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

							Codeset 6 Information Elements
Issue 6  June 1997
4-75
Status BitsWhen the In-use, Idle, Maintenance-busy, and 
Other-unavailable status bits are set to 1, a binary-encoded 
count corresponding to that status follows.
CountsBytes containing counts correlate with the status bits: The 
first count byte conveys the count for the highest order status 
bit set to 1. Typically, this is the “In-use” count, but it could be 
the idle count (for example). Subsequent bytes convey the 
counts for the next highest order status bit set to 1. Bytes 4 
through 7 are extended to accommodate counts greater than 
128. 
The ECS typically returns counts for the trunks in use and 
the idle trunks. The adjunct may sum these two counts to 
calculate the trunks in service in the trunk group. Refer to the 
DEFINITY Enterprise Communications Server Feature 
Description
 (555-230-301) for specifics on the ECS running 
ASAI to determine the maximum values for the parameters 
encoded in the Value field. This determines the maximum 
number of bytes used to encode the information. This 
number varies from ECS to ECS. Hosts should operate with 
the maximum values for the largest ECS on which they will 
be running. 
						

							Information Elements
4-76Issue 6  June 1997 
User-Entered Code
The User-Entered Code IE shown in Figure 4-41 conveys user-entered 
information (for example, authorization codes or call prompter data).
Figure 4-41. User-Entered Code Information Element
NE
8  7 6 54321
User-Entered Code
0  0 0 00010Byte1
Information element identifier
Length of User-Entered Code contents 2
1
Ext.Type of User Code 3
1
Ext.Collect/
Collected Timeout Interval 4
0/1           
Ext. User Code Data 5,...,      n
ASAI EncodingsBits
for Type of User7 6 5 4 3 2 1
Code:0 0 0 0 0 0 0 Any NOT USED
0 0 0 0 0 0 1 Reserved
0 0 0 0 0 1 0 Login Digits
0 0 0 0 0 1 1 Reserved
0 0 0 0 1 0 0 Reserved
0 0 0 0 1 0 1 Call Prompter
0 0 1 0 0 0 1 Customer-provided
0 0 1 0 0 1 0 Application
0 1 0 0 0 0 0 Tone Detector
Collect/CollectedBits
Indication7 6
0 0  Collect Digits. The following byte contains the 
number to be collected. (DEFINITY ECS 
maximum =24.)
The following bytes contain user-entered 
digits. 1 0  
						

							Codeset 6 Information Elements
