Lucent Technologies DEFINITY Enterprise Communications Server Release 5, CallVisor, ASAI Protocol Reference Instructions Manual

							Value Query Association
Issue 6  June 1997
2-45
Operation Value=Value Query, and
a parameter containing the Call Forwarding status (Status IE), 
a parameter containing the forwarded to extension (Redirection 
Number IE).
For coding, see ‘‘Response to Station Call Forwarding Status Query’’ on 
page 5-159 of Chapter 5, “Byte Level Messages.”
Station Status Query Procedure
The adjunct queries the ECS for status information on an extension.
1. The adjunct sends a REGister message to query for extension status. The 
message contains an invoke FIE with:
Operation Value = Value Query, and 
a parameter for extension (Domain IE).
For coding, see ‘‘Station Status Query’’ on page 5-141 of Chapter 5, “Byte 
Level Messages.”
2. The ECS replies with a RELease COMplete message containing a return 
result FIE with:
Operation Value = Value Query, and 
a parameter for the extension’s talk state (Domain IE).
For coding, see ‘‘Response to Station Status Query’’ on page 5-160 of 
Chapter 5, “Byte Level Messages.”
The Domain IE in a Station Status Query for an EAS agent may contain 
either the agent’s physical or logical extension.
Trunk Group Query Procedure
The adjunct queries the ECS for the number of idle/in-use trunks in a trunk group.
1. The adjunct sends a REGister message to query for trunk information. The 
message contains an invoke FIE with:
Operation Value = Value Query, and 
a parameter indicating the trunk group (Domain IE).
For coding, see ‘‘Trunk Group Status Query’’ on page 5-142 of Chapter 5, 
“Byte Level Messages.”
2.  The ECS replies with a RELease COMplete message containing a return 
result FIE with:
Operation Value = Value Query, and 
a parameter indicating the number of idle trunks and 
the number of trunks in use (Trunk Group Status IE).
For coding, see ‘‘Response to Trunk Status Query’’ on page 5-161 of 
Chapter 5, “Byte Level Messages.” 
						

							Messaging Sequences and ASAI
2-46Issue 6  June 1997 
Call Classifiers Query Procedure
The adjunct queries the ECS for the number of idle/in-use classifiers.
NOTE:
Starting with R5.5, if the USA Default Algorithm? field is set to n on the 
System Parameters OCM Call Classification form, the response to this 
query will provide the total number of ports for the TN744D and TN2182B 
boards (and any later versions) that are idle and in-use.This means that the 
response will not include any TN744C ports or earlier versions, nor will it 
include any TN2182 ports. If 
y is entered in this field, the query will provide 
the total number of idle and in-use ports for all the TN744 and TN2182 
boards.
1. The adjunct sends a REGister message to query for classifier information. 
The message contains an invoke FIE with:
Operation Value = Value Query, and 
a parameter for classifiers (Resource IE).
For coding, see ‘‘Call Classifiers Status Query’’ on page 5-143 of Chapter 
5, “Byte Level Messages.”
2. The ECS replies with a RELease COMplete message containing a return 
result FIE with:
Operation Value = Value Query, and 
a parameter indicating the number of classifiers in-use, and 
the number of classifiers that are idle (Resource Status IE).
For coding, see ‘‘Response to Number of Call Classifiers Query’’ on page 
5-162 of Chapter 5, “Byte Level Messages.”
Calls Query Procedure
The adjunct can use the Active Call Query to obtain information about calls at a 
station extension.
1. The adjunct sends a REGister message to query for active call information. 
The message contains an invoke FIE with:
Operation Value = Value Query, 
parameters for active calls (Item IE), and 
a station extension (Domain IE).
For coding, see ‘‘Call Information at Station Query’’ on page 5-146 of 
Chapter 5, “Byte Level Messages.”
2. The ECS replies with a RELease COMplete message containing a return 
result FIE with: 
						

							Value Query Association
