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

							Codeset 6 Information Elements
Issue 6  June 1997
4-35
Data Item IE
The Data Item IE shown in Figure 4-20 returns information that an adjunct has 
queried for. The Data Item information element contains one information value. 
The data item type identifies what value is present in the IE. Presently, the Data 
Item IE is used in the response to the Integrated Directory Database query and in 
the reporting of ISDN Charge Advice.
Figure 4-20. Data Item Information Element
Data Item Type (octet 3):
This byte may need to be interpreted differently in future messages. Currently this 
byte can take on the following values/meanings:ValueThis field is optional and represents the binary count associated 
with the Counter Type. The ECS currently sends one- or two-byte 
Value fields. Adjuncts should be prepared to receive two-byte 
values. 
NOTE:
When a two-byte value is present, the high order bits are in 
byte 4 and the low order bits are in byte 4a, just as they are 
with two-byte CRVs. Refer to the 
DEFINITY Enterprise 
Communications Server Administration and Features 
Description
, 555-230-522, for specifics on the ECS running 
ASAI to determine the maximum values for the parameters 
encoded in the Value field. This indicates 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.
8  7654321
Data Items
0  1010010Octet 1
Information element identifier
Length of Data Items contents 2
1
Data Item Type 3
Ext
1
Data Item Value            4*?
Ext 
						

							Information Elements
4-36Issue 6  June 1997 
 Data Item Value
 This value may be either an integer value, or an ASCII string. Charge amounts 
are encoded as integers and names are encoded as ASCII strings.
If an integer is encoded, then 7 bits of each octet are used. The high bit is an 
extension bit, and is set to 0 except in the last octet of the value. The most 
significant octets are ordered first. For example, 400 (decimal), which is 0x190 
(hexadecimal) is encoded in two octets: 
ASCII strings are encoded with the high bit set to 0 for every byte except the last 
byte.Bits
7654321
0000000 Reserved
0 0 0 0 0 0 1  Intermediate Charge
0000010 Final Charge
0000011 Split Charge
0000100 Name
0 
EXT0000011 4a
1 
EXT0010000 4b 
						

							Codeset 6 Information Elements
Issue 6  June 1997
4-37
 Domain
The Domain IE shown in Figure 4-21 specifies the domain for which an event is 
reported.
.
Figure 4-21. Domain Information Element8  7654321
Domain Information
0  1001001Byte1
Information element identifier
Length of Domain Information contents 2
1
Domain Type 3
Ext.
0/1
Address           4*
Ext
Domain TypeBits
7 6 5 4 3 2 1
0 0 0 0 0 0 0 Adjunct-Monitored call audit
0 0 0 0 0 0 1 Group Extension (includes ACD split)
0 0 0 0 0 1 1 Extension
0 0 0 0 1 1 0 Work mode
0 0 0 0 1 1 1 Talk state
0 0 0 1 0 0 1 Trunk access code
0 0 0 1 1 0 0 Vector Directory Number
0 0 0 1 1 1 0 Announcement
0 0 0 1 1 1 1 Data Extension
0 0 1 0 0 0 0 ASAI
0 0 1 0 0 0 1 Station Type
0 0 1 0 0 1 0 Other
0 0 1 0 0 1 1 Logical Agent
0 0 1 0 1 0 1 Integrated Directory Database
0 0 1 1 0 0 0 Reason Codes 
						

							Information Elements