Issue 6  June 1997
4-77
Timeout IntervalThe interval for digit collection (in seconds) 
once DEFINITY ECS has received the first digit 
(0-63 sec). Encode as all zeros if no timeout is 
to be used. 
User Code DataThe user-entered data is encoded in ASCII 
characters. The ECS sends up to 24 bytes of 
user code data (including * and #). 
When the User-Entered Code carries 
information to log in an agent where EAS is 
activated, then the IE contains both the agent’s 
EAS login ID and password. These are 
separated by a “#” character. If the password 
has fewer digits than what’s administered on 
the ECS, you must provide a leading “0.” 
When the type of user code indicates tone 
detection and the collect/collected field 
indicates collect, then this field contains a 
binary value giving the number of digits to be 
collected. The current maximum is 24. 
						

							Information Elements
4-78Issue 6  June 1997 
Version
The Version IE shown in Figure 4-42 conveys the ASAI protocol version used on a 
specified ASAI link. It may be repeated in the RESTART message to the adjunct in 
the case where the ECS supports multiple versions. The RESTart 
Acknowledgement message can also contain this IE.
Figure 4-42. Version Information Element
Version Value (Octet 3)
Identifier (Octet 4, etc.)
The identifier need not be present. For CallVisor for Unix System V 
(PC/ASAI), this is a 4-octet value.8  7654321
Version
0  0011011Octet1
Information element identifier
Length of Version contents 2
1
Version Value 3
Ext
0/1
Identifier     4*, etc.
Ext
Bits
7654321
0000000 Reserved
0000001 ASAI Version 1
0000010 ASAI Version 2
0000011 ASAI Version 3 
						

							Issue 6  June 19975-1
5
Byte Level Messages
This chapter provides the encodings for each message that passes across the 
ASAI interface at the byte level for the following:
nEvent Reports
nCall Control Capability Group
nDomain (Station/ACD Split/EAS Skill) Control Capability Group
nNotification Capability Group
nRouting Capability Group
nRequest Feature Capability Group
nValue Query Capability Group
nSet Value Capability Group
nMaintenance Capability Group
Conventions
Within certain messages, specific information elements are optional and may or 
may not be present in a specific message. 
Italics denote these bytes in the Byte 
Description column of the tables in this chapter.
Some bytes may be repeated in a message; an asterisk (“*”) at the beginning of 
the entry in the Byte Description column identifies such a byte.
In some messages, the ordering of instances of an information element that 
occurs multiple times is fixed. These situations are explicitly identified in notes 
with the message layouts. In all other cases, the ordering of the instances of an IE 
that appears multiple times is arbitrary. 
						

							Byte Level Messages
5-2Issue 6  June 1997 
The bit-wise OR operation is indicated by a vertical bar “|’’ and the resulting value 
is the bit-wise ORing of the values on either side of the bar. The word “or,” or a 
comma, indicates that the value is one of a list of possible values. 
The occurrence of a question mark (?) in the Byte Value column means that a 
hex-byte value is present.
Event Reports
Event Reports: REGister Messages Sent by the
Adjunct
None for Event Reports.
Event Reports: REGister Messages Sent by the
switch
None for Event Reports.
Event Reports: FACility Messages Sent by the
switch
A FACility message is used to initiate an action or pass information within an 
existing association on an active CRV. All FACility messages have the Protocol 
Discriminator and the CRV followed by a FAC type = 0x62. 
						

							Event Reports
Issue 6  June 1997
5-3
Alerting Event Report
(Continued on next page) Byte Description Byte Value Comments
Protocol Discriminator 0x08 BRI
CRV Length 0x01 or 
0x02
First CRV Byte 0x?
Second CRV Byte0x?
Message Type 0x62 FACility
Locking Shift to Code Set 6 0x96
Facility IE 0x1c
Length of Facility IE 0x?? computed length
Q.932 Supplementary Service 0x91
component type tag 0xa1 INVOKE component
component length 0x?? computed length
component length0x?? long form (length > 127)
invoke identifier tag 0x02
invoke identifier length 0x01
invoke identifier 0x?? even value
operation value tag 0x02
operation value length 0x01
Operation Value = Event Report 0x95
Q.931 IEs tag 0x40
Q.931 IEs length 0x?? computed length
Q.931 IEs length0x?? long form (length > 127)
Cause IE0x08
Length of Cause IE0x02 computed length
Ext bit | coding standard | 
location0x81, 0xe1
cause value0x?? CS3/23 (Remains in Queue); 
CS3/31 (SAC, Cover All Calls, 
Go to Cover active, Adjunct 
Redirected-Alerting-Call); 
CS3/25 (Call Forwarding); 
CS3/26 (Cover, principal busy 
or all call appearances busy); 
CS3/28 (Cover Don’t Answer)
The Connected Number IE0x0c
Length of IE 0x?
Ext bit | Type | Numbering plan0x80
* Address digits0x??  0x30 thru 0x39,0x23(#), 0x2a(*) 
						

							Byte Level Messages
5-4Issue 6  June 1997 
Alerting Event Report — (Continued)
Byte Description Byte Value Comments
Call Identity IE 0x10
Length of Call Identity 0x02 computed value
* Call identifier (2 bytes) 0x?? switch-assigned value
Calling Party Number0x6c
Length of Calling Party IE0x? computed length
Address Type & numbering Plan Id0x?? 0x80, 0x90, 0x81, 0x91, 0xa0, 
or 0xa1
* Address digits0x??  0x30 thru 0x39,0x23(#), 
0x2a(*)
Called Party Number IE 0x70
Length of Called Party Number 0x? computed length
Address Type & Numbering Plan 0x?? 0x80, 0x90, 0x81, 0x91, 0xa0, 
or 0xa1
* ASCII Address digits 0x??  0x30 thru 0x39,0x23(#),0x2a(*)
User-User IE0x7e User-to-user information
The length of user-user IE0x?? computed length
Protocol Discriminator0x??
*user information0x??
Locking Shift to Code Set 6 0x96
Originating Line Information IE0x01
Length of OLI0x?? computed length
*
II-Digits0x??
The Trunk Identification IE 0x0a
The length of IE 0x? computed length
Direction0x80 No Direction
* Trunk Group Number0x?? binary coded
* Trunk Group Member Number0x?? binary coded
The Party Identifier IE 0x44
Length of the IE  0x01 or 0x02
Ext bit | Party ID 0x?? 
Ext bit | Party ID (second byte)0x??
The Specific Event IE 0x47
The length of the Specific Event IE 0x01
Event value = Alerting 0x81
The Domain IE  0x49 present for ACD call
The length of the Domain IE 0x?
The Domain type = ACD Split0x81 ACD split
(Continued on next page) 
						

							Event Reports
Issue 6  June 1997
5-5
NOTE:
The Calling Number IE and the Trunk Identification IE are mutually exclusive. One or 
the other will be present.
* The first to N-1 extension digits0x30 thru 
0x39
The last extension digit0xbX 0xb0 thru 0xb9 Alerting Event Report — (Continued) 
						

							Byte Level Messages
5-6Issue 6  June 1997 
Answered Event Report
(Continued on next page) Byte Description Byte Value Comments
Protocol Discriminator 0x08 BRI
CRV Length 0x01 or 0x02
First CRV Byte 0x?
Second CRV Byte0x?
Message Type 0x62 FACility
Locking Shift to Code Set 6 0x96
Facility IE 0x1c
Length of Facility IE 0x?? computed length
Q.932 Supplementary Service 0x91
component type tag 0xa1 INVOKE component
component length 0x?? computed length
component length0x?? long form (length > 127)
invoke identifier tag 0x02
invoke identifier length 0x01
invoke identifier 0x?? even value
operation value tag 0x02
operation value length 0x01
Operation Value = Event Report 0x95
Q.931 IEs tag 0x40
Q.931 IEs length 0x?? computed length
Q.931 IEs length0x?? long form (length > 127)
Cause IE 0x08
length of Cause IE 0x02 computed length
Ext bit | coding standard | 
location0x81 or 0xe1 switch-to-adjunct
Cause Value 0x?? cause-dependent
The Connected Number IE 0x0c
Length of IE 0x?
Ext bit | Type | Numbering plan0x?? 0x80, 0x90, 0x81, 0x91, 0xa0, 
or 0xa1
* Address digits 0x??  0x30 thru 0x39,0x23(#), 0x2a(*)
Call Identity IE 0x10
Length of Call Identity 0x02 computed value
* Call identifier (2 bytes) 0x?? switch-assigned value