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

							Routing Association Procedure
Issue 6  June 1997
2-35
[User-to-User Information] (User-User IE), 
[ASAI-provided digits] (User Code IE),
[collect digits request] (User Code IE)
12, and
[event to terminate digit collection] (specific event IE).
For coding, see ‘‘Call Route Selection’’ on page 5-112 of Chapter 5, 
“Byte Level Messages.”
b. If the adjunct denies the request, it responds with a RELease 
COMplete message containing a return error FIE with Operation 
Value = Route, and a cause (Cause IE). In this case, the Step 
following the “adjunct route” step is skipped. For coding, see 
‘‘Routing: Request is Denied — Association Terminated’’ on page 
5-115 of Chapter 5, “Byte Level Messages.”
3. The ECS sends a Route End within a RELease COMplete message to 
terminate the routing association. The ECS sends this message in one of 
three ways:
a. The ECS responds to a Route Select. The RELease COMplete 
message contains an invoke FIE with:
Operation Value = Route End and 
a cause (Cause IE).
The Cause is “normal termination” if the ECS accepted and
used the adjunct-supplied route; the cause is “invalid number”
if the ECS could not use the route.
For coding, see ‘‘End Adjunct Routing’’ on page 5-116 of Chapter 5, 
“Byte Level Messages.”
b. The adjunct supplied an invalid route in the route select message: 
The RELease COMplete message contains an invoke FIE with:
Operation Value = Route End and 
a cause (Cause IE).
The Cause may be, for example, “bad permissions,” 
“agent not a member of split,” or “destination busy.”
For coding, see ‘‘End Adjunct Routing’’ on page 5-116 of Chapter 5, 
“Byte Level Messages.”
c. The adjunct has not supplied a route within the allotted time and the 
ECS terminates the routing association. The ECS sends a RELease 
COMplete message to terminate the association. The cause is 
“Recovery on Timer Expiry.” After the ECS sends the Route End 
message, any Route Select received from the adjunct for this 
association is ignored. (It is treated as a protocol error but the call is 
not affected.) 
12.An application may either request digit collection or provide digits, but not both. The “event 
to release tone detection” is optional for digit collection and is not present for “provide 
digits.” 
						

							Messaging Sequences and ASAI
2-36Issue 6  June 1997 
An adjunct may always abort a routing association to terminate that 
association. 
						

							Request Feature Association
Issue 6  June 1997
2-37
Request Feature Association
All feature requests are invocations of the ASAI Feature Request Capability. An 
adjunct should be prepared to accept an ECS denial of any feature request.
Agent Login Procedure
The adjunct logs an agent into a given ACD split/skill.
1. To request an agent login, the adjunct sends a REGister message with an 
invoke FIE containing:
Operation Value = feature request, and 
parameters for 
login feature (Feature IE), 
login identifier (User Code IE), 
ACD split (Domain IE), 
agent extension (Domain IE), and 
[initial work mode] (Domain IE).
For coding, see ‘‘Agent Login Request’’ on page 5-120 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 feature request. For coding, see ‘‘Request Feature: 
Acknowledgment — Association Terminates’’ on page 5-132 of Chapter 5, 
“Byte Level Messages.”
When logging in EAS Agents, the following also apply:
nThe User Entered Code IE contains both the agent’s password and 
the login_id, separated by a “#.”
nThe split parameter must be present in the message as it is a   
mandatory ASAI parameter. (Since the EAS agents’ skill 
assignments are administered on the ECS, the system ignores the 
parameters in an EAS environment.) 
nThe Domain IE must contain the agent’s physical (not logical) 
extension. 
						

							Messaging Sequences and ASAI
2-38Issue 6  June 1997 
Agent Logout Procedure
The adjunct logs an agent out of a given ACD split/skill.
1. To request an agent logout, the adjunct sends a REGister message with an 
invoke FIE containing:
Operation Value = feature request, and 
parameters for 
logout feature (Feature IE), 
ACD split (Domain IE), 
agent extension (Domain IE), and
[reason code
13] (Domain IE).
For coding, see ‘‘Agent Logout Request’’ on page 5-122 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 feature request. For coding, see ‘‘Request Feature: 
Acknowledgment — Association Terminates’’ on page 5-132 of Chapter 5, 
“Byte Level Messages.”
When logging out EAS agents, the agent extension (Domain IE) may 
contain either the agent’s physical extension or logical extension.
Agent Work Mode Change Procedure
The adjunct changes an ACD agent work mode on a given split.
1. The adjunct sends a REGister message to request change of work mode. 
The message contains an invoke FIE with:
Operation Value = feature request, and 
parameters for 
work mode change (Feature IE), 
ACD split (Domain IE), 
agent extension (Domain IE), 
new work mode (Domain IE), and
[reason code
14] (Domain IE).
For coding, see ‘‘Change Agent Work Mode Request’’ on page 5-124 of 
Chapter 5, ‘‘Byte Level Messages.”
13. This IE is included only if the System-Parameters features field, Logout Reason Codes is 
“forced” or “requested,” otherwise the ECS ignores the IE.
14. This IE is included only if the new work mode value is Auxiliary Work and the 
System-Parameters features field, AUX Reason Codes is “forced” or “requested,” otherwise 
the ECS ignores the IE. 
						

							Request Feature Association