4-38Issue 6  June 1997 
nIf the domain type is a group extension, an extension, logical 
agent, trunk access code, VDN, announcement, or data 
extension, the address field may contain the extension 
number (in ASCII).
1 In an incoming Domain IE the ECS will 
parse, the only ASCII characters the ECS permits are the 
digits 0 through 9.
2 There may be instances of event reports 
where an address should be included, but an address is not 
available to the ECS. In such cases, the address is present 
where ASAI requires it. However, in such a case, the 
Address field contains default values:
— ***** is the default value for a local ECS extension 
(might be an “interphantom” extension);
— ##### is the default value for an unknown external 
number.
Any adjunct interfacing to the ECS should be prepared to 
receive the address with default values.
nIf the domain type is “Work Mode,” the address field contains a 
single-byte coded as follows:
1. The address (extension number) is not present when the Domain IE is responding to the 
extension information query, except for an extension information query containing a logical 
extension of a logged-in agent. In this case, the address contains the physical extension 
the agent is logged into. The address is present in all other cases.
2. The 
Adjunct/Switch Application Interface (ASAI) Specification also permits “*” and “#.”
Address (byte 4, 
bits 7 through 1)This optional field has a variable number of bytes 
and its format depends on the domain type.
Bits
7 6 5 4 3 2 1
0 0 0 0 0 0 0 Reserved
0 0 0 0 0 0 1 Aux mode
0 0 0 0 0 1 0 After Call Work Mode
0 0 0 0 0 1 1 Auto In Mode
0 0 0 0 1 0 0 Manual In Mode
0 0 0 0 1 1 1 Logged in
0 0 0 1 0 0 0 Not Logged in 
						

							Codeset 6 Information Elements
Issue 6  June 1997
4-39
nIf the domain type is “Talk State,” the address field contains a single 
byte coded as follows:
nIf the domain type is “Station Type,” the address field contains a 
single byte coded as follows:
nIf the domain type is “ASAI,” the address field contains a single byte 
coded as follows:
nIf the Domain type is Reason Codes, the address field contains a 
single byte with a binary value between 1-9.
nFor other domain types, the address field is not used (call classifiers 
cannot be addressed individually). Bits
7 6 5 4 3 2 1
0 0 0 0 0 0 0 Reserved
0 0 0 0 1 0 1 On Call
0 0 0 01 1 0 Available/Not on Call
Bits
7 6 5 4 3 2 1
0 0 0 0 0 0 0 Reserved
0 0 0 0 0 0 1 Analog
0 0 0 0 0 1 0 Proprietary
0 0 0 0 0 1 1 Basic Rate ISDN Interface
Bits
7 6 5 4 3 2 1
0 0 0 0 0 0 0 Reserved
0 0 0 0 0 0 1 No Bearer Channel Capabilities 
						

							Information Elements
4-40Issue 6  June 1997 
Facility Information Element (FIE)
The Facility information element (FIE) identifies and contains an ASAI capability 
request or response. CCITT Recommendation Q.932 uses an X.209 encoding of 
X.229 Protocol Data Units.
The FIE only appears once in a message. The maximum length of the BRI 
message determines the number of bytes that the FIE may occupy; therefore, it 
imposes an upper bound on the length of an IE.
Table 4-6 to Table 4-9 show the FIE encoding.
.
NOTE:
The FIE may contain only one component.
Figure 4-22. Facility Information Element
Service Discriminator
The ECS/ASAI recognizes only one service discriminator, Q.932 Supplementary 
Services, with the value shown: 1 0 0 0 1.
Components (Bytes 4, etc.)
A component is a sequence of data elements, each made up of a tag, a length, 
and contents. The first byte of the FIE component (byte 4) gives the component 
type. The component types for the Facility information element are:
nInvoke
nReturn Result
nReturn Error
nReject 8 7654321
Facility
0 0011100Byte1
information element identifier
Length of facility contents 2
1
Ext 0010001 3
spare Service Discriminator
Component (Note 1)      4 etc. 
						

							Codeset 6 Information Elements
Issue 6  June 1997
4-41
t
1. The component length is coded to indicate the number of bytes contained in the component (excluding
the component type tag and the component length bytes).
2. This ASAI implementation never uses or expects linked identifiers. Refer to the 
Adjunct/Switch
Application Interface (ASAI) Specification for a description.
3. Contains capability parameter(s) for the Invoke component type.
Table 4-6. Invoke Component
Invoke component SectionMandatory
IndicationByte 
Group
Component type tag
Component length
1Component Type Tag
“Length of Each Component or Contents” Mandatory4
5
Invoke identifier tag
Invoke identifier length
Invoke identifierInvoke Identifier Tags
“Length of Each Component or Contents”
Invoke IdentifierMandatory6
7
8
Linked identifier tag
2 
Linked identifier length
Linked identifierNot used
Not used
Not usedOptional9
10
11
Operation value tag
Operation value length
Operation ValueOperation Value Tag
“Length of Each Component or Contents”
Operation ValueMandatory12
13
14
Argument
3  Using Existing Q.931
Information Elements as ParametersOptional 15, etc. 
						

							Information Elements
