Home

DEFINITY ECS R5 CallVisor PC ASAI Installation and

Contents

1. Incoming Call Route Request gt Route Select Call Routed Route End gt Client ASAI Interface Server Figure 5 1 Routing an Incoming Call The sequence of actions is as follows 1 2 3 4 5 Incoming call to client Route request issued by client Route Select issued by server Call routed by client Route End issued by client If the server rejects the request the cause is indicated with the negative acknowledgement Issue 1 October 1996 5 43 ASAI Capabilities EE Request Indication Parameters Notes 5 44 Destination Address The called endpoint for which the route is needed The following parameters are optional Originating Address The endpoint on whose behalf the call is routed Call Setup Details of incoming call look ahead interflow and user entered code Call Identifier Identifier of the call to be routed Originating Line Information o1i Identifies information indicator II digits received in the oli information element for the call User to User Data A substructure containing user data The structure contains the following fields leng field An integer value that indicates the number of octets of user data included in the request This field is set to O if no user user data is present Currently ECS will accept up to 32 bytes of data 1eng 32 If more than 32 bytes are specified all the data is discar
2. val_length is the number of characters pointed to by domain_val domain val is a pointer to a character string of length val length that indicates the ECS specified value of the domain extension leng udata is an integer value that indicates the number of octets of user data included in the offered call If this item is not supplied by the ECS it assumes the default value of C NUSE LONG collect is a boolean field containing the collect or collected flag 9 118 Issue 1 October 1996 C EN REP 3ASAI Table 9 2 Event Name Members and Descriptions Continued Event Name evr buf Member Description C OFFERED incall list udata type indicates the type of user data It Continued Continued canbe C_LOGIN_DIGITS C_CALL_PROMPTER or C_NUSE_LONG login digits call prompter information or not used timeout specifies the digit collection time out and is an integer value from 0 to 63 the default value is 0 The incomg_udata is a pointer to an optional character string of user data supplied with the call offered If the string is not supplied by the ECS incomg_udata points to a null character as the first character of the string priority_level is an integer value that indicates the priority of the incoming call It can be C_NOT_IN_QUEUE C_LOW C MEDIUM C_HIGH or C_TOP If this item is not ECS supplied it assumes the default value ofC NUSE LONG
3. interflow type is an integer value that indicates the type of interflow It can be C ALL INTERFC LOW C THRESHOLD INTERFC LOW or C VECTORING INTERFC LOW If this item is not ECS supplied it assumes the value of C NUSE LONG The parameters hour minute and secondindicate the elapsed time the offered call has spent in the queue This time is given in the integer values If elapsed time is not supplied all three item s will assume the value of C NUSE LONG dnis chars is a pointer to a null terminated string that indicates the identity of the interflow Source If this item is not ECS supplied it is a null pointer w dnis chars points to a translation of the raw OPTREX data in dnis chars into its locale equivalent ISO four bytes characters See OPTREX locale ISO characters in the glossary for more information feat type is an integer value that indicates what feature if any is associated with this call feat type can be C FLEX BILL indicating this call is available for flexible billing See C ALERTING Issue 1 October 1996 9 119 Programming Manual Pages Table 9 2 Event Name Members and Descriptions Continued Event Name evr buf Member Description C CALEND calend list See C ALERTING calend cause can be any of the following C ANSWERING MACHINE C CALLID TERM C NORMAL C NUM CHANGED C UNSPECIFIED These values
4. C COLLECTED collected digits See C ALERTING user data provides the user information that will be sent from ECS pool SeeC ALERTING 9 110 Issue 1 October 1996 C EN REP 3ASAI Table 9 2 Event Name Members and Descriptions Continued Event Name evr buf Member Description C CONN ECTED connect list See C ALERTING See C ALERTING con type is an optional plan type t structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL See C ALERTING con num type tor more information concerning plan type t See C ALERTING calling type is an optional plan type t structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL See C ALERTING con num type for more information concerning plan type t See C CALL ORIG called type SeeC CALL ORIG See C ALERTING party idjSeeC ALERTING See C ALERTING olifbee C ALERTING See C ALERTING Issue 1 October 1996 9 111 Programming Manual Pages Table 9 2 Event Name Members and Descriptions Continued Event Name evr_buf Member Description C_ANSW ERED See C_A
5. asai common event name call id cause connect num con num type party id calling num call num type dial num dial type uudata acd split ext trk Liy pool C_DATSZ asai_common event name cause connect num con num type call id calling num call num type called num called type uudata party ig pool C DATSZ Issue 1 October 1996 9 101 Programming Manual Pages typedef struct asai_common_t asai_common long event_name long cause char connect_num plan_type_t con_type char calling_num plan_type_t calling_type char called_num plan_type_t called_type call id t call id party id t party ig trunk id t trk oli t oli char pool C DATSZ connect list t typedef struct asai common t long call id t long p e p C p e answere typedef s asai common t 1 G G p 1 c queued_ typedef s asai_common_t As c c p p c hold_li 9 102 Issue 1 October arty_id_t har lan_type_t har lan_type_t har d_list_t truct ong all id t har lan type t ong har har list t truct ong all id t har lan type t arty id t har St t 1996 asai common event name call id answered cause party id connect num connect type called num called type pool C DATSZ asai common event name call id called num called t
6. C POS ACK C NEG ACK The name of the file that contains the cluster identification number for this send This is an ASCII file that can be created through an editor and may or may not contain a terminating newline character A file that contains capability specific information If this argument is omitted and the capability needs other information from the user it will prompt him or her for that information If this filename is specified but the file does not exist the function will use its interactive mode ask the questions and record the users responses in the specified file If the filename is specified and the file exists the information contained therein will be used as the detailed information for the capability The format of this file is capability specific It will therefore be described with the individual capabilities Three examples are provided in the following three subsections Issue 1 October 1996 10 9 Testing Heartbeat Reguest C_HB_REO This capability reguires no additional information The cap_info argument to the asai_send command line is ignored if it is there Set Value Reguest C_SV_REO This capability allows the user to either Turn on or off a message waiting lamp for a particular phone or Send a Flexible Billing rate change request If used in the interactive mode the conversation might look as follows field name sv_common sv_item symbolic values C_SV_M
7. upplied message maps to the value asai_errno The entire message is to the standard error device the program supplied message first then a and then the ASAI message uccessful completion the function returns 0 If an error occurs the function 1 The type of error is indicated by the error value set in asai_errno C SYS errno ER ASAI service error It indicates that st derr cannot be written check Issue 1 October 1996 9 5 Programming Manual Pages asai get env 3ASAD Name asai get env Request information about a specified characteristic of a communication path Synopsis finclude asai asai def h finclude lt asai asai_str h gt finclude lt asai asai_err h gt typedef union version_t version ulong num_node server_type_t server char node id C NODSIZ get type long asai get env fd characteristic arg int fd long characteristic get type arg Description This function is used to obtain a specified characteristic of the communication path associated with a The parameter characteristic can assume any of the following values C LIB VER The c LIB VER parameter requests the version of the ASAI library Data of the structure type version t shown above is returned pointed to by the third argument C NUM NODE The C NUM NODE parameter requests the number of nodes that have been assigned by the most recent call to the asai set env function arg gt num
8. C call id An identifier assigned by the node that processes the call usually ECS Call Management System CMS An application that collects stores analyzes displays and reports ACD information provided by the switch CMS enables customers to monitor and manage telemarketing centers by generating reports on the status of agents splits trunk groups vectors and vector directory numbers and enables customers to partially administer the ACD features on the switch Call Reference Value See CRV Call Vectoring A method that manages inbound calls using routing tables to uniquely define treatments for each call type The call type is based on the dialed number or trunk group termination to a vector via vectoring directory numbers The vectors are customer programmable using commands that resemble a high level programming language to specify what kind of treatment the call should be given Capability A request or in indication of an operation Capability Groups Sets of capabilities that denote association types Each capability group may contain capabilities from several capability groups Groups are provisioned through switch administration and can be requested by an application These are also called Application Service Elements ASEs Cause Value A cause value is returned in response to requests or in event reports when a denial occurs or an unexpected condition is encountered ASAI cause values fall into two coding standar
9. C EN REP C 3PSH C 3PDC REO C 3PDC CONF C 3PAD C 3PAD CONF C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C S3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF 9 38 Issue 1 October 1996 C 3PDC REQ 3ASAI C 3PDC REO ASAT Name C 3PDC REQ Domain control of an ACD or station Type Initiating Acknowledged Usage typedef struct asai common t asai common long domain type char extension char pool C DATSZ a3pdc info t Description The client sends this capability to request control of an extension domain The parameters used in gaining control of the extension domain are defined in the structure of type a3pdc info t When this request is positively acknowledged by ECS all the third party call control capabilities can be applied to the controlled domain except for the following C 3PTC REQ CONF C 3PMC REQ CONF C 3PCC CONF C 3PCE If the request is denied by ECS error and cause values are returned asai common Within this structure the programmer sets capability to C 3PDC REQ and primitive type to C REQUEST The programmer also sets the sao id also known as cluster id extension The extension parameter is a pointer to a character array that specifies the domain to be controlled pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information Issue 1 October 1996 9
10. Request Indication Parameters m Association Identifier Notes There are no restrictions on this capability 5 50 Issue 1 October 1996 Err CVLAN Programming Introduction to CVLAN CVLAN speeds up the ASAI applications development cycle by eliminating the need to provide embedded client server connectivity software CVLAN provides a simple client Application Program Interface API that applications developers should use to take advantage of CVLAN The CVLAN server will be installed on CallVisor PC and will use the ASAI library to interface with the CallVisor Stack Once the system reboots the CVLAN server will be started It will open a socket and wait in listen mode for the next client connection For each client connection it will generate a child server process The CVLAN client API is described in the following pages Applications Development CVLAN provides an executable for the server asaiserv asaiserv automatically runs after installation or system reboot For UNIX platform a client API 1ibxclnt a is provided with an XDR library libxdr a Any application developed for CVLAN must be built with both libxclnt a and libxdr a Libxclnt a implements Remote Procedure Calls RPC that use XDR 1ibxdr a to send and receive data from the CVLAN Server asai serv The CVLAN installation software places the client API 1ibxclnt a under the following directory on the target machine usr adm cvlan xclient
11. The parameter va item identifies the particular item for which information is requested It can be C ACDSPT STAT C CLASS STAT C TG STAT C TIME OF DAY C AGT STAT C STATION C AGTLOGIN AUD C CAL STAT C PTY STAT C EXT STAT C MWI STAT C SAC STAT Of C SCF STAT ACD split status call classifier status trunk group status time of day ACD agent status station status agent login audit call at a station parties on a call extension status message waiting indication send all calls and station call forwarding The parameters contained in the vg buf union members vq split stat vq common vq tg stat vq common vq agt stat vq station vq agt aud vq cal stat vq pty stat vq ext stat vq mwi stat vq sac stat and vq scf stat supply mandatory and optional information concerning the requested item The following table shows the vg item value the associated vag buf union member the information contained in the member and a description of the information Mandatory information is indicated with an asterisk 9 162 Issue 1 October 1996 C VQ REQ 3ASAI Table 9 5 Associated Items and Descriptions for C VO REQ Item Type vq buf Member Description C ACDSPT STAT vq split stat Split ext is a pointer to a null terminated string specifying the ACD split extension number or the split number pool is a character array that provides buffer space for the ASAI library to store p
12. 5 If you click on Cancel the results currently displayed in the window will be permanently lost However you can click on Log Results as shown in Figure 1 4 to save the test results in a file of your choice as seen below LOG RESULTS Save Results in Cancel Help Figure 1 5 CVLAN Log Results Issue 1 October 1996 1 17 Installation DEFINITY ECS Administration The DEFINITY ECS BRI line must be administered to establish ASAI connectivity between DEFINITY ECS and the adjunct computer Use the add station or change station command to administer the BRI line Use the following table as a guide Table 1 1 Field Name and Requirements Field Name Required Optional Contents Extension R System dial plan sequence Type R ASAI Port R Port connecting to ASAI line Name O Your name or handle XID R y Fixed TEI R y TEL R 3 MIM Support R n CRV Length R 2 The Type XID Fixed TEI TEI MIM Support and CRV Length fields all must have the indicated required contents in order to match the built in administration of the IPCI board and CallVisor PC ASAI software The ISDN protocol stack specifically the QP module supports version selection Version 1 default corresponds to G3V3 Version 2 corresponds to G3V4 and Version 3 corresponds to DEFINITY ECS release 5 For release 5 the default also is 3 To find out which software version is on the DEFINITY ECS use the list c
13. C NOSPLIT MEM CS3 11 14 Agent not member of specified split or split number specified incorrectly C_NO_TRUNKS CS3 20 44 Trunks not available C_NOUSE_RESP CS0 18 16 Originating address does not respond to service C NUSE LONG none MAX LONG No value was returned by ECS 8 12 Issue 1 October 1996 cause value Table 8 1 ASAI Library and DEFINITY ECS Cause Values Continued DEFINITY ECS ASAI Cause Value Value Value Description C_OUT_CALL_BARRED CS0 52 49 Outgoing call has been barred C OUT OF SERV CS3 27 19 Domain has been removed by administration C_PERM_DENIED CS3 43 17 Permission checks for service have failed C_PROTERR CS0 111 1 Capability sequence has been violated or underlying protocol error has been detected an unrecognized value was returned by ECS C_QUEFULL CS3 22 28 Queue is full C_REC_TIMER CS0 102 12 Timer expired C_REDIRECT CS3 30 46 Redirected C_REMAINS_IN_Q CS3 23 50 Call remains in queue C REORDER DENIAL CS3 42 29 Reorder Denial C_RESUNAVL CS3 40 2 Resources to fulfill service are not available C_SER_UNIMP CS3 79 4 Noncompatible options selected C_SERV_UNAVIL CS3 63 7 Domain or call is being monitored by another adjunct C_TEMP_FAILURE CS0 41 37 Temporary Failure C_TIMED_ANSWER CS3 17 52 Assumed answer based on internal timer C_UNASSIGNED_NUM CSO 1 32 Unassigned number C_UNSPECIFIED CSO 127 42
14. asai common primitive type 0 asai common cluster id 10 erep common event name 11 INCOM CAL REPORT incall list clling num 5767907 incall li Clled num 1234567890 incall li trk direct 0 incall_li trk reserved 0 incall_li domain type 1 incall li val length 10 incall li domain val 1234567890 incall list leng udata 23 incall li udata type 5 incall li incomg udata display stuff goes here incall list priority level 3 incall li interflow type 2 incall li hour 0 incall li minute 0 incall li second 0 incall li dnis chars M z Figure 10 9 Incoming Call Event Report For explanations of each field s meanings see PC ISDN Interface Software Developer s Guide 10 16 Issue 1 October 1996 Scripts a EVENT REPORT asai common capability 22 asai common primitive type 0 asai common cluster id 10 ev rpt ptr erep common event name 0 ALERTING REPORT ev rpt ptr alert list connect num 1234567890 ev rpt ptr alert list clling num 1234567890 ev rpt ptr alert list dial num 1234567890 E Figure 10 10 Call Alerting EVENT REPORT asai common capability 22 asai common primitive type 0 asai common cluster id 10 ev rpt ptr erep common event name 1 CONNECTED REPORT ev rpt ptr connect list connect num 1234567890 ev rpt ptr connect list clled num 123
15. droped numis a pointer to a null terminated string that indicates the extension dropped If the extension number is not supplied droped numis a null pointer droped type is an optional plan type t structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL See C ALERTING con num tyre for more information concerning plan type t luudata Bee C ALERTING See C ALERTING See C ALERTING 9 114 Issue 1 October 1996 C EN REP 3ASAI Table 9 2 Event Name Members and Descriptions Continued Event Name evr buf Member Description C BUSY busy list call idis a structure of the type call id t whereid ptr points to a character array that indicates the ECS assigned identifier of the call that generated the busy condition id length indicates the length of the call identifier party id j SeeC ALERTING called numjSee C CONNECTED called type SeeC CONNECTED busy cause is an optional parameter that indicates the cause of the busy event It can be C USER BUSY C QUEFULL C INVDNUM orC NUSE LONG See C ALERTING Issue 1 October 1996 9 115 Programming Manual Pages Table 9 2 Event Name Members and Descriptions Continued Event Name evr_buf Member Description C
16. section later in this chapter Removing Software To remove software enter the command pkgrm cvasai and pkgrm cvisdn and pkgrm cvesai Issue 1 October 1996 1 19 Installation pkgrm command removes all package created and installed files along with directories created when the package was installed When you execute pkgrm cvasai all files in the usr adm asai directory along with all other files belonging to the ASAI package are removed Also for isdn package when you execute pkgrm cvasai all files in the usr adm isdn directory along with all other files belonging to the ASAI package are removed All ASAI header files installed in usr include asai and ISDN IPCI headers for the ISDN package in the usr include isdn directory are removed The directories are removed only if they are empty gt NOTE If you have local header files or other files in these directories they will not be removed and neither will the directory The pkgrm procedure will build a new UNIX kernel When this is completed a message will be displayed requesting to reboot the system After both packages have been removed execute the command shutdown i6 y g0 to reboot the system Configuring and Reconfiguring Software The initial part of the installation and upgrade procedure consists of configuring the software You must enter the information when prompted by the software See the Configuration section earlier in this cha
17. C HB REO 9 128 Issue 1 October 1996 C_HB_REQ 3ASAI C HB REO 3ASAI Name C HB REQ Request heartbeat Type Initiating Acknowledged Usage asai common t asai common Description The client that is ECS or the adjunct sends this capability to request information on the state of the data link connection providing service heartbeat The response implies the status of the provider servicing the data link The asai common structure contains the information needed to fulfill the request Within asai common the programmer sets capability to C HB REQ and primitive type to C REQUEST The programmer also sets the sao id also known as cluster id Return Value When this capability is used in an asai rcv the function returns the size of the message when successful and 1 on failure when it is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent or received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also C HB CONF Issue 1 October 1996 9 129 Programming Manual Pages C RF CONF 3ASAI Name C RF CONF Acknowledge a request feature request Type Terminating Unacknowledged Usage typedef struct asai common t asai common long cause value
18. Description This file contains the date and time the software for ASAI product was manufactured Files usr adm asai asai Date Issue 1 October 1996 2 7 Administration asai Name 4 Name asai Name Name file for UNIX ASAI Description This file contains the name of the ASAI software package The content of the file is Lucent Technologies CallVisor ASAI Files usr adm asai asai Name 2 8 Issue 1 October 1996 asai_admin 1 asai_admin 1 Name asai_admin Administer ASAI file Synopsis asai_admin Description asai_admin sets up the protocol stack for the ASAI device file and sends necessary parameters to the ASAI provider Operation The asai_admin program is executed once per machine boot It is started by asai 4 and becomes a daemon process This program has two tasks a To perform the necessary streams operations with UNIX kernel module s and the signal streams to complete the ASAI streams protocol stack b To condition each protocol stack with the board node ID value and ECS protocol value The protocol stack can be used after asai_admin has built the protocol stack When asai_admin has built the stack the dev asai asai file is available for use The ASAI stream file is always kept open by asai_admin Messages Messages status and error information are written to the asai_log file Some of these messages may come from the ASAI provider streams module Exit Codes This
19. The party to be reconnected must be in the held state Some servers may have to be directly connected to the party to be reconnected Interactions with Event Reports This capability can be requested for a directly connected party when the party is in the held state After this capability is successfully acknowledged the party goes from the alerting state to the active state Issue 1 October 1996 5 27 ASAI Capabilities Third Party Redirect Call Description The Third Party Redirect Call capability allows a client to request that an alerting call be redirected to another number The client invokes this capability by issuing a C_3PREDIR request to which the server will respond with an acknowledgment The server sends positive acknowledgment when it has validated the parameters The server sends a C_NEG_ACK if the parameters of the request are invalid or if it cannot apply the tones to the call Request Confirmation Parameters Depending on conditions the request must specify the following parameters wm ASAI Common The capability should be set to C PREDIR and primitive type to C REQUEST The sao id formerly known as cluster id should also be set to identify the association that controls the alerting call Call Identifier This parameter is required for domain control association and is ignored with call control associations Two fields id length and id ptr are in a call id If the id l
20. The version number of the ASAI library includes three values a major value a minor value and a delta value A change to a major value indicates significant functional change to the ASAI library for example addition of new capabilities A change to a minor value indicates change within the existing capabilities that is an enhancement A change to a delta value indicates a correction and does not represent any increased functionality The parameters major_ver minor_ver and delta_ver respectively represent these values asai_get_env also lets you check which node is handling requests from you and which services you are offering ECS Issue 1 October 1996 4 9 ASAI Library Functions Matching Versions Reguirement It is mandatory that at execution time the major and minor version numbers of the library be identical to those with which the application was compiled This is because the API structures change with major or minor version changes The structures usually do not change with delta version changes The library can be a different version only if the application was linked with a shared library the default This is because of the way shared libraries are implemented To guard against the possibility of having the wrong version of the library at run time the application should include code to check the versions See the section asai_get_env 8ASAI in Chapter 9 Programming Manual Pages to know how to obtain the l
21. asai send C 3PANS CONF C 3PDC REO C 3PDC CONF C 3PAD C 3PAD CONF C EN REP C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PRC C 3PRC CONF 9 28 Issue 1 October 1996 C_3PANS_CONF 3ASAI C 3PANS CONF 3ASAI Name C 3PANS CONF Acknowledge an answer call request Type Continuing Unacknowledged Usage typedef struct asai common t asai common long cause value a3pans nak t Description The client receives this capability as a positive or negative acknowledgement to a C 3PANS request asai common Capability is returned as C 3PANS CONF and primitive type is returned as C POS ACK for a positive acknowledgement and as C NEG ACK for a negative acknowledgement The sao id also known as cluster id specified in the answer call request is also returned A positive acknowledgment confirms that the C 3PANS request has been received and understood Subsequent event reports will indicate the progress of the call In the case of a positive acknowledgment the structure of asai common t is the only one needed cause value This parameter can be any of the following NVALID CRV ER BUSY USE RESP OF SERV ETCONJ VLDIE ROTERR ESUNAVL a c zoudnu o a DUH QOo0000000 See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Issue 1
22. cause_value This parameter can be any of the following C_CALLID_TERM C_FACUNSUB PROTERR RESUNAVL S S ER UNIMP ERV UNAVIL C C C C_MAND_INFO C C C C See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of O does not indicate an error but that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes 9 46 Issue 1 October 1996 C_3PM_CONF 3ASAI See Also asai_rcv C_EN_REP C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PTC_CONF C_3PSH C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PSD C_3PSD_CONF C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF Issue 1 October 1996 9 47 Programming Manual Pages C 3PMC CONF ASAD Name C 3PMC CONF Acknowledge a third party make call request Type Continuing Unacknowledged when used as a positive acknowledgment Terminating Unacknowledged when used as a negative acknowledgment Usage typedef struct asai common t asai common party id t party id call id t call id number id t connected char pool C DATSZ a3pmc ack t typedef struct asai common t asai common long cause value a3pmco nak t Description The
23. Function Purpose asai_open Open communication path asai_errval Write error message if function call fails asai_set_env Bind communication path to a node ID or set server for more links asai_get_env Check library version optional asai_send Send a capability asai rcv Receive a capability asai close Close the communication path optional It is possible to process more than one ASE on a communication path however each communication path can be used to service only a single node Thus if an application wishes to use a communication path to send service requests all the requests must be made to the same destination node as that of the initiating capability If an application wishes to use a communication path to receive capabilities requests must come via the port used to receive the initiating capability In general the ASAI library functions are not reentrant therefore you should avoid using them in signal handlers or use sig hold forthe pertinent signals before calling any ASAI function All seven of the library functions are declared as 1ong To prevent unnecessary messages from lint you may want to use OL to test for successful completion rather than just O In some cases you may also need to use a cast to convert expressions to type 1ong There are examples of casting in some of the code fragments later in this chapter Detailed information on each function can be found in the manual pages in Chapter 9 Programm
24. INVLDNUM MAND INFO PROTERR _R 25 _S 7 lt L C QUO Ar 2C 2I Issue 1 October 1996 9 97 Programming Manual Pages See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of O does not indicate an error but that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai_rcv C_EN_REQ C EN REP C EN CAN C EN CAN CONF C EN END 9 98 Issue 1 October 1996 C EN END 3ASAI C EN END GASAD Name C EN END Terminate the generation of event reports Type Terminating Unacknowledged Usage typedef struct asai common t asai common long cause value jene info t Description The ECS sends this capability as an unacknowledged request to terminate a C EN REQ A structure of type ene info t contains the information needed to fulfill this request asai common The programmer sets the capability to c EN END and the primitive type to C REQUEST The programmer also sets the sao id also known as cluster id cause value This parameter can be any of the following C FACUNSUB INVLDIE MAND
25. call id merge ei number_id old_party_id lt 6 originating f lineidentifier B 10 party ext trunk id user to user MT library identifjers 85 Cd library version checking 49 U library matching versions 3 8 link ASAI link ext number 11 2 O IPCI status printing 2 54 LAN Gateway status printing 2 54 link startup failures 11 4 link alarm 1 link change 1 link offline 1 link restart 1 link status 1 links ASAMS3 9 failed links detection 3 9 ISDNinstalation 1 1 Index 1 1 maximum for LAN Gatewa list station ext num ASAI link listening paths disconnecting selected pate oo reconnecting selected parties 9 84 log file A NM M maintenance alarming C SPSDS9 72 C SPSDS CONF C_3PSL_DISC 9 80 3 2 C 3PSL DISC ACK 9 82 C 3PSL RECONNI9 84 1 1 C 3PSL RECONN ACKj9 86 1 1 onzxucccmmmmmm po fm o O0000000O0O0O0O0O0O000 manual pages ASAlcapabilty S 20 memory restrictions and considerations memory space address default 1 2 merge ext 8 8 messagestream decoding 2 18 1 message trace capability isdn trace 11 2 messagetracing 2 27 sd Message Waiting Indicator setting 5 35 sd messages IPCI device drivertracing 2 45 U MFB defintion t 2 0 mkclid cluster
26. party id Identifies ECS assigned identifier before two calls are merged a Trunk identifier trunk_id Identifies a trunk m Party list identifier party ext Identifies a list of parties with their corresponding extensions Station information stn info Identifies a list of calls with their corresponding parties and call states m Merge extension merge ext Identifies a list of parties with their corresponding extensions m User to user user user Identifies information between ISDN users m Originating Line Identifier 011 Identifies Information Indicator II digits received in the originating line information IE for the call m User data user data Identifies user supplied digits call id typedef struct char id ptr long id length long reserved call id t Within the structure of type ca11 id t the parameter id length indicates the number of binary bytes contained in the call identifier and 1d ptr is the value of a pointer to an array of binary bytes that identifies the call If call id is present id length must be 2 If its value is 0 the value of id ptr is undefined If an illegal value other than 0 is encountered asai send Will reject the message with an error code of C BADPMATCH Future releases of ECS may change the legal range of values for id length Defensive programming practices are recommended Note that unlike null terminated character strings such as ca
27. rf nak t typedef union asai_common_t asai common rf nak t rf nak prt spot Description The client receives this capability as a positive or negative acknowledgment of a C_RF_REQ request The union r rsp contains the necessary information asai common The capability is returned as C RF CONF and the primitive type as C POS ACK for positive acknowledgment C NEG ACK for negative acknowledgment The sao id also known as cluster id is also returned cause value This parameter can be any of the following C AGT STATE C BAD ADMI C FACUNSUB EATURE REJECTED NCOM OPT NC PASWD NCS AGT ST NVALID CRV VLDIE VLDNUM ND INFO AX LOGIN ETCONJ z z QO OC Oy OO Qe OQ C3 D zum pan za T ub cT GE M M _N 9 130 Issue 1 October 1996 C_RF_CONF 3ASAI C_NOLOGIN td td tj NOSPLIT MP ROTERR ESUNAVL R UNIMP RV UNAV P FAILURE ER BUSY IL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Return Value Errors See Also When this capability is used in an asai rcv the function returns the size of the message when successful and 1 on failure A return value of 0 does not indicate an error but that no data has been received See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes asai rcv
28. the function returns the size of the message when successful and 1 on failure A return value of 0 does not indicate an error but that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai rcv C EN REO C EN CONF C EN R EP C EN CAN CONF C E 9 96 ssue 1 October 1996 iN END C EN CONF 3ASAI C EN CONF 3ASAI Name C EN CONF Acknowledge an event notification request Type Continuing Unacknowledged when received for positive acknowledgement Terminating Unacknowledged when received for negative acknowledgement Usage typedef struct asai common t asai common long cause value Jen nak t typedef union asai_common_t asai common en nak t en nak jen rsp t Description The client receives this capability as a positive or negative acknowledgment of a C EN REQ The union en rsp t defines the necessary fields for the messages asai common Within asai common the capability is returned as C EN CONF and the primitive type is returned as C POS ACK for positive acknowledgment C NEG ACK for negative acknowledgment The sao id also known as cluster id returned is the association specified in the event notification request cause value This parameter can be any of the following C FACUNSUB INVLDII
29. usr adm isdn bin esai trace See Also esai trace l1 isdn trace 1 2 20 Issue 1 October 1996 asai_ver 1 asai ver 1 Name asai ver Print ASAI product and software version information Synopsis asai ver Description ASAI product information is printed to st aout This includes the name date and version of the ASAI product Exit Codes If there are no errors the exit code is 0 Otherwise the exit code is set to 1 to indicate an error Files usr adm asai asai Name usr adm asai asai Date See Also asai Date 4 asai Name 4 Issue 1 October 1996 2 21 Administration boot bin 4 Name boot bin IPCI Board Bootstrap Loader Program File Description This data file containing the IPCI Bootstrap Loader Program is downloaded to the IPCI board by ipci_on When this program is started it is used to load the ISDN software onto the board Files usr adm isdn boot bin See Also ipci on 1 pcisdn bin 4 2 22 Issue 1 October 1996 cmd 7 cmd 7 Name cmd 7 LAN GATEWAY Streams Module Communication File Description The cmd file allows communication between certain OA amp M commands and the LAN GATEWAY streams module This device is meant to be used by OA amp M delivered commands and not by customer commands gt NOTE This file has the same major device number as the LAN GATEWAY admin 7 and the signal 7 files Files dev esai cmd See Also admin 7 signal 7 Issue 1 October 1
30. Connected Cut Through Progress Disconnect Drop Hold Reconnected Trunk Seized Call Conferenced l Call Transferred Call Redirected Call Ended Call Offered to Domain Call Initiated Queued Reorder Denial Logout A Key A item always provided in event report I item may be provided in event report 5 10 Issue 1 October 1996 Third Party Call Control Capabilities Third Party Call Control Capabilities The Third Party Call Control capability group includes a number of third party subgroups and two types of the abort capabilities In addition there are numerous Event Report interactions Event Reports and abort capabilities are described in this chapter Third Party Call Control allows a client to establish control terminate and monitor calls to which the client is not a party When invoking the Third Party capabilities the client controls a call on behalf of a party to the call For example a client can reguest that a call be set up between Party A and Party B At a later time Party C can be conferenced into the call The server handles the third party conference reguest as if it had been made by Party A or Party B Third Party Call Control that interacts with ECS classified calls is unigue In general if ECS receives any RELease COMplete message for a Third Party Call Control association started by 3P_Make_Call or 3P_Take_Cont
31. DISC request is also returned cause value This parameter can be any of the following C INVLDNUM C PROTERR C RESUNAVL C MAND INFO C INVLDI C INCOM ST See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values 9 82 Issue 1 October 1996 C_3PSL_DISC_ACK 3ASAI Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai rcv C 3PSL DISC C 3PSL RECONN C EN REP C 3PMC REQ C 3PMC CONF C 3PTC REQ C 3PTC CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF Issue 1 October 1996 9 83 Programming Manual Pages C 3PSL RECONN 3ASAD Name C S3PSL RECONN Reconnect the listen path for selected parties Type Continuing Acknowledged Usage typedef struct asai common t asai common party id t from party id party id t to party id a3psl reconn t Description The client sends this capability to request that a listen path between parties on a call controlled by the client be reconnected A structure of type a3ps1 reconn t contains the parameters need
32. INFO OUT OF SERV PROTERR RESUNAVL SER UNIMP S CY CX C C CY CX C ERV UNAVIL If the ECS does not supply a cause value the library supplies the value of C NUSE LONG Table 8 1 ASAI Library and DEFINITY ECS Cause Values provides further information on cause values Issue 1 October 1996 9 99 Programming Manual Pages Return Value When this capability is used in an asai send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by a server See Also asai send C EN REQ C EN CONF C EN REP C EN CAN C EN CAN CONF 9 100 Issue 1 October 1996 C EN REP 3ASAI C EN REP 3ASAI Name Type Usage C EN REP Send or receive an event report Continuing Unacknowledged typedef struct asai common t long call id t long char plan type t party id t char plan type t char plan type u el t e g 1 ct ser_user_t har runk_id_t li t har alert list t typedef struct asai_common_t long long char plan_type_t call_id_t char plan_type_t char plan_type_t user_user_t party id t char E orrgcLrst t
33. Otherwise the parameter is not used tx party id is not an ASCII null terminated string but rather an array of binary bytes of the specified length See the Identifiers section in Chapter 8 ASAI Capability Primitives for more information 9 72 ssue 1 October 1996 C 3PSDS 3ASAI call id call idis ECS assigned identifier of the active call on which the DTMF signals will be applied ca11 idis used only when the association is initiated by the C 3PDC REQ capability user dat a The user data structure is used to convey the information about the DTMF digits to ECS The leng field is an integer value that indicates the number of octets digits of user data included in the request The type field indicates the type of information and is restricted to C UU IA5 which indicates IA5 or ASCII characters The digits field is a pointer to an ASCII string of no more that 32 characters in length pool The pool parameter is a character array that provides buffer space for the ASAI Poor library to store program specific information See the section in Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages fo
34. S ER UNIMP ERV UNAVIL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Issue 1 October 1996 9 41 Programming Manual Pages pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Poorin Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by a server See Also asai send C EN REP C 3PDC REO C 3PDC CONF C 3PAD C 3PAD CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C S3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PRC C 3PRC CONF 9 42 Issue 1 October 1996 C_3PM 3ASAI C_3PM 3ASAD Name C 3PM Merge two calls Type Continuing Acknowledged Usage typedef struct asai common t asai common party id t com party id call id t call id call id t held call id long conf flag char pool C DATSZ a3pm info t Description The client sends this capability to request that two client controlle
35. This process is nearly identical to that used with the CallVisor PC ASAI library server addresses must be specified by the client this is not required in the PC ASAI library Once a connection is established the applications use library routines asai send and asai rcv to send and receive ASAI messages The server routes the messages to and from the proper DEFINITY ECS PBX The format of the messages matches exactly those used with the CallVisor PC ASAI library Except for small changes in the communication establishment it is expected that the applications developed with the CallVisor PC ASAI library could run unchanged on a client system using CVLAN client side library Certain configuration limits are inherited from the CallVisor PC ASAI library or DEFINITY ECS PBX ASAI limits In particular only one client can provide routing service for a PBX Only one client can provide maintenance heartbeat service for a PBX ASAI limits as to the number of active monitors etc supported by a single PBX are not changed by the CallVisor CVLAN implementation 1 12 Issue 1 October 1996 Installation Server Installation on UNIX For the CVLAN UNIX Platform refers to both UNIXWARE and Solaris x86 The CVLAN server can only be installed after CVISDN and CVASAI have been installed 1 To install the CVLAN server type the command pkgadd d diskette1 2 Place the Lucent Technologies CallVisor PC CVLAN Server disk in the appropriate d
36. a3pmc_nak a3pmc_rsp a3ptc_info a3ptc_ack a3ptc_nak a3psh info a3psh rsp a3psd info a3psd rsp a3psl disc a3psl disc ack a3psl reconn a3psl reconn ack a3pr info a3pr rsp a3prc rsp a3pm info a3pm ack a3pm nak a3pcc rsp a3pce info a3pad info a3pad ack a3pad nak Issue 1 October 1996 Programming Manual Pages a3pans_info_t a3pans_nak_t a3pdc_info_t a3pdc_ack_t a3pdc_nak_t a3pdce_info_t en_scn_t en_scn_nak_t sv_buf_t sv rsp t rf buf t rf rsp t rt info t rts info t rte info t rt nak t hb nak t hb rsp t en scn rsp t a3psds info t a3psds rsp t a3predir info t a3predir nak t a3predir ack t kasai info t long asai rcv fd buf int fd char buf long length Description a3pans info a3pans nak a3pdc info a3pdc ack a3pdc nak a3pdce info en scn en scn nak Sv buf Sv rsp rf but rf rsp rt info rts info rte info rt nak hb nak h e b rsp n scn rsp a3psds info a3psds rsp a3predir info a3predir nak a3predir ack length This function is used to read a message that is a packet containing primitives capabilities and or program specific information from the communication path identified by file descriptor a The program passes a pointer to the buffer buf of size length to the ASAI library The ASAI library then returns the message into the program specified buffer The max
37. capability is returned as C ABORT and primitive type as C REQUEST The sao id also known as cluster id identifying the association to be aborted is set by the programmer or returned abort type This parameter indicates the type of abort C USER ABT is initiated by the application program C PROV ABT is initiated by the library The programmer sets C USI ER ABT to request an abort When the library sends an abort capability abort type is returned as C PROV ABT As soon as abort request is sent or received the specified association terminates Any o those 9 92 ssue 1 Oc utstanding messages for that association are ignored and the resources for messages are freed tober 1996 C_ABORT 3ASAI cause_value This mandatory parameter carries the cause of the abort reguest It can be any of the following Q UST TER NCOM ST NVALID CRV NVLDNU ISSING IE ETCONJ NOLOGIN OSPLIT MEM RESP DENIED ERR TIMER RESUNAVL USER C BUSY HHH a a U Z ti O Da n U pe O Zo Q I Y 00 00 00 0 0 00 O0 A See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Return Value When this capability is used in an asai rcv the function returns the size of the message when successful and 1 on failure when it is used in an asai_send the function
38. cluster ID filename 10 9 Third Party Call Ended 5 16 client API CVLAN API descripion 6 2 Third Party Clear Call 5 17 client controlled calls Drop Selected parties 9 67 Third Party Domain Control 5 18 Third Party Domain Control End 5 19 client services obtain 9 1 client side OA amp M utilities asai test asai ver 11 6 Issue 1 October 1996 IN 3 Index client definition 33 O requesting specified characteristic 9 6 sss communication OA amp M commands LAN Gatewaystreams 2 28 O O PCI streams device 2 24 Z O 1 concepts ASAI 3 3 Cid 1525 o s ae Conference Flag parameter 1116 configuration procedures 1 20 connection failure CVLN ITT ECS connection LAN Gateway disable 2 52 connections switch 2 17 Cd continuing capability definition 9 20 CORnumber 11 2 cpcommand 2 2 1 1 1 1 1 CVLAN application development 6 1 o o O asai closelibraryfunction 6 11 sd asai get envlibrary function 6 7 asai rcvlibrary function 6 10 sid asai_send library function 6 9 I NER asai set env library function client and server connecting to TCP IP port 2 58 client installation steps on UNIX 1 13 matching versions reg urement 6 8 product description Ji 14 e sample application on U
39. null terminated character string that indicates the extension of the dialed number If the extension number is not supplied dial numis a null pointer 9 108 Issue 1 October 1996 C EN REP 3ASAI Table 9 2 Event Name Members and Descriptions Continued Event Name evr buf Member Description C ALERTING alert list dial type is an optional plan type t Continued Continued structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL See lcon num type above for more information concerning plan type t uudata is a structure of the type user user t where the leng field is an integer value that indicates the number of octets of user data included in the request This field is set to 0 if no user user data is present Currently ECS will accept up to 32 bytes of data Leng 32 If more than 32 bytes is specified an error will be returned ASAI supports a maximum user_user data length of 32 bytes although user_user data generated from a PRI trunk can be up to 127 bytes in length DEFINITY ECS will truncate this to 32 bytes before forwarding it to ASAI link The protocol field indicates the type of information and is restricted to C_UU_USER that indicates a user specific protocol or C_UU_IAS5 that indicates IA5 or ASCII characters The info field is a pointer to an ASCII string of no more that 32 characters in
40. specified in the C 3PCC request is also returned cause value This parameter can be any of the following C CALLID TERM C FACUNS UB NVLDIE OTER UN R ESUNAVL ER AND INFO R IMP ERV_UNAVIL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Issue 1 October 1996 9 33 Programming Manual Pages Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of 0 does not indicate an error but that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by the server See Also asai_rcv C_EN_REP C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PTC_CONF C_3PSH C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF C_3PSD C_3PSD_CONF C_3PCC C_3PCE C_3PRC C_3PRC_CONF 9 34 Issue 1 October 1996 C 3PCE 3ASAI C 3PCE 3ZASAI Name C S3PCE End a third party call controlled by the client Type Terminating Unacknowledged Usage typedef struct asai common t asai common long cause value call id t call id char pool C DATSZ a3pce info t Description The server sends this capability to request termination of an existing call controlled by a client This capability
41. the call comes via ringing on the station set and the agent goes off hook on the ringing appearance to answer the call Monitored Call A call that provides ASAI Event Reports over Event Notification associations Monitored domain The VDN split or agent specified in an ASAI Event Notification Request ASAI messaging to support this feature only applies to monitored domains N Node Processor reachable through a network Null One of the five possible states for a party on a call Null means that the party is not a participant on the call GL 6 Issue 1 October 1996 Glossary O OPTREX This set is a Lucent Technologies proprietary standard that consists of ASCII and 128 other special characters The ASCII character tilde is an indicator to CallVisor PC that it has received an OPTREX seguence Tilde is a nonprintable toggle character between ASCII and OPTREX The high bit is set for the characters following an odd number of These 8 bit OPTREX characters are mapped to their corresponding ISO characters See description of ISO characters above for more information P Party Extension Active on a Call A party is on the call if it is actually connected to the call in active talk or in held state An originator of a call is always a party on the call Alerting parties busy parties and tones are not parties on a call party_id An abstraction of ECS endpoint dependent information The party_id provides a way
42. the client can take various actions by invoking other ASEs such as Third Party Take Control The Event Notification ASE provides capabilities for the following a Initiating event notification m Event Notification Request m Terminating event notification m Event Notification End m Event Notification Stop m Event Reports In addition the two Abort capabilities can be considered part of the Event Notification ASE Abort capabilities are described in later in this chapter The server only accepts requests for event reports on domains that are directly associated with it The following domains are supported m ACD split a VDN Issue 1 October 1996 Event Notification Reguest Event Notification Reguest Description The Event Notification Request capability allows the client to request the server to begin reporting certain events After the server acknowledges the request the client receives event reports each time an event occurs The client does not have to be a party to any of these events A client can have several instances of Event Notification active at the same time and a single event can be reported for more than one ASE instance In such cases the client receives separate event reports The client invokes this capability by issuing a C_EN_REQ to which the server responds with a C EN CONF If the acknowledgement is positive the client starts to receive event reports and continues to receive them
43. y AAlDdomaintype j9 156 Cd AAID extension number 9 156 1 ACD agentstatus 9 155 1 1 ACD class status 9 1455 1 ACDsplitstatus 9 155 ACDtimestatus 9 155 ACDtrunkgroup 9 155 o O acknowledging the request and terminating callstatus 9 156 capability group 5 36 extension status 9 157 o O Integrated Directory Database 9 156 sd MWistatus 9 157 0 parameters 5 37 partyidstatus 9 157 SACstatus 9 4057 SCFstatus 9 158 1 1537 U Value Ouery Confirmation IN 10 Issue 1 October 1996 Value Query Reguest 5 7 Cd ACD splitstatus 9 163 agentloginaudit j9 163 Cid agent status 9 163 Cd call status classstatus 9 163 extension status 9 163 O MWistatus 9 163 1 parystatus 9 163 1 SACstatus 02 163 Cd SCFstatus 9 163 Cd station extension number 9 163 time of day status 9 163 trunkgroupstatus 9 163 Value Query Request Response 9 165 Value Query Response 5 39 O Value Query Response agent login audit 9 166 VDN domain lb 22 J O vect num routing applications 11 2 version of ASAI library implementation 3 6 version control usage and definition 1 4 v
44. 114 agent login feature reguest 5 40 1 1 1 1 11 1 agent logout feature request 5 40 agent physical extension number 9 113 alarming isdn bri maintenance activating 2 25 isdn bri maintenance deactivating 2 25 alarms isdn brimaintenancej 2 39 Cd LAN link activating 2 5O 11 LAN link deactivating 2 50 alternate destination 5 23 U answering a call capability 9 27 5 23 answering machine detection description application closing communication path specifying as server 46 sd application Service Element see ASAI adjunct log message fileJ2 55 communicationfile 2 6 Issue 1 October 1996 IN 1 Index ASAI library capabilities asai 7 asai Name asai_admin asai_cause asai_close command to close anopenstream 10 8 i communication pathtermination 3 6 CVLAN library function 6 11 library function 4 14 1 j asai common capabiiiies 8 3 stuctue 8 3 5 5 asai errval funcion 3 7 J J O library function 44 1 1 j asai get env CVLANIibraryfunction 6 7 library function 49 1 1 O requesting communication path characteristic 3 6 asai hb 1 asai_log 4 2 asai_open arguments 10 6__ S CVLAN library function 64 library ee open communication path for capabilit ER script command IN 2 Issue 1 Oct
45. 39 Programming Manual Pages Return Value When this capability is used in an asai send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai send C EN REP C 3PSH C 3PDC REO C 3PDC CONF C 3PAD C 3PAD CONF C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PRC C 3PRC CONF 9 40 Issue 1 October 1996 C_3PDCE 3ASAI C 3PDCE 3ASAI Name C 3PDCE End the domain control Type Terminating Unacknowledged Usage typedef struct asai common t asai common long cause value a3pdce info t Description The server sends this capability to indicate that it will end a previous C 3PDC REQ This indication terminates the association and is generally provided when the affected domain is removed or changed administratively from ECS asai common Within this structure the programmer sets capability to C 3PDCE and primitive type to C REQUEST The programmer also sets the association identifier to the sao id also known as cluster id specified in the C 3PDC REQ cause value This parameter can be any of the following C FACUNSUB INVLDIE INVLDNUM MAND INFO PROTERR RESUNAVL S
46. C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF Issue 1 October 1996 9 69 Programming Manual Pages C 3PSD CONF ASAD Name C 3PSD CONF Acknowledge a third party selective drop request Type Continuing Unacknowledged Usage typedef struct asai common t asai common long cause value a3psd rsp t Description The client receives this capability as a positive or negative acknowledgement of a C 3PSD request asai common Within this structure capability is returned as C 3PSD CONF primitive type is returned as C POS ACK for positive acknowledgment and as C NEG ACK for negative acknowledgment The sao id also known as cluster id specified in the C 3PSD request is also returned cause value This parameter can be any of the following Q H z lt E U c ES I SERV_UNAVIL CALLID TERM QO000000 See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values 9 70 Issue 1 October 1996 C_3PSD_CONF 3ASAI Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of 0 does not indicate an error but that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai rcv C EN REP C 3PMC R
47. C VO REO C VO CONF 9 166 Issue 1 October 1996 Testing Integration Test Tool This Integration Test Tool ITT is designed to help test the ASAI library by exercising its function calls and optionally by comparing the expected results to the actual results for received messages See Figure 10 1 Integration Test Tool Overview for ITT structure Issue 1 October 1996 10 1 Testing ASAI Test Tool script ASAI Library User Kernel AP Y A FEL Y 4 QP v A vA ESAI IPCI Figure 10 1 Integration Test Tool Overview Terminology 10 2 The following terms are used extensively throughout this chapter and are unique to the ITT test script Runs the test by telling the tool which ASAI library functions to execute and which capabilities they should invoke capability info script If the test tool needs additional information about the selected capability it asks the user for that input Alternatively the script may contain the name of an input file that would answer all the specifics about the selected capability fd file Used to convey the return value from the ASAI open function The information is stored in a separate file so that it can be passed to subsequent calls represented by command lines in the test script file Issue 1 October 1996 Executing the ITT Program Executing the ITT Program
48. CREAR EQ Issue 1 October 1996 9 131 Programming Manual Pages C_RF_REO 3ASAI Name C_RF_REO Activate or deactivate a call feature for a specified endpoint Type Initiating Acknowledged Usage typedef struct sai_common_t a 1 char char char 1 c har jagt login t typedef struct asai common t long char char long char agt logout t typedef struct asai common t long char char long long char chg wkmod t typedef struct asai common t long char char char jcall frwd t 9 132 Issue 1 October 1996 asai_common rf item agent id split ext agt ext work mode pool C DATSZ asai common rf item split ext agt ext reason code pool C DATSZ asai common rf item split ext agt ext work mode reason code pool C DATSZ asai common rf item called num redir num pool C DATSZ C_RF_REQ 3ASAI typedef struct asai_common_t long char char can_frwd_t typedef struct asai_common_t long char char sac_t typedef struct asai_common_t long char char sac_can_t typedef struct asai common t long rf common t typedef union rf_common_t agt_login_t agt_logout_t chg_wkmod_t call_frwd_t can_frwd_t sac_t sac_can_t Prt butt Description asai common rf item called num pool C DATSZ asai common rf item called num pool C DATSZ asai comm
49. DENIAL denial list See C ALERTING called num See C CONNECTED called type SeeC CONNECTED denial cause is an optional integer value that indicates the cause of the reorder condition It can be any ECS specified cause value or C NUSE LONG See C ALERTING C CUT THROUGH cuthrw list See C ALERTING party id SeeC ALERTING location is a mandatory parameter that shows where the progress indication is coming It canbe C USER C PUBLU C PUBRU or C_PRIRU user public network serving local user public network serving remote user or private network serving remote user prog discp is a mandatory parameter that describes the progress indication It can be C OFFISDN C DESTNISDN C ORIGNISDN C ONISDN or C INBAND call not end to end ISDN destination is nonISDN origination is nonISDN call returned to ISDN or in band information is now available See C ALERTING C TRK SEIZED trkszd list T See C_ALERTING See C_ALERTING called_num See C_CONNECTED See C_CONNECTED See C_ALERTING 9 116 Issue 1 October 1996 C EN REP 3ASAI Table 9 2 Event Name Members and Descriptions Continued Event Name evr buf Member Description C CONFERENCED conf list bef call idis amandatory structure of the type call id t where
50. Development Group Room 4E 317 200 Laurel Avenue Middletown NJ 07748 xiv Issue 1 October 1996 Organization of This Document Organization of This Document This document is organized as follows Chapter 1 Installation provides detailed installation steps Chapter 2 Administration describes CallVisor PC administration Chapter 3 Introduction to ASAI is an overview of the Adjunct Switch Application Interface It presents the terms and concepts specific to ASAI and includes an overview of the ASAI library the functions the application service elements ASEs and the capability primitives Chapter 4 ASAI Library Functions describes the ASAI library functions and their use and contains a number of coding examples Chapter 5 ASAI CAPABILITIES has all the ASAI application service elements providing details about the capabilities that comprise each ASE vent Notification and Event Reports m Third Party Call Control Capabilities m Set Value jm a Value Quer equest Feature m Adjunct Routing m gt Z S D lt o D Ei D D Q o m Abort Capabilities Chapter 6 CVLAN Programming introduces a new feature CVLAN Chapter 7 Error Messages has a detailed list of error messages Chapter 8 ASAI Capability Primitives is an introduction to ASAI capability primitives Chapter 9 Programming Manual Pages contains manual pages for ASAI library functions A
51. EN REP C 3PMC REQ C 3PMC CONF C 3PTC REO C 3PTC CONF C 3PSH C 3PSH CONF C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF 9 56 Issue 1 October 1996 C_3PR_CONF 3ASAI C 3PR CONF ASAD Name C 3PR CONF Acknowledge a third party reconnect request Type Continuing Unacknowledged Usage typedef struct asai common t asai common long cause value a3pr rsp t Description The client receives this capability as a positive or negative acknowledgement to a C 3PR request asai common Within asai common capability is returned as C 3PR CONF primitive type is returned as C POS ACK for positive acknowledgment and as C NEG ACK for negative acknowledgment The sao id also known as cluster id specified in the C 3PR request is also returned cause value This parameter can be any of the following C CALLID TERM C FACUNSUB NCOM ST NVLDIE NVLDNUM AND INFO LI LI I M PROTERR _R 9 9 ESUNAVL ER UNIMP ERV UNAVIL QO00000020 See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Issue 1 October 1996 9 57 Programming Manual Pages Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of 0 does not indicate an error but that no data has been receive
52. Jin Chapter 8 ASAI Capability Primitives for more information C_CALL_ORIG orig_list Icall id See C ALERTING See C ALERTING connect num optional A pointer to a null terminated string that indicates the originating device Normally this is the same as the call number and then omitted however in this case where the call is originated from a logical agent extension this will indicate the physical extension from which the call was made See C ALERTING See C ALERTING calling num is a pointer to a null terminated string that indicates the number that originated the call usually the extension number For Third Party Make Calls originating from a logical agent this is the logical agent number of the agent that is logged into the station making the call call num type See C ALERTING called numi a pointer to an optional null terminated string that indicates the called extension If the extension number is not supplied called numis a null pointer called type is an optional plan type t structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL See C ALERTING for more information concerning plan type t uudata see C ALERTING party id the party number of the originating device on the call pool See C ALERTING
53. Testing asai_close This script command tells the integration test tool to close an open stream through the asai_close library function The format of the command line is as follows asai_close close_ret fd_value This command expects two arguments close_ret The name of a file where the return value from the asai_close will be stored If the return value is not needed or desired then dev nu11 would be sufficient fd value The name of the file that contains the file descriptor that we want to close It would probably be the return value file of the asai open command line 10 8 Issue 1 October 1996 Scripts asai_send Requests the integration test tool to use the supplied information to issue an asai_send library function call Its format is as follows asai send send ret fd file CAPABILITY CAP Type clid file cap info This command line expects six arguments described as follows send ret fd file CAPABILITY CAP Type clid file cap info The name of a file where the return value from the asai send Will be stored The name of the file where the file descriptor is stored This file was probably created as the return value file of the asai open command line A character string that describes the capability being requested The value corresponds to the capability names listed in the asaiDefs h header file A character string describing the type of capability Possible values are C REQUEST
54. The capability does not affect the state of any party on a call Issue 1 October 1996 5 21 ASAI Capabilities Third Party Make Call Description The Third Party Make Call capability allows a client to request the server to establish a call on behalf of two other parties one of which must be designated as the calling party and the other as the called party The capability also allows the server to confirm the request The client invokes this capability by issuing a C_3PMC_REQ to which the server responds with a C_3PMC_CONF Third Party Make Call confirmation if the client has requested acknowledgement The Third Party Make Call request initiates an Event Report C EN REP The client retains control of the call until one of the following conditions is met The client issues a Third Party Clear Call request for the call The client issues a Third Party Relinquish Control request for the call The client receives a Third Party Call Ended capability for the call The client invokes or receives a JU ABORTJ capability for the call The client receives aIP ABORTJ capability for the association Note that this is not an instantaneous process an acknowledgement from the server means only that the server has received and understood the request The server then must attempt to fulfill the request perhaps try several alternative routes If the first route fails the server may not be able to attempt a second rou
55. The filename of the ASAI provider usually dev asai asai The numeric value of flags to be forwarded to asai open A character string referring to the node being opened In the default environment where the administrator uses the suggested values on IPCI installation this would be signal01 Informs the ASAI library software of the number of services that this open if successful will serve If this open does not intend to serve anything then both this and the next fields should be ignored Informs the ASAI library software of the service type that this open if successful will serve If this open intends to serve more than one type of service then each server type should be separated by a blank and the server num should match the number of service types that you entered here Scripts After the asai_open the node id will automatically be set by the test tool through asai set env using the node id specified on the command asai open command line An example of an asai_open command line follows asai open fd file dev asai asai 0 signalO1 1 C RT SER where dev asai asai is the pathname of the ASAI provider 0 denotes the open flags passed to the open signal01 represents the node name or special file name of the ISDN connection to ECS 1 indicates that this open if successful will serve one type of service and C RT SER is the service type routing an incoming call Issue 1 October 1996 10 7
56. The following instructions assume that the installation steps have been completed successfully for the CallVisor PC ISDN ASAI and ITT packages The asai_test Test ASAI Connection with Switch is passed and the BRI link from the adjunct to ECS is good The command mkclid creates cluster id file descriptor and input output files used by the script files These files are created with the users login id and shell umask file permissions Enter the following commands cd usr adm asai itt mkclid ECS sends a heartbeat to the adjunct every two minutes and after doing that three times with no response tears down and then restarts the link During this time C ABORTS are sent to the adjunct Scripts can be run without the C ABORTS appearing by running the asai hb command Refer to the manual page for more information about the asai hb command Enter the following command for link 1 nohup usr bin asai hb 1 amp The following command line illustrates how to execute the ITT itt scriptfile Figure 10 2 Execution of the ASAI integration test tool Here scriptfile represents the name of the main script file to be interpreted by the ITT Issue 1 October 1996 10 3 Testing Scripts 10 4 This section describes the format of script and capability info files The script test file is an ASCII file created using a text editor that tells the test tool which functions to execute and gives it the information that will allow
57. Unspecified C_USER_BUSY CS0 17 15 Domain or call is being monitored by another adjunct C VOICE ENERGY ANSWER CS3 18 53 Voice energy detected by ECS C COVER BUSY CS3 26 58 Redirection cause C COV DONT ANS CS3 28 59 Redirection cause C FORWARD ALL CS3 31 60 Redirection cause C FORWARD BUSY CS3 25 57 Redirection cause Issue 1 October 1996 8 13 ASAI Capability Primitives gt NOTE Whenever the server returns cause_value with an unrecognized value the value is mapped to C_PROTERR If the server does not return a value then cause_value is mapped to C_NUSE_LONG Future releases of the ASAI library may include new cause_values The application can be programmed for upward compatibility by providing for unexpected cause values in the code Pool The pool parameter used with a number of capabilities identifies a buffer area for storing user information The various call identifier values returned by these capabilities ca11 id party id are pointers to the pool buffer The pool buffer pool C DATSZ contains various call identifier numbers in the form of null terminated strings 1 The programmer must do more than simply copy these identifiers to guarantee that the space to which they point will exist in the future 8 14 Issue 1 October 1996 U Programming Manual Pages ASAI Library Manual Pages Access to ASAI services is provided through a collection of functions known as the A
58. a trunk Selective Listening A feature that allows an adjunct to disconnect a party endpoint from listening to other parties on an active call A disconnected party can also be reconnected to the active call Send DTMF Signals A feature that allows the DEFINITY ECS switch to generate DTMF tones on a talk path when requested to do so by the adjunct application Server As used in this guide the responder to a request for service usually but not always ECS Split A group of ACD agents organized to receive similar calls State The five possible states for a call are null alerting active held and seized U Unavailable An event equivalent to busy V VDN Vector Directory Number an extension that provides access to the vectoring feature on ECS Vectoring allows a customer to specify the treatment of incoming calls based on the dialed number Vector Controlled Split A hunt group or ACD split administered with the vector field enabled Access to such split is only possible by dialing a VDN extension GL 8 Issue 1 October 1996 Glossary Ww wide characters These characters point to a translation of the raw OPTREX data into its equivalent ISO four byte characters Issue 1 October 1996 GL 9 Glossary GL 10 Issue 1 October 1996 Index Numerics 27 character display Integrated Directory names 3rd Party Abort 9 92 3rd Party Answer Call 5 13 19 7 3rd Party A
59. are similar t cause value and are explained in Chapter 8 ASAI Capability Primitives If this item is not ECS supplied it assumes the value of C NUSE LONG See C ALERTING C COLLECTED collected See C ALERTING digits 3 user data provides the user information that will be sent from ECS See C ALERTING Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 indicates that there is no data to be sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai send C EN REQ C 3PMC RI Ed O 9 120 Issue 1 October 1996 C EN REQ 3ASAI C EN REQ 3ASAI C EN REQ Request event reports for a specified domain Name Type Initiating Acknowledged Usage typedef struct asai common t long char char jacd grp info t typedef struct asai common t long char char cv info t typedef struct asai common t long jen common t typedef union en_common_t acd_grp_info_t cv_info_t Jen buf t Description asai common domain type domain ext pool C DATSZ asai common domain type domain ext pool C DATSZ asai common domain type en common acd grp info cv info The client sends this capability to
60. asai_send the function returns a nonnegative value upon success and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent 9 80 Issue 1 October 1996 C 3PSL DISC 3ASAI Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by a client See Also asai send C 3PSL RECONN C 3PSL DISC ACK C 3PSL RECONN ACK C EN REP C 3PMC REQ C 3PMC CONF C 3PTC REQ C 3PTC CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF Issue 1 October 1996 9 81 Programming Manual Pages C 3PSL DISC ACK 3ASAI Name C 3PSL DISC ACK Acknowledge a third party selective listen disconnect Type Continuing Unacknowledged Usage typedef struct asai_common_t asai common long cause value ja3psl disc nak t typedef union asai_common_t asai common a3psl disc nak t a3psl disc nak a3psl disc ack t Description The client receives this capability as a positive or negative acknowledgment of a C 3PSL DISC request asai common Within this structure capability is returned as C 3PSL DISC ACK primitive type is returned as C POS ACK for positive acknowledgment andas C NEG ACK for negative acknowledgment The sao id also known as cluster id specified in the C 3PSL
61. client encapsulates ASAI capabilities from the application using External Data Representation XDR When the server receives the request for service from the client it will in turn decode the XDR encoded capability and push it down the ASAI stack of the CallVisor PC Upon receiving the request the DEFINITY ECS will process and reply to the CVLAN server the server will encode the reply message and use a socket connection to send it to the CVLAN client The CVLAN client will then decode the message and hand it to the application Figure 1 1 illustrates CVLAN client server connectivity for CVLAN 1 10 Issue 1 October 1996 Installation ISDN BRI CallVisor PC TCP IP DEFINITY ECS ASAI LinX Un Were or Solaris X86 Ethernet RPC XDR SPARC Solaris TCP IP Client CVLAN Solaris X86 TCP IP Client CVLAN UnixWare TEME Client CVLAN Windows NT 3 51 TOP IP Client Figure 1 1 CVLAN Client Server Connectivity CVLAN speeds up ASAI adjunct application development by taking care of the network connectivity and message transfer between client and server This present release of CVLAN can only handle one client application per user CVLAN client is supported over the following platforms UNIX SVR4 2 UnixWare 1 1 and 2 x Solaris x86 Sparc Solaris and Windows NT 3 51 The CVLAN server is supported on UNIX SVR4 2 Unixware 1 1 2 x a
62. default no agent Supervisory Assist A flag indicating that the call has been directed by an ACD agent who needs assistance to an ACD supervisor default 2 no assist m Alternate Destination A flag indicating that the called number is to be alerted first before the calling number default calling number first m User to User Data A substructure containing user data The structure contains the following fields Leng field An integer value that indicates the number of octets of user data included in the request This field is set to O if no user user data is present Currently ECS will accept up to 32 bytes of data Leng 32 If more than 32 bytes is specified all data is discarded Protocol field Indicates the type of information and is restricted to C UU USER which indicates a user specific protocol or C UU IA5 which indicates IA5 or ASCII characters Info field A pointer to an ASCII string of no more that 32 characters in length ans mach treat lf ans mach treat is CO AM DISC the call is disconnected upon answering machine detection If the treatment is C CO AM SWITCH it follows the setting in ECS administration If the treatment is C CO AM CONNECT the call is connected This parameter must be coded 1 if unused If the Service Circuit parameter is used to add a call classifier to the call and a call classifier is not available the server rejects the Third Party Make Cal
63. desired version and allowable alternatives QP DESIRED VER is set to the desired version Version 1 corresponds to G3V3 Version 2 corresponds to G3V4 and Version 3 corresponds to DEFINITY ECS release 5 For release 5 the default also is 3 QP HIGHERVER and QP LOWERVER are provided to allow higher version and or lower version operation these parameters are O to prevent higher and or lower version numbers and 1 to permit them The tunable parameters are located in etc conf cf d stune The defaults are QP DESIRED VER is set to 3 release 5 QP HIGHERVER is set to 3 to allow higher later versions QP LOWERVER is set to 1 to allow lower earlier versions For Solaris the tunable parameters are located in etc system directory To change the values edit the etc conf cf d stune file Follow the standard tuning procedures and rebuild the kernel then reboot the system Execute the command shutdown i6 y g0 to reboot the system If the version parameters are incompatible with ECS version the BRI link will not start up The QP module will log this error to the system console and the crash buffer 1 24 Issue 1 October 1996 Administration ASAI administration consists of a few tasks that have to be performed at regular intervals and or under certain conditions These tasks are referred to as operation administration and maintenance OA amp M For the most part they are simple merely requiring you to enter a command
64. determined by the status of relays on the IPCI board When they are energized the phone and ECS are connected by the pc software When the relays are not energized the phone and ECS are directly connected by a metallic connection switch_connection The connection to ECS is either act ive or not active switch tei The board LAPD Terminal Endpoint Identifier TEI is printed as a decimal number and will not be greater than 127 link status Indicates the status up or down of both levels 1 and 2 Files dev isdn ipci command See Also command 7 2 36 Issue 1 October 1996 ipci_test 1 ipci_test 1 Name ipci_test Test an IPCI Board Synopsis ipci test n Description IPCI board n is tested Operation If the board is online nondestructive loop back online tests are done If the board is offline board memory tests are done Return Value For success 0 is returned If an error is detected 1 is returned Output The online offline status is printed on stdout followed by the results of the test Errors are printed on stderr Files dev isdn ipci command usr adm isdn boot bin ipci_on 1 ipci_stat 1 Issue 1 October 1996 2 37 Administration ipci_ver 1 Name ipci_ver Print ipci product and software version information Synopsis ipci_ver Description Ipci product information is printed to stdout This includes the name date and version of the pumpware the ipci pro
65. dev asai asai usr bin ipci_off usr adm asai asai_parms usr adm isdn lan_parms See Also asai_test 1 asai_trace 1 Issue 1 October 1996 2 15 Administration asai_log 4 Name asai_log Log file for UNIX ASAI Description Files See Also This file contains all status and error messages It resides in the usr adm asai directory The format is time stamp program name ASCII message newline character time stamp consists of 12 characters in the format of yymmddhhmmss Program name is a 12 character field containing the name of the program left justified that contributed the message to the file The program name is padded on the right with space characters as needed to fill the field ASCII message consists of 0 through 53 ASCII characters Every line is ended by a newline character as shown This file should not grow quickly The programmer can monitor the size of this file if desired If this file does get close to the ulimit value it is renamed old_asai_log and subsequent messages are written to a new asai_log When the system is booted the old version of this file is renamed old_asai_log Anew asai_log file of 0 length is then created Subsequent messages are written to this new file Any previous copy of old_asai_log is removed by this operation usr adm asai asai log asai 4 asai_admin 1 ulimit 1 2 16 Issue 1 October 1996 asai_test 1 asai_test 1 Name asai_t
66. documentation Power up the computer The UNIX system should come up If it does proceed to the next step If it does not reboot again When the message Booting the UNIX system appears press the space bar When the system asks which file to boot from Enter the command stand unixold The system now boots using the kernel that was copied in the earlier step Call the CallVisor PC helpline number at 1 908 957 5725 for assistance before proceeding At the login prompt log in as root Observe the LED on the IPCI board This LED will normally begin to flash within 90 seconds after you log in If it does not flash call the CallVisor PC helpline number at 1 908 957 5725 A flashing LED means the board hardware and software are operating correctly Be sure that the DEFINITY ECS administration has been completed and the BRI line is connected to the LINE connector on the IPCI board Enter the command asai_test This tests the connection from the adjunct to the DEFINITY ECS and verifies that the administration is correct All boards and connections ISDN and LAN are tested If the test passes a success report is displayed The QP module logs link startup failures to both the system consoles and the crash buffer If the QP module has failed it is probably because of DEFINITY ECS and adjunct version incompatibility If QP messages are seen on the console correct the parameters as described in the Configuring and Reconfiguring
67. enter the command cvin_itt lt Script name gt 2 For Windows NT 3 51 system double click on the CVLAN Client program icon Select the ITT Scripts item under the Execute popup menu as shown below gt NOTE After the installation check that the CVLAN Client program group has been created under Windows NT 3 51 CVLAN Sample Client Application vla File Execute Help Figure 1 2 CVLAN Client Application 1 14 Issue 1 October 1996 Installation 3 Enter the name of the ITT Script that you would like to execute An example is shown below CVLN_ITT TESTS Please Enter Filename of Test Script heartbeat t Figure 1 3 CVLAN Test Issue 1 October 1996 1 15 Installation 4 Pressing OK starts the execution of the test specified in the ITT Script As the reguests are sent and ECS responses received these reguests are displayed in the CVLN_ITT SEND RECEIVE LOG as shown in the screen below CLVN_ITT SEND RECEIVE LOG Send Message to Switch HEARTBEAT REQUEST asai_send 888 amp heartbeat 16 asai common capability C HB REQ value 25 asai common cluster id 0 Received Message from Switch asai common ptr capability C HB CONF asai common ptr primitive type C POS ACK common ptr cluster id 0 Log Results Figure 1 4 CVLAN Client Log 1 16 Issue 1 October 1996 Installation
68. first and must be set to contain the IP address of the CVLAN server and the node on that server Use the characteristic C SERVER to specify the names of the node s for which your application will provide services If your application is a client only you do not need to do this Note that each node will allow only one server for each kind of service Return Value 6 6 The function returns 0 on successful completion and it returns 1 if an error occurs Example if asai_set_env socketfd C NODE ID nodeid lt 0 asai errval asai set env failed exit asai_errno Here node ID must be in the form of IP address signal for example WWW XXX yYyy ZZZz Signal 01 Issue 1 October 1996 asai_get_env asai_get_env Description The asai_get_env function allows you to check the version of the ASAI library The version number of the ASAI library includes three values major minor and delta A change to a major value indicates significant functional changes to the ASAI library for example addition of new capabilities A change to a minor value indicates changes made to existing capabilities A delta change indicates a correction with no change in parameters or functionality The parameters major_ver minor_ver and delta_ver represent these values respectively Prototype long asai_get_env int socketfd long attr get_type value Argument The first argument is the socket file descript
69. from the call to asai open The symbolic name of the capability that you expect to receive If it is not important which capability is to be received then a value of will tell the test tool to skip its validity checking of this field The value of capability type also known as primitive type is taken from the expected file The name of a file where the cluster identifier will be stored If this information is not needed later a file name dev null can be specified The name of a file where the output of the asai rcv Will be stored It will be an ASCII file consisting of name value pairs See capability specific sections of this document for more detailed information on these files If the output parameter is omitted the information received from the ASAI provider will only be printed on the screen and will not be stored in any file An optional field contains the file name that contains name value pairs that tell the test tool what you expect to receive from the library These name value pairs must be in the same order and are formatted like the output file described previously The test tool will compare these name value pairs against the name value pairs received from the library If a single capability description match is not found in the expected file an exception is printed If multiple description matches exist and a value cannot be found an exception is printed If there is no expected file enter NULL and the t
70. id ptr points to a character array that indicates ECS assigned identifier of the call before conferencing id lengtnis the length of the call identifier aft call idis a mandatory structure of the type call id t where id ptr points to a character array that indicates the ECS assigned identifier of the call after conferencing id lengtnhis the length of the call identifier calling num See C_ALERTING LH See C CONNECTED called num SeeC CONNECTED called type SeeC CONNECTED part numis the number of structures of the type merge ext t contained in the buffer pointed to by party list party list is a pointer to a list of structures of the type merge _ext_t Within merge_ext_t part y_id identifies a party on the conferenced call id ptr points to a character array that identifies the ECS assigned identifier of the party being conferenced id_length is the length of the party identifier extension is a pointer to a null terminated string that specifies the extension of the party old pidindicates the old party identifier before the call is merged which call can assume the values of C RESULTING CALL or C OTHER CALL and indicates whether the old party belongs to the resulting call or to other calls If this item is not supplied extension is a null pointer See C ALERTING Issue 1 October 1996 9 117 Programming Ma
71. if the ASAI application is controlling a large number of stations or calls the NCLID will need to be adjusted In any case the NCLID value should always be set to conform to your system s specific operational needs The default of 2048 specifies that each BRI board installed be limited to 2048 active associations and that approximately 296K of adjunct memory be reserved on behalf of each board 2048 x 148 bytes per association 296K If four boards are installed a total of approximately 4 x 296K will be reserved for tracking their combined associations Note that with four boards installed if the adjunct has four megabytes of memory or fewer system performance will suffer greatly In this case it is recommended that one or more boards be removed or that the NCLID be lowered Lowering the NCLID reduces both the number of active associations and the amount of adjunct memory reserved for each board 1 22 Issue 1 October 1996 Installation For instance setting the NCLID to 1024 reduces the number of active associations per board to 1024 and cuts the amount of reserved memory per board to 148K 1024 x 148 Alternately setting the NCLID to 512 reduces the number of active associations per board to 512 and cuts the amount of reserved memory per board to 74K 512 x 148 These settings are not likely to impact the performance of most applications Certain ASAI applications may reguire the NCLID to be increased above the default of 20
72. in this file 1 comment lines and 2 message lines A comment line has as its first character It is followed by zero or more ASCII characters that are followed by a new line character A comment line may contain a maximum of 61 characters This limit includes the of character and the new line character Blank comment lines can be used to provide relief between successive messages A message for a particular status or error number may consist of one or more message lines The format of a message line is number space ASCII message gt lt newline character number is the status or error number It is a field of six characters with the number right justified The number consists of digits only and is padded to the left with either blanks or zeroes ASCII message is from 0 to 53 ASCII characters Subsequent message lines of the same message contain the same status error number also The messages in the file must be in ascending status error number order usr adm isdn log msgs ipci admin 1 asai log 4 Issue 1 October 1996 2 55 Administration pcisdn bin 4 Name pcisdn bin IPCI Board ISDN Program File Description This program file is downloaded to the IPCI board by ipci_on 1 Files usr adm isdn pcisdn bin See Also ipci_on 1 boot bin 4 2 56 Issue 1 October 1996 signal 7 signal 7 Name signal IPCI and LAN GATEWAY Device Driver Communication Files
73. is an integer indicating the number of trunks in use C NUSE LONG if not provided I C TIME OF DAY vqc time year is specified by a binary quantity that is specified by 2 digits month is specified by a binary quantity that is specified by 2 digits day is specified by a binary quantity that is specified by 2 digits hour is specified by a binary quantity that is specified by 2 digits minute is specified by a binary quantity that is specified by 2 digits second is specified by a binary quantity that is specified by 2 digits Gl C_AGT_STAT vqc_agt_stat talk_state canbe C_ON_CALL or C_IDLI work_mode canbe C_MANUAL_IN C_AUTO_IN C_AFTCAL_WK or C_AUX_WORK reason_code can be an integer from 1 to 9 indicating the reason why the agent is in auxiliary mode Issue 1 October 1996 9 155 Programming Manual Pages Table 9 4 Associated Items and Descriptions for C_VQ_CONF Continued Item Type vqc buf Member Item and Description C AAID vqc aaid ItemandDescription domain type is an integer value indicating the type of the entity queried for example Station VDN etc extension is a pointer to a null terminated string indicating the name associated with the extension number supplied in the request name a point to a null terminated string indicating the name associated with the extension in the Integrated Directory Database This name will be from 1 to
74. it to gather the proper information to execute that function Test script files can have embedded comments but these must appear on lines by themselves Comment lines should start with a sharp symbol followed by a space and then the comments Comment lines will appear in the trace but will not be interpreted by the test tool Figure 10 3 shows embedded comments T Copyright c 1996 Lucent Technologies All Rights Reserved THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF Lucent Technologies The copyright notice above does not allow for any actual or intended publication of such source code FILE Name test event AUTHOR Robert Hutchison PURPOSE this script tests the event notification features of the ASAI library dE dE db dB b db SR SR db Ge mS Ae Pi Figure 10 3 Script File Comments Issue 1 October 1996 Scripts stall Each command noncomment line in the test script file contains the following parts library function name return value filename capability specific arguments The name of the ASAI library function to be executed for example asai_open is used to open communication with the ASAI stack and ECS The name of a file where the return value of the function is to be stored This is especially important for the asai_open call because we need to save its return value to be used as input to subsequent calls If the return value is to be ignored a reference to dev nu1
75. length acd_split_ext is a pointer to an optional null terminated character string that indicates the ACD split extension that has distributed the call to an alerting agent If the number is not supplied acd split ext is a null pointer trk is a structure of type trunk id t Within this structure direct is a parameter that can be C_NODIRET C_INCTRK or C_OUTTRK These values indicate the direction the trunk was used no direction incoming or outgoing If the ECS does not supply this item the library supplies a value of C_LNUSE_LONG grp ptr is a pointer to an optional character string of length gid_length that indicates a ECS assigned identifier of the trunk that was used If this item is not ECS provided the pointer is a null pointer Similarly 3d ptr is a pointer to a character string of length 1d length that indicates the ECS assigned identifier of the trunk that was used If this item is not ECS provided id ptr is a null pointer oli is an optional oli t structure that specifies II digits from the originating line information for the call Issue 1 October 1996 9 109 Programming Manual Pages Table 9 2 Event Name Members and Descriptions Continued Event Name evr_buf Member Description C_ALERTING Continued alert_list Continued pool is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool
76. login password Issue 1 October 1996 8 11 ASAI Capability Primitives Table 8 1 ASAI Library and DEFINITY ECS Cause Values Continued DEFINITY ECS ASAI Cause Value Value Value Description C_INCS_AGT_ST CS3 12 20 Agent not in compatible state C_INVALID_MESSAGE CS0 95 40 Invalid message unspecified backward compatibility C_INVALID_CRV CS0 81 10 Invalid call identifier sao id also known as cluster id used or call does not exist C_INVLDIE CS0 100 6 Value specified in parameter is not allowed or defined C_INVLDNUM CS0 28 0 Invalid origination or destination address C MAND INFO CS0 96 5 One of the required parameters is missing C_MAXLOGIN CS3 13 21 Agent logged into maximum number of splits C_NO_TONE_CHANNEL CS0 82 54 Channel and or tone does not exist no tone connected to the specified call C_NUM_CHANGED CS0 22 34 Number changed C NETCONJ CS0 42 26 Association terminated because of network congestion C NETWORK OUT OF ORDER CS3 38 47 Network out of order C NO ANSWER CS3 19 43 No answer C NO CIRCUIT CS0 34 36 No circuit or channel available C NO CLASSIFIERS CS3 21 45 Classifiers not available C_NOLOGIN CS3 15 13 Agent not logged into split C_NON_EXIST_MESSAGE CS0 97 41 Message nonexistent not implemented C_NORMAL CS0 16 25 Normal termination call routed successfully C NORMAL UNSPECIF CS0 31 35 Normal unspecified
77. of referring to an endpoint without dealing with the specifics of the way ECS tracks calls users or ports and without dealing with the device used by the connected party party_id is unigue within call_id and is assigned by the node that processes the call Peer Destination for ASAI requests or the source of ASAI indications PRI Primary Rate Interface referring to the ISDN physical interface providing 23 64K bps full duplex B channels and 1 64K bps D channel for message oriented signaling Pump The action of downloading software to an intelligent peripheral card Q 0 931 ITU recommendation Q 931 which describes basic call control on ISDN BRI or PRI 0 932 ITU recommendation Q 932 which describes mechanisms for gaining supplementary services on an ISDN BRI or PRI R RELease COMplete Message The ISDN message type used to complete the ASAI Set Value and Value Query capabilities Issue 1 October 1996 GL 7 Glossary S SACF Single Association Control Function that portion of an SAO that controls the interaction between two different ASEs SAO Single Application Object group of ASEs and an SACF that is used to communicate with a peer process Preferred term for association See also Association SAOID SAO identifier preferred synonym for cluster ID and association ID Seized One of the five possible states for a party on a call Seized indicates that the party is external to ECS and is represented by
78. parameter is a boolean field containing the collect or collected flag timeout This parameter specifies the digit collection time out and is an integer value from 0 to 63 the default is 0 call_udata This parameter is a pointer to a null terminated character string of user data If leng_udata is 0 then it points to a null character as the first character vdn_num This parameter contains the domain VDN from which the route reguest is being made priority_level This parameter is an integer value that indicates the priority of the call It can be C_NOT_IN_OUEUE C_LOW C_MEDIUM C_HIGH or C_TOP If this item is not supplied it assumes the value of C NUSE LONG interflow type This parameter is an integer value that indicates the type of interflow It can be C ALLINT FLOW C THRINT FLOW Or C VECINT FLOW If this item is not supplied it assumes the value of C NUSE LONG hour minute second These parameters indicate the time the routed call is to spend in the queue before interflow Time is given in the integer values of hour minute second If ECS does not supply a time value the library sets all of these items to the value of C NUSE LONG dnis chars This parameter is a pointer to an optional ECS specified null terminated string that indicates an identifier of the interflow source If this parameter is not supplied by ECS itis a null pointer w dnis chars This parameter poi
79. pool parameter is a character array that provides buffer space for the ASAI Poor Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Issue 1 October 1996 9 53 Programming Manual Pages Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai send C EN REP C 3PMC CONF C 3PTC REQ C 3PTC CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF 9 54 Issue 1 October 1996 C_3PR 3ASAI C 3PR 3ASAT Name C 3PR Reconnect a held party Type Continuing Acknowledged Usage typedef struct asai common t asai common party id t party id call id t call id char pool C DATSZ a3pr info t Description The client sends this capability to request reconnection of a held party to a call controlled by the client The structure of type a3pr info t contains the parameters needed to fulfill the request asai common The programmer sets capability to C 3PR and primitive type to C REQUEST sao id also known as cluster id identifies the association that controls the call to be reconnected The programmer also sets the sao id cluster id to t
80. pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information cause_value This parameter can be any of the following C_FACUNSUB NCOM_OPT NVLDIE NVLDNUM AND_INFO I ANE I M PROTERR _R _S 9 ESUNAVL ER UNIMP ERV UNAVIL QO0000000 See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Return Value When this capability is used in an asai rcv the function returns the size of the message when successful and 1 on failure A return value of 0 does not indicate an error but that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Issue 1 October 1996 9 49 Programming Manual Pages See Also asai_rcv C_EN_REP C_3PMC_REO C_3PTC_REO C_3PTC_CONF C_3PSH C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF C_3PSD C_3PSD_CONF C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF 9 50 Issue 1 October 1996 C 3PMC REQ 3ASAI C 3PMC REQ ASAI Name C 3PMC REQ Make a third party call Type Initiating Acknowledged or unacknowledged Usage typedef struct asai common t asai common char calling num char called num user user t uudata long ofacility char ofac ext
81. precision higher than the hundredths is specified for example 127 312 See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai send C SV CONF 9 150 Issue 1 October 1996 C_VQ_CONF 3ASAI C VO CONF 3ASAI Name C VQ CONF Acknowledge and terminate a value query request Type Terminating Unacknowledged Usage typedef struct asai common t long long vqc cause t typedef struct asai common t long long long long vqc split t typedef struct asai common t long long long jvqc cc stat t typedef struct asai common t long long long jvqc tg stat t typedef struct asai common t long long long long long long long asai common vqc type cause value asai common vqc type num login num avail num callinque asai common vqc type num avail num inuse asai common vqc type num avail num inuse asai common vqc type year month day hour minute second Issue 1 October 1996 9 151 Programming Manual Pages vgc_time_t typedef struct asai_common_t long long long long vqc_agt_stat_t typedef struct asai common t long long vqc station t typedef struct asai common t long long stn info t char vqc cal stat t typedef struct asai common t long long party ext t cha
82. provided by the messages Otherwise the message Installation of lt cvesai gt was successful is displayed Place the CallVisor PC ASAI product disk in the appropriate drive and follow the online instructions Pkgadd displays that the CallVisor PC ASAI package is available to process Press to continue the installation Issue 1 October 1996 1 5 Installation 19 20 21 After several minutes the installation procedure displays the number of ASAI nodes that the package is configuring If this information is not available the installation procedure asks you to enter the number of ASAI nodes This is the combined total number of IPCI boards that are already installed or that are going to be installed and the number of LAN links being installed on the machine The default is 1 Enter the correct number 1 to 8 or press for the default After the installation procedure rebuilds the kernel the installation program asks you to remove the diskette from the disk drive and shutdown instructions are displayed The message Installation of lt cvasai gt was successful is also displayed m If this is an upgrade enter the command shutdown i6 y g0 and return to step 19 and proceed m If hardware is to be installed enter the command shutdown i0 y g0 When the screen message reboot the computer now appears shut off the power If no ISDN links were installed proceed to Step 27 With the power shut off install the IPCI boa
83. received from the IPCI driver a corresponding formatted message is written to the asai log file A CAUTION The ipci admin daemon should never be killed with a kill 9 a kill 15 should be used to allow the daemon to clean up the semaphores and message queues prior to exiting If the semaphores or message queues become locked or hung they can be freed using the ipcs 1 UNIX utility Exit Codes Files This program if it exits will exit with a code of 1 Since this program is meant to be run as a daemon process the exit code probably does not carry any great significance dev isdn ipci admin dev isdn ipci signal usr adm asai asai log usr adm asai log msgs Issue 1 October 1996 2 31 Administration See Also 7 asai_ ipci 4 log_msgs 4 w Q 3 Eis D o Q T n p Q 3 IR link restart 1 link status 1 2 32 Issue 1 October 1996 ipci_off 1 ipci_off 1 Name ipci off Put specified IPCI board offline Synopsis ipci off n Description This command is used to place board n offline The value of n can be 1 2 3 or 4 When this is done no new instances of communication between the UNIX ASAI adjunct and ECS can be started After executing this command the board cannot be used for any signaling requests To place it back online it must be pumped using ipci on Exit Codes If an error is encountered or if the board is already offline 1 is returned as the e
84. removal commands 1 19 splitcommand 2 2 B stall scriptcommand 10 5 SY IPCIJ2 54 00 IPCI board printing stderr IPCI ON 11 2 7 stdout actual messages file streams available number 9 1 supervisory assist 5 23 switch administration ASAI link ext num 11 2 switch connections testing 2 17 switches multiple communication 9 1 system operation CVLAN 1 12 n system startup CallVisor PC ASAI 1 24 9 T t input description 10 27 S t output description 10 28 i TCP IP port CVLAN connecting client and server 2 58 Technical Service Center telephone number xvi terminating capability definition j9 20 term ASAI 3 3 sd test script library functions 10 2 test connections 2 17 Cd Third Party AnswerCall 5 13 O Third Party Answer Call Confirmation 9 29 Third Party Auto Dial 5 14 Third Party Call Control capabilities Third Party Call Ended 5 16 Third Party Clear Call 5 17 Third Party Clear Call Confirmation request Third Party Domain Control 5 18 Third Party Domain Control Confirmation 9 37 Third Party Domain Control End 5 19 Third Party Listen Disconnect 5 20 80 Third Party Listen Disconnect Acknowledgement 9 82 Third Party Listen Reconnect 5 21 9 84 lt Third Party Listen Re
85. request event notification The parameters associated with this capability are defined within en buf A set of common parameters for this capability is defined in en common Issue 1 October 1996 9 121 Programming Manual Pages Within en_comm on the programmer sets the asai_common parameters of capability to C_EN_REO and primitive_type to C_REOUEST domain_type indicates the domain of the events reguested and can be C_ACD_GROUP or C_CALL_VI ECTOR ACD group or call vector This capability initiates reports on the following items C ALERTING C CONNECTED C BUSY C DENIAL C HOLD C RECONNECT C LOGIN C LOGOUT C TRK SEIZED C ANSWERED C QUEUED C DROP C INITIATE C COLLECT C CALEND C C CALL ORIG and C OFFI I RED CUT_THROUGH C_CONFERENCED C_TRANSFERED The en_buf union members of aca_grp_info and cv_info contain the identifying information of the reguested domain The following table shows the domain identifying parameter and a description of the parameter The parameters listed in the table are mandatory Table 9 3 Domain Value Parameters and Description Domain Value Parameter Description C ACD GROUP domain ext Pointer to a null terminated string that indicates the extension of the ACD split pool Character array that provides buffer
86. should be on or off C MWI ONOrC MWI OFF sv flex When the sv_item is set to C sv FLEX the sv_flex union member indicates the specific item parameters Ca11 id is ECS assigned identifier of the call to which the billing rate is to be applied The value of this parameter is a character array of length id length pointed to by id_ptr The bill type parameter specifies the rate treatment for the call and can be one of NEW RATE FLAT RATE PREM CHARGE PREM_CREDIT Of FREE CALL The bill rate parameter is a floating point number that specifies the rate according to the treatment indicated by bill type gt NOTE The bill rate is not sent to ECS when the bill type is FREE CALL The poo1 parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that there is no data to be sent Issue 1 October 1996 9 149 Programming Manual Pages Errors Ac SV MWI request will return C BADPMATCH if the called_num parameter is not set Ac sv FLEX request will return C BADVALUE if the bill rate parameter is greater than 999 99 or a
87. struct asai common t long char char jvq scf stat t typedef struct asai common t long long char char vq aaid t asai common vq item extension pool C DATSZ asai common vq item call id pool C DATSZ asai common vq item extension pool C DATSZ asai common vq item extension pool C DATSZ asai common vq item extension pool C DATSZ asai common vq item extension pool C DATSZ asai common vq item domain type extension pool C DATSZ Issue 1 October 1996 9 161 Programming Manual Pages typedef struct asai_common_t asai_common long vq_item vq_common_t typedef union vq_common_t vq common vq split stat t vq split stat vq tg stat t vq tg stat vq agt stat t vq agt stat vq station t vq station vq agt aud t vq agt aug vq cal stat t Vq cal stat vq pty stat t vq pty stat vq ext stat t vq ext stat vq mwi stat t vq mwi stat vq sac stat t Vq sac stat vq scf stat t vq scf stat vq aaid t vq aaid req vq buf t Description The client sends this capability to request information concerning a specified item The information needed to fulfill the request is contained in the members of the vq buf union The data common to all requests is contained in va common The programmer sets the capability to c vo REO and the primitive type to C REQUEST The programmer also sets the sao id also known as cluster ig
88. switch in this case DEFINITY ECS client A program that sends service requests to another program generally on a different processor called the server Usually ECS is the server and CV PC is the client However this is not the case with adjunct routing and this role interchanges in heartbeat requests for example heartbeat requests and confirmation can come from both the sides at any time server 1 The DEFINITY Enterprise Communications Server ECS customer premise telephone switch equipment 2 A program that responds to requests from another program generally on a different processor called the client Usually ECS is the server and CV PC is the client except for adjunct routing and heartbeat request where the role interchanges for example heartbeat requests and confirmation can come from both the sides at any time library The ASAI library provider of ASAI services program The application program that uses the services of the ASAI library whether as a client a server or both The term application is used only in the phrase application program or application programmer To ECS application means an adjunct entity that requests and receives ASAI services or capabilities Although more than one application can reside on a single adjunct ECS is unable to distinguish between these applications As a result the adjunct and all resident applications are treated as a single application and these terms are used inter
89. t char plan type t user user t long char call id t trunk id t oli t wchar t char rt info t Description asai common cal calling type called num called type data leng udata udata type collect timeout call udata vdn num ing num priority level interflow type hour minute second dnis_chars call_id trk oli w dnis chars pool C DATSZ The client that is ECS sends this capability to request a call route A structure of type rt info t contains the information needed to fulfill the request asai common The programmer sets the capability to C RT REQ and the primitive type to C REQUEST The programmer also sets the sao id also known as cluster id 9 138 Issue 1 October 1996 C_RT_REQ 3ASAI calling_num This parameter is a pointer to a null terminated string that specifies the calling extension See t rk parameter for more information calling_type This parameter is an optional plan_type_t structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL called_num This parameter is a pointer to a null terminated string that specifies the called extension of the request called_type This parameter is a plan_type_t structure that supplies additional information about the structure field that immediately precedes i
90. the logical agent id split_ext is a pointer to a null terminated string that specifies the extension for which the agent is logging in agt_ext is a pointer to a null terminated string that specifies the agent extension work_mode can be C_AUX_WORK C_AFTCAL_WK C_AUTO_IN or C_MANUAL_IN auxiliary mode after call work mode auto in mode and manual in mode poo1 is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information agt_logout_t This structure contains the parameters needed to reguest the agent logout feature split_ext is a pointer to a null terminated string that specifies the extension from which the agent is logging out agt_ext is a pointer to a null terminated string that specifies the agent extension reason_code option is a long integer indicating the reason for the agent logout poo1 is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information chg wkmod t This structure contains the parameters needed to request a change in the agent work mode feature split ext is a null terminated string that specifies the extension for which the work mode is to be changed agt ext is a pointer to a null terminated string that specifies the agent extension work mode can
91. this capability as a positive or negative acknowledgment to a set value request The union sv_resp contains the necessary information for both Within asai_common the capability is returned as C_SV_CONF and primitive type is returned as C_POS_ACK for positive acknowledgment and C NEG ACK for negative acknowledgement The sao id also known as cluster id ofthe association specified in the set value request is also returned cause value This parameter can be any of the following C FACUNSUB INVLDIE ERV UNAVIL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values 9 146 Issue 1 October 1996 C_SV_CONF 3ASAI Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of O does not indicate an error it merely indicates that no data has been received at this time Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai rcv C SV REO Issue 1 October 1996 9 147 Programming Manual Pages C SV REO ASAD C SV REQ Set the value of an item in the domain of the provider Name Type Initiating Acknowledged Usage typedef struct asai_common_t long long char char sv_mwi_val_t typedef struct Sv common t call id t long float char sv flex t
92. type symbolic values C ACD GROUP C CALL VECTOR enter choice C ACD GROUP field name acd grp info acd group enter value 2015551212 is P Figure 10 5 Event Notification Request The test tool prints the information as it extracts it from the command line asai_send send_ret fd_value C_EN_REQ C_REQUEST cl_id en_parms and then prompts the user for the proper capability specific values It then stores the answers in the file en_parms the last argument on the command line as follows en_common domain_type 129 acd_grp_info acd_group 2015551212 Note that although the symbol C ACD GROUP was used in the interactive mode the actual value was stored in the file Issue 1 October 1996 10 11 Testing asai_rcv This script command allows the user to receive messages from the ASAI provider that is ECS The script command line s format is as follows asai rcv rcv ret fd file CAP CAP Type clid fn output expected timer 10 12 Issue 1 October 1996 Scripts The command line expects six seven or eight arguments described as follows rcv ret fd file CAP CAP Type clid fn output expected timer The name of the file where the return value from the asai rcv Will be stored If the return value is not important you can specify dev null The name of a file that contains the file descriptor value It should probably be the same file that kept the return value
93. type is a short integer that can have these possible values unknown 0 international 1 national 2 and subscriber 4 The parameter numb plan is also a short integer and can have these values unknown 0 ISDN telephony 1 reserved 2 and private numbering plan 9 Additional values for both parameters may be coded in the future number id typedef struct char Ns plan type t type plan number id t Within number id t the s field when not NULL is an ASCII string that specifies the connected number If s is NULL the following field t ype_plan is undefined The type plan field is of type p1an type t Issue 1 October 1996 8 7 ASAI Capability Primitives party_ext typedef struct party_id_t party id char extension plan type t ext type party ext t Within party ext t the parameter party idis a structure of type party id t The extension parameter points to a null terminated string that specifies the extension corresponding to the party identifier ext type is a structure of type plan type t that supplies additional information about the extension field that immediately precedes it providing that the extension field is not NULL stn info typedef struct call id t call id party id t party ig long pty state long reserved stn info t Within stn_info_t the call id parameter is a structure of type call id t where id length specifies the length of an ECS assigned call identifie
94. typedef struct asai common t long sv common t typedef Union Sv common t sv mwi val t sv flex t sv buf t Description asai common sv item mwi item called num pool C DATSZ SV common call id bill type bill rate pool C DATSZ asai common sv item SV common sv mwi val sv flex The client sends this capability to request that the value of specified items be set These requests are initiated from the adjunct the time of the day can be set only by ECS Within the union sv buf t the parameters contained in the sv common member define a set of common parameters needed to fulfill the request Specific item parameters are contained in the sv mwi val Or sv flex members 9 148 Issue 1 October 1996 C_SV_REQ 3ASAI asai common Within this structure the programmer sets the capability to C sv REQ and the primitive type is set to C REQUEST The programmer also sets the sao id also known as cluster id The parameter sv item defines the domain of the items to be set This parameter can be C SV MWI message waiting indicator or c Sv FLEX flexible billing sv mwi val When sv itemis set to C Sv MWI the sv mwi val union member indicates the specific item parameters The called num parameter is a pointer to a null terminated string containing the extension of the end point for which the indicator is to be set mwi type indicates whether the light
95. until one of the following terminates the association m The client sends Event Notification Cancel m The server sends Event Notification End m The client receives an Abort capabilit Request Indication Parameters Domain The domain over which notifications are requested Domain consists of Domain Type ACD split skill or VDN wm Domain Value The specific domain within domain type that is to be the subject of reports Notes The client can request notification only for domains directly associated with the server Only one domain can be included per request Issue 1 October 1996 5 3 ASAI Capabilities Event Notification End Description The server sends the Event Notification End capability if it can no longer provide the requested service The client receives no further event reports on the specified association identifier The ASE is terminated The server invokes this capability by sending a C EN END Notes Notification must have been initiated through the Event Notification Request capability 5 4 Issue 1 October 1996 Event Notification Cancel Event Notification Cancel Description The Event Notification Cancel capability allows the client to reguest cancellation of event reports for a specified domain The client invokes this capability by sending a C_EN_CAN to which the server responds with a C EN CAN CONF If the confirmation is positive the ASE instance i
96. 0 46 79 No restart acks 08 02 00 00 46 79 will be run 10 The installation procedure asks you to enter higher version operation QP_HIGHERVER is provided to allow higher later version operation These values are 0 to prevent higher version numbers and 1 default to permit higher version numbers Please enter 0 or 1 or press for the default The installation procedure asks to enter lower version operation QP_LOWERVER is provided to allow lower earlier version operation Enter 0 or 1 or press for the default gt NOTE These values are set on a per adjunct PC basis not on a per link basis If the adjunct is to be connected to both a G3V3 link and a G3VA link it would be advisable to select 1 for QP LOWERVER and 2 for QP HIGHERVER Also 2 should be selected for QP DESIRED VER Version 3 corresponds 1 4 Issue 1 October 1996 Installation to DEFINITY ECS release 5 For release 5 the default also is 3 So for release 5 QP_HIGHERVER and QP DESIRED VER should be set to 3 12 The installation procedure asks you to remove the diskette from the disk drive and displays shutdown instructions The message Installation of cvisdn was successful is also displayed If you are not installing the optional CallVisor PC LAN GATEWAY package skip to Step 18 gt NOTE The CallVisor PC LAN GATEWAY installation script assumes that you have completed the ASAI MFB installation prior to the CallVisor PC LA
97. 1 expert agent selection9 113 9 134 ext num ASAllink 11 2 extension domain take control 9 39 O extension definition 3 4 Cd F facility access code ACD split 5 23 0 fd file descriptor feature request change agent work mode5 40 Z Z o Send All Calls 5 40 function call falutes 44 E G get_long description 10 21 get_string description 10 22 H Heartbeat ASAI responses 11 3 0 failed link detection request 3 9 U Heartbeat capability 3 3 5 48 Z Heartbeat OA amp M process invoking application Heartbeat Request 9 129 U Heartbeat acknowledgements 2 14 ss Held PartyReconnect 9 55 CS held state 57 _EZEZ ES highest allowed version QP HIGHERVER 1 4 stn info trunk_id 8 7 0 0 0 0 0 0 0 0 0 0 user to user data 8 9 ool II digits xiii 5 44 9 109 ee info field 5 23 initiating capability definition 9 20 sid inoperable system errors reasons 11 5 1 interrupt level number seelRO interrupt levels setting 9 1 Interrupt Vector Number see introduction ASAI Capability Primitives 8 1 1 CVLANJO1 O IPCI boarddefinition 2 Cid Bootstrap Loader Program definition device driver messages tracing instalaionsteps 11 1 link printing stat
98. 1 October 1996 3 9 Introduction to ASAI Application Service Elements The ASAI Application Service Elements ASEs support ASAI functions ASEs also referred to as capability groups are the high level building blocks from which specific applications are constructed Each ASE defines a series of relationship interactions between a client and a server third party call control event notification value query and so on Each capability provides a specific type of interaction between the client and the server third party make call third party reconnect third party selective hold third party selective listening etc The client and server issue a sequence of calls to the send and receive functions in which capability primitives are exchanged The capability primitives request acknowledge and terminate an interaction Table 3 4 lists the ASAI ASEs and the capability primitives in each group Table 3 4 ASAI Capabilities by Capability Group ASE ASE Capability Description Third Party Call Control C_3PAD Auto Dial C_3PAD_CONF Confirm Auto Dial C_3PANS Answer C_3PANS_CONF Confirm Answer C_3PCC Clear Call C_3PCC_CONF Confirm Clear Call C_3PCE Call Ended C_3PDC_CONF Confirm Domain Control C_3PDC_REQ Domain Control C_3PDCE Domain Control End C_3PM Merge C_3PM_CONF Confirm Merge C_3PMC_REQ Make Call C_3PMC_CONF Confirm Make Call C_3PR Reconnect C_3PR_CONF Confirm Reconnect Issue 1 October 1996 Application S
99. 1 October 1996 9 61 Programming Manual Pages Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of 0 does not indicate an error but that no data has been received Errors See Chapter 7 Error Messages for a list of error me explanations of their probable causes See Also asai rcv ssages with brief C EN REP C 3PMC REQ C 3PMC CONF C 3PTC REO C 3PTC CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3P C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3PRC 9 62 Issue 1 October 1996 C_3PREDIR 3ASAI C 3PREDIR 3ASAD Name C 3PREDIR Redirects an alerting call Type Continuing Acknowledged Usage typedef struct asai common t asai common call id t call id number id t redir num party id t party id char pool C DATSZ a3predir info t Description The client sends this capability to request that an alerting call be redirected to another number A structure of type a3predir info t contains the parameters needed to fulfill the request asai common The programmer sets capability to c 3PREDIR and primitive type to C REQUEST The programmer also sets the sao id also known as cluster id to identify the association that controls the alerting call call id call idis required for domain control associations and is ignored with call
100. 1 will be sufficient to throw away its value Other arguments on the command line are function specific and are described in detail with the particular command This script command temporarily stops the test tool and gives instructions to the person running the test This command can be used in demos where you want to stop and tell about what is happening or to give the operator instructions like pick up extension 1600 or dial 1601 from extension 1600 These instructions permit the operator to test functionality such as event reports The format for a stall command stall instructions instructions tells the operator what to do When these instructions are printed on the screen the operator is prompted to press the key Issue 1 October 1996 10 5 Testing asai_open asai_open 10 6 This script command causes the asai_open library function to be executed Its command line is as follows return_filename asai_special_file flags node_id server_num server_type The arguments to asai_open are as follows return_filename asai_special_file flags node_id server_num server_type Issue 1 October 1996 The filename of the file where the return value of the asai_open a file descriptor will be stored The value will be put in the file in ASCII so that it will be editable as necessary This file will probably be passed to subsequent commands wishing to refer to this stream file descriptor
101. 27 ASCII characters in length If the name is not found any of the optional elements of the RElease COMplete query response message will not be returned w name points to a translation of the raw OPTREX data in the name into its locale equivalent ISO four bytes characters See and ISO characters in the Glossary and ISO Characters for more information C_CAL STAT vqc_cal_stat stn_info is a pointer to a list of structures of type stn_info_t Each structure contains a structure call id that specifies ECS assigned call identifier values and length and a structure party id that specifies ECS assigned party identifier values and length and the current call state of the party pty state When no call information is returned for this capability Stninfo list is a null pointer num call is the number of structures in the list pointed to by st n_info Whenever no call identifiers are returned for this capability it assumes the value of C_NUSE_ LONG pool is acharacter array that provides buffer space for the ASAI library to store program specific information 9 156 Issue 1 October 1996 C_VQ_CONF 3ASAI Table 9 4 Associated Items and Descriptions for C VO CONF Continued Item Type vaqc_buf Member Item and Description C_PTY_STAT vqc pty stat party list is a pointer to a list of structures associated with the same call identifier Each structure contains the extension number and
102. 3psl disc ack t a3psl disc ack a3psl rconn t a3psl reconn a3psl reconn ack t a3psl reconn ack a3pr info t a3pr info a3pr rsp t a3pr rsp a3prc rsp t a3prc rsp a3pm info t a3pm info a3pm ack t a3pm ack a3pm nak t a3pm nak a3pcc rsp t a3pcc_rsp a3pce_info_t a3pce info a3pad info t a3pad info a3pad ack t a3pad ack a3pad nak t a3pad nak ober 1996 asai send 3ASAI a3dpans info t a3pans nak t a3pdco info t a3pdc ack t a3pdc nak t adpdce info t en scn t en scn nak t Et sv rsp t rf buf t rf rsp t rt into t rts_info_t rte_info_t rt_nak_t hb_nak_t hb_rsp_t en_scn_rsp_t a3psds_info_t a3psds_rsp_t a3predir_info_t a3predir_nak_t a3predir_ack_t sv bu jasai info t long int char long Description asai send fd buf fd buts length a3pans info a3pans nak a3pdc info a3pdc ack a3pdc nak a3pdce info en scn en scn nak Sv buf Sv rsp rf buf rf rsp zanto ts_info KG is rte info rt nak hb nak hb rsp en scn rsp a3psds info a3psds_rsp a3predir info a3predir nak a3predir ack length This function is used to send a message containing a primitive a capability or program specific information to the capability layer provider via the stream file descriptor d The message is contained in a buffer pointed to by buf of size length The maximum size of the user buffer is size of asai info t If the function is used i
103. 4567890 Figure 10 11 Connected Report a EVENT REPORT asai common capability 22 asai common primitive type 0 asai common cluster id 10 ev rpt ptr erep common event name 4 DROP REPORT ev rpt ptr drop list drop cause 25 ev rpt ptr drop list drop type 1 ke ev rpt ptr drop list droped num 1234567890 Figure 10 12 Drop Report Issue 1 October 1996 10 17 Testing 10 18 E EVENT REPORT asai common capability 22 asai common primitive type 0 asai common cluster id 10 ev rpt ptr erep common event name 12 CALLEND REPORT ev rpt ptr calend list calend cause 25 Figure 10 13 Call End Report Issue 1 October 1996 Manual Pages Manual Pages The following manual pages describe the utilities available to test the tool for the programmers Issue 1 October 1996 10 19 Testing close dialog out 3 Name close dialog out Synopsis close dialog out Description Closes the temporary dialog recording file opened by open dialog out lt knows the FILE pointer used for the file because the open function stored it in a static variable Return Value Returns SUCCESS or causes the program to exit with a status of 16 10 20 Issue 1 October 1996 get_long 3 get_long 3 Name get_long Synopsis long get_long fieldname cap_info char fieldname struct cap_info cap_
104. 48 If the ASAI application is using one ASAI link to control a large number of calls on a R5r the NCLID may need to be increased There is however a practical limit to which the NCLID value may be raised Appendix B ASAI and Release 5 Requirements of DEFINITY ECS Release 5 CallVisor ASAI Technical Reference discusses the capacity requirements and constraints for the DEFINITY ECS release 5 in detail For example Table B 1 of that appendix lists all the R5r systemwide ASAI limits for the maximum number of domain control station associations as 6000 However setting the NCLID to a value between the default 2048 and the maximum 9600 for example 5000 will not always guarantee that 5000 active ASAI associations can be supported Despite the fact that the theoretical maximum number of domain control station associations is 6000 the actual maximum number of associations is limited by the availability of a variety of other system resources For this reason you must consider several factors when setting the NCLID in the hope of maximizing performance The amount of memory available on the adjunct processor as well as the number of BRI boards installed greatly affect system capabilities It must also be noted that the capacity requirements and constraints on DEFINITY ECS release 5 apply equally to all ASAI links If an application uses more than one ASAI link or if other ASAI applications are connected to the same DEFINITY ECS the maxi
105. 9 sid 3rd Party Relinquish Control Request Confirmation 9 61 3rd Party Request Feature activating or deactivating ified endpoint 9 132 3rd Party Route End 9 136 o Z 8rd Party Route Request 3rd Party RouteSelect 9 142 3rd Party Selective Drop 5 3rd Party Selective Drop Acknowledgement reguest 3rd Party Selective Hold 5 3rd Party Selective Hold Confirmation request 3rd Party Send DTMF Signal Confirmation 3rd Party Send DTMF signals 5 33 72 sd 3rd Party Set Value Request 9 148 3rd Party Set Value Request Confirmation 3rd Party Set Value Request Termination 9 151 3rd Party Stop Call Notification Confirmation 3rd Party Stop Sending Event Reports 3rd Party Take Control 5 34 1 1 3rd Party Take Control Confirmation 3rd Party Take Control Request 9 90 3rd Party Value Query Request 3rd Party Value Query Response 9 165 A Abort association capabilities 5 5 25 55 550 EE user 3 12 ACD split domain acknowledgment MTS dial request active association definition 3 4 1 active state 5 7 adjunct ASAl logmessages 2 5b definition 3 3 routing capabilities group 5 42 sd Adjunct Switch Application Interface definition admin files administering 2 30 agent extension number 9 114 agent logical extension number 9 110 9 113 9
106. 99 6 receive reports from acd domain 7 B entest signal01 vec 9999 10 8 m receive 10 reports from vector domain 9 0 1 finclude stdio h 2 finclude sys types h 3 finclude sys stropts h 4 finclude asai asai defs h 5 finclude asai asai str h 6 finclude asai asai err h 7 8 extern char caps 9 extern char typs 20 extern char causes 21 extern char modes 22 extern char names 23 24 main argc argv 25 char argv 26 27 int fd cnt 28 en_buf_t en 29 asai_info_t rsp 30 31 if argc 4 32 33 usage 34 fprintf stderr usage s lt node gt acd vec lt num gt 35 lt reports gt n argv 0 36 exit 1 237 38 if stremp argv 2 acd 0 39 40 en acd_grp_info domain_type C_ACD_GROUP 41 en acd_grp_info domain_ext argv 3 42 43 else if strcmp argv 2 vec 0 44 45 en cv_info domain_type C_CALL_VECTOR Figure 4 9 Sample Code Testing the Event Notification Capabilities 4 16 Issue 1 October 1996 Sample Code a 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 Te 76 TI 78 79 80 81 82 83 84 85 86 87 88 89 90 en cv info domain ext argv 3 else goto usage if fd asai open dev asai asai 0 0 asai errval asai open dev asai asai failed exit asai errno if asai set env fd C NODE ID argv 1 0 asai errv
107. 996 2 23 Administration command 7 Name command IPCI Streams Device Driver Communication File Description The command file allows communication between certain OA amp M commands and the IPCI streams device driver The IPCI streams device driver communicates with the IPCI board and with software on the board This device is meant to be used by OA amp M delivered commands and not by customer commands Notes This file has the same major device number as admin 7 and the signal 7 files Files dev isdn ipci command See Also admin 7 signal 7 2 24 Issue 1 October 1996 esai_alarm 1 esai alarm 1 Name esai alarm Turn on or off 1sdn bri maintenance alarming Synopsis esai alarm alda b1 58 t0 tn e Description esai alarm Uses the suspend and resume routines to turn on or off the ASAI BRI port alarms associated with the link specified a Activates alarming d Deactivates alarming b linkNo Specifies the link where linkNo 1 8 has sent the message t numsec Sets the time out to n seconds where lt numsec gt 0 n Default is t 3 e Displays the exit codes list shown below Displays the terse help message Issue 1 October 1996 2 25 Administration Exit Codes If esai_alarn fails one of the following exit codes is returned 0 The alarm condition was changed per request 1 Failure due to inadequate memory 2 Open st
108. A return value of O does not indicate an error but that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai_rcv C_3PPREDIR C_EN_REP C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PTC_CONF C_3PSH C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF C_3PSD C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF 9 66 Issue 1 October 1996 C 3PSD 3ASAI C 3PSD 3ASAD Name C 3PSD Drop selected parties from a client controlled call Type Continuing Acknowledged Usage typedef struct asai common t asai common party id t party id call id t call id user user t uudata long resource char pool C DATSZ a3psd info t Description The client sends this capability to request that a party to a call controlled by the client be dropped from the call Any tone connected to a call except ringback tones may be dropped A structure of type a3psd info t contains the parameters needed to fulfill the request asai common The programmer sets capability to C_3P SD and primitive type to C REQUEST The programmer also sets the sao id also known as cluster id to identify the association that controls the call to be dropped party id party idis a conditional parameter and specifies the party to be dropped The length of the identifier is id length party id must be used when the association is i
109. AT none no additional items C TIME OF DAY none no additional items Issue 1 October 1996 9 163 Programming Manual Pages Return Value When this capability is used in an asai send the function returns a nonnegative value when successful and 1 on failure A return value of 0 indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai send C VO RESP C VO CONF 9 164 Issue 1 October 1996 C VQ RESP 3ASAI C VO RESP 3ASAI Name C VQ RESP Respond to a value query request Type Continuing Unacknowledged Usage typedef struct asai common t asai common long vgr item char agtext list plan type t agtext type long num ext char pool C DATSZ vqr agtaud t typedef struct asai common t asai common long vgr item vqr common t typedef union vqr common t vqr common vqr agtaud t vqr agtaugd jvgr buf t Description The client receives this capability in response to a value query request The requested information is returned in the members of the union vqr buf The information common to value query responses is contained in vqr common Within asai common the capability is returned as C VQ RESP and the primitive type as C REQUEST The association identified by the sao id also known as cluster id ofthe request is also returned The parameter va
110. CallVisor PC LAN GATEWAY may be run concurrently on the same adjunct PC Instructions to install CVLAN Client and Server software can be found in Server Installation on UNIX section of this chapter The adjunct is limited to a total of eight links any combination of up to four ISDN links and up to four LAN GATEWAY links is allowed The links must be installed contiguously their order may not be intermixed If ISDN links are to be installed they must be installed as link numbers 1 through 4 LAN GATEWAY link numbering must start immediately after the last ISDN link For example if three Issue 1 October 1996 1 1 Installation ISDN links and two LAN links are installed the ISDN links will be links 1 2 3 and the LAN links will be links 4 and 5 If no ISDN links are installed LAN links will be configured starting at link number 1 The installation scripts will perform this numbering automatically It is not possible to change the number of links ISDN or LAN without completely uninstalling and reinstalling the CallVisor PC ISDN CallVisor PC LAN GATEWAY and CallVisor PC ASAI packages The following steps must be performed in the order specified Throughout this document the PC ISDN board is referred to as the ISDN PC interface IPCI board and the ASAI Multi Function Board for the optional LAN GATEWAY package as the MFB The IPCI device driver is part of the CallVisor PC ISDN software that is pumped to the board If this is an upgrade
111. DFD Invalid file descriptor supplied C BADCHAR Unknown or improper context for a characteristic C_BADCHARVAL Unknown characteristic value specified C SERVEX Cluster service is being provided by another application C BADNODE Node is not available 9 18 Issue 1 October 1996 asai set env 3ASAI C SYSER ASAI service error C INTR A system call was interrupted by a signal C ACTIVE Stream has active cluster instance See Also asai open lasai rcv l llasai send lasai set env Issue 1 October 1996 9 19 Programming Manual Pages ASAI Capability Manual pages Name Type In these manual pages each capability is described by some or all of the following sections This section names and succinctly describes the capability This section gives the capability type Based on its use within an association each capability can be classified as initiating continuing or terminating These classifications reflect the transition of the association through the states of idle active and cluster terminating All unused or uninitiated associations are said to be idle The capability types are defined as follows Initiating This type of capability starts an association that did not previously exist Anew sao_id previously known as cluster_id must be supplied If an existing sao_id is supplied an error will be returned If ECS initiates this capability it wil
112. Description The signal devices allow direct communication between a Lucent Technologies application program and ECS There is a one to one correspondence between each signal stream and the IPCI board it serves or in the case of LAN GATEWAY between the signal stream and the MFB Hence signal01 corresponds to board 1 etc Note the path difference for LAN GATEWAY links LAN GATEWAY links reside in the directory dev esai signal0 8 Notes These files will have the same major device number as the admin 7 and command 7 files Their minor device number will be 1 2 3 or 4 depending on the board number The names of these files are shown below Files dev isdn ipci signal0l dev isdn ipci signal02 dev isdn ipci signal03 dev isdn ipci signal04 dev esai signalO 1 8 See Also Issue 1 October 1996 2 57 Administration CVLAN Administration OA amp M changes for client and server It is mandatory for the client and server both to connect to the same TCP IP port In order to meet this requirement for the UNIX platform in etc services file and for Windows NT platform in C ntdir system32 drivers etc services file the following command has to be administered cvlan XXXX tcp Callvisor LAN service XXXX is an unused unreserved TCP port name 1 ntdir is the Windows NT System directory where NT has been installed for example winnt 35 2 58 Issue 1 October 1996 Intr
113. Description This file contains the date and time the software for ISDN product was manufactured Files usr adm isdn isdn Date Issue 1 October 1996 2 41 Administration isdn 11 r 1 Name isdn 11 r Restart layer 1 and layer 2 Synopsis isdn 11 r Description isdn 11 r Will cause layer 1 and layer 2 to be restarted Operation isdn 11 ris invoked as a single command with no options the user is prompted for a board number from 1 to 4 isdn 11 risa script file that invokes ipci on and ipci off for the specified board The diagnostics for isdn 11 r are the same as those for ipci off and ipci on and the exits codes are those of ipci on See Also ipci on 1 asai_hb 1 2 42 Issue 1 October 1996 isdn 12 r 1 isdn 12 r 1 Name isdn 12 r Restart layer 2 Synopsis isdn 12 r bl b4 e Description isdn 12 r sends a layer 2 reset to the board specified by the b parameter If layer 1 and layer 2 are both up layer 2 will be taken down then brought back up If layer 2 is already down an attempt will be made to bring it back up b numboard Restarts the level 2 link for the specified board where lt numboard gt 1 4 the default is 51 e Displays the exit codes list shown below Displays the terse help menu Exit Codes If isdn 12 r fails one of the following exit codes is returned 0 The reset occurred per request 1 Failure due to inadequate memory 2 Open strea
114. EQ C 3PMC CONF C 3PTC REQ C 3PTC CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF Issue 1 October 1996 9 71 Programming Manual Pages C 3PSDS 3ASAI Name C 3PSDS Send DTMF Signals on behalf of a party on a call Type Continuing Acknowledged Usage typedef struct asai common t asai common call id t call id party id t tx party id party id t tx party ids 5 future use only user code t user data digit information long tone duration future use only long tone duration char pool C DATSZ a3psds info t Description The client sends this capability to request that DTMF tones be sent to all parties on a call that are connected to ECS via ports that support end to end signaling and that have active listen paths to the sender A structure of type a3psds info t contains the parameters needed to fulfill the request asai common The programmer sets capability to c 3Psps and primitive type to C REQUEST The programmer also sets the sao id also known as cluster id to identify the association that controls the call to apply DTMF signals tx party id tx party id is a conditional parameter and specifies the party on whose transmit path the DTMF signals will be applied The length of the identifier is id length tx party id must be used when the association is initiated by the C 3PMC REQ and C 3PTC REQ capabilities
115. Error Messages 7 1 m Library Error Messages 7 1 SC 8 ASAI Capability Primitives 8 1 m ldentifiers 8 5 m cause value 8 11 m Pool 8 14 vi Issue 1 October 1996 Contents 9 1 9 9 9 Programming Manual Pages m asai open 3ASAI m C 3PSL_RECONN 3ASAI 9 84 Issue 1 October 1996 vii Contents m C SPSL RECONN ACK 3ASAI 9 86 m C 3PTC CONF 3ASAI 9 88 m C 3PTC REQ 3ASAI 9 90 C EN SCN CONF 3ASAI 9 125 a C HB CONF 3ASAI 9 127 D 10 Testing 10 1 Integration Test Tool 10 1 Executing the ITT Program 10 3 m Scripts 10 4 Manual Pages 10 19 n i n i u z m close dialog out 3 10 20 m get long 3 10 21 n i u a E z get string 3 10 22 m Open dialog out 3 10 23 parse 3 10 24 print common 3 10 26 m t input 3 10 27 viii Issue 1 October 1996 Contents m t_output 3 10 28 m CVLAN Testing 10 29 11 Troubleshooting 11 1 m ECS Administration 11 2 A ISO Characters A 1 GL Glossa GL 1 Issue 1 October 1996 ix Contents x Issue 1 October 1996 9 About This Document This reference guide is for Lucent Technologies DEFINITY Enterprise Communications Server ECS CallVisor PC ROME Switch Application Interface ASAI platform for UNIX and Windows NT gt NOTE This document can be used with the earlier versions of DEFINITY Communications System products The information in this docu
116. F C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF 9 64 Issue 1 October 1996 C_3PREDIR_ACK 3ASAI C 3PREDIR ACK 3ASAI Name C 3PREDIR ACK Acknowledge a third party redirect alerting call request Type Continuing Unacknowledged Usage typedef struct asai common t long a3predir nak t typedef union asai_common_t a3psl disc nak t a3predir ack t Description asai common cause value asai common a3psl disc nak The client receives this capability as a positive or negative acknowledgement of a C 3PREDIR request asai common Within this structure capability is returned as C 3PREDIR ACK primitive type is returned as C POS ACK for positive acknowledgment and as C NEG ACK for negative acknowledgment The sao id also known as cluster id specified in the C 3PREDIR request is also returned cause value This parameter can be any of the following Q G n ER_BUSY INVLDNUM PROTERR NVLDIE ST ETCONJ NVALID CRV a Q O H CH H QO AAO ALA Issue 1 October 1996 9 65 Programming Manual Pages See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure
117. However it cannot be denied that the process of communicating with ECS is a complex one Unexpected results can disrupt the smooth operation of your system You may also find that you are regarded as the resident ASAI expert Therefore you will probably benefit from reading all of the ASAI documentation A list of all ASAI documents can be found in thel elated Documents section in the Chapter About This Document Once your system is up your official tasks consist of little more than monitoring the system startup procedure and the system log files Your unofficial task which occurs at irregular intervals and at the worst possible time is troubleshooting This chapter is organized to guide you through the performance of both your official and your unofficial tasks Issue 1 October 1996 2 1 Administration The ASAI Log File The ASAI log file asai_log is stored in usr adm asai and can be examined using vi or cat Each time the UNIX system is started the existing log file is moved to old asai log and a new log file is created This old_asai_log file is located in the same directory as asai_log In addition if asai_log becomes full close to ulimit in size itis moved to old_asai_log Note that this overwrites an existing old_asai_log You can split or copy a log file however only root has write permission in the usr adm asai directory Therefore you will have to use a directory in which you have write permissi
118. Issue 1 October 1996 2 29 Administration ipci_admin 1 Name ipci_admin Administer admin and signal files Synopsis ipci admin Description ipci admin sets up the protocol stack for signal device files and logs messages received from the admin 7 stream Operation The ipci admin program is executed once per machine boot It is started by the ipci 4 script and becomes a daemon process This program has two tasks To add the necessary module s into the signal 7 streams that carry ISDN D channel signaling or control information In the case of CallVisor PC LAN GATEWAY ESAI links ipci admin adds the necessary modules to send and receive the same information over TCP IP to and from the LAN GATEWAY circuit pack MFB in DEFINITY ECS In the case of CallVisor LAN GATEWAY links the ipci admin daemon has the responsibility of initiating the connection from the CallVisor PC adjunct to the MFB over the LAN The connection is attempted immediately on startup and if not successful the daemon will try four times at 10 second intervals and every two minutes after that to connect to the MFB To receive status information from both the IPCI streams device driver and the ESAI driver module via the admin 7 stream This information is logged in the log file asai_log 4 The device driver sends three types of information to ipci admin One type contains a status error number that is converted to a corresponding ASCII mess
119. Issue 1 October 1996 6 1 CVLAN Programming The CVLAN installation software places the client API 1ibxclnt a under the following directory on the target machine usr adm cvlan xdrlib For Windows NT platform a Dynamic link library DLL called CVLAN DLL along with its import library CVLAN LIB is provided CVLAN DLL includes both the client API and the data encapsulation XDR for RPC calls After installation CVLAN DLL and CVLAN LIB will be placed under C NCVLANNPROGRAM Client API 6 2 The CVLAN library functions provide the application program with an easy method of sending and receiving information in the form of ASAI capabilities to and from ECS Before you can send and receive information however you must establish a communication path to the CVLAN server asaiserv This is a two step procedure 1 Open a path using asai_open 2 Identify the ECS with which you will communicate The ECS is identified by a node identifier set with asai set env asai set env identifies applications as being either clients or servers A client application initiates a request for service and a server application responds to a request for service The CVLAN library does not allow an application to assume an inappropriate role For those capabilities for which it is registered as a client an application can only send messages defined for clients It cannot send server type messages The CVLAN client API provides the following lib
120. LERTING answered_cause is an optional item that indicates a cause value This item can assume any ECS specified cause value or C_NUSE_LONG loarty id SeeC ALERTING See C ALERTING connect type is an optional plan type t structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL See C ALERTING con num typelfor more information concerning plan type t called num SeeC CONNECTED called type SeeC CONNECTED poo1 see C_ALERTING C QUEUE queued list See C ALERTING icalled_num See C CONNECTED called type SeeC CONNECTED num inque is an optional integer value that indicates the number of calls in the queue including the current call If a value is not supplied the default value is C NUSE LONG acd split ext is a pointer to an optional null terminated string that indicates the extension of the ACD split servicing the queue If the extension number is not supplied acd split ext isa null pointer See C ALERTING 9 112 Issue 1 October 1996 C EN REP 3ASAI Table 9 2 Event Name Members and Descriptions Continued Event Name evr buf Member Description C HOLD hold list call id See C ALERTING hold numis a pointer
121. Lucent Technologies Bell Labs Innovations DEFINITY Enterprise Communications Server Release 5 CallVisor PC ASAI Installation and Reference 555 230 227 Comcode 107879876 Issue 1 October 1996 Copyright 1996 Lucent Technologies All Rights Reserved Printed in USA Notice While reasonable efforts were made to ensure that the information in this document was complete and accurate at the time of printing Lucent Technologies can assume no responsibility for any errors Changes and corrections to the information contained in this document may be incorporated into future reissues Your Responsibility for Your System s Security You are responsible for the security of your system Lucent Technologies does not warrant that this product is immune from or will prevent unauthorized use of common carrier telecommunication services or facilities accessed through or connected to it Lucent Technologies will not be responsible for any charges that result from such unauthorized use Product administration to prevent unauthorized use is your responsibility and your system administrator should read all documents provided with this product to fully understand the features available that may reduce your risk of incurring charges Federal Communications Commission Statements Part 15 Class A Statement This equipment has been tested and found to comply with the limits for a Class A digital device pursuant to Part 15 of the FCC Rules The
122. N GATEWAY installation This is preferred but not required 13 Verify that the hostname and IP address of the ASAI MFB board s for each CallVisor LAN link destination are in the etc hosts file on the adjunct PC If they are not then add them now gt NOTE If your LAN installation uses a Domain Name Service such as NIS instead of etc hosts for host name resolution The Network Administrator s Guide manual for your operating system should be consulted for information on how to add hostnames and IP addresses 14 Place the optional CallVisor PC LAN GATEWAY product disk in the 15 16 appropriate drive and enter the command pkgadd d diskette1 and follow the online instructions The installation script will ask you to enter the number of LAN links you wish to install enter one number from 1 to 4 the default is 1 For each LAN link entered in the previous step the installation script will ask you to provide a valid host name for the LAN link destination This will be the host name of the MFB s added to etc hosts in Step 13 The default is DEFINITY ECS gt NOTE 17 18 The installation script will attempt to verify the hostname of each LAN destination entered in the previous step and print a warning message if it cannot Installation will proceed regardless of the outcome The installation script will verify system requirements and complete the installation If error messages occur follow the instructions
123. N parameters file with new destination and exits Link change can only be invoked by the super user Link change cannot be used to add or delete LAN GATEWAY link the link to be changed must exist in the current configuration Links may only be added or deleted during the ISDN LAN GATEWAY installation process See Also lan change 1 lan stat 1 Issue 1 October 1996 2 51 Administration link_offline 1 Name usr bin link offline Take down LAN GATEWAY connection Synopsis link offline link number 1 Description Link offline sends a message to the LAN GATEWAY administration daemon requesting the specified link s be put offline Both TLI and TCP connectivity are broken and the retry strategy will be disabled Any LAN link put offline will not be put back online until a 1an restart request has been made or the PC is rebooted The 1 options makes the request for all LAN GATEWAY links See Also link restart 1 link status 1 2 52 Issue 1 October 1996 link_restart 1 link_restart 1 Name usr bin link_restart Take down the LAN GATEWAY connection and restart it Synopsis link_restart lt link_number gt 1 Description Link_restart sends a message to the LAN GATEWAY administration daemon requesting the specified link s be taken offline and then immediately reestablished Both TLI and TCP connectivity are broken The 1 option makes the request for all LAN GATEWAY links See Also link_o
124. NIX and Windows server installation steps 1 13 sd system configuration 1 12 S system operation and limits 1 12 CVLAN ITT execution 10 29 1 1 CVLAN library function 6 6 S O CVPC ASAI installationsteps 1 1 sd D data conveying across association 4 11 debugging library function 9 2 Cd DEFINITY ECS cause values 8 11 desired version default 1 3 destination change LAN Gateway links 2 51 si destination node for service request 3 6 direct agent call 53 Cd domain IN 4 Issue 1 October 1996 ACD split 52 VDN b2 domaincontrolendj9 41 J O domain value description 9 122 parameters 9 122 DTMFsignals 5 33 9 72 1 1 N E ending Event Notification 5 4 environment establishing to support program 4 6 ss error codes IPCI ON 11 2 1 error messages ASAI library message Index capability collected list 9 110 connected list drop list hold list item combinations list 57 0 logout list extension number 9 114 9 originating list 9 110 extensionnumber 9 110 SY originating devicenumber 9 110 queued list receiving reconnectlist 9 113 redirected list O 113 sending Event Report End termination of event report generation Event Reports Request specified domains 9 12
125. OA amp M For ease of reference commands and files appear in alphabetical ASCII order Command name prefixes and suffixes imply the following asai_ Commands related to the kernel ASAI protocol stack or the ASAI library ipci_ Commands related to the ipci device drivers isdn_ Commands related to the BRI link between the BRI board and ECS bin Commands related to software that is downloaded pumped to the BRI board esai_ Commands related to the CallVisor LAN GATEWAY interface link Commands related to the CallVisor LAN GATEWAY interface admin 7 ipci_off 1 asai 4 ipci_on 1 asai 7 asai Date 4 asai Name 4 WH asai admin asai cause asai hb 1 asai log 4 asai test 1 asai trace asai ver 1 boot bin 4 cmd 7 command 7 esai_alarm esai_trace ipci_admin 1 a DAE n 1 1 1 ipci_init ipci_stat 1 ipci_test 1 ipci ver 1 isdn alarm 1 isdn Date 4 isdn l1 r 1 isdn 12 r 1 isdn Name 4 isdn trace 1 lan status 1 log_msgs 4 link alarm 1 link offline 1 link restart 1 link status 1 pcisdn bin 4 signal 7 Issue 1 October 1996 2 3 Administration admin 7 Name admin IPCI and LAN GATEWAY Streams Device Driver Communication File Description The admin file allows communication between the ipci_admin 1 program the IPCI streams device driver and the LAN GATEWAY streams module The IPCI streams device drive
126. October 1996 9 29 Programming Manual Pages Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of 0 does not indicate an error but that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai rcv C 3PANS C 3PDC REQ C 3PDC CONF C 3PAD C 3PAD CONF C EN REP C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PRC C 3PRC CONF 9 30 Issue 1 October 1996 C 3PCC 3ASAI C 3PCC 3ASADI Name C 3PCC Third party request to clear a call Type Continuing Acknowledged Usage asai common t asai common Description The client sends this capability to request that a client controlled call be cleared Clearing disconnects all parties to the specified call To receive the server s acknowledgment C 3PCC CONF the client must use asai rcv The asai common structure contains the parameters needed to service this request Within asai common the programmer sets capability to c 3PCC and primitive type to C REQUEST The programmer also sets sao id also known as cluster id The acknowledgment sent by the server will identify the call to be cleared by this sao id cluster id Return Value Errors Notes When this capab
127. RC C 3PRC CONF Issue 1 October 1996 9 79 Programming Manual Pages C 3PSL DISC 3ASAI Name C 3PSL DISC Disconnect the listen path for selected parties Type Continuing Acknowledged Usage typedef struct asai common t asai common party id t from party id party id t to party id a3psl disc t Description The client sends this capability to request that listen path s between parties on a call controlled by the client be dropped A structure of type a3ps1 disc t contains the parameters needed to fulfill the request asai common The programmer sets capability to C_3PSL_DISC and primitive type to C REQUEST The programmer also sets the sao id also known as cluster id to identify the association that controls the call to be disconnected from party id to party id from party id is a required parameter and specifies the party to be disconnected from listening to party idis an optional parameter When the to party idis specified the only path that will be removed is between the talk and listen parties Otherwise all listening paths to rom party idare disconnected For each party id that is specified the length of the party identifier is id length The character array pointed to by id ptr contains the party id See the Identifiers section in Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an
128. S for example setting on the message waiting indicator m Activating or deactivating a number of ECS features for example call forwarding or send all calls m Routing incoming and outgoing calls m Testing a communication path to ensure that the ASAI link is operating Issue 1 October 1996 3 1 Introduction to ASAI m Terminating aborting calls when necessary Reading event reports to provide a complete audit trail of all of these activities Each group of capabilities is called an Application Service Element or ASE Capabilities are the building blocks of ASAI They are sent from the adjunct to ECS or received by the adjunct from ECS The exchange of capabilities is managed by the ASAI library functions asai_send and asai_rcv Library functions perform another very important task controlling the communication path across which capabilities are exchanged The functions asai_open asai_set_env asai_get_env and asai close are used to establish and terminate a communication path In addition asai errval provides error information to be used in error handling routines 3 2 Issue 1 October 1996 Terms and Concepts Terms and Concepts ASAI is an interface between an adjunct and ECS however a number of terms can be used instead of or in addition to adjunct and ECS In this book the following terms are used with the meanings shown below adjunct A PC used to communicate with a PBX
129. SAI capabilities and primitive types in detail Chapter 10 Testing is an overview of Integration Test Tool ITT and its functions Chapter 11 Troubleshooting provides solutions to a number of issues and problems encountered during various phases of installation administration application programming and testing ISO Characters contains ISO certified OPTREX characters Issue 1 October 1996 xv About This Document A Glossary and index are also provided for easy access to terms and definitions Related Documents For specific information concerning DEFINITY ECS Release 5 ASAI the following documents are available from Lucent Technologies Publications Center 1 800 457 1235 DEFINITY Enterprise Communications Server Release 5 CallVisor ASAI Technical Reference 555 230 220 DEFINITY Enterprise Communications Server Release 5 CallVisor ASAI Protocol Reference 555 230 221 DEFINITY Enterprise Communications Server Release 5 Feature Description 555 230 301 PC ISDN Interface Software Developer s Guide 555 016 103 PC ISDN Platform Installation and Reference 555 016 102 DEFINITY Enterprise Communications Server Installation Administration and Maintenance of CallVisor ASAI over the DEFINITY LAN GATEWAY 555 230 223 Technical Service Center xvi The CallVisor PC helpline supports CallVisor PC customers who need technical assistance Technical support is provided for installation administration and functi
130. SAI library A single library can Access multiple ports BRI cards or LAN Gateway links Communicate with one or more switches Manage communications for multiple ASAI links and ports These capabilities are provided by specifying a different node id argument to the asai set env function for each newly opened file descriptor Up to 8 node ids are supported signal01 through signal08 correspond to links 1 through 4 respectively A program can request client services from only one c node id per file descriptor To obtain services from four switches the program must obtain four file descriptors by opening the library four times Different c node ids mustthen be specified to the set env function for each file descriptor The number of streams that are available to all applications is restricted by the maximum number of BRI cards and LAN Gateway links in a computer For the ASAI library the maximum default aggregate number of streams is set at 12 This means that one application can open all 12 streams or 12 different applications can each open one stream ASAI functions are not reentrant Because of this interrupt handlers that are invoked when an application is interrupted during a function call should not themselves invoke another library function Application programmers must set interrupt levels with this restriction in mind Issue 1 October 1996 9 1 Programming Manual Pages The library is identified by its version numb
131. SD PSD CONF PSDS PSDS CONF ONG 1 0 0G OQ QQ Qr Oe OO OG OO OQ QAO AAO PREDIR_ACK Issue 1 October 1996 8 3 ASAI Capability Primitives C_3PSH C_3PSH_CONF C_3PSL_DISC C_3PSL_DISC_ACk C_3PSL_RECONN C_3PSL_RECONN_ACK C_ABORT _EN_CAN _EN_CAN_CONF _EN_CONF EN END EN REP EN REQ o Hj n lt lt lt O v O Z O HN lt PP O Q Z Ej m z Q Z Q O Z nj QADNANDADQADANDE J Ga ee Hj RM C SM REO C SM CONF capability t The type of request or indication is identified in primitive type typedef enum C REQUEST C POS ACK C NEG ACK primitive t The values of C REQUEST C POS ACK and C NEG ACK indicate a request a positive acknowledgement and a negative acknowledgement respectively The reserved parameter which appears in most of these common structures simply means that the parameter is being reserved for future use 8 4 Issue 1 October 1996 Identifiers Identifiers The ASAI library routinely uses a number of identifiers defined in structures of the types shown All of these structures include a field reserved for future use The most common identifiers are Call identifier ca11_id Identifies a specific call m Party identifier part y_id Identifies specific parties on a call w Old party identifier o1
132. SH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF Issue 1 October 1996 9 85 Programming Manual Pages C 3PSL RECONN ACK ASAD Name C 3PSL RECONN ACK Acknowledge a third party selective listen reconnect Type Continuing Unacknowledged Usage typedef struct asai common t asai common long cause value ja3psl reconn nak t typedef union asai_common_t asai_common a3psl_reconn_nak_t a3psl_reconn_nak a3psl_reconn_ack_t Description The client receives this capability as a positive or negative acknowledgment of a C_3PSL_RECONN request asai common Within this structure capability is returned as C 3PSI RECONN ACK primitive type is returned as C POS ACK for positive acknowledgment and as C NEG ACK for negative acknowledgment The sao id also known as cluster id specified in the C 3PSL RECONN request is also returned cause value This parameter can be any of the following NVLDNUM ROTERR ESUNAVL AND INFO NVLDIE NCOM ST 000000 I B CR M ST c See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values 9 86 Issue 1 October 1996 C_3PSL_RECONN_ACK 3ASAI Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of O does n
133. Software section of this chapter Use crash 1m to examine the crash buffer For more link details see asai test 1 in Chapter 2 Administration If the test fails check the version parameters and consult the DEFINITY ECS administrator If the test fails for LAN type links proceed to Step 30 If the DEFINITY ECS is properly administered and the wiring checks out call the CallVisor PC helpline number at 1 908 957 5725 Issue 1 October 1996 1 7 Installation 28 29 30 Shut down the computer Enter the command shutdown i0 y g0 Switch off power and install the cover Power up the computer At the login prompt log in as root and give the IPCI board one minute to come up Recheck connectivity to the DEFINITY ECS using the asai_test command If the test fails consult the DEFINITY ECS administrator If the DEFINITY ECS is properly administered and the wiring checks out and the test still fails call the CallVisor PC helpline number at 1 908 957 5725 If the connectivity fails for LAN type links use the link status 1 command to obtain the current status of LAN link s If the status is other than Talking use the ping command to verify connectivity to the host for example usr sbin ping hostname where hostname is the hostname of the MFB administered in Step 13 If the ping command returns an affirmative response yet asai test fails check the usr adm isdn lan parms file for typographical errors If t
134. Table 3 2 ASAI Library Functions for Exchanging Information Function Description asai_send Initiates continues or terminates an association by transmitting request or confirmation primitives that identify specific capabilities asai rcv Receives primitives that identify specific capabilities to initiate continue or terminate an association Table3 3 ASAI Library Function for Handling Errors Function Description asai_errval Allows the user to specify an error message followed by the exiting error return value written to stderr In general ASAI library functions return 0 when successful and 1 on failure Exceptions are noted in the manual pages in Chapter 8 ASAI Capability Primitives and Chapter 9 Programming Manual Pages Issue 1 October 1996 3 7 Introduction to ASAI Matching Versions Reguirement It is mandatory at execution time that the major and minor version numbers of the library be identical to those versions with which the application was compiled This is because the API structures change with the major or minor version changes The structures usually do not change with delta version changes The library can be a different version only if the application was linked with a shared library the default This is because of the way shared libraries are implemented To guard against the possibility of having the wrong version of the library at run time the application should in
135. The Platform Hardware of 1 2 Issue 1 October 1996 Installation PC ISDN Platform Installation and Reference for details on setting the address selection switches to use the desired address also see Table 3 3 Switch Settings for PC ISDN Interface Card Base Addresses 3 When no one else is using the computer log in as root Bring the computer to single user mode and then run state 1 by entering the command Shutdown iS y g120 Press ctrl d to proceed and enter 1 for the selected run state 4 Copy unix to stand unixold as a safety precaution in case of disaster Enter the command cp unix stand unixold 5 Enter the command pkgadd d diskette1 Place the disk in the appropriate drive and follow the online instructions The Pkgadd displays that the CallVisor PC ISDN package is available to process Press to continue the installation 6 After several minutes the installation procedure asks how many IPCI boards are installed on the machine Enter the number of IPCI boards that are already installed or the number which will be installed on the machine The default is 1 If your installation will have only CallVisor PC LAN GATEWAY links enter 0 Entering 0 will cause the installation to skip to the link version administration step Enter the correct number 0 1 2 3 or press for the default 7 The installation procedure asks to enter the IVN number This is the IRQ IVN number for the IPCI boards that you deci
136. The needed information is contained in the en scn t structure asai common The programmer sets the capability to C_EN_SCN and the primitive type to C REQUEST The programmer also sets the sao id also known as cluster id to identify association inside which the call notification is being terminated Gall id id length specifies the length of ECS assigned call identifier and id ptr points to a binary array that specifies ECS assigned identifier of the monitored call Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Issue 1 October 1996 9 123 Programming Manual Pages Notes This capability can be issued only by a client See Also asai_send C EN SCN CONF C 9 124 Issue 1 October 1996 EN R EQ C EN_CAN C EN_CAN_CONF C_E N END C EN SON CONF 3ASAI C EN SCN CONF ASAI Name C EN SCN CONF Acknowledge a stop call notification request Type Continuing Unacknowledged when used as a positive or negative acknowledgement Usage typedef struct asai common t asai common long cause value jen scn nak t typedef union asa
137. WI C_SV_FLEX enter choice C_SV_MWI message waiting indicator field name sv mwi val mwi type symbolic values C MWI ON C MWI OFF enter choice C MWI ON field name sv mwi val clled num enter value 5767162 Em x Figure 10 4 Set Value Request Here the emboldened values represent values that the user typed in If recorded in a file to be used later in regression tests it would be stored as follows Sv common sv item 131 sv mwi val mwi type 144 sv mwi val clled num 5767162 Note that although the symbols were used in the interactive mode the actual values are stored in the cap info file See PC ISDN Interface Software Developer s Guide for more information on these values 10 10 Issue 1 October 1996 Scripts gt NOTE Due to the changes in t_sv_req for the addition of Flexible Billing Set Value capability all previous ITT set value request input scripts will have to be updated with sv common sv_item as the first line in the file This was optional prior to this release of CallVisor Event Notification Request C_EN_REQ This capability allows the user to ask ECS to send event reports for a specified domain or vector directory number In its interactive mode the interaction for sending this capability looks like a E EVENT NOTIFICATION REQUEST asai common capability 23 asai common primitive type 0 asai common cluster id 10 field name en common domain
138. X C 3PCE X C 3PDC CONF X X C S3PDC REQ X C_3PDCE x C_3PM X C 3PM CONF x C_3PMC_CONF X X C S3PMC REQ X C SPR X C 3PR CONF x C_3PRC x C_3PRC_CONF X X C 3PREDIR x X Issue 1 October 1996 3 13 Introduction to ASAI Table 3 6 Classification of ASAI Capabilities Continued Acknowledged Unacknowledged Init Cont Term Init Cont Term C_3PREDIR_ACK x X C 3PSD X C S3PSD CONF X C 3PSDS x C SPSDS CONF X C_3PSH X C_3PSH_CONF x C_3PSL_DISC x C_3PSL_DISC_ACK x C_3PSL_RECONN x C_3PSL_RECONN_ACK X C 3PTC CONF X X C S3PTC REQ X C ABORT X C EN CAN X C EN CAN CONF X X C EN CONF X X C EN END x C EN REP X C EN REQ X C EN SON X C EN SCN CONF X C HB CONF X C HB REQ X C RF CONF X C RF REQ X C RT END X C RT REQ X 3 14 Issue 1 October 1996 ASAI Capabilities Table 3 6 Classification of ASAI Capabilities Continued Acknowledged Unacknowledged Init Cont Term Init Cont Term C_RT_SEL X C SV CONF X C SV REQ X C VQ CONF X C VQ REQ X C VQ RESP X The programmer is not restricted to a specific number of capabilities that can be supported on a given communication path however he or she is restricted to a single node for all capabilities on a given path Issue 1 October 1996 3 15 Introduction to ASAI 3 16 Issue 1 October 1996 ASAI Library Fu
139. able System Errors These procedures if not done correctly with the correct values can result in an inoperable system Two cases are possible 1 Defective kernel 2 Incompatible version parameters If the kernel is defective the system will not boot or you will be unable to log on To recover from this use the reboot with optional kernel procedure as described in your UNIX documentation If the version parameters are incompatible with ECS version the BRI link will not start up The QP module will log this error to the system console and the crash buffer Issue 1 October 1996 11 5 Troubleshooting CVLAN Troubleshooting Client Side OA amp M Utilities asai_test asai_test tests connections with ECS It has been modified to accept a new option t with the IP address of the server When it is run from the client it will test the connection from the client through the specified server to ECS asai_ver This function returns the library version of the client library This is needed to ensure that the client library and the server library versions are same Other OA amp M and Test Programs For the following OA amp M programs and ITT to run the host name or ip address of the server to which the program is connected has to be administered in usr adm asai server Trouble Connecting to Server Use ping to check the connectivity to the CVLAN server If you cannot ping to the server check your etc hosts file to ascert
140. age and placed into the asai log file The log_msgs 4 file is used to convert this number to the ASCII message The sent type is ASCII information of many different formats and byte lengths The third type indicates boards that have been successfully pumped This information is meant to be used for software debugging To receive and send requests and replies via semaphores and message queues from the various LAN GATEWAY OA amp M commands If a nonrecoverable error condition occurs within the process a message is produced and this program exits Otherwise this program waits for data from the 2 30 Issue 1 October 1996 ipci_admin 1 admin stream After processing the received data this program then waits for more data from the admin stream The admin and signal stream files are always kept open by ipci_admin Messages All of the following messages in the asai_log file are identified by a time stamp and the phrase ipci_admin m Status Messages Two status messages are written to the asai_log file uasr adm asai asai_log 4 by ipci admin One message indicates the beginning of the ipci_admin program The other message indicates the successful setup of each signal stream m Error Messages lfipci admin encounters a nonrecoverable error situation an error message is sent to the console if it cannot be logged otherwise the message is sent to the log file m PCI Driver Status Messages For every status message
141. agt stat vqc station vqc cal stat vqc pty stat vqc ext stat vqc mwi stat vqdc sac stat vqc scf stat vqc_aaid Issue 1 October 1996 9 153 Programming Manual Pages Description The client receives this capability as a positive or negative acknowledgement that terminates a value guery reguest The information needed to service the reguest is contained in the members of the union vgc_buf The data common to all termination requests is contained in vgc_common Within asai_common the capability is returned as C_VQ_CONF and the primitive_type as C POS ACK for a positive acknowledgment and C NEG ACK for as a negative acknowledgement The association identified by the sao id also known as cluster id ofthe value query request is also returned In a positive acknowledgment the capability returns information in one of the following vgc_buf members vqc split vqc cc stat vqo tg stat vqc time vqc agt stat vqc station vqc common vdc common vqc cal stat vqc pty stat vqc ext stat vqco mwi stat vqc sac stat vqc scf stat O0f vqc aaid Within the vqc common structure vqc_type indicates the type of item to which the information supplied pertains This parameter may assume the values of C ACDSPT STAT C CLASS STAT C TG STAT C TIME OF DAY C AGT STAT C STATION C AGTLOGIN AUD C PTY STAT C EXT STAT C MWI STAT C SAC STAT OrC SCF STAT ACD split status call classifier status trunk group status parties on a ca
142. ain that there is an entry for your server CVLN_ITT ECS Connection Failure Check the asai_open statement at the beginning of your script file for the node_id argument This argument must be of the form WWW XXX YYY ZZZ signal0l where WWW XXX YYY ZZZ is the IP address of the server and signa101 designates the ASAI link to ECS 11 6 Issue 1 October 1996 mE ISO Characters Starting with Release 5 CallVisor ASAI supports a subset of European and Japanese Katakana characters that can be displayed by DEFINITY ECS on 85xx telephones These European and Japanese characters are displayed when the Integrated Directory Database is queried for any name that contains all or some of these special characters ASAI parses the queried directory name and translates it according to the language that the application supports An ASCII character preceded by a tilde maps to a specific European or Katakana character that allows the presented name to be translated for the application If a name is composed of special European characters or the Japanese Katakana characters as well as ASCII characters the initial tilde combined with the subsequent ASCII character s toggles to the appropriate character map to translate the character s the second or next tilde turns off the toggle If four tildes appear in a name sent by ECS then the characters preceding the first and third tildes will toggle to the character map so that the charac
143. al asai set env C NODE ID failed exit asai errno cnt argc 5 strtol argv 4 0 0 1 en en common asai common capability C EN REQ en en common asai common primitive type C REQUEST en en common asai common sao id 0 printf Sent C EN REQ C REQUEST on clid 0n if asai send fd amp en sizeof en lt 0 asai errval asai send exit asai errno if asai rcv fd amp rsp sizeof rsp 0 asai errval asai rcv exit asai errno printf Received s s on clid d caps rsp asai common capability typs rsp asai common primitive type rsp asai common sao id if rsp asai common capability C ABORT printf Ntabort type s cause s n rsp abort info abort type C PROV ABT C PROV ABT C USER ABT causes rsp abort info cause value exit 1 D Figure 4 9 Sample Code Testing the Event Notification Capabilities Continued Issue 1 October 1996 4 17 ASAI L ibrary Functions i 91 C CO OQ CO O O O O CO QO XO XO XO XO XO WOO IO Q 000 10 01 AUN IP O i0 OO 1 OY O1 BON co 1o0 01 C N20 S CO C C CO CO OPO PO PO PO PO IND DNDN LDH ICON HP QO i0 0 1 OY O1 i C0 P2 O xo Ww C Ne else if rsp asai common capability C EN CONF amp amp rsp asai common primitive type C NEG ACK printf tcause s n causes rsp en_rsp en_nak cause_value exit 2 printf n for cnt if a
144. alue asai rcv fd input buf BUFSIZ if asai rcv return value lt OL p receive data from switch for node s failed n s Figure 4 7 asai rcv Function asai rcv returns the size of the buffer on success and 1 on failure A return code of 0 does not indicate an error it merely indicates that the received message was intended for the library and no program data is available at this time In the event that a received message will not fit in the buffer supplied by the programmer the ASAI library returns a 1 error and sets asai_errno to 14 C BADLNG If a program ignores this error and simply calls the library again an infinite loop is created Because of this all application programs must check for the presence of a C BADLNG error and provide a larger buffer if it occurs The sample code in Figure 4 9 calls asai_rcv on lines 75 103 and 152 Issue 1 October 1996 4 13 ASAI Library Functions asai close You may never have to use asai close The UNIX system is capable of handling all the details for you if you prefer However the UNIX system also imposes a limit on the number of files that can be open at one time If your application opens a large number of files you may have to call asai close to close specific communication paths asai close closes the communication path identified by a It returns 0 on success and 1 on failure You may also want to write a functi
145. an error will be returned ASAI supports a maximum user_user data length of 32 bytes although user_user data generated froma PRI trunk can be up to 127 bytes in length DEFINITY ECS will truncate this to 32 bytes before forwarding it to ASAI link The protocol field indicates the type of information and is restricted to C_UU_USER that indicates a user specific protocol or C_UU_IA5 which indicates IA5 or ASCII characters The info field is a pointer to an ASCII string of no more that 32 characters in length ofacility This is an optional parameter that identifies the type of facility requested It can be C_TRUNK_GROUP C_ACD_SPLIT or C_NUSE_LONG These values indicate a trunk group an ACD group or facility not used ofac_ext The ofac_ext parameter is a pointer to a null terminated character string that identifies the trunk access code of the trunk group or the ACD split extension depending on the value of ofacility prio_call The requester can indicate call options to be used for the call The prio call parameter can take the value of C_PRIOR_ON indicating that the call is a priority call or c PRIOR OFF indicating that the call is not a priority call alert time The alert time parameter indicates the maximum number of rings to wait after the call has reached the alerting state 9 52 ssue 1 October 1996 C_3PMC_REQ 3ASAI serv_cir The serv_cir parameter with a value of C_SERV_ON indicates that a call classi
146. an type t that supplies additional information about the extension field that immediately precedes it providing that the extension field is not NULL user user typdef struct long leng long protocol char info user user t The purpose of the user user structure is to convey information between ISDN users uudata is a structure of the type user user t where the leng field is an integer value that indicates the number of octets of user data included in the request This field is set to 0 if no user user data is present Currently ECS will accept up to 32 bytes of data 1eng 32 If more than 32 bytes is specified an error will be returned ASAI supports a maximum user user data length of 32 bytes although user user data generated from a PRI trunk can be up to 127 bytes in length DEFINITY ECS will truncate this to 32 bytes before forwarding it to ASAI link The protocol field indicates the type of information and is restricted to C UU USER that indicates a user specific protocol or C UU I1A5 which indicates IA5 or ASCII characters The info field is a pointer to an ASCII string of no more that 32 characters in length user data typedef struct long type long collect long timeout char digits juser code t Issue 1 October 1996 8 9 ASAI Capability Primitives oli 8 10 The user data structure is used to convey the information about the DTMF digits to ECS and with the collect
147. apability allows the adjunct to request on behalf of a station user to answer a ringing bridged or held call that is present at the station Answering a ringing bridged or held call means to connect a call by m Forcing the station off hook if the user is on hook Cutting through the call to the head or handset if the user is off hook The effect is as if the station user selected the call appearance of the alerting bridged or held call and then went off hook asai common Within this structure the programmer sets capability to C 3PANS and primitive type to C REQUEST The programmer also sets sao id also known as cluster id to identify the association that controls the station call id Indicates the alerting bridged or held call to be connected at the controlled station pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information Issue 1 October 1996 9 27 Programming Manual Pages Return Value When this capability is used in an asai send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also
148. apter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai rcv C EN REP C 3PMC REQ C 3PMC CONF C 3PTC REQ C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF Issue 1 October 1996 9 89 Programming Manual Pages C 3PTC REO 3ASAIT Name C 3PTC REQ Take control of an existing third party call Type Initiating Acknowledged Usage typedef struct asai common t asai common call id t call id char pool C DATSZ a3ptc info t Description The client sends this capability to request control of an existing call The a3ptc info t structure contains the parameters needed to fulfill the request asai common The programmer sets capability to C 3PTC REQ and primitive type to C REQUEST The programmer also sets the association identifier to the sao id also known as cluster id that identifies the call call id This structure contains a pointer id ptr to a binary array of length id length that specifies the ECS assigned value of the call identifier for which the request is intended pool This parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information Return Value When this capabil
149. arameters to the capability Description Set Value allows a client to request that an item controlled by the server for example MWI SAC SCFS be set to a specified value It is a user initiated acknowledged end to end service The client invokes this capability by issuing a C SV REO with the items to be set additional parameters when required and the desired value The server responds by issuing a C Sv CONF If the request is not honored the cause parameter is set Request Indication Parameters m ltem Message Waiting Indicator To set the MWI these elements must be specified m The station whose MWI is to be set The desired state Off or On m ltem Flexible Billing Feature To set the Flexible Rate these elements must be specified m The call call id that this capability is to operate on m The type of billing change for example NEW RATE FLAT RATE etc m The rate to apply to the call Issue 1 October 1996 5 35 ASAI Capabilities Value Ouery Capabilities 5 36 The Value Query capability group consists of m Value Quer Value Query Confirm Value Query Response The Abort capability is described later in this chapter Value Query allows a client to request and receive information about the status or value of features or services under server control The following features or services can be queried ACD split status Call classifier status Trunk group s
150. as put offline via the link_offline 1 OA amp M command ipci stat 1 link status 1 Issue 1 October 1996 2 49 Administration link alarm 1 Name usr bin link alarm Suspend or resume alarms for a LAN link Synopsis esai alarm 1 Description Link alarmis a shell script that verifies that the specified link is a LAN link before invoking esai alarm 1 to suspend or resume alarms See the manual page for esai alarm 1 for command line options See Also esai alarm 1 isdn alarm 1 2 50 Issue 1 October 1996 link_change 1 link_change 1 Name usr bin link_change Change the destination of LAN GATEWAY links Synopsis link_change n lt link_number gt h lt hostname gt i lt IP address Description Link_change is a shell script which is used to change the host destination of a LAN GATEWAY link n link number and either a hostname or i IP address gt must be specified Link change Will verify the PC s ability to communicate over the LAN with the specified host or IP address via ping and print a warning if it is unable to do so but will make the change anyway After the verification of the host or IP address link change sends a message to the administration daemon to restart the specified LAN link and attempts to connect to the new destination The user is prompted if communication with the administration daemon is not possible Link change updates the LA
151. be C AUX WORK C AFTCAL WK C AUTO IN OrC MANUAL IN auxiliary mode after call work mode auto in mode and manual in mode reason code option is a long integer value indicating the reason for the change of work modes pool is a character array that provides buffer space for the ASAI library to store program specific information See Pool in Chapter 8 ASAI Capability Primitives for more information call frwd t This structure contains the parameters needed to request the call forwarding feature called numis a pointer to a null terminated string that specifies the extension from which the call is to be forwarded redir numis a pointer to a null terminated string that specifies the extension to which the call is to be 9 134 Issue 1 October 1996 C_RF_REQ 3ASAI forwarded pool is a character array that provides buffer space for the ASAI library to store program specific information See Pool in Chapter 8 ASAI Capability Primitives for more information can_frwd_t This structure contains the parameters needed to request the cancel call forwarding feature called_num is a pointer to a null terminated string that specifies the extension from which call forwarding was invoked poolisa character array that provides buffer space for the ASAI library to store program specific information Seo Pool in Chapter 8 ASAI Capability Primitives for more information sac t This structure contains the parameters
152. be directly connected to the specified party state on the call This capability can be requested for a directly connected party when that party is in the active state After the capability is successfully acknowledged the party goes from the active state to th Issue 1 October 1996 e held state Third Party Send DTMF Signals Third Party Send DTMF Signals Description The Third Party Send DTMF Signals capability allows a client to request the server to issue a sequence of DTMF tones on behalf of a party on the call The DTMF sequence to be generated may contain any digit as well as the and characters A maximum string of 32 characters may be sent from the client to the server in a single service request message The client invokes this capability by issuing a C_3PSDS request to which the server will respond with a C_3PSDS_CONF The server sends positive acknowledgment when it has validated the parameters The server sends a C NEG ACK if the parameters of the request are invalid or if it cannot apply the tones to the call Request Confirmation Parameters Depending on conditions the request must specify the following parameters Call Identifier The call on which this capability operates This parameter must be specified if the capability is requested over an association started with a Third Party Domain Control capability otherwise it must not be used m Party Identifier The party on the call for wh
153. call remain in the state they were in before the merge request 5 26 Issue 1 October 1996 Third Party Reconnect Third Party Reconnect Description The Third Party Reconnect capability allows the client to reguest the server to reconnect a specified party The client invokes this capability by issuing a C_3PR to which the server responds with a C_3PR_CONF The client must use feedback to determine the state of the call with respect to each endpoint If the server is unable to attempt the reconnection or if the parameters specified by the client are invalid the association identifier remains valid for further control of the call and the party that was to have been reconnected remains in the state it was in prior to the reguest Reguest Confirmation Parameters The following parameters are mandatory under the conditions noted otherwise they are optional m Party Identifier The party to be reconnected This parameter is mandatory if the association is started with a Third Party Make Call or Third Party Take Control capability It can be inferred and thus is optional if the association is started with a Third Party Domain Control capability Call Identifier The call that is to be reconnected This parameter is mandatory if the association is started with a Third Party Domain Control capability if the association is started with a Third Party Make Call or Third Party Take Control capability it can be inferred Notes
154. cause values by name shows the DEFINITY ECS value the ASAI library value and provides a brief explanation of the probable cause Table8 1 ASAILibrary and DEFINITY ECS Cause Values DEFINITY ECS ASAI Cause Value Value Value Description C ADMIN PROGRESS CS3 46 30 Administration is in progress request cannot be serviced C AGT STATE CS3 16 23 Request to put agent in same state he she is already in C ANSWERING MACHINE CS3 24 55 Answering machine detected C BAD ADMIN CS3 41 24 ACD not provisioned or optioned C BAD IE CS0 99 27 Unknown information element detected C BEARER CAP UNAVAIL CS0 58 38 Bearer capability not presently available C BEARER SVC NOT IMPL CS0 65 51 Bearer service not implemented C CALL REJECTED CS0 21 33 Call rejected C CALLID TERM CS3 86 8 Call is no longer in active state C CLUST TERM CS3 87 18 Association terminated because service is not active C_CAUSE_UNKNOWN Undefined 48 Undefined value returned from ECS C_FACILITY_REJECTED CS0 29 56 Facility rejected C FACUNSUB CS0 50 3 Capability is implemented but not subscribed to by requester C FEATURE REJECTED CS3 53 31 ECS has rejected a request from the adjunct C_INCOMPAT_DESTINATION CS0 88 39 Incompatible destination C INCOM ST CS0 98 9 Message not compatible with call state C INCOM OPT CS3 80 11 Incompatible options used to establish the call C INC PASWD CS3 14 22 Invalid
155. changeably This ambiguity is avoided by restricting the use of the term application throughout this document The building blocks of the ASAI library are capabilities Requests and indications are capabilities For example Third Party Make Call is a request for setting up a call Third Party Make Call is an ASAI capability An Event Report is an indication that an event has occurred Event Report is a capability ASAI capabilities can be further broken down into capability primitives that perform a single task requesting a service responding to a request confirming a request or indicating that a request has been fulfilled A primitive is an atomic message passed by the library For example the Heartbeat capability consists of Issue 1 October 1996 3 3 Introduction to ASAI 3 4 two primitives C_HB_REQ and C_HB_CONF For more details on Capability primitives see ASAI Capability Manual pages section in Chapter 9 Programming Manual Pages Groups of capabilities for example all the Third Party capabilities are Application Service Elements ASEs or capability groups The term association is critical to understand ASAI An association is a single invocation of an ASE between an adjunct and ECS An association is represented by a unique CRV link combination The Glossary Jat the end of this document contains definitions of additional terms and acronyms that relate to ASAI The ter
156. client receives this capability as a positive or negative acknowledgment of a C 3PMC REO request asai common Within this structure capability is returned as C 3PMC CONF primitive type is returned as C POS ACK for a positive acknowledgment and as C NEG ACK for a negative acknowledgment The sao id also known as cluster id specified in the c 3PMC request is also returned A positive acknowledgment confirms that the c_3PMC_REQ request has been received and understood Subsequent event reports will indicate the progress of the call For a positive acknowledgment a3pmc_ack is used For a negative acknowledgment a3pmc_nak is used party id This parameter indicates the originating party on the call 9 48 Issue 1 October 1996 C 3PMC CONF 3ASAI call id This parameter identifies the call that was created by the third party make call request connected This parameter identifies the connected number which along with other information is contained in the number id t structure The s field of the number id t structure when not NULL is an ASCII string containing the connected number If s is NULL the following field type plan is undefined The type plan field is of type plan type t For more information concerning plan type t seethe C EN REP C ALERTING description in this section This field represents the calling party and is only present when the originator is an EAS agent pool The
157. clude a code to check the versions See the sectionf asai_get_env in Chapter 4 ASAI Library Functions to know how to obtain the library s versions 3 8 Issue 1 October 1996 Detecting Failed ASAI Links Detecting Failed ASAI Links Some applications are reguired to detect and report a failed link within a certain time If the link failure detection time is more than three or four seconds a good way to detect a failed link is to send a heartbeat reguest to ECS at twice the rate of the reguirement If the heartbeat acknowledgment has not been received from ECS when it is time to send the next heartbeat reguest the link can be assumed to have failed If the link failure detection time is fewer than two seconds a more sophisticated algorithm might be needed In constructing such an algorithm the programmer should allow at least 100 milliseconds for ECS to acknowledge the heartbeat The programmer must also consider the delays due to any time sharing activity that may be present The rate at which heartbeat reguests are sent should take the link capacity and overall message load into consideration as well as the detection time reguirement The link capacity is about 40 messages per second The exact figure depends on the length and content of the messages A heartbeat reguest and acknowledgment count as one message each Sending a heartbeat once a second will consume somewhat less than 5 percent of the link capacity Issue
158. connect Acknowledgement 9 86 Third Party Make Call 5 22 Third Party Make Call Confirmation request 9 48 Third Party Make Call Request 9 51 Third PartyMerge 5 25 1 1 O Third Party Merge Request acknowledgement 9 45 Issue 1 October 1996 IN 9 Index Third Party Reconnect 5 27 Third Party Reconnect Request acknowledgement 9 57 Third Party Redirect Acknowledgement Third Party Redirect Call 5 28 9 63 sd Third Party Relinquish Control 5 29 sd Third Party Relinquish Control Request Confirmation Third Party Request to clear call 9 31 Third Party Selective Drop 5 30 Third Party Selective Drop Acknowledgement request 9 70 Third Party Selective Hold 5 32 Third Party selective Hold Confirmation request 9 78 Third Party Send DTMF signals 5 33 sd Third Party Take Contro 5b 34 1 Third Party Take Control Confirmation Third Party Take Control Request 9 90 tracing IPCI device driver messages 2 45 sd tracing LAN Gateway messages 2 27 trouble connecting to server connectivity problems 11 6 trunk id 8 7 twenty seven character display5 38 A 1 ss Integrated Directory names 9 156 U U ABORT 5 upgrade procedure o y userabort definition 3 12 0 user touserdata 5 23 8 9 O V ValueQuery 5 37 AAID 9 156 27 characters widenamej9 156
159. connected when the Third Party Answer request is made will result in a positive acknowledgement Interactions with Event Reports This capability can be issued after the domain controlled station is in the alerting or held state on the call for which this capability is requested After this capability is successfully acknowledged the station party moves to the active state Issue 1 October 1996 5 13 ASAI Capabilities Third Party Auto Dial Description The Third Party Auto Dial capability allows a client to reguest the server to establish a call on behalf of the controlled extension specified in a Third Party Domain Control extension reguest The effect is that the extension places a call to the specified called number automatically when that extension is off hook The capability also allows the server to confirm the reguest The client issues a C_3PAD to request that the call be made and monitored The server responds with a C 3PAD CONF if the client has requested acknowledgement The Third Party Auto Dial confirmation indicates only that the request has been received and understood and that the server will try to establish the requested call If the server cannot establish the call it issues a call ended event report to the client The server issues event reports only after a positive acknowledgement A negative acknowledgement is issued only if the client is not subscribed to the service or if the server is unable to accept t
160. control associations Two fields id length and id ptr are in a call id If id length is zero the field is omitted otherwise id ptr contains a binary representation for the ca11 id typically received in an earlier ASAI message redir num redir numis a required parameter It identifies the destination of the redirected call Two fields p1an type and s are in a number id sis a null terminated string containing the destination number plan type is described in the Identifier section of Chapter 8 Issue 1 October 1996 9 63 Programming Manual Pages party_id party_id is reguired for call control associations It specifies the redirected_from party on the call The length of the party identifier is id_length The character array pointed to by id ptr contains the party id See the Identifiers section in Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that there is no data to be sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by a client See Also asai send C 3PREDIR ACK C 3PSL RECONN ACK C EN REP C 3PMC REQ C 3PMC CONF C 3PTC REO C 3PTC CONF C 3PSH C 3PSH CON
161. d Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai_rcv C_EN_REP C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PTC_CONF C_3PSH C_3PSH_CONF C_3PR C_3PM C_3PM_CONF C_3PSD C_3PSD_CONF C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF 9 58 Issue 1 October 1996 C_3PRC 3ASAI C 3PRC ASAT Name Cc 3PRC Relinquish control of a call without disconnecting the parties to the call Type Terminating Acknowledged Usage asai common t asai common Description The client sends this capability to request that control of a client controlled call be relinquished This terminates the association The asai common structure contains the parameters needed to fulfill the request The programmer sets capability to c 3PRC and primitive type to C REQUEST The programmer also sets the sao id also known as cluster id The use of this capability does not disconnect the parties to the call or free the resources necessary to maintain the call connection Return Value Errors Notes When this capability is used in an asai send the function returns a nonnegative value on success and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes This capabil
162. d so on up to a maximum of six files If the sixth file overflows the entire process begins again and rawt race out 0 is overwritten h Displays the verbose help menu i Causes input to be taken from the board using the command isdn trace 2 18 Issue 1 October 1996 asai_trace 1 m Message type information is included n Public or private network and type of user information is included O Displays the options help menu q Q932 Messages are included E Hex Code is added to the messages raw mode 5 Messages are displayed in split screen format Messages from the adjunct appear on one side of the screen while messages to the adjunct appear on the opposite side Abbreviated mode is forced V Single line per message mode highly abbreviated Displays the terse help menu Examples asai_trace i Trace input directly from the board using isdn_trace cat trace in asai_trace r Decode trace in using raw mode when a heartbeat is sent to ECS by asai_test The trace in file is created by the command isdn trace gt trace in amp Output similar to the following is generated lt Heartbeat gt ADJ gt sw 0 crv 0004 sec 75 37 rcv cc 0 07538 90 11 00 08 02 00 04 64 96 1c 09 91 al 06 02 01 03 02 01 b3 00 00 00 00 asai trace h The verbose help menu is displayed Issue 1 October 1996 2 19 Administration Files usr adm isdn bin asai trace usr adm isdn bin isdn trace
163. d calls that have a common party be merged The common party can be retained on the call by conferencing the two calls or it can be disconnected after effectively transferring one of the other parties A structure of type a3pm info t contains the parameters needed to service this capability asai common Within this structure the programmer sets capability to C 3PM and primitive type to C REQUEST The programmer sets sao id also known as cluster id to the association identifier of one of the calls com party id The common party is a conditional parameter and is identified by a party id structure The com party id parameter must be used when the association has been started through C_3PMC_REQ orc 3PTC REQ Otherwise the parameter is not used See also party id call id Specifies the call to be merged with the held call The call identified by this parameter must be a call initiated by the C_3PMC_REQ capability or a call controlled by the C_3PDC_REQ capability Issue 1 October 1996 9 43 Programming Manual Pages held_call_id Specifies the held call The held call parameter is used only if the extension is controlled by C 3PDC REQ conf flag When conf_flag is set to C CONF ON the party identified by com party id remains connected to the merged call when conf_flag is set to C CONF OFF the common party is disconnected pool The pool parameter is a character array that provides buffe
164. d functions and ASAI capabilities where appropriate Issue 1 October 1996 9 3 Programming Manual Pages asai close ZASAI Name asai close Close the communication path Synopsis include asai asai def h include asai asai str h include asai asai err h long asai_close fd int fd Description This function closes the communication path identified by fa All activity associated with the specified fd is terminated Return Value Upon s returns Errors uccessful completion the function returns 0 If an error occurs the function 1 The type of error is indicated by the error value set in asai errno C BADFD Invalid file descriptor supplied C SYSI See Also ER ASAI service error cannot close the Streams device Check errno asai open 9 4 Issue 1 October 1996 asai_errval 3ASAI asai_errval JASAI Name Synopsis asai errval Write specified error message to stderr include lt asai asai_def h gt include lt asai asai_str h gt include lt asai asai_err h gt long char Description asai_errval mes_buf mes buf C MESIZE This function allows the client to incorporate a specified error message with a message provided by the ASAI library The programmer specifies the message in the null terminated string mes buf of maximum size C MESIZE The ASAI s written colon Return Value Errors Upon s returns
165. d in acknowledgments Positive acknowledgment parameters are specified by the structure of type a3pm ack t Negative acknowledgment parameters are specified by the structure of type a3pm nak t asai common Within this structure capability is returned as C 3PM CONF and primitive type as C POS ACK for a positive acknowledgment and C NEG ACK for a negative acknowledgment The sao id also known as cluster id specified in the C_3PM request is also returned call id Within a3pm ack t call id specifies ECS assigned call identifier of the merged call num merge ext This parameter specifies the number of parties connected to the merged call Issue 1 October 1996 9 45 Programming Manual Pages party_list Within a3pm_ack_t party_list is a pointer to a structure of the type merge_ext_t Each element of this list up to and including the element identified by num_merge_ext contains information about the parties connected to the merged call In each of these structures id_ptr is a pointer to ECS assigned party identifier id_length indicates the length of the party identifier extension points to a null terminated character string indicating the extension or station number associated with that party pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information
166. dc ack t contains status information on the call asai common Within this structure capability is returned as C 3PDC CONF primitive type is returned as C POS ACK for a positive acknowledgment and as C NEG ACK for a negative acknowledgment The sao id also known as cluster id specified in the domain control request is also returned Issue 1 October 1996 9 37 Programming Manual Pages num_callid This parameter shows the number of structures and calls listed in stninfo_list stninfo_list See the section Identifiers in Chapter 8 ASAI Capability Primitives pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool fin Chapter 8 ASAI Capability Primitives for more information cause_value This parameter can be any of the following C_FACUNSUB INVLDIE INVLDNUM MAND INFO PROTERR RESUNAVL S S ER UNIMP ERV UNAVIL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of 0 does not indicate an error but that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai rcv
167. ded protocol field Indicates the type of information and is restricted to C UU USER which indicates a user specific protocol or C UU IAS5 which indicates IA5 or ASCII characters info field A pointer to an ASCII string of no more that 32 characters in length There are no restrictions on this capability Issue 1 October 1996 Route Select Route Select Description The Route Select capability allows the server to respond to a client s Route Reguest The parameters provide the client with all the information it needs to route the call over the route chosen The server uses the information obtained in a C_RT_REO to determine a route for the call Once a route is selected the server responds to the client with a C_RT_SEL capability The client then responds with a C_RT_END capability which terminates the association This is a form of negative acknowledgement with a Cause returned to the server If the client has set its local timer when no response is received from the server before time out the client can send a C ABORT with a cause of timer expired In the event that no appropriate route can be selected the server may respond to the client with a cause value using a C RT SEL capability and C NEG ACK Request Indication Parameters m Destination Address The endpoint for which the route has been obtained The following parameters are optional m Originating Address The en
168. ded to use in Step 1 The default is 2 Enter the correct number 2 3 or press for the default 8 The installation procedure asks you to enter the 5 digit SCMA address value This is the shared memory address selected in Step 2 Be sure to use lowercase letters The defaults are available for four boards and online help displays the available values Enter the correct numbers or press for the default 9 The installation procedure asks you to enter the desired version The ISDN protocol stack specifically the QP module supports link version selection Version 1 default corresponds to G3V3 version 2 corresponds to G3V4 and version 3 corresponds to release 5 For release 5 the default also is 3 See the DEFINITY ECS Administration section of this chapter for more information about how to get the DEFINITY ECS Software Version Enter the correct number or press for the default Issue 1 October 1996 1 3 Installation gt NOTE Most of the 94 features except for new Event Reports will be provided to the applications regardless of whether link version 1 version 2 or version 3 is selected The TSC may have to activate a number of new ASAI features ASAI version control is used to allow applications to work even though certain protocol features may not be totally forward compatible The approach used by DEFINITY ECS is that new ASAI messages that were unsolicited by the adjunct are under version control but those messages which
169. descriptor passed to asai close asai get env asai rcv asai send Orasai set env is invalid possibly because it had been closed previously Communications are flow controlled This value is set in asai rcv if there was no message pending when it was called and the stream was opened in no delay mode Also asai send Will set this value when it cannot send a message Issue 1 October 1996 7 1 Error Messages C_BADF LAG C_SYSER SERVEX C BADNODE C INTR C OSE C BADMSG C BADLNG C UNCAP C BADPMATCH 7 2 ssue 1 October 1996 An invalid value was given for the asai open flags ASAI service error This error is set in asai_close asai rcv andinasai errval whenever an error is detected in the operation of the ASAI Application Entity Service is being provided by another application This error is setin asai set env whenever it has been passed a service that another Application Process is already providing Node is not available This error is set in asai set env whenever it has been passed a Node ID that has no communication path A system call was interrupted by a signal This error is set in all ASAI functions whenever an external event causes a function to return before the operation requested could be performed A system call failed This error is set in all ASAI functions whenever a failure in the operating system causes a function to return before th
170. disconnects all parties to the specified call and terminates the association by freeing the sao id also known as cluster id asai common Within this structure capability is returned as C 3PCE and primitive type is set to C REQUEST The sao id also known as cluster id ofthe association to be terminated is also returned cause value This parameter can be any of the following C CALLID TI C FACUNSUB INVLDIE MAND INFO ERM OTERR ESUNAVL R R E E E UNIMP ERV UNAVIL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Issue 1 October 1996 9 35 Programming Manual Pages call_id Within this structure id_length specifies the length of ECS assigned party identifier and id ptr points to an array of binary bytes that specifies ECS assigned call identifier of the call to be terminated pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Poorin Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brie
171. dpoint on whose behalf the call is to be routed the value received in the Route Request or not available a Call Options Any of the following Priority Calling Direct Agent Call ACD Split Identifier m User to User Data A substructure containing user data The structure contains the following fields leng field An integer value that indicates the number of octets of user data included in the request This field is set to O if no user user data is present Currently ECS will accept up to 32 bytes of data leng 32 If more than 32 bytes are specified all the data is discarded protocol field Indicates the type of information and is restricted to C UU USER which indicates a user specific protocol or C UU IAS5 which indicates IA5 or ASCII characters info field A pointer to an ASCII string of no more that 32 characters in length Issue 1 October 1996 5 45 ASAI Capabilities Notes The server may alter the Destination Address value from the value received from the client The client must use the value provided by the server 5 46 Issue 1 October 1996 Route End Route End Description The Route End capability allows the client to inform the server that it wants to terminate the routing association The routed call under the control of the client is not affected by this termination The reason for the termination is contained in the Cause parameter This is an unac
172. ds coding standard 0 includes any cause values which are part of Lucent Technologies and ITU ISDN specifications coding standard 1 includes any other ASAI cause values Client As used in this guide the initiator of a request for service usually but not always the adjunct Issue 1 October 1996 GL 3 Glossary Cluster Synonym for capability group or ASE See also Association Controlled Extension A station extension that is being monitored and controlled via domain control association CPN Calling Party Number CRV Call Reference Value a number used to identify the logical channels on the ISDN D channel D Daemon Administrative process started when a UNIX system goes into a specified state that controls the activities of a system or peripheral device Denying a Request Equivalent to sending a negative acknowledgement NAK This is done by sending an FIE with a return error component A cause value is also provided It should not be confused with the denial event report which applies to calls Domain Available domains are vector directory numbers ACD splits and extensions The VDN and ACD split domains are only used for active notification associations The extension domain is used only for the domain control associations Domain Control Association A third party domain control request capability initiates a unique CRV link number combination which is referred to as a domain control association Domain Cont
173. duct and the device driver as well as the board identification number Exit Codes If there are no errors the exit code is 0 Otherwise the exit code is set to 1 to indicate an error 2 38 Issue 1 October 1996 isdn_alarm 1 isdn_alarm 1 Name isdn_alarm Turn on or off isdn_bri maintenance alarming Synopsis isdn alarm a d b1 b4 t0 tn e Description isdn alarm uses the suspend and resume routines to turn on or off the isdn bri alarms that are sent from ECS a Activates alarming d Deactivates alarming b numboard Specifies the board where numboard 1 4 is sent the message t numsec Sets the time out to n seconds where lt numsec gt 0 n the default is t3 g Displays the exit codes list shown below Displays the terse help message Issue 1 October 1996 2 39 Administration Exit Codes If isdn alarm fails one of the following exit codes is returned 0 The alarm condition was changed per request 1 Failure due to inadequate memory 2 Open stream failure 3 Failure to send message to board 4 Failure to receive messages from board 5 Time out while waiting to receive a message 6 Layer 1 is down could not attempt reset 7 Layer 2 failed to recover from reset 8 State machine transitioning try again 2 40 Issue 1 October 1996 isdn Date 4 isdn Date 4 Name isdn Date Date file for UNIX ISDN
174. e LAN Gateway links The long form contains the following information Table2 3 Long Form Status Values Link The LAN Gateway link number Possible values are 1 to 8 Dest The Hostname of the ASAI E board with which the link will connect Type The type of link LAN or ISDN should always be LAN Status The status of the link numeric value in braces Num Retry The number of times the LAN Gateway link has attempted to connect to the ASAI E board time to Retry The number of seconds until the next connect attempt will be made Link Fd The file descriptor of the socket connection for the LAN link MUX Fd The file descriptor of the multiplexor for the LAN link TLI Fd The file descriptor of the TLI to TCP connection 2 48 Issue 1 October 1996 lan_stat 1 CS See Also The short form default prints only Link Dest and Status Table 2 4 Common Status Values Talking This indicates Layer 2 connectivity to ECS TLiFailure This indicates that the PC is unable to talk to the ASAI MFB It could be a LAN problem or the MFB could be down or disconnected from the LAN BRiDown This indicates that the CallVisor PC can connect to the MFB via the LAN but the MFB is not communicating with DEFINITY ECS InvalidClient This status indicates that the MFB board has not been administered to communicate with this CallVisor PC LAN link offline This status indicates that this LAN link w
175. e feature is received or a reguest to cancel an already inactive feature the server sends a positive acknowledgement Issue 1 October 1996 5 41 ASAI Capabilities Adjunct Routing Capabilities The Adjunct Routing capability group consists of the following capabilities m Routing Route Select Route End The Abort capability described later in this chapter is also part of this capability group This ASE does not provide any timing mechanism for the receipt of acknowledgements The client can use its own timers to determine the length of time it will wait for a response from the server The client or the server can terminate a routing capability regardless of outstanding acknowledgements by issuing a U_ABORT 5 42 Issue 1 October 1996 Routing Routing Description The Routing capability allows the client to reguest routing instructions based on the incoming call resources used by the call such as originating address or destination address The client invokes this capability by issuing a C_RT_REO to which the server responds with a C RT SI EL capability that provides the route to use The route can be a local or remote endpoint directory number such as an ACD agent to which the call should be routed The server can also respond with a C NEG ACK using C RT SI actions for a client with an incoming call EL capability to deny the client s request Figure 5 1 shows the
176. e operation requested could be performed A corrupt message was received on the given stream This error is set in asai send and asai rcv whenever a malformed message was read from a stream It is recommended that the stream be closed as soon as possible The send or receive buffer is too small for the capability This error is set in asai_send and asai rcv whenever the buffer size passed is too small Cannot send an unknown capability This error is set in asai send whenever an invalid capability is found in the user buffer The request has a missing or invalid matching parameter This error is set in asai_send and asai rcv whenever a mandatory parameter is missing or when two parameters are used inconsistently For example the values in the capability and primitive type parameters must match an initiating capability with an acknowledgment type is an error When returned by asai rcv this error indicates that a message has been lost Library Error Messages C_BADVALUE C_TOOBIG C_ACTIVE The request has an invalid parameter value This error is set in asai_send whenever a parameter has an invalid value Typically this will result from using a definition not meant for the parameter being set A variable length field pointed to by a parameter was too big This error is set in asai_send whenever the user request cannot be sent because of protocol limitations This may be the result of usi
177. e value logging is to kill the asai_cause process A maximum of 160 process ids may be included Following is an example of the format used for logging cause values to stdout when the v option is not included DEFINITY TIME PID CAPABILITY SAO ID ECS ASAI 11 35 33 123456 C 3PMC CONF 4444 CS3 38 C NETWORK OUT OF O 11 38 12 123456 C EN CAN CONF 1 CS0 100 C INVLDIE 07 49 52 55555 C 3PAD CONF fffffffd CS0 17 C USER BUSY 09 06 02 55555 C EN REP RRSffffff CS0 16 C NORMAL 2 12 Issue 1 October 1996 asai_cause 1 Following is an example of the format used for logging cause values to stdout when the v option is specified DEFINITY DATE TIME PID CAPABILITY SAO ID ECS ASAI 08 27 92 113357233 123456 0x83 4444 CS3 38 C_NETWORK_OUT_OF_O 08 27 92 11338312 123456 0x94 1 CS0 100 C INVLDIE 08 28 92 07 49 52 95595 0xc6 fffffffd CS0 17 C USER BUSY 08 28 92 09 06 02 55555 0x95 ffffffff CS0 16 C NORMAL See Also asai_trace 1 isdn_trace 1 Shared Resources m Message Queue Shared Memory Exit Codes If asai cause fails one of the following exit codes is returned U ftok failed to determine key 2 Error in getting shared memory 3 Error in getting message queue 4 Error in getting a semaphore 5 Attempt to ignore SIGHUP failed 6 asai cause command line usage problem 7 Error in attaching to shared memory 8 Error in setting the value of the semaphore 9 Error in receiving a message 10 Error on atte
178. ease 5 CallVisor ASAI Technical Reference ASAI services are broken down into functional sets called capability groups Capability groups enable the adjunct to communicate and control the DEFINITY ECS Central to the idea of capability groups and ASAI in general is the concept of an association An association is a channel of communication between the adjunct and the DEFINITY ECS that is used for messaging purposes An association begins with initiating capabilities controlling capabilities manipulate messages during an association and terminating capabilities end an association An adjunct or more specifically each BRI board installed on an adjunct can manage many active associations at one time and each association must be tracked by the CallVisor ASAI software drivers Tracking consumes adjunct memory that must be reserved for the CallVisor drivers 148 bytes are required to track a single association The amount of memory to be reserved is specified by the NCLID number of cluster ids environment variable NCLID effectively limits the number of active ASAI associations that are allowed to run on each BRI board It is important to note that the NCLID specifies the maximum number of associations that may run on each BRI board not the maximum number for all boards combined The NCLID default is 2048 This should be sufficient for the majority of applications using ASAI However if the adjunct processor has a limited amount of memory or
179. ection Type Continuing Unacknowledged Usage typedefstruct long long long char user_code_t typedefstruct asai_common_t char char user_user_t user_code_t party id t long char rts info t typedefstruct asai_common_t long rt_nak_t Description type collect timeout digits asai_common calling_num called_num uudata ofacility ofac ext priority call dir agtcall user data party id specific event pool C DATSZ asai common cause value The client that is ECS sends this capability to request route selection information relating to a route or route again request Use of this capability is an implicit acknowledgement of the route request A structure of type rts info t contains the information needed to fulfill the request 9 142 Issue 1 October 1996 C RT SEL 3ASAI asai common The programmer sets capability to C RT SEL and primitive type to C REQUEST for a positive acknowledgement The primitive type is set to C NEG ACK for a negative acknowledgement The programmer also sets the sao id also known as cluster id to identify the association of the route request calling num called num The calling and called extensions are specified by the null terminated strings pointed to by these parameters The calling extension is optional therefore calling num may be a null pointer The called extension is mandator
180. ed digits event report to convey information to the adjunct The leng field is an integer value that indicates the number of octets digits of user data included in the request The type field indicates the type of information and is restricted to C UU IA5 which indicates IA5 or ASCII characters The digits field is a pointer to an ASCII string of no more that 32 characters in length typedef struct char oli ptr long oli length long reserved roli t Since ECS does not accept any Il digits from an ASAI adjunct CallVisor PC only supports receiving this IE not sending it The field o1i lengtnhis the length of the byte array pointed to by the field oli ptr If the IE is missing from the message or its length is zero o1i length is zero In all other cases it is the size of the array The field o1i ptr is a pointer to an array of binary bytes This substructure is included in the following ASAI event report capability structures 1 Call Offered to Domain incall list t 2 Alerting alert list t 3 Connected connect list t It is also included in the Route Request capability structure rt info t Issue 1 October 1996 cause value cause_value Certain capabilities return a parameter called cause_value if a negative acknowledgement is sent or received These cause_values are noted with each capability In general a cause_value is returned by ECS and mapped to an ASAI cause value Table 8 1 lists ASAI
181. ed to fulfill the request asai common The programmer sets capability to C 3PSL RECONN and primitive type to C REQU EST The programmer also sets the sao id also known as cluster id to identify the association that controls the call to be reconnected from pa rty id to party id from party id isarequired parameter and specifies the party listening to party idis an optional parameter When the to party id is specified the only path that will be reconnected is between the talk and listen parties Otherwise all parties who were disconnected rom party id are reconnected For party identifiers the length of the identifier is id Length The binary array pointed to by id ptr contains the party id See the Identifiers section in Chapter Return Value 8 ASAI Capability Primitives for more information When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent 9 84 Issue 1 October 1996 C 3PSL RECONN 3ASAI Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by a client See Also asai send C 3PSL DISC C 3PSL DISC ACK C 3PSL RECONN ACK C EN REP C 3PMC REQ C 3PMC CONF C G3PTC REQ C 3PTC CONF C 3P
182. ence 555 230 221 for a description of the Type of Address and Numbering Plan fields as they exist for the Called Party Number IE Many messages contain two or more of the affected IEs redirecting calling called and connected number To avoid confusing these IEs it is desirable that Issue 1 October 1996 8 1 ASAI Capability Primitives 8 2 the Type of Address and Numbering Plan fields be closely associated to the string of ASCII digits which they are intended to describe The conventional method of implementing such an association is to place related fields within a single structure At present however the ASCII digit string is simply a pointer and no single structure is conveniently in place Unfortunately defining a new structure would have profound implications for current applications Specifically all references to redirecting calling called and connected number IEs would have to be recoded The solution that has been adopted leaves the present redirecting calling called and connected number fields unchanged Rather they have been immediately followed with a new structure of type plan type t that contains the Type of Address and Numbering Plan fields Another new structure of type number_id_t has also been added The number_id_t structure contains a plan_type_t structure and a pointer to the ASCII digit string as well As a result applications that need to access the new Type of Address and Numbering Plan info
183. ength is zero the field is omitted If the id length is not zero the id ptr contains a binary representation for the call id Redirect Number This required parameter identifies the destination of the redirected call Two fields plan type and s are in a number id The field s is a null terminated string containing the destination number The field plan type is described in the Identifiers section in Chapter 8 ASAI Capability Primitives m Party Identifier This is an optional parameter It specifies the redirected from party on the call The length of the party identifier is id length The character array pointed to by id ptr contains the party id If omitted the last added party is used Notes For a call to be redirected it must be alerting at a station Interactions with Event Reports A redirected call s event reports will be the same as to call coverage 5 28 Issue 1 October 1996 Third Party Relinguish Control Third Party Relinguish Control Description The Third Party Relinguish Control capability allows a client to yield control of an existing call All parties remain connected to the call Once acknowledgedment is received from the server no further feedback is provided and the client cannot exert any further control over the call or domain within that association The client invokes this capability by issuing a C_3PRC_REO to which the server responds with a C_3PRC_CONF Third Party Relinguish Contro
184. er Various releases of the library are distinguished using major minor and delta version numbers A major release is defined by a technological level or major change in operation from a previous release A minor release is an enhancement or refinement to an existing major release A delta release is a small enhancement or bug fix differently tuned or specific to a hardware platform ASAI library functions do the following w Manage communications paths asai open asai close asai set env asai get env w Manage associations over an established communications path asai rcv asai send m Assist in debugging asai errval On the following pages each library function is described by some or all of the following sections Name This section names and succinctly describes the function Synopsis This section illustrates the declaration of the function including necessary header files Description This section describes the function including its parameters Return Value This section gives the return values of the function on success and failure Errors This section lists error values and describes the errors that are set in asai errno asai errno is defined as follows long asai errno 9 2 Issue 1 October 1996 ASAI Library Manual Pages Notes This section is used to describe any exceptions caveats or usage suggestions pertaining to the function See Also This section lists relate
185. ersion number library 4 9 9 2 f version of library checking 4 9 4 10 version selection tunable parameters 11 4 lt version printing Ww w_dnis ISO character definition 9 140 w dnis characters raw OPTREX data translation w name definition 9 156 Cd waiting time for call answer 5 3
186. ervice Elements Table 3 4 ASAI Capabilities by Capability Group ASE Continued ASE Capability Description Third Party Call Control C_3PRC Relinquish Control continued C_3PRC_CONF Confirm Relinquish Control C_3PREDIR Redirect Call C_3PREDIR_ACK Confirm redirect Call C_3PSD Selective Drop C_3PSD_CONF Confirm Selective Drop C_3PSDS Send DTMF Signals C_3PSDS_CONF Confirm Send DTMF Signals C_3PSH Selective Hold C_3PSH_CONF Confirm Selective Hold C_3PSL_DISC Listen Disconnect C_3PSL_DISC_ACK C_3PSL_RECONN C_3PSL_RECONN_ACk Confirm Listen Disconnect Listen Reconnect Confirm Listen Reconnect Take Control Confirm Take Control C_3PTC_REQ C_3PTC_CONF Event Notification C_EN_CAN Cancel EN C_EN_CAN_CONF Confirm Cancel C EN CONF Confirm EN C EN END End EN C EN REP EN Report C EN REQ Request EN C EN SON Stop EN C EN SCN CONF Confirm Stop EN Maintenance Heartbeat C HB CONF Confirm HB C HB REQ Request HB Request Function C RF CONF Confirm RF C RF REQ Request RF Routing C RT END End RT C RT REQ Request RT C RT SEL Select RT Set Value C SV CONF Confirm SV C SV REQ Request SV Issue 1 October 1996 3 11 Introduction to ASAI Table 3 4 ASAI Capabilities by Capability Group ASE Continued ASE Capability Description Value Query C_VQ_CONF Confirm VQ C_VQ_REQ Request VQ C_VQ_RESP VQ Response In addition the ASAI library provides two types of C_ABORT capabilities a
187. es and Descriptions Argument Meaning field name name of the field being entered cap info starting address of the cap info table for this capability mode operation mode returned by call to C W parse batch value if the mode is SCRIPT MODE then this is a pointer to a character string containing the ASCII value of the parameter Return Value Returns the address of the capability information structure for this field Issue 1 October 1996 10 27 Testing t_output 3 Name t_output Synopsis t_output fieldname expected_filename type value mode char fieldname char expected filename int type char value int mode Description t output is called by read side capability handling functions It serves three purposes 1 prints received value to standard output 2 records name value pair in specified file 3 compares received value with the one recorded in the expected answers file The mode field is used to determine which of the above three is appropriate Return Value The return value is normally SUCCESS 10 28 Issue 1 October 1996 CVLAN Testing CVLAN Testing Overview A modified version of ITT called cvin_itt is provided to test the CVLAN client API the CVLAN server and the ASAI library After installation of the CVLAN client software for Solaris X86 and UnixWare CVLN_ITT can be found in the usr adm asai_itt directory For Sparc Solaris it is in usr adm asa
188. escriptions Return Value Meaning INTERACTIVE the user should be prompted for capability specific information RECORD_DIALOG a file name has been specified to record the dialog SCRIPT_MODE a file name was supplied that contained answers to the dialog specific guestions Issue 1 October 1996 10 25 Testing print_common 3 Name print_common Synopsis print_common common ptr asai common t common ptr Description printf the values of each of the elements of the ASAI common message header to stdout Return Value Returns the defined value of SUCCESS This return value is usually ignored by the calling function 10 26 Issue 1 October 1996 t_input 3 t_input 3 Name t_input Synopsis t input fieldname cap info mode batch value char field key struct cap info cap info int mode char batch value Description If the mode is INTERACTIVE this function displays the name of the field gives choices if they were defined in the choices tables set up by the programmer and accepts input If the RECORD DIALOG bit is on in the mode it will append the results to the current dialog file If the mode is equal to SCRIPT MODE it is assumed that the value of batch value is the ASCII representation to be used The ASCII string is converted as necessary and stored in the table s value field Arguments to this function are described as follows Table 10 3 Argument Typ
189. est Test connection s with ECS Synopsis asai_test Description For all ASAI nodes the connection to the corresponding ECS is tested Operation For each ASAI node an ASAI heartbeat request is sent to the corresponding ECS The response from ECS is tested for correctness Return Value For success 0 is returned If an error is detected 1 is returned Output If the response is correct a success message is printed on stdout If there is an error the corresponding error message is printed on stderr Files dev asai asai usr adm asai config data Issue 1 October 1996 2 17 Administration asai_trace 1 Name asai_trace Decodes an ASAI message stream Synopsis asai_trace a c E e f h i m n o q r s v Description asai_trace decodes an ASAI message stream and can be called with command line options or options can be set using an online help facility a Use short mnemonics abbreviated mode c Coding standard information is included T Expect LAN GATEWAY format messages on stdin for example esai trace nawk f usr adm isdn bin xlat k asai trace E Causes input to be taken from the command esai_trace f Creates from 1 to 6 raw hex files in addition to the trace information The first file created is rawtrace out 0 If it overflows output goes to a second file rawtrace out 1 If this file also overflows rawtrace out 2 is created an
190. est tool will ignore the expected field A default timer of 120 seconds will cause the test tool to exit with an Alarm call message displayed To change the default value enter an integer value Issue 1 October 1996 10 13 Testing Heartbeat Confirmation C HB CONF This message is received from ECS confirming a heartbeat request Its output looks like the following HEARTBEAT CONFIRMATION asai common capability 24 asai common primitive type 1 asai common cluster id 10 Figure 10 6 Heartbeat Confirmation Message The contents of the output file look like the following asai common capability 24 asai common primitive type 1 asai common cluster id 10 Figure 10 7 Heartbeat Confirmation Output 10 14 Issue 1 October 1996 Scripts Set Value Confirmation C_SV_CONF This message confirms a set value request Its screen output resembles the following SET VALUE CONFIRMATION asai common capability 31 asai common primitive type 1 asai common cluster id 10 Figure 10 8 Set Value Confirmation Message Issue 1 October 1996 10 15 Testing Event Report C_EN_REP This message contains event reports sent to the adjunct PC by ECS Incoming Call Event Report The following event report is generated when an external caller places a call to an ASAl controlled domain di N EVENT REPORT asai common capability 22
191. et to the CVLAN Server Prototype long asai_close int socketfd Argument File descriptor of the socket connection to the CVLAN server Return Value If the socket was closed successfully the return value is 0 but if there is an error it is 1 Example close routine extern int fd if asai close fd lt 0 asai errval error closing communication path return Issue 1 October 1996 6 11 CVLAN Programming 6 12 Issue 1 October 1996 Error Messages Library Error Messages Library error messages are listed alphabetically below with a brief explanation of the probable cause of each error C_NOENT C_BADCHAR C_BADCHARVAL C_BADCLUSTID C_BADFD C_BADF LOW No such file or directory This value is set when the file passed to asai_open does not exist Unknown or improper context for a characteristic This value is set when an invalid characteristic is passed to either asai set env Ofasai get env Characteristic s value is invalid This value is set when asai set env is passed an invalid number of servers or a bad type of server The Cluster ID also known as sao id is invalid for the given stream This value is set when asai_send is passed an initiating request with an ID that matches an existing SAO or when it passes a noninitiating request with an ID that matches no existing SAO File descriptor was not returned by asai open This value is set when the file
192. evr_buf_t member that carries the specific information related to that event The table below gives the name of the event its associated evr buf member and a description of each item within the member Table 9 1 Redirection Reason Codes Redirection Reason Cause Value ASAI Value Send All Calls CS3 31 C FORWARD ALL Cover All Calls CS3 31 C FORWARD ALL Go to Cover Active CS3 31 C FORWARD ALL Adjunct Redirected Alerting Call CS3 31 C_FORWARD_ALL Call Forwarding CAFW2 CS3 25 C_FORWARD_BUSY Cover principal Busy CS3 26 C COVER BUSY Cover all call appearances busy CS3 26 C COVER BUSY Cover does not answer CS3 28 C COV DONT ANS Issue 1 October 1996 9 107 Programming Manual Pages Table 9 2 Event Name Members and Descriptions Event Name evr_buf Member Description C_ALERTING alert_list call idis a structure of the type call id t call id specifies the call being reported on See the Identifiers section in Chapter 8 ASAI Capability Primitives for more information cause is a long integer value returned by ECS that indicates the cause of the alert The new 4 0 Alerting Event Report redirection reason Cause Value information will be provided when any type of domain controlled monitored endpoint receives an alerting call as result of a redirection Although the Cause IE in the Alerting Event is optional it will always be provided when alerting at an endpoi
193. f explanations of their probable causes Notes This capability can be issued only by a server See Also asai send lasai rcv C EN REP C 3PMC REQ C 3PMC CONF C 3PTC REO C 3PTC CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PRC C 3PRC CONF 9 36 Issue 1 October 1996 C 3PDC CONF 3ASAI C 3PDC CONF 3ASAI C 3PDC CONF Acknowledge a third party domain control request Continuing Unacknowledged when used as a positive acknowledgement Terminating Unacknowledged when used as a negative acknowledgement Name Type Usage typedef struct asai common t long stn info t char a3pdc ack t typedef struct asai common t long a3pdc nak t Description asai common num callid stninfo list pool C DATSZ asai common cause value The client receives this capability as a positive or negative acknowledgement of a domain control request The a3pdc_ack_t type and its contained parameters are members of a conditional return structure For positive acknowledgment if the domain type has been set to C ACD SPLIT in the domain control request C_3PDC_REQ then this capability includes only the asai common structure Positive acknowledgment of the control of an ACD agent does not return these parameters If domain type is set to C_E XT ENSION in the domain control request a3p
194. ffline 7 link_status 1 lan_stat 1 Issue 1 October 1996 2 53 Administration link_status 1 Name usr bin link_status Print Status of IPCI Link s and LAN GATEWAY links Synopsis link status n LinkNo a Description If n link Nois specified a status report is printed for only that link Otherwise a status report is given for all administered links The report is printed to stdout Link status is a shell script that determines if a specified link belongs to an IPCI group or a LAN GATEWAY group and via the appropriate OA amp M call prints the status of the link s If a is specified a long version of the status for LAN GATEWAY links is generated See the manual page for 1an_stat 1 for more details on the LAN GATEWAY link status See Also isdn trace 1 ipci stat 1 2 54 Issue 1 October 1996 log_msgs 4 log_msgs 4 Name log_msgs UNIX ASAI adjunct Log Message File Description Files See Also This file contains an explanation of certain status or error indications received by ipci_admin 1 from the IPCI device driver as it monitors the admin stream Where applicable it also contains remedial action information for the system administrator Each status or error number is unigue The information in this file is used by ipci_admin 1 All characters in this file are printable ASCII characters This file resides in the usr adm asai directory There are two types of lines
195. fier is to be added to the call request The default is C SERV OFF dir_agtcall A value of C_DIRAGT_ON for dir agtcall indicates that the call is directed to a specific ACD agent The default is C prRAGT OFF When dir agtcallis selected ofac_ext contains the identifier of the ACD split containing the agent and ofacility should be set to C ACD SPLIT when super ast is selected super ast A C SUP AS ON value for super ast indicates that the call is an ACD call directed to an ACD supervisor by an agent who needs assistance otherwise this parameter assumes a value of C SUP AS OFF when super ast is selected alt dest Thealt dest parameter can assume the values of C ALERT ON indicating that the destination is to be alerted first or C ALERT OFF ack flag The ack_flag parameter allows the client to request acknowledgment of the make call request A value of C ACK OoN indicates that acknowledgment is expected C ACK Orr indicates that acknowledgment is not expected ans mach treat If ans mach treat is CO AM DISC the call is disconnected upon answering machine detection If the treatment is C CO AM SWITCH it follows the setting in ECS administration If the treatment is C CO AM CONNECT the call is disconnected This parameter must be coded 1 if unused pool library to store program specific information See the section in Chapter 8 ASAI Capability Primitives for more information The
196. file descriptor of the socket connection to the CVLAN server The second argument is the capability buffer to be sent The third argument is the size of the buffer being sent Return Value If will be 0 for the number of bytes sent and 1 if no data can be sent Example if asai send socketfd char amp a3predir sizeof amp a3predir info t lt 0 asai_errval 3rd party redirect alerting call request exit asai_errno Issue 1 October 1996 6 9 CVLAN Programming asai rcv Description asai rcv allows the user to receive indication primitives Indications may take the form of requests or positive or negative acknowledgments Prototype long asai rcv int socketfd asai info t buf long lenth Arguments The first argument is the descriptor that identifies the communication path The second argument is the information buffer to receive the ASAI message The third argument is the size of the information buffer that may receive the ASAI message Return Value asai rcv returns the size of the information buffer that must be a value greater than 0 on success and 1 on failure asai_errno is set to indicate the reason for failure Example if asai rcv socketfd char amp rt info sizeof rt info t lt 0 asai errval 2 minute timer indicates a Heartbeat was not issued exit asai_errno 6 10 Issue 1 October 1996 asai_close asai_close Description Close a sock
197. freeing unrecognized message of size 0x2 15273 OP qp rsrv 516 msg 0 0x8 msg 1 0x1 The kernel mechanism used by the device driver does not guarantee message order or integrity Therefore a sequence number is placed on each message by the ESAI device driver to allow detection of missing or out of order messages Turning on the message trace facility causes an additional system load Sometimes the load is significant usr adm isdn bin esai trace usr adm isdn bin asai trace asai trace l1l 2 28 Issue 1 October 1996 ipci 4 ipci 4 Name ipci Pump and start administration for all IPCI boards Synopsis ipci Description ipci is a shell script that starts the ipci administration daemon process ipci_admin 1 located in etc idrc d Operation The ASAI program is executed once per machine boot in the multiuser init level of 2 The name of the log file asai_log is changed to 0l1d_asai_log The administration daemon asai_admin 1 is then started When this is done the standard error device is defined as dev console for ipci_admin 1 Exit Codes If pumping the board s is successful 0 is returned as the exit code Otherwise 1 is returned Files usr adm asai asai log dev isdn ipci admin dev asai asai dev isdn ipci command dev isdn ipci signal0l dev isdn ipci signal02 dev isdn ipci signal03 dev isdn ipci signal04 See Also ipci admin 1 ipci on 1
198. ges for a list of error messages with brief explanations of their probable causes See Also asai send C 3PDC REQ C 3PDC CONF C 3PAD C 3PAD CONF C EN REP C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PRC C 3PRC CONF C 3PSDS C 3PSDS CONF 9 24 Issue 1 October 1996 C_3PAD_CONF 3ASAI C 3PAD CONF 3ASAI Name C 3PAD CONF Acknowledge an auto dial request Type Continuing Unacknowledged Usage typedef struct asai_common_t asai common call id t Gall id party id t party id char pool C DATSZ a3pad ack t typedef struct asai common t asai common long cause value a3pad nak t Description The client receives this capability as a positive or negative acknowledgment to a C_3PAD_REQ request The C 3PAD CONF capability is always continuing and will not be carried in a RELease COMPlete message asai common Capability is returned as C 3PAD CONF and primitive type is returned as C POS ACK for a positive acknowledgment and as C NEG ACK for a negative acknowledgement The sao id also known as cluster id specified in the auto dial request is also returned A positive acknowledgment confirms that the C 3PAD REO request has been received and understood Subsequent event reports will indicate the progress of the call call id This parameter identifies the resulting call party id This parameter indicates t
199. h kind of service To summarize an application may be a client of at the most one node and can optionally provide services to one or more nodes for each file descriptor The code example in Figure 4 4 uses the C NODE ID characteristic to supply the node identifier Note that the alternative compares the return value from asai set env toa long 0 if asai set env fd C NODE ID node id 0 asai_errval asai_set_env C_NODE_ID failed exit asai errno an alternative if asai set env fd C NODE ID argv 1 lt OL 24 Figure 4 4 Setting the Library Environment Node ID 4 6 You may also need to specify that the application is to function as a server for ECS routing and maintenance requests A single application can function as a Issue 1 October 1996 asai set env server for more than one node on a single file descriptor A node can be equated to a PC ISDN board or port on an ASAI connection Note that each node will allow only one server for each kind of service To do this set the num node field ofthe server type t structure to the number of nodes the application is to serve Set the buf field to point to an array of structures of the same length Set the name of the node for example signal01 in the node id field or set all the names together of the server types desired in the server type field The code example in Figure 4 5 illustrates the use of asai set env to se
200. hat indicates the logical extensions EAS only of the agent work mode canbeC AUX WORK C AFTCAL WK C AUTO IN C MANUAL IN auxiliary mode after call work mode auto in mode and manual in mode See C ALERTING Issue 1 October 1996 9 113 Programming Manual Pages Table 9 2 Event Name Members and Descriptions Continued Event Name evr buf Member Description C LOGOUT logout list extension is a pointer to a null terminated string indicating the extension of the agent who was logged out ext_type is an optional plan type t structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL See C_ALERTING con_num_typel for more information concerning plan_type_t logical is a pointer to a null terminated string indicating the logical extension of the agent logging out EAS environment only reason_code is a long integer from 1 to 9 indicating the reason why the agent logged out poo1 see C_ALERTING C_DROP drop_list call idis a structure of the type call id t whereid ptr points to a mandatory character array that indicates the ECS assigned identifier of the dropped call and id lengthiis the length of the call identifier drop cause is an optional integer value that indicates the cause of the dropped call This item can be any ECS specific cause value or C NUSE LONG
201. he association identifie party id Specifies the party to be reconnected The r used to put the party on hold length of id ptris id length party idis used only when the association is initiated by the C 3PTC REQ or the C 3PMC REO capability party idis not an ASCII null terminated string but rather an array of binary bytes of the specified length See the Identifiers section in Chapter 8 ASAI Capability Primitives for more information call id call idis ECS assigned identifier of the call to reconnect The value of this parameter is a character array of length id length pointed to by id ptr call idis used only when the association is initiated by the C 3PDC REO capability Issue 1 October 1996 9 55 Programming Manual Pages pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Poorin Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by a client See Also asai send C
202. he function returns the size of the message when successful and 1 on failure A return value of O does not indicate an error it merely indicates that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai rcv C EN REP C 3PMC REQ C 3PMC CONF C 3PTC REO C G3PTC CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C_3PSD C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF Issue 1 October 1996 9 75 Programming Manual Pages C 3PSH ASAI Name C 3PSH Place selected party on hold Type Continuing Acknowledged Usage typedef struct asai common t asai common party id t party id call id t call id char pool C DATSZ a3psh info t Description The client sends this capability to request that a party be placed on hold The party must be on a call controlled by the client A structure of type a3psh info t contains the parameters n asai common The programmer sets capability to cC 3PsH eeded to fulfill this request and primitive type to C REQUEST The programmer also sets the sao id also known as cluster id to identify the association that controls the call to be held party id For call control associations that is those i nitiated with C 3PTC REQ or C 3PMC REQ party id specifies the party to be placed on hold For domain controlled as
203. he identifier of the originator Issue 1 October 1996 9 25 Programming Manual Pages cause_value This parameter can be any of the following NVALID_CRV SER_BUSY OUSE RESP I U N OUT OF SERV N I P ETCONJ NVLDIE ROTERR ESUNAVL e See Table 8 1 ASAI Library and DEFINITY ECS Cause Values in Chapter 8 for further information on cause values pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool fin Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure Return value of 0 does not indicate an error but that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai rcv C 3PANS C 3PDC REQ C 3PDC CONF C 3PAD C 3PAD CONF C EN REP C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PRC C 3PRC CONF 9 26 Issue 1 October 1996 C_3PANS 3ASAI C_3PANS 3ASAI Name C_3PANS Answer a call Type Continuing Acknowledged Usage typedef struct asai_common_t asai_common call_id_t call_id char pool C DATSZ a3pans info t Description This c
204. he instance of communication asai errval lets you specify an error message that is written to the standard error device along with the system supplied ASAI error message The asai errval function should be used after every failed function call in your program Your error message is specified in a null terminated string mes buf of maximum size C MESIZE Note that the error messages can be as terse or as verbose as you wish although a length of more than 80 characters the length set for C MESIZEinthe samp hdrs file supplied with the system is probably not necessary You can specify a message directly as in the code example in Figure 4 2 or you can specify it indirectly as in the code example in l UN it d 0 asai_errval asai_open dev asai asai failed exit i Ne P Figure 4 2 Using asai errval Example 1 4 4 Issue 1 October 1996 asai errval char pathname char buf C MESIZE char p ut asai function args lt 0 ASAI function failed n asai_errval ASAI function failed Se P Figure 4 3 Using asai_errval Example 2 Note that the colon included as part of the message in Figure 4 2 is not necessary The message written to standard error consists of your specified message a colon and then the ASAI message For a full listing of the ASAI error messages see Chapter 7 Error Messages asai_errva
205. he request Request Confirmation Parameters m Destination Address The called endpoint Return Acknowledgement Indicating that the server must return an acknowledgement to the client In addition the following parameters are optional m Facility Type Used only if the Destination Address is a trunk group m Facility Access Code Required only if Facility is specified a Priority Calling Provides a special ring and places call ahead of all other calls for that party m Userto User Data A substructure containing user data The structure contains the following fields Leng field An integer value that indicates the number of octets of user data included in the request This field is set to O if no user user data is present Currently ECS will accept up to 32 bytes of data Leng 32 If more than 32 bytes is specified all data is discarded Protocol field Indicates the type of information and is restricted to C UU USER which indicates a user specific protocol or C UU IA5 which indicates IA5 or ASCII characters Info field A pointer to an ASCII string of no more that 32 characters in length 5 14 Issue 1 October 1996 Third Party Auto Dial Notes There are no restrictions on this capability Related Event Reports This capability does not affect the state s of the parties to the call Issue 1 October 1996 5 15 ASAI Capabilities Third Party Call Ended De
206. here are none verify that the MFB administration is correct by following the procedures in the DEFINITY ECS Installation Administration and Maintenance of CallVisor ASAI over the DEFINITY LAN Gateway for your operating system If the ping command returns a negative response either the ASAI MFB is not properly configured not connected to the LAN or there may be other LAN problems for example LAN administration or routing Consult the DEFINITY ECS Installation Administration and Maintenance of CallVisor ASAI over the DEFINITY LAN Gateway and the Network Administrators Manual for these types of problems If the DEFINITY ECS and ASAI MFB are properly administered and the LAN checks out call the CallVisor PC helpline number at 1 908 957 5725 If the connectivity test succeeds you have demonstrated the compatibility of the computing platform and the CallVisor PC package Congratulations you have successfully installed the CallVisor PC package gt NOTE The kernel environment variable which is the number of cluster ids NCLID sets the amount of memory to be reserved NCLID effectively limits the number of active ASAI associations that are allowed to run on each BRI board or LAN GATEWAY link NCLID has a default value of 2048 if only ISDN links are installed and a default value of 1024 if any LAN GATEWAY links are installed This should be sufficient for the majority of applications using ASAI 1 8 Issue 1 October 1996 Instal
207. i asai_itt directory For Windows NT 3 51 system it is under the CVLAN client program group Executing the CVLN_ITT program Scripts The CVLAN server will be installed on CallVisor PC and it will use the ASAI library to interface with the CallVisor stack To start CVLAN server the system has to be rebooted The server will open a socket and wait in listen mode for the next client connection For each client connection it will fork a child server process To test the connectivity to the server and to DEFINITY ECS the user can use CVLN_ITT The requirements for CVLN_ITT and ITT are the same but CVLN_ITT executes from the command line For UNIX itis cvin itt scriptfile and for Windows NT it is under the EXECUTE menu item of the CVLN_ITT program group The ITT scripts can be used with CVLN_ITT These scripts will require only a slight modification at the beginning of asai_open statement The statement beginning ITT scripts is as follows asai_open return_filename asai_special_file flags node_id server_num server_type All the arguments to asai_open remain the same except for node_id Since the CVLAN client needs to establish connection to ECS through the CVLAN server the node id must point to the server its IP address and the ASAI link to ECS The format used by CVLAN client API is IP address node id Example WWW XXX YYY ZZZ signal01 Issue 1 October 1996 10 29 Testing 10 30 Issue 1 October 1996 Troubleshoot
208. i_common_t asai common en scn nak t en scn nak Jen scn rsp t Description The client receives this capability as a positive or negative acknowledgment to a C EN SCN request asai common The capability is returned as C EN SCN CoNF and the primitive type is returned as C POS ACK for positive acknowledgment C NEG ACK for negative acknowledgment The sao id also known as cluster id specified in the stop call notification request is also returned cause value This parameter can be any of the following C FACUNSUB INVLDIE MAND INFO PROTERR RESUNAVL S S ER UNIMP ERV UNAVIL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Issue 1 October 1996 9 125 Programming Manual Pages Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of O does not indicate an error but no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai_rcv R C_EN_SCN C_EN EQ C EN CONF C C EN END 9 126 Issue 1 October 1996 EN RE P C EN CAN C EN CAN CONF C HB CONF 3ASAI C HB CONF 3ASAI Name C HB CONF Acknowledge a heartbeat request Type Terminating Unack
209. ibrary s versions 4 10 Issue 1 October 1996 asai_send asai_send asai_send and asai_rcv together are the central functions in the library These two functions convey all ASAI capabilities and data across an association asai_send has only three parameters file descriptor fa a pointer to the buffer that contains the message to be sent and the length of the buffer It is your responsibility to map the message to the appropriate structure one of the structures contained in the union asai_info_t otherwise the message cannot be interpreted correctly on the receiving side For example if you are sending a third party make call request you map the message to the structure a3pmc_info_t shown in part below typedef struct asai_common_t asai common char calling num char called num a3pmo info t All of the structures contained in asai info t start with asai common t referred to as the header asai common t consists of four long data types as follows typedef struct capability t capability primitive t primitive type long sao id long reserved asai_common_t In the case of the third party make call request the capability is C_3PMC_REQ and the primitive type is C REQUEST The library encodes the structure you have filled and forwards the result of the encoding to ECS When the library receives a message from ECS it decodes the message fills the necessary data into
210. ic is useful lt link link number 1 lt hexs gt GVI message contents in hex 96 1c 09 91 Received messages those coming from ECS usually have rcv cc in the function field cc refers to the courtesy copy buffer which is a general purpose board to the driver transfer buffer Issue 1 October 1996 2 45 Administration Examples Bugs 2 46 Transmitted messages those going to the IPCI board and then ECS usually have a mnemonic function for example gviSendSignal The function name is separated from the starting byte number by a slash The starting byte number indicates the byte number of the beginning left most byte of the hex field The first line of a message has a byte number of 0 The second line has a number greater than zero usually 12 and so forth for each additional line of the same message The next message will have a byte number of 0 for the first line The diagnostic field indicates the purpose of the entry Only trace entries with a diagnostic field value of MSG_TRACE are useful The driver QP frequently writes diagnostic messages These messages are normal and can be ignored Periodically the kernel reporting mechanism klog also writes entries These can also be ignored isdn trace gt trace in amp Turn on trace and send the output to the file trace in tail trace in Display the end of the trace in file When a heartbeat was sent to ECS using the command asai test output similar
211. icated by the error value set in asai_errno C BADFD Invalid file descriptor supplied C BADFLOW Cannot issue the request because of flow control C SYSER ASAI service error received a message on an unknown association This message will be returned only if sao ia formerly known as cluster id in a route request is already in use C BADLNG The send or receive buffer is too small for the capability C_BADMSG A corrupt message was received on the given stream C INTR A system call was interrupted by a signal C OSER A system call failed check errno asai open asai send asai set env Issue 1 October 1996 9 13 Programming Manual Pages asai send ZASAI Name asai send Send message via the communication path Synopsis asai asai def h asai asai str h asai asai err h include include include typedef union 9 14 Issue 1 Oct asai_common_t asai common abort info t abort info vq buf t vq buf vqr buf t vqr buf vqc buf t vqc buf en buf t en buf en rsp t en rsp evr buf t evr buf enc rsp t enc rsp ene info t ene info a3pmc info t a3pmc info a3pmc ack t a3pmc ack a3pmc nak t a3pmc nak a3pmc rsp t a3pmc rsp a3ptc info t a3ptc info a3ptc ack t a3ptc ack a3ptc nak t a3ptc nak a3psh info t a3psh info a3psh rsp t a3psh rsp a3psd info t a3psd info a3psd rsp t a3psd rsp a3psl disco t a3psl disc a
212. id 10 8 Od MWI see Message Waiting Indicator N name ISDN software 2 44 Z 1 node identifier nodes application number 4 7 09 nonblocking I O requirementsJ11 3 NSU definition 1 19 null state 5 7 number of cluster ids requirements and limitations number_id 8 7 O OA amp M commands 2 3 0 other test programs Issue 1 October 1996 IN 7 Index oveviewt CCC OA amp M changes CVLAN ES8 SSS OA amp M file command 7 esai alarm 1 ipci off 1 ipci on 1 ipci stat 1 ipci test 1 ipci ver 1 isdn Date isdn Name 4 isdn 11 r 1 isdn 12 r 1 isdn alarm 1 isdn trace lan stat 1 link status log msgs pcisdn bin OPTREXjxii 9 119 1 originating line identifier 8 10 1 originating line information 5 44 overview brief summary xv O P P ABORT 5 50 _ _ s O parameters ACD agentloginaudit 5 37 ACDagentstatus 5 37 O Z O ACDsplitstatus 5 37 o IN 8 Issue 1 October 1996 call classifier status 5 37 party id PC mem 5 23 NENNEN product description CVLAN 1 10 0 program definition 33 U establishing environment 4 6 program file IPCI boardj2 5G6 Cd protocol field 5 23 Q QP_DESIRED_VER preferred version 1 4 value 11 4 QP HIGHERVER highest allowed version 1 4 value 11 4 QP LOWERVER lowest allo
213. ility m The server invokes the Third Party Domain Control Ended capability m The server receives a P ABORT capability m The server receives or invokes alU_ABORTIcapability Request Confirmation Parameter Domain The domain over which event reports are to be provided and third party call control capabilities can be requested The domain consists of Domain Value station or ACD split skill Notes The client can request control only for domains directly associated with the server Interactions with Event Reports As soon as the server accepts this request it begins to issue event reports to the client 5 18 Issue 1 October 1996 Third Party Domain Control End Third Party Domain Control End Description The server issues the Third Party Domain Control Ended capability when it can no longer provide event reports domain The server issues a C 3PDCI or allow third party capabilities for the specified E after which the client no longer receives event reports for the domain The server will not accept additional third party capabilities and the association is terminated Notes Control must have been initiated with a Third Party Domain Control request Interactions with Event Reports This capability does not affect the state s of the parties to the call Issue 1 October 1996 5 19 ASAI Capabilities Third Party Listen Disconnect Description Third Party Listen Disconnect capability allows
214. ility is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes This capability can be issued only by a client Issue 1 October 1996 9 31 Programming Manual Pages See Also asai_send C_EN_R EP C_3PMC_RI EQ C 3PMC CONF C_3PTC_REQ C_3PTC_CONF C_3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF 9 32 Issue 1 October 1996 C 3PCC CONF 3ASAI C 3PCC CONF 3ASAI Name C 3PCC CONF Acknowledge a third party clear call request Type Terminating Unacknowledged when used as a positive acknowledgement Continuing Unacknowledged when used as a negative acknowledgement Usage typedef struct asai common t asai common long cause value a3pco rsp t Description The client receives this capability from the server in acknowledgement of a C 3PCC request The structure a3pcc rsp t contains the parameters necessary to service this capability asai common Within this structure capability is returned as C 3PCC CONF primitive type is returned as C POS ACK for positive acknowledgment and C NEG ACK for negative acknowledgment The sao id also known as cluster id
215. imum size of the user buffer is size of asai info t In the event that a received message will not fit in the buffer supplied by the programmer the ASAI library returns a 1 error and sets asai_errno to 14 C_BADLNG The message is saved for the next call gt NOTE If a program ignores this error and simply calls the library again an infinite loop is created Because of this all application programs must check for the presence of a C BADLNG error and provide a larger buffer if it occurs 9 12 Issue 1 October 1996 asai rcv 3ASAI If the function is used in a synchronous mode of operation asai rcv blocks until an entire message has been received until an error occurs or until a is closed by an interrupt function If the function is used in an asynchronous mode of operation asai rcv does not block The library can assume the role of the server that is a program that responds to ECS initiated associations only for the route and maintenance heartbeat services For all other services it must assume a client role asai rcv will never return an inappropriate message for the current role s Return Value Errors See Also Upon successful completion the function returns the size of the message If an error occurs the function returns 1 A return code of 0 does not indicate an error the received message was intended for the library and no program data is available at this time The type of error is ind
216. info Description Obtains the current value of the specified field from the capability information structure if that value is of type long The cap_info argument can either be the address of the start of the table or the address of the proper entry itself Return Value Returns the long value requested or exits with a status of 19 if the value stored in the table is not a long This indicates that the capability information structure was incorrectly set up Issue 1 October 1996 10 21 Testing get_string 3 Name get_string Synopsis char get_string fieldname cap_info char fieldname struct cap_info cap_info Description Obtains the current value of the specified field from the capability information structure if that value is a string The cap_info argument can either be the address of the start of the table or the address of the proper entry itself Return Value Returns the pointer to the string requested or exits the program with a status of 20 if the value stored in the table isn t a string This indicates that the capability information structure was incorrectly set up 10 22 Issue 1 October 1996 open_dialog_out 3 open dialog out 3 Name open dialog out Synopsis open dialog out filename char filename Description Opens the file whose name is pointed to by its argument If unsuccessful it causes the program to exit with a value of 15 It stores the FILE pointer in a static variable a
217. ing This chapter presents a variety of issues or problems that you may encounter during installation administration maintenance or application programming phases of ASAI application development using the CallVisor ASAI product PC ISDN Platform Installation and Reference is the document accompanying the ISDN personal computer interface the BRI interface board IPCI board Some of the sections are very DOS oriented However the document is helpful for specific installation instructions such as a How to install multiple IPCI cards a PCl card ECS settings for addresses in PC memory space that may be used for the card m Modifications that are required for the installation of additional RAM on the IPCI card Issue 1 October 1996 11 1 Troubleshooting ECS Administration When administering the DEFINITY ECS BRI line to be used for ASAI connectivity between ECS and the adjunct computer enter the command add station ext_num where ext_num is the extension number associated with the ASAI link Then enter the precise values listed in Chapter 1 Installation of this document Other release 5 administration commands that may be useful include list station To find an extension number that has been administered as type ASAI For example the extension number of the ASAI link may be needed for a route to adjunct step in a vector change vector vect num To administer vector steps for routing applicati
218. ing Manual Pages Issue 1 October 1996 asai_open asai_open The asai_open function is the first of the library functions that your program calls This function opens a communication path stream and returns file descriptor fd if the call is successful the function returns 1 if the call fails asai open requires two arguments pathname and ndelay flag pathname is dev asai asai The ndelay flag determines whether you will be operating in synchronous mode with blocking and no delay or asynchronous mode with delay and no blocking For synchronous mode set ndelay flag to 0 For asynchronous mode set ndelay_flag to O NDELAY Code Example 4 1 below is a typical open routine E open routine int id if fd asai_open pathname 0 lt 0 asai_errval error message exit asai_errno A Figure 4 1 Opening a Communication Path Note that the routine above calls asai_errval if the value returned is fewer than 0 See the sample code called asai_open on line 52 in Figure 4 9 later in this chapter Issue 1 October 1996 4 3 ASAI Library Functions asai errval When an error occurs an error value is made available in the variable asai errno Of data type long Once asai_errno is set its value is not reset by successful function calls If an error is returned by an ASAI library function there is state transition either for the communication path or for t
219. ing specifying the redirection number if Scf statusisC SCF ON redir typeisanoptionadlplan type t structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL plan type t has two fields addr type and numb plan addr type can have two possible values unknown 0 and international 1 Currently numb plan can have only one value unknown 0 However additional values for both fields may be coded in the future C STATION vqc station t ext status can be C_ON_CALL or C_IDLE pool is acharacter array that provides buffer space for the ASAI library to store program specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information cause_value This parameter can be any of the following C_FACUNSUB C_INVLDIE C_INVLDNUM C_MAND_INFO C_NOLOGIN C_NOSPLIT_MEM ROTERR UNAVL _ UNIMP V_UNAVIL wn td td Ed U See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Return Value When this capability is used in an asai_rcv the function returns the size of the message upon success and 1 on failure A return value of 0 does not indicate an error but that no data has been received 9 158 Issue 1 October 1996 C_VQ_CONF 3ASAI Errors See Chapter 7 Error Messages for a list of error message
220. ing the association identifier that remains active Negative acknowledgement means that the request parameters were invalid or that the server cannot merge the two calls In this case the client can continue to control both calls Request Confirmation Parameters Notes Call Identifier 1 One of the calls to be merged m Call Identifier 2 The other call This identifier is inferred from the association identifier for the call Common Party Identifier The party common to both calls Conference Flag The flag that indicates whether the common party is to be retained on the merged call or disconnected Party List Pointer to a structure that indicates ECS assigned party identifiers after two calls are merged a Old Party Identifier Pointer to a structure that indicates the old party identifiers before the call is merged ECS chooses which call is to be Call Identifier 1 and which is to be Call Identifier 2 Consult your DEFINITY ECS system administrator for specific information Issue 1 October 1996 5 25 ASAI Capabilities Interactions with Event Reports This capability can be issued after the common party is in the held state on the call for which the capability is requested and in the active state on the second call After this capability is successfully acknowledged the common party moves to the active state or to the null state depending on the conference flag All other parties to the
221. installation or the packages are being uninstalled and or reinstalled to change the number of links the current configuration parameters should be written down or printed out for future reference These parameters can be found in the files usr adm isdn ipci_parms usr adm asai asai parms and usr adm isdn lan_parms Enter the following commands cat usr adm isdn ipci parms and cat usr adm asai asai parms and cat usr adm isdn lan parms to see the parameters ZD NOTE Before beginning the installer must make sure that the Network Support Utilities package has been installed 1 If no ISDN links are going to be installed skip to Step 3 Decide on the interrupt level IRQ number to be used The IRQ number is the same as the Interrupt Vector Number IVN referred to when installing the CallVisor PC ISDN software Available IRQs are 2 or 3 The CallVisor PC ISDN software package will ask which package is to be used IRQ 2 is preferred because asynchronous communications port COM2 uses IRQ 3 If IRQ 2 is unavailable IRQ 3 has to be used If IRQ 3 must be used the installer must first find out how to disable COM for his or her particular computer before going to the next step 2 Decide on the shared memory addresses SCMA that the IPCI boards will use The default PC memory space address for one IPCI board is d0000 Use this default address as long as it does not conflict with any other hardware See Task 1 in Chapter 3 Configure
222. itiating capability ECS will return an error if C 3PAD is used as an initiating capability asai common Within this structure the programmer sets capability to C 3PAD and primitive type to C REQUEST The programmer also sets sao id also known as cluster id to identify the domain control association called num This parameter is a pointer to a null terminated string that specifies the called number uudata The purpose of the user user information is to convey information between ISDN users This information is not interpreted by ECS but rather is carried transparently and delivered to the remote user If the info field is IA5 characters ASCII the string is null terminated 9 22 Issue 1 October 1996 C_3PAD 3ASAI The leng field is an integer value that indicates the number of octets of user data included in the request This field is set to 0 if no user_user data is present Currently ECS will accept up to 32 bytes of data leng 32 If more than 32 bytes is specified an error will be returned ASAI supports a maximum user_user data length of 32 bytes although user_user data generated froma PRI trunk can be up to 127 bytes in length DEFINITY ECS will truncate this to 32 bytes before forwarding it to ASAI link The protocol field indicates the type of information and is restricted to C UU USER that indicates a user specific protocol or C_UU_IA5 which indicates IA5 or ASCII characters The inf
223. its associated structure party id t party id t contains the parameter id ptr that points to a character array specifying ECS assigned party identifier values The length of each party identifier is given by id_length When no party identifiers are returned for this capability party list is a null pointer num party is the number of structures specified in the list pointed to by part y_list When no party identifiers are returned for this capability num_party assumes the value of C_NUSE_LONG pool is acharacter array that provides buffer space for the ASAI library to store program specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information C_EXT_STAT vqc_ext_stat domain_type canbe C_ACD_SPLIT C_VDN C_ANNOUNCE C_DATA C VOICE C ASAI LINK or if no value is returned for this capability C NUSE LONG station type canbe C_ANALOG C BRI C PROPRIETARY C NONE BEAR or C NUSE LONG C MWI STA vqc mwi stat mwi status canbe C MWI ONoOr C MWI OFF C SAC STA vqc sac stat Sac status canbeC SAC ONor C SAC OFF Issue 1 October 1996 9 157 Programming Manual Pages Table 9 4 Associated Items and Descriptions for C_VQ_CONF Continued Item Type vqc buf Member Item and Description C SCF STAT vqc sef stat Scf status canbe C_SCF_ONor C SCF OFF redirection is a pointer to a null terminated str
224. ity can be issued only by a client Issue 1 October 1996 9 59 Programming Manual Pages See Also asai send C EN REP C 3PMC REQ C 3PMC CONF C 3PTC REO C 3PTC CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3PRC CONF 9 60 Issue 1 October 1996 C 3PRC CONF 3ASAI C 3PRC CONF 3ASAI Name C 3PRC CONF Acknowledge a third party relinquish control request Type Terminating Unacknowledged when used as a positive acknowledgement Continuing Unacknowledged when used as a negative acknowledgement Usage typedef struct asai common t asai common long cause value a3pro nak t typedef union asai_common_t asai common a3prc nak t a3prc nak ja3pro rsp t Description The client receives this capability as a positive or negative acknowledgement of a C 3PRC request specified by a3prc rsp t asai common Within asai common capability is returned as C 3PRC CONF and primitive type is returned as C POS ACK for positive acknowledgment and as C NEG ACK for negative acknowledgment The sao id also known as cluster id specified in the c 3PRC request is also returned cause value cause value can be any of the following values C FACUNSUB INVLDIE MAND INFO PROTERR RESUNAVL S S ER UNIMP ERV UNAVIL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Issue
225. ity is used in an asai send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent 9 90 Issue 1 October 1996 C_3PTC_REQ 3ASAI Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai send C EN REP C 3PMC REQ C 3PMC CONF C 3PTC CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF Issue 1 October 1996 9 91 Programming Manual Pages C ABORT 3ASAI Name C ABORT Abort an association Type Terminating Unacknowledged Usage typedef struct asai common t asai common long abort type long cause value jabort info t Description Thec lient sends this capability to request a user program initiated abort or receives this capability as a provider library initiated abort request When the client client sends an abort U_ABORT the cause is passed end to end When the receives an abort P ABORT the cause is local to the library A structure of type abort info t contains the parameters needed to fulfill the request asai common Within this structure the programmer sets the capability to C ABORT and the primitive type to C REQUEST to send a user abort request When the abort is a provider abort
226. ject to change old party id typedef struct char id ptr long which call long id length long reserved old party id t Within o1d party id t id ptr is a pointer to an array of binary bytes of length id length that indicates ECS assigned party identifier before two calls are merged See party id for more information The parameter which call can assume the values of C RESULTING CALL Or C OTHER CALL and indicates whether the old party belongs to the resulting call or to other calls Note that in the structure of type party id t id ptris nota null terminated character string 8 6 Issue 1 October 1996 Identifiers trunk_id typedef struct char gid ptr char E DELS long gid length long id length long direct long reserved trunk id t Within trunk id t gid ptr is a pointer to an array of binary bytes indicating ECS assigned trunk group identifier of length gid length id ptr is a pointer to an array of binary bytes indicating ECS assigned identifier in the group identified by aid ptr The length of this identifier is id length The optional parameter direct can assume the values of C NODIRET C INCTRK or C OUTTRR the direction in which the trunk was used no direction incoming or outgoing If this parameter is not specified it assumes the value C NUSE LONG plan type typedef struct short addr type short numb plan plan type t Within plan type t the parameter addr
227. knowledged capability and as soon as a Route End is issued or received the routing association terminates The client invokes this capability by issuing a C_RT_END to terminate the routing ASE Issuing this capability allows the server to infer that the route it provided in the Route Select was used Notes There are no restrictions on this capability Issue 1 October 1996 5 47 ASAI Capabilities Maintenance Capabilities Maintenance allows a client to reguest the Heartbeat capability The Abort capability described later in this chapter is also part of this capability group Both ECS and the adjunct can issue a Heartbeat reguest 5 48 Issue 1 October 1996 Heartbeat Heartbeat Description The Heartbeat capability allows the client to guery the server for the status of the ASAI link Heartbeat is a two way capability either ECS or host computer can be the client and can send a heartbeat reguest A positive response from the server means that the link is operating that messages are received and parsed and that incoming ASAI messages will be delivered to the appropriate ASAI server A positive response further guarantees that if a client makes a reguest when the link is operational but the necessary server is not then an appropriate negative response will be returned No response means that the link or the server is not operating A negative response with a cause of response not available means that the
228. knowledgment The sao id also known as cluster id specified in the C 3PTC request is also returned party ext list num party ext This parameter points to a list of structures During a positive acknowledgment a structure of type a3ptc ack t contains information concerning the existing parties to the call The number of structures in the list is given by num party ext Within party ext list party id specifies a party to the call The extension parameter is a pointer to a null terminated string that indicates the extension of the party See the Identifiers section in Chapter 8 ASAI Capability Primitives for a description of party id 9 88 Issue 1 October 1996 C_3PTC_CONF 3ASAI pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool lin Chapter 8 ASAI Capability Primitives for more information cause_value This parameter can be any of the following C_CALLID_TERM C_FACUNSUB INVLDIE MAND INFO ROTERR ESUNAVL ER UNIMP ERV UNAVIL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Return Value When this capability is used in an asai rcv the function returns the size of the message when successful and 1 on failure A return value of 0 does not indicate an error but that no data has been received Errors See Ch
229. l confirmation Once positive acknowledgement has been received by the client the association identifier used by the C_3PTC_REQ is terminated If the server sends a negative acknowledgement the association identifier used by the C 3PTC REQ is still active Notes A client can issue this capability at any time regardless of any pending or outstanding acknowledgements for any previously requested capability Interactions with Event Reports This capability does not affect the state s of the parties to the call Issue 1 October 1996 5 29 ASAI Capabilities Third Party Selective Drop Description The Third Party Selective Drop capability allows a client to reguest the server to disconnect a specified party The client continues to receive feedback regarding the call and may continue to control the call with further Third Party capabilities The server sends a C_3PSD_POS_ACK when it has disconnected the party The client must use feedback to determine the state of the call with respect to each endpoint The server sends a C_3PSD_NEG_ACK if the parameters of the request are invalid or if it cannot disconnect the party Request Confirmation Parameters Notes 5 30 Depending on conditions the request must specify the following parameters Party Identifier The party on the call to be disconnected This parameter must be specified if the association is started with a Third Party Make Call capability i
230. l create an odd sao id Consequently CV PC developers especially those who planned to register as routing and heartbeat servers should use even numbers for sao id Continuing This type of capability assumes that the association already exists and continues to exist after the capability is sent or received An existing sao id must be supplied If a new sao idis supplied an error will be returned Terminating This type of capability assumes that the association already exists However the association will be terminated after this capability is processed It is worth noting that this processing does not happen instantaneously and that the application may have to deal with messages for this association that were queued earlier and have been read after the terminating capability was sent In addition this section also classifies each capability as Acknowledged or Unacknowledged No additional requests can be made until the outstanding acknowledgement is received If a capability is used in an association state for which it has not been defined the use of the capability is considered a protocol violation A protocol violation in the case of an acknowledged capability results in a negative acknowledgment A protocol violation in the case of an unacknowledged capability aborts the association 9 20 Issue 1 October 1996 ASAI Capability Manual pages Usage This section shows the associated data structures used with the capabili
231. l or C UU 1A5 which indicates IA5 or ASCII characters The info field is a pointer to an ASCII string of no more that 32 characters in length resource The resource field specifies the resource to be dropped from the call The available resources are C CALL CLASSIFIER and C TONE GENERATOR The tone generator is defined in this case as being any locally applied denial tone that is timed by ECS The resource field may be included in the C 3PSD capability when the association is initiated by the either C 3PMC REQ or C 3PTC REQ capability and when the party idis not included pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool fin Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent 9 68 Issue 1 October 1996 C 3PSD 3ASAI Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by a client See Also asai send C EN REP C 3PMC REQ C 3PMC CONF C 3PTC REO C 3PTC CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD CONF
232. l request terminates the call and sends the Third Party Call Ended capability to inform the client If the Direct Agent parameter is selected the Type of Facility must be set to ACD and the Facility Access Code must be supplied Issue 1 October 1996 5 23 ASAI Capabilities Interactions with Event Reports Without the Alert Originator First option this capability places the originating party in the active state 5 24 Issue 1 October 1996 Third Party Merge Third Party Merge Description The Third Party Merge capability allows a client to reguest the server to merge two existing client controlled calls that have a common party The capability also allows the server to confirm the reguest The effect of the merge is similar to a conference or transfer operation depending on the value of the conference flag If the conference flag is on the common party remains connected to the call along with all the other parties as in conferencing If the conference flag is off the common party is dropped from the merged call as in transferring The client invokes this capability by issuing a C_3PM reguest to which the server responds with a C_3PM_CONF The server sends positive acknowledgement when it has validated the parameters and merged the calls After the acknowledgement the client receives a Third Party Call Ended c_3PCE and continues to receive event reports for the merged call The client can control the merged call us
233. l returns 0 on success and 1 on failure The sample code at the end of this chapter uses a conditional callto asai errval after every function call lines 54 59 69 77 105 149 and 154 If the previous function call fails asai_errval is called Issue 1 October 1996 4 5 ASAI Library Functions asai_set_env After opening a communication path the next step is to establish an environment that will support your program The asai_set_env function enables you to set one characteristic at a time You must set the node identifier first using the C_NODE_ID characteristic asai set env has two mandatory and one optional arguments The file descriptor and the characteristic to be set are mandatory Depending on the characteristic you are setting you also may have to specify a value The characteristic C NODE ID establishes the name of the node from which your application will initiate service request This must be done first If an application needs services from more than one node it must open the library once for each node it needs services from This means that multiple file descriptors must be managed You must use the characteristic C SERVER to specify the name s of the node s for which your application will provide services for example it will respond to ECS initiated requests If your application is a client only you do not need to do this Note that each node will allow only one server for eac
234. lation However if the adjunct processor has a limited amount of memory or if a running ASAI application is controlling a large number of stations or calls NCLID may need to be changed In any case NCLID should be set to conform to your system s specific operational needs For more details see section later in this chapter You can install the CallVisor PC ITT package at any time Enter the command pkgadd d diskette1 Place the CallVisor PC ITT product disk in the appropriate drive and follow the online instructions Pkgadd displays that the CallVisor PC ITT package is available to process Press to continue installation After the installation procedure is complete remove the diskette from the disk drive The message Installation of lt cvitt gt was successful is displayed Issue 1 October 1996 1 9 Installation CVLAN Product Description CallVisor CVLAN is a product that allows application software running on UnixWare Solaris x86 Sparc Solaris or Windows NT 3 51 to access DEFINITY ECS PBX CallVisor ASAI features across a TCP IP LAN in a client server arrangement It accesses the CVLAN server platform using standard TCP IP LAN connections The server is directly connected to the DEFINITY PBX and transfers ASAI messages between the PBX and the clients on the LAN CVLAN server is built on top of the CallVisor stack and communicates with the CVLAN client over TCP IP using Remote Procedure Calls RPC The CVLAN
235. lid d caps rsp asai_common capability typs rsp asai common primitive type rsp asai common sao id if rsp asai common capability C ABORT printf tabort type s cause s rsp abort_info abort_type C_PROV_ABT C PROV ABT C USER ABT causes rsp abort info cause value else if rsp asai_common capability C_EN_CAN_CONF amp amp rsp asai_common primitive_type C_NEG_ACK printf Ntcause s causes rsp enc_rsp enc_nak cause_value printf Ant exit 0 D Figure 4 9 Sample Code Testing the Event Notification Capabilities Continued Issue 1 October 1996 4 19 ASAI Library Functions 4 20 Issue 1 October 1996 ASAI Capabilities This chapter contains all the ASAI application service elements and provides the details of all the capabilities that comprise each ASE These application service elements are vent Notification and Event Reports hird Party Call Control Capabilities as m m Set Value m Value Quer equest Feature m Adjunct Routing m Maintenance LI m Abort Capabilities Issue 1 October 1996 5 1 ASAI Capabilities Event Notification 5 2 The Event Notification capability group provides capabilities for a client to obtain information related to specific events that are monitored by the server For example an application can monitor the progress of calls arriving at an ACD split Based on the event information received
236. lies to one of the following m A party on a call a Multiple parties on a call m Acallindependent of parties m A particular ECS entity ACD agents independent of any call The list below shows which events can apply to each of the groups shown Party Multi Parties Call Sw Entity Alerting Call conf d Call ended Logout Answered Call transf d Call offered Login Busy to domain Connected Queued Cut through Drop Hold Reconnected Trunk Seized Reorder Denial Call initiated Call redirected Call Originated Events are related to states more specifically to state transitions A state is associated with each call and with each party to that call A party to several calls can be in different states on each call and different parties to the same call can be in different states The states are m null m Seized m alerting m active m held Event reports are issued for state transitions that is when a party or a call for which reports have been requested moves from one state to another Issue 1 October 1996 5 7 ASAI Capabilities Table 5 1 Valid Event Item Combinations Event Items Reported Calling Called Connected Call New Party Party Id Party No Party No Party No Id Call Id Id List Alerting I I l Answered l l Busy Unavailable l Connected l gt gt Cut Through Progress Disconnect Drop Hold I Reconnected I Pl rl ry rl rl rly gt gt gt g
237. ll extension information time of day ACD agent status station status third party call audit agent login audit message waiting indication send all calls and station call forwarding For third party call audits and agent login audits data comes in a variable number ofc vo RESP messages and this message is used to indicate the end of the list messages The following table shows the item type associated vqc_buf member and a description of the information contained in the member Mandatory information is indicated with an asterisk Optional items show a value for C NUSE LONG 9 154 Issue 1 October 1996 C VQ CONF 3ASAI Table 9 4 Associated Items and Descriptions for C VO CONF Item Type vqc buf Member Item and Description C ACDSPT STAT vqc split num login is an integer value indicating the number of agents logged in C NUSE LONG if not provided num avail isan integer value indicating the number of agents available num callinqueisan integer value indicating the number of calls in the queue C NUSE LONG if not provided C CLASS STAT vqc cc stat num availisan integer value indicating the number of idle call classifiers num inuse is an integer indicating the number of call classifiers in use C NUSE LONG if not provided C TG STAT vqc tg stat num availis an integer value indicating the number of available trunks in the group num_inuse
238. lling num and called num id ptr is nota null terminated character string Rather it is an array of bytes containing binary values The parameter id length indicates the number of binary bytes contained in the call identifier Issue 1 October 1996 8 5 ASAI Capability Primitives party_id gt NOTE call idis not an ASCII null terminated string but rather an array of binary bytes of the specified length The length is subject to change typedef struct char id_ptr long id_length long reserved party id t Within party id t the parameter id length indicates the number of bytes contained in the party identifier and id ptr is the value of a pointer to the array of binary bytes identifying the party The legal value for id_length is 1 if its value is 0 the value of id ptr is undefined If an illegal value other than 0 is encountered asai send will reject the message with an error code of C BADPMATCH The legal value of id length may change in future releases of ECS Defensive programming practices are recommended Note that unlike null terminated character strings such as calling num and called num id ptr is nota null terminated character string Rather it is an array of binary bytes The parameter id length indicates the number of bytes contained in the call identifier gt NOTE party idis not an ASCII null terminated string but rather an array of binary bytes of the specified length The length is sub
239. llowing append dialog and close dialog out to access the file directly Return Value Returns the defined value of SUCCESS Issue 1 October 1996 10 23 Testing parse 3 Name parse Synopsis int parse prim nid clid long prim char kalaj long celid char batch ans int ans len char ans filename Description batch ans ans len ans filename Parses the remainder of a script file command line and returns the operation mode of the function based on the information on the command line It stores the various information elements in the variables and arrays whose addresses are supplied to the function The meanings of its arguments are defined in the following table Table 10 1 Argument Types and Descriptions ARGUMENT TYPE MEANING prim long address of long where primitive type is stored nid char address of char array where node id is copied clid long address of long where clid is stored batch ans char address of table of pointers to character strings where batch answers will be stored ans len int length of previous table ans filename char address of char array where batch answers may be written if we are in INTERACTIVE mode 10 24 Issue 1 October 1996 parse 3 Return Value Returns the operation mode of the capability specific function based on how much information was given on the command line The return values are defined as follows Table 10 2 Return Value D
240. long prio call long alert time long serv cir long dir agtcall long super ast long alt dest long ack flag long ans mach treat char pool C DATSZ a3pmo info t Description The client sends this capability to request establishment of a third party call A structure of type a3pmc info t contains the third party call setup parameters asai common Within this structure the programmer sets capability to C 3PMC REQ and primitive type to C REQUEST The programmer also sets the controlling association to sao id also known as cluster id calling num The calling num a mandatory parameter is a pointer to a null terminated character string that specifies the calling extension Issue 1 October 1996 9 51 Programming Manual Pages called_num The mandatory called_num parameter is a pointer to a null terminated character string that specifies the called extension uudata The purpose of the user_user information is to convey information between ISDN users This information is not interpreted by ECS but rather is carried transparently and delivered to the remote user If the info field is IA5 characters ASCII the string is null terminated The leng field is an integer value that indicates the number of octets of user data included in the request This field is set to 0 if no user user data is present Currently ECS will accept up to 32 bytes of data leng 32 If more than 32 bytes is specified
241. m failure 3 Failure to send message s to board 4 Failure to receive message s from board 5 Time out while waiting to receive a message Issue 1 October 1996 2 43 Administration isdn Name 4 Name isdn Name Name file for UNIX ISDN Description This file contains the name of the ISDN software package The content of the file is Lucent Technologies CallVisor ISDN Files usr adm isdn isdn Name 2 44 Issue 1 October 1996 isdn_trace 1 isdn_trace 1 Name isdn_trace Trace IPCI device driver messages Synopsis isdn_trace Description isdn_trace writes the kernel protocol stack messages to stdout This is a general purpose diagnostic tool Only one of its outputs is the actual message traffic to and from the PC ISDN board The message trace has the following general format lt time stamp gt lt driver gt lt function gt lt slash gt lt sbn gt lt diagnostic gt lt link gt lt hexs gt The following table explains the format Table 2 2 Format of isdn trace Generated IPCI Device Driver Messages Mnemonic Description Example lt time stamp gt message time stamp number 15273 lt driver gt name of module generating the entry IPCI QP Klog function name of function handling the rcv cc message gviSendSignal slash lt sbn gt starting byte number 0 12 lt diagnostic gt message traffic has the value MSG_TRACE MSG_TRACE in this field Only message traff
242. m name ipci on m Error Messages If an error is encountered a message is written to stderr and a copy of the same message is written to the log usr adm asai asai log 4 file m Status Messages Two status messages are written to the asai_log file One message indicates the beginning of the pumping The other message indicates the ending of the pumping Exit Codes For success 0 is returned If an error is detected 1 is returned 2 34 Issue 1 October 1996 ipci_on 1 Notes This program is executed at boot time for all IPCI boards It can be executed any other time for a board s that has successfully been placed offline ipci_off should be used to take the board offline Files usr adm asai asai_log usr adm isdn boot bin usr adm isdn pcisdn bin dev isdn ipci command See Also boot bin 4 ipci 4 pcisdn bin 4 Issue 1 October 1996 2 35 Administration ipci_stat 1 Name ipci_stat Print Status of IPCI Board s Synopsis ipci_stat n Description If n is specified a status report is printed for only that board Otherwise a status report is given for all boards The report is printed to stdout For each board four items are printed line_control Normally the adjunct computer UNIX ASAI adjunct should be in control of the interface between the ISDN phone and ECS When this is the case pc is printed If the adjunct software is not in control of this interface phone is printed Line control is
243. mark of Lucent Technologies in the USA and throughout the world Solaris is a trademark of Sun Microsystems Inc in the USA and other countries UNIX is a registered trademark in the USA and other countries licensed exclusively through X Open Company Limited UnixWare is a registered trademark of the Santa Cruz Operation Inc in the USA and other countries Windows is a registered trademark of Microsoft Corporation Windows NT is a trademark of Microsoft Corporation Ordering Information The ordering number for this document is 555 230 227 To order this document call the BCS Publications Center at 1 800 457 1235 international callers use 1 317 361 5353 For more information about Lucent Technologies documents refer to Business Communications Systems Publications Catalog 555 000 010 You can be placed on a Standing Order list for this and other BCS documents you may need Standing Order will enable you to automatically receive updated versions of individual documents or document sets billed to account information that you provide For more information on Standing Orders or to be put on a list to receive future issues of this document please contact the Lucent Technologies BCS Center Lucent Technologies Fraud Intervention If you suspect you are being victimized by toll fraud and you need technical support or assistance call the BCS Technical Service Center Toll Fraud Intervention Hotline at 1 800 643 2353 Comments To comme
244. ment relates to a specific implementation of ASAI the interface between an adjunct and DEFINITY ECS Emphasis is on the interface itself rather than on the adjunct or DEFINITY ECS Specific information concerning these products is readily available in other documents See the section Related Documents Jat the end of this preface DEFINITY ECS utilizes the following products made by other computer manufacturers Solaris of Sun Microsystems Inc a UNIX is licensed exclusively through X Open Company Limited UnixWare of the Santa Cruz Operation Inc Windows of Microsoft Corporation Windows NT of Microsoft Corporation Issue 1 October 1996 xi About This Document Intended Audience xii This document is intended for system administrators programmers and testers It provides step by step procedures for installation and administration of CallVisor PC This document also describes the interaction between the UNIX ASAI adjunct and DEFINITY ECS It is intended to assist applications programmers in developing applications for the adjunct It includes complete information on all the ASAI library functions capabilities and capability primitives Integration Test Tool ITT is designed to help in testing the library functions A number of issues and problems that may be encountered during various phases from installation to regular administration are also addressed It is assumed that the readers are familiar
245. mpt to log ASAI cause values Issue 1 October 1996 2 13 Administration asai_hb 1 Name asai_hb Acknowledges heartbeats for a Node Synopsis asai_hb v 1 8 n Description When asai_hb is activated for an ASAI Node it registers itself as a maintenance server for that Node and calls the library function asai rcv If the message received is an ASAI heartbeat an ASAI heartbeat acknowledgment is sent If an ASAI heartbeat is not received from ECS within two minutes asai_hb sends a heartbeat request to ECS If ECS does not confirm the request and the n option has not been specified the specified Node is brought down using ipci off PUN Causes asai hb responses to be printed on the user s terminal stdout Causes command line usage information to be printed on the user s terminal 1 8 1 8 is the Node number that corresponds to the board for which heartbeats will be acknowledged Node number information can be found in the files usr adm asai asai parms and usr adm isdn lan parms The contents of asai parms for one installed IPCI board are Node ID for ASAI Node 1 signalO01 IL Disables the shutdown ipci off ofthe link This option should be used for all LAN type links It must be the last option specified on the command line Enter the command asai hb 1 and the process checks for and acknowledges heartbeats immediately for Node number 1 2 14 Issue 1 October 1996 asai_hb 1 Files usr bin asai_hb
246. ms ASE instance and Single Application Object SAO are synonymous with association An active association is one that applies to an existing call on ECS or to an extension on the call Associations can affect a call or a party to a call or both A call usually has two or more parties that can be identified by their extensions as well as by party id An extension can be three four or five numbers that internally identify a station or voice data terminal Extension can also mean a 10 digit number that includes area code and a full 7 digit telephone number Issue 1 October 1996 The ASAI Library Functions The ASAI Library Functions The functions provided by the ASAI library are asai_open asai_close asai set env asai get env asai send asai rcv asai_errval These functions afford access to the services defined by the full set of ASAI capabilities The basic purpose of the functions is twofold to manage the communication path over which ASAI capabilities are requested and acknowledged and to manage the exchange of information over an established communication path Issue 1 October 1996 3 5 Introduction to ASAI 3 6 Table 3 1 gives a brief description of the ASAI library functions that manage the communication path Table 3 1 ASAI Library Functions for Managing the Communication Path Function Description asai open Opens a communication path to the capability provider usi
247. mum number of associations per link will be lower than normal This will also affect the actual maximum number of associations that can be realized Set NCLID using the idtune 1M command Follow the procedures outlined in UNIX System V 386 Release 4 System Administrator s Guide for rebuilding the kernel Any NCLID between 64 and 9600 will work provided that sufficient adjunct memory is available Setting the NCLID to a value outside this range is not supported Issue 1 October 1996 1 23 Installation Starting Up the System System startup for CallVisor PC ASAI is automatic When you boot the adjunct the asai_admin daemon is started asai_admin completes the protocol stack and begins the process of message writing to the asai_log If there is an existing log it is moved to old_asai_log The asai_log contains messages about the startup process The sample below shows typical log entries for a successful startup 910318165042 asai_admin ASAI administration daemon has started 910318165042 asai_admin Push of FEL onto dev isdn ipci signal01 succeeded 910318165042 asai admin Link of dev asai asai file with dev isdn ipci signal 910318165042 asai admin 101 succeeded 910318165042 asai admin ASAI stack setup was successful Matching Versions Requirement for the ISDN protocol stack specifically the QP module must be done correctly or the ASAI link will not come up Three new tunable parameters are provided to allow selecting the
248. n depending on the value of ofacility priority call Setting this parameter to C PRIOR ON indicates that the call should be tagged as a priority call otherwise the parameter should be set to C PRIOR OFF Issue 1 October 1996 9 143 Programming Manual Pages dir_agtcall Setting this parameter to C_DIRAGT_ON indicates that the call should be tagged as a direct agent call otherwise the parameter should be set to C_DIRAGT_OFF user data user data provides the user information that will be sent to ECS type indicates the type of user code entered The t ype field is restricted to the values C TONE DETECTOR and C_ADJUNCT_DIGITS lf C ADJUNCT DIGITS is specified the time out field is forced to zero 0 and the collect field is forced to C COLLECTED If C TONE DETECTOR is specified the collect field is forced to C COLLECT The timeout parameter specifies the digit collection time out and is an integer value from 0 to 63 default is 0 The value of digits depends on the flag specified by the collect field If the collect field has the value C COLLECTED digits is a pointer to an ASCII string If the collect field has the value C COLLECT digits is a single one byte character containing a binary integer indicating the maximum number of digits to be collected default is 0 party id party idis optional party id specifies the party generating the alerting eve
249. n a synchronous mode of operation asai_send blocks until an entire message has been queued for transmission or an error occurs If the function is used in an asynchronous mode of operation asai send does not block The library can assume the role of server only for the route and maintenance heartbeat services For all other services it must assume a client role Any attempt to send a message in an inappropriate role will be rejected Notice that an application can be simultaneously both a client and a server Issue 1 October 1996 9 15 Programming Manual Pages See the asai_set_env section in Chapter 4 ASAI Library Functions for further information Return Value Upon successful completion the function returns a nonnegative value If an error occurs the function returns 1 Errors The type of error is indicated by the error value set in asai_errno C_BA C_BA C_CL C_BA C_BA DFD Invalid file descriptor supplied DF LOW Cannot issue the request because of flow control USTID The cluster identifier is invalid for the given stream DLNG The send or receive buffer is too small for the capability DMSG A corrupt message was received on the given stream C INTR A system call was interrupted by a signal C OS ER A system call failed C UNCAP Cannot send an unknown capability C TOOBIG The field is too big See Also asai open asai rcv a
250. n element IE that includes the coding standard and the cause value The cause value is actually the combination of two fields a class and a value within the class The DEFINITY ECS value and the ASAI library interpretation of the cause value is also included The set of PIDs process identification being monitored by asai cause can be changed by reinvoking the command with a new set of PIDs However other parameters cannot be changed in this way The second invocation of asai cause simply changes the PIDs and then exits it does not start a new logging process Issue 1 October 1996 2 11 Administration Example DATE 08 27 92 08 27 92 08 28 92 08 28 92 The set of input options includes h Causes SIGHUP to be ignored Default is to exit asai_cause on SIGHUP hangup N Causes the one byte hexadecimal operation value from the Facility Information Element FIE to reference the ASAI capability rather than include the capability name itself t log time Specifies a decimal digit string indicating the maximum number of seconds that asai cause Will run Default is t Ox ffffff which is 2 32 1 seconds me Causes a command usage line to be returned process ids Specifies a list of process ids decimal digit strings separated by blanks for which cause value logging is to be performed An empty list turns off cause value logging but leaves the asai_cause process running An easier way of terminating caus
251. nctions The ASAI library functions provide the application program with an easy method of sending and receiving information in the form of ASAI capabilities to and from ECS Before you can send or receive information however you must establish a communication path This is a two step procedure requiring you to first open a path using asai open and then to identify ECS with which your program will communicate ECS is identified by a node identifier set with asai set env asai set env identifies applications as being either clients or servers A client application initiates a request for service and a server application responds to a request for service The ASAI library does not allow an application to assume an inappropriate role For those capabilities for which it is registered as a client an application can only send messages defined for clients It cannot send server type messages Conversely when an application is registered as a server it can only send messages defined for servers It cannot send client type messages This chapter describes each function briefly and shows how it works The final section of this chapter is a sample program The functions are presented in logical rather than alphabetical order thus asai open comes first and asai close comes last as indicated in Table 4 1 Issue 1 October 1996 4 1 ASAI Library Functions 4 2 Table 4 1 ASAI Library Functions A Typical Application
252. nd Solaris x86 version 2 4 Issue 1 October 1996 1 11 Installation System Configuration Each client communicates with the server through any Ethernet interface card supporting Unixware Solaris x86 Sparc Solaris or Windows NT 3 51 Application software on the clients has access to the full range of ASAI features supported by the CallVisor PC ASAI interface The CVLAN server runs on Unixware and Solaris x86 operating system and requires the CallVisor PC ASAI library package The interface card between the server and DEFINITY ECS may consist of the PC ISDN BRI card or the DEFINITY ECS LAN Gateway card The server communicates with clients over the LAN through any Ethernet interface card supporting Unixware or Solaris x86 Both the client and the server hardware must be INTEL 386 486 processors but the client can also run on a Sparc Solaris platform A client can communicate with only one server at a time One server can communicate with up to four DEFINITY ECS PBXs Clients indicate which PBX they wish to access when they connect to the server Software Configuration CVLAN client side library must be installed on each client Client administration specifies a well known address to access a server In addition to UNIX the server must be running the CallVisor PC ASAI library package and CVLAN server software System Operation and Limits Client applications use CVLAN client side library to establish communication with a server
253. needed to request the send all calls feature called numis pointer to a null terminated string that specifies the extension for which send all calls is to be invoked pool is a character array that provides buffer space for the ASAI library to store program specific information Sac can t This structure contains the parameters needed to cancel the send all calls feature for a specified extension called numis a pointer to a null terminated string that specifies the extension for which the send all calls feature is to be cancelled pool is a character array that provides buffer space for the ASAI library to store program specific information Seel Poolin Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai_send C_RF_CONF Issue 1 October 1996 9 135 Programming Manual Pages C RT END 3ASAI Name C RT END Terminate a route request Type Terminating Unacknowledged Usage typedef struct asai common t asai common long cause value rte info t Description The client that is ECS sends this capability to request termination of a ro
254. ng either a blocking or nonblocking mode of operation The communication path is identified by a file descriptor asai close Terminates the communication path from the application process to the capability provider asai set env Allows the application process to set a characteristic of an opened communication path The first characteristic to be set must be the destination node for service requests Other characteristics that can be set are the type of service and node on which requests for this service are to be received called the service destination pair This tells the ASAI library to place indications of the specified ASE from the specified node on this communication path asai get env Requests information from the ASAI library concerning a characteristic of an opened communication path Characteristics that can be queried are the following Destination node to which service requests will be sent Version of the ASAI library implementation This tells the application whether the features of the current ASAI library are sufficient for the application Type of service and node that will send initiating indications This tells the application that initiating indications for the specified type of service and for the specified node will be received from ECS Issue 1 October 1996 The ASAI Library Functions The other ASAI library functions are described briefly in Tables 3 2 and 3 3 below
255. ng variable length strings such as extensions that contain too many characters The stream has active associations This error is set in asai_set_env whenever an attempt to change the Node ID cannot be performed because currently SAOs exist Issue 1 October 1996 7 3 Error Messages 7 4 Issue 1 October 1996 Err ASAI Capability Primitives The capabilities available to the ASAI library functions manage the communications process This introduction provides information common to most or all of the capabilities Beginning with G3V2 the server provides additional information for certain capabilities and messages In order to provide this information to the application new fields in certain structures have been provided and in some cases new structures have been defined These modifications have been made with the following design goals m Affect the API as little as possible a Maintain consistency m Require no extraneous information from the application a Minimize future changes A CAUTION However there are instances where it has not been possible to maintain the capability All messages from ECS that contain redirecting calling called or connected number IEs can now potentially contain new information The new information consists of the Type of Address and Numbering Plan fields for the affected IEs See Chapter 1 of the DEFINITY Enterprise Communications Server Release 5 CallVisor ASAI Protocol Refer
256. nitiated by the C_3PMC_REQ or C_3PTC_REQ capabilities and the resource identifier is not specified ZD NOTE party idis notan ASCII null terminated string but rather an array of binary bytes of the specified length See the Identifiers section in Chapter 8 ASAI Capability Primitives for more information Issue 1 October 1996 9 67 Programming Manual Pages call_id call idis ECS assigned identifier of the call to be dropped ca11_id is used only when the association is initiated by the C_3PDC_REQ capability uudata The purpose of the user user information is to convey information between ISDN users This information is not interpreted by ECS but rather is carried transparently and delivered to the remote user If the info field is IA5 characters ASCII the string is null terminated The 1eng field is an integer value that indicates the number of octets of user data included in the request This field is set to 0 if no user user data is present Currently ECS will accept up to 32 bytes of data 1eng 32 If more than 32 bytes is specified an error will be returned ASAI supports a maximum user user data length of 32 bytes although user user data generated from a PRI trunk can be up to 127 bytes in length DEFINITY ECS will truncate this to 32 bytes before forwarding it to ASAI link The protocol field indicates the type of information and is restricted to C UU USER which indicates a user specific protoco
257. node is returned C NODE ID The C NODE ID parameter requests the node identifier s for a server 9 6 Issue 1 October 1996 asai get env 3ASAI C SERVER The C SERVER parameter requests information on the number and type of servers previously set by calls to asai set env Data of structure type server type t defined below is returned If no service requests have been set then num server is returned as O typedef struct long num node service spec t buf jserver type t Within this structure num node indicates the number of structures of the type service spec t defined below that can be contained in the buffer pointed to by buf typedef struct long server type char node id C NODSIZ service spec t Upon return the ASAI library indicates the number of structures actually supplied in buf but no more than the number requested by the user Within the service spec t Structure server type indicates the service requests that will be accepted and node_id indicates the node from which the service requests are accepted Valid server types that can be put together with the option of selecting either one are C RT SER Routing C MAINT SER Maintenance Return Value Errors Upon successful completion the function returns 0 If an error occurs the function returns 1 The type of error is indicated by the error value set in asai errno C BADFD Invalid file descri
258. nowledged Usage typedef struct asai common t asai common long cause value j hb nak t typedef union asai_common_t asai common hb nak t hb nak hb rsp t Description The client that is for this request it can be ECS or the adjunct receives this capability as a positive or negative acknowledgment of a C HB REO request The union hb rsp t contains the necessary information asai common The capability is returned as C HB CONF and primitive type is returned as C POS ACK for positive acknowledgment C NEG ACK for negative acknowledgment The sao id also known as cluster id specified in the heartbeat request is also returned cause value This parameter can be any of the following C FACUNSUB INVLDIE MAND INFO PROTERR RESUNAVL S S ER UNIMP ERV UNAVIL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Issue 1 October 1996 9 127 Programming Manual Pages Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure when it is used in an asai_send the function returns a nonnegative value on success and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent or received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also
259. nswer Call Request Confirmation 3rd Party AutoDial 5 14 9 22 U 3rd Party Auto Dial Acknowledgement 3rd Party Call Control End 9 35 o o O 3rd Party Call Control capabilities group 3rdParyCallEnd 9 35 o 8rd Party Call Ended 3rd Party ClearCall 5 17 9 31 Cd 3rd Party Clear Call Acknowledgement 3rd Party Domain Control 5 18 3rd Party Domain Control End 5 19 J9 41 3rd Party Domain Control Request 9 39 SY 3rd Party Domain Control Request Confirmation 3rd Party DropCall 9 67 Cid 3rd Party Drop Call Confirmation 9 70 1 3rd Party Event Notification Request Termination 3rd Party Event Report 9 101 3rd Party Event Report Cancel Confirmation 3rd Party Event Report Confirmation 9 97 3rd Party Event Report Request specified domain 9 121 3rd Party Event Report Termination 9 99 1 3rd Party Feature Request Confirmation 3rd Party Heartbeat Confirmation 8rd Party Heartbeat Request 3rd Party Listen Disconnect 5 20 80 3rd Party Listen Disconnect Acknowledgement 3rd Party Listen Reconnect 5 21 5b 84 3rd Party Listen Reconnect Acknowledgement 3rd Party Make Call 5 22 9 51 3rd Party Make Call Confirmation 3rd Party Merge 5 25 1 3rd Party Merge Request Confirmation 3rd Party Merge Two Calls 3rd Party Reconnect 5 27 9 55 Cd 3rd Party Reconnect Request Confirmation 3rd Party Redirect Acknowledgement 3rd Party Redirect Call 5 28 9 63 SY 3rd Party Relinquish Control 5 29 9 5
260. nt gt NOTE party idis not an ASCII null terminated string but rather an array of binary bytes of the specified length See the section Identifiers in Chapter 8 ASAI Capability Primitives for further information specific event specific event is a long integer that indicates the call prompter disconnect condition and indicates either connect or drop pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See Pool in Chapter 8 ASAI Capability Primitives for more information 9 144 Issue 1 October 1996 C RT SEL 3ASAI Return Value When this capability is used in an asai_send the function returns a nonnegative value upon success and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by a server See Also asai send C RT REQ C RT END Issue 1 October 1996 9 145 Programming Manual Pages C SV CONF 3ASAI Name C SV CONF Acknowledge a set value request Type Terminating Unacknowledged Usage typedef struct asai common t asai common long cause value sv nak t typedef union asai comon t asai common sv nak t sv nak ksv rsp t Description The client receives
261. nt is the result of a redirection See Table 9 1 Redirection Reason Codes for redirection reason codes connect num is a pointer to an optional null terminated character string that indicates the alerting extension If an extension number is not supplied connect numis a null pointer con num type is an optional plan type t structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL p1an type t has two fields addr type and numb plan addr type can have two possible values unknown 0 and international 1 Currently numb plan can have only one value unknown 0 However additional values for both fields may be coded in the future party idis a mandatory structure of the type party id t and specifies the party being alerted See the Identifiers section in Chapter 8 ASAI Capability Primitives for more information calling numis a pointer to an optional null terminated character string that indicates the extension of the calling party If the extension number is not supplied calling numis a null pointer call num type is an optional plan type t structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL See con num type above for more information concerning plan type t dial numis a pointer to an optional
262. nt on this document return the comment card at the end of the document Acknowledgment This document was prepared by the BCS Product Documentation Development Group Lucent Technologies Middletown NJ 07748 9972 Contents D About This Document xi Intended Audience xii m CVLAN Product Description 1 10 DEFINITY ECS Administration 1 18 D 1 Installation 1 1 m Configuration 1 19 X 7 alarm 1 1 m command 7 2 24 m esai alarm 2 25 cmd 2 23 m esai trace 2 27 Issue 1 October 1996 iii Contents m isdn Name 4 2 44 m link change 1 2 51 m CVLAN Administration 2 58 po mm GL 3 Introduction to ASAI 3 1 Dj 4 ASAI Library Functions 4 1 iv Issue 1 October 1996 Contents SSS 5 ASAI Capabilities 5 1 a Event Notification 5 2 m Event Notification Request 5 3 m Event Notification End 5 4 m Event Notification Cancel 5 5 m Event Notification Stop Call Notification 5 6 m Event Report 5 7 1 m Value Query Capabilities 5 36 m Value Query 5 97 m Third Party Reconnect 5 27 m Third Party Redirect Call 5 28 m Third Party Listen Reconnect 5 21 Issue 1 October 1996 v Contents m Value Query Response Request Feature Capabilities m Adjunct Routing Capabilities Routing Route Select Route End Maintenance Capabilities Heartbeat Abort Capabilities 5 50 h 2 e A io um ENT m asai close 6 11 Ey 7
263. nts to a translation of the raw e data in R chars into erem locale equivalent ISO four d eaaa characters See optrex loptrex locale and ISO characterslin the Sada and Appendix A EO Characters for more information 9 140 Issue 1 October 1996 C_RT_REQ 3ASAI call_id This parameter identifies the call to be routed trk This parameter is optional It identifies the trunk number from which the call originated Note that calling_num and trk are mutually exclusive One or the other will be present but not both oli This parameter is optional It identifies the Information Indicator Il digits received in the originating line information IE for the call pool This parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Poor in Chapter 8 ASAI Capability Primitives for more information When this capability is used in an asai_rcv the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai send C RT SEL C RT END Issue 1 October 1996 9 141 Programming Manual Pages C RT SEL 3ASAI Name C RT SEL Inform a route requester of a proposed route sel
264. nual Pages Table 9 2 Event Name Members and Descriptions Continued Event Name evr_buf Member Description C_TRANSFERED tran_list bef_tranid is a mandatory structure of the type call_id_t where id_ptr points toa character array that indicates the ECS assigned identifier of the call before transfer id_length is the length of the call identifier aft tranid isa mandatory structure of the type call id t where id ptr points to a character array that indicates the ECS assigned identifier of the call after transfer 3d lengthis the length of the call identifier calling num See C_ALERTING LH See C CONNECTED called num See C CONNECTED called type SeeC CONNECTED See C CONFERENCED party list SeeC CONFERENCED poo1 See C ALERTING C OFFERED incall list call_id See C_LALERTING calling_num See C_ALERTING calling_type See C_CONNECTED called_num See C CONNECTED called_type See C_CONNECTED See C_ALERTING See C_ALERTING loli See C_LALERTING domain type can be C_TRUNK_GROUP C_ACD_SPLIT C_EXTENSION C_HUNTGRP C_VDN indicating the domain type of the party trunk group access code ACD split extension hunt group or vector directory number
265. o 1ag that is passed to the library is O NDELAY for nonblocking reads and writes Since the library is not reentrant an interrupt service routine signal catcher cannot call asai rcv if the main application has already done so It is beyond the scope of this document to discuss the requirements and techniques of nonblocking I O Since the implementation of nonblocking I O is an intricate matter it is strongly recommended that such an undertaking should not be attempted before careful planning is conducted by an experienced developer Integration Test Tool The integration test tool ITT is included only as a very basic example of an application Responding to Heartbeat It is the responsibility of an application to respond to the ASAI heartbeat messages that are periodically sent from ECS ECS sends a register message with the operation value set to heartbeat to the adjunct every two minutes The application must have previously called the function asai set env with server type Setto C MAINT SER for the application to be considered a maintenance server As a maintenance server the application must respond to every C HB REO capability it receives from ECS with a c HB CONF If the application fails to Issue 1 October 1996 11 3 Troubleshooting respond to three consecutive heartbeat reguests from ECS ECS takes down Layer 1 for five seconds and all active associations are aborted Beginning with Release 2 2 of
266. o field is a pointer to an ASCII string of no more that 32 characters in length ofacility This optional parameter identifies the type of facility requested It can be C TRUNK GROUP Or C NUSE LONG indicating a trunk group or facility not used Note that the C ACD SPLIT value is not allowed since this indicates which trunk group should be used when dialing from the controlled station ofac ext This parameter is a pointer to a null terminated string that identifies the trunk access code of the trunk group prio call This parameter is C PRIOR ON for a priority call or C PRIOR OFF fora nonpriority call ack flag This parameter allows the client to request acknowledgment of the auto dial request C ACK ON indicates that acknowledgment is expected C ACK OFF indicates that acknowledgment is not expected If the client sets ack_flag to C_ACK__OFF an INITIATE event report instead of an acknowledgment will be sent pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool lin Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_send the function returns a nonnegative value upon success and 1 on failure A return value of 0 indicates that no data has been sent Issue 1 October 1996 9 23 Programming Manual Pages Errors See Chapter 7 Error Messa
267. o restrictions on this capability Issue 1 October 1996 5 39 ASAI Capabilities Reguest Feature Capabilities The Reguest Feature capability group consists of the Reguest Feature capability and the two Abort capabilities which are common to all groups The Abort capabi lities are described later in this chapter Reguest Feature allows the client to reguest one of the following features Description Agent login Agent logout Change Agent Work Mode Call Forwarding Send All Calls The Request Feature capability allows the client to request ECS provided feature Both the feature and the operation requested invoke or cancel must be specified The client invokes this capability by issuing a C_RF_REQ to invoke or cancel an ECS p rovided feature ECS responds with a C_RF_CONF which terminates the ASE A negative acknowledgement should indicate the cause of the request failure Request Indication Parameters Feature Identifier The following features can be invoked with the indicated parameters Activate Cancel Call Forwarding Forwarding Number Forwarded to Number Forwarding Type Busy no answer No answer Unconditional ACD Agent Log In Log Out Change Work Mode Split Work Flow Agent Identifier Mode Password Activate Cancel Send All Calls Extension 5 40 Issue 1 October 1996 Reguest Feature Capabilities Notes If a reguest to activate an already activ
268. ober 1996 asai rcv CVLAN library function 6 10 libraryfunction 4 139 1 1 10 O receives primiives 3 7 script command to receive messages 10 12 asai send CVLAN library functionJ6 9 Hae Auto Dial Request Confirmation 9 25 _____ B boot bin 4 2 22 0 Bootstrap Loader Program IPCIJ2 22 ss BRI basic rateinterface 11 1 n E ERU C C EN REP eventreports sent by ECS 10 16 C EN REQ event reports for specified domain 10 11 C HB CONF heartbeat request confirmation message 10 14 C SV CONF value request confirmation message C SV REQ tosetvalue 10 10 C VQ RESP associated items 9 166 description 9 166 call auto dial classifier requiring supervisory assistance Index 1521 U Third Party Listen Reconnect Acknowledgement 9 86 Third Party Make Call 5 22 Third Party Make Call Confirmation r 9 Third Party Make Call Request 9 51 call feature Third Party Listen Reconnect activating a specified endpointj9 132 deactivating specified endpoint 9 132 Call Forwarding feature requesting calidi8S 5 CCC CallVisor PC ASAI system startup 1 24 Third Party Merge 5 5 Cd Canceling Event Notification 5 5 Third Party Merge Confirmation request 9 45 Third Party Reconnect 5 27 00 Third Pa
269. oduction to ASAI This chapter is an overview of ASAI what it does and how it works Its purpose is to provide enough general information to design an application Specific information in the form of manual pages for the ASAI functions and capabilities can be found in Chapter 8 ASAI Capability Primitives enolchaper S Programming Manual Pages Coding examples appear throughout Chapter 4 ASAI Library Functions The Adjunct Switch Application Interface ASAI is an open standard interface that permits an application running on an adjunct computer to access telephony services provided by ECS Lucent Technologies CallVisor Switch Adjunct Application Interface Platform for the UNIX system provides connectivity between an adjunct and DEFINITY ECS via the ISDN personal computer interface IPCI The ASAI library a dynamic C library of functions and capabilities provides an application programmer with easy access to the IPCI so that his or her application program can utilize DEFINITY ECS services or features The ASAI library also allows ECS to access services provided by the adjunct such as Routing and Heartbeat The ASAI library provides a set of standard capabilities for performing the following tasks w Managing active calls to which the adjunct is not a party called third party calls for example transferring a call or putting a call on hold Querying or setting values of various indicators maintained by EC
270. old Description The Third Party Selective Hold capability allows the client to reguest the server to invoke this service on behalf of a specified party The effect is the same as if the identified party directly invoked the hold service The client continues to receive feedback regarding the call and may continue to control the call with further Third Party capabilities The server sends a C_3PSH_P OS_ACK when it has placed the party on hold The client must use feedback to determine the state of the call with respect to each endpoint The server sends a C_3PSH_NI EG_ACK if the parameters of the request are invalid or if it cannot attempt the hold operation Request Confirmation Parameters Notes Depending on conditions the request must specify the following parameters m Party Identifier The party on the call to be placed on hold This parameter must be specified if the association is started with a Third Party Make Call or a Third Party Take Control capability it can be inferred if the association is started with a Third Party Domain Control capability Call Identifier The call on which this capability operates This parameter must be specified if the capability is requested over an association started with a Third Party Domain Control capability otherwise it must not be used Some third party servers may h The party must be in the active Interactions with Event Reports 5 32 ave to
271. on rf item called num pool C DATSZ asai common rf item rf common agt login agt logout chg_wkmod call frwd can frwd Sac Sac can The client sends this capability to request activation of a specific feature The rf buf t union members contain either common or specific information needed to fulfill the request The common parameters are contained in the x common t structure the specific parameters for each feature are contained in the remaining union members rf common t Within asai common the programmer sets the capability to c RF REQ and the primitive type to C REQUEST The association is identified by the sao ia also known as cluster id The parameter r item identifies the feature being Issue 1 October 1996 9 133 Programming Manual Pages reguested It can be C_AGT_LOGIN C_AGT_LOGOUT C_CHAGT_WKMOD C_CALL_FRWD C_CAN_FRWD C_SAC or C_SAC_CAN agent login agent logout change of agent work mode call forwarding cancel call forwarding send all calls and cancel send all calls agt_login_t This structure contains the parameters needed to reguest the agent login feature agent_id is a pointer to a null terminated string that indicates the agent login identifier and or password With traditional ACD the agent s password is in the agent_id field With EAS the logical agent id is in the agent_id field If a password is reguired then a number and the password are added after
272. on to close your application under certain conditions for example to stop the system from hanging on an asai_rcv if ECS fails to return the expected response Figure 4 8 shows asai_close de void appy close extern int fd extern char pathname char buf C_MESIZE char p if asai close fd 0 p close of ASAI communication path s failed n sprintf buf p pathname asai_errval buf fflush stdout fflush stderr a return a Figure 4 8 Closing the Communication Path 4 14 gt NOTE The sample code does not call this function Issue 1 October 1996 Sample Code Sample Code The sample code reproduced here tests the Event Notification capabilities First the program determines whether the domain type is an ACD split or a call vector Then it reguests appropriate event reports The c EN REQ capability is sent on lines 65 74 in Figure 4 9 If an abort capability is received lines 75 to 91 the program exits Similarly if C_EN_CONF is received with a negative acknowledgement lines 92 to 98 as shown in Figure 4 9 the program exits Otherwise an event report is received The request is cancelled by sending the C_EN_CAN capability Issue 1 October 1996 4 15 ASAI Library Functions 1 2 set tabstop 4 shiftwidth 4 3 4 usage entest node acd vec num lt reports gt 9 a entest signal01 acd 99
273. on to execute the split or cp command The ASAI Administration menu provides access to UNIX system commands so you can do this by escaping from the menu if you prefer The log file contains entries consisting of a date and time stamp followed by a colon the name of the ASAI process that wrote the message another colon and the message The message tells you whether or not the process executed successfully du UT asai admin ASAI administration daemon has started B 910318165042 asai admin Push of FEL onto dev isdn ipci signalO1 succeeded 910318165042 asai admin Link of dev asai asai with dev isdn ipci signal 910318165042 asai_admin 101 succeeded 910318165042 asai_admin ASAI stack setup was successful Figure2 1 An ASAI Log File In the sample shown above the first 12 characters represent a date and time stamp The date is in the form yymmad the time is in the form hhmmss based on a 24 hour clock Thus 11 30 p m appears as 2330 Following the date and time stamp comes the name of an ASAI process preceded by a colon asai admin in the sample Another colon precedes the message Messages longer than 53 characters are carried over to the next line as shown in lines 2 and 3 in Figure 2 1 2 2 Issue 1 October 1996 OA amp M Manual Pages OA amp M Manual Pages This section contains manual pages for the commands and files that comprise ASAI Operations Administration and Maintenance
274. onality failures bugs The number of hours of technical support varies with the type of license purchased The CallVisor PC helpline number is 1 908 957 5725 The Technical Service Center TSC offers a consulting service to help application developers map desired functionality to ASAI capabilities The TSC can be reached at 1 800 344 9670 Issue 1 October 1996 Installation This chapter provides all the information on DEFINITY ECS administration system configuration operation and limits which is required to install CallVisor PC This chapter also covers the procedure to install CVLAN on Windows NT and UNIX and run the sample application The following sequence of steps is necessary to install CallVisor PC ASAI package on a PC The order of these steps eliminates excessive adjunct computer kernel rebuilds reboots and powerdowns 1 Disable COM 2 only if IRQ3 is to be used Install the CallVisor PC ISDN software IPCI device driver Install the CallVisor PC ASAI software Install the PC ISDN board hardware Test the CallVisor PC ASAI link Install the CallVisor PC ITT software Install CVLAN Server software Install CVLAN Client software CON O Ci A C N The next section of this chapter provides detailed instructions to install the CallVisor PC LAN GATEWAY package The LAN GATEWAY package requires that the CallVisor PC ISDN package be installed prior to the LAN GATEWAY package CallVisor PC ISDN and
275. onf soft command The Software Version is displayed on the Memory Resident line 1 18 Issue 1 October 1996 Installation Configuration This section assumes that you have read the installation steps in this document ZD NOTE The Network Support Utilities NSU package must be installed before you can install the CallVisor software packages The NSU package contains the streams utilities header files libraries and other files that are needed to add streams modules to the UNIX system kernel Upgrading Software The upgrade procedure consists of removing the existing packages and installing the new packages as described in DEFINITY ECS Administration section of this chapter Upgrade the system when no one else is using the computer You must supply the configuration information as part of the upgrade procedure gt NOTE Before beginning the upgrade copy or print the current configuration parameters for future reference These parameters can be found in the files usr adm asai asai_parms and usr adm isdn ipci_parms 1 Log in as root Bring the computer to single user mode and then run state 1 by entering the command shutdown iS y g120 2 Press Ctrl d to proceed and enter 1 for the selected run state 3 Remove the CallVisor PC software by entering the commands pkgrm cvasai and pkgrm cvisdn 4 Now install the new version Configure the software as described in the Configuring and Reconfiguring Software
276. ons where vect num is the number of the vector being administered display cor rstrict num The Direct Agent Calling field must be set to y on the class of restriction COR form for a station s COR for that station to originate or receive direct agent calls through an adjunct rstrict num is the COR number Message Trace Capability Use isdn trace to write the actual messages in hexadecimal format that are coming from or going to the IPCI device to stdout IPCI ON If ipci on fails an error message is written to stderr A list of the error codes with explanations is in usr adm isdn log msgs 11 2 Issue 1 October 1996 Application Programming Application Programming Cause Values CallVisor ASAI product must be installed to access the complete set of correct cause values For a complete description of DEFINITY ECS and ASAI cause values see the section Cause in Chapter 4 Information Elements in DEFINITY Enterprise Communications Server Release 5 CallVisor ASAI Protocol Reference also see cause_value section in Chapter 8 ASAI Capability Primitives of this document Nonblocking I O Some applications must be implemented as nonblocking I O For nonblocking I O in the library an application must call asai_open with ndelay_flag set to O_NDELAY It is also necessary to check error returns on every library function call See open 2 in the UNIX User Reference Manual for more details The
277. or returned by an asai_open call The second argument attr is to get the environment attribute The third argument points to the new value of the attribute Return Value The function returns 0 on successful completion and it returns 1 on failure Example if asai_get_env socketfd attr amp envbuf lt 0 asai_errval asai_get_env failed exit asai errno Issue 1 October 1996 6 7 CVLAN Programming Matching Versions Reguirement At execution time it is mandatory that the major and minor versions of the library be identical to that version with which the application was compiled This is because the API structures change with either minor or major version changes API structures will not change with delta changes The application should check the appropriate versions at run time to ensure that no communication activity occurs if there are any incompatibilities The current release of CVLAN has been designed for version 4 0 of the CallVisor PC ASAI library The CVLAN client library and the CVLAN server software must have identical embedded major and minor versions 6 8 Issue 1 October 1996 asai_send asai_send Description asai send and asai_rcv together are the central functions in the library These two functions convey all ASAI capabilities and data across an association Prototype long asai_send int socketfd asai_info_t buf long length Arguments The first argument is the
278. orm call monitoring and control functions ASAI Application An application running on an ASAI adjunct by making calls to a library written to meet the ASAI specification ASAI Host Adjunct Processor A computer processor that communicates with the switch via an ASAI link ASAI link An ISDN BRI or Ethernet interface configured to support ASAI ASE Application Service Element a well defined set of services available to other ASEs and to the application ASE instance Active conversation between client and server using operations contained in the corresponding ASE ASEID ASE identifier Association An association is a single invocation of an ASE between an application and ECS An association is represented by a unique CRV link number combination This term is synonymous with the following terms ASE instance cluster instance cluster identifier and single application object SAO An active association is one which applies to an existing call on ECS or to an extension on the call SAO is preferred GL 2 Issue 1 October 1996 Glossary Automatic Call Distribution See ACD B BRI Basic Rate Interface referring to the basic ISDN physical interface providing two 64K bps full duplex B bearer channels and one 16K bps D channel for message oriented signaling Busy Unavailable An event sent when a call cannot be completed because the party on the call is busy or the connection to the called endpoint cannot be established
279. ose benefit the tones will be sent This parameter must be specified if the association is started with a Third Party Make Call capability it can be inferred if the association is started with a Third Party Domain Control capability m User Data A substructure containing the user digit data The structure contains the following usable fields m Leng field An integer value that indicates the number of octets digits of user data included in the request Currently ECS will accept up to 32 bytes of data 1eng 32 m type field Indicates the type of information and is restricted to C UU IA5 which indicates IA5 or ASCII characters digits field A pointer to an ASCII string of no more that 32 characters in length Issue 1 October 1996 5 33 ASAI Capabilities Third Party Take Control Description The Third Party Take Control capability allows the client to request the server to allow it to control a call in progress to which the client is not a party Once the request for Third Party Take Control is acknowledged the client can use other third party capabilities for example Third Party Call Merge to control the call The client invokes this capability by issuing C_3PTC_REQ to which the server responds with a C_3PTC_CONF The client retains control of the call until one of the following conditions is met The client invokes the Third Party Clear Call capability for the call The client invokes the Thi
280. ot indicate an error it merely indicates that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai rcv C 3PSL DISC C 3PSL RECONN C 3PSL C 3PMC REO C 3PMC CONF C R ECONN ACK C EN R 3PTC RI u EP EQ C_3PTC_CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF Issue 1 October 1996 9 87 Programming Manual Pages C 3PTC CONF 3ASAI Name C 3PTC CONF Acknowledge a third party take control request Type Continuing Unacknowledged when received as a positive acknowledgement Terminating Unacknowledged when received as a negative acknowledgement Usage typedef struct asai common t asai common long num party ext party ext t party ext list char pool C DATSZ a3ptc ack t typedef struct asai common t asai common long cause value a3ptoc nak t Description The client receives this capability as a positive or negative acknowledgement of a C 3PTC REQ request Positive acknowledgement parameters are specified by a3ptc ack t and negative acknowledgement parameters by a3ptc nak t asai common Within this structure capability is returned as C 3PTC CONF primitive type is returned as it is set to C POS ACK for positive acknowledgment and to C NEG ACK for negative ac
281. pecified node When you use this characteristic previously registered servers are superseded by the new values Issue 1 October 1996 9 17 Programming Manual Pages If no service reguests have been sent by ECS or if the application has not used asai_set_env to register for handling them then no service reguests are passed to the application Use of arg as a null pointer clears any previously set characteristic server value arg defined below is a pointer to a structure of type server_type_t and supplies the server information typedef struct long num node service spec t buf server type t Within this structure num node indicates the number of structures of the type service spec t to be registered with the ASAI library and buf is a pointer to an array of structures of the type service type t defined as follows typedef struct long server type char node id C NODSIZ service spec t Here server type shows which service requests will be accepted and node id shows where they will be accepted Valid server types that can be put together with the option of selecting either one are C RT SER Routing C MAINT SER Maintenance The node id selects the sources of the requests that will be serviced Return Value Errors Upon successful completion the function returns 0 If an error occurs the function returns 1 The type of error is indicated by the error value set in asai errno C BA
282. pletely cleared Until the call is completely cleared and all resources freed the server continues to issue event reports about the call Control of the call to be cleared must have been initiated by a Third Party Make Call or a Third Party Take Control capability The client can issue this capability at any time regardless of pending or outstanding acknowledgements for previously requested capabilities Interactions with Event Reports After this capability is successfully acknowledged all parties on the call return to the null state Issue 1 October 1996 5 17 ASAI Capabilities Third Party Domain Control Description The Third Party Domain Control capability allows a client to request the server to begin reporting events for calls that originate and terminate at the specified domain The client can also request third party call control capabilities for those calls After the server accepts the request the client receives an Event Report each time an event occurs Clients can have several simultaneously active instances of Third Party Domain Control and a single event can be reported to more than one association When this happens the client receives separate event reports The client invokes this capability by issuing a C_3PDC_REQ to which the server responds with event reports The server continues to issue event reports until one of the following occurs m Theclient invokes the Third Party Relinquish Controll capab
283. pool C DATSZ tran list t typedef struct asai common t asai common long event name call id t call id char calling num plan type t calling type char called num plan type t called type user user t uudata trunk id t trk Oli ss oli long domain type long val length char domain val long leng udata long udata type long collect long timeout char incomg udata long priority level long interflow type long hour Issue 1 October 1996 9 105 Programming Manual Pages long long char long wchar_t char 13ncall I tst t typedef struct asai common t long erep common t typedef struct asai common t long call id t long char calend list t typedef struct asai common t long call id t user code t char collected digits t typedef union erep common t orig list t alert list t connect list t answered list queued list t hold list t reconnect list initiate list redirected list t logout list t login list t drop list t busy list t denial list t cuthrw list t trkszd list t conf list t tran list t incall list t 9 106 Issue 1 October 1996 minute second dnis_chars feat_type w_dnis_chars pool C_DATSZ j asai_common event_name asai_common event name call id calend cause pool C DATSZ asai common event name call id user da
284. program if it exits exits with a code of 1 Since this program is meant to be run as a daemon process the exit code is meaningless Issue 1 October 1996 2 9 Administration Files dev asai asai usr adm asai asai_log See Also asai 4 asai 7 asai_admin 1 asai_log 4 2 10 Issue 1 October 1996 asai_cause 1 asai_cause 1 Name asai_cause Logs cause values to stdout Synopsis asai cause h v t logtime process ids Description When asai cause is activated for a process an ASAI application that is running and the application receives an ASAI message which contains a cause value from ECS the library function asai rcv sends an Interprocess Communication IPC message containing the necessary information to asai cause asai cause reads the IPC queue formats the cause information and writes it to stdout asai cause is activated by including at least one valid process id Process ids are not checked for validity asai cause may be activated remotely or from any login in the system It is not necessary to be logged in as root to access asai cause asai cause prints cause values to stdout The following information is logged Date and time m Process id m ASAI capability name or the hexadecimal operation value indicates message type m sao id formerly known as cluster id identifies the particular association for which the message is intended m Contents of the cause informatio
285. pter for more details For the ISDN package you must enter the number of IPCI boards to be installed or those already installed the IRQ number the PC memory addresses as well as the matching version parameters Refer to the table below for default IPCI values Table 1 2 Default IPCI Configuration Values ISDN board IRO IVN PC memory address 1 2 d0000 2 2 d4000 3 2 d8000 4 2 dc000 Note that regardless of the number of ISDN boards installed in the computer the same IRQ IVN number is used Matching Versions Requirement for the ISDN protocol stack specifically for the QP module must be done correctly or the ASAI 1 20 Issue 1 October 1996 Installation link will not come up Three new tunable parameters are provided to allow selecting the desired version and allowable alternatives QP_DESIRED is set to the desired version Version 1 corresponds to G3V3 Version 2 corresponds to G3V4 and Version 3 corresponds to DEFINITY ECS release 5 For release 5 the default also is 3 QP_HIGHERVER and QP_LOWERVER are provided to allow higher version and or lower version operation The tunable parameters are located in etc conf cf d stune The defaults are QP DESIRED VER is set to 3 release 5 QP HIGHERVER is set to 3 to allow higher later versions QP LOWERVER is set to 1 to allow lower earlier versions If you have to reconfigure your adjunct computer system to change the version for example do so when no one else is using
286. ptor supplied C BADCHAR Unknown or improper context for a characteristic Issue 1 October 1996 9 7 Programming Manual Pages Notes The library returns information only on the number of nodes you specify If you specify fewer than the actual number of nodes information is returned on the nodes set in the first calls to asai_set_env It is recommended that you specify num_node as 30 or to any configurable parameter For example define MAXNUMSERV 30 server_type_t server maxnumserv services service_spec_t services MAXNUMSERV See Also 9 8 Issue 1 October 1996 asai open 3ASAI asai open 3ASAI Name asai open Open a communication path Synopsis include fcntl h finclude asai asai def h finclude lt asai asai_str h gt finclude lt asai asai_err h gt long asai open pathname ndelay flag char pathname long ndelay flag Description This function opens a communication path identified by pathname a null terminated character string the default path is dev asai asai lfthe ndelay flag is set to O_NDELAY the operation is asynchronous and the send or receive request does not block If the ndelay flag is setto O NDELAY the operation is synchronous and the send or receive request blocks In the synchronous mode control is not returned to the user until the send or receive request has been completed or an error occurs Return Value Errors Upon successful comple
287. r vqc pty stat t typedef struct asai common t long long long vqc ext stat t typedef struct asai common t long long vqc mwi stat t typedef struct asai common t long long vqc sac stat t 9 152 Issue 1 October 1996 asai common vqc type talk state work mode reason code asai common vqc type ext status asai common vqc type num call stninfo list pool C DATSZ asai common vqc type num party party list pool C DATSZ asai common vqc type domain type station type asai common vqc type mwi status asai common vqc type sac status C VQ CONF 3ASAI typedef struct asai common t long long char plan type t char vqc scf stat t typedef struct asai common t long long char char wchar t char vqc aaid t typedef struct asai common t long vqc common t typedef union vqc_common_t vqc_cause_t vqc split t vage cc statt vgc_tg_stat_t vgc_time_t vqc_agt_stat vqc station t vqc cal stat vqc pty stat vqc ext stat vqc mwi stat vqc sac stat vqc scf stat vqc aaid t jvqc buf t asai common vqc type Scf status redirection redir type pool C DATSZ asai common vqc type domain type extension name w name pool C DATSZ asai common vqc type Vqc common Vqc cause vqc split yac c stat vqc tg stat vqc time vqc
288. r item indicates the type of item to which the information supplied pertains It can be C AGTLOGIN AUD agent login The remaining vqr buf union members supply specific information based on the item identified in the response by vqr_item The following table shows the item type associated vqr buf union member the information contained in the member and a description of the information All items are mandatory Issue 1 October 1996 9 165 Programming Manual Pages Table 9 6 Associated Items and Descriptions for C VO RESP Item Type vqr_buf Member Description C_AGTLOGIN_ vqr_agtaud AUD agtext_list is a pointer to a list of agent extension numbers where each extension is specified by a null terminated character string num ext specifies the number of extensions in the list pointed toby agtext list pool is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_rcv the function returns the size of the message when successful and 1 on failure A return value of 0 indicates that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by a server See Also asai rcv
289. r a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by a client See Also asai_send C_EN_R EP C_3PMC_RI EQ C_3PMC_CONF C_3PTC_REQ C_3PTC_CONF C 3PSH C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF C_3PSD_CONF C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF Issue 1 October 1996 9 73 Programming Manual Pages C 3PSDS CONF 3ASAI Name C 3PSDS CONF Acknowledge a send DTMF request Type Continuing Unacknowledged Usage typedef struct asai common t asai common long cause value a3psds rsp t Description The client receives this capability as a positive or negative acknowledgement of a C 3PSDS request asai common Within this structure capability is returned as C 3PSDS CONF primitive type is returned as C POS ACK for positive acknowledgment and as C NEG ACK for negative acknowledgement The sao id also known as cluster id is specified in the C_3P SDS request is also returned cause value This parameter can be any of the following Q H z lt E U c ES I i SERV_UNAVIL CALLID TERM CY CY CY 0 CQ 0X C wn LI u ci H Z FU See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values 9 74 Issue 1 October 1996 C 3PSDS CONF 3ASAI Return Value When this capability is used in an asai_rcv t
290. r and id ptr is a character string that specifies the call identifier The party id parameter points to a structure of type party id t where id length specifies the length of ECS assigned party identifier and id ptr points to a character string that specifies the party identifier The pty state parameter specifies the current state busy alert etc of the corresponding party identifier In stn_info the return value of the pty state will have the same value as the cause fields in various event report messages See Table 9 1 Redirection Reason Codes in Chapter 9 for more information Whenever the structures of type party id t call id tortrunk id t are used as optional parameters and the information is not supplied id ptrisa null pointer and id length has a value of zero merge ext typedef struct old party id t old pid party id t party ig char extension plan type t ext type merge ext t 8 8 Issue 1 October 1996 Identifiers Within merge ext t the parameter ola_pid is a structure of type o 1d _party_ id_ t which provides the old party identifier see the pid party_id section The parameter party idis a structure of type party id t that indicates ECS assigned party identifier after two calls are merged see the party_id section for details The extension parameter points to a null terminated string that specifies the extension that corresponds to the party ext type is a structure of type pl
291. r communicates with the IPCI board and with software on the board This file is meant to be used only by the ipci admin 1 program Information flows only one way from the IPCI device driver to the ipci admin 1 program This file will have the same major device number as the signal 7 and command 7 files Its minor device number is 0 Files dev isdn ipci admin dev esai admin See Also 2 4 Issue 1 October 1996 asai 4 asai 4 Name asai Start ASAI administration Synopsis asai Description asai is a shell script that starts the ASAI administration daemon process asai admin 1 located in etc idrc d Operation The asai program is executed once per machine boot in the multiuser init level 2 The name of the log file asai 10g is changed to old_asai_log The administration daemon asai admin 1 is then started When this is done the standard error device is defined as dev consoleforasai admin 1 Files usr adm asai asai log See Also Issue 1 October 1996 2 5 Administration asai 7 Name asai ASAI communication file Description This file allows communication with ECS via the ASAI library functions It is meant to be opened by the ASAI library function asai_open This file is created when the software is installed Files dev asai asai See Also asai_admin 1 2 6 Issue 1 October 1996 asai Date 4 asai Date 4 Name asai Date Date file for UNIX ASAI
292. r space for the ASAI library to store program specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes The use of this capability in asai send is restricted to clients See Also asai send lasai rcv C EN REP C 3PMC REQ C 3PMC CONF C 3PTC REO C 3PTC CONF C 3PSH C 3PSH CONF C 3PR C 3PR CONF C 3PM CONF C_3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF 9 44 Issue 1 October 1996 C_3PM_CONF 3ASAI C 3PM CONF 3ASAI Name C 3PM CONF Acknowledge a third party merge request Type Continuing Unacknowledged Usage typedef struct asai common t asai common call id t call id long num merge ext merge ext t party list char pool C DATSZ a3pm ack t typedef struct asai common t asai common long cause value a3pm nak t Description The client receives this capability as a positive or negative acknowledgment of a C_3PM request Structures of the type a3pm ack t and a3pm naxk t contain the asai common structure that specifies the parameters use
293. rary functions asai open asai close asai set env asai get env asai send asai rcv asai errval Issue 1 October 1996 Introduction to CVLAN Table 6 1 Client API Library Functions Function Purpose Open communication path asai_errval Write error message if function call fails Establish communication path by setting node ID set server asai_get_env Check library version optional Send a capability asai_rcv Receive a capability amp o w u u u w w w H H H u u O D D O D ct D oj 5 0 3 lt asai_close Close the communication path optional The above table describes each function and shows how it works The functions are presented in a logical rather than in an alphabetical order Thus asai_open comes first and asai_close comes last as indicated in the above table It is possible to process more than one ASE on a communication path however each communication path can be used to service only a single node Thus if an application wishes to use a communication path to send service requests all requests must be sent to the same destination node as that of the initiating capability Issue 1 October 1996 6 3 CVLAN Programming asai_open Description The asai_open function is the first of the library functions that your application calls This function opens a communications path socket to the CVLAN server Prototype int asai_open con
294. rd Party Relinquish Control capability for the call The client invokes or receives a ULABORT capability for the call The client receives aIP ABORTJ capability for the association Request Confirmation Parameters a Call Identifier The identifier of the call that the client wants to control In addition the programmer can specify any or all of the following m Party Identifier The identifier for a party to the call This parameter is mandatory if the extension address below is specified Address The extension address number of each party to the call Note that the party identifier and the address can be repeated Notes The client must have received an event report from a different association that included the call identifier The client can request an event report receive it and then request the Third Party Take Control capability Interactions with Event Reports This capability does not affect the state s of the parties to the call Notes There are no restrictions on this capability 5 34 Issue 1 October 1996 Set Value Capabilities Set Value Capabilities The Set Value capability group consists of the Set Value capability and the Abort capability which is described later in this chapter Set Value allows a client to reguest a server to set the Message Waiting Indicator MWI or to activate the Flexible Billing Feature Both the feature to be set and its values are specified as p
295. rd by completing the Steps 2 and 3 listed in Chapter 3 of PC ISDN Platform Installation and Reference manual Do not do Step 4 or any subsequent steps listed in PC ISDN Platform Installation and Reference In Step 3 you do not have to connect either a headset or a voice terminal phone You must use a terminating resistor to connect the LINE connector to the wall jack going to the DEFINITY ECS BRI line gt NOTE Most ISDN voice terminals require power to operate This may involve additional equipment depending on the wire installation and equipment in your building Consult your DEFINITY ECS administrator or telecommunications consultant for additional information Do not turn the power on yet If you can see the LED with the cover on the computer you may put the cover on Otherwise leave the cover off until instructed to put it back on after all the software is installed and the LED has confirmed the basic sanity of the IPCI board If in doubt leave the cover off 1 6 Issue 1 October 1996 Installation 22 23 24 25 26 27 If IRQ 3 was chosen disable the COM2 port Most 386 486 class computers have COM1 and COM2 on the motherboard If this is the case use the CMOS configuration utility to disable COM2 according to your computer user manual If you do not have COM2 on the motherboard check to see if you have an expansion board that provides COM2 If you do disable it according to the manufacturer s
296. ream failure 3 Failure to send message to link 4 Failure to receive messages from link 5 time out while waiting to receive a message 6 Layer 1 is down could not attempt reset 7 Layer 2 failed to recover from reset 8 State machine transitioning try again 2 26 Issue 1 October 1996 esai_trace 1 esai_trace 1 Name esai_trace Trace LAN Gateway ESAI ASAI messages Synopsis esai_trace Description esai_trace is a general purpose diagnostic tool Its output is the actual ASAI message traffic to and from the ASAI E LAN Gateway board The message trace has the following general format lt time stamp gt lt driver gt lt function gt lt slash gt lt sbn gt lt diagnostic gt lt link gt lt hexs gt The following table explains the format Table 2 1 Format of esai_trace Generated ESAI Device Driver Messages Mnemonic Description Example lt time stamp gt message time stamp number 15273 lt driver gt name of module generating the ESAI entry QP Klog lt function gt name of function handling the uplink message lt slash gt lt sbn gt starting byte number 0 12 lt diagnostic gt message traffic has the value MSG_TRACE MSG_TRACE in this field Only message traffic is useful lt link gt link number 1 lt hexs gt GVI message contents in hex 96 1c 09 91 Received messages those coming from ECS usually have uplink in the function field Transmitted messages those going
297. returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent or received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes Use of this capability through the asai_send function always indicates a client abort Only ASAI library service providers can issue a provider abort See Also asai send lasai rcv Issue 1 October 1996 9 93 Programming Manual Pages C EN CAN 3ASAT Name C EN CAN Request termination of an event notification request Type Continuing Acknowledged Usage asai common t asai common Description The client sends this capability to request termination of event notification A structure of type asai common t contains the parameters needed to fulfill the request Within asai_common the programmer sets capability to C EN CAN and primitive type to C REQUEST The programmer must also set the sao id also known as cluster id that identifies the association to be terminated Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their p
298. rive and follow the online instructions Pkgadd displays that the package is available to process Press to continue the installation After the installation procedure is complete the installation program asks you to remove the diskette from the disk drive Shutdown instructions and the message Installation of lt cvlansrv gt was successful are also displayed Client Installation on UNIX You can install the PC CVLAN Client package at any time 1 Enter the command pkgadd d diskette1 2 Place the PC CVLAN Client disk in the appropriate drive and follow the online instructions 3 Pkgadd displays that the PC CVLAN Client package is available to process Press to continue the installation 4 After the installation procedure is complete remove the diskette from the disk drive The message Installation of lt cvlanxcl gt was successful is displayed Client Installation on Windows NT 1 To install the CVLAN Client on a Windows NT 3 51 system insert the Client diskette in drive A 2 Click on the RUN File Menu Item under Program Manager or File Manager and type Setup in the dialog box and press OK 3 Follow Setup instructions Issue 1 October 1996 1 13 Installation gt NOTE After Setup is complete CVLAN DLL the dynamic link library and CVLAN LIB the import library will be installed under a subdirectory called Program Running the Sample Application 1 To run the application on UNIX at the prompt
299. rmation can now do so It is recommended that any new information stored by these constructs be moved or cast to a number id t structure In those cases where a redirected calling called or connected number field is added to a message for example third party make call ack a number id t structure has been added to the capability structure Issue 1 October 1996 asai_common asai_common The structure asai_common defined by typedef asai_common_t is part of the data included for each capability As its name implies this structure contains information common to all capabilities This common information is defined as follows typedef struct capability_t primitive_t long long s asai_common_t capability primitive_type sao_id reserved Within asai_common the sao_id also known as cluster_id parameter identifies the particular association for which the message is intended The value of this parameter is an even integer when the capability is user initiated and an odd integer when the association is initiated by the ASAI library The type of service received or transmitted is identified in capability and is defined as follows typedef enum PAD PAD CONF PANS PANS CONF PCC PCC CONF PCE PDC REQ PDC CONF PDCE p de d WWWWWWWWwWWwwwwwwwwwwwww ww CO U r PM CONF PMC REQ C CONF PR PR CONF PRC PRC CONF PREDIR PTC REQ PTC CONF P
300. robable causes Notes This capability can be issued only by a client See Also asai_send C EN REO C EN CAN CONF C EN END 9 94 Issue 1 October 1996 C EN CAN CONF 3ASAI C EN CAN CONF 3ASAI Name C EN CAN CONF Acknowledge an event notification cancel request Type Terminating Unacknowledged when received as a positive acknowledgement Continuing Unacknowledged when received as a negative acknowledgement Usage typedef struct asai common t asai common long cause value Jenc nak t typedef union asai_common_t asai_common enc_nak_t enc_nak enc_rsp_t Description The client receives this capability as a positive or negative acknowledgment of a C_EN_CAN request The union enc_rsp_t defines the necessary fields for the messages asai common Within this structure capability is returned as C EN CAN CONF and primitive type is returned as C POS ACK for positive acknowledgment C NEG ACK for negative acknowledgment The sao id also known as cluster id returned is the association specified in the cancel request Issue 1 October 1996 9 95 Programming Manual Pages cause_value This parameter can be any one of the following C_FACUNSUB P R SER_UNIMP SERV_UNAVIL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values Return Value When this capability is used in an asai_rcv
301. rogram specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information C TG STAT vq tg stat tg ext is a pointer to a null terminated string specifying the trunk group access code or extension pool SeeC ACDSPT STAT C AGT STAT vq agt stat Split ext SeeC ACDSPT STAT agt ext isa pointer to a null terminated string specifying the extension of the ACD agent pool SeeC ACDSPT STAT C STATION vq station extension is a pointer to a null terminated string specifying the end point extension number pool SeeC ACDSPT STAT C AGTLOGIN AUD vq agt aud Split ext SeeC ACDSPT STAT pool SeeC ACDSPT STAT C CAL STA Vq cal stat extension SeeC STATION pool SeeC ACDSPT STAT C PTY STA vq pty stat call idis a structure in which the parameter id length specifies the length of ECS assigned call identifier and id ptr points to a character string that specifies that call identifier pool SeeC ACDSPT STAT C EXT STA vq ext stat extension SeeC STATION pool SeeC ACDSPT STAT C MWI STA vq mwi stat extension SeeC STATION pool SeeC ACDSPT STAT C SAC STA vq sac stat extension SeeC STATION pool SeeC ACDSPT STAT C SCF STA vq scf stat extension SeeC STATION pool SeeC ACDSPT STAT C CLASS ST
302. roject for standardization of operating parameters and interfaces for a network that allows a variety of mixed digital transmission services to be accommodated ISO characters This is an international character encoding standard established by the International Standards Organization It is a fixed width encoding of 32 bits which provides unique codes for all the languages and scientific symbols ITU International Telecommunications Union ITU is a division of the United Nations It produces recommendations which because of ITU s global coverage have more impact than ISO IEC standards Issue 1 October 1996 GL 5 Glossary L LED Light Emitting Diode a type of electronic device a small lamp often used to indicate the state of the hardware LCRV Local Call Reference Value a number that uniquely identifies each Q 931 2 call controlled on a single stream The Q 931 2 provider maps the LCRV to the CRV used in Q 931 2 messages Locale Locale is an internationalization feature Locale can be set to different regions such as French German Japanese etc It causes certain functions to act in the appropriate language or culture dependent ways by providing information such as character representation date and time representation currency representation etc M MWI Message Waiting Indication Manual Answer An operation in which an Automatic Call Distribution ACD agent is on hook and available to receive an ACD call
303. rol ECS continues to process the call normally The exception to this occurs when ECS receives any RELease COMplete message for ECS call that is in the classification state has not yet been classified In this case on receipt of the RELease COMplete message ECS will deny a Relinquish Control request and tear down the call Third Party Call Control provides for the following hird Party Answer Call 4 m Third Party Automatic Dialing hird Party Clear Call hird Party End Call hird Party Domain Control hird Party Domain Control End E mM E zl 3 mB m Third Party Listen Disconnec m Third Party Listen Reconnec m Third Party Make Cal m Third Party Merge hird Party Reconnec m Third Party Redirect Ca m Third Party Relinquish Contro m Third Party Selective Drop m Third Party Selective Hold hird Party Send DTMF Signals LI a Issue 1 October 1996 5 11 ASAI Capabilities m Third Party Take Control There are certain restrictions common to most third party calls a The calling number is not permitted the service For example the calling number may not be permitted to make out of state calls a The called number is not permitted the service For example the called number is not permitted to accept out of state calls m Theclient is not permitted to request the service 5 12 Issue 1 October 1996 Third Party Answer Call Third Party Answer Call Description The Third Party Ans
304. rolled Extension on a Call An extension active on a call which provides event reports over one or two domain control associations E Expert Agent Selection An optional feature that allows call center agents to have assigned skills and to receive calls based on their skill EAS adds flexibility to ACD Each agent assigned to a station at login time This makes it possible to use the same physical station for a variety of skills and agents It is also an ACD feature in which calls can be directed to specialized pools of agents who possess the correct skills to handle the call Event Report An activity within ECS which can cause notification to be sent to an adjunct GL 4 Issue 1 October 1996 Glossary F Flexible Billing A feature that allows ASAI to change the rate at which an incoming 900 type call is billed H Held One of the five possible states for a party on a call Held means that the party has placed the call on hold and is not connected to the call Hunt Group A group of stations which answer calls that are distributed using a routing algorithm An ACD split is a special type of hunt group IE Information Element II Digits Information Identifier Digits Information sent from the originating network switch that identifies the type of originator cellular prison etc for the call IPCI ISDN PC personal computer Basic Rate Interface BRI ISDN Integrated Services Digital Network the ITU p
305. rty Reconnect Confirmation cap info capability information file CAP type capability type 10 9 capabilities Third Party Redirect Call 5 28 9 63 lt conveyed across an association 4 11 Third Party Redirect Call Acknowledgement9 65 initiating controlling and terminating 1 22 Third Party Relinquish Control b 29 capability Third Party Relinquish Control Confirmation 9 61 Abort 5 2 5 35 5 5O Third Party Selective Drop confirmation 9 70 abortassociation 9 92 ACD or station domain control 9 39 O ASAI library functions 9 1 Third Party Selective Hold 5 32 9 76 Third Party Selective Hold Confirmation 9 78 Third Party Selective Listen Disconnect 9 80 Third Party Selective Listen Disconnect client controlled calls Third Party Selective Drop 9 Acknowledgement 9 82 definition Third Party Selective Listen Reconnect 9 84 Domain Control End Third Party Send DTMF Signals 5 33 Event Notification Cancel 5 5b Event Notification Cancel Confirmation 9 95 Third Party Take Control 5 34 Third Party Take Control Confirmation 9 88 Event Notification Confirmation 9 97 Third Party Take Control Request 9 90 Cd Event Notification End 5 4 Value Query 5 37 Cid Event Notification Request 5 3 Event Notification Request Termination 9 94 Event Notification S
306. s shown in Table 3 5 The two ASAI abort services are referred to as user aborts and provider aborts A user abort is a program initiated abort and a provider abort is a library initiated abort The C_ABORT capability is applicable to all ASEs The application can send and receive an abort at any time An abort is always terminating Table 3 5 ASAI Abort Capabilities ASE Capability Description all C_ABORT P_ABORT library initiated provider abort all C_ABORT U_ABORT ECS initiated user abort 3 12 Issue 1 October 1996 ASAI Capabilities ASAI Capabilities The library functions asai_send and asai rcv are used to exchange capabilities Each ASAI capability is specific performing a single task These tasks are classified as initiating continuing or terminating The capabilities are also classified as acknowledged or unacknowledged Table 3 6 lists each capability primitive and shows how it is classified Note that a number of the confirmation primitives are classified both as unacknowledged continuing and unacknowledged terminating In such cases the primitive is continuing when confirmation is positive and terminating when confirmation is negative Table 3 6 Classification of ASAI Capabilities Acknowledged Unacknowledged Init Cont Term Init Cont Term C_3PAD x X C 3PAD CONF X C SPANS X C 3PANS CONF X C 3PCC X C 3PCC CONF X
307. s terminated If the confirmation is negative the client continues to receive event reports and can reissue the Event Notification Cancel capability Notes Event notification must have been initiated by an Event Notification Request Issue 1 October 1996 5 5 ASAI Capabilities Event Notification Stop Call Notification Description The Event Notification Stop Call Notification capability allows the client to request the server to stop sending event reports for a specified call The server continues to send event reports for other calls with the specified association identifier The client invokes this capability by sending a C_EN_SCN to which the server responds with a C EN SCN CONF If the server is able to terminate event reporting for the specified call the client no longer receives the associated event reports If the server cannot terminate event reporting for the call or if the call does not exist the server issues a negative acknowledgement and the client continues to receive any event reports associated with the call if it exists Request Indication Parameter w Call Identifier The call for which no further event reports are desired Notes Only one call identifier can be specified in each Stop Call Notification request 5 6 Issue 1 October 1996 Event Report Event Report Description The Event Report capability is used by the server to report call related events An event app
308. s with brief explanations of their probable causes Notes This capability can be issued only by a server See Also asai rcv C VO REO C VO RESP Issue 1 October 1996 9 159 Programming Manual Pages C_VO_REO 3ZASAI Name Type Usage C_VQ_REQ Request information about status or value of a service or feature within the domain of the provider Initiating Acknowledged typedef struct asai_common_t long char char vq_split_stat_t typedefstruct asai_common_t long char char vq_tg_stat_t typedef struct asai_common_t long char char char vq_agt_stat_t typedef struct asai_common_t long char char vq_station_t typedef struct asai_common_t long char char vq_agt_aud_t 9 160 Issue 1 October 1996 asai_common vq item split ext pool C DATSZ asai common vq item tg ext pool C DATSZ asai common vq item split ext agt ext pool C DATSZ asai common vq item extension pool C DATSZ asai common vq item split ext pool C DATSZ C VQ REQ 3ASAI typedef struct asai common t long char char jvq cal stat t typedef struct asai common t long call id t char jvq pty stat t typedef struct asai common t long char char jvq ext stat t typedef struct asai common t long char char vq mwi stat t typedef struct asai common t long char char jvq sac stat t typedef
309. sai common t long call id t char lan type t ong har Q O denial_list_t typedef struct asai_common_t long call id t party id t long long char cuthrw list t typedef struct asai common t long call id t party id t char plan type t char trkszd list t 9 104 Issue 1 October 1996 droped num droped type uudata party id pool C DATSZ asai common event name call id party id called num called type busy cause pool C DATSZ asai common event name call id called num called type denial cause pool C DATSZ asai common event name call id party id location prog discp pool C DATSZ asai common event name call id party id called num called type pool C DATSZ C EN REP 3ASAI typedef struct asai common t asai common long event name call id t bef call ig call id t aft call id char calling num plan type t calling type char called num plan type t called type long part num merge ext t party list char pool C DATSZ oconf lvst t typedef struct asai common t asai common long event name call id t bef tranig call id t aft tranid char calling num plan type t calling type char called num plan type t called type long part num merge ext t party list char
310. sai rcv fd amp rsp sizeof rsp 0 asai_errval asai_rcv exit asai_errno printf Received s s on clid d caps rsp asai common capability typs rsp asai common primitive type rsp asai common sao id switch rsp asai common capability case C_ABORT printf tabort type s cause s n rsp abort_info abort_type C_PROV_ABT C PROV ABT C USER ABT causes rsp abort info cause value exit 3 case C EN END if rsp ene info cause value C NUSE LONG printf tcause s n causes rsp ene info cause value else printf tcause not returned n exit 0 case C_EN_REP printf Nteven s n names rsp evr_buf erep_common event_name P Figure 4 18 4 9 Sample Code Testing the Event Notification Capabilities Continued Issue 1 October 1996 Sample Code 37 38 39 40 41 42 43 44 45 46 47 48 49 50 S 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 el 72 73 74 9 76 ke break default printf tUnexpected capability causes abort n exit 4 en en_common asai_common capability C_EN_CAN printf Sent C EN CAN C REQUEST on clid 0n if asai send fd amp en sizeof asai common t 0 asai_errval asai_send exit asai_errno if asai rcv fd amp rsp sizeof rsp 0 asai errval asai rcv exit asai errno printf Received s s on c
311. sai set env 9 16 Issue 1 October 1996 asai_set_env 3ASAI asai_set_env ZASAI Name asai_set_env Set a specified characteristic for a communication path Synopsis include lt asai asai_def h gt include lt asai asai_str h gt include lt asai asai_err h gt typedef union server_type_t server char node_id C_NODSIZ set_type long asai_set_env fd characteristic arg int fd long characteristic set type arg Description This function is used to set a specified characteristic of the communication path associated with fd The parameter characteristic can assume any of the following values C NODE ID The C NODE ID parameter must be used before any initiating capability is sent Its purpose is to assign the destination node switch for all subsequent capabilities on the communication path If any association is active on the communication path the function fails The arg parameter points to a null terminated string specifying the node identifier A node identifier is the name of the IPCI board or LAN Gateway link connected to ECS with which you wish to communicate These are typically signal01 signal02 signal03 or signal04 The use of arg as a null pointer clears a destination Only one destination can be set for a communication path at a time C SERVER The C SERVER parameter sets the type of service requests to be accepted for a specified capability group from the s
312. scription The Third Party Call Ended capability is issued by the server to inform the client that a client controlled call has been disconnected and the association has been cleared The client can no longer control the call or use its association identifier The server issues a C_3PCE when the endpoints to a call have been disconnected or when some internal condition causes it to terminate processing for the call Reguest Confirmation Parameters Call Identifier The call that has been terminated Notes This capability may indicate that an existing call has been merged with another existing call It may also be used if a call initiated by a C_3PMC_REQ cannot be routed by the server thus terminating call processing Interactions with Event Reports Reports that a call identified by its call identifier has ended and that the last party to the call was dropped or disconnected A drop event for the last party added to the call is not issued in these instances thus this capability replaces the last drop event on a call 5 16 Issue 1 October 1996 Third Party Clear Call Third Party Clear Call Description Notes The Third Party Clear Call capability allows a client to reguest that an existing call be disconnected and related resources be freed All parties to the call are disconnected The client invokes this capability by issuing a C_3PCC The server responds with a C_3PCC_CONF as soon as the call has been com
313. se limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment This equipment generates uses and can radiate radio frequency energy and if not installed and used in accordance with the instruction manual may cause harmful interference to radio communications Operation of this equipment in a residential area is likely to cause harmful interference in which case the user will be required to correct the interference at his or her own expense Part 68 Network Registration Number This equipment is registered with the FCC in accordance with Part 68 of the FCC Rules It is identified by FCC registration number AS593M 13283 MF E Part 68 Answer Supervision Signaling Allowing this equipment to be operated in a manner that does not provide proper answer supervision signaling is in violation of Part 68 rules This equipment returns answer supervision signals to the public switched network when m Answered by the called station m Answered by the attendant m Routed to a recorded announcement that can be administered by the CPE user This equipment returns answer supervision signals on all DID calls forwarded back to the public switched telephone network Permissible exceptions are m Acallis unanswered m Abusytone is received m A reorder tone is received Trademarks CallVisor is a registered trademark of Lucent Technologies DEFINITY is a registered trade
314. serving node is overloaded and servers cannot accept ASAI requests The server can also provide a negative acknowledgement with a cause of requested facility not subscribed In this case the link is operational but no conclusions can be drawn about the status of the server s The client invokes this capability by issuing a C_HB_REQ to which the server replies with a C HB CONF Request Indication Parameters Notes There are no mandatory parameters associated with this capability The Heartbeat indicates the readiness of server s on a specific ASAI interface If there is no response to the heartbeat then the ASAI link is not operational but the servers may be serving incoming requests on other ASAI interfaces Issue 1 October 1996 5 49 ASAI Capabilities Abort Capabilities The ASAI library includes an Abort capability that is part of every capability group The Abort capability provides two types of Aborts U ABORT Aclient initiated abort a P ABORT A library initiated abort Description The Abort capability allows the client to inform the peer entity client or server that processing for the ASE is terminating The Cause parameter indicates the reason for terminating The client invokes the Abort capability by issuing a C ABORT with the type of abort specified as C USER ABORT The library invokes the Abort capability by issuing a C ABORT With the type of abort returned to the client as C PROV ABORT
315. sing Active One of the five possible states for a party on a call Active means that the party has been connected to the call Active call For the Send DTMF Signals feature a call that has received answer supervision either network or timed that is resulting from elapse of a software timer and has assigned listen and talk time slots Therefore for Send DTMF Signals purpose an answered call on hold is an active call Active Notification Association A unique CRV link number combination assigned by an application via the Event Notification Request capability Active Notification Call A call for which event reports are being sent over an active notification association communication channel to the adjunct Sometimes referred to as a monitored call Active Notification Domains Group domains are Vector Directory Numbers or ACD split extensions for which Event Notification has been requested Adjunct An independent processor connected to ECS Adjunct Controlled Association A unique CRV link number combination assigned by an application via the Third Party Make Call or the Third Party Take Control capability Adjunct Controlled Call A call controlled by an adjunct controlled association The call must have originated via the Third Party Make Call capability or by a call with an active Third Party Take Control capability Adjunct Controlled Split An ACD split administered to be under adjunct control Agents logged into such
316. sociations the parameter is not used The party id structure contains two field S Id ptr and id length The field id ptr does not point to a null terminated character string but rather an array of binary bytes of the specified length call id call idis ECS assigned identifier of the call to be placed on hold call idis used only when the association is initiated by the C 3PDC REO capability 9 76 Issue 1 October 1996 C_3PSH 3ASAI pool The pool parameter is a character array that provides buffer space for the ASAI library to store program specific information See the section Pool fin Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by a client See Also asai send C EN REP C 3PMC REQ C 3PMC CONF C 3PTC REO C 3PTC CONF C 3PSH CONF C 3PR C 3PR CONF C 3PM C 3PM CONF C_3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3PRC C 3PRC CONF Issue 1 October 1996 9 77 Programming Manual Pages C 3PSH CONF ASAD Name C 3PSH CONF Acknowledge a
317. space for the ASAI library to store program specific information See the section Pool Jin Chapter 8 ASAI Capability Primitives for more information C CALL VI ECTOR domain ext Pointer to a null terminated string that indicates the extension of the vector directory number pool Character array that provides buffer space for the ASAI library to store program specific information See the section Pool in Chapter 8 ASAI Capability Primitives for more information Return Value When this capability is used in an asai_send the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been sent Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai send C EN R EP C EN CONF C EN CAN C EN CAN CONF C EN END 9 122 Issue 1 October 1996 C EN SCN 3ASAI C EN SCN 3ASAD Name C EN SCN Stop sending event reports for a specified call Type Continuing Acknowledged Usage typedef struct asai common t asai common call id t call id char pool C DATSZ Jen scn t Description The client sends this capability to request termination of event reports on a specified call The call is identified by ca11 id Only one call idis allowed per request
318. splits must do all telephony and ACD login logout and change work mode functions through the adjunct Adjunct Monitored Call An adjunct controlled call an active notification call or a call that provides event reports over a domain controlled association Issue 1 October 1996 GL 1 Glossary Adjunct Routing A vector command step that allows the switch to reguest a route destination from an ASAI adjunct for the call executing the vector command step When an adjunct routing vector command is encountered the switch disconnects any tone detector call prompter connected to the call and discards any dial ahead digits that had been collected Collected digits are retained with the call and sent to the adjunct in the Route Reguest message Agent A member of an ACD split or a hunt group An agent can be a person at a terminal or a port on an adjunct processor If the agent is a member of an ACD split that agent is referred to as an ACD Alerting One of the five possible states for a party on a call Alerting means that the party is being alerted for the call AP Adjunct Processor Application Processor API Application Program Interface Application An adjunct entity that requests and receives ASAI services or capabilities The terms application and adjunct are used interchangeably ASAT Adjunct Switch Application Interface A messaging interface between the switch and an Adjunct Processor that allows the AP to perf
319. st char int flags Arguments Only the second argument is used in this release of CVLAN flags must be set to O_NDELAY or the call to asai open Will fail Return Value On successful completion the message Socket file descriptor is displayed If an error occurs the function returns 1 Example open routine int fd if fd asai open O NDELAY lt 0 exit asai_errno 6 4 Issue 1 October 1996 asai_errval asai_errval The asai_errval function will be the standard ASAI library function value See asai errval SASAI in Chapter 9 Programming Manual Pages Issue 1 October 1996 6 5 CVLAN Programming asai_set_env Description After opening a communication path the next step is to establish an environment that will support your program The asai set env function enables you to set one characteristic at a time You must set the node identifier first using C NODE ID characteristic Prototype long asai set env int socketfd long attr set type value Arguments asai set env has two mandatory and one optional argument The file descriptor socket fd returned from an asai open call and the characteristic to be set second argument are mandatory you may also have to specify a value for the characteristic you are setting The characteristic C NODE ID establishes the name of the node from which your application will provide services This must be done
320. t Trunk Seized l gt Call Conferenced gt Call Transferred l l Call Redirected Call Ended Call Offered to Domain Call Initiated Call Originated A A Pl rl rl gt gt r gt Queued Reorder Denial Logout Login Key A item always provided in event report I item may be provided in event report 5 8 Issue 1 October 1996 Event Report Table 5 1 Valid Event Item Combinations Continued Event Items Reported Calls User Lookahead Redirection In Queue Cause Entered Info Interflow Info Domain Number Alerting I Answered I Busy Unavailable Connected Cut Through Progress Disconnect Drop Hold Reconnected Trunk Seized Call Conferenced Call Transferred Call Redirected Call Ended A Call Offered to Domain l Call Initiated Call Originated Queued Reorder Denial Logout Login Key A item always provided in event report I item may be provided in event report Issue 1 October 1996 5 9 ASAI Capabilities Table 5 1 Valid Event Item Combinations Continued Event Items Reported Trunk Extension Group Work Progress Extension List Number Flow Indicator UUI oli Alerting l Answered Busy Unavailable Alerting Answered Busy Unavailable
321. t uudata The purpose of the user user information is to convey information between ISDN users This information is not interpreted by ECS but rather is carried transparently and delivered to the remote user If the info field is IA5 characters ASCII the string is null terminated The leng field is an integer value that indicates the number of octets of user data included in the request This field is set to 0 if no user user data is present Currently ECS will accept up to 32 bytes of data 1eng 32 If more than 32 bytes is specified an error will be returned ASAI supports a maximum user user data length of 32 bytes although user user data generated from a PRI trunk can be up to 127 bytes in length DEFINITY ECS will truncate this to 32 bytes before forwarding it to ASAI link The protocol field indicates the type of information and is restricted to C UU USER that indicates a user specific protocol or C UU IA5 which indicates IA5 or ASCII characters The info field is a pointer to an ASCII string of no more that 32 characters in length leng udata This parameter is an integer value that indicates the number of octets of user data included in the offered call udata type This parameter indicates the type of user data It can be C LOGIN DIGITS C CALL PROMPTER orC NUSE LONG login digits call prompter information or not used Issue 1 October 1996 9 139 Programming Manual Pages collect The collect
322. t can be inferred if the association is started with a Third Party Domain Control capability Call Identifier The call on which this capability operates This parameter must be specified if the capability is requested over an association started with a Third Party Domain Control capability otherwise it must not be used Use to User Data A substructure containing user data The structure contains the following fields Leng field An integer value that indicates the number of octets of user data included in the request This field is set to 0 if no user user data is present Currently ECS will accept up to 32 bytes of data Leng 32 If more than 32 bytes is specified all data is discarded Protocol field Indicates the type of information and is restricted to C_UU_USER which indicates a user specific protocol or C_UU_IA5 which indicates IA5 or ASCII characters Info field A pointer to an ASCII string of no more that 32 characters in length There are no restrictions on this capability Issue 1 October 1996 Third Party Selective Drop Interactions with Event Reports This capability can be reguested for a party when the party is in any state except null After the capability is successfully acknowledged the party goes to the null state This capability is the only one allowed for a party that is in the seized state Issue 1 October 1996 5 31 ASAI Capabilities Third Party Selective H
323. t the server type Note that each call to asai set env overwrites the previous setting on a per characteristic basis A E setarg numnode 4 setarg buf srvrs strcpy srvrs 0 nodeid signal01 srvrs 0 node id signal01 srvrs 0 server type C RT SER C MAINT SER if asai set env fd C SERVER amp setarg 0 asai_errval asai_set_env C_SERVER failed return asai_errno A Figure 4 5 Setting the Environment Establishing a Server When you are specifying servers be sure to include maintenance C_MAINT_SER in the list or invoke the heartbeat OA amp M process prior to running your application If you do not your program will be unable to respond when ECS sends a heartbeat If this happens ECS tears down the link Issue 1 October 1996 4 7 ASAI Library Functions You may also want to include the routing C_RT_SER server This is optional and the needs of your program should determine whether or not you specify this service However you will not be able to receive route requests if you do not include this server in your environment The sample code at the end of this chapter calls asai_set_env online 57 in gt NOTE Be aware that each call to asai_set_env overwrites the previous value s on a per characteristic basis 4 8 Issue 1 October 1996 asai_get_env asai_get_env The asai_get_env function allows you to check the version of the ASAI library
324. ta pool C DATSZ erep common orig list alert list connect list answered list queued list hold list reconnect list initiate list redirected list logout list login list drop list busy list denial list cuthrw list trkszd list conf list tran list incall list C EN REP 3ASAI calend list t calend list collected digits t collected digits evr buf t Description The server sends this capability to report requested information in the form of an event report An event report can be generated for calls controlled by the adjunct via the Call Control Capability Group for calls controlled by the adjunct via the Domain Station Call Control Capability Group Domain Control of ACD and for calls for which the adjunct has requested Event Reports via the Notification Capability Group The union evr buf t contains the information shared by all event reports in erep common t and the specific information for each report in the remaining members erep common Within this structure asai common identifies the specific capability corresponding to the report and the association concerning which the reports are to be generated The programmer sets the capability to C EN REP and the primitive type to C REQUEST The event is identified by event name This parameter can be any of the values shown in the table on the following pages For each event there is a
325. tation extension Station Message Waiting Lamp Query Requests status of the Station Message Waiting Lamp for the given extension Station Send All Calls Status Query Requests status of the Station Send All Calls for the given extension Station Call Forwarding Status Query Requests status of the Station Call Forwarding for the given extension Name Query Requests the name associated with the given extension from the Integrated Directory Database There are no restrictions on this capability ECS software Release 5 now supports up to 27 special characters in Integrated Directory Database Before release 5 only 15 characters were supported and only 15 characters will be returned if ECS software is G3V4 or if itis Release 5 and the ASAI link version is 1 or 2 Correct ASAI link version has to be negotiated for this functionality For Release 5 the link version should be set to 3 5 38 Issue 1 October 1996 Value Query Response Value Query Response Description Value Query Response allows the server to provide multiple responses to a request The server issues a C VQ RESP to signal delivery of information requested by the client with a C vo REQ The server terminates this ASE with a C vo CONF after all Value Query Response requests have been answered Request Parameter Value Depends on the item s specified in the Value Query request defined previously in this chapter Notes There are n
326. tatus Time of day ACD agent status Station status ACD Agent Login Audit Party ID Extension Calls query Station Message Waiting Lamp Query Station Send All Calls Status Query Station Call Forwarding Status Query Name Query Integrated Directory Data The feature or service is specified as a parameter The server can send multiple replies to a single query Issue 1 October 1996 Value Query Value Query Description The Value Query capability allows a client to request and receive information about the status of the value of a feature or service under server control The client issues a C_VQ_REQ specifying the feature or service queried The server responds with a C vo coNF when only one reply is needed or a variable number of C vo RESP messages when multiple replies are needed Request Parameters Item The object for which a value is being requested including ACD Split Status Requests the number of agents logged into the ACD split the number of agents available to receive calls or the number of calls queued in the ACD split Call Classifier Status Requests the number of idle call classifiers the number of call classifiers that are in use the number of call classifiers that are busied out for maintenance or the number of call classifiers that are unavailable for reasons other than maintenance Trunk Group Status Requests the number of idle trunks in the trunk group the number of
327. te and call processing terminates In this case if the ack_flag is set on the client receives an acknowledgement from ECS If the ack_flag is not set on the client receives no response regardless of whether the call can be made or not see C 3PMC CONF 3ASAI in Chapter 9 Programming Manual Pages Request Confirmation Parameters a Calling Number The party specified by extension number on whose behalf the call is being made Called Number The extension number of the third party who is being called m Acknowledgement Requested A flag that must be set on or off indicating whether the server must return an acknowledgement as soon as it accepts the C 3PMC request In addition the programmer can specify any or all of the following m Type of Facility Trunk group ACD split or neither default neither 5 22 Issue 1 October 1996 Third Party Make Call Notes m Facility Access Code Access code of the trunk or ACD split if one is specified m Priority Call A flag indicating that the call is a priority call default no priority a Waiting Time The number of rings after the call has reached the alerting state to wait for the call to be answered default is ECS dependent m Service Circuit A flag indicating that a call classifier is to be added to the call default 2 no call classifier Direct Agent Call A flag indicating that the call is directed to a specific ACD agent
328. ters can be translated the second and fourth tildes discontinue character mapping and the presentation of ASCII characters within the name resumes To illustrate the use of tildes for character mapping and translation the Spanish name Pe n a is received from ECS by ASAI and this name is subsequently translated by the ASAI adjunct to Pe a The first tilde in this name turns on character mapping and the second tilde turns it off It should be noted that the application can only present the translated name to the user if the operating system supports the European and Katakana character sets and fonts m Fordetails on character mapping see the Enhanced Voice Terminal Display section in Chapter 3 of the DEFINITY Enterprise Communications Server Helease 5 Feature Description m For information on searching for a name in the Integrated Directory Database see Value Query section in Chapter 5 ASAI Capabilities of this document Issue 1 October 1996 A 1 ISO Characters A 2 Issue 1 October 1996 Glossary A ACD Automatic Call Distribution a distribution method used to direct calls to a group of agents called splits using the most idle agent or the hot seat routing algorithm ACD agent extension A station extension that is a member of an Automatic Call Distribution ACD split skill hunt group ACD call A call directed to an ACD split skill hunt group either directly or through vector proces
329. the CallVisor ASAI product an OA amp M process asai_hb is available to accomplish this maintenance task Link Startup Failure The QP module logs link startup failures to both the system console and the crash buffer Use crash 1M to examine the crash buffer If the QP module has failed it is probably because of ECS and adjunct version incompatibility If the link failure was because of incompatible parameters correct the parameters as described in the Starting Up the System section in Chapter 1 Installation Version Selection ECS now supports version selection The ISDN protocol stack specifically the QP module supports this feature Three new tunable parameters are provided to allow selecting the desired version and allowable alternatives QP DESIRED VER is set to 3 Version 1 corresponds to G3V3 Version 2 corresponds to G3V4 and Version 3 corresponds to release 5 For release 5 the default also is 3 QP_HIGHERVER and QP_LOWERVER are provided to allow higher version and or lower version operation The tunable parameters are located in etc conf cf d stune The defaults are QP DESIRED VERis set to 3 release 5 QP HIGHERVER is set to 3 to allow higher later versions QP LOWERVER is set to 1 to allow lower earlier versions To change the values edit the etc conf cf d stune file Follow the standard tuning procedures and rebuild the kernel then reboot 11 4 Issue 1 October 1996 Inoperable System Errors Inoper
330. the adjunct To change the values edit the etc conf cf d stune file Follow the standard tuning procedures and rebuild the kernel then reboot the system Execute the command shutdown i6 y g0 to reboot the system If the version parameters are incompatible with ECS version the BRI link will not start up The QP module will log this error to the system console and the crash buffer For the ASAI package you must enter the number of ASAI nodes IPCI boards installed 1 2 3 or 4 if that information is not available at the time of installation If the ISDN package was installed first this information is available to the ASAI package If only one IPCI board was configured for the ISDN package the following message is displayed Configuring cvasai for 1 ASAI Nodes Reconfiguring the packages requires you to reinstall the ISDN and ASAI software If you have to reconfigure your adjunct computer system to add a board for example do so when no one else is using the adjunct gt NOTE Make sure that you save a copy of the current configuration parameters for future reference Issue 1 October 1996 1 21 Installation Memory Considerations This section introduces a number of concepts that assume practical experience with administration of the ASAI applications package The material presented here is discussed in detail in Chapter 1 ASAI and Capability Groups of DEFINITY Enterprise Communications Server Rel
331. the appropriate structure and passes the structure to the application In addition to this mapping responsibility you must also ensure that the length of your buffer is sufficient to contain the entire message If the buffer is too small results are unpredictable Issue 1 October 1996 4 11 ASAI Library Functions The maximum useful size of the user buffer is size of asai_info_t but you can select a size appropriate for your application The example below uses size of asai_common_t If you are not sure use size of asai_info_t if asai_send fd amp mybuf sizeof asai_common_t lt 0 asai errval asai send exit asai errno e Pi Figure 4 6 asai_send Function asai_send returns the size of the message on success and 1 on failure Technically a return code of 0 is not an error however it does indicate that only the control portion of a message has been sent This is probably not what you intended The sample code at the end of this chapter calls asai_send on line 70 and on line 147 in Figure 4 9 4 12 Issue 1 October 1996 asai_rcv asai_rcv This function reads messages from the communication path specified by fd Like asai_send it expects a buffer and the length of the buffer to be passed to it a sprintf buf p node id fflush stdout fflush stderr asai errval buf return aSai_errno S asai rcv return v
332. the client to request the server to temporarily disconnect a specified party the listener from listening to communication from another party or parties the talker s on an active call The client continues to receive feedback regarding the call and may continue to control the call with further Third Party capabilities The server sends a C_3PSL_DISC_ACK with primitive type C_POS_ACK whenit has disconnected the listener party from listening The server sends a C 3PSL DISC ACK with primitive type C NEG ACK if the parameters of the request are invalid or if it cannot disconnect the listener party from listening Request Confirmation Parameters Notes Depending on the conditions the request must specify the following parameters m Listener Party Identifier The party on the call to be disconnected from listening The request may also specify m Talker Party Identifier This parameter is specified to identify a specific party who will no longer be heard by the listener If this parameter is omitted the listener will be disconnected from listening to a other parties that is the listener will not hear any other party on the call The listener party must be connected on the call Although any voice path originating from a station or trunk on a call is blocked for the party which is disconnected from listening it is possible that a disconnected listener will still hear faint tones or speech This can happen in a multipart
333. third party selective hold request Type Continuing Unacknowledged Usage typedef struct asai common t asai common long cause value a3psh rsp t Description The client receives this capability as a positive or negative acknowledgement of a C 3PSHrequest asai common Within this structure capability is returned as C 3PSH CONF primitive type is returned as C POS ACK for a positive acknowledgment and as C NEG ACK for a negative acknowledgment The sao id also known as cluster id specified in the selective hold request is also returned cause value This parameter can be any of the following C CALLID TERM C FACUNSUB C C_INVLDIE C_INVLDNUM C_MAND_INFO C o C C PROTERR RESUNAVL S S ER_UNIMP ERV_UNAVIL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values 9 78 Issue 1 October 1996 C_3PSH_CONF 3ASAI Return Value When this capability is used in an asai_rcv the function returns the size of the message upon success and 1 on failure A return value of 0 does not indicate an error but that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes See Also asai rcv C EN REP C 3PMC REQ C 3PMC CONF C 3PTC REO C 3PTC CONF C 3PSH C 3PR C 3PR CONF C 3PM C 3PM CONF C 3PSD C 3PSD CONF C 3PCC C 3PCC CONF C 3PCE C 3P
334. tion the function returns the integer value of fa If an error occurs the function returns 1 The file descriptor can be used by subsequent calls to ASAI library functions The type of error is indicated by the error value set in asai errno C BADFD Invalid file descriptor supplied C BADFLAG An invalid value was given for the asai open flag C NOENT No such file or directory C OSER A system call failed check errno Issue 1 October 1996 9 9 Programming Manual Pages See Also 9 10 Issue 1 October 1996 asai_rcv 3ASAI asai rcv 3ASAI asai rcv Receive message via the communication path Name Synopsis incl incl incl lt asai asai_def h gt lt asai asai_str h gt lt asai asai_err h gt typedef union asai common t nfo abort i vq buf t vqr buf vqc buf en buf en rsp evr buf enc rsp ene info t a3pmc info a3pmc_ack a3pmc_nak a3pmc_rsp_ a3ptc_info a3ptc_ack a3ptc_nak Cr CT ct ct a3psh info a3psh rsp a3psd info a3dpsd rsp a3psl disc a3psl disc a3psl rcon a3psl reco a3dpr info a3pr_rsp_t a3prc_rsp_ a3pm_info_ a3pm_ack_ a3pm_nak_ aspee rsp a3pce_info_ a3pad_info a3pad_ack_ a3pad_nak_ FF GE ct cv CT cv CT ct ct t E ct ct asai common abort info vq buf vqr bu vqc bu en buf en rsp Ih e evr_buf enc_rsp ene_info a3pmc_info a3pmc_ack
335. to a null terminated string indicating the number held If the number is not supplied the parameter is a null pointer hold_type is an optional plan_type_t structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL See C_ALERTING con_num_type for more information concerning plan_type_t See C_ALERTING pool See C_ALERTING C_RECONNECT reconnect_list See C_ALERTING reconnect_num is a pointer to a null terminated string indicating the number held If the number is not supplied the parameter is a null pointer recon typeisanoptionalplan type t structure that supplies additional information about the structure field that immediately precedes it providing that the preceding field is not NULL See C ALERTING con num typelfor more information concerning plan type t lparty_id See C_LALERTING Gl See C ALERTING C INITIATE initiate list See C ALERTING Es party id SeeC ALERTING poo1 see C ALERT ING C REDIRECTED redirected list See C ALERTING poo1 See C ALERT ING C LOGIN login list phys ext is a pointer to a null terminated string indicating the physical extension logged into a specific split skill log ext is a pointer to a null terminated string t
336. to the ASAI E board and then ECS usually have a mnemonic function for example downlink Issue 1 October 1996 2 27 Administration Examples Bugs Files See Also The function name is separated from the starting byte number by a slash The starting byte number indicates the byte number of the beginning left most byte of the hex field The first line of a message has a byte number of 0 The second line has a number greater than zero usually 12 and so forth for each additional line of the same message The next message will have a byte number of 0 for the first line The diagnostic field indicates the purpose of the entry Only trace entries with a diagnostic field value of MSG_TRACE are useful The driver QP frequently writes diagnostic messages These messages are normal and can be ignored Periodically the kernel reporting mechanism klog also writes entries These can also be ignored gt esai_trace gt trace in amp Turn on trace and send the output to the file trace in tail trace in Display the end of the trace in file A heartbeat was sent to ECS using the command asai_test Output similar to the following is generated 15273 ESAI downlink 0 MSG_TRACE 1 08 02 00 02 64 96 1c 09 91 15273 ESAI downlink 12 MSG TRACE al 06 02 01 03 02 01 b3 00 00 00 00 15273 ESAI uplink 0 MSG TRACE 08 02 00 02 64 96 1c 09 91 15273 ESAI uplink 12 MSG TRACE al 06 02 01 03 02 01 b3 00 00 00 00 15273 QP qp rsrv 515
337. to the following is generated 15273 IPCI gviSendSignal 0 MSG TRACE LINK 95 11 00 08 02 00 02 64 96 1c 09 91 15273 IPCI gviSendSignal 12 MSG TRACE al 06 02 01 03 02 01 53 00 00 00 00 15273 IPCI rcv cc 0 MSG TRACE 90 11 00 08 02 00 02 64 96 1c 09 91 15273 IPCI rcv cc 12 MSG_TRACE al 06 02 01 03 02 01 b3 00 00 00 00 15273 QP qp rsrv 515 freeing unrecognized message of size 0x2 15273 QP qp rsrv 516 msg 0 0x8 msg 1 0x1 The kernel mechanism used by the device driver does not guarantee message order or integrity Therefore a sequence number is placed on each message by the IPCI device driver to allow detection of missing or out of order messages Turning on the message trace facility causes an additional system load Sometimes the load is significant Issue 1 October 1996 isdn_trace 1 Files usr adm isdn bin isdn_trace usr adm isdn bin asai trace See Also asai trace l1 Issue 1 October 1996 2 47 Administration lan_stat 1 Name usr adm isdn bin lan stat Print Status of LAN Gateway links Synopsis lan stat n linkNo a Description If n linkNo is specified a status report is printed only for that link Otherwise a status report is given for all LAN gateway links The report is printed to st dout Lan stat With no arguments specified will print the status for only those LAN Gateway links that are administered If the a option is specified a long form of status is reported for all possibl
338. top Call Notification 5 6 Event Report 5 7 Event Report End Event Report Request specified domain 9 Value Query Confirmation 9 151 0 09 Value Query Confirmation value quer termination Q i5t capability group Adjunct Routing 5 defintion 1 22 0 Event Report sending or receiving event TE 9 101 event QD Ue Heartbeat 5 48 5 49 1 1 Request Feature capabilities Set Value Third Party Call Control 5 Heartbeat oe EEA Heartbeat Request Confirmation 9 127 merge two calls 9 43 ReconnectHeldParty 9 55 Relinquish Call Control 9 59 Request Feature Confirmation capability info script 1 Capability Primitives Request Feature Request deactivating call feature for listing specified endpoint 9 132 purpose 9 132 Request Feature Request specified endpoint Route End 5 cause values Route Request logging Route iud End Reason codes Route Select references 11 3 change agent work mode feature request 5 send DTMFsignals 9 72 Cd characters Set Value Confirmation 9 146 Japanese Katakana Set Value Request item 9 148 Stop Call Notification Confirmation 9 125 i33 0 0 classification ASAI capabilities Stop Event Report specified call 9 123 clear call third party request 9 31 Third Party AnswerCall 5 13 clid file
339. trunks in use in the trunk group the number of trunks that are busied out for maintenance or the number of trunks that are unavailable for reasons other than maintenance Time of Day Requests the time of day specified in the following fields m Year specified as 2 decimal digits 00 99 m Month specified as 2 decimal digits 01 12 m Day specified as 2 decimal digits 01 31 m Hour specified as 2 decimal digits 00 23 m Minute specified as 2 decimal digits 00 59 Second specified as 2 decimal digits 00 59 ACD Agent Status Requests talk state of agent with respect to ACD split on call or idle or current work mode of agent manual in auto in after call work auxiliary work Station Status Requests talk state of extension on call or idle ACD Agent Login Audit Requests a list of agents currently logged into a split skill Party Identifier Requests list of party identifiers for the call or the extension number of each party to the call Issue 1 October 1996 5 37 ASAI Capabilities Notes Extension Requests the kind of extension number VDN ACD split announcement voice station ASAI other Calls Query Requests list of call identifiers for all calls present at the station extension list of party identifiers and identification of station extension on the call or list of endpoint call states alerting call initiated connected held unknown for each of the calls present at the s
340. ty Description This section describes the capability including its associated parameters Return Value This section gives the values returned by asai_send or asai_rcv when the capability is used in those functions Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This section is used to describe any exceptions caveats or usage suggestions pertaining to the capability See Also This section lists related capabilities and ASAI functions as appropriate In general it describes all the other capabilities in the appropriate capability group and toC EN REP The latter is included because Event Notification differs according to the release of ECS equipment in use Issue 1 October 1996 9 21 Programming Manual Pages C 3PAD 3ASAD Name C 3PAD Establish an auto dial Type Continuing Acknowledged Usage typedef struct asai common t asai common char called num user user t uudata long ofacility char ofac ext long prio call long ack flag char pool C DATSZ a3pad info t Description The client sends this capability to request the call between a third party domain controlled extension and another number A structure of type a3pad info t contains the third party call setup parameters The c 3PAD capability is a continuing capability FACility messaged used after C 3PDC REQ C_3PDC_REQ is described as an in
341. us 2 54 O product and software version printing purpose 3 1 IPCI board initializing softwarej2 34 _ ISDN program file printing status 2 36 Cd starting administration 2 29 sid taking off lineJ2 33 U testing Issue 1 October 1996 IN 5 Index IPCI o ipci_stat 1 X ipci_test 1 ipci_ver 1 ISDN product date of manufacture 2 ISDN software package file name isdn 11 r 1 isdn 12 r 1 isdn trace message trace capability 11 2 ISO characters description A 1 Cd ECS wide European characters support 5 38 wide European characters used for names 9 119 103 U ITT program execution 10 3 IVN installing ISDNlinks 1 2 00 ITT ASAI library test Japanese characters A L LAN Gatewa connection LAN Gateway link printing status 2 LAN Gateway links changing destination LAN Gateway messages tracing 2 27 LAN Gateway signal device driver communication file 2 57 LAN link activating alarms 2 50 0 deactivating alarms 2 50 0 destination changej2 51 1 11 IN 6 Issue 1 October 1996 lan stat 1 2 layer1and2 restatt 2 42 layer2 restart 2 43 oo lengfieldj5 28 library error messages 7 1 CSCS library function ASAI library function name 10 5 purpose 3 5 library functions puposej4 1 O typicalapplication 4 2 y library wei
342. uting request A structure of type rte info t contains the information needed to fulfill the request asai common The programmer sets the capability to C RT END and the primitive type to C REQU EST The programmer also sets the sao id also known as cluster id to identify the association in the route request cause value This parameter can be any of the following C AGT NOT SPLIT ME C CALLID TERM C FACUNSUB C INCOM ST C INVLDIE C INVLDNUM C MAND INFO C NOLOGIN ROTERR ESUNAVL IAL ER_UNIMP ERV_UNAVIL See Table 8 1 ASAI Library and DEFINITY ECS Cause Values for further information on cause values 9 136 Issue 1 October 1996 C_RT_END 3ASAI Return Value When this capability is used in an asai_rcv the function returns a nonnegative value when successful and 1 on failure A return value of 0 does not indicate an error it merely indicates that no data has been received Errors See Chapter 7 Error Messages for a list of error messages with brief explanations of their probable causes Notes This capability can be issued only by a client See Also asai rcv C RT REQ C RT SEL Issue 1 October 1996 9 137 Programming Manual Pages C RT REO BASAI Name C RT REQ Request a call route Type Initiating Acknowledged Usage typedef struct sai common t char plan type
343. ver an ASAI link An ASAI application can use the information provided by II Digits to properly route or provide special treatment for the incoming call This feature can also be used to prevent fraud II Digits will be populated in the Call Offered Alerting Connected Event Reports and in Route Request 27 Character Display The ASAl Accessed Integrated Directory query has been modified to return up to 27 characters for names when extensions are retrieved from the Integrated Directory of ECS Link version 3 must be negotiated between ECS and the adjunct for this enhancement to work otherwise only 15 characters will be passed International Standards Organization ISO certified optrex characters are also included in the ASAl Accessed Integrated Directory OPTREX Characters Some newer phones support escape sequences to display certain international characters CallVisor PC now provides this data in new fields in wide character format so that it can be processed by the standard functions that accompany the UNIX operating system Issue 1 October 1996 xiii About This Document How to Comment on This Document A reader comment card is provided at the end of this document While we have tried to make this document meet your needs we are interested in your suggestions for improving it and urge you to complete and return the reader comment card You may send additional comments to Lucent Technologies Product Documentation
344. wed version 1 4 value 11 4 R Reason codes xiii 9 114 9 155 Reconnect Held Party 9 55 Index Redirection Reason Codes 9 4107 09 Redirection Reason Type 9 158 related ASAlbooks xvi 1 1 OO release major release definition 9 2 minor release definition 9 2 Relinquish Call Controlj9 59 1 Oe removal of software commands 1 19 Request Feature capabilities group 5 40 Request Termination event notification request 9 94 requesting Event Notification 5 3 pond reserved parameter definition sample code Event Notification capabilities 4 15 SAO defintion 3 4 sd sao id parameterdefinition B 3 SCMA installing IPCI boards 1 2 scripts CVLAN test scripts 10 29 test files in ASCILJ104 1 1 Selective Listening xili 0 Send All Calls feature requesting Send DTMF signals 5 33 U send ret return value storage file 10 9 server type setting 47 Cd server definition 3 3 Cid service circuit 5 23 Cid service requests destination node 3 6 Set Value Confirmation 9 146 Set Value capabilities group shared memory addresses see SCMA signal files administering 2 30 signal7 2 57 9 A4 O Single Application Object see SAO software configuration steps 1 20 software configuration CVLAN 1 12 software
345. wer Call capability allows the client to request to answer a call on behalf of a station user The call can be a ringing bridged or held call that is present at a station Answering a ringing bridged or held call indicates to connect a call by forcing the station off hook if the user is on hook or cutting through the call to the head or handset if the user is off hook The effect is as if the station user selected the call appearance of the alerting bridged or held call and then went off hook The client invokes this capability by issuing a C 3PANS to which the server responds with a C_3PANS_CONF Third Party Answer Call confirmation After the acknowledgement the client continues to receive event reports for the answered call The Third Party Answer Call request is acknowledged by the server if it is able to connect the specified call by either forcing the station off hook turning the speakerphone on or waiting up to five seconds for the user to become off hook The server sends a C NEG ACK if the parameters of the request are invalid or if it cannot attempt the answer operation Request Confirmation Parameters Notes Call Identifier Indicates the alerting bridged or held call to be connected at the controlled station The Third Party Answer capability can be used to answer a call present at any station type that is analog DCP hybrid and BRI as long as the station is domain controlled A call which is already
346. were requested by the adjunct are not For example the G3V4 Event Reports Logout and Call Originated would not be sent if the adjunct had negotiated a version 1 G3V3 link but the adjunct could request the new Send DTMF Signals feature on G3V4 even under link version 1 This way the adjunct can still have access to the new functionality without being concerned about receiving unexpected ASAI messages In CallVisor QP HIGHERVER OK and QP LOWERVER OK have been changed to QP HIGHERVER and QP LOWERVER respectively The former represents boolean values used to allow or disallow support for other link versions They now represent a list of versions supported by the adjunct When necessary the CallVisor PC administration can limit the versions at which the protocol will run to meet their application s needs Three kernel tunables are used to negotiate the ASAI link version QP DESIRED VER the preferred version B QP_HIGHERVER the highest allowed version QP LOWERVER the lowest allowed version The version will be negotiated to the first acceptable one in the list First try qp ver then qp high then qp high 1 and finally qp low If ECS or CV PC does not support version control it will be negotiated as though the list contained only the lowest version that is 1 If the version negotiation fails there will be no error message and the link will not come up This can be diagnosed by running isdn trace and seeing restarts 08 02 00 0
347. with the UNIX operating system including advanced topics such as device polling through signals and unwaited I O and have at least a basic knowledge of the Integrated Services Digital Network ISDN In addition readers should be thoroughly familiar with DEFINITY ECS ASAI features and their restrictions Issue 1 October 1996 Reason for Reissue Reason for Reissue This section summarizes major enhancements for Release 5 of CallVisor ASAI PC Reason Codes ASAI will allow adjuncts to enter a reason code when an agent s work mode changes to AUX work or when an agent logs out In addition the adjunct can also guery for an agent s reason code status This feature must be optioned and it is mandatory that the AUX Work Reason Codes and the Agent Logout Reason Codes be set to forced or reguested ASAI Selective Listening This feature allows an ASAI adjunct application to disconnect or reconnect selected listening paths An application can use this feature to prevent one or more parties on a call from hearing communications among other parties on that call II Digits Il Digits provide information about the originating line For example these digits will indicate if the call is originating from a prison a cellular system a coin machine or special operator etc Il Digits are passed to DEFINITY ECS by the network on Integrated System Digital Network Primary Rate Interface ISDN PRI trunks and are then passed to the adjunct o
348. xit code Otherwise 0 is returned Notes When a board has reached the offline state it cannot be used for any signaling requests To place it back online it must be pumped Files dev isdn ipci command See Also command 7 ipci on 1 ipci stat 1 Issue 1 October 1996 2 33 Administration ipci_on 1 Name ipci_on Pump Software to IPCI Board s Synopsis ipci_on n Description ISDN software is placed on the IPCI board s and that software is initialized The board is then considered to be online If a value of n is specified only that board is addressed If no value of nis specified the software is sent to all IPCI boards and all IPCI boards are placed into the online state If n is used its value will be 1 2 3 or 4 Board numbers are assigned to the physical boards when the system administrator installs the software Operation First usr adm isdn boot bin the bootstrap loader is copied to the stream file dev isdn ipci command When this has been done successfully the IPCI streams device driver starts running this program on the board s Then usr adm isdn pcisdn bin the ISDN program is copied When this has been completed successfully the pcisdn bin program is started on the board s by the IPCI streams device driver Then the software on the boards is initialized Messages All of the following messages written by ipci_on are identified by a date and time stamp followed by the progra
349. y uudata The purpose of the user user information is to convey information between ISDN users This information is not interpreted by ECS but rather is carried transparently and delivered to the remote user If the info field is IA5 characters ASCII the string is null terminated The 1eng field is an integer value that indicates the number of octets of user data included in the request This field is set to O if no user user data is present Currently ECS will accept up to 32 bytes of data 1eng 32 If more than 32 bytes is specified an error will be returned ASAI supports a maximum user user data length of 32 bytes although user user data generated from a PRI trunk can be up to 127 bytes in length DEFINITY ECS will truncate this to 32 bytes before forwarding it to ASAI link The protocol field indicates the type of information and is restricted to C UU USER that indicates a user specific protocol or C UU 1A5 which indicates IA5 or ASCII characters The info field is a pointer to an ASCII string of no more that 32 characters in length ofacility This is an optional parameter that identifies the type of facility requested It can be C TRUNK GROUP C ACD SPLIT OrC NUSE LONG These values indicate a trunk group an ACD group or facility not used ofac ext The ofac ext parameter is a pointer to a null terminated character string that identifies the trunk access code of the trunk group or the ACD split extensio
350. y call where the primary voice path is disconnected but alternate paths remain for example through a third party on the call whose voice path to listener is not disconnected Interactions with Event Reports 5 20 This capability does not affect the state of any party on a call Issue 1 October 1996 Third Party Listen Reconnect Third Party Listen Reconnect Description The Third Party Listen Reconnect capability allows the client to reguest the server to reconnect a specified party the listener who was previously blocked from listening to one or more parties on a call via the Third Party Listen Disconnect capability The server sends a C_3PSL_RECONN_ACK in response to this request Primitive type C_POS_ACK indicates success C_NEG_ACK is used if the parameters of the request are invalid or if it cannot reconnect to listen Request Confirmation Parameters Depending on the conditions the request must specify the following parameters m Listener Party Identifier The party on the call to be listen reconnected to listening The request may also specify m Talker Party Identifier This parameter is specified to identify a specific party who will be listen reconnected If this parameter is omitted the listener will be listen reconnected to all other parties Notes The listener party must be connected on the call and should have been previously listen disconnected Interactions with Event Reports
351. ype num inque acd split ext pool C DATSZ asai common event name call id hold num hold type party id pool C DATSZ C EN REP 3ASAI CC EGE FE LL LS typedef struct asai common t long call id t char plan type t party id t char reconnect list t typedef struct asai common t long call id t party id t char initiate list t typedef struct asai common t long call id t char redirected list t typedef struct asai common t long char plan type t long char logout list t typedef struct asai common t long har har long char login list t C C typedef struct asai common t long call id t long asai common event name call id reconnect num recon type party id pool C DATSZ asai common event name call id party id pool C DATSZ asai common event name call id pool C DATSZ asai common event name extension ext type reason code pool C DATSZ asai common event name phys ext log ext work mode pool C DATSZ asai common event name call id drop cause Issue 1 October 1996 9 103 Programming Manual Pages char plan_type_t user_user_t party id t char drop list t typedef struct asai common t long call id t party id t char plan type t long char busy list t typedef struct a

Download Pdf Manuals

Related Search

Related Contents

Untitled    Samsung Samsung S3100 User Manual  Voici un mode d`emploi de votre messagerie du collège.  ハッピィ・マインダー  Formato Informe Cuatrimestral estado CI  NV Microlaser & NV Ortho User`s Manual  Eye-Pal Installation Guide    "取扱説明書"  

Copyright © All rights reserved. Failed to retrieve file