Nortel DMS-100 TOPS Audio Table (TOPAUDIO) |
Table Name
TOPS Audio
Functional Description of Table TOPAUDIO
TOPAUDIO defines audio programs for playing to a caller while waiting for an operator. A program consists of a combination of ringing, music, announcements, and/or silence.
Datafill Sequence & Table Size
Tables CLLI (Common Language Location Identifier), ANNS (Announcement), and ANNMEMS (Announcement Members) must be datafilled before table TOPAUDIO.
Table CT4QNAMS (Call Type for Queuing by Names) must be datafilled after table TOPAUDIO. Therefore, an associated tuple must be deleted from table CT4QNAMS before deleting from table TOPAUDIO.
Size is 0 to 128 tuples.
Datafill
The following table describes datafill for table TOPAUDIO:
----------------------------------------------------------------------------------------------
Table TOPAUDIO Field Descriptions
Field Subfield Entry Explanation and Action
----------------------------------------------------------------------------------------------
AUDIOKEY Alphanumeric Audio Key
(1 to 16 This field is the key to the table and defines a
characters) name for this program. This name is used in
table CT4QNAMS.
----------------------------------------------------------------------------------------------
ROUTES See Subfield Routes
This field consists of up to six occurrences of
subfield AUDIOSEL and refinements.
AUDIOSEL ANN, MUSIC, Audio Selection
SILENCE, RINGING, This field defines the components of the
REPEAT program. The values are defined as follows:
* ANN (Announcement) - Enter datafill in fields
ANNCLLI and AUDRING.
* MUSIC - Enter datafill in refinements
MUSICLLI and TIME.
* SILENCE - Enter datafill in refinement TIME.
* RINGING - Enter datafill in refinement TIME.
* REPEAT - Enter datafill in refinement ROUTE.
This value continuously replays the sequence
of entries in AUDIOSEL, starting with the
entry number in ROUTE and going to the last
entry before REPEAT. When REPEAT is used, it
must be the last entry. Also, REPEAT cannot
be the only entry.
Each value, except REPEAT, can be used more
than once.
ANNCLLI Name from Announcement CLLI
table ANNMEMS Enter data in this field if field AUDIOSEL=ANN.
This field defines the announcement CLLI and it
must be entered in tables CLLI, ANNS, and
ANNMEMS.
AUDRING Y or N Audible Ringing
Enter data in this field if field AUDIOSEL=ANN.
This field indicates if audible ringing is
provided (Y) or not (N) to the caller after
the announcement is connected and before the
beginning of a cycle.
MUSICLLI Name from Music CLLI
table ANNMEMS Enter data in this field if field AUDIOSEL=MUSIC.
This field defines the music CLLI and it must be
entered in tables CLLI, ANNS, and ANNMEMS.
TIME 0 to 1,800 Time
Enter data in this field if field AUDIOSEL=MUSIC,
RINGING, or SILENCE. Field TIME defines how many
seconds the music, ringing or silence are played.
If MUSIC, RINGING, or SILENCE is the last entry
in field AUDIOSEL, TIME must be set to 0.
Value "0" provides continuous playing of the
MUSIC, RINGING, or SILENCE.
ROUTE 1 to 5 Route
Enter data in this field if field
AUDIOSEL=REPEAT. This field indicates the
starting entry number in field AUDIOSEL of the
sequence of AUDIOSEL entries that are to be
continuously replayed. When value REPEAT is
used in field AUDIOSEL, REPEAT must be the last
entry.
----------------------------------------------------------------------------------------------
-End-
Datafill Example
The following example MAP display shows sample datafill for table TOPAUDIO:
AUDIOKEY ROUTES
________________________________________________________________________________
POP_MUSIC_ONLY (MUSIC POP_MUSIC_CLLI 0)
SILENCE_ONLY (SILENCE 0)
BUSOFC_AFTER_HRS (ANN BUS_HRS_ANN_CLLI Y) (MUSIC ROCK_MUSIC_CLLI 0)
STD_WAIT_TRMT (RINGING 4) (ANN HOLD_4_OPR_CLLI Y) (MUSIC ROCK_MUSIC_CLLI 30)
(ANN DONT_HANGUP_CLLI N) (REPEAT 3) $
|
The following are comments on the above tuples.
The first example tuple shows a one-element audio route list that could be used to replace ringing with music for queued calls. After the music selector, the route specifies the music CLLI and the duration of the music in seconds. A non-zero duration would be used if the music were to be followed by an announcement after some number of seconds. But in this example, music is the last element of the route list, so the duration datafill is zero indicating infinite duration. (For music in queue, infinite duration means to continue the treatment until the operator becomes available or the caller goes on hook).
The second example tuple shows a one-element audio route list that could be used to simply replace ringing with silence. No CLLI is entered in datafill when the silence selector is used. However, a duration is entered and interpreted the same way as a music duration. (A route with the ringing selector has a similar field for the duration.)
The third example shows an audio route that might be used for after hours calls to the business office, if these calls are routed to an operator. The audio route begins with an announcement, which might say the business office is closed, but an operator will be connected if the caller stays on the line. After the announcement, music is played until an operator becomes available.
The "Y" entry in this announcement route is for the audible ringing subfield. A "Y" value indicates that audible ringing should be applied between the time the announcement is connected and the beginning of a cycle.
The last example specifies four seconds of ringing, followed by an announcement (which might ask the caller to hold for an operator), followed by 30 seconds of music and then a different announcement (which might ask the caller to stay on the line). The "(REPEAT 3)" after the last announcement specifies that the last announcement should be followed by element 3 of the route list, which is music. So the pattern of 30 seconds of music followed by the "don't hang up" announcement continues until the operator becomes available or the caller goes on-hook.
In the last example, note that the actual duration of ringing before the first announcement could be anywhere from four seconds to nearly the number of seconds the announcement takes. This longer ringing time would occur if the caller were connected to the announcement just after a cycle had begun, and had to wait almost an entire cycle's length before beginning to hear the announcement.
Also in the last example, notice that the Audible Ringing subfield is "Y" for the first announcement but "N" for the second one. When an announcement follows ringing, a "Y" selector is recommended because it causes the ringing to simply continue until the beginning of the announcement cycle comes around. But when an announcement follows music, it may be better to provide silence, rather than a short burst of ringing, until the beginning of a cycle. This is especially true if the announcement is short.
It is recommended that the last route in each audio route list specify either repetition or an interval (music, ringing, or silence) of infinite duration. Otherwise, the route list does not specify what happens if the end of the list is reached before the operator becomes available. When this happens, ringing is applied until the operator becomes available.
Error Messages for Table TOPAUDIO
The following error messages apply to table TOPAUDIO.
----------------------------------------------------------------------------------------------
Error Messages for Table TOPAUDIO
Error Message Explanation and Action
----------------------------------------------------------------------------------------------
TUPLE ALREADY EXISTS The field AUDIOKEY name must be unique. If an attempt is
made to add a second tuple with the same name this error
message is displayed.
----------------------------------------------------------------------------------------------
INVALID ANNOUNCEMENT/MUSIC CLLI. When field AUDIOSEL=MUSIC, then MUSICLLI refinement
CHECK TABLE ANNS. specifying music CLLI must be already in tables CLLI, ANNS
and ANNMEMS tables. Otherwise this error message is
displayed.
----------------------------------------------------------------------------------------------
MUSIC AS THE LAST CHOICE MUST If MUSIC is the last selection in field AUDIOSEL, then the
HAVE ZERO TIME. associated TIME must be 0 (zero). Otherwise this error
message is displayed
----------------------------------------------------------------------------------------------
RINGING AS THE LAST CHOICE MUST If RINGING is the last selection in field AUDIOSEL, then
HAVE ZERO TIME. the associated TIME must be 0 (zero). Otherwise this
error message is displayed
----------------------------------------------------------------------------------------------
SILENCE AS THE LAST CHOICE MUST If the SILENCE is the last selection in field AUDIOSEL,
HAVE ZERO TIME. then the associated TIME must be 0 (zero). Otherwise this
error message is displayed.
----------------------------------------------------------------------------------------------
REPEAT ROUTE MUST NOT BE GREATER When field AUDIOSEL=REPEAT then ROUTE refinement specifies
THAN <n> the route number (1 to 5) where the repeat sequence begins.
If the specified target route does not exist or the route
is illegal (for example, the last selection is route #5 and
entered as "REPEAT 5") then this error message is displayed.
----------------------------------------------------------------------------------------------
AUDIOKEY MUST BE DELETED FROM If an attempt is made to delete a tuple whose AUDIOKEY is
CT4QNAMS FIRST. still entered in table CT4QNAMS, then this error message is
displayed.
----------------------------------------------------------------------------------------------
NO AUDIO SELECTION WAS DATAFILLED. At least one audio selection must be entered in field
AUDIOSEL. Otherwise, this error message is displayed.
----------------------------------------------------------------------------------------------
TABLE LIMIT HAS BEEN REACHED. If the limit of tuples in table TOPAUDIO is reached, this
error message is displayed.
----------------------------------------------------------------------------------------------
INTERNAL RESOURCE ALLOCATION ERROR. If table TOPAUDIO is not able to allocate more data store,
this error message is displayed.
----------------------------------------------------------------------------------------------
REPEAT MUST BE THE LAST CHOICE If the REPEAT choice in field AUDIOSEL is not the last one,
ONLY. this error message is displayed.
----------------------------------------------------------------------------------------------
SINGLE REPEAT CHOICE IS NOT If REPEAT is only choice in field AUDIOSEL, this error
ALLOWED. message is displayed.
----------------------------------------------------------------------------------------------
-End-