Configurator Administrators Guide
Table of Contents 1 Introduction and Definitions...1 2 Users...5 2.1 Users...5 2.1.1 Viewing Users...5 2.1.2 Adding a User...5 2.1.3 Editing a User...7 2.1.4 Add User Wizard...8 2.1.5 Import LDAP/AD Users...8 2.1.6 Assigned Channels...8 2.2 My Items...8 2.3 Departments...9 2.4 Recordings...9 2.4.1 Add Managers...9 2.4.2 User...9 2.4.3 Queue...10 2.4.4 Archived...11 2.4.5 Personal...11 2.5 Call Restrictions...11 2.5.1 Zones...11 2.5.2 Restrictions...11 2.6 Directory...12 2.7 Session...12 2.7.1 Drop Admin Privileges (This session only)...12 2.7.2 Logout...12 2.8 System...12 2.8.1 About...12 2.8.2 Network Configuration...12 3 Devices...13 3.1 Devices...13 3.1.1 View Devices...13 3.1.2 Add Device...13 3.1.3 Configure Zap Channels...15 3.1.4 Manage Servers...15 3.2 Session...15 3.3 System...16 4 Phones...17 5 Extensions...17 5.1 Extensions...17 5.1.1 View Extensions...17 5.1.2 Add Extension...17 5.2 Routing...19 5.2.1 DID Routing Rules...19 5.2.2 Outbound Routing...19 5.3 Directory...20 5.3.1 Printable Extension List...20 5.4 Parking...20 5.4.1 Settings...20 5.5 Session...20 5.6 System...20 6 Queues...21 Configurator Admin Reference
6.1 Queue Settings...21 6.1.1 View Queues...21 6.1.2 Add Queue...22 6.2 Settings...25 6.2.1 View Assist URLs...25 6.2.2 Add Assist URLs...25 6.2.3 Pause Reasons...25 6.2.4 Dispositions...25 6.2.5 Apply Changes Now...25 6.3 Session...25 6.4 System...26 7 Call Groups...27 7.1 Call Groups...27 7.1.1 Add Group...27 7.1.2 Edit Group...27 7.1.3 Edit Members...27 7.1.4 Delete Group...27 7.2 Call Groups (side menu)...28 7.2.1 View Groups...28 7.2.2 Add Group...28 7.2.3 Find Me/Follow Me...28 7.3 Session...29 7.4 System...29 8 Conferences...30 8.1 Conferences...30 8.1.1 Add Room...30 8.1.2 Edit Room...31 8.1.3 Delete Room...31 8.2 Session...31 8.3 System...31 9 CDRs...32 9.1 CDRs...32 9.1.1 Show CDRs...32 9.2 Call Recordings...32 9.2.1 Purge Settings...32 9.3 More Reports...32 9.3.1 Inbound/Outbound Calls...32 9.4 Session...32 9.5 System...32 10 IVRs...33 10.1 IVRs...33 10.1.1 Add IVR...33 10.2 Session...37 10.3 System...37 11 Sounds...38 11.1 Sounds...38 11.2 Phrases...38 11.3 Music On Hold...38 11.3.1 Classes for Music On Hold...38 11.4 Speech Recognition...39 11.4.1 Add Dictionary...39 11.4.2 Edit Dictionary...39 Configurator Admin Reference
11.5 Faxes...39 11.6 Session...39 11.7 System...39 Configurator Admin Reference
1 Introduction and Definitions Asterisk 1 is an open-source software application that emulates the functionality of a Private Branch Exchange, or PBX. A PBX is used to allow telephones within a business to communicate with each other, as well as place and receive calls outside the business. The PBX allows the devices to share the access channels coming into the business. In most businesses all phones will not be simultaneously in use calling outside the business, therefore the PBX provides the benefit of not requiring a separate line for each phone set. Connections to Service Provider PBX Telephone Sets In addition to multiplexing the access channels, the PBX provides various call handling features such as call transfer, call park, three way calling, forward and away features, as well as functionality such as voice mail, auto attendants, conference bridges, call queues, and hunts groups. The ASG Configurator is a configuration tool designed to provide a convenient, easy to use interface to set up and manage activities associated with the PBX. Devices may communicate with the Asterisk PBX using different protocols, depending on the device type. Analog devices generally use the Zaptel protocol VoIP handsets generally use the SIP protocol Instead of SIP, some devices may use the IAX2 (InterAsterisk exchange) protocol 1 Asterisk is a registered trademark of Digium Corporation. Configurator Admin Reference 1
Useful Definitions The following are useful definitions to understand before using the configuration tool: Agent is a member of a call center or queue that is available to take calls from one or more queues for sales, support, customer service, etc. Assist URL is a URL that pops information on a screen for an agent to use during a call. CDRs (Call Detail Records) are server details of each call stored in a data format. Call Groups are groups of devices on a specific ring plan. Groups can be Ring All, Hunt, or Find Me/Follow Me type groups. A Ring All group rings all members devices simultaneously. A Hunt Group dials devices serially, attempting to get an answer until the call terminates to a voicemail (if not answered). A Find Me/Follow Me is a personal call group where different devices belonging to the same user can ring in a hunt-type fashion. Campaigns are outbound dialing efforts defined in OmegaDial. Conference Bridges are meetings where devices and outside calls may dial in and join a conversation. Contact Pools are groups of contacts that are used for OmegaDial campaigns. Devices are physical handsets (telephones) or soft phones with one or multiple lines. Direct Inward Dial (DID)s are numbers that may be dialed from outside the business to access the PBX. DIDs are associated with an extension. In the logical drawing above, there are 4 connections to the PBX from the Service Provider. However, the Service Provider may provide a block of numbers (i.e. 555-1001 through 555-1020) that will be routed to the 4 connections on the PBX. This example would allow twenty telephone sets to have their own unique number outside the business. Extensions are numbers that identify where a call should go. They may point to a device or some entity of the PBX (call group, queue, IVR, etc.). Interactive Voice Response (IVR) is a mechanism for directing call flow in the PBX. It has the ability to use the touch tone sounds to interact with callers to capture information or instruct the PBX to perform certain actions. Queues are where calls are held in the specific order in which they arrive until they are answered or sent somewhere else. Configurator Admin Reference 2
Queue Member is a user assigned to a queue to answer calls that come in to the queue. SIP (Session Initiation Protocol) is a standard protocol for initiating, modifying, and terminating an interactive user session. State is a mode within an IVR that causes an action whether it is play a sound, forward, hang-up, etc. Users are individuals identified to the PBX for assignment of permissions and access to various functions. Wrap-up Time is the amount of time an agent needs after a call is completed to do any work associated that call. During this time, the agent is unavailable to take calls and is usually in a paused state. Zap Channel permits Asterisk to communicate with a Zaptel device. The Configuration Tool can be used to input information about each of these items and make the appropriate associations. Configurator Admin Reference 3
Helpful Tips for Using the Configurator This manual is separated by category headings in the Configurator. So, each category in the Configurator has a chapter dedicated to it. Any underlined heading is a hyperlink and if clicked, goes to the associated form or information. Anything presented in a color other than black is a hyperlink and if clicked, goes to the data that corresponds with it. Configurator Admin Reference 4
2 Users Users are individuals identified to the Asterisk system for access to various functions. There a two levels of permission for Users in the Configurator. Normal users only have access to their personal information. Admin users can create, edit, and delete anything in the Configurator. In the Users tab, users can be added, edited and deleted. Groups, Departments, Call Recordings, and Call Restrictions can also be defined here. 2.1 Users 2.1.1 Viewing Users When View Users is selected (or alternately selecting the Users link), a list of all users defined in the Asterisk system will appear. At this point, users can be added, edited, or deleted. 2.1.2 Adding a User From the Configurator, select the Users link, then select Add User. This produces the Add User form. Complete the fields on the form. Fields in red are required fields. All others are optional. They are: Username First Name Last Name Email Pager Email Outbound CID Authentication Password Unique alphabetic identification given to the new user First name of the User Last name of the User Sends a notification to the specified email address that a voicemail message has been received and attaches a copy of the voicemail message Sends a notification to the specified email address that a voicemail message has been received, but does not attach the message Caller ID displayed when outbound calls are made using a device associated with this user Mechanism for determining whether a user has permissions to access the system. Standard or LDAP depending on your particular configuration. Unique alpha-numeric identifier used to access applications requiring a username/password (i.e. Configurator, Assist, INsight, OmegaDial) any application that requires an alphanumeric log in with a computer. Configurator Admin Reference 5
PIN Unique numeric identifier used to log in to a device or access voicemail any place that requires log in with a numeric keypad. The PIN number will automatically generate. PIN-less VoiceMail access from assigned devices Require PIN for outbound calls When checked, allows the user to check their voicemail from their assigned device or phone without requiring a PIN to log into the voicemail system When checked, the user must enter their PIN to make outbound calls. Department Used to organize users by location. If Departments have been defined, there will be a pull down list of all available departments. This user can be associated with one of the available departments. (To define departments, see Add Department). Departments are typically used for overhead paging. ACL State Follow Me Call Restrictions Access to Call Recordings Incoming Call Recording Outgoing Call Recording Access Control Level sets the users permissions for the Configurator. Normal limits the access to only information about the user. Admin allows the user full administration privileges. Call routing for a user. Routing states are: Normal Users calls ring their device. Normal is the default. Do Not Disturb Users calls go directly to voicemail. Forward Users calls are routed to a different extension or external number. Find Me/Follow Me Users calls are routed to a Find Me/Follow Me personal call group. Provides a list of Follow Me (personal) call groups that can be associated with this user. To create Follow Me call groups refer to the section on Call Groups. A mechanism for limiting outbound calling for a particular user. Restrictions are defined through User Calls > Zones or Restrictions on the toolbar on the left hand side of the Users page. If defined, they will appear in the dropdown list in the User configuration form. They can then be assigned to the user by selecting the appropriate restriction from the dropdown list. If checked, the user will have the ability to administer other user s call recordings if they are assigned to them. If checked, records all the users incoming calls. If checked, records all the users outgoing calls. Configurator Admin Reference 6
Delete Voicemail after Email Monitor Calls Reporter Sound Recorder Permission If checked, deletes the voicemail in the Asterisk system after and email message is sent to the user s email address. Note: This option should be used with caution. If checked, this allows the user access the monitoring functionality such as Listen, Whisper, 3-Way and Barge, etc. from the INsight product. If checked, allows the user to access the INsight Reporter. If checked, gives this user permission to access a Sound Recorder extension to create sound files. Sound Recorder extensions are used to create sound files for use with Queues, IVRs, or Dial Campaigns. PBX User Create Campaign Permission Max Dialer Trunks Extension Voicemail List in Directory Add Device User Profile If checked, a User can be given permissions to view and manipulate selected OmegaDial campaigns. If User is given campaign permissions, Max Dialer Trunks limits the number of trunks this user can assign. Assigns an extension to the new User. An extension can be added or assigned anytime after the user is added. Creates a voicemail box for the assigned extension. A voicemail can be assigned to the user s extension anytime after the user is added. Adds the user to a printable list of User Extensions. Gives the option of immediately adding or assigning a device for this user instead of doing it in the devices tab. The device can be added or assigned anytime after the user is added. Optional contact information can be added for this user including Email, Address, City, State, Zip Code. Once the pertinent information is added to the form, select the Add New User button. The user will be added to the Asterisk system and a list of all users will be displayed. To continue adding new users without being returned to the list of users, select the Save and Add button. The new user will be added and the Add User form will be cleared and ready to add another new user. 2.1.3 Editing a User To edit an existing user, select the user by selecting the radio button next to the username and selecting the Edit User button; alternately, the username in the list is a link to the Edit User page. In Edit User mode, the same form used to add a new user will appear with the existing user s information populated in the form fields. Change the necessary information and select Save Changes. Also available to Admin level users in Configurator Admin Reference 7
Edit User mode is a list of Associations related to the user. These include Check Voicemail, Edit Contacts, Edit Devices, Edit DIDs, Edit Extensions, Queue Membership, and Queue Supervision. Check Voicemail Edit Contacts Edit Devices Edit DIDs Edit Extensions Queue Membership Queue Supervision Allows users to check their voicemail messages from the Configurator interface. Allows the user to enter and edit personal contacts. Physical handsets, soft phones, and/or virtual Agents that are assigned to the user. Incoming lines associated with the user, if any. The numbers associated with the user. Shows the queues which the user is assigned and also allows the administrator to add and remove the user from queues. Shows the queues that the user supervises, if any. The administrator can add or remove queue supervision. 2.1.4 Add User Wizard The Add User Wizard is another way to add users. The wizard takes you through all the steps to add a new user. It also enables a device and extension to be created and assigned to the user. 2.1.5 Import LDAP/AD Users This provides an import mechanism for adding multiple users if LDAP or Active Directory is the organizations preference for Authentication. 2.1.6 Assigned Channels When using OmegaDial in a hosted capacity, there may be users with permission to manipulate dial campaigns. Assigned Channels is a way to see at a glance server channels that are assigned to these users. 2.2 My Items My Items lets the user, when logged in with their username/password, access their voicemail and contacts. My Voicemail My Contacts Allows users to check their voicemail messages from the Configurator interface. Allows the user to enter and edit personal contacts. Configurator Admin Reference 8
2.3 Departments Departments can be used to segment users by physical area for large organizations. This is primarily used for intercom systems to isolate announcements to a specific location. The default department contains everyone in the Asterisk system. Selecting View Departments from the side menu produces a list of departments defined in the system. From the View Departments list, the administrator can edit, delete, or view the members of a department. To add a department, select Add Department from the side bar menu. This produces the Add Department form. Enter a department name and select the Add Department button. To edit the department name, select the radio button next to the department name and choose the Edit Department button from the View Departments screen. Change the department name and select the Save Dept button. To view members of a department, select the radio button next to the department name and choose the View Members button. This produces a list of all the members of that department. Note: Members are added to a department in the Add or Edit Users form. To delete a department, select the radio button next to the department to be deleted. Then, select the Delete Dept button. 2.4 Recordings The Recordings area allows managers to be defined and users to be associated with the assigned manager. This allows the manager permission to view and manage call recordings. 2.4.1 Add Managers To give a User permissions to view and manage other user s call recordings, select the Add Managers link from the left side bar. If there are managers already defined in the system, a list of those managers will be shown. To add a new manager, select the Add Manager button. A dropdown list of all users defined in the system will appear. Select the new manager from the list. Below the dropdown list is a section called Managed Users. This is where users to be managed by the manager are defined. The dropdown list is a list of all users previously defined in the system. Select a user from the list and select the Add button. Continue this process until all users to be assigned to the manager are added. Select the Add Manager button and the new manager will be added. 2.4.2 User Once assigned, a Manager can log in to the Configurator with their username/password and access recorded call files of users assigned to them. Selecting User produces a list of the users associated with the manager. To view call files, select the radio button adjacent to a user and select View Call Files. Alternately, the Username of the user is a link to the Recorded Calls display. Configurator Admin Reference 9
From the Recorded Calls display, the manager can filter calls by date, save calls from deletion, mark calls for deletion, and archive calls To filter calls, select a date range, and then select the Filter button. The list will be narrowed to files within that date range. To save a recording from deletion, select the check box adjacent to the file to be saved from deletion or Select All, then select the Save From Deletion button. This will change the Yes/No in the Saved From Deletion column to Yes. To mark recordings for deletion, select the check box adjacent to the file to be marked for deletion or Select All, then select the Mark For Deletion button. This will change the Yes/No in the Saved From Deletion column to No. To archive recordings, select the check box adjacent to the file to be saved from deletion or Select All, then select the Archive button. This produces an archive form. Add the email address the archive notification should be sent to and name the archive. Then select the Archive button. When the file(s) have been archived, an email is sent to the email address provided. To access the Archives, select the Archive link from the left side bar menu. This produces a list of all Recorded Call Archives for the manager. Options for archives are Download Archive or Delete Archive. 2.4.3 Queue Queue allows a Manager to easily access call recordings for whole Queues. Once assigned, a Manager can log in to the Configurator with their username/password and access recorded call files of agents assigned to their queues. Selecting Queue produces a list of the queues associated with the Manager. To view call files, select the radio button adjacent to a queue name and select the View Call Files button. Alternately, the Queue Name is a link to the Recorded Queue Calls table. From the Recorded Queue Calls table, the supervisor can filter calls by date, save calls from deletion, mark calls for deletion, and archive calls To filter calls, select a date range then select the Filter button. The list will be narrowed to files within that date range. To save from deletion, select the check box adjacent to the file to be saved from deletion or Select All, then select the Save From Deletion button. This will change the Yes/No in the Saved From Deletion column to Yes. To mark for deletion, select the check box adjacent to the file to be marked for deletion or Select All, then select the Mark For Deletion button. This will change the Yes/No in the Saved From Deletion column to No. To archive recordings, select the check box adjacent to the file to be saved from deletion or Select All, then select the Archive button. This produces an archive form. Add the email address the archive notification should be sent to and name the archive. Then select the Archive button. When the file(s) have been archived, an email is sent to the email address provided. To access the Archives, select the Archive link from the left Configurator Admin Reference 10
side bar menu. This produces a list of all Recorded Call Archives for the manager. Options for archives are Download Archive or Delete Archive. 2.4.4 Archived Selecting Archived produces a list of calls that have been archived in the Recording section. 2.4.5 Personal Selecting User produces a list of call files associated with the user. From the Recorded Calls display, the user can filter calls by date, save calls from deletion, mark calls for deletion, and archive calls To filter calls, select a date range, and then select the Filter button. The list will be narrowed to files within that date range. To save a recording from deletion, select the check box adjacent to the file to be saved from deletion or Select All, then select the Save From Deletion button. This will change the Yes/No in the Saved From Deletion column to Yes. To mark recordings for deletion, select the check box adjacent to the file to be marked for deletion or Select All, then select the Mark For Deletion button. This will change the Yes/No in the Saved From Deletion column to No. To archive recordings, select the check box adjacent to the file to be saved from deletion or Select All, then select the Archive button. This produces an archive form. Add the email address the archive notification should be sent to and name the archive. Then select the Archive button. When the file(s) have been archived, an email is sent to the email address provided. To access the Archives, select the Archive link from the left side bar menu. This produces a list of all Recorded Call Archives for the user. Options for archives are Download Archive or Delete Archive. 2.5 Call Restrictions Allows the Administrator to define a class of service and assign it to one or more users. 2.5.1 Zones Selecting the Zones link provides a list of Zones already configured as well as the option to create a new Zone. When adding a new Zone, a unique name must be given, then the restriction can be defined. When defining Zones, the variables X, Z, and N can be used to represent the following: X matches any digit from 0-9 Z matches any digit from 1-9 N matches any digit from 2-9 Numbers used in brackets are defined literally. For example [256] matches 256. 2.5.2 Restrictions Restrictions allow an administrator to create groups of Zones. Configurator Admin Reference 11
2.6 Directory When the Printable Extension List link is selected, it produces a list of User Extension that have the List in Directory option checked. 2.7 Session 2.7.1 Drop Admin Privileges (This session only) When this link is selected, the Configurator changes to Normal user access level. All Admin privileges are unavailable until the user logs out. The Admin privileges return on a successful login unless they were changed on this user. 2.7.2 Logout This logs the User out of the system. 2.8 System 2.8.1 About About provides information about the software version, host, and license data on the Asterisk server. 2.8.2 Network Configuration Network Configuration shows the interfaces and the current configuration for each. It also provides an interface for editing the network configuration. Configurator Admin Reference 12
3 Devices Devices are physical handsets or soft phones. example, a Polycom 501 handset has 3 lines). A device may have multiple lines (for From the Devices tab, an administrator can view and add devices and configure Zap Channels. The devices can be filtered by Type by choosing the type from the pull down menu under Show devices of type. Then select the Filter button. Device types are: SIP Session Initiation Protocol An IP protocol used for transporting many forms of media, including video and voice. SIP is currently the most common VOIP protocol. IAX2 Inter-Asterisk exchange Agent A VOIP protocol designed to be much more NAT friendly. currently only transports audio. A pseudo-channel for routing calls to an ACD agent. IAX Local Zap A pseudo-channel that loops back into the dialplan in a different context. A channel that communicates with a Zaptel device driver used to access Zaptel telephone interface cards. 3.1 Devices 3.1.1 View Devices View Devices produces a list of all devices created in the Asterisk system. From View Devices, the administrator can add a new device, edit an existing device, or delete a device. The list can be filtered here by device type. The device may be edited by selecting the radio button that corresponds with the device to be edited then selecting Edit Device. Alternately, the device can be clicked which will also put you in edit mode. In Edit mode, the Type, Device Name, Assign To, and Friendly Name can be changed. Once the necessary changes are made, select Save to save the changes. 3.1.2 Add Device From the Devices tab, select Add Device. This produces the Add Device form. Select the Server for the device. Select the Type of device to be added (SIP, IAX2, Agent, Local, or Zap Trunk). Device Name is user defined. Assign to is a pull-down list of all the users in the system. Friendly Name is optional. You can define Context (all_calls is the default), set the Type, Secret, DTMF Mode (Dual-tone multi-frequency), Host, and NAT (Network Address Translation). When the form has been completed, select Add & Exit to save the device, Add & Clone to save the device and keep the data in the form to Configurator Admin Reference 13
create another device with the same attributes, Add New to save the device and clear the form to create a new device or Cancel to not save the device and clear the form. Server Type Device Name Assign to Friendly Name Account Code Context Usable as Trunk Insecure Username Codecs From Username From Domain Type Secret DTMF Mode RFC2833 Compensate Available servers will be in a dropdown list. Choose the server in which the new device should register. Provides a drop-down list of the available types of devices that can be added to the server. Name of the device. This should be the same as the devices Username in the physical phone configuration. Provides a drop-down list of all user that the device can be associated with. It can also be left Unassigned. Name that shows on the device when it registers to the server. Data (typically used for accounting) that passes with the call string when a call is made from this device. A collection of extensions on the Asterisk server. Default is all_calls. When checked, creates a trunk or group of channels. Type of security for a device. Name sent with the password for authentication. The type of encryption or encoding to be used. Auth username to be sent in the From header of the sip INVITE. These are NOT needed unless your provider requests them. Auth domain to be sent in the From header of the sip INVITE. These are NOT needed unless your provider requests them. Friend can send and receive calls, User can only send calls, and Peer can only receive calls. Password for the device. This should be the same as the devices Password in the physical phone configuration. Provides a drop-down list of the DTMF signaling methods. Default is RFC2833. Sets the sip flag for broken/strict implementations of the RFC2833 DTMF handling. Use only if carry requires RFC2833 and there are problems with DTMF. Call Limit The number of inbound and outbound calls that can be received/made on the device. The number correlates to inbound and outbound. For instance one means there can be a maximum of Configurator Admin Reference 14
one inbound and one outbound call at any given time. Pickup Group Host Port NAT Qualify Speakerphone on Internal Calls Register? A group of User s that can answer devices within the group from a separate device. For instance all devices in the Pickup Group 1 can answer calls that are ringing on devices that are also a member of Pickup Group 1. The maximum number of Pickup Groups that can exist on an Asterisk system is 63. Determines if the device can connect from any IP address or is limited. Default is dynamic. The port on the server used to send and receive data. Default is 5060. Network Address Translation helps determine if this device is on the internal network or outside the firewall. Turn NAT to register devices outside the internal network. Determines if the system periodically checks to see if the device is still available. Allows the devices speakerphone to be used as an intercom. Determines whether the device registers to the carrier to tell them where it is. This is only for carriers. 3.1.3 Configure Zap Channels Available Zaptel Channels can be configured here for use with devices. 3.1.4 Manage Servers Manage Servers provides a list of all Asterisk servers available. From this list, servers can be added, edited or deleted. To add a server, select Add Server from the Server page. In the blank form, provide a Name. Enter the IP address in the Host field. Provide the Port. Assign a Username and Password. Select the check box next to Use For Dialer if this server will be used for dial campaigns with the OmegaDial product. Select the Save Server button. To edit a server, select the radio button next to the server to be edited (or select the server name) and select Edit Server from the Server page. The same form used to add a server will appear populated with information related to the selected server. Make any necessary changes to the server information and select the Update Server button. To delete a Server, from the list of Servers, select the radio button adjacent to the Server to be deleted. Then, select the Delete Server button. 3.2 Session See Session in Section 2 Users. Configurator Admin Reference 15
3.3 System See System in Section 2 Users. Configurator Admin Reference 16
4 Phones Phones is an auto-discovery tool for devices on the Asterisk system. It currently only supports Polycom phones. The main page shows a list of Detected Phones not yet Configured and a list of Configured Phones. With this tool, you can Upload New Firmware, Regenerate Config Files, and Reboot Configured Phones. By selecting a phone in the list of Detected Phones Not Yet Configured, the admin has the ability to Assign the device, identify the Model, Assign the individual lines on the phone, and Edit the Sidecar if one exists. 5 Extensions Extensions are numbers that identify which device or devices to ring. The Extensions tab contains the commands to view, add, and edit extensions and DID routing rules. The extensions can be filtered by Type by choosing a type from the Show extensions of type pull down menu. Then select the Filter button. Extension types: User Extension, DID, IVR, Queue, Call Group, Auto Directory, Music On Hold, Agent Login, Voicemail Main, Conference Room, Parking Lot, Dynamic Agent Login, Dynamic Agent Logout, Direct To Device, ASG Agent Login, Direct to Fax, and Sound Recorder. 5.1 Extensions 5.1.1 View Extensions View Extensions produces a list of all extensions in the Asterisk system. The list can be filtered by extension type by selecting from the pull down list of available extension types and selecting the Filter button. The extension can be edited by selecting the radio button that corresponds with the extension to be edited and selecting Edit Extension. Alternately, the actual extension is a link and can be selected which will put you in edit mode. When in Edit mode, the Number, Extension Type, and Destination can be edited. The Voicemail can be toggled on or off by selecting the checkbox. Make necessary changes and select Save Extension to save changes. 5.1.2 Add Extension From the Extensions tab, select the Add Extension link from the left or the Add Extension button from the bottom of the list. This produces the Add Extension form. Assign a Number from a group of extensions assigned by the provider. Select an Extension type from the pull-down list. Depending on the type selected, the destination fields change. For example, if User Extension is selected, a dropdown list of all users defined in the system appears. With User Extension, checking the Voicemail check box will allow this user to have a voicemail account. Once all fields are populated, select Add New Ext. button. Extension types defined: Configurator Admin Reference 17
User Extension DID IVR Queue Call Group Auto Directory Music on Hold Voicemail Main Conference Room Dynamic Agent Login Dynamic Agent Logout ASG Agent Login Direct-to-Device Sound Recorder ASG Agent Callback Login ASG Agent An extension given to an individual or unassigned that has the option to create a voicemail box, be listed in the directory, and has a timeout period assigned. The timeout period determines how long Asterisk tries the call before the call rolls to voicemail, if a voicemail box exists. Direct inward dial is a number that can be dialed from outside the Asterisk system and is directed to an extension. It can be directed to any type of extension such as a user extension, queue, conference bridge, IVR, etc. Interactive voice response system is a phone tree or a way to direct calls. Queues are holding areas for calls waiting to be answered typically by agents in a call center. Hunt-type or ring-all groups A directory of user extensions that can be accessed from the phone and searched by name. Music or sound files that a caller hears when they are put on hold or are waiting in a queue. An extension that accesses the voicemail system and allows messages to be retrieved. Bridge numbers that allow multiple people to join a call. Login extension for a Dynamic Agent which associates the agent and a device with the queues in which they belong. For more information on agent types, See Queues. An extension for a Dynamic Agent that logs their user and device out of the Asterisk system at the end of their shift. Login extension for an ASG Agent which associates the agent and a device with the queues in which they belong. For more information on agent types, See Queues. Rings a device directly that is not attached to a user. Records audio messages and stores them in the Sounds area for reuse. Login extension for an ASG Agent which associates the agent and a device with the queues in which they belong and calls them when they get a call. For more information on agent types, See Queues. An extension for an ASG Callback Agent that logs their user and Configurator Admin Reference 18
Callback Logout Find Me/Follow Me Direct to Voicemail DID Redirect Inbound Campaign device out of the Asterisk system at the end of their shift. A personal hunt group. See Call Groups for detailed information on Find Me/Follow Me. Sends a call directly to a voicemail box without ringing a device. Redirects a call to a trunk that you specify based on the DID Sends the call to a dial campaign, allowing dial campaigns to be run on inbound calls. This provides all the reporting of an outbound dial campaign on inbound calls. 5.2 Routing 5.2.1 DID Routing Rules Time-based DID routing rules tell Asterisk what to do with DIDs (incoming calls) during specific times and dates. Calls can be sent to a specific extension, queue, IVR, etc. From Time-based DID Routing Rules, the administrator can add, edit, and delete rules. To Add a new rule, select DID Routing Rules, then Add Rule. From the drop down list, select the DID Extension that requires a time-based routing rule. Enter a Start Time, End Time, Destination Extension, and check the days of the week you would like the rule to be applicable. Once all the information is populated, selecting the Add New Rule button will create the rule and make it active. 5.2.2 Outbound Routing Outbound Routing is a tool for directing outbound calls by using Dialed Number Routing Rules. Selecting the Outbound Routing link produces the Dialed Number Routing Rules page. Here outbound routing rules can be defined. To add a new routing rule, select the Add Route button and complete the Add Routing Rule form. Options include: Pattern Trunk Forced CID Strip Digits from Dialstring Trunk Prefix A series of numbers and characters that define how a number should be entered to make an outbound dial. Rules include: [0-2] - Match any SINGLE digit within a range X - Match any SINGLE digit 0-9 N - Match any SINGLE digit 2-9 Z - Match any SINGLE digit 1-9. - Match any digit, unlimited length A dropdown list of available trunks to associate with this rule. CallerID of the call made with this routing rule. (Optional) Defines digits that need to be removed from the dial string at the beginning, end, or both. (Optional) Appends digits to the beginning of a call dialed using this Configurator Admin Reference 19
(Prepended) Emergency Route? Routing Rule. If checked, designates this route as an emergency route. 5.3 Directory 5.3.1 Printable Extension List When the Printable Extension List link is selected, it produces a list of User Extension that have the List in Directory option checked. 5.4 Parking Parking is putting a call in a hold area where other users can retrieve the call. 5.4.1 Settings Parking Settings defines the parking area. The settings are: Park Extension Park Positions Parking Duration Parked Music On Hold Class The assigned extension to the Park Area. This is the extension the call is transferred to when placed in the hold area. Defines the numbers of the spaces where calls can reside in the park area. When a call is transferred to the park area (parked), the park position is announced. This is the number that should be called to retrieve the parked call. The amount of time the call can hold. When the Parking Duration expires, the call goes back to the person that put the call in the park area. Defines the music on hold that the caller hears while they are in the park area waiting for their call to be answered. 5.5 Session See Session in Section 2 Users. 5.6 System See System in Section 2 Users. Configurator Admin Reference 20
6 Queues Queues are set up in Asterisk to route calls to specific groups of devices. Queues, unlike Call Groups, have waiting functionality associated, so that many calls can knowingly wait to be answered when a device becomes available. When there are many calls, queues are useful to help manage the call volume. In the Queues tab, queues are created, edited, deleted; and members (agents) and supervisors are added, removed and permissions set. 6.1 Queue Settings 6.1.1 View Queues View Queues allows the administrator to view the queues. From this point, the administrator can also Add new queues, Copy a queue, Edit existing queues, view Members of the queues, view Supervisors, and Delete queues. Add Queue Copy Queue Edit Queue Members Creates a queue. Copies the attributes of the selected queue when creating a new queue. Edits the selected queue. Accesses the Members in a queue. Enables the administrator to Add and Delete users (members) from the selected queue. The available member types are static, dynamic, and ASG Agent. A drop down list of the member type and users/devices in the Asterisk system is provided. To add a member, select the type from the pull down list, then select a user from the pull down list. Once a member is added to the queue, Penalty allows the administrator to assign a number to the agent to prioritize which agent gets the call first in the queue. Prioritization for Penalties is 0=highest priority and 10=lowest priority. Member or agent types are: Static Dynamic ASG Agent Agent has a device assigned to them that is always in their associated queues. Agent logs into their queues through their device which puts the device into the queue. They can then hang up the device and it will ring when a queue call is routed to the device. The agent logs out of the queue with the device when their shift is over. Agent logs into their queues by dialing in with a device. Once they dial in, the device is actively in the queue until the agent hangs up the device. The agent doesn t have to answer the device to take a call. They will listen to music on hold until a queue call is routed to them. To Configurator Admin Reference 21
terminate a call without logging out of the queue, the agent presses * on the device. To log out of the queues, the agent hangs up the device. Supervisors Delete Queue Accesses the Supervisors of a queue and allows the administrator to View, Add, Edit, and/or Delete supervisor permissions for the selected queue. Deletes an existing queue. When a queue is selected from the View list, the Queue Detail view is displayed. In the Queue Detail view, Queue Settings, Quick Stats for Today, Queue Members, and Queue Supervisors can be viewed and accessed. 6.1.2 Add Queue From the Queues tab, select Add Queue from the link on the left or the button at the bottom of the list. This produces the Add Queue form. Give the queue a name (i.e. Sales, Marketing, Support, etc.). Enter information for the following fields: Queue Name Strategy Join Empty The name given to the queue. Implements a ring strategy for the queue. There are several ring strategies to select from the drop down menu. Defines whether a caller can join an empty queue or not. Options are: Yes Callers can join a queue with no members or only unavailable members No Callers cannot join a queue with no members. This option produces an extension field to define where the call be routed. Strict Callers cannot join a queue with no members or only unavailable members Note: This option does not work with Static agents. Leave Empty Defines whether a caller can leave an empty queue or not. Options are : Yes Callers cannot stay in a queue with no members. This option produces an extension field to define where the call should be routed. No Callers can stay in a queue with no members Strict Callers can stay in a queue with no members or only unavailable members Configurator Admin Reference 22
Note: This option does not work with Static agents. Weight Wrapup Time Agent Timeout Queue Timeout Timeout Extension Escape Key Escape Extension Assist URL Collect Dispositions Post-Call IVR Outbound CID Number User Data Music On Hold Music On Hold Class Allows the administrator to assign a number to the queue to prioritize which calls are answered first in the event calls are waiting to be answered in multiple queues. An amount of time an agent is given after a call is complete to do any after call work before being made available to take another call. Wrapup time is in seconds. An amount of time an agent is tried before a different agent is tried. (For all Strategies except Ring All.) An overall amount of time the call waits in a queue unanswered. Allows the call to be routed to an extension when the Queue Timeout period has expired instead of hanging up the call. Allows a hot-key to be defined so the caller can exit the queue and be transferred to the assigned Escape Extension. This should be defined if using an Escape Key. This is an extension in which the caller will be transferred if the Escape Key is pressed. Specifies a default screen pop in Assist (Asteria Solutions call center agent product) for calls entering the queue. Assist URLs are defined in the Agent URLs links under Agent Settings in the Queues tab. (Option not available for Quick Queues) A pull down list to determine where to collect call dispositions if they are being utilized. If no post-call disposition is necessary, None should be selected. The other options are to collect the dispositions via the agent/csr device (Phone) or with a dropdown list from Assist (Assist Agent Client). Provides a drop down list of IVRs that are defined in the system. Post- Call IVR allows an IVR to be specified that the caller will enter when a queue call has been completed. Allows a caller ID number to be specified for the queue. If the agent/csr is using Assist to do outbound dialing, the CID can be specified prior to the call with a pull down list provided in Assist. An open field for any custom development that may need to be done. When checked, allows the caller to hear music on hold for that particular queue. Allows music on hold to be defined by the administrator. Classes can be defined in Sounds with the Music On Hold link. Sound files can then be uploaded to a specific class. In the Music On Hold Class of the Configurator Admin Reference 23
queue configuration, a class name can be specified and the sound files uploaded to that class will be the music on hold. Position Announce Position Announce Frequency Announce Holdtime with Position Periodic Sound Periodic Sound Frequency Call Recording Recording Frequency (out of 100) Agent Announcement Agent Threshold Call Wait Alert Call Length Alert CallerID Prepend Text Color Reports to the caller their position in the queue if Yes is selected in the queue configuration. How often an IVR announces the caller s position in the queue. If set to Yes, an estimated hold time will be announced with the position announcement. A sound that plays periodically when a call is holding in a queue. The dropdown list will produce a list of sounds from the IVR custom Sounds. How often a periodic announcement is made when a call is holding in a queue. Determines the recording strategy of the queue. Choices are to record all calls, no calls, randomly record calls, and on-demand. Specifies the frequency of random call recording. A sound file played to the agent before they get a call. The number of agents that should be logged into a queue at any given time. There is an alarm in INsight that lets the supervisor know if the number of agents logged in goes below what is set for the threshold. An acceptable amount of time a call can wait to be answered in a queue. If the time exceeds the acceptable time specified, an alarm in the INsight Queue Viewer lets the supervisor know calls are waiting too long in the queue. An acceptable amount of time that the agent should speak with a caller. If the time exceeds what is defined here, the agent card will flash in the INsight Queue Viewer. Prepends information added in this field along with the CallerID. Allows the queue color in INsight to be user definable. When all information is entered, select Save Queue to create the queue. Configurator Admin Reference 24
6.2 Settings 6.2.1 View Assist URLs Agent URLs are web addresses used to provide screen pops in Assist to aid the agent/csr when taking calls. The View Assist URLs link displays a list of Assist URLs currently defined in the system. 6.2.2 Add Assist URLs To add an Assist URL, select the Add Assist URL link. The Assist URLs form will appear. Name the URL in the Name field and define the URL in web address format (example http://www.asteriasgi.com). 6.2.3 Pause Reasons The Pause Reasons link allows administrators to define agent pause reasons. When a pause is implemented through Assist or INsight, the agent is paused from taking calls in all associated queues during the pause period. Adding Pause reasons populates a drop down menu in INsight. To define a pause reason, simply name the reason and select the Add button. Pause reasons can also be deleted by selecting the radio button that corresponds with the reason to be deleted and selecting the Delete button. 6.2.4 Dispositions The Dispositions link allows call dispositions to be defined. The dispositions can be queue specific and provide a way for calls to be tagged for users that may not need the detail that a CRM package provides, but still need to know the disposition of calls. They can be collected with the agent s device or with a pull down list in Assist. To define a disposition, select the Add button. The Add Disposition form will appear. Queue ID is a drop down list of all queues defined. Select from the list which queue should be associated with the disposition being added. The Disposition Code is a numeric code associated with the Disposition. It should be no longer than 4 digits and is used when dispositions are collected via the agent device. The Text field is the actual description of the disposition and can be one or multiple words. The description in the text field will appear in the drop down list in Assist if dispositions are being collected with that method. If call dispositions are used in either collection method, a Disposition Report is available in the INsight Reporter. 6.2.5 Apply Changes Now The link called Apply Changes Now restarts a service that causes INsight and Assist to be updated with any configuration changes that have been made to the queues. If any users are logged into these products, it will log them out and they will be forced to log in again. The calls will not drop, but INsight and Assist sessions will be disrupted. 6.3 Session See Session in Section 2 Users. Configurator Admin Reference 25
6.4 System See System in Section 2 Users. Configurator Admin Reference 26
7 Call Groups Call groups are set up for answering incoming calls. The groups can be a Hunt type group that rings one phone after another in a given order until the call is answered; a Ring All type group that rings all phones in the group simultaneously; a Paging type that sets up a group of devices for paging using the speaker functionality on the device; or a Find Me/Follow Me type which is basically a personal hunt group. 7.1 Call Groups 7.1.1 Add Group To add a new Call Group, from the Call Groups tab, select the Add Group button. This produces the Add Call Group form. With Hunt and Ring All groups, give the new Call Group a Name, a Fail Extension, which is a rollover extension that will ring if the call is not answered, and choose a call group Type from the pull down list. If Paging type is selected, the Fail Extension field is replaced with Full Duplex check box. Check the box if you want the devices in the paging group to have the ability to answer the page. Note: The incoming call will go to the voicemail of the Fail Extension if it is not answered. 7.1.2 Edit Group Call Groups can be edited by selecting the group from the list. The administrator can select the radio button next to the group name then select Edit Group or the actual group name is a link that also takes you to the Edit Group form. Edit Group allows the administrator to edit the basic properties of the call group such as Name, Fail Extension, and Ring Type. To save changes, select the Save Group button. 7.1.3 Edit Members This allows devices (called members) to be added or removed and member priority to be specified for the selected call group. To add members to a group select the group to be edited from the list of call groups. Then select the Edit Members button which produces the View Group Members form. A drop down list of devices available lets you easily choose which device to add. In a Hunt group, a Ring Time can be specified for each individual device. In a Ring All group, the Ring Time is a global setting for all of the devices in the group. In a Paging group, there is no ring time associated. The devices auto answer and the page or announcement is sent through the speakerphone function of all devices in the group simultaneously that are not in use. Once members are added to the group, the administrator can Remove a member or reorder the list by using the Move Up or Move Down buttons. In a Hunt group, devices will ring in the order they are listed. 7.1.4 Delete Group This deletes the entire selected Call Group. When selected, a message appears confirming the group should be deleted. Configurator Admin Reference 27
7.2 Call Groups (side menu) 7.2.1 View Groups View Groups allows the administrator to view a list of all Call Groups defined in the system. From the View Groups screen, the administrator can also add groups, edit groups, view members of a group, and delete groups. 7.2.2 Add Group To add a new Call Group, from the Call Groups tab, select the Add Group link. This produces the Add Call Group form. Give the new Call Group a Name, a Fail Extension, which is a rollover extension that will ring if the call is not answered, and choose a ring Type from the pull down list. Note: The incoming call will go to the voicemail of the Fail Extension if it is not answered. 7.2.3 Find Me/Follow Me Find Me/Follow Me is a personal call group. It provides the owner of the call group the ability to receive calls by adding numbers other than the desktop device. To add a Find Me/Follow Me, select the Find Me/Follow Me link from the left menu. A list of existing Find Me/Follow Me groups is displayed. From this display, Add New, Edit (existing), and Delete (existing) can be accessed. To add a new Find Me/Follow Me group, select the Add New button. Enter information for the following fields: Name Take Call Decline Call Fail Extension Record Caller Name Call From Prompt No Recording Prompt Options Prompt Please Hold Prompt The name given to the Find Me/Follow Me group. A key press defined to accept the call with the current device. A key press defined to decline the call with the current device, sending it to the next device or voicemail. An extension the call will go to it is not accepted or there is no answer. If checked, the caller will be prompted to say their name which will be recorded and played back to the callee. Plays the selected sound file to the callee in conjunction with the recorded caller name. Plays the selected sound file to the callee if no recorded caller name exists. Plays the selected sound file to the callee to explain the accept/decline options. Plays the selected sound file to the caller to request them to hold on the line for the callee. Configurator Admin Reference 28
Once the above information has been entered, the Add Row button lets you enter the numbers that should be associated with the Find Me/Follow Me group. For example, office extension, cell number, home number, etc. are all types of numbers that can be added to the group. Note: If the PBX requires number(s) to be pre-pended, those numbers should also be entered. In addition to the number, a timeout period should be assigned for each. The timeout period is in seconds and is the amount of time that Asterisk will try that number before moving to the next number in the list. The numbers will be dialed by row in a hunt type in the order that they are listed. The symbol creates additional columns on the row where numbers can be entered. If a row has multiple columns, each number in the row will ring simultaneously for the amount of time entered in the timeout field. The symbols move the rows up or down if the ring order needs to be changed. 7.3 Session See Session in Section 2 Users. 7.4 System See System in Section 2 Users. Configurator Admin Reference 29
8 Conferences Conference Rooms are conference bridges set up in Asterisk. In this tab, administrators can add, edit, and delete conference rooms. 8.1 Conferences 8.1.1 Add Room Selecting the Add Room button in Conference Rooms produces the Conference Rooms form. Enter information for the following fields: Name User Pin Admin Pin The name given to the Conference Room. Access code for participants to enter the conference bridge. This is optional as do not require User or Admin Pins. Access code for the administrator of the conference call to enter the conference bridge. This is optional as do not require User or Admin Pins. Additional Options when creating a Conference Room are: Announce when user joins/leaves the conference This provides a drop down list allowing you to select No Announcements, With Review, Without Review, and Quiet Mode Disable you are currently the only person in this conference message for first member Allow user to exit the conference by pressing #. Present menu (user or admin) when * is received. Announce user(s) count on joining a conference (does not work with Quiet mode) Close the conference when the last admin exits. Wait until admin enters the conference. *Users will hear MusicOnHold until the admin enters (if music on hold is enabled). Enable music on hold for the conference (does not work with quiet mode). When the information is complete, select the Add New Room button. Once Conference Rooms are created, an extension can be assigned to them in Extensions. When creating a Conference Room extension, a pull down list of all conference rooms will be produced as the extension Destination. Configurator Admin Reference 30
8.1.2 Edit Room Conference Rooms can be edited by selecting a Conference Room from the list. The administrator can select the radio button next to the Conference Room name then select the Edit Room button; alternately, the Conference Room name is a link that also takes you to the Edit Room form. Selecting the Edit Room button allows any of the Conference Room options to be edited. Once the information is updated, select Save Changes to save changes. 8.1.3 Delete Room This deletes the selected Conference Room. 8.2 Session See Session in Section 2 Users. 8.3 System See System in Section 2 Users. Configurator Admin Reference 31
9 CDRs 9.1 CDRs 9.1.1 Show CDRs Call Detail Records can be viewed from this link. Various filters can be set to show records by Date, From Number, To Number, Both From and To Numbers, and/or User. Information available for viewing is Call Date, Channel, Source, Destination, CallFile, LastData, Disposition and Duration. The arrow links at the bottom of the list allow page navigation through the list. << and >> Go to the first and last pages respectively. << and >> Go to the next or previous pages respectively. Call Detail Records can also be exported as a CSV file. To do this, filter the report you would like exported and select the Export button. A dialog box will appear with the option of Save or Cancel. Selecting Save produces as Save As window. Select a location to save the file and rename if desired. Select the Save button and the file is saved. 9.2 Call Recordings 9.2.1 Purge Settings Call recordings by default are saved on the system for 60 days. Purge settings let the administrator configure the length of time to keep the recordings on the system. To configure the purge settings, select the check box next to Enabled, enter the number of days that recordings should stay on the system, then select the Save Changes button. To change the settings, simply change the number of days and select the Save Changes button. 9.3 More Reports 9.3.1 Inbound/Outbound Calls This report filters the calls detail records to only show inbound and outbound calls. The filter allows filtering by date and either inbound or outbound. Data shown in this report format is Source, Destination, Call Date, Inbound/Outbound, and Duration. 9.4 Session See Session in Section 2 Users. 9.5 System See System in Section 2 Users. Configurator Admin Reference 32
10 IVRs All Interactive Voice Responses (IVRs) are set up in this section. IVRs are used as an auto attendant and most simply used to route calls to extensions or queues. In the Configurator IVR setup tab, IVRs can be one simple command (called state) or many states connected to create a call flow. 10.1 IVRs IVRs are Interactive Voice Responses and can direct call flow. While typically used to direct inbound calls, they can also define a call flow for an outbound call with OmegaDial, ASG s automated dialer product. For more information on OmegaDial, please see the OmegaDial User s Guide. 10.1.1 Add IVR To add an IVR select the Add IVR button or the Add IVR link from the main IVR page. Give the IVR a Name and select the Add IVR button. This adds a new IVR and goes to the Edit State page. The next step is to Edit the states of the IVR. 10.1.1.1 Edit IVR Once an IVR is added it must be edited and a state or series of states added to direct the call flow. A Start state is added automatically to every new IVR. When adding a new IVR, the system goes to the Edit State form with the Start state populated. A state consists of a Name, Action, subsequent action called Then, and Set Tag. Following is a list of those fields and their definition. Name Action Then Set Tag Used for reference purposes and must be unique. Determines the function of the state. Defines the next state or action. Set Tag, if checked, allows a tag to be defined that is attached to the call string unless it is overwritten by a tag in another state. These tags can be displayed in ASG s call center products. Actions an IVR can perform include: Play Sound Plays a stock, custom, sound file. It can also play a phrase which is multiple sound files linked together or a variable. (For more information on sound files, see Sounds.) The Play Sound option also produces the AMD checkbox. AMD is Answering Machine Detection and used when the IVR is for an outbound OmegaDial dial campaign. If AMD is checked, the AMD On Machine Goto: dropdown list appears. The dropdown list defines Configurator Admin Reference 33
what happens if an answering machine is detected. AGI Command Hangup Forward Send to Queue Capture Digits Send to User Send to IVR Send to Extension Set Monitor Add to DNC TTS Conditional Time Conditional Return Send Fax Accept Reject Set Language AGI (Asterisk Gateway Interface) is an interface for adding functionality to Asterisk with many different programming languages. This action allows an AGI command to be added to the IVR. The Expand Variables checkbox appears if AGI Command is selected as the action. Hangs up the call. Sends the call to a number outside the PBX. Sends the call directly to a queue that resides on the Asterisk server. Allows DTMF to be entered, and captured as a variable to be stored or used later in the call. Sends the call to a User on the Asterisk system. Sends the call to another IVR. Sends the call to an Extension on the Asterisk system. Starts a call recording. Adds the caller ID to a table called DNC (Do Not Call). This does not relate to the National Do Not Call List. Allows text-to-speech if a text to speech engine is implemented. Allows a value to be assigned to a variable and, based on the value being true (Yes) or false (No), determine what the call should do next. Allows a time and day range to be defined and, based on whether the current time is inside (Yes) or outside (No) that range, determine what the call should do next. Forces the call to return to the previous state even if it s in a different IVR. Sends a.tif or.jpg file (from the uploaded faxes in Sounds), Station ID, and Company name. In a Find Me/Follow Me IVR, this accepts the call. In a Find Me/Follow Me IVR, this rejects the call and sends it to the Fail number. Sets the language folder for sound files to be pulled from in a multilingual IVR. Configurator Admin Reference 34
Once the Action is decided, Then should be defined. The actions for Then differ depending on the Action. Then can go to a different State or Wait for Keypress. If Wait for Keypress is selected, a list of numeric keys appears with check boxes next to each. Once a box is checked, a drop down menu of States appears next to the numeric key. If there are no additional states defined, select Create New State and name the new state in the field provided. This will create a placeholder so that the new state can be defined once the current state is saved. Wait for Keypress also evokes the following additional options: Use sentences Allow extension dialing Allow loosely matched extensions? Capture Digits This works with speech recognition if a speech recognition engine is implemented. When a Speech Recognition Dictionary is selected, the words or phrases that are in that dictionary are available when Use Sentences is checked. The items contained in the dictionary will be listed with check boxes next to each. They will typically correlate with one of the DTMF choices that were previously selected. If a dictionary item is checked, a drop down list of states will appear. One of the states should be selected to define the action that should happen when the sound or phrase is detected. If an appropriate state is not listed, a new state can be created. Allows callers to directly dial an extension that exists on the Asterisk system. If Wait for keypress in invoked, the system will pause to wait for other digits to be pressed before assuming the DTMF is actually a Wait for keypress option. Allows callers to directly dial an extension with a set number of digits (which are defined) that are not necessarily created with the Configurator. *Advanced option. If Wait for keypress in invoked, the system will pause to wait for other digits to be pressed before assuming the DTMF is actually a Wait for keypress option. Allows DTMF to be captured. If checked, other options for capturing digits can be defined. The are: Variable Max Digits Next State Allow Speech A name given to the digits being captured that can be used in queries or AGI commands. The maximum number of digits that the caller can make. When they enter the max number as defined, the IVR moves to the next state and no more digits can be entered. If the caller enters fewer than defined, Asterisk will wait for additional DTMF to be entered before moving to the next step. The default wait time is 10 seconds. Defines where the next state in the IVR. If speech recognition is being used, selecting Allow Speech lets the user say the numbers instead of Configurator Admin Reference 35
entering them on as key presses. Mode Speech recognition has built in dictionaries for Numbers, Digits, and Dollars and Cents. Mode allows one of these to be selected if the DTMF being collected is for one of these types. Speech Recognition Dictionary Bad Choice Sound Replays Fail State If using speech recognition, dictionaries of words and phrases to be listened for, will be created in Sounds. This provides a drop down list of the speech recognition dictionaries that exist in Sounds that can be associated with this state. Used in Wait for Keypress, this provides a dropdown list of sound files that can be played if a call makes a keypress that is not defined. Provides a dropdown list from 0-10 to define the number of replays of the current state if no keypress is made. The default timeout for this is 10 seconds. If none of the defined keypresses are made and there are no replays or the max number of replays is exhausted, the Fail State defines what should happen next. Once the Start State is defined satisfactorily, select Save State to save the state or changes. 10.1.1.2 Copy IVR To copy an IVR, simply select the radio button next to the IVR to be copied, then select the Copy button at the bottom of the list or the Copy IVR link in the menu on the left side of the page. This will produce the Copy IVR page. Provide a name for the new IVR and select the Copy IVR button. The list of defined IVRs appears with the new IVR. If any adjustments need to be made, open the new IVR, make the adjustments, and save the changes. 10.1.1.3 Delete IVR To delete an IVR, select the radio button next to the IVR to be deleted, then select the Delete button at the bottom of the list. A confirmation dialog box will appear asking to confirm the deletion. Select OK to delete the IVR or Cancel to disregard the delete command. 10.1.1.4 Move IVR The Move function provides a method to organize IVRs. There must first be Folders to move the IVRs into (see Create Folder). To move an IVR into a folder, select the radio button next to the IVR that should be moved, then select the Move button or the Move IVR link from the menu on the left of the page. A pull down list called New Parent will appear. Select the appropriate folder from the pull down list, then select the Move IVR button. Configurator Admin Reference 36
10.1.1.5 Create Folder Creating folders provides a method to organize IVRs. To create a folder, select the Create Folder button to be taken to the Add Folder form. Provide a name for the folder and select a Parent for the folder from the dropdown list. If the folder should be at the top level, choose the / folder. Otherwise, folders can belong to other folders. Once folders are created, IVRs can be moved into them or created within them. 10.2 Session See Session in Section 2 Users. 10.3 System See System in Section 2 Users. Configurator Admin Reference 37
11 Sounds The Sounds area is used to upload and manage voice recordings and sound files to be used on the PBX. Sounds may be recorded using a Sound Recorder extension on the PBX, a professional talent or created with other voice recording applications. 11.1 Sounds Selecting the Sounds link will produce the Recording Studio. At the top of this section, there are two tabs, Files and Folders. Files is where sounds are uploaded. Folders is where directories can (optionally) be created to organize the sound files. Sound files can be uploaded by selecting the Browse button to find the file on the system or network. If it will be organized in a folder, select the folder from the / dropdown list. If it is for a multilingual IVR, select the appropriate language from the English dropdown list. If there are multiple files to be uploaded, select the Add Another File button. This will produce an additional line to add a file to be uploaded. Continue this process until all files to be uploaded are listed. When the list is complete, selecting Upload will load the files and they can then be used by Asterisk for IVRs and Queues. When all files are uploaded, they will show up in the Contents area in list form where they can be selected for use, Renamed, or Deleted. The sound files can also be opened and played by selecting the file name. To select a file to use in an IVR, check the corresponding box next to the file name and select the Submit button. 11.2 Phrases Phrases allows sound files to be linked together so that they play continuously. To connect sound files select Add Phrase, select a sound file from the New dropdown list then select Update. Continue this process until all the necessary sound files are connected. 11.3 Music On Hold The Configurator provides a MusicOnHold Manager. This allows custom music on hold to be uploaded and played for a queue. Classes, similar to folders, are created and music is uploaded into a class. The class can then be designated as Music on Hold for a queue. To access the MusicOnHold Manager, select the Music on Hold link in the Sounds tab. Two tabs, Files and Classes, will be displayed. 11.3.1 Classes for Music On Hold Classes provide a method for organizing sound files intended for Music on Hold and designating those sound files as Music on Hold in queues. To add a class, select the Classes tab within the Sounds tab. Create Class will require a name for the class. Once a name has been added, sound files can be uploaded into the class by selecting the class from the drop down list in the Upload File section. Browse the network and follow the directions above for uploading sound files. To play sounds within a class as Music on Hold in a queue, refer to the Queue section of this manual. Configurator Admin Reference 38
11.4 Speech Recognition Speech Recognition provides a tool to create dictionaries if a speech recognition engine is implemented. Dictionaries are lists of words or sounds that the speech recognition engine will try to detect. Selecting the Speech Recognition link produces the Speech Recognition Dictionaries page. The Speech Recognition Dictionaries page presents a list of dictionaries that have been previously created and exist on the Asterisk system. On this page, you can Add new dictionaries, Edit existing dictionaries, or delete dictionaries. 11.4.1 Add Dictionary To add a new dictionary, create a unique name in the New: field and select the Add Dictionary button. 11.4.2 Edit Dictionary To add an item or items (words or phrases) to the dictionary, select a dictionary either by selecting the radio button next to the dictionary and selecting the Edit Dictionary button or selecting the actual dictionary name which is a link to the Edit page. Select the Add button, to add dictionary items. Sentence Return Value Confirmation Sound Add the word or phrase that the Speech Recognition engine should detect A value for what was said usually the same thing as the sentence, but it can be used to create alternate ways to say the same thing as the sentence. A sound file can be played to the caller if the word or phrase they spoke was correctly detected. If Confirmation Sound is checked, drop down lists appear to determine what sound file should be played. 11.5 Faxes Faxes allows.tif and.jpg files to be uploaded for auto-faxing with OmegaDial. To upload files for faxing, select the browse button and choose a file to be uploaded. Only.tif and.jpg files can be uploaded. Then select the Upload button to upload the file. When files have been uploaded, they can be renamed if necessary by selecting the checkbox next to the appropriate file and selecting the rename button. This creates a field with the file name. Make the necessary changes and select Submit. 11.6 Session See Session in Section 2 Users. 11.7 System See System in Section 2 Users. Configurator Admin Reference 39
Configurator Admin Reference 40