ATT DEFINITY Communications System Generic 3V4 Instructions Manual

							ASAI and Value Query Capabilitiesbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
Value Querybbbbbbbb
The adjunct can use this capability to inquire about specific resources available
on the switch.
Information Flowbbbbbbbbbbbbbbb
The switch either:
Issues the information as part of the acknowledgement to the adjunct
Denies the request with the appropriate cause code
Sends one or more value query response messages with a response,
then issues an acknowledgement to terminate the association
Value Query Parametersbbbbbbbbbbbbbbb
item[mandatory] Specifies the switch resource
Valid items are:
dACD Agent Login Audit QuerydMWI Status
dCalls QuerydExtension Information Query
dParty_id QuerydTime of Day
item_paramsContains additional item-specific parameters
ACD Agent Login
Audit QueryThe ACD split extension
ACD Agent Status
QueryThe ACD agent extension and ACD split extension
ACD Split QueryThe ACD split extension
Calls QueryThe Station extension
Call Classifier
QueryNo additional parameters needed
Extension QueryThe extension number (any valid dial plan number)
Party_id QueryThe call identifier for an existing call
9-2  Issue 4  September 1995 
						

							ASAI and Value Query Capabilitiesbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
Station Feature
QueryWith the Station Feature query, the application passes an
extension number and the feature to the switch.  The
extension need not be domain-controlled, but must be
one supporting the particular feature.  The following
features may be queried:
Message Waiting Indication (MWI)
Send All Calls
Call Forwarding
All positive responses reflect the on/off status of the
feature as known to the switch.
1
Station Status
QueryThe station extension
Time of DayNo additional parameters needed
Trunk Group
QueryThe Trunk Group access code
Internally Measured Data Value Query
Parameters
data_domainIndicates the internally measured data domain for which
data is requested.  The following values are supported:
agent, split/skill, trunk group, and VDN.
domain_elementIndicates the specific element (e.g., agent) from the
specified domain for which data is requested.
For split/skill and VDN data_domains, this is always an
extension number corresponding to the target element.
For agents, this is either the logical agent login ID when
EAS is optioned, the BCMS/VuStats Login ID when the
BCMS/VuStats Login ID feature is optioned, or the
extension of the agents phone (in a traditional ACD
environment).
aaaaaaaaaaaaaaaaaaa
1.  Although in most  cases a lamp is associated with the feature for visual status, the query provides the feature
status inside the switch, not the lamp status.  (The lamp status may reflect some other stations MWI or it may
be displaying an agents MWI, based on administration.)
Issue 4  September 1995  9-3 
						

							ASAI and Value Query Capabilitiesbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
In a non-EAS environment with BCMS/VuStats login IDs,
the address field of a logical agent contains the login ID
(in ASCII). This can be up to 9 ASCII characters, 0 to 9.
If either a BCMS/VuStats login ID or EAS logical agent is
used, then the domain type in this element should be
login_id.
For trunk groups, this is the TAC of the target group.
split/skill_ref[Optional] Indicates a specific split/skill (from 1 to 4) into
which the agent is currently logged, from which data is
being requested.  For acd-calls, avg-acd-talk-time, shift-
acd-calls, or shift-avg-acd-talk-time, the value ``0 signifies
that data should be summed or averaged across all splits
the agent is logged into.
data_items[mandatory] Indicates the data items within the selected
data_domain for which data is being requested.
If an IMD query about an agent requests historic data on
acd-calls or on average-acd-talk-time and specifies a split
rather than requesting the data over all splits to which the
agent belongs), then those items are not returned.
Historic data on agents does not segment these items
into data for each split.
In the lists that follow, one, two, or three letters may follow
an item. An ``S indicates a ``split reference is used, an
``A signifies a split of ``All can be used, and an ``H
indicates that historical data is available through interval
collection.
Valid items are:
Agent Data Items:
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
acd-calls H, S, Asplit-avg-after-call-time S
agent extension split-avg-speed-of-ans. H, S
agent-name split-avg-time-to-abandon H, S
agent state Ssplit-call-rate H, S
avg-acd-talk-time H, S, Asplit-calls-abandoned H, S
avg-extension-time Hsplit-calls-flowed-in H,S
avg-acd-call-time H, Ssplit-calls-flowed-out H, S
call-rate Hsplit-calls-waiting S
extension-calls Hsplit-name S
9-4  Issue 4  September 1995 
						

							ASAI and Value Query Capabilitiesbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
