Lucent Technologies DEFINITY Enterprise Communications Server Release 6 CallVisor PC ASAI Instructions Manual

							Programming Manual Pages
Issue  3  May 1998
9-169
Notes
This capability can be issued only by a server.
See Also
asai_rcv()
C_VQ_REQ C_VQ_RESP 
						

							Programming Manual Pages
9-170Issue  3  May 1998 
C_VQ_REQ (3ASAI)
Name
C_VQ_REQ — Request information about status or value of a service or feature 
within the domain of the provider
Ty p e
Initiating — Acknowledged
Usage
typedef struct{
asai_common_t asai_common;
long vq_item;
char *split_ext;
char pool[C_DATSZ];
}vq_split_stat_t;
typedefstruct{
asai_common_t asai_common;
long vq_item;
char *tg_ext;
char pool[C_DATSZ];
}vq_tg_stat_t;
typedef struct{
asai_common_t asai_common;
long vq_item;
char *split_ext;
char *agt_ext;
char pool[C_DATSZ];
}vq_agt_stat_t;
typedef struct{
asai_common_t asai_common;
long vq_item;
char *extension;
char pool[C_DATSZ];
}vq_station_t;
typedef struct{
asai_common_t asai_common;
long vq_item;
char *split_ext;
char pool[C_DATSZ];
}vq_agt_aud_t; 
						

							Programming Manual Pages
Issue  3  May 1998
9-171
typedef struct{
asai_common_t asai_common;
long vq_item;
char *extension;
char pool[C_DATSZ];
}vq_cal_stat_t;
typedef struct{
asai_common_t asai_common;
long vq_item;
call_id_t call_id;
char pool[C_DATSZ];
}vq_pty_stat_t;
typedef struct{
asai_common_t asai_common;
long vq_item;
char *extension;
char pool[C_DATSZ];
}vq_ext_stat_t;
typedef struct{
asai_common_t asai_common;
long vq_item;
char *extension;
char pool[C_DATSZ];
}vq_mwi_stat_t;
typedef struct{
asai_common_t asai_common;
long vq_item;
char *extension;
char pool[C_DATSZ];
}vq_sac_stat_t;
typedef struct{
asai_common_t asai_common;
long vq_item;
char *extension;
char pool[C_DATSZ];
}vq_scf_stat_t;
typedef struct{
asai_common_t asai_common;
long vq_item;
long domain_type;
char *extension;
char pool[C_DATSZ];
}vq_aaid_t; 
						

							Programming Manual Pages
9-172Issue  3  May 1998 
typedef struct{
asai_common_t asai_common;
long vq_item;
call_id_t call_id;
char pool[C_DATSZ];
}vq_ucid_t;                                /* 63V6 */
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_aud;
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_ucid_t     vqc_ucid_req;  /* G3V6 */
}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 vq_common. The programmer 
sets the capability to C_VQ_REQ and the primitive_type to C_REQUEST. 
The programmer also sets the sao_id (also known as cluster_id).
The parameter vq_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 , 
C_SCF_STAT, C_AAID, or C_UCID.(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 status, station call forwarding, name associated with the 
extension number, or Universal Call ID.) 
						

							Programming Manual Pages
Issue  3  May 1998
9-173
The parameters contained in the vq_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 vq_item value, the associated vq_buf union 
member, the information contained in the member, and a description of the 
information. Mandatory information is indicated with an asterisk (*).
Table 9-5. Associated Items and Descriptions for C_VQ_REQ 
Item Typevq_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 program-specific information.  
See ‘‘Pool’’ on page 8-15 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. See C_ACDSPT_STAT.
C_AGT_STAT vq_agt_stat split_ext
. See C_ACDSPT_STAT.
agt_ext is a pointer to a null-terminated string 
specifying the extension of the ACD agent.
pool. See C_ACDSPT_STAT.
C_STATION vq_station extension is a pointer to a null-terminated string 
specifying the end point extension number.
pool. See C_ACDSPT_STAT.
C_AGTLOGIN_AUD vq_agt_aud split_ext. See C_ACDSPT_STAT.
pool. See C_ACDSPT_STAT.
C_CAL_STAT vq_cal_stat extension. See C_STATION.
pool. See C_ACDSPT_STAT.
C_PTY_STAT vq_pty_stat call_id is a structure in which the parameterid_length specifies the length of ECS-assigned call 
identifier and
 id_ptr points to a character string that 
specifies that call identifier.
pool. See C_ACDSPT_STAT.
C_EXT_STAT vq_ext_stat extension. See C_STATION.
pool. See C_ACDSPT_STAT.
C_MWI_STAT vq_mwi_stat extension. See C_STATION.
pool. See C_ACDSPT_STAT. 
						

							Programming Manual Pages
9-174Issue  3  May 1998 
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_VQ_RESP C_VQ_CONF C_SAC_STAT vq_sac_stat extension
. See C_STATION.
pool. See C_ACDSPT_STAT.
C_SCF_STAT vq_scf_stat extension. See C_STATION.
pool. See C_ACDSPT_STAT.
C_CLASS_STATnone (no additional items)
C_TIME_OF_DAYnone(no additional items)
C_AAIDdomain_type is a pointer to a null-terminated string 
specifying the ACD split extension number or the split 
number.
extension is a pointer to a null-terminated string 
specifying the end point extension number.
pool. See C_ACDSPT_STAT.
C_UCID call_id is 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. See C_ACDSPT_STAT.
Table 9-5. Associated Items and Descriptions for C_VQ_REQ  — Continued
Item Typevq_buf Member Description 
						

							Programming Manual Pages
Issue  3  May 1998
9-175
C_VQ_RESP (3ASAI)
Name
C_VQ_RESP — Respond to a value query request
Ty p e
Continuing — Unacknowledged
Usage
typedef struct{
asai_common_t asai_common;
long vqr_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 vqr_item;
}vqr_common_t;
typedef union{
vqr_common_t vqr_common;
vqr_agtaud_t vqr_agtaud;
}vqr_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) of the request is also returned.
The parameter vqr_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.  
						

							Programming Manual Pages
9-176Issue  3  May 1998 
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()
C_VQ_REQ C_VQ_CONF
Table 9-6. Associated Items and Descriptions for C_VQ_RESP 
Item Typevqr_buf Member Description
C_AGTLOGIN_
AUDvqr_agtaud 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 to by 
agtext_list.
pool is a character array that provides buffer space for the 
ASAI library to store program-specific information. See 
‘‘Pool’’ on page 8-15 in Chapter 8, ‘‘ASAI Capability 
Primitives’’ for more information. 
						

							Issue  3  May 199810-1
10
Te s t i n g
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 on page 10-1 for ITT 
structure.
Figure 10-1. Integration Test Tool — Overview
script
answers
fd
ASAI
LibraryIntegration
Te s t
To o l
User
DEFINITY ECS  
						

							Testing
10-2Issue  3  May 1998 
Terminology
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 scriptIf 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).