Issue 6  June 1997
2-47
Operation Value = Value Query, and 
parameters containing a list of call_ids (Call Identifier IE), 
the party_id of the principal’s extension on the call (Party ID IE), and
the state of the principal’s extension on the call (Specific Event IE).
For coding, see ‘‘Response to Call Query’’ on page 5-163 of Chapter 5, 
“Byte Level Messages.”
The contents of the Facility IE, ‘‘Response to Call Query’’ on page 5-163 in 
Chapter 5, after the invoke identifier are present if and only if calls are 
present at the station. If no calls are present, the ECS responds with a 
RELease COMplete message containing the information upto and 
including the invoke identifier value from the request.
The Domain IE in a Calls Query procedure for an EAS agent may contain 
the agent’s physical or logical extension.
Party ID Query Procedure
The adjunct can use the Party ID Query to obtain information about the parties on 
a given call.
1. The adjunct sends a REGister message to query for party_id information. 
The message contains an invoke FIE with:
Operation Value = Value Query, and 
parameters for party_id query (Item IE) and 
a call_id (Call Identifier IE).
For coding, see ‘‘Party ID Information on Call Query’’ on page 5-147 of 
Chapter 5, “Byte Level Messages.”
2. The ECS replies with a RELease COMplete message containing a return 
result FIE with:
Operation Value = Value Query, and 
parameters containing a list of party ids (Party ID IE) and 
extensions (Connected Number IE).
For coding, see ‘‘Response to Party ID Query’’ on page 5-165 of Chapter 5, 
“Byte Level Messages.”
Extension Information Query Procedure
The adjunct can use the Extension Query to obtain information about a given 
extension.
1. The adjunct sends a REGister message to query for extension information. 
The message contains an invoke FIE with:
Operation Value = Value Query, and 
parameters for extension query (Item IE), and 
an extension (Calling Number IE). 
						

							Messaging Sequences and ASAI
2-48Issue 6  June 1997 
For coding, see ‘‘Extension Type/Class Information Query’’ on page 5-148 
of Chapter 5, “Byte Level Messages.”
2. The ECS replies with a RELease COMplete message containing a return 
result FIE with:
Operation Value = Value Query, and 
a parameter containing the extension type
16 [and the class of the
station]17 (Domain IE). 
For coding, see ‘‘Response to Extension Information Query’’ on page 
5-167 of Chapter 5, “Byte Level Messages.”
Agent Login Audit Procedure
The adjunct queries the ECS for information on the agents logged into a given 
ACD split.
1. The adjunct sends a REGister message with an invoke FIE containing:
Operation Value = Value Query, and 
parameters for an ACD split (Domain IE), and 
an agent login audit (Item IE).
For coding, see ‘‘ACD Agent Login Audit Query’’ on page 5-144 of Chapter 
5, “Byte Level Messages.”
2. If the request is successful, the ECS replies with a number of FACility 
messages, each with an invoke FIE containing:
Operation Value = Response Continued, and 
up to eight agent extensions (Domain IEs).
For coding, see ‘‘Response to Agent Login Query (List of Logged-in Agent 
Extensions)’’ on page 5-151 of Chapter 5, “Byte Level Messages.”
3. After the ECS has sent as many FACility messages as necessary to supply 
the agent information, it sends a RELease COMPlete message to 
terminate the association. The RELease COMPlete message contains a 
return result FIE. The invoke-id in the return result has the same value as 
the invoke-id in the original value query. For coding, see ‘‘Value Query: 
Acknowledgment — Association Terminates’’ on page 5-170 of Chapter 5, 
“Byte Level Messages.”
16. ACD split, VDN, announcement, data extension, (voice) station, ASAI, logical agent, and 
other.
17.If the type is station (voice), the address field indicates either “analog,” “BRI,” or 
“proprietary.” If the type is ASAI, the address field indicates “No Bearer Capabilities.” If the 
type is logical agent and if the agent is logged in, the address field indicates the physical 
extension of the agent 
						

							Value Query Association
Issue 6  June 1997
2-49
Integrated Directory Database Query Procedure
This query allows an application to pass the ECS an extension number and query 
for the corresponding name in the Integrated Directory database.
1. The adjunct sends a REGister message to query for an Integrated 
Directory name. The message contains an invoke FIE with:
Operation Value=Value Query, and 
parameters for 
a name database query (Domain IE), and 
an extension (Domain IE).
The domain type in the extension parameter must be for a type of 
extension that the Integrated Directory Database query feature supports 
(Hunt Group, Station, TAC, VDN, Announcement, Data Extension, Logical 
Agent).   However, the extension domain type does not have to match the 
actual type of the queried number (it just has to be one of the permitted 
values).
For coding, see ‘‘Integrated Directory Database Query’’ on page 5-149 of 
Chapter 5, “Byte Level Messages.”
2. The ECS replies with a RELease COMPlete message containing a return 
result FIE with:
Operation Value=Value Query; and 
parameters containing: 
the actual type and number of the queried extension (Domain IE), and 
the name (Data Item IE).
If there is no administered name, the ECS sends this message without the 
actual type and name.
For coding, see ‘‘Response to Integrated Directory Query’’ on page 5-169 
of Chapter 5, “Byte Level Messages.” 
						

							Messaging Sequences and ASAI
