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

							ASAI Capabilities
Issue  3  May 1998
5-41
Request Feature Capabilities
The Request Feature capability group consists of the Request Feature capability 
and the two Abort capabilities which are common to all groups. The Abort 
capabilities are described later in this chapter.
Request Feature allows the client to request one of the following features:
nAgent login
nAgent logout
nChange Agent Work Mode
nCall Forwarding
nSend All Calls
Description
The Request Feature capability allows the client to request the 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-provided feature. The 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:
nActivate/Cancel Call Forwarding
— Forwarding Number
— Forwarded to Number
— Forwarding Type (Busy/no answer; No answer; Unconditional)
nACD Agent Log In/Log Out/Change Work Mode
— Split
—Work Flow
— Agent Identifier
—Mode
—Password
nActivate/Cancel Send All Calls
— Extension 
						

							ASAI Capabilities
5-42Issue  3  May 1998 
Notes
If a request to activate an already active feature is received or a request to cancel 
an 
already inactive feature, the server sends a positive acknowledgement. 
						

							ASAI Capabilities
Issue  3  May 1998
5-43
Adjunct Routing Capabilities
The Adjunct Routing capability group consists of the following capabilities:
nRouting
nRoute Select
nRoute 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. 
						

							ASAI Capabilities
5-44Issue  3  May 1998 
Routing
Description
The Routing capability allows the client to request 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_REQ to which the server 
responds with a C_RT_SEL 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_SEL capability to deny the client’s request. Figure 5-1 shows the 
actions for a client with an incoming call.
Figure 5-1. Routing an Incoming Call
The sequence of actions is as follows:
1. Incoming call to client
2. Route request issued by client
3. Route Select issued by server
4. Call routed by client
5. Route End issued by client
If the server rejects the request, the cause is indicated with the negative 
acknowledgement.
Client (ECS)Server (PC)ASAI Interface Route Request
Route Select
Route End
Incoming Call
Call Routed 
						

							ASAI Capabilities
Issue  3  May 1998
5-45
Request/Indication Parameters
nDestination Address — The called endpoint for which the route is needed
The following parameters are optional:
nOriginating Address — The endpoint on whose behalf the call is routed
nCall Setup — Details of incoming call (look-ahead interflow and 
user-entered code)
nCall Identifier — Identifier of the call to be routed
nOriginating Line Information (oli)— Identifies information indicator (II) 
digits received in the
 oli information element for the call.
nUser 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, the 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_IA5 which indicates IA5 or ASCII characters.
—info field — A pointer to an ASCII string of no more that 32 
characters in length.
nUniversal Call ID (ucid) — Identifier assigned by the ECS. 
Notes
There are no restrictions on this capability. 
						

							ASAI Capabilities
5-46Issue  3  May 1998 
Route Select
Description
The Route Select capability allows the server to respond to a client’s Route 
Request. 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_REQ 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
nDestination Address — The endpoint for which the route has been 
obtained.
The following parameters are optional:
nOriginating Address — The endpoint on whose behalf the call is to be 
routed (the value received in the Route Request or ‘‘not available”).
nCall Options — Any of the following:
— Priority Calling
— Direct Agent Call
— ACD Split Identifier
nUser-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, the 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_IA5 which indicates IA5 or ASCII characters.
—info field — A pointer to an ASCII string of no more that 32 
characters in length. 
						

							ASAI Capabilities
Issue  3  May 1998
5-47
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. 
						

							ASAI Capabilities
5-48Issue  3  May 1998 
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 unacknowledged 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. 
						

							ASAI Capabilities
Issue  3  May 1998
5-49
Maintenance Capabilities
Maintenance allows a client to request the Heartbeat capability. The Abort 
capability, described later in this chapter, is also part of this capability group. Both 
the ECS and the adjunct can issue a 
Heartbeat request. 
						

							ASAI Capabilities
5-50Issue  3  May 1998 
Heartbeat
Description
The Heartbeat capability allows the client to query the server for the status of the 
ASAI link. Heartbeat is a two-way capability; either the ECS or host computer can 
be the client and can send a heartbeat request.
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 request 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 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
There are no mandatory parameters associated with this capability.
Notes
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.