4-42Issue 6  June 1997 
1. The component length is coded to indicate the number of bytes contained in the component (excluding
the component type tag and the component length bytes).
2. The sequence tag is an anomaly in the Return Result component. Although other components are
similarly structured, the Return Result component is the only component with a sequence tag. This
arises from a specific backward compatibility need for the Q.932 Return Result component with respect
to other CCITT standards.
3. When the sequence tag is present, both the Operation Value and the Result must be present. All are
present or none are.
4. Contains parameter(s) of the Return Result component type.
Table 4-7. Return Result Component
Invoke component SectionMandatory
IndicationByte 
Group
Component type tag
Component length
1 Component Type Tag
“Length of Each Component or Contents” Mandatory4
5
Invoke identifier tag
Invoke identifier length
Invoke identifierInvoke Identifier Tags
“Length of Each Component or Contents”
Invoke IdentifierMandatory6
7
8
Sequence tag
2, 3
Sequence lengthSequence Value Tag
“Length of Each Component or Contents” Optional9
10
Operation value tag
3
Operation value length
Operation ValueOperation Value Tag
“Length of Each Component or Contents”
Operation ValueMandatory11
12
13
Result
3, 4Using Existing Q.931
Information Elements as ParametersOptional 14, etc. 
						

							Codeset 6 Information Elements
Issue 6  June 1997
4-43
.
1. The component length is coded to indicate the number of bytes contained in the component (excluding the
component type tag and the component length bytes).
2. The ASAI specification and the Q.932 specification have an “error value” here in the return error component.
Both ASAI and Q.932 have the same encoding for the “error value tag” in the return error component and
the “operation value tag” in the Invoke component. This means that what occupies the “error value” field is
an Operation Value.
3. Contains parameter(s) of the return error component type
Table 4-8. Return Error Component
Invoke Component SectionMandatory
IndicationByte 
Group
Component type tag
Component length
1 Component Type Tag
“Length of Each Component or Contents” Mandatory4
5
Invoke identifier tag
Invoke identifier length
Invoke identifierInvoke Identifier Tags
“Length of Each Component or Contents”
Invoke IdentifierMandatory6
7
8
Error value tag
Error value length
Error value/Operation Value
2
Error Value Tag
“Length of Each Component or Contents”
Error ValueMandatory9
10
11
Parameter
3  Using Existing Q.931
Information Elements as ParametersOptional 12, 
etc. 
						

							Information Elements
4-44Issue 6  June 1997 
Component/Content Length
Lengths up to 127 bytes are coded using the short form of Recommendation 
X.209: bit 8 is set to zero and the remaining seven bits are a binary encoding of 
the length with bit 1 the least significant bit.
This length encoding is identical to that of Recommendation Q.931 for lengths up 
to 127 bytes.
.
Figure 4-23. Format of the Length Field (Short Form)
1. The component length is coded to indicate the number of bytes contained in the component (excluding
the component type tag and the component length bytes).
2. The problem length is always one byte.
Table 4-9. Reject Component
Reject Component SectionMandatory
IndicationByte 
Group
Component type tag
Component length
1 Component Type Tag
“Length of Each Component or Contents” Mandatory4
5
Invoke identifier tag
Invoke identifier length
Invoke identifierInvoke Identifier Tags
“Length of Each Component or Contents”
Invoke IdentifierMandatory6
7
8
Problem tag
Problem length
2 
ProblemProblem Tag
“Length of Each Component or Contents”
Problem TagMandatory6
7
8
87654321
0 Length of Contents
MSB LSB