2-50Issue 6  June 1997 
Set Value Association
All set value requests are invocations of the ASAI Set Value Capability.
Activate Message Waiting Lamp Procedure
The adjunct turns on a message waiting lamp (MWL) at a given extension.
1. The adjunct sends a REGister message to light the MWL.
Operation Value = Set Value, and 
parameters for   
MWL Value (Item IE),   
Message waiting On (Status IE), and   
Extension (Called Party Number IE).
For coding, see ‘‘Activate Message Waiting Lamp Request’’ on page 5-177 
of Chapter 5, “Byte Level Messages.”
2. The ECS replies with a RELease COMplete message containing a return 
result FIE. The invoke-id in the return result has the same value as the 
invoke-id in the request. 
For coding, see ‘‘Set Value: RELease COMplete Messages Sent by the 
switch’’ on page 5-182 of Chapter 5, “Byte Level Messages.”
Deactivate Message Waiting Lamp Procedure
The adjunct turns off a MWL at a given extension.
1. The adjunct sends a REGister message to extinguish a MWL. The 
message contains an invoke FIE with:
Operation Value = Set Value, 
parameters for    
MWL Value (Item IE)   
Message waiting off (Status IE), and   
Extension (Called Party Number IE).
For coding, see ‘‘Deactivate Message Waiting Lamp Request’’ on page 
5-178 of Chapter 5, “Byte Level Messages.”
2. The ECS replies with a RELease COMplete message containing a return 
result FIE. The invoke-id in the return result has the same value as the 
invoke-id in the request. For coding, see ‘‘Set Value: RELease COMplete 
Messages Sent by the switch’’ on page 5-182 of Chapter 5, “Byte Level 
Messages.” 
						

							Set Value Association
Issue 6  June 1997
2-51
Billing Change Request Procedure
The adjunct requests a billing change for a given call.
1. The adjunct sends a REGister message to request a billing change. The 
message contains an invoke FIE with:
Operation Value = Set Value, and 
parameters for   
Flexible Billing (Item IE)   
Call ID (Call Identity IE)   
Billing request type and amount (Generic Billing IE)
For coding, see ‘‘Billing Change Request’’ on page 5-179 of Chapter 5, 
“Byte Level Messages.”
2. The ECS replies with a RELease COMplete message containing a return 
result FIE. The invoke-id in the return result has the same value as the 
invoke-id in the request. For coding, see ‘‘Set Value: RELease COMplete 
Messages Sent by the switch’’ on page 5-182 of Chapter 5, “Byte Level 
Messages.”  
						

							Messaging Sequences and ASAI
2-52Issue 6  June 1997 
Ending an ASAI Association
An ASAI endpoint terminates an association for the following reasons:
nThe ASAI messaging procedure terminates normally. The endpoint sends 
the RELease COMplete message prescribed by the messaging procedure 
for the type of association that is in progress. ASAI procedures use 
RELease COMplete messages containing either (or both) an FIE and/or 
Cause IE. The FIE carries an Invoke, Return Result, or Return Error 
component. The messaging procedures for any given type of association 
determine the message used for termination.
nThe endpoint must deny the requested operation. The endpoint 
understands the message, parses and understands the FIE, but the 
service request is invalid, the parameters are invalid, or the endpoint must 
deny service for some other reason. The ECS sends this message only as 
the first response to an ASAI request; otherwise it aborts the ongoing 
association.
nThe endpoint must abort an ongoing association. The endpoint has begun 
to service an ASAI request, but cannot process it further.
nThe endpoint cannot parse an FIE. The endpoint understands the 
message, detects an FIE within the message, but a protocol violation exists 
within the FIE.
nThe endpoint cannot parse a layer 3 message. Message Parsing may fail in 
a number of ways.
If the adjunct passes Return Error or Reject components to the ECS in a FACility 
or REGister message, the ECS aborts the association on that CRV.
NOTE:
If a valid request is made by an adjunct over an incorrect association, the 
ECS terminates that association (sends a RELease COMplete).
Endpoint Denies a Request
When an endpoint receives a request for a service that is permitted in the present 
ASAI context, but cannot provide the service for some reason (such as an invalid 
value for a request parameter), it responds with a message containing an FIE with 
a Return Error component, Operation Value = the Operation Value from the FIE 
being denied, and an optional reason for the denial (Cause IE). The return error 
response must be the first response to the request. For coding, see ‘‘Call Control: 
Request is Denied — Association Terminated’’ on page 5-64 of Chapter 5, “Byte 
Level Messages.”
The denial may be carried in:
nA FACility message if the denying endpoint allows the association to 
continue. The ECS may use a FACility message for a denial of: 
						

							Ending an ASAI Association