Agent Data Items, contd.:
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
extension-incoming-calls split-number S
extension-outgoing-calls split-extension S
shift-acd-calls S, Asplit-objective S
shift-avg-acd-talk-time S, Asplit-oldest-call-waiting S
split-acceptable-svc-lvl Ssplit-%-in-service-level H, S
split-acd-calls H, Ssplit-total-acd-talk-time H, S
split-after-call-sessions Ssplit-total-after-call-time H, S
split-agents-available Ssplit-total-aux-time S
split-agents-in-after-call Stime-agent-entered-state S
Issue 4  September 1995  
9-5 
						

							ASAI and Value Query Capabilitiesbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
Agent Data Items, contd.:
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
split-agents-in-aux Stotal-acd-talk-time H
split-agents-in-other Stotal-after-call-time H
split-agents-on-acd-calls Stotal-aux-time H
split-agents-on-ext.-calls Stotal-available-time H
split-agents-staffed Stotal-hold-time H
split-avg-acd-talk-time H, Stotal-staffed-time H
total-acd-call-time H
Spit/Skill Data Items:
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
acceptable-service-level call-rate H
acd-calls Hcalls-abandoned H
after-call-sessions calls-flowed-in H
agents-available calls-flowed-out H
agents-in-after-call calls-waiting
agents-in-aux-work oldest-call-waiting
agents-in-other %-in-service-level H
agents-on-acd-calls split-name
agents-on-ext.-calls split-extension
agents-staffed split-number
avg-acd-talk-time Hsplit-objective
avg-after-call-time total-after-call-time H
avg-speed-of-answer Htotal-aux-time
avg-time-to-abandon Htotal-acd-talk-time H
VDN Data Items:
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
acceptable-service-level calls-offered H
acd-calls Hcalls-waiting
avg-acd-talk-time Hnon-acd-connected-calls H
avg-speed-of-answer Holdest-call-waiting
avg-time-to-abandon H%-in-service-level H
calls-abandoned Htotal-acd-talk-time H
calls-flowed-out Hvdn-extension
calls-forced-busy-or-disc Hvdn-name
9-6  Issue 4  September 1995 
						

							ASAI and Value Query Capabilitiesbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
Trunk Group Data Items:
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
avg-incoming-call-time Houtgoing-usage H
avg-outgoing-call-time H%-all-trunks-busy H
incoming-abandoned-calls H%-trunks-maint-busy H
incoming-calls Htrunk-group-name
incoming-usage Htrunk-group-#
number-of-trunks trunks-in-use
outgoing-calls Htrunks-maint-busy
outgoing-completed-calls H
intervalIndicates the collection interval for which requested data
should be reported. Intervals are:
Current Ð Current interval only (indicated by
omitting this parameter)
Last Ð Last complete interval
Integrated Directory Database Data Value Query
Parameters
data_domain[mandatory] Indicates the data domain for which data is
requested. This is a value for 
integrated directory.
domain_element[mandatory] Indicates the specific extension [1-5] digits
for which the corresponding administered name is
requested.
ACK (Positive Acknowledgement)
Parameters
bbbbbbbbbbbbbbb
The following ACK parameters are passed by the switch to the adjunct in
response to the particular value query request:
ACD Agent Login
Audit QueryThe switch responds with a sequence of value query
response messages that contain the extension for each
agent logged into the split.  Due to the volume of
information contained in this response, the ACK is the last
piece of data provided to the adjunct.  It indicates the
conclusion of the response.  For most other queries, the
information is returned within the ACK.
ACD Agent Status
QueryThe switch responds with work mode and idle/busy state
of the ACD agent.  A ``busy state is returned if the ACD
agent is on any active call or if Call Forwarding/SAC is
active for the station.
Issue 4  September 1995  
9-7 
						

							ASAI and Value Query Capabilitiesbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
An ``idle state is returned if the ACD agent is not on any
active call (includes off-hook idle).
ACD Split QueryThe switch responds with the number of ACD agents
available to receive calls through that split, the number of
calls in queue, and the number of ACD agents logged in.
The number of calls in queue does not include
direct-agent calls.
Calls QueryThe switch responds with the call_id(s) for the calls
present at the primary extension. Information for a
maximum of 10 calls present at the station is reported
back to the adjunct.  Additional calls are not reported.
This query is valid for stations only.
The switch provides the following information in the value
parameter of the acknowledgement to the Calls Query
request:
call_id list is a list of call-identifiers for calls present at
the principals station (includes calls present at bridged
appearances on the principals station)
call_state list is a list of call states for each call present
at the principals station. Each call can be in any of the
following states:
Dialing (initiate): A station on the call is off-hook
originating a call or listing to dial tone.
Alerting: The call is alerting (ringing).  This also
includes calls at simulated bridges of stations that
are ringing.
Connected (active): A call is active at the station
(talking state).  This includes active calls at a
bridged or simulated bridged appearance.
Held: A call that was put on hold.
Bridged: A call is present at a bridged, simulated
bridged, button TEG, or PCOL appearance, and
the call is neither ringing nor connected (active) at
the station.
Other: All other call states, including conference
pending, listening to tone, and so forth.
9-8  Issue 4  September 1995 
						

							ASAI and Value Query Capabilitiesbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