Issue 6  June 1997
2-39
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 feature request. For coding, see ‘‘Request Feature: 
Acknowledgment — Association Terminates’’ on page 5-132 of Chapter 5, 
“Byte Level Messages.”
When changing work mode for EAS Agents, the following also applies:
nThe split parameter must be present as it is a mandatory ASAI 
parameter. (Since the EAS agents’ skill assignments are 
administered on the ECS, the system ignores the parameters in an 
EAS environment.) 
nThe Domain IE may contain either the agent’s physical or logical 
extension. 
nThe new work mode applies to all the agent skills.
Call Forwarding Activation Procedure
The adjunct requests that forwarding be activated from a given local station 
extension to another number (possibly external to the ECS).
1. The adjunct sends a REGister message to request forwarding activation. 
The message contains an invoke FIE with:
Operation Value = feature request, and 
parameters for forwarding activation (Feature IE), 
forwarding extension with unconditional forwarding    
(Redirecting IE without optional byte 4), and 
destination for the calls (Redirection IE without optional byte 4).
For coding, see ‘‘Call Forwarding Feature Activation’’ on page 5-128 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 feature request.
For coding, see ‘‘Request Feature: Acknowledgment — Association 
Terminates’’ on page 5-132 of Chapter 5, “Byte Level Messages.”
If the feature cannot be activated, the ECS responds with a denial 
message containing a cause. For coding, see ‘‘Request is Denied — 
Association Terminated’’ on page 5-131 of Chapter 5, “Byte Level 
Messages.” 
						

							Messaging Sequences and ASAI
2-40Issue 6  June 1997 
Call Forwarding Cancel Procedure
The adjunct requests that forwarding be canceled from a given local station 
extension.
1. The adjunct sends a REGister message to request forwarding cancel.
The message contains an invoke FIE with:
Operation Value = feature request, and 
parameters for forwarding cancel (Feature IE) and 
forwarding extension (Redirecting IE without optional byte 4).
For coding, see ‘‘Cancel Call Forwarding Feature Activation’’ on page 
5-129 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 feature request.
For coding, see ‘‘Request Feature: Acknowledgment — Association 
Terminates’’ on page 5-132 of Chapter 5, “Byte Level Messages.”
If the feature cannot be canceled, the ECS responds with a denial 
message containing a cause. For coding, see ‘‘Request is Denied — 
Association Terminated’’ on page 5-131 of Chapter 5, “Byte Level 
Messages.”
Send All Calls Activation Procedure
The adjunct requests that Send All Calls be activated for a given local station 
extension.
1. The adjunct sends a REGister message to request Send All Calls. The 
message contains an invoke FIE with:
Operation Value = feature request, and 
parameters for Send All Calls (Feature IE) and 
station extension (Redirecting IE without optional byte 4).
For coding, see ‘‘Send All Calls Feature Activation’’ on page 5-126 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 feature request.
For coding, see ‘‘Request Feature: Acknowledgment — Association 
Terminates’’ on page 5-132 of Chapter 5, “Byte Level Messages.” 
If the feature cannot be activated, the ECS responds with a denial 
message containing a cause. For coding, see ‘‘Request is Denied — 
Association Terminated’’ on page 5-131 of Chapter 5, “Byte Level 
Messages.” 
						

							Request Feature Association
Issue 6  June 1997
2-41
Cancel Send All Calls Procedure
The adjunct requests that Send All Calls be canceled for a given local station 
extension.
1. The adjunct sends a REGister message to request forwarding cancel. The 
message contains an invoke FIE with:
Operation Value = feature request, and 
parameters for cancelling Send All Calls (Feature IE) and 
station extension (Redirecting IE without optional byte 4).
For coding, see ‘‘Cancel Send All Calls Feature Activation’’ on page 5-127 
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 feature request. 
For coding, see ‘‘Request Feature: Acknowledgment — Association 
Terminates’’ on page 5-132 of Chapter 5, “Byte Level Messages.”
If the feature cannot be canceled, the ECS responds with a denial 
message containing a cause. For coding, see ‘‘Request is Denied — 
Association Terminated’’ on page 5-131 of Chapter 5, “Byte Level 
Messages.” 
						

							Messaging Sequences and ASAI