Issue 6  June 1997
2-53
— The Call Control capabilities (Third Party Hold, Third Party Drop, 
Third Party Merge, Third Party Reconnect, and Third Party 
Relinquish control).
— The Stop Notification capability request within a Notification 
association.
— The Auto Dial capability in a Domain (Station) Control association.
nA RELease COMplete message if the denying endpoint does not allow the 
association to continue. The ECS always uses a RELease COMplete 
message for any denial of all other requests.
The ECS expects any adjunct denials to terminate the association. If the ECS 
receives a Return Error component in a FACility message, then the ECS sends a 
RELease COMplete message and aborts the association.
The ECS sends a denial if an Invoke FIE contains ASAI parameters that are 
incompatible with one another. Determination of incompatible parameters is 
capability-specific.
When the ECS is overloaded it may deny initiating requests (REGister messages) 
and return a Cause of CS0/42, “ECS equipment congested.” This cause is 
returned inside the Facility IE in the same way as any other denial.
An adjunct may also make a request for a service not provisioned on the ECS. 
The ECS responds with a denial containing a Cause of CS0/50, “requested facility 
not subscribed.” This cause is returned inside the Facility IE in the same way as 
any other denial.
If Flexible Billing is not allowed for a call, the ECS responds with a denial 
containing a cause of CS0/29 (Facility Reject) or CS0/98 (Message not 
Compatible with Call State).
The ECS may also return the Return Error component in a FACility message 
when it denies a request within a Call Control association, Domain (Station) 
Control association, or Notification association and the association is to continue. 
For call control coding, see ‘‘Call Control: Request is Denied — Association 
Continues’’ on page 5-62 of Chapter 5, “Byte Level Messages.” For domain 
control coding, see ‘‘Domain Control: Request is Denied — Association 
Continues’’ on page 5-90 of Chapter 5, “Byte Level Messages.”
Endpoint Application Level Software Aborts
ASAI Processing
Either the ECS or adjunct may abort an ASAI association at any time. An ASAI 
endpoint must be prepared to receive an abort at any time. To abort an 
association, the endpoint sends a RELease COMplete message. The message  
						

							Messaging Sequences and ASAI
2-54Issue 6  June 1997 
contains: invoke FIE with Operation Value = Abort, and an optional cause (Cause 
IE). The ECS always supplies a cause when it aborts an association. The abort 
mechanism may be used:
nWhen internal constraints within the ASAI endpoint terminate processing;
nWhen a capability request is made on the wrong type of association;
nWhen an error, unexpected, or abnormal condition occurs within the ASAI 
endpoint that terminates processing.
Special cases include the following:
nThe ECS always expects to receive Reject and Return Error components 
from the adjunct in RELease COMplete messages. If an adjunct sends one 
of the components in a FACility message, then the ECS aborts the 
association.
nThe ECS aborts an association if it receives a message with an 
unexpected or unrecognized Operation Value. The ECS sends a RELease 
COMplete message containing an FIE with a Invoke component. The 
Invoke component contains a cause CS0/111 (protocol error). An example 
is the denial of a capability that is not provided within the context of the 
requesting association, such as a request for Third Party Clear Call 
capability in a Notification Association.
The ECS uses the abort mechanism to terminate Third Party Call Control 
associations that must halt because ECS processing encounters conditions such 
as invalid Class of Restriction.
Endpoint Rejects FIE
An ASAI endpoint may use the Reject component to reject an FIE that is badly 
structured or violates protocol. An ASAI endpoint may use18 the Reject 
component when it is able to determine the message type, CRV, and the presence 
of an FIE within a message, but the contents of the FIE violate protocol for some 
reason. The Reject component contains a problem code that specifies the 
protocol violation within the FIE. ASAI permits the rejecting endpoint to send the 
Reject component in either: 
nA FACility message if the rejecting endpoint permits the requesting 
endpoint to continue the association and retry
nA RELease COMplete message if the rejecting endpoint terminates the 
association when an FIE protocol error occurs
Of these options, the ECS always sends any Reject component in a RELease 
COMplete message and terminates any association where an FIE protocol 
violation occurs. The ECS does not permit the adjunct to retry within the same 
association after an FIE protocol violation. For coding, see ‘‘Call Control: Endpoint 
18. It may also abort or return an empty RELease COMplete message.