party_id list provides a party identifier for the station on
each of the calls.  Note that there is a one-to-one
correspondence between the elements of this list and the
above two lists (call_id and call_state list).
Call Classifier
QueryThe switch responds with the number of ``idle and
``in-use TN744 ports.  The ``in-use number is a snapshot
of the TN744 port usage.
Extension
Information QueryThe switch responds with the following information:
Extension_class specifies the extension number as:
1. Vector Directory Number (VDN)
2. Hunt group (ACD split)
3. Announcement
4. Data extension
5. Voice extension: The response further defines the
endpoint assigned to the extension number into
various station types:
Analog (includes off-premises station
extensions)
Proprietary
BRI
6. ASAI
7. Logical Agent
8. Other (for example, modem pool)
If the extension provided in the query is an agents login
ID, the response is ``Logical Agent and the address field
of the domain IE contains the physical station extension
the agent is logged into.
Integrated
Directory
Database QueryThe switch responds with the following information (if a
name is administered for the queried extension number):
1. actual type of queried user
2. extension of queried device
3. name of queried device
Party_Id QuerySwitch responds with the party_id and the extension
number (on-PBX extensions Ð local parties) on the call.
The switch responds with the following information in the
value parameter of the acknowledgement to the Party_id
Query request:
Issue 4  September 1995  
9-9 
						

							ASAI and Value Query Capabilitiesbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
party_id is a list of identifiers for the endpoints on the
specific call (call_id).
extension_number is a list of extension numbers for
each party on the call.  A party on the call may be an on-
PBX connected extension, an alerting extension, or a split
hunt group extension (when the call is queued).  When a
call is queued on more than one split hunt group, only one
split hunt group extension is provided in the response to
such query.  For calls that are alerting at various groups
(for example, hunt group, TEG, and so forth), the group
extension is reported to the adjunct. For calls that are
connected to the member of a group, the group members
extension is reported back to the adjunct.
For off-PBX parties, the switch always provides an
extension entry even though it may contain the default
value.  A default value of ##### is provided.
Station Feature
QueryStatus of MWI feature
A positive acknowledgement indicates status of the
message waiting indicator expressed as ``on or ``off, and
the status as known by the following switch applications:
ASAI
Property Management
Message Center
Voice Messaging
Leave Word Calling
The MWI query is defined for the following:
All types of stations
TEGs
Hunt groups
Status of Send All Calls feature
A positive acknowledgement indicates status of the send
all calls feature expressed as ``on or ``off.  The status is
always reported as ``off when the extension does not
have a coverage path.
The SAC query is defined for the following:
All station types
TEGs
9-10  Issue 4  September 1995 
						

							ASAI and Value Query Capabilitiesbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
Status of Call Forwarding feature
A positive acknowledgement indicates the status of the
Call Forwarding feature expressed as ``on or ``off and
the forwarded-to number.
The Call Forwarding query is defined for the following:
All types of stations
Hunt Groups
TEGs
Station Status
QueryThe switch responds with an ``idle and/or ``busy state of
the station.  The ``busy state is returned if the station is
active with a call.  The ``idle state is returned if the station
is not active on any call.
Time of DayThe switch response contains the year, month, day, hour,
minute, and second.
Trunk Group
QueryThe switch responds with the number of ``idle trunks in
the group and the number of ``in-use trunks.  The sum of
the ``idle and ``in-use trunks provides the number of
trunks in service.
Denial (NAK) Causesbbbbbbbbbbbbbbb
The switch issues one of the following reasons as the cause for ending the
association:
Invalid association (CS0/81)
The association is already in existence.
Invalid number (CS0/28)
An invalid parameter (split extension, trunk access code, agent extension,
etc.) has been designated in the query.
Requested facility not subscribed/provisioned (CS0/50)
The user has not subscribed for the requested capability.
The Internally Measured Data feature requires that ASAI and Internally
Measured Data both be optioned.
Call with requested identity has been terminated (CS3/86)
The call for which the request was made is no longer active.
Resources not available (CS3/40)
The request cannot be executed.  Sent in response to an Internally
Measured Data query if the system limit on simultaneous IMD queries is
exceeded.
Agent not member of split (CS3/11)
The agent is not a member of the specified split.
Issue 4  September 1995  
9-11