2-42Issue 6  June 1997 
Value Query Association
All value queries are invocations of the ASAI Value Query capability. An adjunct 
should be prepared to accept the ECS’s denial to a value query.
Date/Time Query Procedure
The adjunct queries the ECS for its current date and time.
1. The adjunct sends a REGister message to query for date/time. The 
message contains an invoke FIE with:
Operation Value = Value Query, and 
a parameter for date/time (Item IE).
For coding, see ‘‘Date/Time Query’’ on page 5-145 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 
the date and time (Date/Time IE).
For coding, see ‘‘Response to Date/Time Query’’ on page 5-168 of 
Chapter 5, “Byte Level Messages.”
Split Status Query Procedure
The adjunct queries the ECS for status information on an ACD split.
1. The adjunct sends a REGister message to query for split status. The 
message contains an invoke IE with:
Operation Value = Value Query, and 
a parameter for ACD split (Domain IE).
For coding, see ‘‘ACD Split Status Query’’ on page 5-136 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, 
the number of calls in the ACD queue (Counter IE), 
the number of agents logged into the split (Counter IE), and 
the number of available agents (Counter IE).
For coding, see ‘‘Response to ACD Split Status Query’’ on page 5-153 of 
Chapter 5, “Byte Level Messages.” 
						

							Value Query Association
Issue 6  June 1997
2-43
Agent Status Query Procedure
The adjunct queries the ECS for status information on an agent in an ACD split.
1. The adjunct sends a REGister message to query for agent status with an 
invoke FIE containing: 
Operation Value = Value Query, and 
parameters for ACD split (Domain IE) and 
agent 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, 
the agent’s work state (Domain IE), and 
the agent’s talk state (Domain IE), and the
[reason code] (Domain IE)
15.
For coding, see ‘‘Response to Agent Status Query’’ on page 5-155 of 
Chapter 5, “Byte Level Messages.”
In a query for an EAS agent, the agent extension Domain IE may contain 
either the agent’s physical or logical extension. The Split parameter 
(Domain IE) must be present since it is a mandatory ASAI IE. The ECS 
ignores the contents of the split parameter for EAS agents in Skills.
Station MWL Status Query Procedure
The adjunct can use the Message Waiting Lamp Status Query to obtain 
information about the ON/OFF status of the Message Waiting Lamp at a given 
extension. The query response breaks down which messaging services have an 
ON/OFF setting in the ECS.
1. The adjunct sends a REGister message to query for Message Waiting 
Lamp Status.
The message contains an invoke FIE with:
Operation Value=Value Query, and 
parameters for Message Waiting Lamp Status query (Item IE), and 
an extension (Calling Number IE).
For coding, see ‘‘Station Feature Query — Message Waiting Lamp’’ on 
page 5-138 of Chapter 5, “Byte Level Messages.”
15. This IE will be only included in the response if the System-Parameter Features field, AUX 
Reason Codes, is “forced” or “requested,” and the Agent’s Work State is Auxiliary. 
						

							Messaging Sequences and ASAI
2-44Issue 6  June 1997 
2. The ECS replies with a RELease COMplete message containing a return 
result FIE with:
Operation Value=Value Query, and 
a parameter containing the MWL status for the messaging services
(Status IE).
For coding, see ‘‘Response to Station Message Waiting Lamp Status 
Query’’ on page 5-157 of Chapter 5, “Byte Level Messages.”
Station Send-All-Calls Query Procedure
The adjunct can use the Send All Calls Status Query to obtain information about 
the ON/OFF status of the Send All Calls feature at a given extension. 
1. The adjunct sends a REGister message to query for Send All Calls Status. 
The message contains an invoke FIE with:
Operation Value=Value Query, and 
parameters for the Send All Calls Status query (Feature IE) and 
an extension (Calling Number IE).
For coding, see ‘‘Station Feature Query — Send All Calls’’ on page 5-139 
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 Send All Calls status (Status IE).
For coding, see ‘‘Response to Station Send-All-Calls Status Query’’ on 
page 5-158 of Chapter 5, “Byte Level Messages.
Station Call Forwarding Status Query Procedure
The adjunct can use the Call Forwarding Status Query to obtain information about 
the ON/OFF status of the Call Forwarding feature at a given extension. When the 
feature is active at the station, the response returns the number where the ECS 
will forward calls. 
1. The adjunct sends a REGister message to query for Call Forwarding 
Status. The message contains an invoke FIE with:
Operation Value=Value Query, and 
parameters for Call Forwarding Status query (Feature IE) and 
an extension (Calling Number IE).
For coding, see ‘‘Station Feature Query — Call Forwarding’’ on page 5-140 
of Chapter 5, “Byte Level Messages.”
2. The ECS replies with a RELease COMplete message containing a return 
result FIE with: