FortiVoice Phone System 5.3.0 Administration Guide

FortiVoice™ Phone System 5.3.0
Administration Guide
FortiVoice Phone System 5.3.0 Administration Guide
November 3, 2017
4th Edition
Copyright© 2017 Fortinet, Inc. All rights reserved. Fortinet®, FortiGate®, FortiCare® and
FortiGuard®, and certain other marks are registered trademarks of Fortinet, Inc., in the U.S. and
other jurisdictions, and other Fortinet names herein may also be registered and/or common law
trademarks of Fortinet. All other product or company names may be trademarks of their
respective owners. Performance and other metrics contained herein were attained in internal
lab tests under ideal conditions, and actual performance and other results may vary. Network
variables, different network environments and other conditions may affect performance results.
Nothing herein represents any binding commitment by Fortinet, and Fortinet disclaims all
warranties, whether express or implied, except to the extent Fortinet enters a binding written
contract, signed by Fortinet's General Counsel, with a purchaser that expressly warrants that
the identified product will perform according to certain expressly-identified performance metrics
and, in such event, only the specific performance metrics expressly identified in such binding
written contract shall be binding on Fortinet. For absolute clarity, any such warranty will be
limited to performance in the same ideal conditions as in Fortinet's internal lab tests. In no event
does Fortinet make any commitment related to future deliverables, features or development,
and circumstances may change such that any forward-looking statements herein are not
accurate. Fortinet disclaims in full any covenants, representations, and guarantees pursuant
hereto, whether express or implied. Fortinet reserves the right to change, modify, transfer, or
otherwise revise this publication without notice, and the most current version of the publication
shall be applicable.
Technical Documentation
docs.fortinet.com
Knowledge Base
kb.fortinet.com
Customer Service & Support
support.fortinet.com
Training Services
training.fortinet.com
FortiGuard
fortiguard.com
Document Feedback
techdocs@fortinet.com
Table of Contents
Introduction....................................................................................................... 9
Registering your Fortinet product ............................................................................ 9
Customer service & technical support............................................................... 9
Training .................................................................................................................... 9
Documentation .....................................................................................................
Fortinet Tools & Documentation CD ................................................................
Fortinet Knowledge Base ................................................................................
Comments on Fortinet technical documentation ............................................
10
10
10
10
Scope..................................................................................................................... 10
Conventions ...........................................................................................................
IP addresses ....................................................................................................
Cautions and notes..........................................................................................
Typographical conventions..............................................................................
Command syntax conventions ........................................................................
10
10
11
11
12
Connecting to the FortiVoice System........................................................... 15
Connecting to the web-based manager or CLI ..................................................... 15
Connecting to the web-based manager .......................................................... 16
Connecting to the CLI ...................................................................................... 17
Setting up the system using the wizard................................................................. 19
Testing the setup ................................................................................................... 19
Configuring setups for phone users ......................................................................
Accessing the user web portal.........................................................................
Changing the user PIN .....................................................................................
Receiving and sending fax...............................................................................
Using the operator console..............................................................................
Setting user privileges and preferences ..........................................................
Setting the feature codes.................................................................................
20
20
21
21
21
21
21
Monitoring the FortiVoice System ................................................................ 22
Fortinet Technologies Inc.
Viewing overall system status................................................................................
Viewing the dashboard ....................................................................................
Viewing the Call Statistics................................................................................
Using the CLI Console .....................................................................................
22
22
25
25
Viewing phone system status ................................................................................
Viewing active calls ..........................................................................................
Viewing parked calls ........................................................................................
Viewing conference calls .................................................................................
Viewing extension status .................................................................................
Viewing hot desking configurations .................................................................
Viewing trunk status.........................................................................................
Viewing unassigned phones ............................................................................
Viewing DHCP client list ..................................................................................
25
25
26
26
26
27
27
28
30
Page 3
FortiVoice Phone System 5.3.0 Administration Guide
Viewing call/fax storage .........................................................................................
Playing recorded calls......................................................................................
Viewing current fax accounts...........................................................................
Viewing archived faxes ....................................................................................
Viewing fax queues ..........................................................................................
Searching for archived calls/faxes ...................................................................
31
31
31
31
32
32
Viewing call records............................................................................................... 33
Viewing generated reports..................................................................................... 33
Viewing log messages ...........................................................................................
Displaying and arranging log columns.............................................................
Using the right-click pop-up menus ................................................................
Searching log messages..................................................................................
34
36
37
38
Viewing phone directories ..................................................................................... 39
Configuring System Settings......................................................................... 41
Configuring network settings.................................................................................
About IPv6 Support .........................................................................................
About the management IP ...............................................................................
About FortiVoice logical interfaces ..................................................................
Configuring the network interfaces..................................................................
Configuring static routes..................................................................................
Configuring DNS ..............................................................................................
Configuring DHCP server.................................................................................
Capturing voice and fax packets .....................................................................
41
41
42
42
43
48
49
49
51
Configuring administrator accounts and access profiles ...................................... 52
Configuring administrator accounts................................................................. 53
Configuring administrator profiles.................................................................... 55
Using high availability ............................................................................................
About high availability ......................................................................................
About the heartbeat and synchronization........................................................
How to use HA .................................................................................................
Monitoring the HA status .................................................................................
Configuring the HA mode and group...............................................................
Example: Failover scenarios ............................................................................
56
56
57
59
60
63
70
Configuring system time, system options, SNMP, email setting, GUI appearance,
and call data storage ........................................................................................... 76
Configuring the time and date ......................................................................... 77
Configuring system options ............................................................................. 81
Configuring SNMP queries and traps .............................................................. 83
Configuring email settings ............................................................................... 89
Customizing the GUI appearance.................................................................... 91
Selecting the call data storage location........................................................... 93
Fortinet Technologies Inc.
Page 4
FortiVoice Phone System 5.3.0 Administration Guide
Managing certificates............................................................................................. 96
Managing local certificates .............................................................................. 96
Obtaining and installing a local certificate ....................................................... 97
Managing certificate authority certificates..................................................... 102
Managing the certificate revocation list ......................................................... 103
Maintaining the system ........................................................................................
Maintaining the system configuration ............................................................
Downloading a trace file ................................................................................
Maintaining phones........................................................................................
103
103
104
104
Configuring Phone System.......................................................................... 106
Configuring phone system settings .....................................................................
Setting PBX location and contact information...............................................
Configuring PBX options................................................................................
Customizing call report and notification email templates..............................
106
106
107
109
Configuring advanced phone system settings ....................................................
Configuring SIP settings ................................................................................
Configuring SIP phone auto-provisioning......................................................
Adding prompt languages .............................................................................
Managing phone configurations ....................................................................
Configuring system capacity .........................................................................
110
110
112
114
116
117
Managing sound files and music on hold ............................................................ 119
Working with FortiVoice profiles ..........................................................................
Configuring SIP profiles .................................................................................
Modifying caller IDs .......................................................................................
Configuring phone profiles.............................................................................
Configuring LDAP profiles..............................................................................
Configuring user privileges ............................................................................
Configuring location profile............................................................................
Scheduling the FortiVoice unit .......................................................................
120
120
122
123
126
131
131
132
Configuring FortiFone 870i .................................................................................. 133
Reviewing system configuration .......................................................................... 134
Reviewing phone management ..................................................................... 134
Configuring Extensions................................................................................ 136
Setting up local extensions..................................................................................
Configuring IP extensions ..............................................................................
Modifying analog extension (200D-T, 1000E-T, and 20E2 models only).......
Setting up remote extensions ........................................................................
Configuring fax extensions ............................................................................
Setting extension user preferences ...............................................................
Resetting voice messages .............................................................................
Fortinet Technologies Inc.
Page 5
136
136
147
150
153
156
165
FortiVoice Phone System 5.3.0 Administration Guide
Creating extension groups...................................................................................
Creating user groups .....................................................................................
Creating extension departments....................................................................
Creating ring groups ......................................................................................
Creating page groups ....................................................................................
Creating pickup groups .................................................................................
165
165
166
166
168
169
Setting up general voice mailboxes..................................................................... 170
Working with virtual numbers .............................................................................. 172
Configuring Trunks....................................................................................... 175
Setting up VoIP trunks ......................................................................................... 175
Testing SIP trunks.......................................................................................... 179
Creating a SIP trunk with FortiCall service .................................................... 180
Modifying PSTN/PRI trunks ................................................................................. 181
Configuring the T1/E1 span ........................................................................... 184
Configuring the analog voice trunk ................................................................ 186
Configuring office peers....................................................................................... 187
Configuring Call Routing ............................................................................. 189
Configuring inbound dial plans ............................................................................ 189
Configuring direct inward dialing ......................................................................... 192
Mapping DIDs ................................................................................................ 193
Configuring outbound dial plans..........................................................................
Testing outbound dial plans...........................................................................
Creating dialed number match ......................................................................
Configuring call handling actions...................................................................
194
196
196
198
Setting up a Call Center............................................................................... 200
Creating call queues and queue groups.............................................................. 200
Creating call queues ...................................................................................... 200
Creating queue groups .................................................................................. 209
Configuring agents............................................................................................... 209
Configuring IVRs .................................................................................................. 210
Setting up an IVR ........................................................................................... 211
Configuring restful service ............................................................................. 216
Configuring surveys ............................................................................................. 216
Setting up queue view ......................................................................................... 218
Configuring other agent information ....................................................................
Adding agent skill sets ...................................................................................
Creating agent skill levels ..............................................................................
Modifying agent reason code descriptions....................................................
Configuring data service ................................................................................
Setting caller priorities ...................................................................................
218
218
219
219
219
219
Configuring agent profiles.................................................................................... 220
Working with call queue statistics ....................................................................... 221
Fortinet Technologies Inc.
Page 6
FortiVoice Phone System 5.3.0 Administration Guide
Configuring call center report profiles and generating reports............................
Configuring the report query selection ..........................................................
Configuring the report time period.................................................................
Configuring report email notifications............................................................
Configuring the report schedule ....................................................................
Generating a report manually.........................................................................
222
223
224
224
224
225
Working with Property Management System ............................................ 226
Configuring hotel management settings.............................................................. 226
Configuring hotel room status ............................................................................. 228
Configuring phone auto dialer .................................................................... 230
Setting up an auto dialer campaign..................................................................... 230
Creating a recorded broadcast message ............................................................ 231
Adding contacts and contact groups .................................................................. 231
Configuring auto dialer settings........................................................................... 231
Viewing auto dialer reports .................................................................................. 232
Configuring Call Features............................................................................ 233
Configuring auto attendants ................................................................................ 233
Viewing auto attendant hierarchies................................................................ 235
Configuring key actions ................................................................................. 237
Configuring user privileges .................................................................................. 239
Configuring account codes.................................................................................. 243
Mapping speed dials ........................................................................................... 244
Configuring conference calls ............................................................................... 244
Recording calls ....................................................................................................
Configuring call recordings ............................................................................
Setting the recorded file format .....................................................................
Archiving recorded calls ................................................................................
247
247
249
249
Creating call queues and queue groups.............................................................. 250
Creating call queues ...................................................................................... 250
Creating queue groups .................................................................................. 256
Configuring call parking ....................................................................................... 256
Configuring fax.....................................................................................................
Receiving Faxes .............................................................................................
Sending faxes ................................................................................................
Configuring other fax settings........................................................................
Archiving faxes...............................................................................................
257
257
259
263
264
Setting calendar reminder.................................................................................... 265
Modifying feature access codes.......................................................................... 266
Configuring Internet of things (IoT) ...................................................................... 271
Fortinet Technologies Inc.
Page 7
FortiVoice Phone System 5.3.0 Administration Guide
Configuring Logs and Reports .................................................................... 273
About FortiVoice logging ..................................................................................... 273
FortiVoice log types ....................................................................................... 273
Log message severity levels .......................................................................... 274
Configuring logging..............................................................................................
Configuring logging to the hard disk..............................................................
Choosing which events to log........................................................................
Configuring logging to a Syslog server or FortiAnalyzer unit.........................
275
275
276
277
Configuring report profiles and generating call reports .......................................
Configuring the report query selection ..........................................................
Configuring the report time period.................................................................
Configuring report email notifications............................................................
Configuring the report schedule ....................................................................
Choosing call rate ..........................................................................................
Generating a report manually.........................................................................
Setting call rates ............................................................................................
279
280
282
282
283
283
283
284
Submitting CDRs to a database ..........................................................................
Configuring CDR submission.........................................................................
Modifying CDR templates ..............................................................................
Creating CDR filters .......................................................................................
284
284
285
286
Configuring Station Messaging Detail Record (SMDR) ....................................... 286
Configuring SMDR settings ........................................................................... 286
Setting SMDR formats ................................................................................... 287
Configuring alert email ......................................................................................... 287
Configuring alert recipients ............................................................................ 288
Configuring alert categories........................................................................... 288
Installing firmware........................................................................................ 290
Testing firmware before installing it ..................................................................... 290
Installing firmware ................................................................................................
Reconnecting to the FortiVoice unit...............................................................
Restoring the configuration............................................................................
Verifying the configuration .............................................................................
Upgrading ......................................................................................................
292
294
295
296
296
Clean installing firmware...................................................................................... 297
Appendix A: Installing Click-to-Dial software............................................ 299
Index .............................................................................................................. 300
Fortinet Technologies Inc.
Page 8
FortiVoice Phone System 5.3.0 Administration Guide
Introduction
Welcome, and thank you for selecting Fortinet products.
The FortiVoice Enterprise Phone System enables you to completely control your organization’s
telephone communications. Easy to use and reliable, the FortiVoice phone system delivers
everything you need to handle calls professionally, control communication costs, and stay
connected everywhere.
The FortiVoice system includes all the fundamentals of enterprise-class voice communications,
with no additional cards to install. Auto attendants, voice messaging, ring groups, conferencing
and much more are built-in. In addition, the FortiVoice personal web portal lets your staff view
their call logs, configure and manage their own messaging, and access other features, such as
the operator console and the agent console.
This document describes how to configure and use the FortiVoice phone system. Only the
configuration procedures through the web-based manager are provided. For configuration
procedures through the CLI, see the FortiVoice CLI Reference.
This topic includes:
• Registering your Fortinet product
• Training
• Documentation
• Scope
• Conventions
Registering your Fortinet product
Before you begin, take a moment to register your Fortinet product at the Fortinet Technical
Support web site, https://support.fortinet.com.
Many Fortinet customer services, such as firmware updates and technical support,
require product registration.
For more information, see the Fortinet Knowledge Base article Registration Frequently Asked
Questions.
Customer service & technical support
Fortinet Technical Support provides services designed to make sure that you can install your
Fortinet products quickly, configure them easily, and operate them reliably in your network.
To learn about the technical support services that Fortinet provides, visit the Fortinet Technical
Support web site at https://support.fortinet.com.
You can dramatically improve the time that it takes to resolve your technical support ticket by
providing your configuration file, a network diagram, and other specific information. For a list of
required information, see the Fortinet Knowledge Base article Technical Support Requirements.
Training
Fortinet Training Services provides classes that orient you quickly to your new equipment, and
certifications to verify your knowledge level. Fortinet provides a variety of training programs to
serve the needs of our customers and partners world-wide.
Fortinet Technologies Inc.
Page 9
FortiVoice Phone System 5.3.0 Administration Guide
To learn about the training services that Fortinet provides, visit the Fortinet Training Services
web site at http://training.fortinet.com, or email them at training@fortinet.com.
Documentation
The Fortinet Technical Documentation web site, http://docs.fortinet.com, provides the most
up-to-date versions of Fortinet publications, as well as additional technical documentation such
as technical notes.
In addition to the Fortinet Technical Documentation web site, you can find Fortinet technical
documentation on the Fortinet Tools and Documentation CD, and on the Fortinet Knowledge
Base.
Fortinet Tools & Documentation CD
Many Fortinet publications are available on the Fortinet Tools and Documentation CD shipped
with your Fortinet product. The documents on this CD are current at shipping time. For current
versions of Fortinet documentation, visit the Fortinet Technical Documentation web site,
http://docs.fortinet.com.
Fortinet Knowledge Base
The Fortinet Knowledge Base provides additional Fortinet technical documentation, such as
troubleshooting and how-to-articles, examples, FAQs, technical notes, a glossary, and more.
Visit the Fortinet Knowledge Base at http://kb.fortinet.com.
Comments on Fortinet technical documentation
Please send information about any errors or omissions in this document to
techdoc@fortinet.com.
Scope
This document describes how to connect the FortiVoice unit to its web-based manager and CLI
and use the web-based manager to configure the FortiVoice unit.
This document does not cover commands for the command line interface (CLI).
Conventions
Fortinet technical documentation uses the following conventions:
• IP addresses
• Cautions and notes
• Typographical conventions
• Command syntax conventions
IP addresses
To avoid publication of public IP addresses that belong to Fortinet or any other organization, the
IP addresses used in Fortinet technical documentation are fictional and follow the
documentation guidelines specific to Fortinet. The addresses used are from the private IP
Fortinet Technologies Inc.
Page 10
FortiVoice Phone System 5.3.0 Administration Guide
address ranges defined in RFC 1918: Address Allocation for Private Internets, available at
http://ietf.org/rfc/rfc1918.txt?number-1918.
Cautions and notes
Fortinet technical documentation uses the following guidance and styles for cautions and notes.
Warns you about commands or procedures that could have unexpected or undesirable results
including loss of data or damage to equipment.
Highlights useful additional information, often tailored to your workplace activity.
Typographical conventions
Fortinet documentation uses the following typographical conventions:
Table 1: Typographical conventions in Fortinet technical documentation
Convention
Example
Button, menu, text
box, field, or check
box label
From Minimum log level, select Notification.
CLI input
config system dns
set primary <address_ipv4>
end
CLI output
FGT-602803030703 # get system settings
comments
: (null)
opmode
: nat
Emphasis
HTTP connections are not secure and can be
intercepted by a third party.
File content
<HTML><HEAD><TITLE>Firewall
Authentication</TITLE></HEAD>
<BODY><H4>You must authenticate to use
this service.</H4>
Hyperlink
Visit the Fortinet Technical Support web site,
https://support.fortinet.com.
Keyboard entry
Type a name for the remote VPN peer or client, such as
Central_Office_1.
Fortinet Technologies Inc.
Page 11
FortiVoice Phone System 5.3.0 Administration Guide
Table 1: Typographical conventions in Fortinet technical documentation
Navigation
Go to Monitor > Status > DHCP.
Publication
For details, see the FortiGate Administration Guide.
Command syntax conventions
The command line interface (CLI) requires that you use valid syntax, and conform to expected
input constraints. It will reject invalid commands.
Brackets, braces, and pipes are used to denote valid permutations of the syntax. Constraint
notations, such as <address_ipv4>, indicate which data types or string patterns are
acceptable value input.
Table 2: Command syntax notation
Convention
Description
Square brackets [ ]
A non-required word or series of words. For example:
[verbose {1 | 2 | 3}]
indicates that you may either omit or type both the verbose
word and its accompanying option, such as:
verbose 3
Fortinet Technologies Inc.
Page 12
FortiVoice Phone System 5.3.0 Administration Guide
Table 2: Command syntax notation
Angle brackets < >
A word constrained by data type.
To define acceptable input, the angled brackets contain a
descriptive name followed by an underscore ( _ ) and suffix
that indicates the valid data type. For example:
<retries_int>
indicates that you should enter a number of retries, such as 5.
Data types include:
• <xxx_name>: A name referring to another part of the
configuration, such as policy_A.
• <xxx_index>: An index number referring to another part
of the configuration, such as 0 for the first static route.
• <xxx_pattern>: A regular expression or word with wild
cards that matches possible variations, such as
*@example.com to match all email addresses ending in
@example.com.
• <xxx_fqdn>: A fully qualified domain name (FQDN), such
as mail.example.com.
• <xxx_email>: An email address, such as
admin@mail.example.com.
• <xxx_url>: A uniform resource locator (URL) and its
associated protocol and host name prefix, which together
form a uniform resource identifier (URI), such as
http://www.fortinet.com/.
• <xxx_ipv4>: An IPv4 address, such as 192.168.1.99.
• <xxx_v4mask>: A dotted decimal IPv4 netmask, such as
255.255.255.0.
• <xxx_ipv4mask>: A dotted decimal IPv4 address and
netmask separated by a space, such as
192.168.1.99 255.255.255.0.
• <xxx_ipv4/mask>: A dotted decimal IPv4 address and
CIDR-notation netmask separated by a slash, such as such
as 192.168.1.99/24.
• <xxx_ipv6>: A colon( : )-delimited hexadecimal IPv6
address, such as
3f2e:6a8b:78a3:0d82:1725:6a2f:0370:6234.
• <xxx_v6mask>: An IPv6 netmask, such as /96.
• <xxx_ipv6mask>: An IPv6 address and netmask
separated by a space.
• <xxx_str>: A string of characters that is not another data
type, such as P@ssw0rd. Strings containing spaces or
special characters must be surrounded in quotes or use
escape sequences.
• <xxx_int>: An integer number that is not another data
type, such as 15 for the number of minutes.
Fortinet Technologies Inc.
Page 13
FortiVoice Phone System 5.3.0 Administration Guide
Table 2: Command syntax notation
Curly braces { }
A word or series of words that is constrained to a set of
options delimited by either vertical bars or spaces.
You must enter at least one of the options, unless the set of
options is surrounded by square brackets [ ].
Options
delimited by
vertical bars |
Mutually exclusive options. For example:
{enable | disable}
indicates that you must enter either enable or disable, but
must not enter both.
Options
delimited by
spaces
Non-mutually exclusive options. For example:
{http https ping snmp ssh telnet}
indicates that you may enter all or a subset of those options, in
any order, in a space-delimited list, such as:
ping https ssh
To change the options, you must re-type the entire list. For
example, to add snmp to the previous example, you would
type:
ping https snmp ssh
If the option adds to or subtracts from the existing list of
options, instead of replacing it, or if the list is
comma-delimited, the exception will be noted.
Fortinet Technologies Inc.
Page 14
FortiVoice Phone System 5.3.0 Administration Guide
Connecting to the FortiVoice System
After physically installing the FortiVoice unit, you need to connect to its management tools to
configure, maintain, and administer the unit. You also need to inform your phone users on how
to access the user web portal and use the FortiVoice features.
This topic includes:
• Connecting to the web-based manager or CLI
• Setting up the system using the wizard
• Testing the setup
• Configuring setups for phone users
Connecting to the web-based manager or CLI
There are two methods to connect to the FortiVoice unit:
• use the web-based manager, a graphical user interface (GUI), from within a web browser
• use the command line interface (CLI), an interface similar to DOS or UNIX commands, from a
Secure Shell (SSH) or Telnet terminal
Access to the CLI and/or web-based manager is not yet configured if:
• you are connecting for the first time
• you have just reset the configuration to its default state
• you have just restored the firmware
In these cases, you must access either interface using the default settings.
If the above conditions do not apply, access the web UI using the IP address, administrative
access protocol, administrator account and password already configured, instead of the
default settings.
After you connect, you can use the web-based manager or CLI to configure basic network
settings and access the CLI and/or web-based manager through your network. However, if you
want to update the firmware, you may want to do so before continuing. See “System
Information widget” on page 23.
Until the FortiVoice unit is configured with an IP address and connected to your network, you
may prefer to connect the FortiVoice unit directly to your management computer, or through a
switch, in a peer network that is isolated from your overall network. However, isolation is not
required.
This topic includes:
• Connecting to the web-based manager
• Connecting to the CLI
Fortinet Technologies Inc.
Page 15
FortiVoice Phone System 5.3.0 Administration Guide
Connecting to the web-based manager
To connect to the web-based manager using its default settings, you must have:
• a computer with an RJ-45 Ethernet network port
• a web browser such as Microsoft Internet Explorer version 6.0 or greater, or a recent version
of Mozilla Firefox
• a crossover network cable
Table 3: Default settings for connecting to the web-based manager
Network Interface
port1
URL
https://192.168.1.99/admin
Administrator Account
admin
Password
(none)
To connect to the web-based manager
1. On your management computer, configure the Ethernet port with the static IP address
192.168.1.2 with a netmask of 255.255.255.0.
2. Using the Ethernet cable, connect your computer’s Ethernet port to the FortiVoice unit’s
port1.
3. Start your browser and enter the URL https://192.168.1.99/admin. (Remember to include the
“s” in https://.)
To support HTTPS authentication, the FortiVoice unit ships with a self-signed security
certificate, which it presents to clients whenever they initiate an HTTPS connection to the
FortiVoice unit. When you connect, depending on your web browser and prior access of the
FortiVoice unit, your browser might display two security warnings related to this certificate:
• The certificate is not automatically trusted because it is self-signed, rather than being
signed by a valid certificate authority (CA). Self-signed certificates cannot be verified with
a proper CA, and therefore might be fraudulent. You must manually indicate whether or
not to trust the certificate.
• The certificate might belong to another web site. The common name (CN) field in the
certificate, which usually contains the host name of the web site, does not exactly match
the URL you requested. This could indicate server identity theft, but could also simply
indicate that the certificate contains a domain name while you have entered an IP
address. You must manually indicate whether this mismatch is normal or not.
Both warnings are normal for the default certificate.
4. Verify and accept the certificate, either permanently (the web browser will not display the
self-signing warning again) or temporarily. You cannot log in until you accept the certificate.
For details on accepting the certificate, see the documentation for your web browser.
5. In the Name field, type admin, then click Login. (In its default state, there is no password for
this account.)
Login credentials entered are encrypted before they are sent to the FortiVoice unit. If your
login is successful, the web UI appears. To continue by updating the firmware, see “System
Information widget” on page 23. Otherwise, to continue by following the configuration
wizard.
Fortinet Technologies Inc.
Page 16
FortiVoice Phone System 5.3.0 Administration Guide
Connecting to the CLI
Using its default settings, you can access the CLI from your management computer in two
ways:
• a local serial console connection
• an SSH connection, either local or through the network
To connect to the CLI using a local serial console connection, you must have:
• a computer with a serial communications (COM) port
• the RJ-45-to-DB-9 serial or null modem cable included in your FortiVoice package
• terminal emulation software, such as HyperTerminal for Microsoft Windows
To connect to the CLI using an SSH connection, you must have:
• a computer with an RJ-45 Ethernet port
• a crossover Ethernet cable
• an SSH client, such as PuTTY
Table 4: Default settings for connecting to the CLI by SSH
Network Interface
port1
IP Address
192.168.1.99
SSH Port Number
22
Administrator Account
admin
Password
(none)
If you are not connecting for the first time, nor have you just reset the configuration to its
default state or restored the firmware, administrative access settings may have already been
configured. In this case, access the CLI using the IP address, administrative access protocol,
administrator account and password already configured, instead of the default settings.
For more information on available CLI commands, see the FortiVoice CLI Reference.
The following procedure uses Microsoft HyperTerminal. Steps may vary with other terminal
emulators.
To connect to the CLI using a local serial console connection
1. Using the RJ-45-to-DB-9 or null modem cable, connect your computer’s serial
communications (COM) port to the FortiVoice unit’s console port.
2. Verify that the FortiVoice unit is powered on.
3. On your management computer, start HyperTerminal.
4. On Connection Description, enter a Name for the connection and select OK.
5. On Connect To, from Connect using, select the communications (COM) port where you
connected the FortiVoice unit.
6. Select OK.
7. Select the following Port settings and select OK.
Fortinet Technologies Inc.
Page 17
FortiVoice Phone System 5.3.0 Administration Guide
Bits per second
9600
Data bits
8
Parity
None
Stop bits
1
Flow control
None
8. Press Enter.
The terminal emulator connects to the CLI and the CLI displays a login prompt.
9. Type admin and press Enter twice. (In its default state, there is no password for this
account.)
The CLI displays a prompt, such as:
FortiVoice #
10.Type admin and press Enter twice. (In its default state, there is no password for this
account.)
The CLI displays the following text:
Type ? for a list of commands.
You can now enter commands. For information about how to use the CLI, including how to
connect to the CLI using SSH or Telnet, see the FortiVoice CLI Reference.
The following procedure uses PuTTY. Steps may vary with other SSH clients.
To connect to the CLI using an SSH connection
1. On your management computer, configure the Ethernet port with the static IP address
192.168.1.2 with a netmask of 255.255.255.0.
2. Using the Ethernet cable, connect your computer’s Ethernet port to the FortiVoice unit’s
port1.
3. Verify that the FortiVoice unit is powered on.
4. On your management computer, start your SSH client.
5. In Host Name (or IP Address), type 192.168.1.99.
6. In Port, type 22.
7. From Connection type, select SSH.
8. Select Open.
The SSH client connects to the FortiVoice unit.
The SSH client may display a warning if this is the first time you are connecting to the
FortiVoice unit and its SSH key is not yet recognized by your SSH client, or if you have
previously connected to the FortiVoice unit but it used a different IP address or SSH key. If
your management computer is directly connected to the FortiVoice unit with no network
hosts between them, this is normal.
9. Click Yes to verify the fingerprint and accept the FortiVoice unit’s SSH key. You cannot log in
until you accept the key.
The CLI displays a login prompt.
Fortinet Technologies Inc.
Page 18
FortiVoice Phone System 5.3.0 Administration Guide
10.Type admin and press Enter twice. (In its default state, there is no password for this
account.)
The CLI displays the following text:
Type ? for a list of commands.
You can now enter commands. For information about how to use the CLI, including how to
connect to the CLI using SSH or Telnet, see the FortiVoice CLI Reference.
Setting up the system using the wizard
The FortiVoice unit’s Configuration Wizard leads you through required configuration steps,
helping you to quickly set up your FortiVoice system. Once the setup is complete, you can make
phone calls through the FortiVoice unit.
While all settings configured by the Configuration Wizard can also be configured through the
web-based manager, the wizard presents each setting in the necessary order.
The wizard is a reusable tool and you can modify the configuration settings. Each time you click
the Next button, the configuration is saved.
To start the wizard, open the web-based manager in a browser and click Wizard in the
top-right button row.
Testing the setup
After a configuration through the Configuration Wizard, you can connect a SIP phone to your
VoIP network and make an internal, external, or office peer test call.
If the SIP phone and the FortiVoice unit (PBX) are on different subnets, proper routing should
be set to make them reachable
If you make a office peer test call, make sure that your FortiVoice unit and the peer office PBX
are mutually registered. For more information, see “Configuring office peers” on page 187.
Depending on the phone you use, the procedure to connect the phone may vary. Refer to the
phone user manuals for instructions.
Generally, you need to configure the following on the phone after powering it up and connecting
it to the network:
• Enter the IP address of the phone if it is not DHCP-enabled.
• Enter the SIP server IP address and port number (5060 by default) of the FortiVoice unit. You
can find the SIP serve IP by the Configuration Wizard and going to System Setting > Network
Setting.
• Enter the extension number and SIP password you have configured and make sure the
extension is enabled. You can find the information by opening the Configuration Wizard and
going to Extension > Import/Add/Edit and double-click an extension.
If you have not imported or added any extensions, do it first. For more information, see
“Configuring IP extensions” on page 136. The extension number on the FortiVoice unit and
your phone should match.
Fortinet Technologies Inc.
Page 19
FortiVoice Phone System 5.3.0 Administration Guide
Configuring setups for phone users
The FortiVoice system provides a user web portal where phone users can view their call logs,
configure and manage their own messaging, and access other features.
This section contains information that you may need to inform or assist your phone users so
that they can use the FortiVoice features.
This information is not the same as what is included in the help for FortiVoice user web portal. It
is included in this guide because:
• Phone users need to know how to access the FortiVoice user web portal and its online help.
• Phone users need to know the feature codes they can use on the phones.
• Phone users need to know how to change the voicemail password on the web portal and on
the phone.
• Phone users may be confused if they try to enable a feature that you disabled (such as call
waiting or do not disturb).
• You may need to tailor some information to your network or phone users.
This topic includes:
• Accessing the user web portal
• Changing the user PIN
• Receiving and sending fax
• Using the operator console
• Setting user privileges and preferences
• Setting the feature codes
Accessing the user web portal
FortiVoice user web portal is a special web site located on a FortiVoice unit. This web portal
allows a phone user to:
• check your voicemail including playing, deleting, or saving the voicemails
• receive and send fax
• Use the agent console to manage queue calls
• Use the operator console to process company calls
• check your call record for received, placed, or missed calls
• check your recorded calls including playing, deleting, or saving the voicemails
• view your corporate phone directory
• check the feature codes that you can dial on your phone keypad
• configure your extension according to your preferences
• manage calls
• configure phone profiles
• customize sound files
Several modern, popular web browsers are supported, so you can use FortiVoice user web
portal through the web browser of your choice.
Fortinet Technologies Inc.
Page 20
FortiVoice Phone System 5.3.0 Administration Guide
For the phone users to access the web portal, you need to inform phone users of:
• the web portal URL (same with that of the FortiVoice unit except without /admin in the end)
• their extension numbers, and
• the default user PINs.
With this information, a user can enter the URL in the browser’s location or address bar. The
user can then log into the portal using the extension number as user name and the user PIN as
password.
Once they access the web portal, phone users can click the Help button to learn how to use the
portal.
For information on adding extension numbers and user PINs, see “Configuring IP extensions”
on page 136.
Changing the user PIN
Inform the phone users how to change the default user PIN on the phone. The information for
changing the user PIN on the web portal is in the online help of the portal.
Receiving and sending fax
Inform the phone users that they can receive and send faxes on the user web portal. For more
information, see “Configuring fax” on page 257.
Using the operator console
If you have enabled the operator role for an extension, inform the extension user so that the user
can process corporate calls on the user web portal. For more information, see “Operator role”
on page 240.
Setting user privileges and preferences
The call features each phone user can use is controlled by the user privilege and preferences
settings associated with the user’s extension. You may need to inform users of the features that
they can use.
For information, see “Configuring user privileges” on page 239 and “Setting extension user
preferences” on page 156.
Setting the feature codes
By default, the FortiVoice unit has feature codes for users to access certain features by dialing
the codes. You can go to Service > Feature Code > Feature Code and double-click a feature
name to modify its code and description, but that does not change the mapping between the
code and the feature.
For details, see “Modifying feature access codes” on page 266.
Fortinet Technologies Inc.
Page 21
FortiVoice Phone System 5.3.0 Administration Guide
Monitoring the FortiVoice System
The Status menu displays system usage, log messages, reports, and other status-indicating
items.
This topic includes:
• Viewing overall system status
• Viewing phone system status
• Viewing call/fax storage
• Viewing call records
• Viewing generated reports
• Viewing log messages
• Viewing phone directories
Viewing overall system status
The Status menu displays system status, most of which pertain to the entire system, such as
service status and system resource.
This topic includes:
• Viewing the dashboard
• Viewing the Call Statistics
• Using the CLI Console
Viewing the dashboard
Status > Dashboard displays first after you log in to the web-based manager. It contains a
dashboard with widgets that each indicates performance level or other statistics.
By default, widgets display the serial number and current system status of the FortiVoice unit,
including uptime, system resource usage, license information, service status, firmware version,
system time, and statistics history.
To view the dashboard, go to Status > Dashboard > Dashboard.
Fortinet Technologies Inc.
Page 22
FortiVoice Phone System 5.3.0 Administration Guide
Figure 1: Monitor system status
The dashboard is customizable. You can select which widgets to display, where they are
located on the tab, and whether they are minimized or maximized.
To move a widget, position your mouse cursor on the widget’s title bar, then click and drag the
widget to its new location.
To show or hide a widget, in the upper left-hand corner, click Add Content, then mark the check
boxes of widgets that you want to show.
Options vary slightly from widget to widget, but always include options to close or
minimize/maximize the widget.
Figure 2: A minimized widget on the dashboard
Disclosure arrow
Widget title
Refresh
Close
System Information widget
The System Information widget displays the serial number and basic system statuses such as
the firmware version, system time, and up time.
In addition to displaying basic system information, the System Information widget lets you
change the firmware. To change the firmware, click Update for Firmware version. For more
information, see “Installing firmware” on page 290.
To view the widget, go to Status > Dashboard. If the widget is not currently shown, click Add
Content, and mark the check box for the widget.
License Information widget
The License Information widget displays the last queried license statuses for the number of
extensions supported (if you use FortiVoice VM), hotel management, and call center (if you have
purchased these options).
Depending on the license you have purchased, when you first access the FortiVoice web-based
manager, you need to upload the license to enable the functions you need.
Fortinet Technologies Inc.
Page 23
FortiVoice Phone System 5.3.0 Administration Guide
To upload the license file, first place the license file to your management computer, then click
Update license and browse for the license file.
A full VMware license is required to upload a hotel management license onto the FortiVoice VM.
To view the widget, go to Status > Dashboard. If the widget is not currently shown, click Add
Content, and mark the check box for the widget.
Service Status widget
The Service Status widget displays the number of current calls, extension status, trunk status,
and device connection status.
To view the widget, go to Status > Dashboard. If the widget is not currently shown, click Add
Content, and mark the check box for the widget.
Device (200D-T and 2000E-T2 models only) displays the connection status of the FortiVoice
physical ports:
• Connected: The port is connected to a device.
• Disconnected: The port is not connected to any device and is ready for use.
• Alarmed: The port has an error and is not usable.
• Occupied: The port is being used.
System Resource widget
The System Resource widget displays the CPU, memory, and disk space usage. It also displays
the system load and current number of IP sessions.
To view the widget, go to Status > Dashboard. If the widget is not currently shown, click Add
Content, and mark the check box for the widget.
The system resources history can also be viewed in this widget by clicking History. The system
resources history contains four graphs. Each graph displays readings of one of the system
resources: CPU, memory, IP sessions, and network bandwidth usage. Each graph is divided by
a grid.
Statistics History widget
The Statistics History widget contains charts that summarize the number of calls in each time
period that the FortiVoice unit recorded.
To view the widget, go to Status > Dashboard. If the widget is not currently shown, click Add
Content, and mark the check box for the widget.
Also see “Viewing the Call Statistics” on page 25.
System Command widget
The System Command widget lets you restart, shut down, or reload the configuration of the
FortiVoice unit.
To view the widget, go to Status > Dashboard. If the widget is not currently shown, click Add
Content, and mark the check box for the widget.
Before rebooting or halting the FortiVoice unit, consider notifying your phone users, as it could
result in temporary interruptions to connectivity.
Fortinet Technologies Inc.
Page 24
FortiVoice Phone System 5.3.0 Administration Guide
Reloading allows the FortiVoice unit to reload its configuration from its last saved version, and
log you out. Any changes that were in progress but not yet saved, such as GUI pages that were
not applied or CLI commands where you had not yet entered next or end, are lost. If you want
to continue configuring the FortiVoice unit, refresh your browser and log in again.
Recent Calls widget
The Recent Calls widget displays the calls processed by the FortiVoice unit, including phone
numbers, call directions, call starting time and duration, and call status.
To view the widget, go to Status > Dashboard. If the widget is not currently shown, click Add
Content, and mark the check box for the widget.
The maximum call records shown is 8.
Viewing the Call Statistics
The Call Statistics tab contains summaries of the number of calls by time and direction that the
FortiVoice unit recorded.
To view call statistics, go to Status > Dashboard > Call Statistics.
Using the CLI Console
Go to Status > Dashboard > Console to access the CLI without exiting from the web-based
manager.
You can click the Open in New Window at the bottom of the page to move the CLI Console into
a pop-up window that you can resize and reposition.
For more information about CLI commands, see the FortiVoice CLI Reference.
Viewing phone system status
Status > Phone System displays all the ongoing phone calls, parked calls, conference calls,
extensions, trunks, call queues, DHCP clients, and unassigned phones.
This topic includes:
• Viewing active calls
• Viewing parked calls
• Viewing conference calls
• Viewing extension status
• Viewing hot desking configurations
• Viewing trunk status
• Viewing unassigned phones
• Viewing DHCP client list
Viewing active calls
Status > Phone System > Active Calls displays all the ongoing phone calls in realtime, including
the callers and receivers, the trunks through which phone calls are connected, the call status,
and the call duration.
You can stop a phone call by clicking the Hang up icon.
Fortinet Technologies Inc.
Page 25
FortiVoice Phone System 5.3.0 Administration Guide
The call statuses include:
• Ringing: The receiver’s phone is ringing.
• Connected: Callers are connected. The voice channel is established.
• Voicemail: The call goes to the voicemail.
Viewing parked calls
A parked call is similar to a call that is on hold, except that the parked call can then be picked
up from any extension.
To view parked calls, go to Status > Phone System > Parked Calls.
For more information on call parking, see “Configuring call parking” on page 256.
Viewing conference calls
Status > Phone System > Conference displays the conference call records, including the name
of the conference call, the extension number of the call, the displayed name of the caller, and
the call duration.
You can stop a caller from attending the conference call by selecting the caller and clicking the
Kick icon.
For more information, see “Configuring conference calls” on page 244.
Viewing extension status
Status > Phone System > Extensions displays all the extensions in realtime, including their
statuses, IDs, numbers, display names, types, IPs for SIP extensions, phone information, and if
it has any auxiliary devices.
For more information, see “Configuring Extensions” on page 136.
GUI field
Description
Category/Status
Select to view the extensions by categories. Each category has its
corresponding statuses.
• All: Displays extensions in all statuses.
• Active: Can display extensions in each of the following statuses once
selected:
• Idle: The extension is not in use.
• In Use: The extension is in use.
• Busy: The extension is busy.
• Ringing: The extension is ringing.
• On Hold: The extension has an on-hold call.
• Other: The status other than the above.
• Inactive: Can display extensions in each of the following statuses once
selected:
• Not registered: The extension is not registered with the FortiVoice
unit and is not in service.
• Unavailable: The extension is not reachable.
• Disable: Displays all disabled extensions.
Fortinet Technologies Inc.
Page 26
FortiVoice Phone System 5.3.0 Administration Guide
Deregister
Select an extension and click this icon to remove the extension assigned to
the phone.
Status
The status of the extension. See “Category/Status” on page 26.
User ID
This is the system-generated ID based on the extension number.
Number
The extension number.
Display Name
The name displaying on the extension. This is usually the name of the
extension user.
Type
The type for this extension, such as SIP or analog (for the FortiVoice
200D-T and 2000E-T2 models).
IP
The link to the IP address of the phone using the extension number. Click
to interface with the extension and configure it remotely by entering the
login information. See “IP” on page 143.
Phone type
The phone brand and model.
Phone Info
The phone brand and model and its MAC address.
Auxiliary device
Devices added to the extension. This is known as SIP forking. For more
information, see “Configuring IP extensions” on page 136.
Viewing hot desking configurations
Status > Phone System > Hot Desking displays all of the extensions configured for hot desking,
including:
• Status: the status of the hot desking extension: logged in or logged out.
• User ID: the system-generated ID for the hot desking extension.
• Number: the hot desking extension number.
• Display Name: the name displayed on the hot desking extension.
• Host Device: the extension number or MAC address (for a unassigned phone) of the phone
that a hot desking user logs into.
• Last Login: the last login time at the host device.
• Expiry: the login expiry time.
Hot desking enables users to log into another phone. However, unlike using Follow Me or Call
Forwarding which simply redirect a user's calls to another user’s phone, hot desking takes total
control of another phone by applying all of the user's own phone settings to that phone until the
user logs out. Each user can log into another phone by pressing *11 and enter his extension
number and user PIN following the prompts. To log out, a user can press *12.
If the two phones use different programmable phone keys, the host phone will reboot. For
information on programmable phone keys, see “Configuring phone profiles” on page 123.
For information on configuring hot desking, see “Hot-desking” on page 242.
Viewing trunk status
Status > Phone System > Trunks displays all the trunks in realtime, including their names, IP
addresses, types, status, and registration/connection status with the VoIP or PSTN service
provider.
Fortinet Technologies Inc.
Page 27
FortiVoice Phone System 5.3.0 Administration Guide
The trunk statuses include:
• Not registered: The trunk is not registered with the VoIP or PSTN service provider and is not
in service.
• In service: The trunk is registered with the VoIP or PSTN service provider and is in service.
• Unavailable: The trunk is not reachable.
• Alarm detected: There is a problem with the trunk.
• Admin down: The trunk is disabled.
• Unmonitored: The trunk is not monitored.
When you click the IP address of a SIP extension, you can interface with the extension and
configure it remotely.
Registration/Connection indicates if a trunk has been registered with or connected to the VoIP
or PSTN service provider.
You can stop a phone call by clicking the Hang up icon.
For more information, see “Configuring Trunks” on page 175.
Viewing unassigned phones
Status > Phone System> Unassigned Phone lists the supported phones auto-discovered by the
FortiVoice unit but not assigned to any extensions yet.
Once an unassigned phone connects to the FortiVoice unit and is auto-discovered, the
FortiVoice unit assigns an IP address to the phone and sends the basic PBX setup information
to it.
After assigning an extension to the phone, the extension’s full configuration file will be sent to
the phone if the auto-provisioning option is selected in the user privilege applied to the
extension. For details, see “Setting up local extensions” on page 136 and “Configuring user
privileges” on page 239.
Fortinet Technologies Inc.
Page 28
FortiVoice Phone System 5.3.0 Administration Guide
Figure 3: Unassigned phones
GUI field
Description
Action
• Assign to new extension: Select an unassigned phone and click this
option to add an extension and assign this client to the user at the
same time. The phone record disappears from the Unassigned
Phone list. For more information, see “To assign a new extension
user to an unassigned phone” on page 29.
• Assign to FortiFone-870i device: Select an unassigned FortiFone
870i and click this option to add an extension and assign this client
to the user at the same time. The phone record disappears from the
Unassigned Phone list. For more information, see “To assign a new
extension user to an unassigned phone” on page 29.
• Apply to existing extension: Select an unassigned phone and click
this option to assign this client to an existing user. The phone record
disappears from the Unassigned Phone list. For more information,
see “To assign an existing extension user to an unassigned phone”
on page 29.
Export
Select to save the unassigned phone list in csv format.
MAC
The Media Access Control address (MAC address) of the unassigned
phone.
IP
The IP address of the unassigned phone assigned by the FortiVoice unit.
Vendor
The brand name of the unassigned phone.
Phone Info
The phone brand and model.
To assign a new extension user to an unassigned phone
1. Go to Status > Phone System > Unassigned Phone.
2. Select an unassigned phone.
3. Click Action and select Assign to new extension.
4. Configure the extension associated with the unassigned phone following “Configuring IP
extensions” on page 136.
5. Click Create.
To assign an existing extension user to an unassigned phone
1. Go to Status > Phone System > Unassigned Phone.
2. Select an unassigned phone.
3. Click Action and select Assign to existing extension.
4. Select the extension to associate with the unassigned phone.
5. Click Apply to existing extension.
Fortinet Technologies Inc.
Page 29
FortiVoice Phone System 5.3.0 Administration Guide
Viewing DHCP client list
Status > Phone System > DHCP displays all the DHCP-enabled devices connected to the
FortiVoice unit in realtime.
Once a DHCP-enabled phone connects to the FortiVoice unit and is auto-discovered, the
FortiVoice unit assigns an IP address to the phone and sends the basic PBX setup information
to it.
For the supported DHCP-enabled phone to connect to the FortiVoice unit:
• In the FortiVoice DHCP server configuration, select DHCP option 66 (an advanced option on
the web-based manager) and include the IP address of the FortiVoice interface connected to
the same network as the SIP phones to be auto-provisioned. For more information, see
“Configuring DHCP server” on page 49.
DHCP server option 66 identifies a TFTP server and includes the IP address of the TFTP
server and downloads the TFTP server identity to the device that gets an IP address from the
DHCP server. DHCP option 66 is defined in RFC 2132.
• If using your own DHCP server, set the DHCP server option 66 to the FortiVoice unit’s TFTP
server (Opt66) value. For more information, see “Configuring DHCP server” on page 49.
• If the FortiVoice unit and the SIP phone with an IP assigned by a DHCP server are on
different subnets, proper route should be set to make them reachable.
Figure 4: DHCP client list
GUI field
Description
Export
Select to save the DHCP client list in csv format.
MAC
The Media Access Control address (MAC address) of the DHCP client.
Interface
The FortiVoice unit port to which the DHCP client connects. For
information on FortiVoice interfaces, see “Configuring network settings”
on page 41.
IP
The IP address of the DHCP client assigned by the FortiVoice DHCP
server.
Expired
The expiration time of the DHCP client IP address.
Vendor
The brand names of the DHCP clients.
Fortinet Technologies Inc.
Page 30
FortiVoice Phone System 5.3.0 Administration Guide
Extension
When a DHCP-enabled device connects to the FortiVoice unit, the
FortiVoice unit assigns a temporary ID to the device if it is a supported
device. If an extension number is assigned to the phone, the extension
number appears. For information on assigning extensions, see “Viewing
unassigned phones” on page 28.
Configuration
Status
• OK: The DHCP client is assigned to a new or an existing extension
user.
• Not assigned: The DHCP client is not assigned to a new or an
existing extension user.
• Misconfigured: The DHCP client’s configuration has errors.
Viewing call/fax storage
Status > Storage displays the recorded calls, faxes, archived faxes, and faxes in queue.
This topic includes:
• Playing recorded calls
• Viewing current fax accounts
• Viewing archived faxes
• Viewing fax queues
• Searching for archived calls/faxes
Playing recorded calls
The Recorded Calls tab lists the calls recorded by the FortiVoice unit.
To listen to a call, go to Status > Storage > Recorded Calls and select a call record folder to
open the archived call files. Select a call file and click the Play button.
To save a recorded call, go to Status > Storage and select a call record folder to open the
archived call files. Select a call file and click the Download button.
To search the locally archived calls, click Search. See “Searching for archived calls/faxes” on
page 32.
For information on configuring recording calls, see “Recording calls” on page 247.
Viewing current fax accounts
The Fax tab lists the fax accounts created on the FortiVoice unit. For more information about
creating fax accounts, see “Configuring fax” on page 257.
To view fax accounts, go to Status > Storage > Fax. The fax accounts are listed with their
names, numbers, display names, storage sizes, and faxes stored.
You can double-click a fax account and view the detailed information on the faxes it stores. You
can also click Download PDF to save a fax.
Viewing archived faxes
The Fax Archive tab lists the faxes sent and received through the FortiVoice unit. For more
information about fax, see “Configuring fax” on page 257.
Fortinet Technologies Inc.
Page 31
FortiVoice Phone System 5.3.0 Administration Guide
To view fax configurations, go to Status > Storage > Fax Archive. The fax configurations are
listed with their names, numbers, storage sizes, and faxes stored.
You can double-click a fax configuration and view the detailed information on the faxes it stores.
To search the locally archived faxes, click Search.
Viewing fax queues
The Fax Queue tab lists the faxes waiting to be sent on the FortiVoice unit. For more information
about fax, see “Configuring fax” on page 257.
Searching for archived calls/faxes
When viewing recorded calls or archived faxes, you can click Search to make Call Archive
Search or Fax Archive Search tab appear and look for archived calls.
The Call Archive Search or Fax Archive Search tab lets you configure the search parameters for
locally archived calls or faxes. You can also select a search record and view the search
configuration, view the search result, and stop or resume the search.
To search for archived calls
1. Go to Status > Storage > Call Archive Search.
2. Click New and configure the following:
GUI field
Description
Recording type
Select to search for system (all calls except conference calls) calls,
conference calls, or both.
From
Enter the caller’s number of which you want to search for calls.
From Name
Enter the caller’s name of which you want to search for calls.
To
Enter the callee’s number of which you want to search for calls.
To Name
Enter the callee’s name of which you want to search for calls.
Call duration
Enter the call time range of which you want to search for calls.
Fro example, if you enter 10 for From and 20 for To, you are
searching for calls that last between 10 to 20 minutes.
Time
Enter the day and time range of which you want to search for calls.
Match Condition
Select the regular expression pattern for the search.
3. Click Create.
To search for archived faxes
1. Go to Status > Storage > Fax Archive Search.
2. Click New and configure the following:
Fortinet Technologies Inc.
GUI field
Description
From
Enter the sender’s number of which you want to search for faxes.
Page 32
FortiVoice Phone System 5.3.0 Administration Guide
eFax number
Enter the eFax account number of which you want to search for
faxes. For information on eFax, see “Configuring fax” on page 257.
eFax name
Enter the eFax account name of which you want to search for faxes.
For information on eFax, see “Configuring fax” on page 257.
Time
Enter the day and time range of which you want to search for faxes.
Match Condition
Select the regular expression pattern for the search.
3. Click Create.
Viewing call records
Status > Call Detail Records (CDR) displays all the phone calls made during a certain time
period, including time of the call, caller and receiver, call duration, call status, call direction,
trunks used, call type, and call recordings.
Double-clicking a record displays the detailed call information, including the CDR flow.
You can filter the call records display by clicking the Search button and enter criteria that
records must match in order to be visible. You can also save the call records by clicking the
Download button.
Viewing generated reports
The Call Reports tab displays the call reports and call center reports generated by the FortiVoice
unit. You can delete, view, and/or download generated reports.
FortiVoice units can generate reports automatically according to the report schedules that you
configure. For more information, see “Configuring report profiles and generating call reports” on
page 279.
To reduce the amount of hard disk space consumed by reports, regularly download then
delete generated reports from the FortiVoice unit.
To view call or call center reports
1. Go to Status > Call Reports> Reports/Call Center Reports.
Fortinet Technologies Inc.
Page 33
FortiVoice Phone System 5.3.0 Administration Guide
Figure 5: Reports tab
GUI field
Description
Download
Click to create a PDF or HTML version of the report.
Report File Name
Lists the name of the generated report, and the date and time at
which it was generated.
For example, Report 1-2012-03-31-2112 is a report named
Report 1, generated on March 31, 2012 at 9:12 PM. To view an
individual section of the report in HTML format, click + next to the
report name to expand the list of HTML files that comprise the
report, then double-click one of the file names.
Last Access Time
Lists the date and time when the FortiVoice unit completed the
generated report.
Size
Lists the file size of the report in HTML format, in bytes.
2. To view the report in PDF file format, mark the check box in the corresponding row and click
Download. On the pop-up menu, select Download PDF.
3. To view the report in HTML file format, you can view all sections of the report together, or you
can view report sections individually.
• To view all report sections together, mark the check box in the row corresponding to the
report, such as 1-2012-03-31-2112, then click Download and select Download HTML.
Your browser downloads a file with an archive (.tgz.gz) file extension to your
management computer. To view the report, first extract the report files from the archive,
then open the HTML files in your web browser.
• Each Query Selection in the report becomes a separate HTML file. You can view the
report as individual HTML files. In the row corresponding to the report that you want to
view, click + next to the report name to expand the list of sections, then double-click the
file name of the section that you want to view, such as report1.html. The report
appears in a new browser window.
4. To view the report in CSV (comma-separated value) file format that can be viewed in a
spreadsheet application such as Microsoft Excel or OpenOffice Calc, mark the check box in
the corresponding row and click Download. On the pop-up menu, select Download CSV.
Viewing log messages
The Logs submenu displays locally stored log files. If you configured the FortiVoice unit to store
log messages locally (that is, to the hard disk), you can view the log messages currently stored
in each log file.
Logs stored remotely cannot be viewed from the web-based manager of the FortiVoice unit. If
you want to view logs from the web-based manager, also enable local storage. For details, see
“Configuring Logs and Reports” on page 273.
Fortinet Technologies Inc.
Page 34
FortiVoice Phone System 5.3.0 Administration Guide
Status > Logs displays the logs of administrator activities and system events as well as voice,
fax, queue, hotel management (with license only), and call center (with license only).
To view the list of log files and their contents
1. Go to Status > Logs > Event/Voice/Fax/Queue/Hotel/Call center.
The list of log files appears with the beginning and end of a log file’s time range and the size
of a log file in bytes. The queue log files display more information.
2. To download an event, voice, fax, and call center log file, select it and click Download to
save it in one of the three formats:
• Normal Format for a log file that can be viewed with a plain text editor such as Microsoft
Notepad.
• CSV Format for a comma-separated value (.csv) file that can be viewed in a spreadsheet
application such as Microsoft Excel or OpenOffice Calc.
• Compressed Format for a plain text log file like Normal Format, except that it is
compressed and stored within a .gz archive.
3. To search the log files, click the Search button and enter criteria that records must match in
order to be visible.
Unlike the search when viewing the contents of an individual log file, this search displays
results regardless of which log file contains them. For more information, see “Searching log
messages” on page 38.
4. To view messages contained in logs, double-click a log file.
To view the current page’s worth of the log messages as an HTML table, right-click and
select Export to Table. The table appears in a new tab. To download the table, click and drag
to select the whole table, then copy and paste it into a rich text editor such as Microsoft
Word or OpenOffice Writer.
Log messages can appear in either raw or formatted views.
• Raw view displays log messages exactly as they appear in the plain text log file.
• Formatted view displays log messages in a columnar format. Each log field in a log
message appears in its own column, aligned with the same field in other log messages,
for rapid visual comparison.
By default, log messages always appear in columnar format, with one log field per column.
However, when viewing this columnar display, you can also view the log message in raw
format by hovering your mouse over the index number of the log message, in the # column,
as shown in Figure 6.
Fortinet Technologies Inc.
Page 35
FortiVoice Phone System 5.3.0 Administration Guide
Figure 6: Log message view
Log message in columnar format
Log message in raw format
The log messages vary by levels. For more information, see “Configuring Logs and Reports”
on page 273.
The log messages are also filtered by subtypes:
• Configuration: Display only log messages containing subtype=config.
• Administration: Display only log messages containing subtype=admin.
• System: Display only log messages containing subtype=system.
You can click the Save View button to save the customized view. Future log message reports
appear in this view.
Displaying and arranging log columns
When viewing logs, you can display, hide, sort and re-order columns.
For most columns, you can also filter data within the columns to include or exclude log
messages which contain your specified text in that column. For more information, see
“Searching log messages” on page 38.
By default, each page’s worth of log messages is listed with the log message with the lowest
index number towards the top.
To sort the page’s entries in ascending or descending order
1. Click the column heading by which you want to sort.
The log messages are sorted in ascending order.
2. To sort in descending order, click the column heading again.
Depending on your currently selected theme:
• the column heading may darken in color to indicate which column is being used to sort
the page
• a small upwards-or downwards-pointing arrow may appear in the column heading next to
its name to indicate the current sort order.
To display or hide columns
1. Go to Status > Logs > Event/Voice/Fax/Queue/Call center.
2. Double-click the row corresponding to time period whose log messages you want to view.
3. Position your mouse cursor over a column heading to display the down arrow on its
right-hand side, click the down arrow and move your cursor over Columns to display the list
of available columns, then mark the check boxes of columns that you want to display.
Fortinet Technologies Inc.
Page 36
FortiVoice Phone System 5.3.0 Administration Guide
Figure 7: Hiding and showing log columns
Make visible
Make invisible
4. Click Save View.
To change the order of the columns
1. Go to Status > Logs > Event/Voice/Queue/Call center.
2. Double-click the row corresponding to time period whose log messages you want to view.
3. For each column whose order you want to change, click and drag its column heading to the
left or right.
4. Click Save View.
Using the right-click pop-up menus
When you right-click on a log message, a context menu appears.
Figure 8: Using the right-click menus on log reports
Right-click pop-up menus
Fortinet Technologies Inc.
Page 37
FortiVoice Phone System 5.3.0 Administration Guide
Table 5: Log report right-click menu options
Select All
Select to select all log messages in the current page, so that you can
export all messages to a table.
Clear Selection
Select to deselect one or multiple log messages.
Export to Table
Select to export the selected log messages to a table format. A new tab
named Exported Table appears, displaying the exported information.
The table format allows you to copy the information and paste it
elsewhere.
Searching log messages
You can search logs to quickly find specific log messages in a log file, rather than browsing the
entire contents of the log file.
To search log messages
1. Go to Status > Logs > Event/Voice/Fax/Queue/Call center.
2. To search all log files, click Search.
3. To search one of the log files, first double-click the name of a log file to display the contents
of the log file, then click Search.
Figure 9: Log search dialog
4. Enter your search criteria by configuring one or more of the following:
GUI field
Description
Keyword
Enter any word or words to search for within the log messages.
For example, you might enter GUI session to locate all log messages
containing that exact phrase in any log field.
Fortinet Technologies Inc.
Message
Enter all or part of the Message log field.
Log ID
Enter all or part of the log ID in the log message.
Page 38
FortiVoice Phone System 5.3.0 Administration Guide
Time
Select the time span of log messages to include in the search
results.
For example, you might want to search only log messages that were
recorded during the two weeks and 8 hours previous to the current
date. In that case, you would specify the current date, and also
specify the size of the span of time (two weeks and 8 hours) before
that date.
Match condition
• Contain: searches for the exact match.
• Wildcard: supports wildcards in the entered search criteria.
5. Click Apply.
The FortiVoice unit searches your currently selected log file for log messages that match
your search criteria, and displays any matching log messages.
Viewing phone directories
The Directory tab displays the extensions used for the following purposes:
• local
• remote
• ring group
• paging
• virtual number
• conference
• analog
• general voicemail
• fax
To display the peer office extensions, you need to enable fetching office directory on the local
and peer office FortiVoice units. For more information, see “Configuring office peers” on
page 187.
To view or download the phone directory, go to Status > Directory.
Figure 10: Viewing directory
GUI field
Description
Download
Select to save all directories or search result.
Number
The extension number. For information on creating extension numbers,
see “Setting up local extensions” on page 136.
Fortinet Technologies Inc.
Page 39
FortiVoice Phone System 5.3.0 Administration Guide
Display Name
The name displaying on the extension. This is usually the name of the
extension user.
Location
The extension location.
Department
The department to which the extension belongs.
Type
The extension type.
Fortinet Technologies Inc.
Page 40
FortiVoice Phone System 5.3.0 Administration Guide
Configuring System Settings
The System menu lets you set up configurations of the FortiVoice operation system, including
administrator accounts, network settings, system time, SIP settings, system maintenance, and
more.
This topic includes:
• Configuring network settings
• Configuring administrator accounts and access profiles
• Using high availability
• Configuring system time, system options, SNMP, email setting, GUI appearance, and call
data storage
• Managing certificates
• Maintaining the system
Configuring network settings
The Network submenu provides options to configure network connectivity and administrative
access to the web-based manager or CLI of the FortiVoice unit through each network interface.
This topic includes:
• About IPv6 Support
• About the management IP
• About FortiVoice logical interfaces
• Configuring the network interfaces
• Configuring static routes
• Configuring DNS
• Configuring DHCP server
• Capturing voice and fax packets
About IPv6 Support
IP version 6 (IPv6) handles issues that were not around decades ago when IPv4 was created
such as running out of IP addresses, fair distributing of IP addresses, built-in quality of service
(QoS) features, better multimedia support, and improved handling of fragmentation. A bigger
address space, bigger default packet size, and more optional header extensions provide these
features with flexibility to customize them to any needs.
IPv6 has 128-bit addresses compared to IPv4’s 32-bit addresses, effectively eliminating
address exhaustion. This new very large address space will likely reduce the need for network
address translation (NAT) since IPv6 provides more than a billion IP addresses for each person
on Earth. All hardware and software network components must support this new address size,
an upgrade that may take a while to complete and will force IPv6 and IPv4 to work side-by-side
during the transition period.
Fortinet Technologies Inc.
Page 41
FortiVoice Phone System 5.3.0 Administration Guide
The FortiVoice unit supports the following IPv6 features:
• Network interface
• Network routing
• DNS
• DHCP
• Phone extension
• Trunk
About the management IP
The FortiVoice unit has an IP address for administrators to configure it through a network
connection rather than a local console. The management IP address enables administrators to
connect to the FortiVoice unit through port1 or other network ports, even when they are
currently bridging.
By default, the management IP address is indirectly bound to port1 through the bridge. If other
network interfaces are also included in the bridge with port1, you can configure the FortiVoice
unit to respond to connections to the management IP address that arrive on those other
network interfaces.
You can access the web-based manager and the FortiVoice user account using the
management IP address. For details, see “Connecting to the web-based manager” on page 16.
About FortiVoice logical interfaces
In addition to the FortiVoice physical interfaces, you can create the following types of logical
interfaces on the FortiVoice unit:
• VLAN subinterfaces
• Redundant interfaces
• Loopback interfaces
VLAN subinterfaces
A Virtual LAN (VLAN) subinterface, also called a VLAN, is a virtual interface on a physical
interface. The subinterface allows routing of VLAN tagged packets using that physical interface,
but it is separate from any other traffic on the physical interface.
Virtual LANs (VLANs) use ID tags to logically separate devices on a network into smaller
broadcast domains. These smaller domains forward packets only to devices that are part of that
VLAN domain. This reduces traffic and increases network security.
One example of an application of VLANs is a company’s accounting department. Accounting
computers may be located at both main and branch offices. However, accounting computers
need to communicate with each other frequently and require increased security. VLANs allow
the accounting network traffic to be sent only to accounting computers and to connect
accounting computers in different locations as if they were on the same physical subnet.
For information about adding VLAN subinterfaces, see “Configuring the network interfaces” on
page 43.
Redundant interfaces
On the FortiVoice unit, you can combine two or more physical interfaces to provide link
redundancy. This feature allows you to connect to two or more switches to ensure connectivity
in the event one physical interface or the equipment on that interface fails.
Fortinet Technologies Inc.
Page 42
FortiVoice Phone System 5.3.0 Administration Guide
In a redundant interface, traffic is only going over one interface at any time. This differs from an
aggregated interface where traffic is going over all interfaces for increased bandwidth. This
difference means redundant interfaces can have more robust configurations with fewer possible
points of failure. This is important in a fully-meshed high availability (HA) configuration.
A physical interface is available to be in a redundant interface if:
• it is a physical interface, not a VLAN interface
• it is not already part of a redundant interface
• it has no defined IP address and is not configured for DHCP
• it does not have any VLAN subinterfaces
• it is not monitored by HA
When a physical interface is included in a redundant interface, it is not listed on the System >
Network > Network page. You cannot configure the interface anymore.
For information about adding redundant interfaces, see “Configuring the network interfaces” on
page 43.
Loopback interfaces
A loopback interface is a logical interface that is always up (no physical link dependency) and
the attached subnet is always present in the routing table.
The FortiVoice’s loopback IP address does not depend on one specific external port, and is
therefore possible to access it through several physical or VLAN interfaces. In the current
release, you can only add one loopback interface on the FortiVoice unit.
For information about adding a loopback interface, see “Configuring the network interfaces” on
page 43.
Configuring the network interfaces
The System > Network > Network tab displays the FortiVoice unit’s network interfaces.
You must configure at least one network interface for the FortiVoice unit to connect to your
network. Depending on your network topology and other considerations, you can connect the
FortiVoice unit to your network using two or more of the network interfaces. You can configure
each network interface separately. You can also configure advanced interface options, including
VLAN subinterfaces, redundant interfaces, and loopback interfaces. For more information, see
“About FortiVoice logical interfaces” on page 42, and “Editing network interfaces” on page 44.
To view the list of network interfaces, go to System > Network > Network.
Figure 11: Network tab
GUI field
Description
Name
Displays the name of the network interface, such as port1.
Fortinet Technologies Inc.
Page 43
FortiVoice Phone System 5.3.0 Administration Guide
Type
Displays the interface type: physical, VLAN, redundant, or loopback. For
details, see “About FortiVoice logical interfaces” on page 42.
IP/Netmask
Displays the IP address and netmask of the network interface.
IPv6/Netmask
Displays the IPv6 address and netmask of the network interface. For
more information about IPv6 support, see “About IPv6 Support” on
page 41.
Access
Displays the administrative access and phone user access that are
enabled on the network interface, such as HTTPS for the web-based
manager.
Status
Indicates the up (available) or down (unavailable) administrative status
for the network interface.
• Green up arrow: The network interface is up and can receive traffic.
• Red down arrow: The network interface is down and cannot receive
traffic.
To change the administrative status (that is, bring up or down a network
interface), see “Editing network interfaces” on page 44.
Editing network interfaces
You can edit FortiVoice’s physical network interfaces to change their IP addresses, netmasks,
administrative access protocols, and other settings. You can also create or edit logical
interfaces, such as VLANs, redundant interfaces and the loopback interface.
Enable administrative access only on network interfaces connected to trusted private
networks or directly to your management computer. If possible, enable only secure
administrative access protocols such as HTTPS or SSH. Failure to restrict administrative
access could compromise the security of your FortiVoice unit.
You can restrict which IP addresses are permitted to log in as a FortiVoice administrator through
network interfaces. For details, see “Configuring administrator accounts” on page 53.
To create or edit a network interface
1. Go to System > Network > Network.
2. Double-click a network interface to modify it or select the interface and click Edit. If you want
to create a logical interface, click New.
The Edit Interface dialog appears.
3. Configure the following:
Fortinet Technologies Inc.
Page 44
FortiVoice Phone System 5.3.0 Administration Guide
Figure 12: Edit Interface dialog
Figure 13: Creating logical interfaces
GUI field
Description
Interface Name
If you are editing an existing interface, this field displays the name
(such as port2) and media access control (MAC) address for this
network interface.
If you are creating a logical interface, enter a name for the interface.
Fortinet Technologies Inc.
Page 45
FortiVoice Phone System 5.3.0 Administration Guide
Type
If you are creating a logical interface, select which type of interface
you want to create. For information about logical interface types, see
“About FortiVoice logical interfaces” on page 42.
• VLAN: If you want to create a VLAN subinterface, select the
interface for which you want to create the subinterface. Then
specify a VLAN ID. Valid VLAN ID numbers are from 1 to 4094,
while 0 is used for high priority frames, and 4095 is reserved.
• Redundant: If you want to create a redundant interface, select the
interface members from the available interfaces. Usually, you
need to include two or more interfaces as the redundant interface
members.
• Loopback: If you want to add a loopback interface, select the
Loopback type and the interface name will be automatically reset
to “loopback”. You can only add one loopback interface on the
FortiVoice unit.
Addressing Mode
• Manual: Select to enter the IP address or IPv6 address and
netmask for the network interface in IP/Netmask or
IPv6/Netmask.
• DHCP: Select and click Update request to retrieve a dynamic IP
address using DHCP.
Fortinet Technologies Inc.
Page 46
FortiVoice Phone System 5.3.0 Administration Guide
Access
Enable protocols that this network interface should accept for
connections to the FortiVoice unit itself. (These options do not affect
connections that will travel through the FortiVoice unit.)
• HTTPS: Enable to allow secure HTTPS connections to the
web-based manager, and extension user account through this
network interface.
• HTTP: Enable to allow HTTP connections to the web-based
manager, and extension user account through this network
interface.
Enable this option if you select Centralized phonebook when
configuring programmable phone key. For more information, see
“Set Programmable Phone Key” on page 126.
• PING: Enable to allow ICMP ECHO (ping) responses from this
network interface.
For information on configuring the network interface from which
the FortiVoice unit itself will send pings, see the FortiVoice CLI
Reference.
• SSH: Enable to allow SSH connections to the CLI through this
network interface.
• SNMP: Enable to allow SNMP connections (queries) to this
network interface.
For information on further restricting access, or on configuring the
network interface that will be the source of traps, see
“Configuring the network interfaces” on page 43.
• TELNET: Enable to allow Telnet connections to the CLI through
this network interface.
Caution: HTTP and Telnet connections are not secure, and can
be intercepted by a third party. If possible, enable this option only
for network interfaces connected to a trusted private network, or
directly to your management computer. Failure to restrict
administrative access through this protocol could compromise
the security of your FortiVoice unit. For information on further
restricting access of administrative connections, see “Configuring
administrator accounts” on page 53.
MTU
Override default MTU value (1500): Enable to change the maximum
transmission unit (MTU) value, then enter the maximum packet or
Ethernet frame size in bytes.
If network devices between the FortiVoice unit and its traffic
destinations require smaller or larger units of traffic, packets may
require additional processing at each node in the network to
fragment or defragment the units, resulting in reduced network
performance. Adjusting the MTU to match your network can improve
network performance.
The default value is 1500 bytes. The MTU size must be between 576
and 1500 bytes. Change this if you need a lower value; for example,
RFC 2516 prescribes a value of 1492 for the PPPoE protocol.
Fortinet Technologies Inc.
Page 47
FortiVoice Phone System 5.3.0 Administration Guide
Administrative
status
Select either:
• Up: Enable (that is, bring up) the network interface so that it can
send and receive traffic.
• Down: Disable (that is, bring down) the network interface so that
it cannot send or receive traffic.
Configuring static routes
The System > Network > Routing tab displays a list of routes and lets you configure static
routes and gateways used by the FortiVoice unit.
Static routes direct traffic exiting the FortiVoice unit. You can specify through which network
interface a packet will leave, and the IP address of a next-hop router that is reachable from that
network interface. The router is aware of which IP addresses are reachable through various
network pathways, and can forward those packets along pathways capable of reaching the
packets’ ultimate destinations.
A default route is a special type of static route. A default route matches all packets, and defines
a gateway router that can receive and route packets if no other, more specific static route is
defined for the packet’s destination IP address.
You should configure at least one static route, a default route, that points to your gateway.
However, you may configure multiple static routes if you have multiple gateway routers, each of
which should receive packets destined for a different subset of IP addresses.
To determine which route a packet will be subject to, the FortiVoice unit compares the packet’s
destination IP address to those of the static routes and forwards the packet to the route with the
large prefix match.
When you add a static route through the web-based manager, the FortiVoice unit evaluates the
route to determine if it represents a different route compared to any other route already present
in the list of static routes. If no route having the same destination exists in the list of static
routes, the FortiVoice unit adds the static route.
To view or configure static routes
1. Go to System > Network > Routing.
GUI field
Description
Enabled
Displays the route status.
Destination
IP/Netmask
Displays the destination IP address and subnet of packets subject to
the static route. A setting of 0.0.0.0/0.0.0 indicates that the route
matches all destination IP addresses.
Gateway
Displays the IP address of the next-hop router to which packets
subject to the static route will be forwarded.
Interface
The interface that this route applies to.
Comment
Displays any notes on the static route.
2. Either click New to add a route or double-click a route to modify it.
A dialog appears.
3. Select Enabled to activate the route.
Fortinet Technologies Inc.
Page 48
FortiVoice Phone System 5.3.0 Administration Guide
4. In Destination IP/netmask, enter the destination IP address and netmask of packets that will
be subject to this static route.
To create a default route that will match all packets, enter 0.0.0.0/0.0.0.0.
5. Select the interface that this route applies to.
6. In Gateway, type the IP address of the next-hop router to which the FortiVoice unit will
forward packets subject to this static route. This router must know how to route packets to
the destination IP addresses that you have specified in Destination IP/netmask. For an
Internet connection, the next hop routing gateway routes traffic to the Internet.
7. Enter any comments you have for the route.
8. Click Create or OK.
Configuring DNS
FortiVoice units require DNS servers for features such as reverse DNS lookups. Your ISP may
supply IP addresses of DNS servers, or you may want to use the IP addresses of your own DNS
servers.
For improved FortiVoice unit performance, use DNS servers on your local network.
The DNS tab lets you configure the DNS servers that the FortiVoice unit queries to resolve
domain names into IP addresses.
To configure the primary and secondary DNS servers
1. Go to System > Network > DNS.
2. In Primary DNS server, enter the IP address of the primary DNS server.
3. In Secondary DNS server, enter the IP address of the secondary DNS server.
4. Click Apply.
Configuring DHCP server
A DHCP server provides an address to a client on the network, when requested, from a defined
address range.
You can configure one or more DHCP servers on any FortiVoice interface. A DHCP server
dynamically assigns IP addresses to the clients on the network connected to the interface.
These clients must be configured to obtain their IP addresses using DHCP.
To configure the DHCP server
1. Go to System > Network > DHCP.
2. Click New and configure the following:
GUI field
Description
Network Interface
Setting
Fortinet Technologies Inc.
Page 49
FortiVoice Phone System 5.3.0 Administration Guide
ID
The system will generate an ID for this configuration. This is view
only.
Enabled
Select to enable the DHCP server.
Interface
Select an interface for the DHCP server from the drop-down list.
If this FortiVoice is in HA mode, make sure that the slave unit has
the same interface as the master unit. For information on HA,
see “Using high availability” on page 56.
Gateway
Enter the IP address of the default gateway that the DHCP
server assigns to DHCP clients.
DNS options
Select to use either a specific DNS server or the system’s DNS
settings.
If you select a specific DNS server, enter the Primary DNS server
and the Secondary DNS server fields.
For more information, see “Configuring DNS” on page 49.
Domain
Enter the domain that the DHCP server assigns to its clients.
Netmask
Enter the netmask of the addresses that the DHCP server
assigns.
Advanced Setting
TFTP server (Opt66) The default TFTP server (192.168.2.99) is where the
configuration files for the supported phones are stored. This is
also the IP address of the default gateway that the DHCP server
assigns to the DHCP clients. If you have your own TFTP server
for such information, enter its IP address in this field. However,
SIP phone auto-provisioning will not work in this case. For more
information, see “Configuring SIP phone auto-provisioning” on
page 112.
Lease time
(Seconds)
Enter the length of time an IP address remains assigned to a
client. Once the lease expires, the address is released for
allocation to the next client request for an IP address. The
default time is 604800 seconds.
Vender Class
Identifier option
Select this option to apply the DHCP configuration to the
phones of a specific vendor identified by the VCI string supplied
by the vendor or by checking Monitor > PBX Status > DHCP >
VCI.
VCI string
Enter the phone VCI string supplied by the vendor.
Options
Fortinet Technologies Inc.
Page 50
FortiVoice Phone System 5.3.0 Administration Guide
Option 66 (TFTP)
Select to configure which TFTP server to use.
• Auto provisioning server: Select if you want to use the default
TFTP server (192.168.2.99) which is where the configuration
files for the supported phones are stored. This is also the IP
address of the default gateway that the DHCP server assigns
to the DHCP clients. For more information, see “Configuring
SIP phone auto-provisioning” on page 112.
• User defined IP/host: Select if you have your own TFTP
server for such information, enter its IP address in this field.
DHCP IP Range
Click New to enter the start and end for the range of IP
addresses that this DHCP server assigns to the DHCP clients.
DHCP Excluded IP
Range
Click New to enter a range of IP addresses that this server
should not assign to the DHCP clients.
Reserved IP Address
Click New to enter an IP address from the DHCP server to
match it to a specific client using its MAC address.
In a typical situation, an IP address is assigned ad hoc to a
client, and that assignment times out after a specific time of
inactivity from the client, known as the lease time. To ensure a
client always has the same IP address, that is, there is no lease
time, use this option.
3. Click Create.
Capturing voice and fax packets
When troubleshooting networks, it helps to look inside the contents of the packets. This helps
to determine if the packets, route, and destination are all what you expect. Traffic capture can
also be called packet sniffing, a network tap, or logic analyzing.
Packet sniffing tells you what is happening on the network at a low level. This can be very useful
for troubleshooting problems, such as:
• finding missing traffic
• seeing if sessions are setting up properly
• locating ARP problems such as broadcast storm sources and causes
• confirming which address a computer is using on the network if they have multiple
addresses or are on multiple networks
• confirming routing is working as you expect
• intermittent missing PING packets.
If you are running a constant traffic application such as ping, packet sniffing can tell you if the
traffic is reaching the destination, how the port enters and exits the FortiVoice unit, if the ARP
resolution is correct, and if the traffic is returning to the source as expected. You can also use
packet switching to verify that NAT or other configuration is translating addresses or routing
traffic the way that you want it to.
Before you start sniffing packets, you need to have a good idea of what you are looking for.
Sniffing is used to confirm or deny your ideas about what is happening on the network. If you try
sniffing without a plan to narrow your search, you could end up with too much data to effectively
analyze. On the other hand, you need to sniff enough packets to really understand all of the
patterns and behavior that you are looking for.
Fortinet Technologies Inc.
Page 51
FortiVoice Phone System 5.3.0 Administration Guide
To capture voice and fax packets
1. Go to System > Network > Traffic Capture.
Figure 14: Traffic capture list
GUI field
Description
Stop
Click to stop the packet capture.
Download
When the capture is complete, click Download to save the packet
capture file to your hard disk for further analysis.
Name
The name of the packet capture file.
Status
The status of the packet capture process, Complete or Running.
Size
The size of the packet capture file.
2. Click New.
3. Enter a prefix for the file generated from the captured traffic. This will make it easier to
recognize the files.
4. Enter the time period for performing the packet capture.
5. If you choose SIP or Use protocol for Filter, from the Available peers field, select the
extension or trunk of which you want to capture the voice packets and click -> to move them
into the Selected peers field. You can select up to 3 peers.
6. If you want to limit the scope of traffic capture, in the IP/HOST field, enter a maximum of 3 IP
addresses or host names for the extensions and trunks you selected. Only traffic on these IP
addresses or host names is captured.
7. Select the filter for the traffic capture:
• SIP: Only SIP traffic of the peers you select will be captured.
• Use protocol: Only UDP or TCP traffic of the peers you select will be captured.
• Capture all: All network traffic will be captured.
8. For Exclusion, enter the IP addresses/host names and port numbers of which you do not
want to capture voice traffic.
9. Click Create.
Configuring administrator accounts and access profiles
The Admin submenu configures administrator accounts and access profiles.
This topic includes:
• Configuring administrator accounts
• Configuring administrator profiles
Fortinet Technologies Inc.
Page 52
FortiVoice Phone System 5.3.0 Administration Guide
Configuring administrator accounts
The Administrators tab displays a list of the FortiVoice unit’s administrator accounts and the
trusted host IP addresses administrators use to log in (if configured).
By default, FortiVoice units have a single administrator account, admin. For more granular
control over administrative access, you can create additional administrator accounts with
restricted permissions.
To view and configure administrator accounts
1. Go to System > Admin > Administrators.
Figure 15: Administrators tab
GUI field
Description
Name
Displays the name of the administrator account.
Extension
Displays the extension associated with the administrator account.
Authentication Type The administrator authentication type: Local or LDAP.
Authentication
Profile
The LDAP authentication profile. For more information, see
“Configuring LDAP profiles” on page 126.
Trusted Hosts
Displays the IP address and netmask from which the administrator
can log in.
Admin Profile
The administrator profile that determines which functional areas the
administrator account may view or affect.
2. Either click New to add an account or double-click an account to modify it.
A dialog appears.
3. Configure the following:
GUI field
Description
Administrator
Enter the name for this administrator account.
The name can contain numbers (0-9), uppercase and lowercase
letters (A-Z, a-z), hyphens ( - ), and underscores ( _ ). Other special
characters and spaces are not allowed.
Fortinet Technologies Inc.
Page 53
FortiVoice Phone System 5.3.0 Administration Guide
Single sign-on
manager
Select the extension for the administrator account.
If you add an extension, a User portal icon appears at the top of the
web-based manager when you log into the FortiVoice unit. Clicking
the icon opens the user web portal.
Click Edit to modify the selected extension or click New to configure
a new one. For more information on extensions, see “Configuring IP
extensions” on page 136.
Managed
departments
This option appears after you select an extension for the
administrator account.
If you want to configure an administrator to manage call center
departments, click >> and select the departments for the
administrator. Click Done when you are finished.
For information on setting up call center departments, see
“Configuring agents” on page 209.
With this configuration, an administrator can log into the FortiVoice
unit and view the following information of the managed departments:
• recorded calls
• call center reports
• call queues
• call queue reports
The administrator can also click User Portal to go to the user web
portal and click Administrator to return to the administration page.
Note that in the administrator’s Admin profile, Call center
management and Storage recorded calls must be Read Only or
Read-Write. For details, see “Configuring administrator profiles” on
page 55.
Authentication type Select an administrator authentication type: Local or LDAP.
Create password
Click to configure account login information.
• Password: Enter this account’s password.
The password can contain any character except spaces.
This field does not appear if Authentication type is LDAP.
Caution: Do not enter a FortiVoice administrator password less
than six characters long. For better security, enter a longer
password with a complex combination of characters and
numbers, and change the password regularly. Failure to provide a
strong password could compromise the security of your
FortiVoice unit.
• Confirm password: Enter this account’s password again to
confirm it.
This field does not appear if Authentication type is LDAP.
LDAP profile
Fortinet Technologies Inc.
If you select LDAP for Authentication type, select an LDAP
authentication profile. For more information, see “Configuring LDAP
profiles” on page 126.
Page 54
FortiVoice Phone System 5.3.0 Administration Guide
Trusted Hosts
Enter an IPv4 or IPv6 address or subnet from which this
administrator can log in.
If you want the administrator to access the FortiVoice unit from any
IP address, use 0.0.0.0/0.0.0.0.
Enter the IP address and netmask in dotted decimal format. For
example, you might permit the administrator to log in to the
FortiVoice unit from your private network by typing
192.168.1.0/255.255.255.0.
Note: For additional security, restrict all trusted host entries to
administrative hosts on your trusted private network. For example, if
your FortiVoice administrators log in only from the 10.10.10.10/24
subnet, to prevent possibly fraudulent login attempts from
unauthorized locations, you could configure that subnet in the
Trusted Host #1, Trusted Host #2, and Trusted Host #3 fields.
Note: For information on restricting administrative access protocols
that can be used by these hosts, see “Editing network interfaces” on
page 44.
Click the + sign to add additional IP addresses or subnets from
which the administrator can log in.
Admin profile
Select the name of an admin profile that determines which functional
areas the administrator account may view or affect.
Click New to create a new profile or Edit to modify the selected
profile. For details, see “Configuring administrator profiles” on
page 55.
Select language
Select this administrator account’s preference for the display
language of the web-based manager.
Select theme
Select this administrator account’s preference for the display theme
or click Use Current to choose the theme currently in effect.
The administrator may switch the theme at any time during a session
by clicking Next Theme.
Description
Click Click to edit to enter any comments for the administrator
account.
4. Click Create.
Configuring administrator profiles
The Admin Profile tab displays a list of administrator access profiles.
Administrator profiles govern which areas of the web-based manager and CLI that an
administrator can access, and whether or not they have the permissions necessary to change
the configuration or otherwise modify items in each area.
To configure administrator access profiles
1. Go to System > Admin > Admin Profile.
2. Either click New to add an account or double-click an access profile to modify it.
3. In Profile name, enter the name for this access profile.
Fortinet Technologies Inc.
Page 55
FortiVoice Phone System 5.3.0 Administration Guide
4. In the Configure the privileges table, for each access control option, select the permissions
to be granted to administrator accounts associated with this access profile:
• None
• Read Only
• Read-Write
5. Click Create.
Using high availability
Go to System > High Availability to configure the FortiVoice unit to act as a high availability (HA)
member in order to increase availability.
For the general procedure of how to enable and configure HA, see “How to use HA” on page 59.
This section contains the following topics:
• About high availability
• About the heartbeat and synchronization
• How to use HA
• Monitoring the HA status
• Configuring service-based failover
• Example: Failover scenarios
About high availability
FortiVoice units operate in active-passive HA mode which has the following features:
• 2 FortiVoice units in the HA group
• Both configuration and data synchronized (For exceptions to synchronized configuration
items, see “Configuration settings that are not synchronized” on page 58.
• Only primary unit processes phone calls
• No data loss when hardware fails although active calls are disconnected and line
appearance and extension appearance take time to restore
• Has failover protection, but no increased processing capacity.
Fortinet Technologies Inc.
Page 56
FortiVoice Phone System 5.3.0 Administration Guide
Figure 16:Active-passive HA group
Internal
network
Internet
Switch
Active
Passive
FortiVoice
Active-passive
HA Group
Same FortiVoice models must be used in the same HA group. All units in the HA group must
have the same firmware version with the same hardware.
Communications between HA members occur through the heartbeat and synchronization
connection. For details, see “About the heartbeat and synchronization” on page 57.
To configure FortiVoice units operating in HA mode, you usually connect only to the primary unit
(master). The primary unit’s configuration is almost entirely synchronized to secondary units
(slave), so that changes made to the primary unit are propagated to the secondary units.
Exceptions to this rule include connecting to a secondary unit in order to view log messages
recorded about the secondary unit itself on its own hard disk, and connecting to a secondary
unit to configure settings that are not synchronized. For details, see “Configuration settings that
are not synchronized” on page 58.
For instructions of how to enable and configure HA, see “How to use HA” on page 59.
About the heartbeat and synchronization
Heartbeat and synchronization traffic consists of TCP packets transmitted between the
FortiVoice units in the HA group through the primary and secondary heartbeat interfaces.
Service monitoring traffic can also, for short periods, be used as a heartbeat. For details, see
“Remote services as heartbeat” on page 66.
Fortinet Technologies Inc.
Page 57
FortiVoice Phone System 5.3.0 Administration Guide
Heartbeat and synchronization traffic has three primary functions:
• to monitor the responsiveness of the HA group members
• to synchronize configuration changes from the primary unit to the secondary units
For exceptions to synchronized configuration items, see “Configuration settings that are not
synchronized” on page 58.
• to synchronize system and user data from the primary unit to the secondary unit
Call data consists of the FortiVoice call detailed records, recorded calls, voicemail, call
directories, fax, and voice prompts.
When the primary unit’s configuration changes, it immediately synchronizes the change to the
secondary unit through the primary heartbeat interface. If this fails, or if you have inadvertently
de-synchronized the secondary unit’s configuration, you can manually initiate synchronization.
For details, see “click HERE to start a configuration/data sync” on page 62. You can also use
the CLI command diagnose system ha sync on either the primary unit or the secondary
unit to manually synchronize the configuration. For details, see the FortiVoice CLI Reference.
During normal operation, the secondary unit expects to constantly receive heartbeat traffic from
the primary unit. Loss of the heartbeat signal interrupts the HA group and generally triggers a
failover. For details, see “Failover scenario 1: Temporary failure of the primary unit” on page 71.
Exceptions include system restarts and the execute reload CLI command. In case of a
system reboot or reload of the primary unit, the primary unit signals the secondary unit to wait
for the primary unit to complete the restart or reload. For details, see “Failover scenario 2:
System reboot or reload of the primary unit” on page 72.
Periodically, the secondary unit checks with the primary unit to see if there are any configuration
changes on the primary unit. If there are configuration changes, the secondary unit will pull the
configuration changes from the primary unit, generate a new configuration, and reload the new
configuration. In this case, both the primary and secondary units can be configured to send
alert email. For details, see “Failover scenario 3: System reboot or reload of the secondary unit”
on page 73 and “Configuring alert email” on page 287.
Configuration settings that are not synchronized
All configuration settings on the primary unit are synchronized to the secondary unit, except the
following:
Table 6: HA settings not synchronized
Host name
The host name distinguishes members of the cluster.
Static route
Static routes are not synchronized because the HA units may be in
different networks (see “Configuring static routes” on page 48).
Interface
configuration
Each FortiVoice unit in the HA group must be configured with different
network interface settings for connectivity purposes. For details, see
“Configuring the network interfaces” on page 43.
Exceptions include some active-passive HA settings which affect the
interface configuration for failover purposes. These settings are
synchronized.
Main HA
configuration
Fortinet Technologies Inc.
The main HA configuration, which includes the HA mode of operation
(such as master or slave), is not synchronized because this configuration
must be different on the primary and secondary units. For details, see
“Configuring the HA mode and group” on page 63.
Page 58
FortiVoice Phone System 5.3.0 Administration Guide
Table 6: HA settings not synchronized
HA service
monitoring
configuration
In active-passive HA, the HA service monitoring configuration is not
synchronized. The remote service monitoring configuration on the
secondary unit controls how the secondary unit checks the operation of
the primary unit. The local services configuration on the primary unit
controls how the primary unit tests the operation of the primary unit. For
details, see “Configuring service-based failover” on page 69.
Note: You might want to have a different service monitoring configuration
on the primary and secondary units. For example, after a failover you
may not want service monitoring to operate until you have fixed the
problems that caused the failover and have restarted normal operation of
the HA group.
System
appearance
The appearance settings you configured under System > Configuration >
Appearance are not synchronized.
Synchronization after a failover
During normal operation, extensions are in one of two states:
• registered and idle
• active call
When a failover occurs, active calls are interrupted and users have to reinitiate the calls.
However, registered idle extensions can still make and receive phone calls without being
affected.
When a failover is corrected, one of the following occurs automatically:
1. The secondary unit detects the failure of the primary unit, and becomes the new primary
unit.
2. The former primary unit restarts, detects the new primary unit, and becomes a secondary
unit.
You may have to manually restart the failed primary unit.
How to use HA
In general, to enable and configure HA, you should perform the following:
1. Physically connect the FortiVoice units that will be members of the HA group.
You must connect at least one of their network interfaces for heartbeat and synchronization
traffic between members of the group. For reliability reasons, Fortinet recommends that you
connect both a primary and a secondary heartbeat interface, and that they be connected
directly or through a dedicated switch that is not connected to your overall network.
Fortinet Technologies Inc.
Page 59
FortiVoice Phone System 5.3.0 Administration Guide
2. On each member of the group:
• Enable the HA mode that you want to use and select whether the individual member will
act as a primary unit or secondary unit. For information about the differences between
the HA modes, see “About high availability” on page 56.
• Configure the local IP addresses of the primary and secondary heartbeat and
synchronization network interfaces.
• Configure a virtual IP address that is shared by the HA group and remains the same after
a failover. The virtual IP address is used to auto-provision the server IP address and the
SIP trunk client IP address.
• Configure the behavior on failover, and how the network interfaces should be configured
for whichever FortiVoice unit is currently acting as the primary unit.
3. If you want to trigger failover when hardware or a service fails, even if the heartbeat
connection is still functioning, configure service monitoring. For details, see “Configuring
service-based failover” on page 69.
4. Monitor the status of each group member. For details, see “Monitoring the HA status” on
page 60. To monitor HA events through log messages and/or alert email, you must first
enable logging of HA activity events. For details, see “Configuring logging” on page 275.
Monitoring the HA status
The Status tab in the High Availability submenu shows the configured HA mode of operation of
a FortiVoice unit in an HA group. You can also manually initiate synchronization and reset the HA
mode of operation. A reset may be required if a FortiVoice unit’s effective HA mode of operation
differs from its configured HA mode of operation, such as after a failover when a configured
primary unit is currently acting as a secondary unit.
For FortiVoice units operating as secondary units, the Status tab also lets you view the status
and schedule of the HA synchronization daemon.
Before you can use the Status tab, you must first enable and configure HA. For details, see
“How to use HA” on page 59.
To view the HA mode of operation status, go to System > High Availability > Status.
Figure 17:Active-passive HA status (primary unit)
Fortinet Technologies Inc.
Page 60
FortiVoice Phone System 5.3.0 Administration Guide
Table 7: Viewing HA status
GUI item
Description
Mode Status
Configured
Operating
Mode
Displays the HA operating mode that you configured, either:
• master: Configured to be the primary unit of an
active-passive group.
• slave: Configured to be the secondary unit of an
active-passive group.
For information on configuring the HA operating mode, see
“Mode of operation” on page 65.
After a failure, the FortiVoice unit may not be acting in its
configured HA operating mode. For details, see “Effective
Operating Mode” on page 61.
Effective
Operating
Mode
Displays the mode that the unit is currently operating in, either:
• master: Acting as primary unit.
• slave: Acting as secondary unit.
• off: For primary units, this indicates that service/interface
monitoring has detected a failure and has taken the
primary unit offline, triggering failover. For secondary units,
this indicates that synchronization has failed once; a
subsequent failure will trigger failover. For details, see “On
failure” on page 65.
• failed: Service/network interface monitoring has detected a
failure and the diagnostic connection is currently
determining whether the problem has been corrected or
failover is required. For details, see “On failure” on page 65.
The configured HA operating mode matches the effective
operating mode unless a failure has occurred.
For example, after a failover, a FortiVoice unit configured to
operate as a secondary unit could be acting as a primary unit.
For explanations of combinations of configured and effective
HA modes of operation, see Table 8.
For information on restoring the FortiVoice unit to an effective
HA operating mode that matches the configured operating
mode, see “click HERE to restore configured operating mode”
on page 62.
Daemon
Status
Fortinet Technologies Inc.
This option appears only for secondary units in active-passive HA groups.
Page 61
FortiVoice Phone System 5.3.0 Administration Guide
Table 7: Viewing HA status
GUI item
Description
Monitor
Displays the time at which the secondary unit’s HA daemon
will check to make sure that the primary unit is operating
correctly, and, if monitoring has detected a failure, the number
of times that a failure has occurred.
Monitoring occurs through the heartbeat link between the
primary and secondary units. If the heartbeat link becomes
disconnected, the next time the secondary unit checks for the
primary unit, the primary unit will not respond. If the maximum
number of consecutive failures is reached, and no secondary
heartbeat or remote service monitoring heartbeat is available,
the secondary unit will change its effective HA operating mode
to become the new primary unit.
For details, see “HA base port” on page 66.
Configuration Displays the time at which the secondary unit’s HA daemon
will synchronize the FortiVoice configuration from the primary
unit to the secondary unit.
The message slave unit is currently
synchronizing appears when the HA daemon is
synchronizing the configuration.
For information on items that are not synchronized, see
“Configuration settings that are not synchronized” on page 58.
Data
Displays the time at which the secondary unit HA daemon will
synchronize mail data from the primary unit to the secondary
unit.
The message slave unit is currently
synchronizing appears when the HA daemon is
synchronizing data.
Actions
click HERE to
start a
configuration/
data sync
Click to manually initiate synchronization of the configuration
and call data. For information on items that are not
synchronized, see “Configuration settings that are not
synchronized” on page 58.
click HERE to
restore
configured
operating
mode
Click to reset the FortiVoice unit to an effective HA operating
mode that matches the FortiVoice unit’s configured operating
mode.
For example, for a configured primary unit whose effective HA
operating mode is now slave, after correcting the cause of the
failover, you might click this option on the primary unit to
restore the configured primary unit to active duty, and restore
the secondary unit to its slave role.
Note: Before selecting this option, if the effective HA operating
mode changed due to failover, you should resolve any issues
that caused the failover.
Fortinet Technologies Inc.
Page 62
FortiVoice Phone System 5.3.0 Administration Guide
Table 8: Combinations of configured and effective HA modes of operation
Configured Effective Description
operating
operating
mode
mode
master
master
Normal for the primary unit of an active-passive HA group.
slave
slave
Normal for the secondary unit of an active-passive HA group.
master
off
The primary unit has experienced a failure, or the FortiVoice unit is in
the process of switching to operating in HA mode.
HA processes and call processing are stopped.
slave
off
The secondary unit has detected a failure, or the FortiVoice unit is in
the process of switching to operating in HA mode.
After the secondary unit starts up and connects with the primary unit
to form an HA group, the first configuration synchronization may fail
in special circumstances. To prevent both the secondary and
primary units from simultaneously acting as primary units, the
effective HA mode of operation becomes off.
If subsequent synchronization fails, the secondary unit’s effective
HA mode of operation becomes master.
master
failed
The remote service monitoring or local network interface monitoring
on the primary unit has detected a failure, and will attempt to
connect to the other FortiVoice unit. If the problem that caused the
failure has been corrected, the effective HA mode of operation
switches from failed to slave, or to match the configured HA mode of
operation, depending on the On failure setting.
master
slave
The primary unit has experienced a failure but then returned to
operation. When the failure occurred, the unit configured to be the
secondary unit became the primary unit. When the unit configured
to be the primary unit restarted, it detected the new primary unit and
so switched to operating as the secondary unit.
slave
master
The secondary unit has detected that the FortiVoice unit configured
to be the primary unit failed. When the failure occurred, the unit
configured to be the secondary unit became the primary unit.
Configuring the HA mode and group
The Configuration tab in the System > High Availability submenu lets you configure the high
availability (HA) options, including:
• enabling HA
• whether this individual FortiVoice unit will act as a primary unit or a secondary unit in the
group
• network interfaces that will be used for heartbeat and synchronization and virtual IP
• service monitor
HA settings, with the exception of Virtual IP Address settings, are not synchronized and must be
configured separately on each primary and secondary unit.
Fortinet Technologies Inc.
Page 63
FortiVoice Phone System 5.3.0 Administration Guide
You must maintain the physical link between the heartbeat and synchronization network
interfaces. These connections enable a group member to detect the responsiveness of the
other member, and to synchronize data. If they are interrupted, normal operation will be
interrupted and a failover will occur. For more information on heartbeat and synchronization, see
“About the heartbeat and synchronization” on page 57.
You can directly connect the heartbeat network interfaces of the two FortiVoice units using a
crossover Ethernet cable.
To configure HA options
1. Go to System > High Availability > Configuration.
Figure 18: Active-passive HA (primary unit)
2. Configure the following sections, as applicable:
• “Configuring the primary HA options” on page 64
• “Configuring the advanced options” on page 65
• “Configuring interface monitoring” on page 66
• “Configuring service-based failover” on page 69
3. Click Apply.
Configuring the primary HA options
Go to System > High Availability > Configuration and click the arrow to expand the HA
Configuration section, if needed.
Fortinet Technologies Inc.
Page 64
FortiVoice Phone System 5.3.0 Administration Guide
Table 9: HA main options
GUI item
Description
Mode of
operation
Enables or disables HA, and selects the initial configured role this FortiVoice
unit in the HA group.
• off: The FortiVoice unit is not operating in HA mode.
• master: The FortiVoice unit is the primary unit in an active-passive HA
group.
• slave: The FortiVoice unit is the secondary unit in an active-passive HA
group.
On failure
Select one of the following behaviors of the primary unit when it detects a
failure, such as on a power failure or from service/interface monitoring.
• switch off: Do not process phone calls or join the HA group until you
manually select the effective operating mode (see “click HERE to start a
configuration/data sync” on page 62 and “click HERE to restore configured
operating mode” on page 62).
• wait for recovery then restore original role: On recovery, the failed primary
unit‘s effective HA mode of operation resumes its configured master role.
This also means that the secondary unit needs to give back the master role
to the primary unit. This behavior may be useful if the cause of failure is
temporary and rare, but may cause problems if the cause of failure is
permanent or persistent.
• wait for recovery then restore slave role: On recovery, the failed primary
unit’s effective HA mode of operation becomes slave, and the secondary
unit continues to assume the master role. The primary unit then
synchronizes with the current master unit. The new master unit can then
deliver phone calls. For information on manually restoring the FortiVoice
unit to acting in its configured HA mode of operation, see “click HERE to
restore configured operating mode” on page 62.
In most cases, you should select the wait for recovery then restore slave role
option.
For details on the effects of this option on the Effective Operating Mode, see
Table . For information on configuring service/interface monitoring, see
“Configuring service-based failover” on page 69.
This option appears only if “Mode of operation” is master.
Shared
password
Enter an HA password for the HA group. You must configure the same Shared
password value on both the primary and secondary units.
Configuring the advanced options
Go to System > High Availability > Configuration to configure the advanced options.
Fortinet Technologies Inc.
Page 65
FortiVoice Phone System 5.3.0 Administration Guide
Table 10:HA advanced options
GUI item
Description
HA base port Keep the default TCP port number (20000) that will be used for:
• the heartbeat signal
• synchronization control
• data synchronization
• configuration synchronization
Note: In addition to configuring the heartbeat, you can configure service
monitoring. For details, see “Configuring service-based failover” on page 69.
Note: In addition to automatic immediate and periodic configuration
synchronization, you can also manually initiate synchronization. For details,
see “click HERE to start a configuration/data sync” on page 62.
Heartbeat lost Enter the total span of time, in seconds, for which the primary unit can be
threshold
unresponsive before it triggers a failover and the secondary unit assumes the
role of the primary unit.
The heartbeat will continue to check for availability once per second. To
prevent premature failover when the primary unit is simply experiencing very
heavy load, configure a total threshold of three (3) seconds or more to allow
the secondary unit enough time to confirm unresponsiveness by sending
additional heartbeat signals.
Note: If the failure detection time is too short, the secondary unit may falsely
detect a failure when during periods of high load.
Caution: If the failure detection time is too long the primary unit could fail and
a delay in detecting the failure could mean that call is delayed or lost.
Decrease the failure detection time if email is delayed or lost because of an HA
failover.
Remote
services as
heartbeat
Enable to use remote service monitoring as a secondary HA heartbeat. If
enabled and both the primary and secondary heartbeat links fail or become
disconnected, if remote service monitoring still detects that the primary unit is
available, a failover will not occur.
Note: The remote service check is only applicable for temporary heartbeat link
fails. If the HA process restarts due to system reboot or HA daemon reboot,
physical heartbeat connections will be checked first. If the physical
connections are not found, the remote service monitoring does not take effect
anymore.
Note: Using remote services as heartbeat provides HA heartbeat only, not
synchronization. To avoid synchronization problems, you should not use
remote service monitoring as a heartbeat for extended periods. This feature is
intended only as a temporary heartbeat solution that operates until you
reestablish a normal primary or secondary heartbeat link.
Configuring interface monitoring
Interface monitor checks the local interfaces on the primary unit. If a malfunctioning interface is
detected, a failover will be triggered.
Fortinet Technologies Inc.
Page 66
FortiVoice Phone System 5.3.0 Administration Guide
To configure interface monitoring
1. Go to System > High Availability > Configuration.
2. Select master or slave as the mode of operation.
3. Expand the Interface area, if required.
4. Click on the port/interface name to configure the interface. For details, see “Configuring the
network interfaces” on page 43.
The interface IP address must be different from, but on the same subnet as, the IP address of
the other heartbeat network interface of the other member in the HA group.
When configuring the other FortiVoice unit in the HA group, use this value as the remote peer IP.
5. Select a row in the table and click Edit to configure the following HA settings on the
interface.
Fortinet Technologies Inc.
GUI item
Description
Port
Displays the interface name you’re configuring.
Enable port
monitor
Enable to monitor a network interface for failure. If the port fails, the primary
unit will trigger a failover.
Page 67
FortiVoice Phone System 5.3.0 Administration Guide
GUI item
Description
Heartbeat
status
Specify if this interface will be used for HA heartbeat and synchronization.
• Disable
Do not use this interface for HA heartbeat and synchronization.
• Primary
Select the primary network interface for heartbeat and synchronization
traffic. For more information, see “About the heartbeat and
synchronization” on page 57.
This network interface must be connected directly or through a switch to
the Primary heartbeat network interface of the other member in the HA
group.
• Secondary
Select the secondary network interface for heartbeat and
synchronization traffic. For more information, see “About the heartbeat
and synchronization” on page 57.
The secondary heartbeat interface is the backup heartbeat link between
the units in the HA group. If the primary heartbeat link is functioning, the
secondary heartbeat link is used for the HA heartbeat. If the primary
heartbeat link fails, the secondary link is used for the HA heartbeat and
for HA synchronization.
This network interface must be connected directly or through a switch to
the Secondary heartbeat network interfaces of the other member in the
HA group.
Caution: Using the same network interface for both HA
synchronization/heartbeat traffic and other network traffic could result in
issues with heartbeat and synchronization during times of high traffic load,
and is not recommended.
Note: In general, you should isolate the network interfaces that are used for
heartbeat traffic from your overall network. Heartbeat and synchronization
packets contain sensitive configuration information, are latency-sensitive,
and can consume considerable network bandwidth.
Peer IP
address
Enter the IP address of the matching heartbeat network interface of the
other member of the HA group.
For example, if you are configuring the primary unit’s primary heartbeat
network interface, enter the IP address of the secondary unit’s primary
heartbeat network interface.
Similarly, for the secondary heartbeat network interface, enter the IP
address of the other unit’s secondary heartbeat network interface.
For information about configuration synchronization and what is not
synchronized, see “About the heartbeat and synchronization” on page 57.
Fortinet Technologies Inc.
Page 68
FortiVoice Phone System 5.3.0 Administration Guide
GUI item
Description
Virtual IP
action
Select whether and how to configure the IP addresses and netmasks of the
FortiVoice unit whose effective HA mode of operation is currently master.
For example, a primary unit might be configured to receive phone call traffic
through port1 and receive heartbeat and synchronization traffic through
port3 and port4. In that case, you would configure the primary unit to set
the IP addresses or add virtual IP addresses for port1 of the secondary unit
on failover in order to mimic that of the primary unit.
• Ignore: Do not change the network interface configuration on failover,
and do not monitor. For details on service monitoring for network
interfaces, see “Configuring the network interfaces” on page 43.
• Use: Add the specified virtual IP address and netmask to the network
interface on failover. Normally, you will configure your network so that
clients use the virtual IP address. This option results in the network
interface having two IP Addresses: the actual and the virtual.
Virtual IP
address
Enter the virtual IPv4 address for this interface.
Configuring service-based failover
Go to System > High Availability > Configuration to configure remote service monitoring, local
network interface monitoring, and local hard drive monitoring.
HA service monitoring settings are not synchronized and must be configured separately on
each primary and secondary unit.
With remote service monitoring, the secondary unit confirms that it can connect to the primary
unit over the network using SIP and HTTP connections.
With local network interface monitoring and local hard drive monitoring, the primary unit
monitors its own network interfaces and hard drives.
If service monitoring detects a failure, the effective HA operating mode of the primary unit
switches to off or failed (depending on the On failure setting).A failover then occurs, and the
effective HA operating mode of the secondary unit switches to master. For information on the
On failure option, see “Configuring the HA mode and group” on page 63. For information on the
effective HA operating mode, see “Monitoring the HA status” on page 60.
To configure service monitoring
1. Go to System > High Availability > Configuration.
2. Select master or slave as the mode of operation.
3. Expand the service monitor area, if required.
4. Select a row in the table and click Edit to configure it.
5. For Remote HTTP, configure the following:
Fortinet Technologies Inc.
GUI item
Description
Enable
Select to enable connection responsiveness tests for SMTP.
Name
Displays the service name.
Remote IP
Enter the peer IP address.
Port
Enter the port number of the peer SMTP service.
Page 69
FortiVoice Phone System 5.3.0 Administration Guide
GUI item
Description
Timeout
Enter the timeout period for one connection test.
Interval
Enter the frequency of the tests.
Retries
Enter the number of consecutively failed tests that are allowed before the
primary unit is deemed unresponsive and a failover occurs.
6. For SIP UDP, configure the following:
GUI item
Description
Enable
Select to enable SIP UDP service.
Name
Displays the service name.
Remote IP
Enter the peer IP address.
Port
Enter the port number of the peer SIP UDP service.
Timeout
Enter the timeout period for one connection test.
Interval
Enter the frequency of the tests.
Retries
Enter the number of consecutively failed tests that are allowed before the
primary unit is deemed unresponsive and a failover occurs.
7. For Interface monitor and Local hard drives, configure the following:
GUI item
Description
Enable
Select to enable local hard drive monitoring. Interface monitoring is enabled
when you configure interface monitoring. See “Configuring interface
monitoring” on page 66.
Network interface monitoring tests all active network interfaces whose:
• “Virtual IP action” setting is not Ignore
• “Configuring interface monitoring” setting is enabled
For details, see “Configuring interface monitoring” on page 66 and “Virtual
IP action” on page 69.
Interval
Enter the frequency of the test.
Retries
Specify the number of consecutively failed tests that are allowed before the
local interface or hard drive is deemed unresponsive and a failover occurs.
Example: Failover scenarios
This section describes basic FortiVoice active-passive HA failover scenarios. For each scenario,
refer to the HA group shown in Figure 19. To simplify the descriptions of these scenarios, the
following abbreviations are used:
• P1 is the configured primary unit.
• S2 is the configured secondary unit.
Fortinet Technologies Inc.
Page 70
FortiVoice Phone System 5.3.0 Administration Guide
Figure 19:Example active-passive HA group
Active-passive HA group
port1
172.16.5.10
(HA virtual IP: 172.16.5.2)
FortiVoice
Switch
Primary unit (P1)
port 2, 3 or 4
Heartbeat link
Secondary unit (S2)
FortiVoice
port1
172.16.5.11
This section contains the following HA failover scenarios:
• Failover scenario 1: Temporary failure of the primary unit
• Failover scenario 2: System reboot or reload of the primary unit
• Failover scenario 3: System reboot or reload of the secondary unit
• Failover scenario 4: System shutdown of the secondary unit
• Failover scenario 5: Primary heartbeat link fails
• Failover scenario 6: Network connection between primary and secondary units fails (remote
service monitoring detects a failure)
Failover scenario 1: Temporary failure of the primary unit
In this scenario, the primary unit (P1) fails because of a software failure or a recoverable
hardware failure (in this example, the P1 power cable is unplugged). HA logging and alert email
are configured for the HA group.
When the secondary unit (S2) detects that P1 has failed, S2 becomes the new primary unit and
continues processing phone calls.
There is no data loss when failover happens although active calls are disconnected and line
appearance and extension appearance take time to restore. Call data consists of the FortiVoice
call detailed records, recorded calls, voicemail, call directories, fax, and voice prompts. The
user web portal is not affected.
Here is what happens during this process:
1. The FortiVoice HA group is operating normally.
2. The power is accidentally disconnected from P1.
3. S2’s heartbeat test detects that P1 has failed.
How soon this happens depends on the HA daemon configuration of S2.
4. The effective HA operating mode of S2 changes to master.
5. S2 sends an alert email similar to the following, indicating that S2 has determined that P1
has failed and that S2 is switching its effective HA operating mode to master.
This is the HA machine at 172.16.5.11.
The following event has occurred
‘MASTER heartbeat disappeared’
The state changed from ‘SLAVE’ to ‘MASTER’
Fortinet Technologies Inc.
Page 71
FortiVoice Phone System 5.3.0 Administration Guide
6. S2 records event log messages (among others) indicating that S2 has determined that P1
has failed and that S2 is switching its effective HA operating mode to master.
Recovering from temporary failure of the primary unit
After P1 recovers from the hardware failure, what happens next to the HA group depends on
P1’s HA On failure settings under System > High Availability > Configuration.
Figure 20: HA On Failure settings
• switch off
P1 will not process calls or join the HA group until you manually select the effective HA
operating mode (see “click HERE to restore configured operating mode” on page 62).
• wait for recovery then restore original role
On recovery, P1’s effective HA operating mode resumes its configured master role. This also
means that S2 needs to give back the master role to P1. This behavior may be useful if the
cause of failure is temporary and rare, but may cause problems if the cause of failure is
permanent or persistent.
In the case, the S2 will send out another alert email similar to the following:
This is the HA machine at 172.16.5.11.
The following event has occurred
‘SLAVE asks us to switch roles (recovery after a restart)
The state changed from ‘MASTER’ to ‘SLAVE’
After recovery, P1 also sends out an alert email similar to the following:
This is the HA machine at 172.16.5.10.
The following critical event was detected
The system was shutdown!
• wait for recovery then restore slave role
On recovery, P1’s effective HA operating mode becomes slave, and S2 continues to assume
the master role. P1 then synchronizes with the current master unit, S2. For information on
manually restoring the FortiVoice unit to acting in its configured HA mode of operation, see
“click HERE to restore configured operating mode” on page 62.
Failover scenario 2: System reboot or reload of the primary unit
If you need to reboot or reload (not shut down) P1 for any reason, such as a firmware upgrade
or a process restart, by using the CLI commands execute reboot or execute reload, or
by clicking the Restart button under Status > Dashboard > System Command on the GUI:
• P1 will send a holdoff command to S2 so that S2 will not take over the master role during
P1’s reboot.
• P1 will also send out an alert email similar to the following:
This is the HA machine at 172.16.5.10.
Fortinet Technologies Inc.
Page 72
FortiVoice Phone System 5.3.0 Administration Guide
The following critical event was detected
The system is rebooting (or reloading)!
• S2 will hold off checking the services and heartbeat with P1. Note that S2 will only hold off
for about 5 minutes. In case P1 never boots up, S2 will take over the master role.
• S2 will send out an alert email, indicating that S2 received the holdoff command from P1.
This is the HA machine at 172.16.5.11.
The following event has occurred
‘peer rebooting (or reloading)’
The state changed from ‘SLAVE’ to ‘HOLD_OFF’
After P1 is up again:
• P1 will send another command to S2 and ask S2 to change its state from holdoff to slave
and resume monitoring P1’s services and heartbeat.
• S2 will send out an alert email, indicating that S2 received instruction commands from P1.
This is the HA machine at 172.16.5.11.
The following event has occurred
‘peer command appeared’
The state changed from ‘HOLD_OFF’ to ‘SLAVE’
• S2 logs the event in the HA logs.
Failover scenario 3: System reboot or reload of the secondary unit
If you need to reboot or reload (not shut down) S2 for any reason, such as a firmware upgrade
or a process restart, by using the CLI commands execute reboot or execute reload, or
by clicking the Restart button under Monitor > System Status > Status on the GUI, the behavior
of P1 and S2 is as follows:
• P1 will send out an alert email similar to the following, informing the administrator of the
heartbeat loss with S2.
This is the HA machine at 172.16.5.10.
The following event has occurred
‘ha: SLAVE heartbeat disappeared’
• S2 will send out an alert email similar to the following:
This is the HA machine at 172.16.5.11.
The following critical event was detected
The system is rebooting (or reloading)!
• P1 will also log this event in the HA logs.
Failover scenario 4: System shutdown of the secondary unit
If you shut down S2:
• No alert email is sent out from either P1 or S2.
• P1 will log this event in the HA logs.
Failover scenario 5: Primary heartbeat link fails
If the primary heartbeat link fails, such as when the cable becomes accidentally disconnected,
and if you have not configured a secondary heartbeat link, the FortiVoice units in the HA group
cannot verify that other units are operating and assume that the other has failed. As a result, the
Fortinet Technologies Inc.
Page 73
FortiVoice Phone System 5.3.0 Administration Guide
secondary unit (S2) changes to operating as a primary unit, and both FortiVoice units are acting
as primary units.
Two primary units connected to the same network may cause address conflicts on your
network. Additionally, because the heartbeat link is interrupted, the FortiVoice units in the HA
group cannot synchronize configuration changes or voice data changes.
Even after reconnecting the heartbeat link, both units will continue operating as primary units.
To return the HA group to normal operation, you must connect to the web-based manager of S2
to restore its effective HA operating mode to slave (secondary unit).
1. The FortiVoice HA group is operating normally.
2. The heartbeat link Ethernet cable is accidently disconnected.
3. S2’s HA heartbeat test detects that the primary unit has failed.
How soon this happens depends on the HA daemon configuration of S2.
4. The effective HA operating mode of S2 changes to master.
5. S2 sends an alert email similar to the following, indicating that S2 has determined that P1
has failed and that S2 is switching its effective HA operating mode to master.
This is the HA machine at 172.16.5.11.
The following event has occurred
‘MASTER heartbeat disappeared’
The state changed from ‘SLAVE’ to ‘MASTER’
6. S2 records event log messages (among others) indicating that S2 has determined that P1
has failed and that S2 is switching its effective HA operating mode to master.
Recovering from a heartbeat link failure
Because the hardware failure is not permanent (that is, the failure of the heartbeat link was
caused by a disconnected cable, not a failed port on one of the FortiVoice units), you may want
to return both FortiVoice units to operating in their configured modes when rejoining the failed
primary unit to the HA group.
To return to normal operation after the heartbeat link fails
1. Reconnect the primary heartbeat interface by reconnecting the heartbeat link Ethernet
cable.
Even though the effective HA operating mode of S2 is master, S2 continues to attempt to
find the other primary unit. When the heartbeat link is reconnected, S2 finds P1 and
determines that P1 is also operating as a primary unit. So S2 sends a heartbeat signal to
notify P1 to stop operating as a primary unit. The effective HA operating mode of P1
changes to off.
2. P1 sends an alert email similar to the following, indicating that P1 has stopped operating as
the primary unit.
This is the HA machine at 172.16.5.10
The following event has occurred
'SLAVE asks us to switch roles (user requested takeover)'
The state changed from 'MASTER' to 'OFF'
3. P1 records event log messages (among others) indicating that P1 is switching to off mode.
The configured HA mode of operation of P1 is master and the effective HA operating mode
of P1 is off.
The configured HA mode of operation of S2 is slave and the effective HA operating mode of
S2 is master.
4. Connect to the web-based manager of P1, go to System > High Availability > Status.
Fortinet Technologies Inc.
Page 74
FortiVoice Phone System 5.3.0 Administration Guide
5. Check for synchronization messages.
Do not proceed to the next step until P1 has synchronized with S2.
6. Connect to the web-based manager of S2, go to System > High Availability > Status and
select click HERE to restore configured operating mode.
The HA group should return to normal operation. P1 records the event log message (among
others) indicating that S2 asked P1 to return to operating as the primary unit.
P1 and S2 synchronize again. P1 processes phone calls normally.
Failover scenario 6: Network connection between primary and secondary units
fails (remote service monitoring detects a failure)
Depending on your network configuration, the network connection between the primary and
secondary units can fail for a number of reasons. In the network configuration shown in
Figure 19 on page 71, the connection between port1 of primary unit (P1) and port1 of the
secondary unit (S2) can fail if a network cable is disconnected or if the switch between P1 and
S2 fails.
A more complex network configuration could include a number of network devices between the
primary and secondary unit’s non-heartbeat network interfaces. In any configuration, remote
service monitoring can only detect a communication failure. Remote service monitoring cannot
determine where the failure occurred or the reason for the failure.
In this scenario, remote service monitoring has been configured to make sure that S2 can
connect to P1. The On failure setting located in the HA main configuration section is wait for
recovery then restore slave role. For information on the On failure setting, see “On failure” on
page 65. For information about remote service monitoring, see “Configuring service-based
failover” on page 69.
The failure occurs when power to the switch that connects the P1 and S2 port1 interfaces is
disconnected. Remote service monitoring detects the failure of the network connection
between the primary and secondary units. Because of the On failure setting, P1 changes its
effective HA operating mode to failed.
When the failure is corrected, P1 detects the correction because while operating in failed mode
P1 has been attempting to connect to S2 using the port1 interface. When P1 can connect to S2,
the effective HA operating mode of P1 changes to slave and the voice data on P1 will be
synchronized to S2. S2 can now deliver the calls. The HA group continues to operate in this
manner until an administrator resets the effective HA modes of operation of the FortiVoice units.
1. The FortiVoice HA group is operating normally.
2. The power cable for the switch between P1 and S2 is accidently disconnected.
3. S2’s remote service monitoring cannot connect to the primary unit.
How soon this happens depends on the remote service monitoring configuration of S2.
4. Through the HA heartbeat link, S2 signals P1 to stop operating as the primary unit.
5. The effective HA operating mode of P1 changes to failed.
6. The effective HA operating mode of S2 changes to master.
7. S2 sends an alert email similar to the following, indicating that S2 has determined that P1
has failed and that S2 is switching its effective HA operating mode to master.
This is the HA machine at 172.16.5.11.
The following event has occurred
‘MASTER remote service disappeared’
The state changed from ‘SLAVE’ to ‘MASTER’
8. S2 logs the event (among others) indicating that S2 has determined that P1 has failed and
that S2 is switching its effective HA operating mode to master.
Fortinet Technologies Inc.
Page 75
FortiVoice Phone System 5.3.0 Administration Guide
9. P1 sends an alert email similar to the following, indicating that P1 has stopped operating in
HA mode.
This is the HA machine at 172.16.5.10.
The following event has occurred
'SLAVE asks us to switch roles (user requested takeover)'
The state changed from 'MASTER' to 'FAILED'
10.P1 records the log messages (among others) indicating that P1 is switching to Failed mode.
Recovering from a network connection failure
Because the network connection failure was not caused by failure of either FortiVoice unit, you
may want to return both FortiVoice units to operating in their configured modes when rejoining
the failed primary unit to the HA group.
To return to normal operation after the heartbeat link fails
1. Reconnect power to the switch.
Because the effective HA operating mode of P1 is failed, P1 is using remote service
monitoring to attempt to connect to S2 through the switch.
2. When the switch resumes operating, P1 successfully connects to S2.
P1 has determined the S2 can connect to the network and process calls.
3. The effective HA operating mode of P1 switches to slave.
4. P1 logs the event.
5. P1 sends an alert email similar to the following, indicating that P1 is switching its effective
HA operating mode to slave.
This is the HA machine at 172.16.5.10.
The following event has occurred
'SLAVE asks us to switch roles (user requested takeover)'
The state changed from 'FAILED' to 'SLAVE'
6. Connect to the web-based manager of P1 and go to System > High Availability > Status.
7. Check for synchronization messages.
Do not proceed to the next step until P1 has synchronized with S2.
8. Connect to the web-based manager of S2, go to System > High Availability > Status and
select click HERE to restore configured operating mode.
9. Connect to the web-based manager of P1, go to System > High Availability > Status and
select click HERE to restore configured operating mode.
P1 should return to operating as the primary unit and S2 should return to operating as the
secondary unit.
P1 and S2 synchronize again. P1 can now process phone calls normally.
Configuring system time, system options, SNMP, email setting, GUI
appearance, and call data storage
The System > Configuration submenu lets you configure the system time, system options,
SNMP, email setting, GUI appearance, and call data storage.
Fortinet Technologies Inc.
Page 76
FortiVoice Phone System 5.3.0 Administration Guide
This topic includes:
• Configuring the time and date
• Configuring system options
• Configuring SNMP queries and traps
• Configuring email settings
• Customizing the GUI appearance
• Selecting the call data storage location
Configuring the time and date
The System > Configuration > Time tab lets you configure the system time and date of the
FortiVoice unit.
You can either manually set the FortiVoice system time or configure the FortiVoice unit to
automatically keep its system time correct by synchronizing with Network Time Protocol (NTP)
servers.
For many features to work, including scheduling, logging, and certificate-dependent features,
the FortiVoice system time must be accurate.
FortiVoice units support daylight savings time (DST), including recent changes in the USA,
Canada and Western Australia.
To configure the system time
1. Go to System > Configuration > Time.
2. Configure the following:
GUI field
Description
System time
Displays the date and time according to the FortiVoice unit’s clock at
the time that this tab was loaded, or when you last selected the
Refresh button.
Time zone
Select the time zone in which the FortiVoice unit is located.
• Automatically adjust clock for daylight saving time changes:
Enable to adjust the FortiVoice system clock automatically when
your time zone changes to daylight savings time (DST) and back
to standard time.
When selecting time zone in CLI, use the command config
system time manual and enter the code before the time zone in
Table 11 on page 78.
Fortinet Technologies Inc.
Page 77
FortiVoice Phone System 5.3.0 Administration Guide
Synchronize with
NTP Server
Select to use a network time protocol (NTP) server to automatically
set the system date and time.
• Server: Enter the IP address or domain name of an NTP server.
You can add a maximum of 10 NTP servers. The FortiVoice unit
uses the first NTP server based on the selection mechanism of
the NTP protocol.
Click the + sign to add more servers.
Click the - sign to remove servers. Note that you cannot remove
the last server.
To find the NTP servers that you can use, see http://www.ntp.org.
Depending on your network traffic, it may take some time for the
FortiVoice unit to synchronize its time with the NTP server.
Set date
Select this option to manually set the date and time of the FortiVoice
unit’s clock, then select the Year, Month, Day, Hour, Minute, and
Second fields before you click Apply.
Alternatively, configure Synchronize with NTP server.
3. Click Apply.
Table 11:Time zone codes for CLI configuration
Code
Time Zone
0
(GMT-12:00) Eniwetok, Kwajalein
1
(GMT-11:00) Midway Island, Samoa
2
(GMT-10:00) Hawaii
3
(GMT-9:00) Alaska
4
(GMT-8:00) Pacific Time (US&amp; Canada)
5
(GMT-7:00) Arizona
6
(GMT-7:00) Mountain Time (US&amp; Canada)
7
(GMT-6:00) Central America
8
(GMT-6:00) Central Time
9
(GMT-6:00) Mexico City
10
(GMT-6:00) Saskatchewan
11
(GMT-5:00) Bogota, Lima, Quito
12
(GMT-5:00) Eastern Time (US &amp; Canada)
13
(GMT-5:00) Indiana (East)
14
(GMT-4:30) Venezuela Standard Time
15
(GMT-4:00) Atlantic Time (Canada)
Fortinet Technologies Inc.
Page 78
FortiVoice Phone System 5.3.0 Administration Guide
Table 11:Time zone codes for CLI configuration
Code
Time Zone
16
(GMT-4:00) Caracas, La Paz
17
(GMT-4:00) Santiago
18
(GMT-3:30) Newfoundland
19
(GMT-3:00) Brasilia
20
(GMT-3:00) Buenos Aires, Georgetown
21
(GMT-3:00) Greenland
22
(GMT-2:00) Mid-Atlantic
23
(GMT-1:00) Azores
24
(GMT-1:00) Cape Verde Is.
25
(GMT) Casablanca, Monrouia
26
(GMT) Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London
27
(GMT+1:00) Amsterdam, Berlia, Bern, Rome, Stockholm, Vienna
28
(GMT+1:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague
29
(GMT+1:00) Brussels, Copenhagen, Madrid, Paris
30
(GMT+1:00) Sarajevo, Skopje, Sofija, Vilnius, Warsaw, Zagreb
31
(GMT+1:00) West Central Africa
32
(GMT+2:00) Athens, Istanbul, Minsk
33
(GMT+2:00) Bucharest
34
(GMT+2:00) Cairo
35
(GMT+2:00) Harare, Pretoria
36
(GMT+2:00) Helsinki, Riga, Tallinn
37
(GMT+2:00) Jerusalem
38
(GMT+3:00) Baghdad
39
(GMT+3:00) Kuwait, Riyadh
40
(GMT+3:00) Moscow, St.Petersburg, Volgograd
41
(GMT+3:00) Nairobi
42
(GMT+3:30) Tehran
43
(GMT+4:00) Abu Dhabi, Muscat
44
(GMT+4:00) Baku, Tbilisi, Yerevan
Fortinet Technologies Inc.
Page 79
FortiVoice Phone System 5.3.0 Administration Guide
Table 11:Time zone codes for CLI configuration
Code
Time Zone
45
(GMT+4:30) Kabul
46
(GMT+5:00) Ekaterinburg
47
(GMT+5:00) Islamabad, Karachi, Tashkent
48
(GMT+5:30) Calcutta, Chennai, Mumbai, New Delhi
49
(GMT+5:45) Kathmandu
50
(GMT+6:00) Almaty, Novosibirsk
51
(GMT+6:00) Astana, Dhaka
52
(GMT+6:00) Sri Jayawardenepara
53
(GMT+6:30) Rangoon
54
(GMT+7:00)B angkok, Hanoi, Jakarta
55
(GMT+7:00) Krasnoyarsk
56
(GMT+8:00) Beijing, Chong Qing, Hong Kong, Urumgi
57
(GMT+8:00) Irkutsk, Ulaan Bataar
58
(GMT+8:00) Kuala Lumpur, Singapore
59
(GMT+8:00) Perth
60
(GMT+8:00) Taipei
61
(GMT+9:00) Osaka, Sapporo, Tokyo, Seoul
62
(GMT+9:00) Yakutsk
63
(GMT+9:30) Adelaide, Darwin
64
(GMT+10:00) Brisbane
65
(GMT+10:00) Canberra, Melbourne, Sydney
66
(GMT+10:00) Guam, Port Moresby, Hobart, Vladivostok
67
(GMT+11:00) Magadan, Solomon Is., New Caledonia
68
(GMT+12:00) Auckland, Wellington
69
(GMT+12:00) Fiji, Kamchatka, Marshall Is.
70
(GMT+13:00) Nuku'alofa
71
(GMT-3:00) Montevideo
72
(GMT+3:00) Minsk
Fortinet Technologies Inc.
Page 80
FortiVoice Phone System 5.3.0 Administration Guide
Configuring system options
The System > Configuration > Options tab lets you set the following global settings:
• system idle timeout
• password enforcement policy
• administration ports on the interfaces
To view and configure the system options
1. Go to System > Configuration > Options.
2. Configure the following:
Figure 21: Options tab
GUI field
Description
Idle timeout
Enter the amount of time that an administrator may be inactive
before the FortiVoice unit automatically logs out the administrator.
For better security, use a low idle timeout value.
Fortinet Technologies Inc.
Page 81
FortiVoice Phone System 5.3.0 Administration Guide
Password / PIN
Policy
Displays the SIP password and user PIN policy for administrators
and extension users. For information on setting SIP password and
user PIN, see “Configuring IP extensions” on page 136.
• Enable: Select to enable the password/PIN policy.
• Minimum password length: Set the minimum acceptable length
(8) for passwords.
• Password must contain: Select any of the following special
character types to require in a password. Each selected type
must occur at least once in the password.
• Uppercase letters — A, B, C, ... Z
• Lowercase letters — a, b, c, ... z
• Number — 0 ... 9
• Non alphanumeric character — punctuation marks, @,#, ... %
• Apply password policy to: Select where to apply the password
policy:
• Administrators — Apply to administrator passwords. If any
password does not conform to the policy, require that
administrator to change the password at the next login.
• SIP users — Apply to FortiVoice SIP phone users’ passwords.
If any password does not conform to the policy, require that
user to change the password at the next login.
• Minimum PIN length: Set the minimum acceptable length (6) for
the user PIN.
• PIN must contain:
• Number: Select to include a number (0-9) in the PIN.
• PIN special: Select to include * or # or both in the PIN.
• Apply PIN policy to: Select Voicemail users to apply the policy to
FortiVoice phone users’ user PIN. If any PIN does not conform to
the policy, require that user to change the PIN at the next login.
Administration
Ports
Specify the TCP ports for administrative access on all interfaces.
Default port numbers:
HTTP: 80
HTTPS: 443
SSH: 22
TELNET: 23
Web action host/IP
Enter the host name or IP address from where a email notification is
sent to you when a voice mail or fax is delivered to your extension.
This IP address is included in the email notification. You can open
the link to view or manage the voice mail or fax. If you leave this field
empty, port1 IP will be used instead.
The value entered here replaces the default Url host variable for
customizing messages. See “Customizing call report and notification
email templates” on page 109.
3. Click Apply.
Fortinet Technologies Inc.
Page 82
FortiVoice Phone System 5.3.0 Administration Guide
Configuring SNMP queries and traps
Go to System > Configuration > SNMP to configure SNMP to monitor FortiVoice system events
and thresholds, or a high availability (HA) configuration for failover messages.
To monitor FortiVoice system information and receive FortiVoice traps, you must compile
Fortinet proprietary MIBs as well as Fortinet-supported standard MIBs into your SNMP
manager. RFC support includes support for most of RFC 2665 (Ethernet-like MIB) and most of
RFC 1213 (MIB II). For more information, see “FortiVoice MIBs” on page 87.
The FortiVoice SNMP implementation is read-only. SNMP v1, v2c, and v3 compliant SNMP
managers have read-only access to FortiVoice system information and can receive FortiVoice
traps.
The FortiVoice SNMP v3 implementation includes support for queries, traps, authentication, and
privacy. Before you can use its SNMP queries, you must enable SNMP access on the network
interfaces that SNMP managers will use to access the FortiVoice unit. For more information, see
“Editing network interfaces” on page 44.
This topic includes:
• Configuring an SNMP threshold
• Configuring email settings
• Configuring an SNMP v3 user
Configuring an SNMP threshold
Configure under what circumstances an event is triggered.
To set SNMP thresholds
1. Go System > Configuration > SNMP.
2. Configure the following:
Fortinet Technologies Inc.
Page 83
FortiVoice Phone System 5.3.0 Administration Guide
GUI field
Description
SNMP agent
enable
Enable to activate the FortiVoice SNMP agent. This must be enabled
to accept queries from SNMP managers or send traps from the
FortiVoice unit.
Description
Enter a descriptive name for the FortiVoice unit.
Location
Enter the location of the FortiVoice unit.
Contact
Enter administrator contact information.
SNMP Threshold
To change a value in the four editable columns, select the value in any
row. It becomes editable. Change the value and click outside of the
field. A red triangle appears in the field’s corner and remains until you
click Apply.
Trap Type
Displays the type of trap, such as CPU Usage.
Trigger
You can enter either the percent of the resource in use or the number
of times the trigger level must be reached before it is triggered.
For example, using the default value, if the mailbox disk is 90% or
more full, it will trigger.
Threshold
Sets the number of triggers that will result in an SNMP trap.
For example, if the CPU level exceeds the set trigger percentage once
before returning to a lower level, and the threshold is set to more than
one, an SNMP trap will not be generated until that minimum number
of triggers occurs during the sample period.
Sample
Period(s)
Sets the time period in seconds during which the FortiVoice unit
SNMP agent counts the number of triggers that occurred.
This value should not be less than the Sample Freq(s) value.
Sample
Freq(s)
Sets the interval in seconds between measurements of the trap
condition. You will not receive traps faster than this rate, depending
on the selected sample period.
This value should be less than the Sample Period(s) value.
Community
Fortinet Technologies Inc.
Displays the list of SNMP communities (for SNMP v1 and v2c) added
to the FortiVoice configuration. For information on configuring a
community, see either “Configuring email settings” or “Configuring an
SNMP v3 user” on page 86.
Name
Displays the name of the SNMP community. The SNMP Manager
must be configured with this name.
Status
A green check mark icon indicates that the community is enabled.
Queries
A green check mark icon indicates that queries are enabled.
Traps
A green check mark icon indicates that traps are enabled.
Page 84
FortiVoice Phone System 5.3.0 Administration Guide
User
Displays the list of SNMP v3 users added to the FortiVoice
configuration. For information on configuring a v3 user, see
“Configuring an SNMP v3 user” on page 86.
Name
Displays the name of the SNMP v3 user. The SNMP Manager must be
configured with this name.
Status
A green check mark icon indicates that the user is enabled.
Queries
A green check mark icon indicates that queries are enabled.
Traps
A green check mark icon indicates that traps are enabled.
Security Level The security level of the SNMP v3 user.
Configuring an SNMP v1 and v2c community
An SNMP community is a grouping of equipment for SNMP-based network administration
purposes. You can add up to three SNMP communities so that SNMP managers can connect to
the FortiVoice unit to view system information and receive SNMP traps. You can configure each
community differently for SNMP traps and to monitor different events. You can add the IP
addresses of up to eight SNMP managers to each community.
To configure an SNMP community
1. Go to System > Configuration > SNMP.
2. Under Community, click New to add a community or select a community and click Edit.
The SNMP Community page appears.
3. Configure the following:
GUI field
Description
Name
Enter a name to identify the SNMP community. If you are editing an
existing community, you cannot change the name.
You can add up to 16 communities.
Enable
Enable to send traps to and allow queries from the community’s SNMP
managers.
Community
Hosts
Lists SNMP managers that can use the settings in this SNMP
community to monitor the FortiVoice unit. Click Create to create a new
entry.
You can add up to 16 hosts.
IP Address Enter the IP address of an SNMP manager. By default, the IP address is
0.0.0.0, so that any SNMP manager can use this SNMP community.
Fortinet Technologies Inc.
Delete
(button)
Click to remove this SNMP manager.
Create
(button)
Click to add a new default entry to the Hosts list that you can edit as
needed.
Page 85
FortiVoice Phone System 5.3.0 Administration Guide
Queries
Enter the Port number (161 by default) that the SNMP managers in this
community use for SNMP v1 and SNMP v2c queries to receive
configuration information from the FortiVoice unit. Mark the Enable
check box to activate queries for each SNMP version.
Traps
Enter the Local Port and Remote Port numbers (162 local, 162 remote by
default) that the FortiVoice unit uses to send SNMP v1 and SNMP v2c
traps to the SNMP managers in this community. Enable traps for each
SNMP version that the SNMP managers use.
SNMP Event
Enable each SNMP event for which the FortiVoice unit should send traps
to the SNMP managers in this community.
Note: Since FortiVoice checks its status in a scheduled interval, not all
the events will trigger traps. For example, FortiVoice checks its hardware
status every 60 seconds. This means that if the power is off for a few
seconds but is back on before the next status check, no system event
trap will be sent.
4. Click Create.
Configuring an SNMP v3 user
SNMP v3 adds more security by using authentication and privacy encryption. You can specify
an SNMP v3 user on FortiVoice so that SNMP managers can connect to the FortiVoice unit to
view system information and receive SNMP traps.
To configure an SNMP v3 user
1. Go to System > Configuration > SNMP.
2. Under User, click New to add a user or select a user and click Edit.
The SNMPv3 User page appears.
You can add up to 16 users.
3. Configure the following:
GUI field
Description
User name
Enter a name to identify the SNMP user. If you are editing an existing
user, you cannot change the name.
Enable
Enable to send traps to and allow queries from the user’s SNMP
managers.
Security level
Choose one of the three security levels:
• No authentication, no privacy: This option is similar to SNMP v1 and
v2.
• Authentication, no privacy: This option enables authentication only.
The SNMP manager needs to supply a password that matches the
password you specify on FortiVoice. You must also specify the
authentication protocol (either SHA1 or MD5).
• Authentication, privacy: This option enables both authentication
and encryption. You must specify the protocols and passwords.
Both the protocols and passwords on the SNMP manager and
FortiVoice must match.
Fortinet Technologies Inc.
Page 86
FortiVoice Phone System 5.3.0 Administration Guide
Authentication For Security level, if you select either Authentication option, you must
Protocol
specify the authentication protocol and password. Both the
authentication protocol and password on the SNMP manager and
FortiVoice must match.
Privacy
protocol
For Security level, if you select Privacy, you must specify the
encryption protocol and password. Both the encryption protocol and
password on the SNMP manager and FortiVoice must match.
Notification Hosts Lists the SNMP managers that FortiVoice will send traps to. Click
Create to create a new entry. You can add up to 16 host.
IP Address
Enter the IP address of an SNMP manager. By default, the IP address
is 0.0.0.0, so that any SNMP manager can use this SNMP user.
Delete
Click to remove this SNMP manager.
(button)
Create
(button)
Click to add a new default entry to the Hosts list that you can edit as
needed.
Queries
Enter the Port number (161 by default) that the SNMP managers use
for SNMP v3 queries to receive configuration information from the
FortiVoice unit. Select the Enable check box to activate queries.
Traps
Enter the Local Port and Remote Port numbers (162 local, 162 remote
by default) that the FortiVoice unit uses to send SNMP v3 traps to the
SNMP managers. Select the Enable check box to activate traps.
SNMP Event
Enable each SNMP event for which the FortiVoice unit should send
traps to the SNMP managers.
Note: Since FortiVoice checks its status in a scheduled interval, not all
the events will trigger traps. For example, FortiVoice checks its
hardware status every 60 seconds. This means that if the power is off
for a few seconds but is back on before the next status check, no
system event trap will be sent.
4. Click Create.
FortiVoice MIBs
The FortiVoice SNMP agent supports Fortinet proprietary MIBs as well as standard RFC 1213
and RFC 2665 MIBs. RFC support includes support for the parts of RFC 2665 (Ethernet-like
MIB) and the parts of RFC 1213 (MIB II) that apply to FortiVoice unit configuration.
The FortiVoice MIBs are listed in Table 12. You can obtain these MIB files from Fortinet technical
support. To communicate with the SNMP agent, you must compile these MIBs into your SNMP
manager.
Your SNMP manager may already include standard and private MIBs in a compiled database
that is ready to use. You must add the Fortinet proprietary MIB to this database. If the standard
MIBs used by the Fortinet SNMP agent are already compiled into your SNMP manager you do
not have to compile them again.
Fortinet Technologies Inc.
Page 87
FortiVoice Phone System 5.3.0 Administration Guide
Table 12:FortiVoice MIBs
MIB file name
Description
FortiVoice.mib
Displays the proprietary Fortinet MIB includes detailed FortiVoice
system configuration information. Your SNMP manager requires this
information to monitor FortiVoice configuration settings. For more
information, see “MIB fields” on page 88.
FortiVoice traps
The FortiVoice unit’s SNMP agent can send traps to SNMP managers that you have added to
SNMP communities. To receive traps, you must load and compile the FortiVoice trap MIB into
the SNMP manager.
All traps sent include the trap message as well as the FortiVoice unit serial number and host
name.
MIB fields
Trap
Description
fvTrapStorageDiskHighThreshold
Trap sent if log disk usage and mailbox disk usage
become too high.
fvTrapSystemEvent
Trap sent when system shuts down, reboots,
upgrades, etc.
fmlTrapHAEvent
Trap sent when an HA event occurs.
The Fortinet MIB contains fields reporting current FortiVoice unit status information. The tables
below list the names of the MIB fields and describe the status information available for each.
You can view more details about the information available from all Fortinet MIB fields by
compiling the MIB file into your SNMP manager and browsing the MIB fields.
Fortinet Technologies Inc.
Page 88
FortiVoice Phone System 5.3.0 Administration Guide
Table 13:System session MIB fields
MIB field
Description
fvSysModel
FortiVoice model number, such as 400 for the FortiVoice-400.
fvSysSerial
FortiVoice unit serial number.
fvSysVersion
The firmware version currently running on the FortiVoice unit.
fvSysCpuUsage
The current CPU usage (%).
fvSysMemUsage
The current memory utilization (%).
fvSysLogDiskUsage
The log disk usage (%).
fvSysStorageDiskUsa The storage disk usage (%).
ge
fvSysEventCode
System component events.
fvSysload
Current system load.
fvSysHA
• fvHAMode: Configured HA operating mode.
• fvHAEffectiveMoce: Effective HA operating mode.
fmlHAEventId
HA event type ID.
fmlHAUnitIp
Unit IP address where the event occurs.
fmlHAEventReason
The reason for the HA event.
Configuring email settings
You can configure the FortiVoice unit to send email notifications to phone users when they miss
a phone call or receive a voicemail or fax.
For phone users to receive the notifications, you need to add their email addresses when
configuring the extensions. See “Configuring Extensions” on page 136.
To configure email settings
1. Go to System > Configuration > Mail Settings.
2. Configure the following:
Fortinet Technologies Inc.
Page 89
FortiVoice Phone System 5.3.0 Administration Guide
Figure 22: Mail server settings
GUI field
Description
Local Host
Host name
Enter the host name of the FortiVoice unit, such as
fortivoice-200D.
Local domain name Enter the local domain name of the FortiVoice unit, such as
example.com.
Mail Queue
Maximum time for
email in queue
(1-240 hours)
Enter the maximum number of hours that deferred email
messages can remain in the deferred email queue, during
which the FortiVoice unit periodically retries to send the
message. After it reaches the maximum time, the FortiVoice
unit sends a final delivery status notification (DSN) email
message to notify the sender that the email message was
undeliverable.
Time interval for
retry (10-120
minutes)
Enter the number of minutes between delivery retries for email
messages in the deferred mail queues.
Relay Server
Fortinet Technologies Inc.
Configure an SMTP relay, if needed, to which the FortiVoice
unit will relay outgoing email. This is typically provided by your
Internet service provider (ISP), but could be a mail relay on
your internal network.
Relay server name
Enter the domain name of an SMTP relay.
Relay server port
Enter the TCP port number on which the SMTP relay listens.
This is typically provided by your Internet service provider
(ISP).
Page 90
FortiVoice Phone System 5.3.0 Administration Guide
Use SMTPs
Enable to initiate SSL- and TLS-secured connections to the
SMTP relay if it supports SSL/TLS. When disabled, SMTP
connections from the FortiVoice unit’s built-in MTA or proxy to
the relay will occur as clear text, unencrypted.
This option must be enabled to initiate SMTPS connections.
Authentication
Required:
Select the checkbox and click the arrow to expand the section
and configure:
• User name: Enter the name of the FortiVoice unit’s account
on the SMTP relay.
• Password: Enter the password for the FortiVoice unit’s user
name.
• Authentication type: Available SMTP authentication types
include:
• AUTO (automatically detect and use the most secure
SMTP authentication type supported by the relay server)
• PLAIN (provides an unencrypted, scrambled password)
• LOGIN (provides an unencrypted, scrambled password)
• DIGEST-MD5 (provides an encrypted hash of the
password)
• CRAM-MD5 (provides an encrypted hash of the
password, with hash replay prevention, combined with a
challenge and response mechanism)
Customize email template View and reword the default email history report and
notification email templates. For more information, see
“Customizing call report and notification email templates” on
page 109.
3. Click Apply.
Customizing the GUI appearance
The System > Configuration > Appearance tab lets you customize the default appearance of the
web-based manager and voicemail interface with your own product name, product logo,
corporate logo, and language.
To customize the GUI appearance
1. Go to System > Configuration > Appearance.
2. Click the arrow to expand Administration interface and Voicemail interface.
3. Configure the following to change appearance:
Fortinet Technologies Inc.
Page 91
FortiVoice Phone System 5.3.0 Administration Guide
Figure 23: Appearance tab
GUI field
Description
Administration interface
Product name
Enter the name of the product. This name will precede
Administrator Login in the title on the login page of the
web-based manager.
Product icon
Click Change to browse for the product icon. The icon should
be in .ico format, and 16 pixels wide x16 pixels tall in size.
Top logo
Click Change to upload a graphic that will appear at the top of
all pages in the web-based manager. The image’s dimensions
must be 460 pixels wide by 36 pixels tall.
For best results, use an image with a transparent background.
Non-transparent backgrounds will not blend with the underlying
theme graphic, resulting in a visible rectangle around your logo
graphic.
Note: Uploading a graphic overwrites the current graphic. The
FortiVoice unit does not retain previous or default graphics. If
you want to revert to the current graphic, use your web browser
to save a backup copy of the image to your management
computer, enabling you to upload it again at a later time.
Click Reset to return to the default setting.
Default UI language Select the default language for the display of the web-based
manager.
You can configure a separate language preference for each
administrator account. For details, see “Configuring
administrator accounts” on page 53.
Voicemail interface
Fortinet Technologies Inc.
Page 92
FortiVoice Phone System 5.3.0 Administration Guide
Voicemail login
Enter a word or phrase that will appear on top of the voicemail
login page, such as Voicemail Login.
Login user name
hint
Enter a hint for the user name, such as Your Email Address. This
hint will appear as a mouse-over display on the login name
field.
Voicemail theme
Select a theme for the voicemail GUI.
Voicemail UI
language
Select the language in which voicemail pages will be displayed.
By default, the FortiVoice unit will use the same language as the
web-based manager
Voicemail top logo
Click Change to upload a graphic that will appear at the top of
all webmail pages. The image’s dimensions must be 460 pixels
wide by 36 pixels tall.
For best results, use an image with a transparent background.
Non-transparent backgrounds will not blend with the underlying
theme graphic, resulting in a visible rectangle around your logo
graphic.
Note: Uploading a graphic overwrites the current graphic. The
FortiVoice unit does not retain previous or default graphics. If
you want to revert to the current graphic, use your web browser
to save a backup copy of the image to your management
computer, enabling you to upload it again at a later time.
Click Reset to return to the default setting.
4. Click Apply to save changes or Reset to return to the default settings.
Selecting the call data storage location
The System > Configuration > Storage tab lets you configure local or remote storage of call data
such as the recorded calls, faxes, and voice mails.
FortiVoice units can store call data either locally or remotely. FortiVoice units support remote
storage by a network attached storage (NAS) server using the network file system (NFS)
protocol.
NAS has the benefits of remote storage which include ease of backing up the call data and
more flexible storage limits. Additionally, you can still access the call data on the NAS server if
your FortiVoice unit loses connectivity.
If the FortiVoice unit is a member of an active-passive HA group, and the HA group stores call
data on a remote NAS server, disable call data synchronization to prevent duplicate call data
traffic. For details, see “Configuring the HA mode and group” on page 63.
If you store the call data on a remote NAS device, you cannot back up the data. You can only
back up the call data stored locally on the FortiVoice hard disk. For information about backing
up call data, see “Backing up configuration” on page 103.
Fortinet Technologies Inc.
Page 93
FortiVoice Phone System 5.3.0 Administration Guide
Tested and Supported NFS servers
• Linux NAS (NFS v3/v4)
• Red Hat 5.5
• Fedora 16/17/18/19
• Ubuntu 11/12/13
• OpenSUSE 13.1
• FreeNAS
• Openfiler
• EMC VNXe3150 (version 2.4.2.21519(MR4 SP2))
• EMC Isilon S200 (OneFS 7.1.0.3)
Untested NFS servers
• Buffalo TeraStation
• Cisco Linksys NAS server
Non-Supported NFS Servers
• Windows 2003 R2 /Windows 2008 Service for NFS
To configure call data storage
1. Go to System > Configuration > Storage.
2. Configure the following:
GUI field
Description
NAS section
Local
Select to store call data on the FortiVoice unit’s local disk or RAID.
NAS server
Select to store call data on a remote network attached storage (NAS)
server.
Test
Click to verify the NAS server settings are correct and that the
FortiVoice unit can access that location. The test action basically
tries to discover, login, mount, and unmount the remote device.
(button)
This button is available only when NAS server is selected.
Fortinet Technologies Inc.
Page 94
FortiVoice Phone System 5.3.0 Administration Guide
Protocol
Select a type of the NAS server:
• NFS: To configure a network file system (NFS) server. For this
option, enter the following information:
• Hostname/IP address: the IP address or fully qualified domain
name (FQDN) of the NFS server.
• Port: the TCP port number on which the NFS server listens for
connections.
• Directory: the directory path of the NFS export on the NAS
server where the FortiVoice unit will store call data.
• iSCSI Server: To configure an Internet SCSI (Small Computer
System Interface) server. For this option, enter the following
information:
• Username: the user name of the FortiVoice unit’s account on
the iSCSI server.
• Password: the password of the FortiVoice unit’s account on
the iSCSI server.
• Hostname/IP address: the IP address or fully qualified domain
name (FQDN) of the iSCSI server.
• Port: the TCP port number on which the iSCSI server listens
for connections.
• Encryption key: the key that will be used to encrypt data
stored on the iSCSI server. Valid key lengths are between 6
and 64 single-byte characters.
• iSCSI ID: the iSCSI identifier in the format expected by the
iSCSI server, such as an iSCSI Qualified Name (IQN),
Extended Unique Identifier (EUI), or T11 Network Address
Authority (NAA).
Status: When available, it indicates if the iSCSI share was
successfully mounted on the FortiVoice unit’s file system. This field
appears only after you configure the iSCSI share and click Apply.
Status may take some time to appear if the iSCSI server is slow to
respond.
If Not mounted appears, the iSCSI share was not successfully
mounted. Verify that the iSCSI server is responding and the
FortiVoice unit has both read and write permissions on the iSCSI
server.
Refresh
(button)
This button appears when you configure an iSCSI server. Click it to
update the information in the Status field.
Click here to These two links appear when you configure an iSCSI server and click
format this Apply.
device
Click a link to initiate the described action (that is, format the device
or check its file system). A message appears saying the action is
Click here to
being executed. Click OK to close the message and click Refresh to
check file
see a Status update.
system on
this device
Note: If the ISCSI disk has never been formatted, the FortiVoice unit
needs to format it before it can be used. If the disk has been
formatted before, you do not need to format it again. unless you
want to wipe out the data on it.
Fortinet Technologies Inc.
Page 95
FortiVoice Phone System 5.3.0 Administration Guide
Managing certificates
This section explains how to manage X.509 security certificates using the FortiVoice web-based
manager. Using the Certificate submenu, you can generate certificate requests, install signed
certificates, import CA root certificates and certificate revocation lists, and back up and restore
installed certificates and private keys.
The FortiVoice unit uses certificates for PKI authentication in secure connections. PKI
authentication is the process of determining if a remote host can be trusted with access to
network resources. To establish its trustworthiness, the remote host must provide an
acceptable authentication certificate by obtaining a certificate from a certification authority (CA).
You can manage the following types of certificates on the FortiVoice unit:
Table 14:Certificate types
Certificate type
Usage
Server certificates The FortiVoice unit must present its local server certificate for the
following secure connections:
• the web-based manager (HTTPS connections only)
• phone user web interface (HTTPS connections only)
• phone and FortiVoice unit (TLS and SRTP connections only), see
“Configuring SIP profiles” on page 120.
For details, see “Managing local certificates” on page 96.
CA certificates
The FortiVoice unit uses CA certificates to authenticate the PKI users,
including administrators and phone users. For details, see “Managing
certificate authority certificates” on page 102.
Personal
certificates
Phone users’ personal certificates are used for S/MIME encryption.
This section contains the following topics:
• Managing local certificates
• Obtaining and installing a local certificate
• Managing certificate authority certificates
• Managing the certificate revocation list
Managing local certificates
System > Certificate > Local Certificate displays both the signed server certificates and
unsigned certificate requests.
On this tab, you can also generate certificate signing requests and import signed certificates in
order to install them for local use by the FortiVoice unit.
FortiVoice units require a local server certificate that it can present when clients request secure
connections, including:
• the web-based manager (HTTPS connections only)
• phone user web interface (HTTPS connections only)
To view local certificates, go to System > Certificate > Local Certificate.
Fortinet Technologies Inc.
Page 96
FortiVoice Phone System 5.3.0 Administration Guide
Figure 24: Local Certificate tab
GUI field
Description
View
Select a certificate and click View to display its issuer, subject, and
range of dates within which the certificate is valid.
Generate
Click to generate a local certificate request. For more information, see
“Generating a certificate signing request” on page 98.
Download
Click the row of a certificate file or certificate request file in order to
select it, then click this button and select either:
• Download: Download a certificate (.cer) or certificate request (.csr)
file. You can send the request to your certificate authority (CA) to
obtain a signed certificate for the FortiVoice unit. For more
information, see “Downloading a certificate signing request” on
page 100.
• Download PKCS12 File: Download a PKCS #12 (.p12) file. For
details, see “Downloading a PKCS #12 certificate” on page 102.
Set status
Click the row of a certificate in order to select it, then click this button to
use it as the “default” (that is, currently chosen for use) certificate. The
Status column changes to indicate that the certificate is the current
(Default) certificate.
This button is not available if the selected certificate is already the
“default.”
Import
Click to import a signed certificate for local use. For more information,
see “Importing a certificate” on page 101.
Obtaining and installing a local certificate
There are two methods to obtain and install a local certificate:
• If you already have a signed server certificate (a backup certificate, a certificate exported
from other devices, and so on), you can import the certificate into the FortiVoice unit. For
details, see “Importing a certificate” on page 101.
• Generate a certificate signing request on the FortiVoice unit, get the request signed by a CA,
and import the signed certificate into the FortiVoice unit.
For the second method, follow these steps:
• Generating a certificate signing request
• Downloading a certificate signing request
• Submitting a certificate request to your CA for signing
• Importing a certificate
Fortinet Technologies Inc.
Page 97
FortiVoice Phone System 5.3.0 Administration Guide
Generating a certificate signing request
You can generate a certificate request file, based on the information you enter to identify the
FortiVoice unit. Certificate request files can then be submitted for verification and signing by a
certificate authority (CA).
For other related steps, see “Obtaining and installing a local certificate” on page 97.
To generate a certificate request
1. Go to System > Certificate > Local Certificate.
2. Click Generate.
A dialog appears.
3. Configure the following:
Figure 25: Generate Certificate Signing Request dialog
GUI field
Description
Certification name
Enter a unique name for the certificate request, such as fvlocal.
Subject Information Information that the certificate is required to contain in order to
uniquely identify the FortiVoice unit.
Fortinet Technologies Inc.
Page 98
FortiVoice Phone System 5.3.0 Administration Guide
ID type
Select the type of identifier to be used in the certificate to identify the
FortiVoice unit:
• Host IP
• Domain name
• E-mail
Which type you should select varies by whether or not your
FortiVoice unit has a static IP address, a fully-qualified domain name
(FQDN), and by the primary intended use of the certificate.
For example, if your FortiVoice unit has both a static IP address and
a domain name, but you will primarily use the local certificate for
HTTPS connections to the web-based manager by the domain name
of the FortiVoice unit, you might prefer to generate a certificate
based on the domain name of the FortiVoice unit, rather than its IP
address.
• Host IP requires that the FortiVoice unit have a static, public IP
address. It may be preferable if clients will be accessing the
FortiVoice unit primarily by its IP address.
• Domain name requires that the FortiVoice unit have a
fully-qualified domain name (FQDN). It may be preferable if clients
will be accessing the FortiVoice unit primarily by its domain name.
• E-mail does not require either a static IP address or a domain
name. It may be preferable if the FortiVoice unit does not have a
domain name or public IP address.
IP
Enter the static IP address of the FortiVoice unit.
This option appears only if ID type is Host IP.
Domain name
Type the fully-qualified domain name (FQDN) of the FortiVoice unit.
The domain name may resolve to either a static or, if the FortiVoice
unit is configured to use a dynamic DNS service, a dynamic IP
address. For more information, see “Configuring the network
interfaces” on page 43 and “Configuring DNS” on page 49.
If a domain name is not available and the FortiVoice unit subscribes
to a dynamic DNS service, an unable to verify certificate
message may appear in the user’s browser whenever the public IP
address of the FortiVoice unit changes.
This option appears only if ID type is Domain name.
E-mail
Type the email address of the owner of the FortiVoice unit.
This option appears only if ID type is E-mail.
Optional
Information
Organization
unit
Information that you may include in the certificate, but which is not
required.
Type the name of your organizational unit, such as the name of your
department. (Optional)
To enter more than one organizational unit name, click the + icon,
and enter each organizational unit separately in each field.
Organization
Fortinet Technologies Inc.
Type the legal name of your organization. (Optional)
Page 99
FortiVoice Phone System 5.3.0 Administration Guide
Locality (City)
Type the name of the city or town where the FortiVoice unit is
located. (Optional)
State/Province Type the name of the state or province where the FortiVoice unit is
located. (Optional)
Country
Select the name of the country where the FortiVoice unit is located.
(Optional)
E-mail
Type an email address that may be used for contact purposes.
(Optional)
Key type
Displays the type of algorithm used to generate the key.
This option cannot be changed, but appears in order to indicate that
only RSA is currently supported.
Key size
Select a security key size of 512 Bit, 1024 Bit, 1536 Bit or 2048 Bit.
Larger keys are slower to generate, but provide better security.
4. Click OK.
The certificate is generated, and can be downloaded to your management computer for
submission to a certificate authority (CA) for signing. For more information, see
“Downloading a certificate signing request” on page 100.
Downloading a certificate signing request
After you have generated a certificate request, you can download the request file to your
management computer in order to submit the request file to a certificate authority (CA) for
signing.
For other related steps, see “Obtaining and installing a local certificate” on page 97.
To download a certificate request
1. Go to System > Certificate > Local Certificate.
2. Click the row that corresponds to the certificate request in order to select it.
3. Click Download, then select Download from the pop-up menu.
Your web browser downloads the certificate request (.csr) file.
Submitting a certificate request to your CA for signing
After you download the certificate request file, you can submit the request to you CA for
signing.
For other related steps, see “Obtaining and installing a local certificate” on page 97.
To submit a certificate request
1. Using the web browser on the management computer, browse to the web site for your CA.
2. Follow your CA’s instructions to place a Base64-encoded PKCS #12 certificate request,
uploading your certificate request.
3. Follow your CA’s instructions to download their root certificate and Certificate Revocation
List (CRL), and then install the root certificate and CRL on each remote client.
4. When you receive the signed certificate from the CA, install the certificate on the FortiVoice
unit. For more information, see “Importing a certificate” on page 101.
Fortinet Technologies Inc.
Page 100
FortiVoice Phone System 5.3.0 Administration Guide
Importing a certificate
You can upload Base64-encoded certificates in either privacy-enhanced email (PEM) or public
key cryptography standard #12 (PKCS #12) format from your management computer to the
FortiVoice unit.
DER encoding is not supported in FortiVoice version 2.0 GA.
Importing a certificate may be useful when:
• restoring a certificate backup
• installing a certificate that has been generated on another system
• installing a certificate, after the certificate request has been generated on the FortiVoice unit
and signed by a certificate authority (CA)
If you generated the certificate request using the FortiVoice unit, after you submit the certificate
request to CA, the CA will verify the information and register the contact information in a digital
certificate that contains a serial number, an expiration date, and the public key of the CA. The
CA will then sign the certificate and return it to you for installation on the FortiVoice unit. To
install the certificate, you must import it. For other related steps, see “Obtaining and installing a
local certificate” on page 97.
If the FortiVoice unit’s local certificate is signed by an intermediate CA rather than a root CA,
before clients will trust the FortiVoice unit’s local certificate, you must demonstrate a link with
trusted root CAs, thereby proving that the FortiVoice unit’s certificate is genuine. You can
demonstrate this chain of trust either by:
• installing each intermediate CA’s certificate in the client’s list of trusted CAs
• including a signing chain in the FortiVoice unit’s local certificate
To include a signing chain, before importing the local certificate to the FortiVoice unit, first open
the FortiVoice unit’s local certificate file in a plain text editor, append the certificate of each
intermediate CA in order from the intermediate CA who signed the FortiVoice unit’s certificate to
the intermediate CA whose certificate was signed directly by a trusted root CA, then save the
certificate. For example, a local certificate which includes a signing chain might use the
following structure:
-----BEGIN CERTIFICATE----<FortiVoice unit’s local server certificate>
-----END CERTIFICATE---------BEGIN CERTIFICATE----<certificate of intermediate CA 1, who signed the FortiVoice
certificate>
-----END CERTIFICATE---------BEGIN CERTIFICATE----<certificate of intermediate CA 2, who signed the certificate of
intermediate CA 1 and whose certificate was signed by a trusted
root CA>
-----END CERTIFICATE----To import a local certificate
1. Go to System > Certificate > Local Certificate.
2. Click Import.
Fortinet Technologies Inc.
Page 101
FortiVoice Phone System 5.3.0 Administration Guide
3. From Type, select the type of the import file or files:
• Local Certificate: Select this option if you are importing a signed certificate issued by your
CA. For other related steps, see “Obtaining and installing a local certificate” on page 97.
• PKCS12 Certificate: Select this option if you are importing an existing certificate whose
certificate file and private key are stored in a PKCS #12 (.p12) password-encrypted file.
• Certificate: Select this option if you are importing an existing certificate whose certificate
file (.cert) and key file (.key) are stored separately. The private key is password-encrypted.
The remaining fields vary by your selection in Type.
4. Configure the following:
• Certificate file: Enter the location of the previously .cert or .pem exported certificate (or,
for PKCS #12 certificates, the .p12 certificate-and-key file), or click Browse to locate the
file.
• Key file: Enter the location of the previously exported key file, or click Browse to locate
the file.
This option appears only when Type is Certificate.
• Password: Enter the password that was used to encrypt the file, enabling the FortiVoice
unit to decrypt and install the certificate.
This option appears only when Type is PKCS12 certificate or Certificate.
5. Click OK.
Downloading a PKCS #12 certificate
You can export certificates from the FortiVoice unit to a PKCS #12 file for secure download and
import to another platform, or for backup purposes.
To download a PKCS #12 file
1. Go to System > Certificate > Local Certificate.
2. Click the row that corresponds to the certificate in order to select it.
3. Click Download, then select Download PKCS12 File on the pop-up menu.
A dialog appears.
4. In Password and Confirm password, enter the password that will be used to encrypt the
exported certificate file. The password must be at least four characters long.
5. Click Download.
6. If your browser prompts you for a location to save the file, select a location.
7. Your web browser downloads the PKCS #12 (.p12) file. For information on importing a PKCS
#12 file, see “Importing a certificate” on page 101.
Managing certificate authority certificates
Go to System > Certificates > CA Certificate to view and import certificates for certificate
authorities (CA).
Certificate authorities validate and sign other certificates in order to indicate to third parties that
those other certificates may be trusted to be authentic.
CA certificates are required by connections that use transport layer security (TLS), and by
S/MIME encryption. Depending on the configuration of each PKI user, CA certificates may also
be required to authenticate PKI users.
To view a the list of CA certificates, go to System > Certificate > CA Certificate. You can remove,
view, download, or import a CA certificate.
Fortinet Technologies Inc.
Page 102
FortiVoice Phone System 5.3.0 Administration Guide
Managing the certificate revocation list
The Certificate Revocation List tab lets you view and import certificate revocation lists.
To ensure that your FortiVoice unit validates only valid (not revoked) certificates, you should
periodically upload a current certificate revocation list, which may be provided by certificate
authorities (CA).
To view remote certificates, go to System > Certificate > Certificate Revocation List. You can
remove, view, download, or import a certificate revocation list.
Maintaining the system
The System > Maintenance submenu allows you to perform scheduled maintenance.
This topic includes:
• Maintaining the system configuration
• Downloading a trace file
• Maintaining phones
Maintaining the system configuration
The System > Maintenance > Configuration tab contains features for use during scheduled
system maintenance: updates, backups, restoration, and centralized administration.
Backing up configuration
Before installing FortiVoice firmware or making significant configuration changes, back up your
FortiVoice configuration. Backups let you revert to your previous configuration if the new
configuration does not function correctly. Backups let you compare changes in configuration.
You can back up system configuration or user configuration. System configuration includes the
configurations that make the FortiVoice unit work. User configuration includes user-configured
settings, such as voicemail greetings, in addition to system configuration.
In addition to backing up your configuration manually, you can also configure a schedule to
back up the configuration automatically to the FortiVoice local hard drive or a remote FTP/SFTP
server.
To back up the configuration file
1. Go to System > Maintenance > Configuration.
2. In the Backup Configuration area, select System configuration or User data.
If you choose to back up user data and the user data files are not updated, select the files to
be updated and click Prepare first before proceeding to the next step.
3. Click Backup.
Your management computer downloads the configuration file. Time required varies by the
size of the file and the speed of your network connection. You can restore the backup
configuration later when required. For details, see “Restoring the configuration” on
page 104.
To schedule a configuration backup
1. Go to System > Maintenance > Configuration.
2. Under Scheduled Backup, configure the schedule time and the maximum backup number.
When the maximum number is reached, the oldest version will be overwritten.
Fortinet Technologies Inc.
Page 103
FortiVoice Phone System 5.3.0 Administration Guide
3. Enable Local backup if you want to back up locally.
4. Enable Remote backup and configure the FTP/SFTP server credentials if you want to back
up remotely.
5. Click Apply.
Restoring the configuration
In the Restore Configuration area under System > Maintenance > Configuration, you can restore
the backup FortiVoice configuration from your local PC. For details, see “Restoring the
configuration” on page 295.
Restoring the firmware
In the Restore Firmware area under System > Maintenance > Configuration, you can install a
FortiVoice firmware from your local PC. For details, see “Installing firmware” on page 292.
Downloading a trace file
If Fortinet Technical Support requests a trace log for system analysis purposes, you can
download one using the web-based manager.
Trace logs are compressed into an archive (.gz), and contain information that is supplementary
to debug-level log files.
To download a trace file
1. Go to System > Maintenance > Configuration.
2. At the bottom of the tab, click Download trace log.
Your web browser downloads trace.log.gz.
Maintaining phones
The System > Maintenance > Phone Maintenance tab lets you upgrade phone firmwares and
configurations.
To view the list of phone maintenance records, go to System > Maintenance > Phone
Maintenance.
GUI field
Description
View
Select a record and click this option to view the job details.
Stop
Select a record and click this option to cancel an upgrade in progress.
Fortinet Technologies Inc.
Page 104
FortiVoice Phone System 5.3.0 Administration Guide
View phone status
Select a record and click this option to display the extensions to be
upgraded, the phone status, the upgrade job status, the job started
time, and the phone types.
On the phone status page, you may also select an extension and click
Redo to reconfigure the upgrade.
Job status:
• Waiting: Once the upgrade start time is due, the phones show this
status before receiving upgrade notifications from the FortiVoice unit.
• Notified: Once the upgrade start time is due, the phones show this
status after receiving upgrade notifications from the FortiVoice unit.
• Confirmed: The FortiVoice unit send configuration file to the phones.
The phones restart and reregister with the FortiVoice unit.
• Firmware confirmed: The FortiVoice unit send firmware upgrade file
to the phones. The phones restart and reregister with the FortiVoice
unit.
Phone management Select a record and click this option to manage the phones. For more
information, see “Managing phone configurations” on page 116.
Job ID
Displays system generated ID for the upgrade job.
Start time
Displays the starting time of the upgrade.
End time
Displays the ending time of the upgrade.
Summary
Displays the job upgrade status.
To upgrade a phone
1. Go to System > Maintenance > Phone Maintenance.
2. Click New and configure the following:
GUI field
Description
Name
Enter a unique name for the upgrade job.
Type
Select if you want a phone firmware or configuration upgrade.
Start/End time
Enter the date and time to start and end the upgrade.
Extension filter
Select the phones for the upgrade.
Extension
Select the phones in the Available field and move them to the
Selected field for the upgrade.
3. Click Create.
Fortinet Technologies Inc.
Page 105
FortiVoice Phone System 5.3.0 Administration Guide
Configuring Phone System
The Phone System menu lets you configure the FortiVoice PBX settings and other features for
managing phone calls.
This topic includes:
• Configuring phone system settings
• Configuring advanced phone system settings
• Managing sound files and music on hold
• Working with FortiVoice profiles
• Configuring FortiFone 870i
• Reviewing system configuration
Configuring phone system settings
Phone System > Settings let you configure the FortiVoice unit’s location, number management,
speed dial, and email notification templates.
You need to inform the users about some of the settings that affect them, such as number
settings and speed dial settings.
This topic includes:
• Setting PBX location and contact information
• Configuring PBX options
• Customizing call report and notification email templates
Setting PBX location and contact information
Identify the FortiVoice unit’s location and its number.
To set the PBX location
1. Go to Phone System > Settings > Location.
2. Configure the following:
GUI field
Description
Country/Region
Select the country/region where the FortiVoice unit is in.
Emergency number Click the default number (911) to enter the emergency call number of
the selected country.
Fortinet Technologies Inc.
Long-distance
prefix
Click the default number (1) to enter the prefix for dialing
long-distance calls.
International prefix
Click the default number (011) to enter the prefix for dialing
international calls.
Page 106
FortiVoice Phone System 5.3.0 Administration Guide
Outside line prefix
Click the default number (9) to enter the prefix for making outbound
calls.
Area code
Click the default number (613) to enter the Area code for the main
number of the FortiVoice unit. This code is provided by your PSTN
service provider.
Area code is
required when
dialing local
numbers
Select this option if the area code needs to be dialed for local phone
calls.
Main display name
Enter the name displaying on the FortiVoice unit. This name is
provided by your PSTN service provider.
Main number
Enter the main number of the FortiVoice unit. This number is
provided by your PSTN service provider.
Default prompt
language
Select a new default prompt language for the FortiVoice unit. The
default is English.
This setting affects all of the FortiVoice unit’s voice prompts, such as
auto attendant and voice mail. However, if you change the sound file
for an individual component, such as auto attendant, to use a
different language, it will override the default prompt language for
this component.
For information on adding prompt languages, see “Adding prompt
languages” on page 114.
Contact Information Optionally, enter your contact information.
Emergency setting
Configure to send an alert email when an emergency call is made.
Select Do nothing if you don’t want the FortiVoice unit to send an
alert email. Otherwise, select Send alert email and enter the email
address.
3. Click Apply.
Configuring PBX options
The Phone System > Settings > Options tab lets you configure the pattern and number of digits
you want the FortiVoice unit to use for phone numbers, speed dials, and prefixes as well as the
default FortiVoice system settings. These settings apply to all extensions unless you change
them when configuring the extensions. For details, see “Setting up local extensions” on
page 136.
The FortiVoice unit supports the following pattern-matching syntax:
Table 15:Pattern-matching syntax
Syntax
Description
X
Matches any single digit from 0 to 9.
Z
Matches any single digit from 1 to 9.
N
Matches any single digit from 2 to 9.
Fortinet Technologies Inc.
Page 107
FortiVoice Phone System 5.3.0 Administration Guide
Table 15:Pattern-matching syntax
Syntax
Description
[15-7]
Matches a single character from the range of digits specified. In this case, the
pattern matches a single 1, as well as any number in the range 5, 6, 7.
.
Wildcard match; matches one or more characters, no matter what they are.
!
Wildcard match; matches zero or more characters, no matter what they are.
,
These pattern delimiters allow you to enter multiple pattern strings at a time. For
example, you can enter NXXX,6XXXX;[3-5]X
; or
(space)
Table 16:Pattern-matching examples
Pattern
Description
NXXX
Matches any four-digit number, as long as the first digit is 2 or higher.
NXXNXXXXXX
This pattern matches with areas with 10-digit dialing.
1NXXNXXXXXX
Matches the number 1, followed by an area code between 200 and 999,
then any seven-digit number. In the North American Numbering Plan calling
area, you can use this pattern to match any long-distance number.
011.
Matches any number that starts with 011 and has at least one more digit.
To configure PBX options
1. Go to Phone System > Settings > Options.
2. Configure the following:
GUI field
Description
Number Management
Extension number
pattern
Enter the extension number pattern. For example, NXXX is any
four-digit number as long as the first digit is 2 or higher and 7XXX
is a four-digit number that always starts with 7. This pattern will
be followed when creating extensions. See “Configuring IP
extensions” on page 136.
Speed dial pattern
Enter the speed dial number pattern. For example, *3XX is any
three-digit number that starts with 3. This pattern will be
followed when configuring speed dials. See “Mapping speed
dials” on page 244.
System prohibited
prefix
Enter the phone number prefix that you want to ban, such as
900. Click the + sign to add up to 10.
System unrestricted Enter the allowed phone number prefix, such as 800. Click the +
prefix
sign to add up to 10.
Operator extension Enter the extension for the operator of the FortiVoice unit.
Fortinet Technologies Inc.
Page 108
FortiVoice Phone System 5.3.0 Administration Guide
Supporting
extension
Enter the extension for technical support of the FortiVoice unit.
Default Setting
Default SIP user
password
Enter your own password or let the FortiVoice unit generate one
for you. This password is used for configuring your SIP phone
from the phone or the Web. You need the phone's IP to access it
from the Web. This password appears when you add an
extension. For details, see “Configuring IP extensions” on
page 136.
• Specified: Enter the password. The password cannot be
blank, must be 8 or more characters, must contain at least
one uppercase character, one lowercase character and one
number. Non-alphanumeric characters, like ( - $, are not
supported in the password field.
The default password is voice#321.
• Generated: Select to have a system-generated password.
Default user PIN
Enter your own password or let the FortiVoice unit generate one
for you. This password is for the extension user to access voice
mail and the user web portal. This password appears when you
add an extension. For details, see “Configuring IP extensions”
on page 136.
If you select Specified, the default password is 123123.
User ID prefix
Enter the prefix for the extension user ID. When you add a new
extension, the FortiVoice unit will generate a user ID with this
prefix plus the extension number. For details, see “Configuring IP
extensions” on page 136.
Default ring
duration
Enter the time, in seconds, for a phone connected to the
FortiVoice unit to ring before the call is processed (for example,
the call is sent to voice mail). The default is 20.
3. Click Apply.
Customizing call report and notification email templates
Go to Phone System > Settings > Custom Message to view and reword the default call report
and notification email templates.
The FortiVoice unit sends out call reports based on your call report configuration (see
“Configuring report email notifications” on page 282) and notification email when, for example,
you have a new voicemail or fax in your mailbox or missed a call. You can customize the email
templates for the call report and email notifications.
You can change the content of the email template by editing the text and HTML codes and by
working with email template variables. For descriptions of the default email template variables,
open a template and select Edit Variable.
To customize call report and email templates
1. Go to Phone System > Settings > Custom Message.
2. Open Report or Email templates to display the default templates.
3. To edit a template, double-click it or select it and click Edit.
Fortinet Technologies Inc.
Page 109
FortiVoice Phone System 5.3.0 Administration Guide
4. To format template in HTML, use HTML tags, such as <b>some bold text</b>.
There is a limit of 250 characters for the Subject field, 60 characters for the From field, and
4000 characters for Htmlbody and Textbody messages each in the Content body field.
5. To add a variable:
• Select Insert Variables next to the area to insert a variable. A pop-up window appears.
• Place your mouse cursor in the text message at the insertion point for the variable.
• Click the name of the variable to add. It appears at the insertion point.
• To add another variable, click the message area first, then click the variable name.
• Click the Close (X) icon to close the window.
6. To insert a color:
• Click Insert Color Code. A pop-up window of color selection appears.
• Place your mouse cursor in the text at the insertion point for the color code, or highlight
an existing color code to change.
• Click a color in the color selection pop-up window.
For example, to replace the color code in the HTML tag <tr bgcolor="#3366ff">,
you can highlight "#3366ff", then select the color you want from the color palette.
To add a new color code, include it with HTML tags as applicable, such as <tr
bgcolor="#3366ff">.
7. To determine if your HTML and color changes are correct, click Preview. The replacement
message appears in HTML format.
8. Click OK, or click Reset To Default to revert the replacement message to its default text.
Configuring advanced phone system settings
The Phone System > Advanced Settings submenu lets you configure SIP setting, SIP phone
auto-provisioning, prompt languages, phone management, and system capacity.
This topic includes:
• Configuring SIP settings
• Configuring SIP phone auto-provisioning
• Adding prompt languages
• Managing phone configurations
• Configuring system capacity
Configuring SIP settings
FortiVoice units support SIP communications.
To configure FortiVoice SIP settings
1. Go Phone System > Advanced Settings > SIP.
2. Configure the following:
GUI field
Fortinet Technologies Inc.
Description
Page 110
FortiVoice Phone System 5.3.0 Administration Guide
Transport Setting
SIP communication commonly uses TCP or UDP port 5060
and/or 5061. Port 5060 is used for nonencrypted SIP signaling
sessions and port 5061 is typically used for SIP sessions
encrypted with Transport Layer Security (TLS).
Enable the ports as required.
Registration/Subscription Interval
Extension
To keep the extensions’ registration status with the FortiVoice
registration/subscrip- unit, enter the range of extension registration time interval as
tion interval range
required by the FortiVoice unit in minutes. An extension’s
registration timeout setting is overridden by the FortiVoice
unit’s extension registration time interval range if it is out of the
range.
The default range is 1-480.
The start of the range is 1-60 and the end of the range is
30-1440.
Internal extension
Enter the default registration time interval for the extensions on
registration/subscrip- your subnet as required by the FortiVoice unit in minutes. The
tion interval
default is 30 and the range is 10-480.
Set a proper value for this option. If it is too low, the
performance of the FortiVoice unit is compromised due to
frequent registration. If it is too high, the connection between
the FortiVoice unit and the extension may terminate.
External extension
Enter the default registration time interval for the extensions on
registration/subscrip- other subnets as required by the FortiVoice unit in seconds.
tion interval
The default is 30 and the range is 10-1800.
Set a proper value for this option. The FortiVoice unit requires
that external extensions register more frequently with it to
keep the connection. However, if the value is set too low, the
performance of the FortiVoice unit is compromised due to
frequent registration. If it is too high, the connection bewteen
the FortiVoice unit and the extension may terminate.
Networks
External static
Host/IP
Enter the FortiVoice unit’s external static IP address to which
the external extensions register. Also enter the port number.
External SIP port
Enter the FortiVoice unit’s external SIP port number to which
the external extensions connect.
External HTTPS port
Enter the FortiVoice unit’s external HTTPS port number to
which the external extensions connect.
RTP Setting
RTP port start
Fortinet Technologies Inc.
Enter the starting Real-time Transport Protocol (RTP) port that
the FortiVoice unit will use for phone call sessions. If the unit is
behind a firewall, these ports should be open. Ensure there is a
reasonable port range so that you have enough ports for all
open calls. The default port is 5000.
Page 111
FortiVoice Phone System 5.3.0 Administration Guide
RTP port end
Enter the end RTP port that the FortiVoice unit will use for
phone call sessions. Ensure there is a reasonable port range
so that you have enough ports for all open calls. The default
port is 30000.
RTP timeout
Enter the amount of time in seconds during an active call that
the extension will wait for RTP packets before hanging up the
call. 0 means no time limit. The default is 60.
RTP hold timeout
Enter the amount of time in seconds that the extension will
wait on hold for RTP packets before hanging up the call. 0
means no time limit. The default is 300.
TLS Client Setting
If you have enabled TLS, configure the following:
• Server certificate verification: Select this option for the TLS
clients to confirm the validity of a server’s credentials with a
trusted root certification authority’s (CA’s) certificates. For
information on uploading a CA certificate, see “Managing
certificate authority certificates” on page 102.
• TLS protocol: Select the TLS protocol version.
Security
By default, the FortiVoice unit screens out incoming calls from
unauthenticated source. If you want to change this default
setting, select Accept unauthenticated incoming call.
Advanced Setting
• Enable early media: Select if you want the FortiVoice unit to
relay a ring tone to the caller of an incoming call before the
establishment of a call connection. A ring tone or a busy
tone is early media.
If you select this option, you also need to configure a
specific trunk to send the ring tone. See “Inband ringtone”
on page 177.
• SIP session helper: Select if you do not want the FortiVoice
unit to apply NAT or other SIP session help features to SIP
traffic. With the SIP session helper disabled, the FortiVoice
unit can still accept SIP sessions if they are allowed by a
security policy, but the FortiVoice unit will not be able to
open pinholes or NAT the addresses in the SIP messages.
3. Click Apply.
Configuring SIP phone auto-provisioning
Phone System > Advanced Settings > Auto Provisioning allows the FortiVoice unit to discover
the SIP phones on your network and send the configuration files to them.
With auto-provisioning configured, when a supported FortiFone is connected to the network
and powered on, it is automatically discovered and receives the configuration file from the
FortiVoice unit. The FortiFone will then reboot with the pushed-in configuration file and register
with the FortiVoice unit.
The FortiVoice unit can only auto provision the supported FortiFones.
Fortinet Technologies Inc.
Page 112
FortiVoice Phone System 5.3.0 Administration Guide
To configure auto-provisioning settings
1. Go to Phone System > Advanced Settings > Auto Provisioning and configure the following:.
GUI field
Description
Auto Provisioning Setting
Enabled
Select to activate the SIP phone auto-provisioning function for
auto discovering the phones.
Generate default
configuration for
unassigned phone
Select to generate phone configuration files for the supported
unassigned SIP phones. For details, see “Viewing unassigned
phones” on page 28.
With this option selected, once a supported SIP phone
connects to the FortiVoice unit and is auto-discovered, the
FortiVoice unit assigns an IP address to the phone and sends
the basic PBX setup information to it.
If you want to upgrade your phone system and keep the
current phone configuration, do not select this option.
Otherwise your existing phone configuration will be overridden
by the upgraded FortiVoice configuration.
Administrator PIN
Click and enter a global password to be used by an
administrator to connect a FortiFone to the FortiVoice unit to
set mobile extension number. This password is also used by
the administrator to override schedules. For details, see
“Configuring system capacity” on page 117.
For example, you can press the default Configure Phone
feature code *17 (See “Modifying feature access codes” on
page 266) on any FortiFone that connects to the FortiVoice
unit and enter this password. You can then enter an existing
extension to set it as the extension of this phone.
Click Apply and then Auto Provisioning to return to the Auto
Provisioning page.
Server Settings for Phone
Configuration
Standard (apply to all Select to configure the server settings for the supported
server settings)
phones. The same settings apply to the SIP server, TFTP
server, and NTP server.
• Use IP address of interface: Select the interface for the
server. The SIP phones connect to this server to register
and receive the PBX setup information and use it as the
NTP server. For information on interface configuration, see
“Configuring the network interfaces” on page 43.
• Use static IP or host name: Enter the current public IP
address or public domain name of the server. The SIP
phones connect to this server to register and receive the
PBX setup information and use it as the NTP server.
Fortinet Technologies Inc.
Page 113
FortiVoice Phone System 5.3.0 Administration Guide
Advanced
If you use different servers for SIP, TFTP, and NTP, select to
configure the settings of each server for the supported
phones.
• SIP server
• Use IP address of interface: Select the interface for the
server. The SIP phones connect to this server to
register.
• Use static IP or host name: Enter the current public IP
address or public domain name of the server. The SIP
phones connect to this server to register.
• TFTP server
• Use IP address of interface: Select the interface for the
server. The SIP phones connect to this server to receive
the PBX setup information.
• Use static IP or host name: Enter the current public IP
address or public domain name of the server. The SIP
phones connect to this server to receive the PBX setup
information.
• NTP server
• Use IP address of interface: Select the interface for the
server. The SIP phones connect to this server to
synchronize time.
• Use static IP or host name: Enter the current public IP
address or public domain name of the server. The SIP
phones connect to this server to synchronize time.
2. Click Apply.
Adding prompt languages
The prompt language affects all of the FortiVoice unit’s voice prompts, such as auto attendant
and voicemail. Prompt languages are used when configuring the PBX settings. For more
information, see “Setting PBX location and contact information” on page 106.
However, if you change the sound file for an individual component, such as auto attendant, to
use a different language, it will override the default prompt language for this component.
The default prompt language is English.
For information on generating a prompt language file, see “Recording in FortiVoice audio
format” on page 115.
To add a prompt language
1. Go to Phone System > Advanced Settings > Prompt Languages.
2. Click New.
3. In the Upload field, click Browse to upload the language file provided by Fortinet Technical
Support.
4. Click OK.
Fortinet Technologies Inc.
Page 114
FortiVoice Phone System 5.3.0 Administration Guide
Recording in FortiVoice audio format
A prompt language file must be recorded in the FortiVoice language package format. This can
be accomplished by using the free and robust audio program called Audacity which can be
downloaded from http://audacity.sourceforge.net and a microphone.
Once this program has been installed, and the microphone connected, then the file can be
recorded.
Audacity cannot natively record in the format that FortiVoice unit requires. Therefore, some
adjustments need to be made in the software as described in the following procedure.
To generate a prompt language file
1. On Audacity, go to Edit > Preferences.
2. Click the Devices menu and select 1(Mono) for Channels.
3. Click the Quality menu and set the Default Sample Rate to 8000 Hz and the Default Sample
Format to 16 bit.
4. Click OK.
5. Click the Record button when ready to start recording the file. When finished recording, click
Stop.
The completed recording can now be saved in a format to work with the FortiVoice unit.
6. Go to File > Export.
Fortinet Technologies Inc.
Page 115
FortiVoice Phone System 5.3.0 Administration Guide
7. For Save As Type, select Other compressed files.
8. Click Options.
9. For Encoding, select U-law. Click OK.
10.. Select the directory in which to save the recording and then click Save.
The recording is now in a format that can be loaded into the FortiVoice unit.
Managing phone configurations
The FortiVoice unit provides the default configuration templates for the phone types with
Limited support level. In most cases, there is no need to modify the templates. If you do need to
make changes to a template (for example, change the IP address of the NTP server), make sure
the format matches that of the default template. Otherwise, phone auto-provisioning will not be
possible. This is because the template is part of the configuration file generated for the phone
type and will be sent to a phone of this type through auto provisioning. For details, see
“Configuring SIP phone auto-provisioning” on page 112.
The phones with Comprehensive support level do not display their configuration templates
because the FortiVoice unit fully supports the phones.
You can also manage the phone firmwares on the FortiVoice unit.
Once you have modified the templates or uploaded a new firmware, they are saved on the
FortiVoice unit. To send them to the phones, choose a low traffic time and reboot the phones.
For information on rebooting the phones, see “Setting up local extensions” on page 136.
If your organization adds new FortiFones that use a different range of MAC addresses than your
current ones and you want to add them to the FortiVoice unit in order to auto-provision them,
you can do so by adding the new phones’ MAC address.
If your phones are not FortiFone, you can upload the third party phone configuration files to the
FortiVoice TFTP server and migrate the files to your phones without using an external TFTP
server.
To manage a phone firmware
1. Go to Phone System > Advanced Settings > Phone Management.
2. Select the phone type of which you want to manage the firmware.
3. Click Manage.
4. In the pop-up window, double-click a firmware folder under Name.
Fortinet Technologies Inc.
Page 116
FortiVoice Phone System 5.3.0 Administration Guide
5. Remove or save an existing firmware, or upload a new firmware in .zip format. You can also
activate or deactivate a firmware.
To configure a phone profile
1. Go to Phone System > Advanced Settings > Phone Management.
2. Click Phone Profile.
3. See “Configuring phone profiles” on page 123.
To add new FortiFones MAC address
1. Go to Phone System > Advanced Settings > Phone Management.
2. Click Additional Phone/MAC.
3. Click New.
4. For MAC address, enter the FortiFone MAC address in the following format:
AA:BB:CC:00:00:00.
5. Leave the Phone Type field as is. Currently, this feature only supports FortiFone.
6. Select Status.
7. Click Create.
The new FortiFones are recognized by the FortiVoice unit. You can auto-provision them now.
For more information, see
To upload third party configuration to FortiVoice TFTP server
1. Go to Phone System > Advanced Settings > Phone Management.
2. Click TFTP Service.
3. Click Upload and browse for the file.
4. Click Upload.
To maintain phones
1. Go to Phone System > Advanced Settings > Phone Management.
2. Click Phone Maintenance.
3. See “Maintaining phones” on page 104.
To upload phone template files
1. Go to Phone System > Advanced Settings > Phone Management.
2. Click Template upgrade.
• Upgrade all template files: Select to upgrade phone template files which are used as
basis for configuration files.
• Check the conflict files: Select to list the old template files on phones that conflict the
newly upgrade one. The conflict may occur as a result of changes manually made or
templates inconsistency. You may double-click a template to view the file conflict content
and manually edit the file by moving the content you want to the new template at the
bottom of the page, and click OK. Otherwise, select Remove conflict file and Set
template to default to use the newly upgraded template.
3. Click OK.
Configuring system capacity
The Phone System > Advanced Settings > Miscellaneous tab lets you set the PIN used by the
administrator to override schedules, configure voicemail greeting and message length, set
phone directory options, configure CDR settings, and configure queue logs.
Fortinet Technologies Inc.
Page 117
FortiVoice Phone System 5.3.0 Administration Guide
To configure system capacity
1. Go to Phone System > Advanced Settings > Miscellaneous.
2. Configure the following:
GUI field
Description
PBX Setting
Administrator PIN
Enter the password used by the administrator to override
schedules.
This global password is also used by an administrator to
connect a FortiFone to the FortiVoice unit to set mobile
extension number. For details, see “Configuring SIP phone
auto-provisioning” on page 112.
PBX identification
Schedule Override
Enter a unique name for the FortiVoice unit.
Select Allow admin user to override schedule if required.
An administrator with the privilege can dial *821, *822, or *823
followed by the administrator PIN to temporarily replace the
original schedule with one of the three default ones. You may
also modify the temporary schedule. Dial *820 to go back to
the original schedule.
Voicemail
Enter the maximum message length, greeting length, and
voicemail volume you want.
Directory
Set phone directory options.
Dial-by-name option
Select how a caller can check the directory by dialing a name.
Dial-by-name digits
Enter the number of letters allowed for a caller to dial someone
by name. The range is 3-9. This feature enables a caller to
reach a specific person quickly by dialing, for example, the
first three letters of their first or last name from any phone.
Read back number
Select if you want a person’s extension number to be read out
after you check the directory by dialing the person’s first or last
name.
Internet of Things
Amazon Alexa
Select to enable configuring your FortiVoice unit’s integration
with Amazon Alexa. For more information, see “Configuring
Internet of things (IoT)” on page 271.
IFTTT
Select to enable configuring your FortiVoice unit’s integration
with IFTTT Web service. For more information, see “Configuring
Internet of things (IoT)” on page 271.
CDR
Fortinet Technologies Inc.
Enter the time in month that you want to keep the call log/call
detail record and the maximum number of CDR records. For
information about call log/CDR, see “Viewing call records” on
page 33.
Page 118
FortiVoice Phone System 5.3.0 Administration Guide
Queue log
Enter the time in month that you want to keep the queue log
and the maximum number of log records. For information
about queue logs, see “Viewing log messages” on page 34.
3. Click Apply.
Managing sound files and music on hold
The Phone System > Audio > Prompts/Music On Hold menu lets you upload, record, and play
phone sound files such as voicemail greetings and announcements. It also lets you choose the
sound files to play while a call is on hold.
There are default sound files ready to use.
The sound files can be used when configuring music on hold, conference calls, and auto
attendants. See “To configure music on hold” on page 119 and “Configuring Call Features” on
page 233.
To manage a sound file
1. Go to Phone System > Audio > Prompts.
2. Click New.
3. Enter a name for the file.
4. Select a profile type.
5. Optionally, enter a description for the file.
6. For Voice language, configure the following:
If you select Prompt sound file for the profile type, you can click Upload to get an existing
sound file, Record to make a sound file, Download to save a a sound file, and Play to listen
to an uploaded or recorded file (with speakers or earphones) for the language you select.
i. To record a sound file, click Record.
ii. On the Send Voice Recording Call dialog box, enter the extension that you will use to
record the file, and click Send to dial the extension. You can edit the extension or add
a new one. For details, see “Configuring IP extensions” on page 136.
iii. When the extension rings, record the sound file and hang up.
iv. On the FortiVoice web-based manager, click Yes on the Voice recording request sent
to specified extension dialog box.
If you select Music on hold for the profile type, you can click Upload to get an existing sound
file, Record to make a sound file, Download to save a a sound file, and Play to listen to a
uploaded or recorded file (with speakers or earphones).
7. Click OK.
To configure music on hold
1. Go to Phone System > Audio > Music On Hold.
2. Click New.
3. Configure the following:
GUI field
Description
Name
Enter a name for the music on hold file.
Mode
Fortinet Technologies Inc.
Page 119
FortiVoice Phone System 5.3.0 Administration Guide
Files
If you select to use existing sound files, do the following:
• For Sound files, select the Available sound files and click
-> to move them into the Selected field. You can use the
Up and Down buttons to reorder the files.
• For Play mode, if you want to play the selected sound files
randomly, select Random. If you want to play the files
according to the order in the Selected field, select
Sequential.
• For Volume, Set the music sound volume.
Stream
If you select to use streaming files, in the Stream URL field,
enter the URL where the streaming music is, such as a radio
station. This way, the music is delivered to the FortiVoice unit
and played virtually straight away. You can click Test stream
to see if the URL is added successfully.
Before doing so, make sure to only use the legal stream
sources.
Volume
Set the music sound volume.
Description
Optionally, enter a description for the file.
4. Click Create.
Working with FortiVoice profiles
The Phone System > Profiles tab lets you create user privileges and SIP profiles for configuring
extensions and SIP trunks. It also allows you to modify caller IDs, schedule the FortiVoice unit,
and configure phone and LDAP profiles.
This topic includes:
• Configuring SIP profiles
• Modifying caller IDs
• Configuring phone profiles
• Configuring LDAP profiles
• Configuring user privileges
• Configuring location profile
• Scheduling the FortiVoice unit
Configuring SIP profiles
Configure the supported phone features and codecs and apply them to the extensions and SIP
trunks.
Communicate with your VoIP service provider because the profile settings are subject to the
capabilities of the VoIP service provider. For example, if some of your features and codecs are
not supported by your VoIP service provider, they will not work even if they are enabled or
selected in the SIP profile.
The default SIP profiles can be edited but not be deleted.
Fortinet Technologies Inc.
Page 120
FortiVoice Phone System 5.3.0 Administration Guide
For information on extensions, see “Configuring Extensions” on page 136.
For information on SIP trunks, see “Configuring Trunks” on page 175.
To configure a SIP profile
1. Go to Phone System > Profiles > SIP and click New.
2. Configure the following:
GUI field
Description
SIP
• Name: Enter a name for this profile.
• DTMF: Select the dual-tone multi-frequency (DTMF) method used
by the VoIP provider. Options are RFC2833, Inband, Info,
Shortinfo, and Auto.
Auto means the VoIP provider’s server and the FortiVoice unit will
negotiate to select a DTMF method. You could also select a
specific DTMF method if required.
• NAT: Select if the VoIP service provider supports SIP NAT
translation.
• Video: Select if the service provider supports video calling over
SIP.
• T.38: Select if the VoIP service provider supports fax over VoIP
network.
• Monitor/Keep alive (SIP notify) interval: Enter the time interval in
seconds for the FortiVoice unit to talk to the SIP server of your
service provider to keep the connectivity and check its capability.
0 means no checking by the FortiVoice unit.
Transport
Transport: SIP commonly uses TCP or UDP port 5060 and/or 5061.
Port 5060 is used for non-encrypted SIP signaling sessions and port
5061 is typically used for SIP sessions encrypted with Transport
Layer Security (TLS).
Enable the protocols as required.
This option, if applied to a user, overrides the system-wide transport
settings. For more information, see “Configuring SIP settings” on
page 110.
Secure RTP: Select to provide encryption, message authentication
and integrity, and replay protection to the FortiVoice Real-time
Transport Protocol data.
Codec
Select the codecs supported by the VoIP service provider. Among
the selected ones, choose the preferred one for the VoIP provider.
The preferred codec is usually the most used one in your area and
provides the best quality of communication.
If your preferred codec is different from that of your VoIP service
provider, the service provider’s codec will be used as long as it is one
of your supported codecs.
3. Click Create.
Fortinet Technologies Inc.
Page 121
FortiVoice Phone System 5.3.0 Administration Guide
Modifying caller IDs
You can change the phone number, caller’s name, or both that will appear on the destination
phone.
Caller ID modifications are used when configuring dial plans. For more information, see
“Configuring Call Routing” on page 189.
To modify a caller ID
1. Go to Phone System > Profiles > Caller ID Modification.
2. Click New and configure the following:
GUI field
Description
Name
Enter the name for this caller ID modification record.
Match number
Enter the extension number or number pattern you want to modify.
For example, you can enter 8134 to modify a single extension, or
81xx to modify all the four-digit numbers starting with 81.
Number
Modification
If you have entered a Match number, configure the following values
to modify it:
• Strip: Enter a number to hide the starting part of an extension
from displaying. 0 means no action.
For example, if your Match number is 8134 and Strip is 2, only 34
will be displayed as caller ID.
• Truncate: Enter a number to hide the ending part of an extension
from displaying. 0 means no action.
For example, if your Match number is 8134 and Truncate is 2,
only 81 will be displayed as caller ID.
• Prefix: Add a number before an extension.
For example, if your Match number is 8134 and Prefix is 5, the
caller ID will be 58134.
• Postfix: Add a number after an extension.
For example, if your Match number is 8134 and Postfix is 5, the
caller ID will be 81345.
Fortinet Technologies Inc.
Page 122
FortiVoice Phone System 5.3.0 Administration Guide
Match option
Select the way to match a call with caller name and number in order
to modify call number or caller ID.
• Match number or name: If the number is matched, modifications
will be done based on Number Modification configuration. If the
name is matched, modifications will be done based on Map to
new caller ID name configuration.
• Match number then name: If the number is matched,
modifications will be done based on Number Modification
configuration. If both the number and name are matched,
modifications will be done based on Map to new caller ID name
configuration.
• Match name then number: If the Name is matched, modification
will be done based on Map to new caller ID name configuration. If
both the name and number are matched, modifications will be
done based on Number Modification configuration.
• Match number and name: If both the number and name are
matched, modifications will be done based on Number
Modification and Map to new caller ID name configurations.
Match caller ID
name
Enter the caller ID that you want to map to another one.
Map to new caller
ID name
Enter the new caller ID name to which you want to map the one
entered in the Match caller ID name field.
Advanced Setting
Select Block caller ID to stop your caller ID from displaying on the
destination phone.
Caller IDs are created when configuring SIP extensions. See
“Configuring IP extensions” on page 136.
3. Click Create.
Mapping a group of extensions to a caller ID name
If you want to map a group of extensions to a caller ID name, you can use the pattern for the
extensions to do so.
For example, if you have a technical support team that has 10 extensions (8100-8110), instead
of displaying each extension when making calls, you can just display one caller ID name
“Support” for the whole team.
To map a group of extensions to a caller ID name
1. Go to Phone System > Profile > Caller ID Modification.
2. Click New.
3. In the Match number field, enter the pattern of the extensions, such as 81xx in the example.
4. In the Map to new caller ID name field, enter the caller ID name to which you want to map,
such as “Support”.
5. Click Create.
Configuring phone profiles
Phone profiles contain the phone configurations that are mostly used and customized, such as
the programmable phone keys. Phone profiles make extension configuration more flexible
because phone users are allowed to choose the profile they want. In addition, any changes the
Fortinet Technologies Inc.
Page 123
FortiVoice Phone System 5.3.0 Administration Guide
administrator makes to a profile is automatically applied to the extensions that use the profile.
For more information, see “Configuring IP extensions” on page 136.
The phone profiles configured here appear as Admin defined profiles when you configure a SIP
extension.
To configure a phone profile
1. Go to Phone System > Profiles > Phone.
2. Click New and configure the following:
GUI field
Description
Phone profile
Name
Enter a name for the profile.
Phone type
Select a phone model for the profile.
Time format
Select the time display format on the phone.
• North American: mm/dd/yyyy
• International: dd/mm/yyyy
Description
Enter any notes you have for this profile.
Configuration mode Select the profile mode.
• Automatic: the FortiVoice unit will generate a phone
configuration file based on the information you provide.
See “Automatic Configuration” on page 125.
This option is only available for FortiFone-260i and above.
• Manual: This option allows you to manually edit the phone
configuration file. See “Manual Configuration” on
page 126
Phone book
Select Local only to include the phone directory on this
FortiVoice unit, and Global to include the phone directories of
any remote FortiVoice units connected to this unit.
For information on phone directories, see “Viewing phone
directories” on page 39.
Vlan
Fortinet Technologies Inc.
You may need to deploy phones using the existing IT
infrastructure which only has one network drop for each
employee. The network switch supports 802.1Q VLAN
tagging and LLDP-MED. Some phones such as FortiFones
have two network ports: LAN and PC. The recommended
solution is to connect FortiFones to the switch using LAN
port and connect the computer to the PC port of FortiFones.
VLAN tag needs to be enabled to segregate FortiFone voice
network and PC data network.
Page 124
FortiVoice Phone System 5.3.0 Administration Guide
Option
If you select Manual, configure the following:
ID for voice: Enter your organization’s VLAN ID for voice.
ID for data: Enter your organization’s VLAN ID for data.
Priority for voice/data: Enter the traffic service level
recommended by the IEEE. Each number represents a traffic
type. The range is from 0-7, with 7 being the highest.
• 0: Background
• 1: Best Effort
• 2: Excellent Effort
• 3: Critical Applications
• 4: Video, < 100 ms latency and jitter
• 5: Voice, < 10 ms latency and jitter
• 6: Internetwork Control
• 7: Network Control
If you select LLDP (Link Layer Discovery Protocol), the
FortiVoice unit automatically generates the configuration file.
You need to enable LLDP support on your network switch.
Automatic Configuration
This option is only available if you select Automatic for
Configuration mode.
Display option
Select what to display on the extension: the extension user’s
name only or name and number.
Provisioning lines
Enter the number of phone lines to which this profile applies.
The maximum lines that you can provision is 4.
Digit map pause
timer
Enter the digit map timeout in seconds which defines the
waiting time between the completion of dialing number
entering and initiating the call.
For example, if you enter 5 and use the default digit map
syntax, the phone will initiate a call 5 seconds after you finish
entering the dialing number.
Digit map
The FortiVoice unit uses digit map syntax definition to define
the FortiFone dialing behavior. A phone needs to know when
number entering is complete and therefore to initiate the call.
You can enter the syntax or use the default syntax x.T|x+#
where:
• x.T means you can dial any number and the call is
initiated after the digit map pause timeout is reached.
• | is a choice operator that matches the expression before
or after the operator. For example, abc|def matches
"abc" or "def".
• x+# means you can enter any number and then press the
# key to initiate the call.
For more information about digit map syntax definitions, see
Section 2.1.5 of RFC 3435.
Fortinet Technologies Inc.
Page 125
FortiVoice Phone System 5.3.0 Administration Guide
Set Programmable
Phone Key
Allows you to program the phone keys for FortiFone-260i to
675i. For FortiFones with expansion modules, you can select
the module to program the keys.
After completing programing the keys, you can click
Download printable label to save and print out the
configuration and label it on the phone.
Note that keys 1 and 2 are reserved and cannot be
programmed.
If you select One key dial or User Assigned function for a key,
you need to enter the information in the Resource field based
on your phone configuration. For example, if you select User
defined for key 3 and you want to map this key to your
voicemail code such as *78, enter *78 in the Resource field.
Selecting Centralized phonebook allows you to browse the
phone book from a FortiFone. You can also search on
FortiFones by name or number. Please note that this feature
works on top of HTTP protocol which is disabled by default in
system interface settings. If you want to use this feature,
enable HTTP under System > Network > Network.
If you select Line Appearance, the peer office will appear in
the Resource field. Line appearance for peer office is to monitor
analog lines connected through FXO gateway.
Manual Configuration
If you select Manual configuration mode, edit the phone
configuration file.
3. Click Create.
Configuring LDAP profiles
The LDAP submenu lets you configure LDAP profiles which can query LDAP servers for
authentication.
Before using an LDAP profile, verify each LDAP query and connectivity with your LDAP server.
When LDAP queries do not match with the server’s schema and/or contents, unintended phone
call processing behaviors can result.
LDAP profiles each contains one or more queries that retrieve specific configuration data, such
as user groups, from an LDAP server. The LDAP profile list indicates which queries you have
enabled in each LDAP profile.
To view the list of LDAP profiles, go to Phone System > Profiles > LDAP.
GUI field
Description
Clone
Click the row corresponding to the profile whose settings you want
to duplicate when creating the new profile, then click Clone. A
single-field dialog appears. Enter a name for the new profile. Click
OK.
Profile Name
The name of the profile.
Fortinet Technologies Inc.
Page 126
FortiVoice Phone System 5.3.0 Administration Guide
Server
The domain name or IP address of the LDAP server.
Port
The listening port of the LDAP server.
Auth
Indicates whether User Authentication Options is enabled.
Cache
Indicates whether query result caching is enabled.
(Green dot in column
heading)
Indicates whether the entry is currently referred to by another item in
the configuration. If another item is using this entry, a red dot
appears in this column, and the entry cannot be deleted.
You can add an LDAP profile to define a set of queries that the FortiVoice unit can use with an
LDAP server. You might create more than one LDAP profile if, for example, you have more than
one LDAP server, or you want to configure multiple, separate query sets for the same LDAP
server.
After you have created an LDAP profile, LDAP profile options will appear in other areas of the
FortiVoice unit’s configuration. These options let you to select the LDAP profile where you might
otherwise create a reference to a configuration item stored locally on the FortiVoice unit itself.
These other configuration areas will only allow you to select applicable LDAP profiles — that is,
those LDAP profiles in which you have enabled the query required by that feature. For example,
if a feature requires a definition of user groups, you can select only from those LDAP profiles
where Group Query Options are enabled.
To configure an LDAP profile
1. Go to Phone System > Profiles > LDAP.
2. Click New to add a profile or double-click a profile to modify it.
GUI field
Description
Profile name
For a new profile, enter its name.
Server name/IP
Enter the fully qualified domain name (FQDN) or IP address of the
LDAP server.
Port: Enter the port number where the LDAP server listens.
The default port number varies by your selection in Use secure
connection: port 389 is typically used for non-secure connections,
and port 636 is typically used for SSL-secured (LDAPS) connections.
Fallback server
name/IP
Optional. Enter the fully qualified domain name (FQDN) or IP address
of an alternate LDAP server that the FortiVoice unit can query if the
primary LDAP server is unreachable.
Port: Enter the port number where the fallback LDAP server listens.
The default port number varies by your selection in Use secure
connection: port 389 is typically used for non-secure connections,
and port 636 is typically used for SSL-secured (LDAPS) connections.
Fortinet Technologies Inc.
Page 127
FortiVoice Phone System 5.3.0 Administration Guide
Use secure
connection
Select whether to connect to the LDAP servers using an encrypted
connection.
• none: Use a non-secure connection.
• SSL: Use an SSL-secured (LDAPS) connection.
Click Test LDAP Query to test the connection. A pop-up window
appears. For details, see “Testing LDAP profile queries” on
page 130.
Base DN
Enter the distinguished name (DN) of the part of the LDAP directory
tree within which the FortiVoice unit will search for user objects, such
as ou=People,dc=example,dc=com.
User objects should be child nodes of this location.
Bind DN
Enter the bind DN, such as
cn=FortiVoiceA,dc=example,dc=com, of an LDAP user
account with permissions to query the Base DN.
This field may be optional if your LDAP server does not require the
FortiVoice unit to authenticate when performing queries.
Bind password
Enter the password of the Bind DN.
Click Browse to locate the LDAP directory from the location that you
specified in Base DN, or, if you have not yet entered a Base DN,
beginning from the root of the LDAP directory tree.
Browsing the LDAP tree can be useful if you need to locate your
Base DN, or need to look up attribute names. For example, if the
Base DN is unknown, browsing can help you to locate it.
Before using, first configure Server name/IP, Use secure connection,
Bind DN, Bind password, and Protocol version, then click Create or
OK. These fields provide minimum information required to establish
the directory browsing connection.
3. Configure the following sections:
• “Configuring authentication options” on page 128
• “Configuring advanced options” on page 129
4. Click Create, OK or Apply.
The LDAP profile appears in the LDAP profile list. To apply it, select the profile in features
that support LDAP queries, such as protected domains and policies.
Before using the LDAP profile in other areas of the configuration, verify the configuration of
each query that you have enabled in the LDAP profile. Incorrect query configuration can
result in unexpected phone processing behavior. For information on testing queries, see
“Testing LDAP profile queries” on page 130.
Configuring authentication options
The following procedure is part of the LDAP profile configuration process. For general
procedures about how to configure an LDAP profile, see “Configuring LDAP profiles” on
page 126.
1. Go to Phone System > Profiles > LDAP.
2. Click New to create a new profile or double click on an existing profile to edit it.
3. Click the arrow to expand the User Authentication Options section.
Fortinet Technologies Inc.
Page 128
FortiVoice Phone System 5.3.0 Administration Guide
4. Configure the following:
GUI field
Description
Try common name
with base DN as
bind DN
Select to form the user’s bind DN by prepending a common name to
the base DN. Also enter the name of the user objects’ common
name attribute, such as cn or uid into the field.
Search user and try Select to form the user’s bind DN by using the DN retrieved for that
bind DN
user by configuring the following:
• Schema: If your LDAP directory’s user objects use a common
schema style:
• InetOrgPerson
• Active Directory
Select the schema style. This automatically configures the query
string to match that schema style.
If your LDAP server uses any other schema style, select User
Defined, then manually configure the query string.
• LDAP user query: Enter an LDAP query filter that selects a set of
user objects from the LDAP directory.
The query string filters the result set, and should be based upon
any attributes that are common to all user objects but also
exclude non-user objects.
For example, if user objects in your directory have two
distinguishing characteristics, their objectClass and
extension attributes, the query filter might be:
(& (objectClass=inetOrgPerson) (telephonenumber=$u))
where $u is the FortiVoice variable for a user's extension.
This option is preconfigured and read-only if you have selected
from Schema any schema style other than User Defined.
• Scope: Select which level of depth to query, starting from
Base DN.
• One level: Query only the one level directly below the Base DN
in the LDAP directory tree.
• Subtree: Query recursively all levels below the Base DN in the
LDAP directory tree.
• Derefer: Select the method to use, if any, when dereferencing
attributes whose values are references.
• Never: Do not dereference.
• Always: Always dereference.
• Search: Dereference only when searching.
• Find: Dereference only when finding the base search object.
Configuring advanced options
The following procedure is part of the LDAP profile configuration process. For general
procedures about how to configure an LDAP profile, see “Configuring LDAP profiles” on
page 126.
1. Go to Phone System > Profiles > LDAP.
Fortinet Technologies Inc.
Page 129
FortiVoice Phone System 5.3.0 Administration Guide
2. Click New to create a new profile or double click on an existing profile to edit it.
3. Click the arrow to expand the Advanced Options section.
4. Configure the following:
GUI field
Description
Timeout (seconds)
Enter the maximum amount of time in seconds that the FortiVoice
unit will wait for query responses from the LDAP server.
Protocol version
Select the LDAP protocol version used by the LDAP server.
Enable cache
Enable to cache LDAP query results.
Caching LDAP queries can introduce a delay between when you
update LDAP directory information and when the FortiVoice unit
begins using that new information, but also has the benefit of
reducing the amount of LDAP network traffic associated with
frequent queries for information that does not change frequently.
If this option is enabled but queries are not being cached, inspect
the value of TTL. Entering a TTL value of 0 effectively disables
caching.
TTL (minutes)
Enter the amount of time, in minutes, that the FortiVoice unit will
cache query results. After the TTL has elapsed, cached results
expire, and any subsequent request for that information causes the
FortiVoice unit to query the LDAP server, refreshing the cache.
The default TTL value is 1440 minutes (one day). The maximum
value is 10080 minutes (one week). Entering a value of 0 effectively
disables caching.
This option is applicable only if Enable cache is enabled.
Enable user
password change
Enable if you want to allow FortiVoice web portal users to change
their password.
Password schema
Select your LDAP server’s user schema style, either OpenLDAP or
Active Directory.
Testing LDAP profile queries
After you have created an LDAP profile, you should test each enabled query in the LDAP profile
to verify that the FortiVoice unit can connect to the LDAP server, that the LDAP directory
contains the required attributes and values, and that the query configuration is correct.
When testing a query in an LDAP profile, you may encounter error messages that indicate failure
of the query and how to fix the problem.
To verify user authentication options
1. Go to Phone System > Profiles > LDAP.
2. Double-click the LDAP profile whosequery you want to test.
3. Click Test LDAP Query.
4. A pop-up window appears allowing you to test the query.
5. From Select query type, select Authentication.
6. In User name, enter the user name or extension of a user on the LDAP server, such as jdoe
or 1234, depending your selection of User Authentication Options.
Fortinet Technologies Inc.
Page 130
FortiVoice Phone System 5.3.0 Administration Guide
7. In Password, enter the current password for that user.
8. Click Test.
The FortiVoice unit performs the query, and displays either success or failure for each
operation in the query, such as the search to locate the user record, or binding to
authenticate the user.
Clearing the LDAP profile cache
You can clear the FortiVoice unit’s cache of query results for any LDAP profile.
This may be useful after, for example, you have updated parts of your LDAP directory that are
used by that LDAP profile, and you want the FortiVoice unit to discard outdated cached query
results and reflect changes to the LDAP directory. After the cache is emptied, any subsequent
request for information from that LDAP profile causes the FortiVoice unit to query the updated
LDAP server, refreshing the cache.
To clear the LDAP query cache
1. Go to Phone System > Profiles > LDAP.
2. Double-click the LDAP profile whose query cache you want to clear.
3. Click Test LDAP Query.
4. From Select query type, select Clear Cache.
A warning appears at the bottom of the window, notifying you that the cache for this LDAP
profile will be cleared if you proceed. All queries will therefore be new again, resulting in
decreased performance until the query results are again cached.
5. Click Ok.
The FortiVoice unit empties cached LDAP query responses associated with that LDAP
profile.
Configuring user privileges
A user privilege includes a collection of phone services and restrictions that can be applied to
each extension user.
For more information, see “Configuring user privileges” on page 239.
Configuring location profile
Location profiles group phones into internal and external numbers based on their locations.
The external and internal profiles are system defined and can be modified but not be deleted.
To configure a location profile
1. Go to Phone System > Profiles > Location.
2. Click New and configure the following:
Fortinet Technologies Inc.
GUI field
Description
Name
For a new profile, enter its name.
Type
Select the profile type: internal or external phones.
Page 131
FortiVoice Phone System 5.3.0 Administration Guide
Emergency Enter the caller ID to display on the destination phone when you dial the
caller ID
emergency number, such as 911.
If an extension in this profile already has an emergency caller ID, this ID is
overridden by the extension’s own ID. See “Emergency caller ID” on
page 157.
Members
Select the extensions to include in the profile.
Phone
provision
protocol
Select the protocol used by the phones to get configuration file from the
FortiVoice unit.
Description Enter any notes you have for this profile.
Emergency Configure to send an alert email when an emergency call is made.
setting
Select Do nothing if you don’t want the FortiVoice unit to send an alert email.
Otherwise, select Send alert email and enter the email address.
Contact
Enter the contact information for the profile.
Information
3. Click Create.
Scheduling the FortiVoice unit
You can schedule the FortiVoice operation time and use the schedules when configuring dial
plans, virtual numbers, or call management. The default schedules, namely after_hour,
any_time, business_hour, and holiday, can be modified but cannot be deleted.
Depending on your preference, you can create either a standard or a calendar-based schedule.
For information on dial plan, see “Configuring Call Routing” on page 189.
For information on virtual numbers, see “Working with virtual numbers” on page 172.
For information on call management, see “Setting extension user preferences” on page 156.
To configure a standard schedule
1. Go to Phone System > Profiles > Schedule and click New.
2. Enter a profile name and select Standard for Mode.
3. Click Create.
4. In the schedule list, select the profile name you created.
5. For Week Day, select the days to include in the schedule and set the AM and PM time or
select Full Day.
6. For Holiday, click New to set the holidays. For example, select 01/01/12 in the Date field and
enter New Year’s Day in the Description field, and click Create.
7. Click OK.
To configure a calendar-based schedule
1. Go to Phone System > Profiles > Schedule and click New.
2. Enter a profile name and select Calendar for Mode.
3. Click Create.
4. In the schedule list, select the profile name you created.
5. Double-click a date to schedule an event.
Fortinet Technologies Inc.
Page 132
FortiVoice Phone System 5.3.0 Administration Guide
6. Click OK.
Configuring FortiFone 870i
Each base FortiFone 870i can support up to 15 handsets. You can configure a FortiFone 870i to
work with the FortiVoice unit by adding a primary phone (base) and multiple secondary phones
(bases). For detailed information, see FortiFone 870i Multi-Cell Deployment with FortiVoice
Enterprise Technical Note.
The following prerequisites must be met for the configuration to work:
• FortiVoice v5.0 build 136 or later
• FortiVoice auto provisioning is enabled (see “Configuring SIP phone auto-provisioning” on
page 112)
• FortiFone 870i firmware 3.23 or later
• Network connectivity available between FortiFone870i and the FortiVoice unit
Follow the FortiFone 870i guide and the technical note to configure the phone first. Once you
connect the phone to the network, you can configure it on the FortiVoice unit.
To configure the FortiFone 870i
1. Go to Status > Phone System > Unassigned Phone and find the MAC address of the
intended primary station.
2. Select the intended primary station, click Action, and select Assign to FortiFone-870i device.
3. In Device role, set the station as primary with chain ID. The chain ID should be numbers up
to 5 digits. Type any description as needed. Then click Create.
4. Go to Phone System > Device > FortiFone-870i to add extensions to the primary station.
Note that we only need to add the extension configuration to the primary. All secondary
stations can obtain the extension information from the primary.
5. Select the primary station just created, click Action, and select Assign new extension or
Apply existing extension.
6. For Assign new extension, configure the extension information and enter Handset ID which
should start with 1. Leave Base MAC address field empty and click Create.
7. Add more extensions as needed with a different handset IDs. Upon completion, you should
see all the extensions listed for the primary station.
8. Since the primary station is provisioned now, we can proceed to provision the secondary
stations. Factory reset the intended secondary station and connect it to the network. If the
network and the FortiVoice unit are configured properly, it should appear under Status >
Phone System > Unassigned Phone.
9. Select the unassigned FortiFone 870i station, click Action > Assign to FortiFone-870i device.
10.In Device role, set the base station as secondary and select Prime (primarystation) from the
drop down list. Type any description as needed.
11.Click Create.
12.On the secondary phone configuration, remove the temporary extension setting and reboot
the station. See the phone guide for more information.
Note that the temporary extension is used for initial configuration of the base and has to be
removed for the phone to work with the FortiVoice unit.
Fortinet Technologies Inc.
Page 133
FortiVoice Phone System 5.3.0 Administration Guide
Reviewing system configuration
Phone System > Review provides a snapshot of the FortiVoice system configuration, including:
• extension numbers
• extension numbers in conflict (Conflicting numbers happen when the number assigned to an
extension conflict with the same number used for other purposes, such as call parking,
conference, or ring groups.)
• phone MAC addresses in conflict
• extension password check
• new voice mail check
• network summary
• DID handling information
• Call queues
• Agent information
• Extensions that are used by other objects and their roles in the objects
• Phone firmware and configuration upgrade status. See “Reviewing phone management” on
page 134.
Except Phone Management, you can double click a record to modify or view the information.
Reviewing phone management
Phone System > Review > Phone Management displays the status of phone upgrade tasks. For
information on phone upgrade tasks, see “Maintaining phones” on page 104.
GUI field
Description
Job
Select the phone upgrade job to list the extension information
associated with the job.
Job status
Select the phone upgrade job status to list the extension information
associated with the job.
• All: Extensions with all job status are listed.
• Waiting: The upgrade job is being implemented.
• Require information: The FortiVoice unit needs information from
the extension for the upgrade.
• Notify for information: The FortiVoice unit sends a request to the
extension for any missing information needed for the upgrade.
• Ready: The extension reboots and is ready to be upgraded.
• Notified: The extension received the request for information.
• Confirmed: Extension configuration upgrade is completed.
• Firmware confirmed: Extension firmware upgrade is completed.
When doing an upgrade job, some extensions may get stuck in a
status and cannot complete the job. You may need to identify the
extensions and check them for any issues that prevent them from
completing the upgrade job.
Redo
Fortinet Technologies Inc.
Select an extension and click this option to reinitiate the upgrade.
For details, see “Maintaining phones” on page 104.
Page 134
FortiVoice Phone System 5.3.0 Administration Guide
Fortinet Technologies Inc.
Page 135
FortiVoice Phone System 5.3.0 Administration Guide
Configuring Extensions
The Extensions menu lets you configure local and remote extensions, virtual numbers, and
extension department.
This topic includes:
• Setting up local extensions
• Creating extension groups
• Setting up general voice mailboxes
• Working with virtual numbers
Setting up local extensions
You can configure IP phone extensions, edit analog extension, and choose extension
preferences.
This topic includes:
• Configuring IP extensions
• Modifying analog extension (200D-T, 1000E-T, and 20E2 models only)
• Setting up remote extensions
• Configuring fax extensions
• Setting extension user preferences
• Resetting voice messages
Configuring IP extensions
An IP extension is an IP phone connected through a network to a system. An internal IP
extension is a phone connected on the same LAN as the system. An external IP extension is a
phone connected outside the LAN.
To view the local IP extensions, go to Extensions > Extensions > IP Extensions.
GUI field
Description
Batch Edit
If you want to apply the same changes to multiple extensions, select the
extensions and click this option. Make the changes and click Apply To
All.
Export
Select to save a copy of the extension list in CSV format.
Import
Select to upload a copy of the extension list in CSV format. For details,
see “Importing a list of extensions” on page 144.
Save
Click an extension’s Display name or Phone Type to modify them and
click this button to save the changes.
Fortinet Technologies Inc.
Page 136
FortiVoice Phone System 5.3.0 Administration Guide
Other actions
• Apply phone configuration: If you have edited an extension
configuration and want to apply it to the phone associated with this
extension, select the extension and click this option.
The selected phones will reboot and only the phones that meet the
following conditions will receive the new configuration:
• Phones supported by and registered to the FortiVoice unit. For
the list of supported phones and auto provisioning prerequisites,
see “Configuring SIP phone auto-provisioning” on page 112.
• Phone type and MAC address is correctly configured. See “To
create or edit an IP extension” on page 138.
• Auto-provisioning is enabled for the extension associated with
the phone through the user privilege applied to it. See
“Configuring user privileges” on page 239.
• Maintenance: Select an extension and click this button to manage a
user’s voicemail box. You can check the size of the box and empty
the box.
Click Back to return to the SIP tab.
• View phone configuration file: Select a FortiFone extension and click
this option to view the phone’s configuration file.
When a phone is associated with an extension, the FortiVoice unit
generates a configuration file for the phone. For details, see “To
create or edit an IP extension” on page 138.
• Check the password strength of SIP accounts: See “Auditing SIP
extension password” on page 143.
• Number auditor: Select to fix duplicate or missing numbers. See
“Fixing duplicate or missing numbers” on page 143.
• Download programmable phone key labels: If you need a copy of the
programmable phone key labels of your users, select All extensions
or Selected extensions, click Yes and then open or save the file.
Enabled
Select to activate an extension.
Number
The extension number.
Display Name
The name displaying on the extension. This is usually the name of the
extension user.
Status
The extension statuses, including:
• Idle: The extension is not in use.
• In Use: The extension is in use.
• Busy: The extension is busy.
• Ringing: The extension is ringing.
• On Hold: The extension has an on-hold call.
• Admin down: The trunk of the extension is disabled
• Not registered: The extension is not registered with the FortiVoice
unit and is not in service.
• Unavailable: The extension is not reachable.
• Alarm detected: There is a problem with the phone line.
• Other: The status other than the above.
Fortinet Technologies Inc.
Page 137
FortiVoice Phone System 5.3.0 Administration Guide
IP
The link to the IP address of the phone using the extension number. See
“IP” on page 143.
Department
The link to the department of which this extension is a member.
For information on creating departments, see “Creating extension
departments” on page 166.
Disk Usage (KB)
Displays the size of disk space used by voicemails for the user in
kilobytes (KB).
Phone Type
The type of phone for this extension.
Phone Profile
Displays the phone profile applied to the user. For information on phone
profile, see “Configuring phone profiles” on page 123.
Phone Info
The model of the phone for this extension.
To create or edit an IP extension
1. Go to Extensions > Extensions > IP Extensions.
2. Click New or double-click an existing extension.
3. Configure the following:
GUI field
Description
Extension Setting
Number
Enter the extension number following the extension number
pattern. See “Configuring PBX options” on page 107.
Show suggested
numbers
Select and click in the Number field to display the extension
numbers available for use. If it is deselected, clicking in the
Number field displays the extension numbers already in use.
This option also serves as a diagnostic tool for finding and
fixing duplicate or missing numbers. Missing numbers are the
extensions that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can
click the icon and fix the numbers. For more information, see
“Fixing duplicate or missing numbers” on page 143.
User ID
This is the system-generated ID based on the user ID prefix
you set (see “User ID prefix” on page 109) and the extension
number.
This option is view only and only appears when you edit an
extension. You can add a new user ID through the CLI. For
more information, see the FortiVoice CLI Reference.
Fortinet Technologies Inc.
Enabled
Select to activate the extension.
Display name
Enter the name displaying on the extension. This is usually the
name of the extension user.
Page 138
FortiVoice Phone System 5.3.0 Administration Guide
External caller ID
If you want to display a particular caller ID on a called phone
instead of the FortiVoice main number (see “Main number” on
page 107) or the trunk phone number (see “Phone Number”
on page 179), enter it here. The format must be name<phone
number>, such as HR<2221111234>.
If this extension is mapped to a DID number and the
Outbound option is also selected in DID mapping
configuration, the external caller ID entry has priority. For
information on DID mapping, see “Mapping DIDs” on
page 193.
SIP password
Password policy warnings may appear above this field
depending on your password/PIN policy configuration. You
can click the warning notice to configure the policy. For
details, see “Configuring system options” on page 81.
Enter the password used for configuring your SIP phone from
the phone or the Web. You need the phone's IP to access it
from the Web.
Click Generate to generate a strong password automatically.
Select View password to display the password. This option is
only available when you edit an extension.
If you have configured the default SIP user password (see
“Default SIP user password” on page 109), the password
appears here. However, you can change it.
User PIN
Enter the password for the extension user to access voicemail
and the user web portal.
Click Generate to generate a strong password automatically.
Select View PIN to display the password. This option is only
available when you edit an extension.
If you have configured the default user PIN (see “Default user
PIN” on page 109), the password appears here. However, you
can change it.
Authentication type Select the extension’s authentication type: Local or LDAP.
LDAP profile
If you select LDAP for Authentication type, select an LDAP
profile to apply to this extension. For information on LDAP
profile, see “Configuring LDAP profiles” on page 126.
You can click New to create a new profile or Edit to modify the
selected one.
Authentication ID
If you select Try common name with base DN as bind DN as
the user authentication option in the authentication profile you
select, enter the authentication ID based on the user objects’
common name attribute you entered in the Common name ID
field of the profile, such as jdoe.
If you select Search user and try bind DN as the user
authentication option in the authentication profile you select,
leave this field blank.
This option is only available if you select LDAP for
Authentication type.
Fortinet Technologies Inc.
Page 139
FortiVoice Phone System 5.3.0 Administration Guide
Phone language
Select the voice prompts for the extension, such as auto
attendant and voicemail. The default is English.
For information on adding prompt languages, see “Adding
prompt languages” on page 114.
Preference
Select Edit preference to configure the extension user
preferences. See “Setting extension user preferences” on
page 156.
This option is only available when you edit an extension.
Description
Enter any notes for the extension setting.
Advanced Setting
Location
Select Internal if the extension does not traverse through
Network Address Translation (NAT) to connect to the
FortiVoice unit, and External if the extension does. These are
system defined locations.
You can also choose other customized locations.
SIP setting
Select the SIP profile for the extension. Click Edit to modify
the current profile or New to configure a new one. For more
information, see “Working with FortiVoice profiles” on
page 120.
User privilege
Select the services for the extension. Click Edit to modify the
current user privilege or click New to configure a new one. For
more information on user privilege, see “Configuring user
privileges” on page 239.
Personal code
Enter the extension specific account code that can be used to
restrict calls. You can click Generate to get a code.
Department
Select the department that the extension belongs to. Click
Edit to modify the current department or click New to
configure a new one. For more information on extension
department, see “Configuring agents” on page 209.
Phone type
Select a supported phone type for the extension.
If you cannot find your phone type in the list, select Generic.
This phone will not receive the PBX setup information from the
FortiVoice unit.
When you edit an extension assigned to a phone that does
not match what you entered in this field, an orange
exclamation mark icon appears. Clicking this icon enters the
actual phone type into this field.
If you select FortiFone-870i and want it to join the multi-cell
configuration, select Multi-Cell. For more information, see
“Configuring FortiFone 870i” on page 133.
Fortinet Technologies Inc.
Page 140
FortiVoice Phone System 5.3.0 Administration Guide
MAC address
Enter the MAC address of the SIP phone using the extension
number. This option does not apply to
FortiFone-850i/860i/870i.
When you edit an extension assigned to a FortiFone that does
not match what you entered in the Phone type field, an orange
exclamation mark icon appears. Clicking this icon enters the
FortiFone into the Phone type field. An orange exclamation
mark icon also appears beside the MAC address field.
Clicking this icon enters the FortiFone MAC address into the
MAC address field.
Base MAC address If your Phone type is FortiFone-850i/860i/870i, enter the MAC
address of the base supporting the handsets.
When you edit an extension assigned to a FortiFone that does
not match what you entered in the Phone type field, an orange
exclamation mark icon appears. Clicking this icon enters the
FortiFone into the Phone type field. An orange exclamation
mark icon also appears beside the Base MAC address field.
Clicking this icon enters the base MAC address into the field.
Handset ID
If your Phone type is FortiFone-850i/860i/870i, you can enter
the handset ID range (1-8) because these models support
multiple handset and each handset is assigned an extension
number.
Phone profile
Select a profile type if your phone type is FortiFone 260i and
above:
• Admin defined: This type allows you to choose a system
level phone profile. You can also create a new profile or
modify the selected one.
• User defined: This type allows phone users to set the
programmable phone keys on the user web portal when
the profile is applied to their extensions. There is no need
to choose a profile.
Select an Admin defined profile if your phone type is other
than FortiFone 260i and above. You can also create a new
profile or modify the selected one.
For details on phone profiles, see “Configuring phone
profiles” on page 123.
The phone profile settings you select here synchronize with
the same settings in extension preferences. For details, see
“Phone profile” on page 162.
Configure User
Defined Profile
This option is only available if you select the User defined
profile type, save the extension configuration and re-open the
extension.
Click to configure the user defined phone profile. For details,
see “Configuring phone profiles” on page 123.
Fortinet Technologies Inc.
Page 141
FortiVoice Phone System 5.3.0 Administration Guide
Auxiliary device
This option is only available when you edit an extension.
Click to add SIP devices to the extension. This is known as
SIP forking.
SIP forking allows you to have your desk phone ring at the
same time as your softphone or a SIP phone on your mobile.
For example, you can use SIP forking to ring your desk phone
and your Android SIP phone at the same time, allowing you to
take the call from either device easily. No forwarding rules
would be necessary as both devices would ring. In the same
manner, SIP forking can be used in an office and allow the
secretary to answer calls to the extension of his/her boss
when he is away or unable to take the call.
For more information, see “Configuring SIP forking” on
page 144.
Other accounts
This option is only available when you edit an extension.
Click to add the extension to another PBX. Enter the PBX
information and click OK.
Call Center
Agent
Enable or disable this extension as a call center agent. For
more information about call center agents, see “Setting up a
Call Center” on page 200.
Configure
If you enabled the agent, click to configure it. For more
information, see “Configuring call center agent” on page 146.
Voice Mailbox
Configure the extension’s voice mailbox.
In some cases, you may want other users or groups to share
this voice mailbox. For example, a supervisor wants his/her
co-workers to access his/her voice mailbox while he/she is
away.
Main voice mailbox Select the extension’s own voice mailbox (Default) or that of
another extension as the voice mailbox of this extension.
Typically, you use the default mailbox.
If you select the voice mailbox of another extension, you can
click Edit to modify that extension.
Notify message
waiting light to
You can let the FortiVoice unit turn on the message waiting
light on the phones of a user or user group if you want to
notify the user or group of a new voice message stored in the
voice mailbox associated with this extension.
To notify a user or user group, click User(s)/Group(s) and
select the users/groups from the Available field and click -> to
move them to the Selected field.
To listen to the message after being notified, the user can dial
*97 or the code you set (see “Modifying feature access
codes” on page 266) and enter the user’s own voicemail PIN.
For information on creating user groups, see “Creating
extension groups” on page 165.
Fortinet Technologies Inc.
Page 142
FortiVoice Phone System 5.3.0 Administration Guide
Extra Information
IP
This option is only available when you edit an extension.
The link to the IP address of the phone using the extension
number. This address is retrieved from a SIP phone after it is
registered with the FortiVoice unit. Clicking the link opens the
login page of the web interface of the phone. You need the
user name and password of the phone to log in.
4. Click Create (for new extension) or OK (for editing extension).
Auditing SIP extension password
You can verify the strength of SIP extension passwords. For information on setting SIP
extension password, see “Configuring IP extensions” on page 136.
To audit a SIP extension password
1. Go to Extensions > Extensions > IP Extensions.
2. Under Other actions, click Check the password strength of SIP accounts.
The Audit SIP Passwords page opens.
3. If a password policy warning appears, click the warning to view the password policy. To set
the policy, see “Configuring system options” on page 81.
4. If the Password Strength of an extension shows the Weak or Very weak icon, you can click
the password and change it based on the policy until the Password Strength shows the
Strong icon.
5. Click Save.
To modify the configuration of an extension
1. Go to Extensions > Extensions > IP Extensions.
2. Under Other actions, click Check the password strength of SIP accounts.
The Audit SIP Passwords page opens.
3. Select the extension that you want to modify.
4. Click Edit and follow the steps in “To create or edit an IP extension” on page 138.
Fixing duplicate or missing numbers
When there are duplicate or missing extensions, an orange exclamation mark icon appears
beside Show suggested numbers. You can click the icon and fix the numbers.
Duplicate numbers occur when there are more than one extension with the same number.
Missing numbers happen when you create an extension without assigning it a number. This
rarely happens and can only be done through the CLI.
For information on the Show suggested numbers field, see “Show suggested numbers” on
page 173.
To fix duplicate or missing numbers
1. On any page that has Show suggested numbers, click the orange exclamation mark icon
beside it.
The Numbers Auditor page displays.
Fortinet Technologies Inc.
Page 143
FortiVoice Phone System 5.3.0 Administration Guide
2. To fix a duplicate number:
• Click the Duplicate Number sub-menu.
• Click the duplicate number’s user ID (duplicate object) you want to remove. The duplicate
number’s configuration page displays.
• Remove the duplicate number in the Number field and click OK. For information on
configuring extensions, see “Setting up local extensions” on page 136.
3. To fix a missing number:
• Click the Missing Number submenu.
• Double-click a missing number. The missing number’s configuration page displays.
• Enter an extension number in the Number field and click OK. For information on
configuring extensions, see “Setting up local extensions” on page 136.
4. Close the Numbers Auditor page.
Importing a list of extensions
The import feature provides a simple way to add a list of new extensions in one operation. You
can create a CSV file in any spreadsheet and import the data as long as the columns match the
FortiVoice format.
Your CSV file must have a headline containing the column names such as User ID, Extension,
Display name, Phone type, Mac address, and Phone profile. Otherwise, the import will fail.
To import extension records
1. On the IP Extensions tab, click Import.
The Import SIP extension from CSV file page opens.
2. Select Update existing extensions if you want to overwrite the existing extensions with the
matching imported records.
If you do not select this option, the uploaded extensions will be skipped if they already exist
on the FortiVoice unit.
3. Select The import CSV file contains ‘User ID’ field if you want to import extension records
with the User ID column.
4. Click Browse to locate the CSV file to import and click Open.
5. Optionally, click Download sample to see if the columns of your CSV file match those of the
FortiVoice format.
6. Click OK.
A field appears showing the percentage of import completion.
A dialog appears showing the number of imported records.
Configuring SIP forking
SIP forking allows you to have your desk phone ring at the same time as your softphone or a
SIP phone on your mobile.
When a device is added, it inherits your master phone’s user privileges except hot-desking and
fax.
You can add two SIP extensions and one external phone number.
Fortinet Technologies Inc.
Page 144
FortiVoice Phone System 5.3.0 Administration Guide
To add a SIP device
1. Go to Extensions > Extensions > IP Extensions.
2. Click an extension and go to Advanced Setting.
3. Click Auxiliary device to add a device.
4. Click New and configure the following:
GUI field
Description
Status
Select to enable the device.
Type
Select SIP for the type of device to add.
User ID
This is the system-generated ID based on the user ID prefix
you set (see “User ID prefix” on page 109) and the master
extension number.
This option is view only. You can add a new user ID through
the CLI. For more information, see the FortiVoice CLI
Reference.
Password
Password policy warnings may appear above this field
depending on your password/PIN policy configuration. You
can click the warning notice to configure the policy. For
details, see “Configuring system options” on page 81.
Enter the password used for configuring your SIP phone from
the phone or the Web. You need the phone's IP to access it
from the Web.
Click Generate to generate a strong password automatically.
Select View password to display the password. This option is
only available when you edit an extension.
If you have configured the default SIP user password (see
“Default SIP user password” on page 109), the password
appears here. However, you can change it.
Location
Designate the device as external, internal, or mobile. Click
Edit to modify the current location or New to configure a new
one.
SIP setting
Select the SIP profile for the device. Click Edit to modify the
current profile or New to configure a new one. For more
information, see “Working with FortiVoice profiles” on
page 120.
Phone type
Select a supported phone type for the extension.
If you cannot find your phone type in the list, select Generic.
This phone will not receive the PBX setup information from the
FortiVoice unit.
When you edit an extension assigned to a phone that does
not match what you entered in this field, an orange
exclamation mark icon appears. Clicking this icon enters the
actual phone type into this field.
MAC address
Fortinet Technologies Inc.
Enter the MAC address of the SIP device.
Page 145
FortiVoice Phone System 5.3.0 Administration Guide
5. Click Create.
To add an external phone number
1. Go to Extensions > Extensions > IP Extensions.
2. Click an extension and go to Advanced Setting.
3. Click Auxiliary device to add a device.
4. Click New.
5. Select Status to enable the device.
6. For Type, select Phone number.
7. Enter the external number.
8. Click Create.
Configuring call center agent
Configure the departments that a call center agent manages, queues that the agent belongs to,
skill sets, and skill levels. For more information on call center, see “Setting up a Call Center” on
page 200.
To configure an agent
1. Go to Extensions > Extensions > IP Extensions> Call Center.
2. Select Enable for Agent.
3. Click Configure and do the following:
GUI field
Description
Agent profile
Select the profile for the agent. You can also create a new one
or modify an existing one. For more information about agent
profiles, see “Configuring agent profiles” on page 220.
Managed departments
An agent manager may need to monitor call queues in certain
departments. For information on setting up departments, see
“Creating extension departments” on page 166.
Click >> to select the departments to be monitored and then
click Done.
Member of Queues
Click to select the call queues to join.
• Main/Outgoing queue: This option is for collecting the
outgoing calls from all queues by this agent and displaying
them in “Working with call queue statistics” on page 221.
You can select any queue of which this agent is a member
for that purpose except None which will not collect agent’s
outgoing call information.
• Queues: Select the queues of which you want the
extension/agent to be a member, and click Apply.
Skill Sets
Click New to select the skill set for the agent, including skill
and level, and click Create. For more information about agent
skills and levels, see “Adding agent skill sets” on page 218
and “Creating agent skill levels” on page 219.
4. Click OK.
Fortinet Technologies Inc.
Page 146
FortiVoice Phone System 5.3.0 Administration Guide
Modifying analog extension (200D-T, 1000E-T, and 20E2 models only)
The FortiVoice 200D-T and 1000E-T each has one analog port and a default analog extension.
The FortiVoice 20E2 has two analog ports and two default analog extensions.You can edit the
extensions’ default configuration.
Analog lines, also referred to as POTS (Plain Old Telephone Service), are used for standard
phones, fax machines, and modems.
To view the default analog extension, go to Extensions > Extensions > Analog Extensions.
GUI field
Description
Batch Edit
If you want to apply the same changes to multiple extensions, select the
extensions and click this option. Make the changes and click Apply To
All.
Maintenance
Select an extension and click this button to manage its voicemail box.
You can check the size of the box and empty the box.
Click Back to return to the Analog tab.
Enabled
Select to activate the extension.
User ID
This is the system-generated ID for the analog extension.
Number
The analog extension number.
Display Name
The name displaying on the extension.
Phone Type
The type of phone for this extension.
Disk Usage (KB)
Displays the size of disk space used by voicemails for the user in
kilobytes (KB).
To edit the default analog extension
1. Go to Extensions > Extensions > Analog Extensions.
2. Select the default extension and click Edit.
3. Configure the following:
Fortinet Technologies Inc.
Page 147
FortiVoice Phone System 5.3.0 Administration Guide
Figure 26: Analog extension configuration
GUI field
Description
Extension Setting
User ID
This is the system-generated ID for the extension and is
read-only.
Number
Enter the extension number following the extension number
pattern. See “Configuring PBX options” on page 107.
Show suggested
numbers
Select and click in the Number field to display the extension
numbers available for use. If it is deselected, clicking in the
Number field displays the extension numbers already in use.
This option also serves as a diagnostic tool for finding and
fixing duplicate or missing numbers. Missing numbers are
the extensions that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can
click the icon and fix the numbers. For more information, see
“Fixing duplicate or missing numbers” on page 143.
Fortinet Technologies Inc.
Enabled
Select to activate the extension.
Display name
Enter the name displaying on the extension. This is usually
the name of the extension user.
Page 148
FortiVoice Phone System 5.3.0 Administration Guide
External caller ID
If you want to display a particular caller ID on a called phone
instead of the FortiVoice main number (see “Main number”
on page 107) or the trunk phone number (see “Phone
Number” on page 179), enter it here. The format must be
name<phone number>, such as HR<2221111234>.
If this extension is mapped to a DID number and the
Outbound option is also selected in DID mapping
configuration, the external caller ID entry has priority. For
information on DID mapping, see “Mapping DIDs” on
page 193.
User PIN
Password policy warning icon may appear beside this field
depending on your password/PIN policy configuration. You
can click the warning icon to configure the policy. For
details, see “Configuring system options” on page 81.
Enter the password for the user to access voicemail (by
dialing *98 or the customized code. See “Modifying feature
access codes” on page 266) and the user web portal.
Click Generate to generate a strong password automatically.
Select View PIN to display the password.
If you have configured the default user PIN (see “Default
user PIN” on page 109), the password appears here.
However, you can change it.
Authentication type Select the extension’s authentication type: Local or LDAP.
LDAP profile
If you select LDAP for Authentication type, select an LDAP
profile to apply to this extension. For information on LDAP
profile, see “Configuring LDAP profiles” on page 126.
You can click New to create a new profile or Edit to modify
the selected one.
Authentication ID
If you select Try common name with base DN as bind DN as
the user authentication option in the authentication profile
you select, enter the authentication ID based on the user
objects’ common name attribute you entered in the
Common name ID field of the profile, such as jdoe.
If you select Search user and try bind DN as the user
authentication option in the authentication profile you select,
leave this field blank.
This option is only available if you select LDAP for
Authentication type.
Language
Select the prompt language for the FortiVoice unit. The
default is English.
This setting affects all of the FortiVoice unit’s voice prompts,
such as auto attendant and voicemail. However, if you
change the sound file for an individual component, such as
auto attendant, to use a different language, it will override
the default prompt language for this component.
For information on adding prompt languages, see “Adding
prompt languages” on page 114.
Fortinet Technologies Inc.
Page 149
FortiVoice Phone System 5.3.0 Administration Guide
Preference
Select Edit preference to configure the extension user
preferences. See “Setting extension user preferences” on
page 156.
Advanced Setting
User privilege
Select the services for the extension. Click Edit to modify
the current user privilege or click New to configure a new
one. For more information on user privileges, see
“Configuring user privileges” on page 239.
Department
Select the department that the extension belongs to. Click
Edit to modify the current department or click New to
configure a new one. For more information on extension
department, see “Creating extension departments” on
page 166.
Analog port
Enter the analog port number. By default, it is fxs1.
Enable fax
Select to activate facsimile function for the extension.
4. Click OK.
Setting up remote extensions
A remote extension reaches an external phone by automatically selecting a line from a trunk and
dialing the phone number. For example, a remote extension could reach an employee’s cell
phone or home phone, or a phone at a branch office.
A caller can connect to a remote extension through the auto attendant, or can be transferred to
a remote extension by a call cascade. A user at a local extension can manually transfer a caller
to a remote extension, or can dial a remote extension directly. If the remote extension is busy or
unanswered, the system can route the call using the remote extension’s call cascade.
For example, a caller reaches the auto attendant and dials a local extension. The user is not
there, so the call is unanswered. The call cascade of the local extension can be configured to
transfer unanswered calls to a remote extension. The remote extension can be configured to
dial the user’s cellular phone. This way the user is available outside the office.
Remote extensions are designed to operate with local major telephone service providers. The
feature may not function correctly with some telephone and mobile operator’s networks,
especially for international phone numbers and mobile phones roaming internationally.
To configure a remote extension
1. Go to Extensions > Extensions > Remote Extensions.
2. Click New.
3. Configure the following:
GUI field
Description
Extension Setting
Number
Fortinet Technologies Inc.
Enter the local extension number from which calls are transferred
to a remote extension.
Page 150
FortiVoice Phone System 5.3.0 Administration Guide
Show suggested
numbers
Select and click in the Number field to display the extension
numbers available for use. If it is deselected, clicking in the
Number field displays the extension numbers already in use.
This option also serves as a diagnostic tool for finding and fixing
duplicate or missing numbers. Missing numbers are the
extensions that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can click
the icon and fix the numbers. For more information, see “Fixing
duplicate or missing numbers” on page 143.
Remote number
Enter the remote phone number to which a call to the local
extension is transferred. You can enter digits 0–9, space, dash,
comma, # and *.
If you want to enter an auto attendant number followed by an
extension, you can use comma (,) or semicolon (;) to pause the
automatic dialing.
A comma pauses dialing for two seconds, for example,
1-123-222-1234, 5678#. In this case, once auto attendant
1-123-1234 is dialed, and after two seconds, extension 5678 is
automatically dialed.
A semicolon pauses dialing for one second, for example,
1-123-222-1234; 5678#. In this case, once auto attendant
1-123-1234 is dialed, and after one second, extension 5678 is
automatically dialed.
Enabled
Select to activate the remote extension.
Display name
The name displaying on the remote extension when a call is
transferred.
You can choose to display the name differently than the one you
entered here. See “Modifying caller IDs” on page 122.
External caller ID
If you want to display a particular caller ID on a called phone
instead of the FortiVoice main number (see “Main number” on
page 107) or the trunk phone number (see “Phone Number” on
page 179, enter it here. The format must be name<phone
number>, such as HR<2221111234>.
If this extension is mapped to a DID number and the Outbound
option is also selected in DID mapping configuration, the
external caller ID entry has priority. For information on DID
mapping, see “Mapping DIDs” on page 193.
Fortinet Technologies Inc.
Page 151
FortiVoice Phone System 5.3.0 Administration Guide
User PIN
Password policy warnings may appear above this field
depending on your password/PIN policy configuration. You can
click the warning notice to configure the policy. For details, see
“Configuring system options” on page 81.
Enter the password for the user to access voicemail (by dialing
*98 or the customized code. See “Modifying feature access
codes” on page 266) and the user web portal.
Click Generate to generate a strong password automatically.
Select View PIN to display the password. This option is only
available when you edit an extension.
If you have configured the default user PIN (see “Default user
PIN” on page 109), the password appears here. However, you
can change it.
Authentication type Select the extension’s authentication type: Local or LDAP.
LDAP profile
If you select LDAP for Authentication type, select an LDAP profile
to apply to this extension. For information on LDAP profile, see
“Configuring LDAP profiles” on page 126.
You can click New to create a new profile or Edit to modify the
selected one.
Authentication ID
If you select Try common name with base DN as bind DN as the
user authentication option in the authentication profile you
select, enter the authentication ID based on the user objects’
common name attribute you entered in the Common name ID
field of the profile, such as jdoe.
If you select Search user and try bind DN as the user
authentication option in the authentication profile you select,
leave this field blank.
This option is only available if you select LDAP for Authentication
type.
Description
Enter any notes you have for the extension.
Advanced Setting
Select a user privilege for the extension. For more information,
see “Configuring user privileges” on page 239.
Voice Mailbox
Configure the extension’s voice mailbox.
In some cases, you may want other users or groups to share this
voice mailbox. For example, a supervisor wants his/her
co-workers to access his/her voice mailbox while he/she is
away.
Main voice mailbox Select the extension’s own voice mailbox (Default) or that of
another extension as the voice mailbox of this extension.
Typically, you use the default mailbox.
If you select the voice mailbox of another extension, you can
click Edit to modify that extension.
Fortinet Technologies Inc.
Page 152
FortiVoice Phone System 5.3.0 Administration Guide
Notify message
waiting light to
You can let the FortiVoice unit turn on the message waiting light
on the phones of a user or user group if you want to notify the
user or group of a new voice message stored in the voice
mailbox associated with this extension.
To notify a user or user group, click User(s)/Group(s) and select
the users/groups from the Available field and click -> to move
them to the Selected field.
To listen to the message after being notified, the user can dial *97
or the code you set (see “Modifying feature access codes” on
page 266) and enter the user’s own voicemail PIN.
For information on creating user groups, see “Creating extension
groups” on page 165.
Search
Enter an extension and look for it in the User(s)/Group(s) fields.
4. Click Create.
Configuring fax extensions
If you want to continue using your fax machine with the VoIP phone system, connect the fax
machine to an adapter (such as OBIHAI OBi 200, Cisco SPA 112, or Grandstream HT 702) that
supports T38 first before connecting it to the FortiVoice unit. T38 is a protocol designed to allow
fax to travel over a VoIP network.
In this case, the fax machine is treated like an extension. The FortiVoice unit receives faxes and
relays them to the fax machine. Faxes sent from the fax machine will follow the fax sending dial
plans.
To use this option, you need to create and enable the fax extensions first. You then need to
configure the FortiVoice unit to receive and relay the faxes to the fax machine.
For information on fax configuration, see “Configuring fax” on page 257.
To view the list of fax extensions, go to Extensions > Extensions > Fax Extensions.
GUI field
Description
Enabled
Select to activate this fax extension.
Department
The department to which this extension belongs.
For information on creating departments, see “Creating extension
departments” on page 166.
Number
The fax extension number.
Display Name
The name displaying on the fax extension.
To create or edit a fax extension
1. Go to Extensions > Extensions > Fax Extensions.
2. Click New or double-click an existing extension.
3. Configure the following:
GUI field
Description
Extension Setting
Fortinet Technologies Inc.
Page 153
FortiVoice Phone System 5.3.0 Administration Guide
Number
Enter the extension number following the extension number
pattern. See “Configuring PBX options” on page 107.
Show suggested
numbers
Select and click in the Number field to display the extension
numbers available for use. If it is deselected, clicking in the
Number field displays the extension numbers already in use.
This option also serves as a diagnostic tool for finding and
fixing duplicate or missing numbers. Missing numbers are the
extensions that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can
click the icon and fix the numbers. For more information, see
“Fixing duplicate or missing numbers” on page 143.
User ID
This is the system-generated ID based on the user ID prefix
you set (see “User ID prefix” on page 109) and the extension
number.
This option is view only and only appears when you edit an
extension. You can add a new user ID through the CLI. For
more information, see the FortiVoice CLI Reference.
Enabled
Select to enable this extension to receive and send faxes that
support T38 protocol. This applies to using a fax machine
connected to the FortiVoice unit via an adapter that supports
T38 protocol. For more information, see “Configuring fax” on
page 257.
Display name
Enter the name displaying on the extension.
External caller ID
If you want to display a particular caller ID on a called phone
instead of the FortiVoice main number (see “Main number” on
page 107) or the trunk phone number (see “Phone Number”
on page 179), enter it here. The format must be name<phone
number>, such as HR<2221111234>.
If this extension is mapped to a DID number and the
Outbound option is also selected in DID mapping
configuration, the external caller ID entry has priority. For
information on DID mapping, see “Mapping DIDs” on
page 193.
SIP password
Password policy warnings may appear above this field
depending on your password/PIN policy configuration. You
can click the warning notice to configure the policy. For
details, see “Configuring system options” on page 81.
Enter the password used for configuring your SIP phone from
the phone or the Web. You need the phone's IP to access it
from the Web.
Click Generate to generate a strong password automatically.
Select View password to display the password. This option is
only available when you edit an extension.
If you have configured the default SIP user password (see
“Default SIP user password” on page 109), the password
appears here. However, you can change it.
Fortinet Technologies Inc.
Page 154
FortiVoice Phone System 5.3.0 Administration Guide
User PIN
Enter the password for the extension user to access voicemail
and the user web portal.
Click Generate to generate a strong password automatically.
Select View PIN to display the password. This option is only
available when you edit an extension.
If you have configured the default user PIN (see “Default user
PIN” on page 109), the password appears here. However, you
can change it.
Authentication type Select the extension’s authentication type: Local or LDAP.
LDAP profile
If you select LDAP for Authentication type, select an LDAP
profile to apply to this extension. For information on LDAP
profile, see “Configuring LDAP profiles” on page 126.
You can click New to create a new profile or Edit to modify the
selected one.
Authentication ID
If you select Try common name with base DN as bind DN as
the user authentication option in the authentication profile you
select, enter the authentication ID based on the user objects’
common name attribute you entered in the Common name ID
field of the profile, such as jdoe.
If you select Search user and try bind DN as the user
authentication option in the authentication profile you select,
leave this field blank.
This option is only available if you select LDAP for
Authentication type.
Phone language
Select the voice prompts for the extension, such as auto
attendant and voicemail. The default is English.
For information on adding prompt languages, see “Adding
prompt languages” on page 114.
Preference
Select Edit preference to configure the extension user
preferences. See “Setting extension user preferences” on
page 156.
This option is only available when you edit an extension.
Description
Enter any notes you have for the extension.
Advanced Setting
Fortinet Technologies Inc.
Location
Select Internal if the extension does not traverse through
Network Address Translation (NAT) to connect to the
FortiVoice unit, and External if the extension does.
SIP setting
Select the SIP profile for the extension. Click Edit to modify
the current profile or New to configure a new one. For more
information, see “Working with FortiVoice profiles” on
page 120.
Page 155
FortiVoice Phone System 5.3.0 Administration Guide
User privilege
Select the services for the extension. Click Edit to modify the
current user privilege or click New to configure a new one. For
more information on user privilege, see “Configuring user
privileges” on page 239.
Personal code
Enter the extension specific account code that can be used to
restrict faxes. You can click Generate to get a code.
Department
Select the department that the extension belongs to. Click
Edit to modify the current department or click New to
configure a new one. For more information on extension
department, see “Creating extension departments” on
page 166.
Phone type
Select a supported phone type for the extension.
If you cannot find your phone type in the list, select Generic.
This phone will not receive the PBX setup information from the
FortiVoice unit.
When you edit an extension assigned to a phone that does
not match what you entered in this field, an orange
exclamation mark icon appears. Clicking this icon enters the
actual phone type into this field.
MAC address
Extra Information
IP
Enter the MAC address of the adapter through which the fax
machine connects to the FortiVoice unit.
This option is only available when you edit an extension.
The link to the IP address of the fax adapter using the
extension number. This address is retrieved from the adapter
after it is registered with the FortiVoice unit. Clicking the link
opens the login page of the web interface of the adapter. You
need the user name and password of the adapter to log in.
4. Click Create (for new extension) or OK (for editing extension).
Setting extension user preferences
Each SIP and analog extension comes with its default user preferences, including voicemail
settings and phone display preference. You can modify these settings.
Phone users can modify the preferences on the web user portal.
To view the list of extensions, go to Extensions > Extensions > Preferences.
GUI field
Description
Maintenance
Select an extension and click this option to reset the user preferences to
the default values.
Number
The extension number.
User ID
The system-generated ID based on the extension number.
Display Name
The name displaying on the extension. This is usually the name of the
extension user.
Fortinet Technologies Inc.
Page 156
FortiVoice Phone System 5.3.0 Administration Guide
To edit extension user preferences
1. Go to Extensions > Extensions > Preferences.
2. Select an extension and click Edit.
3. Configure the following:
GUI field
Description
Voicemail Setting
User ID
This is the system-generated ID based on the extension
number. This is not editable. You can add a new user ID
through the CLI. For more information, see the FortiVoice CLI
Reference.
Number
The extension number. This is not editable.
Display name
Enter the name displaying on the extension. This is usually
the name of the extension user.
Emergency caller ID Enter the caller ID to display on the destination phone when
you dial the emergency number, such as 911.
If you also enter an external caller ID (see “External caller ID”
on page 157), that ID will not override the emergency caller ID
when dialing the emergency number.
If this extension is part of a phone group in a location profile
which also has an emergency caller ID, this ID overrides the
emergency caller ID in the location profile. See “Emergency
caller ID” on page 132.
External caller ID
The caller ID you want to display on a called phone instead of
the FortiVoice main number (see “Main number” on
page 107) or the trunk phone number (see “Phone Number”
on page 179). This is not editable.
For details, see “External caller ID” on page 139 and
“External caller ID” on page 149.
Fortinet Technologies Inc.
Ring duration
Enter the phone ringing duration in seconds before an
incoming call goes to voicemail.
Call forward
Select to forward phone calls and enter the phone number to
forward the calls. This function only works if call forwarding is
enabled in the extension’s user privilege. See “Configuring
user privileges” on page 239.
Call waiting
Select to enable call waiting. This function only works if call
waiting is enabled in the extension’s user privilege. See
“Configuring user privileges” on page 239.
Do not disturb
Select to enable DND. This function only works if DND is
enabled in the extension’s user privilege. See “Configuring
user privileges” on page 239.
Message waiting
indication
Select to enable phone indication that a message is received.
Page 157
FortiVoice Phone System 5.3.0 Administration Guide
Voicemail handling
(Caller press 0
during
announcement)
Select to enable reaching the operator by pressing 0 when
you hear the announcement of a callee’s voicemail.
Include caller id
number when
playing voicemail
message
Select to announce caller’s ID when playing the voicemail.
Include date and
Select to announce date and time when playing the
time when playing voicemail.
voicemail message
Notification Options
Voicemail
Select the type of email notification when this extension has a
voicemail:
• None: Do not send any notification.
• Simple: Send an email notification.
• With attachment: Send an email notification with the
voicemail attached.
Fax
Select the type of email notification when this extension has a
fax:
• None: Do not send any notification.
• Simple: Send an email notification.
• With attachment: Send an email notification with the fax
attached.
Fortinet Technologies Inc.
Missed call
Select On if you want to receive an email notification when an
incoming call is missed.
Email address
Enter the email address to which an email notification is sent.
Page 158
FortiVoice Phone System 5.3.0 Administration Guide
Voicemail Options
Configure greeting, unavailable, and busy messages.
Name: Your name of the voicemail. For example, John Doe.
• Standard: Use the system default name for the voicemail.
This will be the extension number.
• Personal: Use your own name for the voicemail.
• Click Call me to ring your extension and record a name
using the phone, such as your name or extension
number.
• Click Upload to import a name, such as your name or
extension number.
• Click Play to listen to a recorded name.
• Click Erase to delete a recorded name.
• Click Download to save a recorded name.
Greeting: Select the voicemail greeting mode and greeting
content.
• Standard: The system defined greeting.
• Simple: The customer-recorded greeting that applies to
any time except when the line is busy and extension is
unavailable.
• Scheduled: The customer-recorded greeting that comes
with a schedule.
• Conditional: The customer-recorded greeting that only
applies to occasions when the line is busy or extension is
unavailable.
• Audio file: Click to configure the greeting. This option is
only available when you select Simple, Scheduled or
Conditional.
• Click Call me to ring your extension and record a
message such as a greeting, unavailable, or busy
message using the phone. This applies to the Simple
and Scheduled modes.
• Click Upload to import a message such as a greeting,
unavailable, or busy message.
• Click Play to listen to a message such as a greeting,
unavailable, or busy message.
• Click Erase to delete a message such as a greeting,
unavailable, or busy message.
• Click Download to save a message such as a greeting,
unavailable, or busy message.
If you select Scheduled for Greeting, click New to add a
system schedule or create a new one. You can also add a
greeting which is the audio file you configured when clicking
Audio file.
The purpose of having a separate voicemail name file is for
occasions that you just want to change the name without
touching the greeting file.
Display Preference
Fortinet Technologies Inc.
Page 159
FortiVoice Phone System 5.3.0 Administration Guide
Default portal
Select the default user web portal interface.
If User portal is disabled, it means that the user portal
function in the user privilege for this extension is not enabled.
For more information, see “Configuring user privileges” on
page 239.
If Operator console is disabled, it means that the operator
mode function in the user privilege for this extension is not
enabled. For more information, see “Configuring user
privileges” on page 239.
If Agent console is disabled, it means that the extension
agent for this extension is not enabled. For more information,
see “Call Center” on page 142.
Phone language
Select the prompt language for the extension. The default is
English.
For information on adding prompt languages, see “Adding
prompt languages” on page 114.
Web language
Select the language for the FortiVoice user web portal.
Theme
Select the display theme for the FortiVoice user web portal.
Time zone
Select the time zone for the FortiVoice user web portal.
Idle timeout
Set the timeout for the FortiVoice user web portal.
Account Management
Click Change PIN number to change the password for
accessing the voice mailbox and the FortiVoice user web
portal.
Agent
PIN required to
login/logout from
phone
Select to enable an agent to log into/log out of a queue from
the extension using the user PIN.
PIN required to
pause/unpause
from phone
Select to enable an agent to pause/unpause a queue from
the extension using the user PIN. To pause means the agent
is not answering calls.
For information on feature access codes, see “Configuring
account codes” on page 243.
For information on feature access codes, see “Configuring
account codes” on page 243.
Auto-Pause after
agent login queue
Select to automatically put the agent in pause (not ready)
status after the agent logs into a queue. The agent can
unpause a queue to answer calls.
For information on feature access codes, see “Configuring
account codes” on page 243.
Fortinet Technologies Inc.
Page 160
FortiVoice Phone System 5.3.0 Administration Guide
Speed Dial Setting
Map a phone key to a phone number for speed dialing by
clicking Number and enter the phone number.
You can enter digits 0–9, space, dash, comma, # and *.
If you want to enter an auto attendant number followed by an
extension, you can use comma (,) or semicolon (;) to pause
the automatic dialing.
A comma pauses dialing for two seconds, for example,
1-123-222-1234, 5678#. In this case, once pressing the
speed dial code you set, auto attendant 1-123-1234 is
reached, and after two seconds, extension 5678 is
automatically dialed.
A semicolon pauses dialing for one second, for example,
1-123-222-1234; 5678#. In this case, once pressing the
speed dial code you set, auto attendant 1-123-1234 is
reached, and after one second, extension 5678 is
automatically dialed.
Follow Me
See “Configuring follow me settings” on page 163.
Black list
Click New to enter the phone number you want to block from
calling this extension.
This configuration serves as a profile for use in managing
calls. See “Handling calls” on page 163.
Call Handling
Retain original caller ID: Select to maintain the original caller's
identity when forwarding an inbound call.
Call screening: Select if you want the FortiVoice unit to
prompt callers for their names so that callees can identify the
callers before the connect to you.
Record caller name: By default, this option is selected when
you select Call screening. If you deselect this option, the
FortiVoice unit will not prompt callers for their names.
Instead, the FortiVoice unit will ring a callee’s phone but will
not connect to the caller. The callee is able to pick up the
phone and see the caller’s ID and decide whether to pick up
the call.
For more information, see “Handling calls” on page 163.
Fortinet Technologies Inc.
Page 161
FortiVoice Phone System 5.3.0 Administration Guide
Twinning Setting
This option is only available if Twinning is selected in the user
privileges of the extension. For more information, see
“Twinning” on page 240.
Setting: Select the twinning method.
• Disabled: Select to disable twinning.
• Simple: Select to configure a basic twinning by adding
a phone number.
• Scheduled: Select to configure a twinning by adding
phone numbers based on a schedule.
Operation status: If you choose to configure a twinning,
select to turn it on or off.
Number: If you choose to configure a simple twinning, enter
the phone (twin) number.
Schedule: If you choose to configure a scheduled twinning,
select up to 3 time schedules (see “Scheduling the FortiVoice
unit” on page 132), and enter a phone (twin) number for each
schedule.
Phone profile
For details on phone profiles, see “Configuring phone
profiles” on page 123.
Select a profile type if your phone type is FortiFone 260i and
above:
• Admin defined: This type allows you to choose a system
level phone profile. You can also create a new profile or
modify the selected one.
• User defined: This type allows phone users to set the
programmable phone keys on the user web portal when
the profile is applied to their extensions. There is no need
to choose a profile.
Select an Admin defined profile if your phone type is other
than FortiFone 260i and above. You can also create a new
profile or modify the selected one.
The phone profile settings you select here synchronize with
the same settings in extension configuration. For details, see
“Phone profile” on page 141.
Configure User
Defined Profile
This option is only available if you select the User defined
profile type, save the extension configuration and re-open the
extension.
Click to configure the user defined phone profile. For details,
see “Configuring phone profiles” on page 123.
FortiFone Call Preference
Fortinet Technologies Inc.
If this extension is for a FortiFone, you can configure its call
preferences.
Direct call
Select to add direct call function to this phone, that is, as
soon as you pick up the phone, it dials the number you set
automatically.
Direct call number
If you select Direct call, enter the number to call. For
example, the number of your paging system.
Page 162
FortiVoice Phone System 5.3.0 Administration Guide
Direct call timer
Enter the time in seconds to wait before the number dialing
starts after the phone is picked up.
You can enter a different number to call before the set time
expires.
Auto answer
Select to enable this phone to automatically answer phone
calls without being picked up.
4. Click OK.
Configuring follow me settings
Follow me allows a call to an extension to be transferred to another destination when you are
not available.
This configuration serves as a profile for use in managing calls. See “Handling calls” on
page 163.
To configure follow me settings:
1. Go to Extensions > Extensions > Preferences > Follow Me.
2. Click New.
3. Enter a Name for this setting.
4. Under Follow Me Numbers, click New.
5. Enter a phone number to which the call to your extension can be transferred.
6. Enter the phone ringing duration, in seconds, before the call goes to voicemail or next
number in the sequence.
7. Click Create.
Repeat steps 4 to 7 of this procedure to add more numbers if you want to transfer a follow
me call to multiple numbers in a sequence. The numbers will be dialed according to the
sequence in the follow me setting.
Handling calls
Extensions > Extensions > Preferences > Call Handling allows you to manage the call process.
For example, you can configure the process to forward a call to another number on a specific
schedule.
You can manage a normal call handling by configuring the call process for different situations.
You can also manage quick call handling by dialing a code to enter into a default mode and
configure the call process for that particular mode if required.
If the extension with configured call handling action is part of another FortiVoice function that
also has configured call handling action (for example, a member of a ring group or used for a
virtual number), then the call handling action of the other FortiVoice function overrides the
extension call handling action.
To handle a normal call
1. Go to Extensions > Extensions > Preferences > Call Handling.
2. Click Normal call handling.
3. Select a call status at the top of the page.
Each status can only be used for one call management configuration.
Fortinet Technologies Inc.
Page 163
FortiVoice Phone System 5.3.0 Administration Guide
4. For Call Process, select System default action or User defined action.
The System default action (action shows in brackets) changes depending on the status
selection.
5. If you select User defined, click New to define a call process according to a schedule.
• Select a pre-configured Schedule for the call action. You can click View to display the
schedule details. For information on configuring schedules, see “Scheduling the
FortiVoice unit” on page 132.
• Add an Action for the call process.
For some call handling processes that may require further actions, you need to add one
or more call processes to complete the call handling. For example, after adding a process
that contains a Forward action, you can add another process with a Go voicemail action
to complete the call handling. In this case, the call will be forwarded to the phone
specified and if the phone is not picked up, a voicemail will be left on this extension.
Default action is equal to the action when you select System default action under Call
Process.
• If you select Follow me, select a follow me profile. For information on configuring
follow me, see “Follow Me” on page 161.
This option is available only if call forwarding is enabled in the extension’s user
privilege. See “Configuring user privileges” on page 239.
• If you select Play announcement, select a sound file. For information on configuring
sound files, see “Managing sound files and music on hold” on page 119.
• If you select Auto attendant, select an auto attendant profile. For information on
configuring auto attendant, see “Configuring auto attendants” on page 233.
• If you select Forward, enter the number to which you want to forward the call.
This option is available only if call forwarding is enabled in the extension’s user
privilege. See “Configuring user privileges” on page 239.
• Click Create.
6. Click OK.
To handle a quick call
1. Go to Extensions > Extensions > Preferences > Call Handling.
2. Click Quick call handling.
3. Select a call status at the top of the page.
Each status can only be used for one call management configuration.
4. For Call Process, select System default action or User defined action except for the Out of
office status.
5. If you select System default action, the three quick call modes are the same as listed.
6. If you select User defined, click New to define a call process according to a schedule.
• Select a pre-configured Schedule for the call action. You can click View to display the
schedule details. For information on configuring schedules, see “Scheduling the
FortiVoice unit” on page 132.
• Add an Action for the call process. You can add multiple actions to process a call in
sequence. For example, you can add Play announcement and then Auto attendant. In this
case, an incoming call will be transferred to the auto attendant after an announcement is
played.
Default action is equal to the action when you select System default action under Call
Process.
• If you select Follow me, select a follow me profile. For information on configuring
follow me, see “Follow Me” on page 161.
Fortinet Technologies Inc.
Page 164
FortiVoice Phone System 5.3.0 Administration Guide
This option is available only if call forwarding is enabled in the extension’s user
privilege. See “Configuring user privileges” on page 239.
• If you select Play announcement, select a sound file. For information on configuring
sound files, see “Managing sound files and music on hold” on page 119.
• If you select Auto attendant, select an auto attendant profile. For information on
configuring auto attendant, see “Configuring auto attendants” on page 233.
• If you select Forward, enter the number to which you want to forward the call.
This option is available only if call forwarding is enabled in the extension’s user
privilege. See “Configuring user privileges” on page 239.
• Click Create.
7. Click OK.
Resetting voice messages
Extensions > Extensions > Voice Messages lets you view the voice message count in each
extension. You can also delete the voice messages for an extension by selecting the extension
and click Maintenance > Reset. This action only deletes the messages, not the extension itself.
Creating extension groups
Extensions > Groups lets you configure extension groups including extension departments, ring
groups, page groups, and pickup groups.
This section contains the following topics:
• Creating user groups
• Creating extension departments
• Creating ring groups
• Creating page groups
• Creating pickup groups
Creating user groups
You can create a user group and use it to simplify the configuration of an IP extension voice
mailbox, a general voice mailbox, a ring group, a page group, or a pickup group. For example,
when creating a ring group, you can select the name of a user group rather than entering each
user name individually.
For information on creating IP extension voice mailboxes, see “Configuring IP extensions” on
page 136.
For information on creating general voice mailboxes, see “Setting up general voice mailboxes”
on page 170.
To create a user group
1. Go to Extension > Groups > User Group.
2. Click New.
3. Enter a name for the group.
4. Select the available users or user groups that you want to include in the group and click -> to
move them into the Selected field.
5. Click Create.
Fortinet Technologies Inc.
Page 165
FortiVoice Phone System 5.3.0 Administration Guide
Creating extension departments
You can create department profiles for applying to the extensions. For example, you can create
a department profile called HR and apply it to extension 1111 to indicate that this extension
belongs to the HR department.
For information on applying department profiles, see “Setting up local extensions” on page 136.
To create an extension department
1. Go to Extension > Groups > Department.
2. Click New.
3. In the Name field, enter the name of the department.
4. In the Comment field, enter any notes you have for this department.
5. If you have call center license, the Call Center section appears. For configuration
information, see “Configuring agents” on page 209.
6. Click Create.
Creating ring groups
A ring group is a group of local extensions and external numbers that can be called using one
number. Local extensions and auto attendants can dial a ring group.
A ring group can reach a group of extensions. For example, ring group 301 can ring the sales
group at extensions 111, 112, 113, and 114. When a customer calls the sales group, the first
available salesperson answers for the group.
To create a ring group
1. Go to Extension > Groups > Ring Group.
2. Click New.
3. Configure the following:
GUI field
Description
Name
Enter the name for the ring group.
Number
Enter the ring group number following the extension number pattern.
See “Configuring PBX options” on page 107.
Clicking in the field displays a list of crossed-out extensions. These
numbers are already used and cannot be used as ring group
numbers.
The ring group number, once dialed, will ring all the extensions in the
group.
Show suggested
numbers
Select and click in the Number field to display the extension
numbers available for use. If it is deselected, clicking in the Number
field displays the extension numbers already in use.
This option also serves as a diagnostic tool for finding and fixing
duplicate or missing numbers. Missing numbers are the extensions
that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can click the
icon and fix the numbers. For more information, see “Fixing
duplicate or missing numbers” on page 143.
Fortinet Technologies Inc.
Page 166
FortiVoice Phone System 5.3.0 Administration Guide
Display Name
Enter the name displaying on the extensions of the ring group, such
as “HR”.
Enabled
Select to activate the ring group.
Ring mode
Select how you want the ring group to be called.
• All: All extensions in the group will ring when the ring group
number is dialed.
• Sequential: Each extension in the group is called one at a time in
the order in which they have been added to the group. You can
set a timeout period for each ring.
Department
Select the department to which this group belongs.
Members
Select the available extensions or user groups that you want to
include in the ring group and click -> to move them into the Selected
field.
For information on creating extensions and user groups, see “Setting
up local extensions” on page 136 and “Creating extension groups”
on page 165.
External numbers
Click New to add an external phone number to the ring group. For
example, you can add the number of a remote employee to a ring
group.
Call Handling
Use this option to configure the call handling for the ring group. For
more information, see “Configuring ring group call handling” on
page 167.
Advanced setting
• Ring Pattern: Select a ring pattern for the group.
• Ring duration: Set the amount of time in seconds allowing all
extensions or each one to ring before going to voicemail.
• Early media: Select the ring tone for the group. For creating new
sound files, see “Managing sound files and music on hold” on
page 119.
• Caller ID option: Select how you want the caller ID to display.
• Call waiting: Select to enable call waiting.
• Emergency call option: Select Display emergency caller ID to
show the emergency caller’s ID, or Disconnect ongoing call to
stop a call that uses the line for emergency call.
4. Click Create.
Configuring ring group call handling
Use the Call Handling option to configure the call automation. For example, you can configure
the process to forward a call to another number on a specific schedule.
You can only configure ring group call handling when editing a ring group.
If the ring group with configured call handling action is part of another FortiVoice function that
also has configured call handling action (for example, a member of another ring group or the
ring group extension is used for a virtual number), then the call handling action of the other
FortiVoice function overrides the ring group call handling action.
Fortinet Technologies Inc.
Page 167
FortiVoice Phone System 5.3.0 Administration Guide
For information on the Call Handling option, see “Call Handling” on page 167.
To configure the call process
1. On the Ring Group page, click Normal call handling under Call Handling.
2. Select a call status at the top of the page.
Each status can only be used for one call management configuration.
For the Busy status, if you set the ring group’s ring mode to All, the FortiVoice unit will
declare the ring group busy only if all extensions in the group are busy; if you set the ring
group’s ring mode to Sequential, the FortiVoice unit will declare the ring group busy only if
the last extension in the group is busy after ringing the extensions sequentially and each one
is busy at the time of being rung.
3. For Call Process, select System default action or User defined action.
The System default action changes depending on the status selection.
4. If you select User defined, click New to define a call process according to a schedule.
• Select a pre-configured Schedule for the call action. You can click View to display the
schedule details. For information on configuring schedules, see “Scheduling the
FortiVoice unit” on page 132.
• Add an Action for the call process. You can add multiple actions to process a call in
sequence. For example, you can add Play announcement and then Auto attendant. In this
case, an incoming call will be transferred to the auto attendant after an announcement is
played.
Default action is equal to the action when you select System default action under Call
Process.
• If you select Voicemail, enter the extension number of the voice mail.
• If you select Play announcement, select a sound file. For information on configuring
sound files, see “Managing sound files and music on hold” on page 119.
• If you select Auto attendant, select an auto attendant profile. For information on
configuring auto attendant, see “Configuring auto attendants” on page 233.
• If you select Forward, enter the number to which you want to forward the call.
This option is available only if call forwarding is enabled in the extension’s user
privilege. See “Configuring user privileges” on page 239.
• Click Create.
Creating page groups
A page group is a group of extensions that can be paged using one number. Page groups
require telephones that support group paging.
A page group can reach a group of extensions. For example, page group 301 can ring the sales
group at extensions 111, 112, 113, and 114. When a call reaches 301, all extensions in the
group can pick up and answer the call.
To create a page group
1. Go to Extensions > Groups > Paging Group.
2. Click New.
3. Enter a name for the group.
4. Enter the page group number following the extension number pattern. See “Configuring PBX
options” on page 107.
This is the number that, once paged, will ring all the extensions in the group.
Fortinet Technologies Inc.
Page 168
FortiVoice Phone System 5.3.0 Administration Guide
5. For Show suggested numbers, select and click in the Number field to display the extension
numbers available for use. If it is deselected, clicking in the Number field displays the
extension numbers already in use.
This option also serves as a diagnostic tool for finding and fixing duplicate or missing
numbers. Missing numbers are the extensions that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange exclamation mark icon appears
beside this option. You can click the icon and fix the numbers. For more information, see
“Fixing duplicate or missing numbers” on page 143.
6. Enter the name displaying on the extensions of the group, such as “HR”.
7. Select Enabled to activate this group.
8. For Caller ID option, select how you want to display the ID of a caller to the group.
• No change: the caller ID will display as is.
• Replace: the caller ID will be replaced by the Display name you set.
• Prefix: the caller ID will be prefixed with the Display name you set.
9. For Emergency call option, do the following:
• Select Display emergency caller ID to show the caller ID.
• Select Disconnect ongoing call to interrupt a page in progress when an emergency page
comes in.
10.Select the department to which this group belongs.
11.Select the available extensions or extension groups that you want to include in the page
group and click -> to move them into the Selected field.
12.Click Create.
Creating pickup groups
Some organizations cannot afford to miss phone calls on any extensions. Pickup groups allow
some members in a group to answer incoming calls that ring on other extensions while the
users are away.
Pickup groups can press the feature codes to pick up incoming calls that ring on other
extensions. For more information, see “Modifying feature access codes” on page 266.
To create a pickup group
1. Go to Extensions > Groups > Pickup Group.
2. Click New.
3. Enter a name for the group.
4. Select Enabled to activate this group.
5. Select the department to which this group belongs.
6. For Members, select the Available extensions or user groups that you want to include in the
pickup group and click -> to move them into the Selected field.
For information on creating extensions and user groups, see “Setting up local extensions”
on page 136 and “Creating extension groups” on page 165.
7. For Pickup by members, select the Available extensions or user groups that are allowed to
answer incoming calls that ring on other extensions and click -> to move them into the
Selected field.
8. Click Create.
Fortinet Technologies Inc.
Page 169
FortiVoice Phone System 5.3.0 Administration Guide
Setting up general voice mailboxes
Some organizations, such as the sales team of a company, may have the need to share voice
mails within multiple users or a user group for better service and efficiency. With a general voice
mailbox, when there is a new voice mail, the entire group is copied or notified. Any member of
the group can access the voice mail and once this is done, the notification is gone and others
know that the voice mail has been taken care of.
To view the group voice mailbox, go to Extensions > General Voicemail > General Voicemail.
GUI field
Description
Enabled
Select to activate the mailbox.
Number
The extension number for the mailbox. This number is for the mailbox
only and not associated with any phone.
Display Name
The name displaying on the extension.
Disk Usage (KB)
Displays the size of disk space used by the general voice mails in
kilobytes (KB).
To set up a general voice mailbox
1. Go to Extensions > General Voicemail > General Voicemail.
2. Click New or double-click an existing record.
3. Configure the following:
GUI field
Description
General Voicemail
Number
Enter the mailbox extension number following the extension
number pattern. See “Configuring PBX options” on page 107.
User ID
This is the system-generated ID based on the mailbox
extension number.
This option is view only. You can add a new user ID through
the CLI. For more information, see the FortiVoice CLI
Reference.
Show suggested
numbers
Select and click in the Number field to display the extension
numbers available for use. If it is deselected, clicking in the
Number field displays the extension numbers already in use.
This option also serves as a diagnostic tool for finding and
fixing duplicate or missing numbers. Missing numbers are the
extensions that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can
click the icon and fix the numbers. For more information, see
“Fixing duplicate or missing numbers” on page 143.
Fortinet Technologies Inc.
Enabled
Select to activate the mailbox extension.
Display name
Enter the name of the mailbox extension.
Page 170
FortiVoice Phone System 5.3.0 Administration Guide
User PIN
Password policy warning icon may appear beside this field
depending on your password/PIN policy configuration. You
can click the warning icon to configure the policy. For details,
see “Configuring system options” on page 81.
Enter the password for the user to access voicemail (by
dialing *98 or the customized code. See “Modifying feature
access codes” on page 266) and the user web portal.
Click Generate to generate a strong password automatically.
Select View PIN to display the password. This option is only
available when you edit an extension.
If you have configured the default user PIN (see “Default user
PIN” on page 109), the password appears here. However, you
can change it.
Authentication type Select the mailbox extension’s authentication type: Local or
LDAP.
LDAP profile
If you select LDAP for Authentication type, select an LDAP
profile to apply to this extension. For information on LDAP
profile, see “Configuring LDAP profiles” on page 126.
You can click New to create a new profile or Edit to modify the
selected one.
Authentication ID
If you select Try common name with base DN as bind DN as
the user authentication option in the authentication profile you
select, enter the authentication ID based on the user objects’
common name attribute you entered in the Common name ID
field of the profile, such as jdoe.
If you select Search user and try bind DN as the user
authentication option in the authentication profile you select,
leave this field blank.
This option is only available if you select LDAP for
Authentication type.
Phone language
Select the voice prompts for the mailbox extension, such as
auto attendant and voicemail. The default is English.
For information on adding prompt languages, see “Adding
prompt languages” on page 114.
Description
Group Voice Mailbox
Fortinet Technologies Inc.
Enter any notes for the extension’s mailbox.
Configure the users for sharing this extension’s mailbox.
Page 171
FortiVoice Phone System 5.3.0 Administration Guide
Mode
Select the way to deliver the voicemail from this mailbox
extension to the users sharing this mailbox.
• Centralized: Select to copy or notify the entire group when
a new voicemail comes in. Any member of the group can
access the voicemail and once this is done, the notification
is gone and others know that the voicemail has been taken
care of.
• Notify message waiting light: If you select this option,
the FortiVoice unit turns on the message waiting light
on a user’s phone when a new voice message is left on
this voice mailbox.
• List as mailbox: Users can listen to a centralized
voicemail by dialing *97 or the customized code (see
“Modifying feature access codes” on page 266) from
their own extensions and enter the user PIN for this
general voicemail box.
• Broadcast: If you select this option, the voicemail is sent to
the voicemail boxes of the users. Users can access the
voicemail by dialing *98 or the customized code (see
“Modifying feature access codes” on page 266) from any
extensions and enter the personal user PIN.
Participants
Select the users or groups to notify when a voicemail is left in
this mailbox extension.
To select the users to share this mailbox, click User(s) and
from the Available field, select the users and click -> to move
them to the Selected field.
To select the groups to share this mailbox, click Group(s) and
from the Available field, select the groups and click -> to move
them to the Selected field.
For information on creating user groups, see “Creating
extension groups” on page 165.
4. Click Create or OK.
Working with virtual numbers
A virtual number is an extension that is not assigned to a phone. Unlike auto attendants, when a
call goes to a virtual number, the caller does not need to manually select any options by
pressing the phone keys. The call process is automated based on time schedules. For example,
for after business hour phone calls, you can configure a virtual number to play an
announcement, then transfer the call to the voice mailbox. You can also transfer the calls to the
auto attendant where the callers can manually select the options based on the auto attendant
configuration.
If the virtual number with configured call handling action is part of another FortiVoice function
that also has configured call handling action (for example, a member of a ring group), then the
call handling action of the other FortiVoice function overrides the virtual number call handling
action.
To configure a virtual number
1. Go to Extensions > Virtual Number > Virtual Number and click New.
Fortinet Technologies Inc.
Page 172
FortiVoice Phone System 5.3.0 Administration Guide
2. Configure the following:
GUI field
Description
Name
Enter a name for the virtual number.
Number
Enter the virtual number which is not assigned to any phone.
Show suggested
numbers
Select and click in the Number field to display the virtual numbers
available for use. If it is deselected, clicking in the Number field
displays the virtual numbers already in use.
This option also serves as a diagnostic tool for finding and fixing
duplicate or missing numbers. Missing numbers are the extensions
that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can click the
icon and fix the numbers. For more information, see “Fixing
duplicate or missing numbers” on page 143.
Display name
Enter the name displaying on the extension. This is usually the name
of the extension user.
Enabled
Select to activate this virtual number.
Bypass sub call
handling
Select if you want to bypass the call handling configuration
embedded in the call handling of this virtual number.
Comment
Enter any notes you have for the virtual number.
Call Handling
Use this option to configure the call handling for the virtual number.
For more information, see “Configuring virtual number call handling”
on page 173.
Configuring virtual number call handling
Use the Call Handling option to configure the call automation. For example, you can configure
the process to forward a call to another number on a specific schedule.
For information on the Call Handling option, see “Call Handling” on page 173.
To configure the call process
1. On the Virtual Number page, click New under Call Handling.
2. Select a pre-configured Schedule for the call action. You can also click New to create a
schedule or Edit to modify the selected one. For information on configuring schedules, see
“Scheduling the FortiVoice unit” on page 132.
3. Select an Action for the call handling.
Some actions require that you enter further information to complete the call process, such as
Dial extension and General mailbox.
For some call handling processes that may require further actions, you need to add one or
more call processes to complete the call handling. For example, after adding a process that
contains a Set call queue priority action, you can add another process with a Call queue
action to complete the call handling. In this case, the call will be processed again with new
priority after it is transferred to the queue.
4. Click Create.
5. Click OK.
Fortinet Technologies Inc.
Page 173
FortiVoice Phone System 5.3.0 Administration Guide
Fortinet Technologies Inc.
Page 174
FortiVoice Phone System 5.3.0 Administration Guide
Configuring Trunks
Setting up trunks enables the FortiVoice unit to connect to the outside world. You can configure
trunks that go to your VoIP service provider for long-distance calls, trunks for your PSTN
circuits, and trunks that connect your various offices together.
Trunks are applied to user extensions and dial plans. For more information, see “Configuring
Extensions” on page 136 and “Configuring Call Routing” on page 189.
This topic includes:
• Setting up VoIP trunks
• Modifying PSTN/PRI trunks
• Configuring office peers
Setting up VoIP trunks
You can add one or more VoIP service providers to the FortiVoice unit trunk configuration. The
VoIP service providers deliver your telephone services to customers equipped with SIP-based
PBX (IP-PBX).
To view the list of VoIP service providers, go to Trunks > VoIP > SIP.
GUI field
Description
Test
Select to test if the trunk is created successfully.
For more information, see “Testing SIP trunks” on page 179.
FortiCall
Select to create a SIP trunk with Fortinet’s FortiCall service.
You can only create one trunk with FortiCall and use it free for 30 days
or 300 minutes, whichever comes first. Note that the trial account only
allows outbound calling and no international calling is available.
If you sign up for the service during a trial, the trial is closed and billing
will start.
For more information, see “Creating a SIP trunk with FortiCall service”
on page 180.
Enabled
Select to activate this trunk.
Name
The name of the VoIP service provider.
Server
The VoIP provider’s domain name or IP address. For example,
172.20.120.11 or voip.example.com.
Port
The port for SIP sessions.
Fortinet Technologies Inc.
Page 175
FortiVoice Phone System 5.3.0 Administration Guide
SIP Setting
The SIP profile applied to this trunk.
Status
The status of the SIP trunk.
• Not registered: The trunk is not registered with the VoIP service
provider and is not in service.
• In service: The trunk is registered with the VoIP service provider and
is in service.
• Unavailable: The trunk is not reachable.
• Alarm detected: There is a problem with the phone line.
• Admin down: The trunk is disabled.
• Unmonitored: The trunk is unknown.
To create a VoIP trunk
1. Go to Trunks > VoIP > SIP.
2. Click New.
3. Configure the following:
GUI field
Description
SIP
Name
Enter the name of the VoIP service provider.
Enabled
Select to activate the SIP trunk.
Display name
Enter your caller ID that will appear on the called phone, such
as Example Company.
Main number
Enter the phone number that will appear on the called phone.
If you entered the external caller ID in “External caller ID” on
page 139 or “External caller ID” on page 157, this trunk phone
number will be overridden by the external caller ID.
SIP Setting
SIP server
Enter the VoIP provider’s IP address or domain name. For
example, 172.20.120.11 or voip.example.com.
SIP port
Most SIP configurations use TCP or UDP port 5060 for SIP
sessions. If your VoIP service provider uses a different port for
SIP sessions, enter the port number.
If you select the Using DNS record option, this field is greyed
out.
Using SRV record
If you entered the VoIP provider’s domain name in the SIP
server field, select this option to translate the domain name
and obtain the SIP port.
You can only select this option if your VoIP provider uses the
same setting.
User name
Fortinet Technologies Inc.
Enter the user name provided by the VoIP service provider for
the FortiVoice unit to register with the SIP server.
Page 176
FortiVoice Phone System 5.3.0 Administration Guide
Password
Enter the password provided by the VoIP service provider for
the FortiVoice unit to register with the SIP server.
Auth. user name
Some VoIP providers may provide you with an authentication
user name that is different from your user name for the
FortiVoice unit to register with the SIP server. If tat is the case,
enter the authentication user name here.
Realm/domain
Some VoIP service providers’ SIP servers authenticate the
PBXes that register with them by requesting the name of the
host performing the authentication. If this is the case with your
VoIP service provider, enter the name of the host performing
the authentication provided by your VoIP service provider.
SIP setting
Select the SIP profile to apply the supported phone features
and codecs for the trunk. To match the information of the VoIP
service provider, you can edit the existing profile or click New
to add a new one. For more information, see “Configuring SIP
profiles” on page 120.
Max channel
Each trunk contains multiple channels. The number of
channels you can have in a trunk is controlled by your VoIP
service provider. This number displays under line appearance
option when you configure programmable phone keys for
phone profiles. See “Configuring phone profiles” on page 123.
Consult your VoIP service provider for the maximum of
channels that you can set to limit the number of concurrent
calls. For example, if you want to allow six calls at a time,
enter 6.
Max outgoing
channel
With known max channels, if you need to reserve incoming
channels, you may enter the number of outgoing channels
allowed and the remaining channels are for incoming calls.
For example, the max channel number is 10 and you want to
reserve 4 channels for incoming calls, you can enter 6 for Max
outgoing channel.
User=Phone in SIP
URI
Select if your service provider requires this option to make the
FortiVoice unit to be compatible with the VoIP service
provider’s configurations.
Caller ID
modification
Select if you want the trunk main number to appear on the
called phone. See “Main number” on page 176.
Otherwise, the user name provided by the VoIP service
provider for the FortiVoice unit to register with the SIP server
will appear on the called phone. See “User name” on
page 176.
Inband ringtone
Select to enable the FortiVoice unit to send ring tone to the
caller of an incoming call before the establishment of a call
connection.
This option is only editable if you enable early media in
“Advanced Setting” on page 112.
Fortinet Technologies Inc.
Page 177
FortiVoice Phone System 5.3.0 Administration Guide
Registration
Enter the SIP registration information from the VoIP service
provider by selecting a registration method. You can receive
calls after registering with the SIP server of the VoIP service
provider.
• Enable registration: Select to activate the registration with
the VoIP service provider. This trunk is ready to use.
• Standard: Select to use the standard registration method
which automatically registers with the SIP server of the
VoIP service provider.
• Registrar: Select to enter the registration information from
the VoIP service provider:
• Registrar host/IP: Enter the VoIP service provider’s SIP
registration server domain name or IP address. For
example, 172.20.120.11 or voip.example.com.
• Registrar port: Most SIP configurations use TCP or
UDP port 5060 for SIP sessions. If your VoIP service
provider uses a different port for SIP sessions, enter the
port number.
• Transport protocol: Select the transport protocol used
for the registration.
• Registration URI: Enter the registration string provided by
the VoIP service provider in the Registration URI field.
The string usually has the following formats:
register => user[:secret[:authuser]]@host
[:port][/extension]
or
register => fromuser@fromdomain:secret@host
or
register => fromuser@fromdomain:secret:
authuser@host:port/extension
For example, a string could be: register =>
2345:password@mysipprovider.com/1234
Outbound Proxy
Some VoIP service providers use proxy servers to direct its
traffic. If this is the case, your registration request will go to
the proxy server first before reaching the registration server.
Configure the following:
• Enable proxy: Select to activate the proxy server settings.
• Proxy host/IP: Enter the proxy server’s domain name or IP
address. For example, 172.20.120.11 or
voip.example.com.
• Proxy port: Enter the port number of the proxy server.
• Transport protocol: Select the transport protocol used for
the registration.
Fax
Fortinet Technologies Inc.
Configure fax signal automatic detection and fax handling.
Page 178
FortiVoice Phone System 5.3.0 Administration Guide
Automatic fax
detection
Select for the FortiVoice unit to detect incoming fax signal on
this trunk automatically.
Selecting this option may delay the call response time on this
trunk.
Forward fax to eFax Some incoming faxes’ numbers do not match those of your
account
eFax accounts. Selecting this option and a fax receiving
account will send the faxes to the fax account. See “Forward
tax to eFax account” on page 183.
This option is only selectable if Automatic fax detection is
selected.
Phone Number
Click New to add the phone number provided by your VoIP
service provider. The VoIP service provider SIP server will
direct calls from external callers directly to this number. You
can add multiple numbers.
4. Click Create.
Testing SIP trunks
After you create a SIP trunk, you can select the trunk and click Test to see if the trunk works.
For more information, see “Test” on page 175.
To test a SIP trunk
1. Go to Trunks > VoIP > SIP.
2. Select the trunk that you want to test and click Test.
The System Configuration Test page appears.
3. Configure the following:
GUI field
Description
Test Dry Run
Run a system SIP trunk test without making a real phone call.
Destination number Enter a destination number to call.
From number
Enter the number from which you want to call the destination
number. The FortiVoice unit will connect this number with the
destination number for the test.
Test
Click to start the dry run test and check the Test result.
Reset
Click to remove the test result in order to start a new test.
Test Call
Test the SIP trunk by making a real phone call.
Destination number Enter a destination number to call.
Fortinet Technologies Inc.
Page 179
FortiVoice Phone System 5.3.0 Administration Guide
After call is
established
Select the FortiVoice action once it calls the destination
number:
• Play welcome message: The FortiVoice unit will play a
message to the destination number.
• Connect test call to number: In the Number field, enter the
number from which you want to call the destination
number. The FortiVoice unit will connect this number with
the destination number to test the trunk.
Test
Click to start the test and check the Test result.
Reset
Click to remove the test result in order to start a new test.
See also
• Creating a SIP trunk with FortiCall service
Creating a SIP trunk with FortiCall service
You can create one trunk with FortiCall and use it free for 30 days or 300 minutes, whichever
comes first. Note that the trial account only allows outbound calling and no international calling
is available.
If you sign up for the service during a trial use, the trial is closed and billing will start.
To create a SIP trunk with FortiCall service
1. Go to Trunks > VoIP > SIP.
2. Click FortiCall.
The Create SIP Trunk dialog box displays.
Figure 27: Creating a SIP trunk with FortiCall service
3. Note down the MAC Address and System ID for use if you decide to sign up for the service
later. See “To sign up for the FortiCall service” on page 181.
4. Keep Create dialplans for this trunk selected unless you want to create the dialplans by
yourself.
The auto-generated dialplans will replace the default inbound, outbound, and emergency
call dialplans. You can delete them if you do not choose to use the FortiCall service.
5. Click Yes.
6. Enter your name and email address and click Create.
7. Click OK.
The FortiCall trunk is created.
Fortinet Technologies Inc.
Page 180
FortiVoice Phone System 5.3.0 Administration Guide
To sign up for the FortiCall service
1. Go to Trunks > VoIP > SIP.
2. Double-click the trunk named FortiCall.
3. Under Account, click Sign Up.
4. On the FortiCall sign up page, fill out the sign-up form and click Submit.
For the System ID and MAC Address fields, use the noted-down information when you
created the FortiCall trunk. See “To create a SIP trunk with FortiCall service” on page 180.
You will receive an email containing your SIP user name and password for logging into and
manage your FortiCall account.
To log into the FortiCall account
1. Go to Trunks > VoIP > SIP.
2. Double-click the trunk named FortiCall.
3. Under Account, click Login.
4. Enter the login information you received after signing up for the service. See “To sign up for
the FortiCall service” on page 181.
5. Click Login.
Modifying PSTN/PRI trunks
PSTN (Public Switched Telephone Network)/PRI (Primary Rate Interface) trunks connect your
PBX or VoIP network to your PSTN service providers and through them to the outside world.
These trunks can be analog or digital phone lines.
This option is only available on the FVE 200D-T, FVE 300E-T, FVE 500E-T2, FVE 1000E-T, and
FVE 2000E-T2 models.
You can modify the default trunks or create new ones.
To view the PSTN trunks, go to Trunks > PRI > PRI.
GUI field
Description
Enabled
Select to activate the trunk.
Name
The name of the trunk.
Status
The trunk statuses, including:
• In service: The trunk is currently in use.
• Not activated: The trunk is not enabled.
• Idle: The trunk is not in use.
• Unavailable: The trunk is not reachable.
• Conflict: The trunk conflicts with another one.
• Alarm detected: There is a problem with the trunk.
• Admin down: The trunk is disabled.
Type
The trunk type: digital or analog.
To add a T1/E1 voice circuit trunk
1. Go to Trunks > PRI > PRI.
Fortinet Technologies Inc.
Page 181
FortiVoice Phone System 5.3.0 Administration Guide
2. Click New.
3. Configure the following:
GUI field
Description
Trunk Setting
Name
The name of this trunk. This is view only.
Enabled
Select to activate the trunk.
Display name
Enter your caller ID that will appear on the called phone, such as
Example Company.
Number
Enter the phone number that will appear on the called phone.
If you entered the external caller ID in “External caller ID” on
page 139 or “External caller ID” on page 157, this trunk phone
number will be overridden by the external caller ID.
Hardware Property
Use this option to configure the T1/E1 span.
Spans represent trunks (spans) of T1/E1 PSTN lines. The
FortiVoice unit supports T1/E1 lines according to the installed
voice card. You can add a span name using the CLI.
Click a span name to configure the settings of the T1/E1 span to
match the same settings of your PSTN service provider. Click OK
after finishing the configuration. For more information, see
“Configuring the T1/E1 span” on page 184.
Share
D-Channel
(NFAS)
For FVE 2000E-T2 that supports two T1/E1 voice circuit trunks pri1 and pri2, you can efficiently use your B channels on both
spans by sharing the D channel to save one D channel which can
be used as a B channel.
To do so:
• In the D-Channel span field, select the span of which you want
to share the D channel.
• Enter the channel number of Backup D-channel if required. 0
means no backup D channel.
This is useful when you have more than 3 spans.
Once you set the backup D channel, click span2 and enter the
backup D channel number in the D-channel field under
Advanced Options. Make sure that this backup D channel
number is not included in the channel range in the B-channel
field.
Max channel
Indicates the total number of B channels on both spans.
This option is only available for FVE 2000E-T2.
Max outgoing Enter the number of outgoing channels out of the maximum
channel
number of B channels.
This option is only available for FVE 2000E-T2.
Fax
Fortinet Technologies Inc.
Configure fax and phone signal automatic detection and fax
handling.
Page 182
FortiVoice Phone System 5.3.0 Administration Guide
Automatic fax Select for the FortiVoice unit to detect incoming fax signal on this
detection
trunk automatically.
Forward tax to Select the fax receiving account for the detected faxes.
eFax account
Phone Number
Click New to add the phone number provided by your PSTN
service provider. This is your DID number. Your PSTN service
provider will direct calls from external callers directly to this
number. You can add multiple numbers, including numbers from
full or fractional PRI (T1/E1).
4. Click Create.
To add a analog CO trunk for 200D-T
1. Go to Trunks > Analog > Analog.
2. Click New.
3. Configure the following:
GUI field
Description
Analog Setting
Name
The name of this trunk. This is view only.
Display name
Enter your caller ID that will appear on the called phone,
such as Example Company.
Number
Enter the phone number that will appear on the called
phone.
If you entered the external caller ID in “External caller ID” on
page 139 or “External caller ID” on page 157, this trunk
phone number will be overridden by the external caller ID.
Enabled
Select to activate the trunk.
Hardware Property
analog1
Use this option to configure the analog trunk.
Click Edit to configure the PSTN analog settings to match
the same settings of your PSTN service provider. Click OK
after finishing the configuration. For more information, see
“Configuring the analog voice trunk” on page 186.
Port
Fax
Configure fax and phone signal automatic detection and fax
handling.
Automatic fax
detection
Fortinet Technologies Inc.
Select the FXO ports you want for this trunk and click -> to
move them into the Selected ports field. Each FXO port
provides an analog phone line for a FXO device, such as a
phone or fax.
Select for the FortiVoice unit to detect incoming fax signal
on this trunk automatically.
Page 183
FortiVoice Phone System 5.3.0 Administration Guide
eFax account
Select the fax receiving account for the detected faxes.
Phone Number
Click New to add the phone number provided by your PSTN
service provider. Your PSTN service provider will direct calls
from external callers directly to this number. You can add
multiple numbers.
4. Click Create.
Configuring the T1/E1 span
You can configure the settings of the T1/E1 span, including full or fractional PRI (T1/E1), to
match the same settings of your PSTN service provider.
For 2000E-T2, if a PRI trunk includes two spans, the configuration of the second span is much
simpler as the spans share many configurations.
For more information, see “Hardware Property” on page 182.
To configure the T1/E1 span
1. On the PRI page, click a span name under Hardware Property.
2. Configure the following:
GUI field
Description
Standard Options
Name
The name of this span. This is view-only.
Type
Select the span type: PRI T1 or PRI E1.
A T1 span usually supports 23+1 channels, while an E1 span
supports 30 channels in CAS (Channel Associate Signaling)
mode and 30 B channels and one D channel in ISDN mode.
Signalling
Select the signaling type of the ISDN PRI:
• PRI signalling, CPE (Customer Premises Equipment) side
• PRI signalling, Network Side
• PRI R2 signalling
Advanced Options
Framing and Specify the type of framing and coding to provision the PRI with
coding option your PSTN service provider.
Clocking
options
Select the FortiVoice unit’s clock synchronization:
• Clock sourcing from PSTN network
• Internal clocking source
This option does not need to match that of your PSTN service
provider.
Fortinet Technologies Inc.
Page 184
FortiVoice Phone System 5.3.0 Administration Guide
Receive
sensitivity
Select the level of receiver sensitivity which is the ability of the
phone receiver to pick up the required level of phone signals to
make it operate more effectively within its application.
This option does not need to match that of your PSTN service
provider.
D-channel
signalling
format
Select a signalling method for the D channel which is a signalling
channel and carries the information needed to connect or
disconnect calls and to negotiate special calling parameters (for
example, automatic number ID, call waiting, data protocol). The D
channel can also carry packet-switched data using the X.25
protocol.
Line build out Select the line build out (LBO).
LBO settings are an inherent part of T1 and T3 network element
transmission circuitry.
Since cable lengths between network elements and digital signal
cross-connect (DSX) vary in the central office, LBO settings are
used to adjust the output power of the transmission signal to
achieve equal level point (ELP) at the DSX.
D-channel
By default, depending on your selection of “Type” on page 184,
the typical channel numbers are:
• Full T1: 24
• Full E1: 16
You can also set the channel numbers to others such as 1.
The settings you configure must match the same settings of your
PSTN service provider.
B-channel
By default, depending on your selection of “Type” on page 184,
the typical channel settings are:
• Full T1: 1-23
• Full E1: 1-15, 17-31
You can also configure the fractional channel numbers. For
example, for T1/E1, the channels can be:
• 1-12
• 2, 3, 4, 9-15
• 2-4, 9-15
The settings you configure must match the same settings of your
PSTN service provider.
PRI R2 Settings
Since there is no single signaling standard for R2, the FortiVoice
unit addresses this challenge by supporting many localized
implementations of R2 signaling.
This option is active only if you select PRI R2 signalling for
“Signalling” on page 184.
Country
Fortinet Technologies Inc.
Select the country for PRI R2 settings.
Page 185
FortiVoice Phone System 5.3.0 Administration Guide
Max ANI digits ANI (Automatic Number Identification) is a system used by
telephone companies to identify the DN (Directory Number) of a
calling subscriber. It allows subscribers to capture or display
caller’s telephone number.
Enter the number of digits of a caller‘s phone number to be
captured.
Max DNIS
digits
Dialed Number Identification Service (DNIS) is a service provided
by telephone companies that lets the subscribers determine
which telephone number was dialed by a caller.
Enter the number of digits of a dialed call to be sent by the
telephone company.
Caller
category
Select the caller type.
Incoming
digits mode
Select the incoming digits mode by consulting your telephone
company.
DTMF dialing
Select to enable dual-tone multi-frequency signaling (DTMF)
dialing.
DTMF
answering
Select to enable dual-tone multi-frequency signaling (DTMF)
answering.
Allow collect
calls
Select to allow collect calls.
3. Click OK.
Configuring the analog voice trunk
You can configure the settings of the analog CO trunk to match the same settings of your PSTN
service provider except the TX/RX gain settings.
For more information, see “Hardware Property” on page 182.
To configure the analog CO trunk
1. On the Analog page, click Edit under Hardware Property.
2. Configure the following:
GUI field
Description
PSTN Analog Setting
Name
The name of this configuration. This is view-only.
Codec
Select the Codec for the trunk.
Caller ID
signalling
Select the caller ID signalling standard per your phone company’s
request.
3. Click OK.
Fortinet Technologies Inc.
Page 186
FortiVoice Phone System 5.3.0 Administration Guide
Configuring office peers
If you have remote offices equipped with VoIP network, you can set up office peer trunks so that
offices can call each other as if they are local extensions.
For the office peers to call each other, make sure that your FortiVoice unit and the peer office
PBX are mutually registered with each other’s IP address and SIP port number.
To view the list of office peer trunks, go to Trunks > Office Peers > Office Peers.
GUI field
Description
Fetch Office
Directory
Select a trunk and click this button to obtain the phone directory from
this office peer.
This option only works if the PBX of the remote office is a FortiVoice unit
and Fetch directory (see “Fetch Directory” on page 188) is selected on
the remote unit.
You can view the directory by going to Status > Directory and selecting
this office in the Office field. For more information, see “Viewing phone
directories” on page 39.
Enabled
Select to activate this trunk.
Name
The name of the office peer.
Location
The location of the trunk.
Type
The type of the trunk.
Server
The domain name or IP address of the remote office’s PBX. For
example, 172.20.120.11 or peer.example.com.
Port
The port number for VoIP network on the remote office’s PBX.
SIP Setting
The SIP profile applied to this trunk.
Status
The status of the SIP trunk.
• Not registered: The trunk is not registered with the VoIP service
provider and is not in service.
• In service: The trunk is registered with the VoIP service provider and
is in service.
• Unavailable: The trunk is not reachable.
• Alarm detected: There is a problem with the phone line.
• Admin down: The trunk is disabled.
• Unmonitored: The trunk is unknown.
To set up an office peer
1. Go to Trunks > Office Peers> Office Peers.
2. Click New.
Fortinet Technologies Inc.
Page 187
FortiVoice Phone System 5.3.0 Administration Guide
3. Configure the following:
GUI field
Description
Office Peer
Name
Enter a name for the trunk.
Enabled
Select to activate the trunk.
Location
Enter the location of the trunk.
Type
Select the trunk type: SIP or IAX2.
Remote server
Enter the domain name or IP address of the remote office’s PBX.
Remote port
Enter the port number for VoIP network on the remote office’s
PBX.
SIP setting
Select the SIP profile for the trunk. You can edit the existing
profile or click New to add a new one. For more information, see
“Configuring SIP profiles” on page 120.
Max channel
Enter the maximum voice channels for the trunk.
Fetch Directory
Select this option and click Fetch now to obtain the phone
directory from this office peer.
This option only works if the PBX of the remote office is a
FortiVoice unit and the same option is selected on the remote
unit.
You can view the directory by going to Monitor > Directory and
selecting this office in the Office field. For more information, see
“Viewing phone directories” on page 39.
Authentication Settings If you want to authenticate incoming and outgoing calls, enable
Incoming authentication and Outgoing authentication and enter
the Inbound name, Outbound name, and Shared password.
These settings must be the same on both PBXs forming the
office peer trunk.
The PBX on each end will use the settings to authenticate
incoming and outgoing calls.
4. Click Create.
After setting up the peer office, create outgoing and incoming dial plans for the local and
peer offices. For more information, see “Configuring Call Routing” on page 189.
Fortinet Technologies Inc.
Page 188
FortiVoice Phone System 5.3.0 Administration Guide
Configuring Call Routing
Dial plans define how calls flow into and out of the FortiVoice unit. Without dial plans, telephone
communications among PBXs are impossible.
This topic includes:
• Configuring inbound dial plans
• Configuring outbound dial plans
• Configuring direct inward dialing
Configuring inbound dial plans
The Call Routing > Inbound > Inbound submenu lets you configure dial plans for incoming calls
to the FortiVoice unit.
When the FortiVoice unit receives a call, the call is processed according to the inbound dial
plan. To process the call, the FortiVoice unit selects the dial plan rule that best matches the
dialed number and processes the call using the settings in the dial plan rule. For example, if
your main line is 123-4567, you can set a dial plan rule that sends all incoming calls dialing
123-4567 to the auto attendant. Once the auto attendant is reached, the callers can follow the
instructions, for instance, to dial an extension.
To view the inbound dial plans, go to Call Routing > Inbound > Inbound.
GUI field
Description
Enabled
Select to activate this dial plan.
Name
The name of the dial plan.
Call handling
The actions to process the incoming calls with matched dialed numbers
and/or caller IDs. For details, see “Call Handling” on page 190.
Handling
Description
The specific call handling actions. For details, see “Action” on
page 191.
From Trunk
The trunks of the incoming calls that are subject to this dial plan.
Match DID
The phone number pattern in your dial plan that matches many different
numbers. For details, see “Dialed Number Match” on page 190.
Match CID
The caller ID pattern for this dial plan. For details, see “Caller ID Match”
on page 190.
To set up an inbound dial plan
1. Go to Call Routing > Inbound > Inbound.
2. Click New.
3. Configure the following:
Fortinet Technologies Inc.
GUI field
Description
Name
Enter a name for this plan.
Enabled
Select to activate this dial plan.
Page 189
FortiVoice Phone System 5.3.0 Administration Guide
From Trunk
Select the trunks of the incoming calls that are subject to this dial
plan.
Select the trunks in the Available field and click -> to move them
into the Selected field.
Dialed Number Match With dialed number pattern matching, you can create one phone
number pattern in your dial plan that matches many different
numbers.
The called numbers matching this pattern will follow this dial plan
rule.
Create the number match following “Pattern-matching syntax” on
page 197 and “Pattern-matching examples” on page 197.
Caller ID Match
Click New to set the caller ID pattern following “Pattern-matching
syntax” on page 197 and “Pattern-matching examples” on
page 197 for this dial plan, and click Create.
You can enter an incoming call’s display name string or the caller’s
phone number string as the pattern.
Caller IDs under this pattern are subject to this plan.
Caller ID modification Select one or more caller ID modification configurations. You can
associate multiple caller ID modification configurations with a dial
plan. For more information on caller ID modification, see
“Modifying caller IDs” on page 122.
Call Handling
Action type
Select the actions to process the incoming calls with matched
dialed numbers and/or caller IDs.
Select the type of action for the plan and configure the actions
accordingly. See “Action” on page 191.
• Endpoint action: Select if you want to send incoming calls to
the local destinations according to operation schedules. For
example, send calls to the voicemail after business hours.
• Dial local number: Select if you want to send incoming calls to
the local destinations at any time. For example, you can enter
222xxxx as a pattern and strip 222. The FortiVoice unit will only
dial the last four digits for all called numbers matching the
pattern.
• Call routing: Select if you want to route incoming calls (to the
FortiVoice unit) to an external phone system using an outbound
dial plan.
Fortinet Technologies Inc.
Page 190
FortiVoice Phone System 5.3.0 Administration Guide
Action
Depending on the selected Action type, click New to configure the
actions:
• If you select the Endpoint action type:
a. Select the FortiVoice operation schedule for the action.
Click Edit to modify the selected schedule or click New to
configure a new one. For more information on FortiVoice
schedule, see “Scheduling the FortiVoice unit” on page 132.
b. Select an action for the incoming calls under this plan.
For some actions, you need to enter the extension (such as
Go voicemail) or select a profile (such as Play
announcement).
c. Click Create.
d. Repeat this procedure if you need more actions for this
action type.
Do not use the same schedule for more than one action to
avoid schedule conflict.
• If you select the Dial local number type:
a. Click New to add the number pattern in the Value field
following “Pattern-matching syntax” on page 197 and
“Pattern-matching examples” on page 197 for this dial plan.
Repeat to add more patterns.
b. For Strip, enter a number to omit dialing the starting part of
a pattern. 0 means no action.
For example, if your Match Pattern is 222XXXX and Strip is
3, the FortiVoice unit will only dial the last four digits for all
called numbers matching the pattern.
c. For Prefix, add a number before a pattern.
For example, if your Match Pattern is 9XXX and the numbers
under this pattern have been upgraded to have an
additional digit 5 at the beginning, you can enter 5 for the
Prefix. When an incoming call matches the pattern, the
FortiVoice unit will add a 5 before the number.
d. For Postfix, add a number after a pattern.
For example, if your Match Pattern is 9XXX and the numbers
under this pattern have been upgraded to have an
additional digit 5 at the end, you can enter 5 for the Postfix.
When an incoming call matches the pattern, the FortiVoice
unit will add a 5 after the number.
e. Click Create.
• If you select the Call routing type, select the available outbound
dial plans and click -> to move them into the Selected member
field. This means that the FortiVoice unit will route incoming
calls to an external phone system using the selected outbound
dial plans.
4. Click Create.
Fortinet Technologies Inc.
Page 191
FortiVoice Phone System 5.3.0 Administration Guide
Configuring direct inward dialing
The Call Routing > Inbound > DID Mapping submenu lets you configure how to map Direct
Inward Dialing (DID) numbers.
Local phone companies offer DID service to provide a block of telephone numbers for calling
into a company’s PBX system over limited rented physical lines (also called “trunk lines”). The
phone numbers you rent may not be enough to provide a DID number for each workstation,
because each DID can only be mapped to one extension. With the FortiVoice unit, you have 2
options to address this issue:
• only map the DID numbers to the extensions you want.
• map a DID number to one or more extensions based on the callers’ phone numbers.
For more information, see “Mapping DIDs” on page 193.
To view the DIDs, go to Call Routing > Inbound > DID Mapping.
GUI field
Description
Enabled
Select to activate this DID.
Rule Name
The name of the DID.
Incoming Trunk
The trunk used for dialing the DIDs.
Schedule
The schedule to apply the rule.
Caller ID
modification
The caller ID modification configuration. For more information, see
“Inbound caller ID modification” on page 192.
To configure a DID
1. Go to Call Routing > Inbound > DID Mapping.
2. Click New.
3. Configure the following:
GUI field
Description
DID Rule
Fortinet Technologies Inc.
Rule name
Enter a name for this DID setting.
Enabled
Select to activate this DID setting.
Trunk
Select the trunk used for dialing the DIDs.
Schedule
Select a schedule to apply the rule. For information on
creating schedules, see “Scheduling the FortiVoice unit” on
page 132.
Inbound caller ID
modification
Select the caller ID modification configuration. For more
information on caller ID modification, see “Modifying caller
IDs” on page 122.
Page 192
FortiVoice Phone System 5.3.0 Administration Guide
Inbound fallback
action
Select the action to take if a caller not in the caller list dialed
the DID number mapped to an extension.
For some actions, you need to enter the extension, such as
Dial voicemail.
For information on filtering callers, see “Mapping DIDs” on
page 193.
Number Mapping
For adding a number mapping, see “Mapping DIDs” on
page 193.
Click Export to open or save the number mapping file and
Import to browse for a number mapping file.
Mapping DIDs
You can map a DID number to one extension. You can also map a DID to multiple extensions
based on the callers’ phone numbers. For example, calling numbers 123-4567, 123-4568, and
123-4569 can call the DID number 222-1000 to reach extension 1234. Calling numbers
234-4567, 234-4568, and 234-4569 can call the same DID number 222-1000 to reach extension
1265. In both cases, the calling numbers will display on the extension.
If a caller outside the configured caller list dialed the mapped DID number, the FortiVoice unit
will react according to the selected fall back action. For details, see “Inbound fallback action”
on page 193.
To map DIDs
1. Go to Call Routing > Inbound > DID Mapping.
2. Click New.
3. In Number Mapping, click New.
4. Configure the following:
Fortinet Technologies Inc.
GUI field
Description
Map Setting
This option allows you to map a DID number to an extension.
DID number
Enter the DID number that you want to map to an extension. The
DID number cannot be mapped to more than one extension
unless the DID is bundled with a caller number (see “Advanced
Setting” on page 194). Otherwise, an error message about
duplicate entry appears and the DID mapping configuration
cannot be saved.
Extension
Enter the extension that you want to map to the DID number.
Page 193
FortiVoice Phone System 5.3.0 Administration Guide
Option
Select Inbound to direct incoming calls to the extension through
the mapped DID. If this option is not selected, incoming calls to
this extension through the mapped DID will follow the inbound
fallback action configured in “Inbound fallback action” on
page 193. By default, this option is selected.
Select Outbound to send the DID numbers of the extensions
mapped to the DID with outgoing calls so that the DID numbers
can display on the called phones. If this option is not selected, the
extension’s DID number is not sent with outgoing calls and the
phone number displayed on the called phone could be the
FortiVoice main number (see “Main number” on page 107) or the
trunk phone number (see “Phone Number” on page 179)
associated with the extension. Alternatively, you can choose the
caller ID to display on the called phone when configuring an
extension (see “External caller ID” on page 139).
By default, both Inbound and Outbound are selected.
Advanced Setting
Caller number
This option allows you to bundle caller numbers to a DID number
which can be mapped to any extension.
Click New to add the caller’s phone number or pattern in the
Pattern String field and click Create.
Repeat to add more calling numbers or patterns.
Only the caller numbers matching the numbers or patterns you
set will reach the mapped extension when they dial the DID
number.
For information on phone number patterns, see
“Pattern-matching syntax” on page 197 and “Pattern-matching
examples” on page 197.
5. Click Create.
Configuring outbound dial plans
The Call Routing > Outbound > Outbound submenu lets you configure dial plans for outgoing
calls from the FortiVoice unit.
You can configure dial plans on the FortiVoice unit to route calls made from a FortiVoice
extension to an external phone system. The external phone system can be one or more PSTN
lines or a VoIP service provider. To route calls to an external phone system, you add dial plan
rules that define the extra digits that extension users must dial to call out of the FortiVoice unit.
The rules also control how the FortiVoice unit handles these calls including whether to block or
allow the call, the destinations the calls are routed to and whether to add digits to the beginning
of the dialed number.
For example, if users should be able to dial 911 for emergencies, you should include a dial plan
rule that sends all calls that begin with 911 to an external phone system. This rule should also
override the default outgoing prefix so that users can dial 911 without having to dial 9 first.
To view the outbound dial plans, go to Call Routing > Outbound > Outbound.
GUI field
Fortinet Technologies Inc.
Description
Page 194
FortiVoice Phone System 5.3.0 Administration Guide
Test
Select to test if the dial plan is created successfully.
For more information, see “Testing outbound dial plans” on page 196.
Enabled
Select to activate this dial plan.
Name
The name of the dial plan.
Pattern
The phone number pattern in the dial plan that matches other numbers.
For details, see “Dialed Number Match” on page 195.
Match CID
The caller ID pattern for this dial plan. For details, see “Caller ID Match”
on page 195.
Call handling
The call handling action for the numbers matching the configured
number pattern and the caller IDs matching the caller ID pattern. For
details, see “Call Handling” on page 195.
To set up an outbound dial plan
1. Go to Call Routing > Outbound > Outbound.
2. Click New.
3. Configure the following:
GUI field
Description
Name
Enter a name for this plan.
Enable
Select to activate this dial plan.
Emergency call
Select to allow emergency call with this plan. By default, this is
selected.
For information on setting emergency number, see “Setting PBX
location and contact information” on page 106.
Dialed Number
Match
With dialed number pattern matching, you can create one phone
number pattern in your dial plan that matches many different
numbers.
The dialed numbers matching this pattern will follow this dial plan
rule.
For information on adding a dialed number match, see “Creating
dialed number match” on page 196.
Caller ID Match
Click New to set the caller ID pattern following “Pattern-matching
syntax” on page 197 and “Pattern-matching examples” on page 197
for this dial plan, and click Create.
You can enter a caller’s display name string or the caller’s phone
number string as the pattern.
Callers with IDs under this pattern are subject to this plan.
Call Handling
Fortinet Technologies Inc.
Click New to configure the call handling action for the numbers
matching the configured number pattern and the caller IDs matching
the caller ID pattern. For details, see “Configuring call handling
actions” on page 198.
Page 195
FortiVoice Phone System 5.3.0 Administration Guide
4. Click Create.
Testing outbound dial plans
After you create a dial plan, you can select the dial plan and click Test to see if the dial plan
works.
For more information, see “Test” on page 195.
To test an outbound dial plan
1. Go to Call Routing > Outbound > Outbound.
2. Select the dial plan that you want to test and click Test.
The call test page appears.
3. Configure the following:
GUI field
Description
Test Call - Dry Run
Run a system outbound dial plan test without making a real
phone call.
Destination number Enter a destination number to call.
From number
Enter the number from which you want to call the destination
number. The FortiVoice unit will connect this number with the
destination number for the test.
Test
Click to start the dry run test and view the Test result.
Reset
Click to remove the test result in order to start a new test.
Test Call
Test the outbound dial plan by making a real phone call.
Destination number Enter a destination number to call.
After call is
established
Select the FortiVoice action once it calls the destination
number:
• Play welcome message: The FortiVoice unit will play a
message to the destination number.
• Connect test call to number: In the Number field, enter the
number from which you want to call the destination
number. The FortiVoice unit will connect this number with
the destination number to test the trunk.
Test
Click to start the test and view the Test result.
Reset
Click to remove the test result in order to start a new test.
Creating dialed number match
You can create one extension number pattern in your dial plan that matches many different
numbers for outbound calls.
The numbers matching this pattern will follow this dial plan rule.
Fortinet Technologies Inc.
Page 196
FortiVoice Phone System 5.3.0 Administration Guide
The FortiVoice unit supports the following pattern-matching syntax:
Table 17:Pattern-matching syntax
Syntax
Description
X
Matches any single digit from 0 to 9.
Z
Matches any single digit from 1 to 9.
N
Matches any single digit from 2 to 9.
[15-7]
Matches a single character from the range of digits specified. In this case, the
pattern matches a single 1, as well as any number in the range 5, 6, 7.
.
Wildcard match; matches one or more characters, no matter what they are.
!
Wildcard match; matches zero or more characters, no matter what they are.
Table 18:Pattern-matching examples
Pattern
Description
NXXXXXX
Matches any seven-digit number, as long as the first digit is 2 or higher.
NXXNXXXXXX
This pattern matches with areas with 10-digit dialing.
1NXXNXXXXXX
Matches the number 1, followed by an area code between 200 and 999,
then any seven-digit number. In the North American Numbering Plan calling
area, you can use this pattern to match any long-distance number.
011.
Matches any number that starts with 011 and has at least one more digit.
To create a dialed number match
1. Go to Call Routing > Outbound > Outbound.
2. Click New.
3. In Dialed Number Match, click New.
4. Configure the following:
GUI field
Description
Match Pattern
New
Modification
Strip
Click to add the number pattern in the Value field following
“Pattern-matching syntax” on page 197 and “Pattern-matching
examples” on page 197 for this dial plan. Repeat to add more
patterns.
You can manipulate the number patterns you entered.
Enter a number to omit dialing the starting part of a pattern. 0
means no action.
For example, if your Match Pattern is 9XXX and Strip is 1, you
only need to dial the last three digits for this pattern.
Fortinet Technologies Inc.
Page 197
FortiVoice Phone System 5.3.0 Administration Guide
Prefix
Add a number before a pattern, such as area code.
For example, if your Match Pattern is 123XXXX and its area
code is 555, you can enter 555 for the Prefix. When you dial a
number under this pattern, you do not need to dial the area
code 555.
Postfix
Add a number after a pattern.
For example, if your Match Pattern is 9XXX and the numbers
under this pattern have been upgraded to have an additional
digit 5 at the end, you can enter 5 for the Postfix. When you dial
a number under this pattern, you do not need to dial the last
digit 5.
5. Click Create.
Configuring call handling actions
Configure the call handling action for the numbers matching the configured number pattern and
the caller IDs matching the caller ID pattern.
To configure the call handling action
1. Go to Call Routing > Outbound > Outbound.
2. Click New.
3. In Call Handling, click New.
4. Configure the following:
GUI field
Description
Call Handling
Fortinet Technologies Inc.
Schedule
Select the FortiVoice operation schedule to implement this
plan. Click Edit to modify the selected schedule or click New to
configure a new one. For more information on PBX schedule,
see “Scheduling the FortiVoice unit” on page 132.
Action
Select the call handling action for the numbers matching the
configured number pattern and the caller IDs matching the
caller ID pattern.
Outgoing trunk
Select the trunk for the outbound calls. Click Edit to modify the
selected trunk or click New to configure a new one. For more
information on trunks, see “Configuring Trunks” on page 175.
Caller ID
modification
Select the caller ID modification configuration. Click Edit to
modify the selected configuration or click New to configure a
new one. For more information on caller ID modification, see
“Modifying caller IDs” on page 122.
Page 198
FortiVoice Phone System 5.3.0 Administration Guide
Warning message
If you select Allow with warning or Deny with warning in the
Action field, select the sound file for the warning. Click Edit to
modify the selected file or click New to configure a new one.
For more information on sound files, see “Managing sound files
and music on hold” on page 119.
Delay
Optionally, if you want to discourage certain users for making
outbound calls, enter the call delay time in seconds.
5. Click Create.
Fortinet Technologies Inc.
Page 199
FortiVoice Phone System 5.3.0 Administration Guide
Setting up a Call Center
A call center allows an organization to receive or transmit a large volume of requests by
telephone in a centralized office.
You can configure a call center and operate the center on the user web portal.
This option is only available if you have purchased a call center license.
This topic includes:
• Creating call queues and queue groups
• Configuring agents
• Configuring IVRs
• Configuring surveys
• Configuring other agent information
• Configuring agent profiles
• Working with call queue statistics
• Configuring call center report profiles and generating reports
Creating call queues and queue groups
Call queuing, or Automatic Call Distribution (ACD), enables the FortiVoice unit to queue up
multiple incoming calls and aggregate them into a holding pattern. Each call is assigned a rank
that determines the order for it to be delivered to an available agent (typically, first in first out).
The highest-ranked caller in the queue is delivered to an available agent first, and every
remaining caller moves up a rank.
With call queuing, callers do not need to dial back repeatedly trying to reach someone, and
organizations are able to temporarily deal with situations when callers outnumber agents.
This topic includes:
• Creating call queues
• Creating queue groups
Creating call queues
Configure a call queue and add it in an inbound dial plan as a call handling action to make it
effective. For more information, see “Configuring inbound dial plans” on page 189.
Call queues consist of:
• Incoming calls waiting in the queue
• Agents who answer the calls in the queues
• A plan for how to handle the queue and assign calls to agents
• Music played while waiting in the queue
• Announcements for agents and callers
Depending on their privileges, agents can log into a queue to answer calls or transfer calls to
another queue, which can then be answered by another available agent.
Agents can be static or dynamic. Static agents are always connected to the queues, and
dynamic agents need to log into the queue in order to process calls.
Fortinet Technologies Inc.
Page 200
FortiVoice Phone System 5.3.0 Administration Guide
To view the call queues, go to Call Center > Call Queue > Call Queue.
GUI field
Description
Queue ID
The name of the call queue.
Display Name
The queue name displaying on the queue extension.
Number
The extension number for the call queue.
Department
The departments of the agents enrolled in the queue.
Agents
The extensions of the agents enrolled in the queue.
To create a call queue
1. Go to Call Center > Call Queue > Call Queue.
2. Click New and configure the following.
GUI field
Description
Call Queue
Queue ID
Enter an ID for the queue.
Number
Enter an extension for callers to dial and enter into a call
queue following the extension number pattern. See
“Configuring PBX options” on page 107.
This is another way to use a call queue configuration in
addition to adding it in an inbound dial plan as a call handling
action.
Even if you enter an extension, you can still add the call queue
configuration in an inbound dial plan as a call handling action.
In this case, the dial plan ignores this extension and still uses
the extension to which it is applied for call queue action.
Show suggested
numbers
Select and click in the Number field to display the extension
numbers available for use. If it is deselected, clicking in the
Number field displays the extension numbers already in use.
This option also serves as a diagnostic tool for finding and
fixing duplicate or missing numbers. Missing numbers are the
extensions that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can
click the icon and fix the numbers. For more information, see
“Fixing duplicate or missing numbers” on page 143.
3. Click Create.
4. From the call queue list, select the queue you just create.
5. Configure the following:
GUI field
Description
Call Queue
Fortinet Technologies Inc.
Page 201
FortiVoice Phone System 5.3.0 Administration Guide
Number
Enter an extension for callers to dial and enter into a call
queue following the extension number pattern. See
“Configuring PBX options” on page 107.
This is another way to use a call queue configuration in
addition to adding it in an inbound dial plan as a call handling
action.
Even if you enter an extension, you can still add the call queue
configuration in an inbound dial plan as a call handling action.
In this case, the dial plan ignores this extension and still uses
the extension to which it is applied for call queue action.
Show suggested
numbers
Select and click in the Number field to display the extension
numbers available for use. If it is deselected, clicking in the
Number field displays the extension numbers already in use.
This option also serves as a diagnostic tool for finding and
fixing duplicate or missing numbers. Missing numbers are the
extensions that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can
click the icon and fix the numbers. For more information, see
“Fixing duplicate or missing numbers” on page 143.
Status
Select to enable the call queue.
Display name
Enter the queue name displaying on the queue extension,
such as Support.
Description
Enter any notes about this queue.
Department
Select the department to which the queue belongs. For
information on creating departments, see “Creating extension
departments” on page 166.
Queue Setting
Maximum queue
capacity
Enter the maximum number of callers for the call queue.
When the call queue is full, other callers will be dealt with
according to the Queue Overflow call handling action you set
in “Queue Overflow” on page 207.
The maximum is 100.
Maximum queuing
time
Enter the maximum call queue waiting time in minutes. When
the call waiting time is due, the callers in the queue will be
dealt with according to the call handling action you set in
“Queue Timeout” on page 208.
The maximum is 720 minutes.
Fortinet Technologies Inc.
Ring duration
Enter the time in seconds to ring each agent. If a call is not
answered when the ring duration is due, the call is transferred
to the next agent. The range is between 5 to 120 seconds.
Music on hold
Select a sound file or music on hold file to play when a caller
is waiting. For more information, see “Managing sound files
and music on hold” on page 119.
Page 202
FortiVoice Phone System 5.3.0 Administration Guide
Call Distribution
Skill Based Routing Select and choose a call routing option. This option is based
on agent skill level scores. For more information, see
“Creating agent skill levels” on page 219.
• Lowest level first: The call will ring the agent with the
lowest skill level score first and move up the rank if the
agent is unable to take the call, that is, the agent’s
extension is in a Not Ready status.
• Highest level first: The call will ring the agent with the
highest skill level score first and move down the rank if the
agent is unable to take the call, that is, the agent’s
extension is in a Not Ready status.
Default skill
Select the group, such as Billing, Sales, or Support, that the
call distribution is executed. You acan add a new skill or
modify an existing one. For more information, see “Adding
agent skill sets” on page 218.
Distribution policy
Select a call Distribution policy.
This option works like following:
• If Skill Based Routing is not selected, calls are distributed
according to the policy you choose.
• If Skill Based Routing is selected, calls are distributed
according to the skill based call routing option you choose.
This option only applies to the situation when you have
agents with the same skill level in a queue. In such cases,
calls are distributed to these agents according to the
policy you choose.
• Ring all: rings all available agents (default).
• Round robin: rings all agents in a queue equally in
some rational order, usually from the top to the bottom
of a list and then starting again at the top of the list and
so on.
• Sequential: rings each agent in a sequential manner
regardless of whether they have answered calls.
• Random: rings an agent at random.
• Least recent: rings the agent that least recently
received a call.
• Fewest calls: rings the agent that has completed the
fewest calls in this queue.
• Weight random: rings a random agent, but uses the
agent’s number of received calls as a weight.
• Priority based: rings agents based on call answering
priorities for callers entering the call queue. A new call
always starts with the lowest priority. However, a queue
manager with privileges can change the priority of a call
on the agent console of the user web portal. See
“Setting caller priorities” on page 219.
Additional Settings
Fortinet Technologies Inc.
Page 203
FortiVoice Phone System 5.3.0 Administration Guide
Distinctive settings Announce queue name: Select a sound file that announces
for agent
the queue name. You can add a new one or modify an existing
one. For more information, see “Managing sound files and
music on hold” on page 119.
Caller ID option: Select how you want the IDs of the calls to
this queue to display. If you select Prefix, the queue Display
name is added before the caller ID on the agent’s phone. If
you select Replace, the queue Display name replaces the
caller ID on the agent’s phone.
Ring Pattern: Select a queue extension ring pattern.
Business schedule
Click >> and select a operation schedule for the queue. For
example, “business_hour” schedule means agents are only
available to answer the calls for this queue during business
hours. For information on scheduling, see “Scheduling the
FortiVoice unit” on page 132.
Announcement to
caller
Announce holdtime: Select if you want to announce the queue
waiting time to a caller at the set interval. You may also select
to announce only once.
Announce position: Select to announce a caller’s waiting
position in the queue, such as “You are caller No. 5 in the call
queue”.
• No: Do not announce a caller’s position.
• Always: Always announce a caller’s position.
• Abbreviated: Announce a caller’s position only once if the
caller is over the marked position and always announce
once the caller is within the marked position.
• Minimal: Announce only when the caller is within the
marked position.
• Mark position: Enter the benchmark for selecting
Abbreviated or Minimal setting.
For example, if you select Abbreviated and enter 5, a
caller’s position is announced when the caller becomes
No. 5 in the queue and announced only once before the
caller becomes No. 5 in the queue.
• Announcement interval: Enter the announcement
frequency in seconds.
Custom announcement: You can also customize the
announcement settings.
• Mode: Select the method of greeting announcement to the
caller once the caller enters this call queue. You can also
select to diable this function.
If you select Periodic or Random, enter the announcement
frequency in seconds in Announcement interval.
• Audio: Select a greeting sound file for the announcement.
For more information, see “Managing sound files and
music on hold” on page 119.
Queue entry announcement: Select Enable to announce to
callers when they enter a call queue.
Fortinet Technologies Inc.
Page 204
FortiVoice Phone System 5.3.0 Administration Guide
Service Level
Interval: Enter the time period in minutes for calculating the
threshold.
Threshold: Enter the call answering rate for a certain period of
time. The action triggered by the threshold being reached is
configured in “Call Handling” on page 207.
Service level low threshold is used in call handling: Click
Service level low call handling to configure how other callers
will be dealt with according to the Queue Overflow call
handling action you set in “Service Level Low” on page 208
when the call queue is full
Alert Settings
Alert Event: Select the event that triggers an action which is
configured in “Call Handling” on page 207.
Send alert email: Select if you want to send an email when an
alert event is triggered. Click New to enter an email address.
Call extension/number: Select this option and an extension
number if you want a phone call when an alert event is
triggered. Click New to add an extension.
GUI popup: Select to have a popup notification on the user
web portal GUI when an alert event is triggered. This only
applies to agents with the particular privilege called Queue
alert. See Agent Console Privilege in “Configuring agent
profiles” on page 220.
Alert interval: Enter a value in minutes during which time no
alert is sent. For example, if you enter 60, you will not receive
any alerts for an hour even if an alert event is triggered. This
will be the case each time when you receive an alert
notification.
If you enter 0, you will receive notifications each time when an
event is triggered.
Callback Setting
This option allows callers waiting in a queue to request a
callback following the recorded instructions and wait for an
agent to return their call.
Status: Select to enable this option.
Callback mode:
• Agent call back manually(from call center console): Select
to allow an agent to manually call the caller using the agent
console on the user web portal.
• System call back automatically: Select to allow the
FortiVoice unit to call the caller automatically based on the
callback number collected when an agent is available.
Fortinet Technologies Inc.
Page 205
FortiVoice Phone System 5.3.0 Administration Guide
Prompt to caller to leave the call back number: Select the
method to collect the callback number.
• System default: Select to use system defined voice file.
• User defined IVR: Select to use user configured IVR.
For more information on IVR, see “Configuring IVRs” on
page 210.
Prompt to caller after callback call established: Select to ring
the caller when a callback call is set up.
Survey Setting
Surveys are used to collect customer feedback to ensure that
the service delivered by your call center agents consistently
meets corporate standards and drives high customer
satisfaction.
Status: Select to enable this option.
Survey: Choose the survey configuration for the call queue.
For more information on surveys, see “Configuring surveys”
on page 216.
Agent
Agent type
Select the agent login mode.
Once enrolled into the queue, static agents are always
connected to the queues while dynamic agents need to log
into the queue in order to process calls.
Auto-logout time
If you select Dynamic login mode, enter the agent login expiry
time in hours. For example, if you enter 5, the agent will be
logged out 5 hours after having logged into the queue.
Logout all agents
after scheduled
business hour
Select to log out all agents in the queue when the scheduled
business hour is due.
Wrap up time
Enter the time (in seconds) needed by agents to complete a
queue call including taking notes or record-keeping, starting
from the moment that call is hang up.
The default is 0 second.
Wrap up outgoing
call
Select if the agent needs to make an outgoing customer call
and time to take notes or record-keeping, starting from the
moment that call is hang up.
You can enter the wrap up time in the “Wrap up time”field.
Fortinet Technologies Inc.
Page 206
FortiVoice Phone System 5.3.0 Administration Guide
Call waiting
Select this option so that if an agent is on the phone when a
queue call comes in, the caller information will display on the
agent’s phone. The agent can choose to answer the call or
not. If the agent does not answer the call, after the ring
duration is due, the call is transferred to the next agent.
This option is different from the call waiting feature of a regular
extension (See “Setting extension user preferences” on
page 156). On a regular extension, the call waiting feature only
applies to the calls that directly go to the extension. On a
queue extension, the call waiting feature only applies to the
calls that go to the extension from the queue.
Call Handling
When no logged-in
agent
You may select to queue a caller or not if there is no agents
available.
If you select Do not queue, an incoming call will be handled by
your general call handling configuration, such as auto
attendant.
This option is only available if agent type is Dynamic.
Scheduled Business Click to configure the business hour call handling action for
Hour call handling the queue. For details, see “Configuring scheduled business
hour queue call handling actions” on page 207.
Non Scheduled
Business Hour call
handling
Click to configure the non business hour call handling action
for the queue. For details, see “Configuring scheduled
business hour queue call handling actions” on page 207.
6. Click OK.
Configuring scheduled business hour queue call handling actions
Configure the call handling action for the queue. This action applies to all calls once they enter
into the queue.
This option is only available when you edit a queue.
To configure the call handling action
1. Go to Call Center > Call Queue > Call Queue.
2. Select a call queue for which you want to configure queue call handling actions and click
Edit.
3. In Call Handling, click Scheduled Business Hour call handling.
4. Configure the situation upon which the FortiVoice unit can be configured to take
corresponding actions:
GUI field
Description
Queue Overflow
The situation when callers exceed the maximum waiting callers
you set. See “Maximum queue capacity” on page 202.
A popup notification appears when this barometer is triggered.
Fortinet Technologies Inc.
Page 207
FortiVoice Phone System 5.3.0 Administration Guide
Queue Timeout
Callers waiting time exceeds the maximum waiting time set in
“Maximum queuing time” on page 202.
A popup notification appears when this barometer is triggered.
Service Level Low
Service level represents the maximum amount of time a caller
should ideally have to wait before being presented to an agent.
You need to set service level and service level interval in the
FortiVoice CLI.
For example, if service level interval is set to 60 seconds and
the service level percentage is 80 percent, that means 80
percent of the calls that came into the queue were presented to
an agent in less than 60 seconds. Any service level percentage
lower than 80 is considered to be low.
All Agents Logout
There are no agents in the queue to answer calls. The action for
this option only works if you select Queue caller for “When no
logged-in agent” on page 207.
All Agents Paused
There are no agents in the queue to answer calls. The action for
this option only works if you select Queue caller for “When no
logged-in agent” on page 207.
Unclassified
Any reason that you need to schedule call handlings.
Call Processing
Click New to configure call handling action for the situation you
selected.
For some processes that may require further actions, you need
to add one or more call processes to complete the call
handling. For example, after adding a process that contains a
Set call queue priority action, you can add another process with
a Transfer to queue action to complete the call handling. In this
case, the call will be processed again with new priority after it is
transferred to the queue.
Schedule
Select the FortiVoice operation schedule to implement this call
handling action. For more information on schedules, see
“Scheduling the FortiVoice unit” on page 132.
Action
Select the call handling action. Depending on the action
selected, further configuration may be needed. For example, if
you select Dial extension for Action, enter the extension to
which a call is transferred.
5. Click Create, then OK.
Configuring non scheduled business hour queue call handling actions
Configure the call handling action for the queue. This action applies to all calls once they enter
into the queue.
For some processes that may require further actions, you need to add one or more call
processes to complete the call handling. For example, after adding a process that contains a
Set call queue priority action, you can add another process with a Transfer to queue action to
complete the call handling. In this case, the call will be processed again with new priority after it
is transferred to the queue.
This option is only available when you edit a queue.
Fortinet Technologies Inc.
Page 208
FortiVoice Phone System 5.3.0 Administration Guide
To configure the call handling action
1. Go to Call Center > Call Queue > Call Queue.
2. Select a call queue for which you want to configure queue call handling actions and click
Edit.
3. In Call Handling, click Non Scheduled Business Hour call handling.
4. On the Call Processing page, click New to configure call handling action.
5. For Schedule, select the FortiVoice operation schedule to implement this call handling
action. For more information on schedules, see “Scheduling the FortiVoice unit” on
page 132.
6. For Action, select the call handling action. Depending on the action selected, further
configuration may be needed. For example, if you select Dial extension for Action, enter the
extension to which a call is transferred.
7. Click Create, then OK.
Creating queue groups
You can group queues together to facilitate queue management.
To create a call queue
1. Go to Call Center > Call Queue > Queue Group.
2. Click New.
3. Enter a name for the group.
4. Select the available call queues that you want to include in the group and click -> to move
them into the Selected field.
5. Click Create.
Configuring agents
Extensions with call center agent function enabled can be further configured with other call
center information, such as agent profile, managed departments, and skill sets. Call center
departments and user groups can also be set up to form the basis for department and group
management.
To configure an agent
1. Go to Call Center > Agents > Agents.
All extensions with call center agent function enabled display. Clicking Extensions opens the
IP extensions configuration page. For information, see “Configuring IP extensions” on
page 136.
2. Select the extension you want to configure and click Edit.
3. Select an agent profile. For more information, see “Configuring agent profiles” on page 220.
4. For Managed departments, click >>.
5. Select the departments to be managed by this agent if required, and click Done.
6. Click Member of Queues to select the call queues to join.
• Main/Outgoing queue: This option is for collecting the outgoing calls from all queues by
this agent and displaying them in “Working with call queue statistics” on page 221. You
Fortinet Technologies Inc.
Page 209
FortiVoice Phone System 5.3.0 Administration Guide
can select any queue of which this agent is a member for that purpose except None
which will not collect agent’s outgoing call information.
• Queues: Select the queues of which you want the extension/agent to be a member, and
click Apply.
7. Add skill sets for the agent by clicking New under Skill Sets.
8. Select the skill set for the agent, including skills and level, and click Create. For more
information about agent skills and levels, see “Adding agent skill sets” on page 218 and
“Creating agent skill levels” on page 219.
9. Click OK.
To set up a department
1. Go to Call Center > Agents > Department.
2. Click New and configure the following:
GUI field
Description
Department
Name
Enter a name for the department.
Comment
Click Click to edit and enter any notes you have for this
department.
Call Center
Manager
From the Available extension list, select the ones to be department
managers and click Done.
Managers can view call queue reports.
Member
From the Available extension list, select the ones to be members of
the department and click Done.
Each member can only belong to one department.
Queue
From the Available extension list, select the ones to be call queues
of the department and click Done.
Each queue can only belong to one department.
3. Click Create.
To set up a user group
1. Go to Call Center > Agents > Group.
2. Click New.
3. See “Creating user groups” on page 165.
Configuring IVRs
FortiVoice Interactive Voice Response (IVR) function allows it to interact with callers through the
use of voice and DTMF tones input via keypad. Callers proceed according to the IVR audio
instructions to reach the callees or get the information they need.
Fortinet Technologies Inc.
Page 210
FortiVoice Phone System 5.3.0 Administration Guide
Based on the information collected from callers and by interacting with the backend database,
FortiVoice IVR can prioritize the calls using call queues and present callers’ information to the
agents.
FortiVoice IVR interfaces with RESTful Web service for querying caller information from the
database.
This topic includes:
• Setting up an IVR
• Configuring restful service
Setting up an IVR
Call Center > IVR > IVR allows you to view the existing IVR list and create new IVRs.
Creating new IVRs includes configuring:
• SIP header collector to share IVR information among multiple FortiVoice units based on
information gathered by digit and RESTful collectors (see To configure a SIP header
collector)
• the digits collector to collect digit inputs from callers (see To configure a digit collector)
• the RESTful collector to gather caller information from database (see To configure a restful
collector)
• call handling to route the calls based on information gathered by digit and RESTful
collectors, and
• error handling to deal with unknown errors and RESTful service errors.
To view the IVR list
1. Go to Call Center > IVR > IVR.
2. Click the Expand all icon.
The IVR tree list displays. Under each IVR name, configuration items are listed. Clicking an
item opens its configuration page.
To configure a SIP header collector
1. Go to Call Center > IVR > IVR and click the Switch icon.
2. Click New and type the name of the IVR and description.
3. Click Create.
4. From the IVR name list, select the name you created and click Edit to open the IVR
configuration page.
5. For Description, select Click to edit to enter any notes you have for the IVR.
6. Click Add SIP header collector..
Fortinet Technologies Inc.
GUI field
Description
Name
Enter a name for the SIP header collector.
Description
Enter any notes you have for the SIP header collector.
Page 211
FortiVoice Phone System 5.3.0 Administration Guide
Variable
Click New and do the following:
1. For Variable, enter a value for a SIP header field based on your
organization’s SIP header definitions, for example, ticket_id.
This value must be the same on every FortiVoice unit that
shares IVR information.
2. For Share with, do the following:
• None: Select if you do not want to share the information that
the SIP header collector gathers with other interfaces.
• Agent console name: Select if you want agents in the
queues where the IVR calls are routed to see the information
that the SIP header collector gathers. Enter a name for the
information to display on the agent console.
• SIP header name: Select if you want to share the
information that the SIP header collector gathers with other
SIP header collectors. Enter a value in the Name field that
matches the value on the SIP header to enable information
sharing.
• Remote CDR name: Select if you want to share the
information that the SIP header collector gathers with a
remote CDR database. Enter a value in the Name field that
matches the value on the remote CDR to enable information
sharing.
3. Click Create.
4. Click Create.
You can create a maximum of 10 SIP header collectors which are saved as variables.
To configure a digit collector
1. After configuring the SIP header collector, click Add digit collector to configure digit inputs
collection from callers. You can create a maximum of 10 digits collectors.
Fortinet Technologies Inc.
GUI field
Description
Name
Enter a name for the digit collector.
Prompt
Select the audio file that you want callers to listen to. You can also
create a new file or edit the selected one. For more information,
see “Managing sound files and music on hold” on page 119.
Enable read back
Select if you want the digit inputs to be read out to the caller.
Page 212
FortiVoice Phone System 5.3.0 Administration Guide
Share with
None: Select if you do not want to share the information that the
digit collector gathers with other interfaces.
Agent console name: Select if you want agents in the queues
where the IVR calls are routed to see the information that the digit
collector gathers. Enter a name for the information to display on
the agent console.
SIP header name: Select if you want to share the information that
the digit collector gathers with SIP header collector. Enter a value
in the Name field that matches the value on the SIP header to
enable information sharing.
Remote CDR name: Select if you want to share the information
that the digit collector gathers with a remote CDR database. Enter
a value in the Name field that matches the value on the remote
CDR to enable information sharing.
Description
Enter any notes you have for the digit collector.
Digits Settings
Min digits
Enter the minimum digits the digits collector allows. The range is
1-30.
Max digits
Enter the maximum digits the digits collector allows. The range is
1-30.
Max invalid input Enter the number of times a caller is allowed for inputting wrong
allowed
digits. The call will be terminated if the limit is reached. The range
is 0-10.
Timeout
Enter the time limit that a caller is allowed for taking NO action
after the call is put through. The call will be terminated if the time
limit is reached. The range is 0-600 seconds.
Max timeout
allowed
Enter the number of timeouts a caller is allowed for taking no
action after the call is put through. The call will be terminated if the
number of timeouts limit is reached. The range is 0-10.
For example, if Timeout is set to 10 seconds and Max timeout
allowed to 3, a caller would have a total of 30 seconds timeout
time after he or she dials in and takes no action afterwards.
2. Click Create.
You can create a maximum of 10 digit collectors which are saved as variables.
To configure a restful collector
1. After configuring the digit collector, click Add restful collector to configure the database
collector for resource querying.
Fortinet Technologies Inc.
GUI field
Description
Name
Enter a name for the restful collector.
Service
Select the restful service for the collector. You can also create a
new service or edit the selected one. For more information, see
“Configuring restful service” on page 216.
Page 213
FortiVoice Phone System 5.3.0 Administration Guide
Method
Choose the method to submit the information collected by the
FortiVoice IVR system to the database server (as HTTP POST or
HTTP GET) and use the value as a variable in your SQL statement.
Parameters
Select Click to edit to enter query parameters to customize the
results returned from a GET or POST operation on the database,
such as sorting or filtering.
Optionally, click Add variable to insert self or system defined
variables into the parameters.
URL
Posting HTTP
Headers
Select Click to edit to enter a HTTP header for information
querying on the RESTful web service.
Optionally, click Add variable to insert self or system defined
variables into the HTTP header.
This option is only available if you select Post for Method.
Posting Message
Body
Select Click to edit to enter a HTTP message body for information
querying on the RESTful web service.
Optionally, click Add variable to insert self or system defined
variables into the HTTP body.
This option is only available if you select Post for Method.
Fortinet Technologies Inc.
Timeout
Enter the time allowed for the query to be processed. If the time
elapses before the query response is complete, partial information
may be returned. The range is 0-600 seconds.
Max retry allowed
Enter the number of database query tries allowed. The query will
be denied if the retry limit is reached. The range is 0-10.
Description
Enter any notes you have for the restful collector.
New (under Fields)
Click to name each of the attributes returned from a database
query to present it or use it as a variable.
Field
Enter a name for the attribute you want to define.
Query
Enter the query parameter for the attribute you want to define.
Optionally, click Add variable to insert self or system defined
variables into the parameter.
Page 214
FortiVoice Phone System 5.3.0 Administration Guide
Share with
None: Select if you do not want to share the information that the
restful collector gathers with other interfaces.
Agent console name: Select if you want agents in the queues
where the IVR calls are routed to see the information that the
restful collector gathers. Enter a name for the information to
display on the agent console.
SIP header name: Select if you want to share the information that
the restful collector gathers with SIP header collector. Enter a value
in the Name field that matches the value on the SIP header to
enable information sharing.
Remote CDR name: Select if you want to share the information
that the restful collector gathers with a remote CDR database.
Enter a value in the Name field that matches the value on the
remote CDR to enable information sharing.
2. Click Create and then Create.
You can create a maximum of 10 restful collectors which are saved as variables.
To configure IVR handling
1. After configuring the restful collectors, click Add IVR handling to configure call processing
using the digit and restful collector configurations.
SIP header, digit and restful collector configurations only take effect after IVR handling is set
up.
GUI field
Description
Condition
Configure the conditions based on which call processing actions
are taken.
Unconditional
Select if you do not need to configure the conditions. In this case,
the system default condition applies.
Variable
Click Add to insert self or system defined digit or restful variable
for the condition.
This option appears if you deselect Unconditional.
Operator
Use query operators to assign a value to the variable, or perform
mathematical operations.
This option appears if you deselect Unconditional.
Value
Enter the value assigned by the operator to the variable.
Optionally, click Add variable to insert self or system defined
variables into the value.
This option appears if you deselect Unconditional.
Description
Action
Fortinet Technologies Inc.
Enter any notes you have for the IVR handling.
Click New to configure the actions to take based on the
conditions.
Page 215
FortiVoice Phone System 5.3.0 Administration Guide
Action type
Select the IVR action. Depending on the action type selected,
further configuration may be needed. For example, if you select
Dial extension, enter the extension to which a call is transferred.
Click Create.
You can create multiple actions.
2. Click Create.
To configure error handling
1. After configuring IVR handling, click Add error handling to deal with unknown errors and
restful service errors.
2. For Error Type, select Unspecified for unknown errors and Restful for restful service errors.
3. For Action, click New.
4. Select the action. Depending on the action type selected, further configuration may be
needed. For example, if you select Dial extension, enter the extension to which a call is
transferred.
5. Click Create, Create.
6. Click OK to complete the IVR configuration.
Configuring restful service
FortiVoice IVR interfaces with restful web service for querying caller information from the
database.
Call Center > IVR > Restful service allows you to configure the restful web service.
To configure restful service
1. Go to Call Center > IVR > Restful service, click New and do the following:
GUI field
Description
Name
Enter a name for the configuration.
Protocol
Select the protocol for the service.
Base URL
Enter the URL of the server hosting restful service.
Click Test to validate the URL.
Authentication
Select to enter the user name and password for logging onto the
restful server.
SSL verification
Select if required.
Description
Click Click to edit to enter any notes for the configuration.
Configuring surveys
You can use surveys to collect customer feedback to ensure that the service delivered by your
call center agents consistently meets corporate standards and drives high customer
satisfaction. You can also set survey rules.
Fortinet Technologies Inc.
Page 216
FortiVoice Phone System 5.3.0 Administration Guide
To configure a survey
1. Go to Call Center > Survey > Survey.
2. Click New and type the name of the survey.
3. Click Create.
4. From the survey name list, select the name you created and click Edit to open the survey
configuration page.
5. Click Add digit collector to configure collecting digit inputs from callers. You can create a
maximum of 10 digits collectors.
GUI field
Description
Name
Enter a name for the digits collector.
Prompt
Select the audio file that you want callers to listen to. You can also
create a new file or edit the selected one. For more information,
see “Managing sound files and music on hold” on page 119.
Enable read back
Select if you want the digit inputs to be read out to the caller.
Question
Enter the survey question.
Digits settings
Max digits
Enter the maximum digits the digits collector allows. The range is
1-30.
Max invalid input Enter the number of times a caller is allowed for inputting wrong
allowed
digits. The call will be terminated if the limit is reached. The range
is 0-10.
Timeout
Enter the time limit that a caller is allowed for taking NO action
after the call is put through. The call will be terminated if the time
limit is reached. The range is 0-600 seconds.
Max timeout
allowed
Enter the number of timeouts a caller is allowed for taking no
action after the call is put through. The call will be terminated if the
number of timeouts limit is reached. The range is 0-10.
For example, if Timeout is set to 10 seconds and Max timeout
allowed to 3, a caller would have a total of 30 seconds timeout
time after he or she dials in and takes no action afterwards.
6. Click Create.
The digit collector is listed under Questionnaire. You may click New to add more.
7. If you want callers to comment on the survey, select Caller Comment.
8. For Audio prompt, select the audio file that explains to callers how to comment on the
survey. Click New to create a new audio file. For more information, see “Managing sound
files and music on hold” on page 119.
9. For Description, enter any notes for the Caller Comment.
10.Click OK.
To configure survey settings
1. Go to Call Center > Survey > Setting.
2. For Survey retention month, enter the number of months that you want to keep the surveys.
Fortinet Technologies Inc.
Page 217
FortiVoice Phone System 5.3.0 Administration Guide
3. For Max survey records, enter the maximum number of surveys you want to keep.
4. Click Apply.
Setting up queue view
You can create a queue view to let agents with privileges to view the snapshot of the key
information of queues on the user web portal, such as number of calls in queue, longest waiting
calls, and abandoned calls.
To apply the queue view configuration, you need to enable it in agent profile and apply the
profile to an agent. As a result, the agent will have a Queue Monitor icon once he or she logs
into the user web portal.
To set up a queue view
1. Go to Call Center > Monitor View > Monitor.
2. Click New and configure the following:
GUI field
Description
Name
Enter a name for the queue view.
Monitor Items
Click New to include the queues or agents that you want to
monitor.
Title
Enter a name for the configuration.
Type
Choose to monitor queues or agents.
Refresh interval
Enter the refresh interval time for the monitor view in seconds.
Queue
From the Available field select the queues to be included and click
->.
Click Create.
Logo
Select Customized logo to add text or logo for agents with
privileges to view on the user web portal.
In the text editor window, you can type the text or copy and paste
a logo here.
3. Click Create.
Configuring other agent information
Configure call agent skill sets, skill levels, reason codes, data service, and global settings to be
used for configuring agent profiles.
Adding agent skill sets
Depending on the agents skill sets and the nature of your business, you can classify agents into
different groups, such as Billing, Sales, or Support.
To add an agent skill set
1. Go to Call Center > Configuration > Skill Set.
Fortinet Technologies Inc.
Page 218
FortiVoice Phone System 5.3.0 Administration Guide
2. Click New.
3. Enter a name and description for the skill set.
4. Click Create.
Creating agent skill levels
The FortiVoice unit comes with 9 default skill levels, ranging from 10 to 90, with 10 to 30 being
junior, 40 to 60 being intermediate, and 70 to 90 being senior. You can modify the default skill
level descriptions, or create new skill levels.
To create an agent skill level
1. Go to Call Center > Configuration > Skill Level.
2. Click New.
3. Enter the skill level and description.
4. Click Create.
Modifying agent reason code descriptions
Agent reason codes explain why agents are not able to take calls, such as due to lunch break,
meeting, or vacation. You cannot change the default reason codes, but you can modify the
code descriptions.
To modify an agent reason code description
1. Go to Call Center > Configuration > Reason Code.
2. Double-click a reason code.
3. Enter the code description.
4. Click OK.
Configuring data service
If you use a third party software to generate call center reports or statistics, you can configure
the FortiVoice database to provide all data needed.
To configure data service
1. Go to Call Center > Configuration > Data Service.
2. Configure the schedule time.
3. Enable Local if you want to back up locally.
4. Enable Remote and configure the FTP/SFTP server credentials if you want to back up
remotely.
5. Configure the maximum backup number. When the maximum number is reached, the oldest
version will be overwritten.
6. Click Apply.
Setting caller priorities
You can set call answering priorities for callers entering the call queue. A new call always starts
with the lowest priority. However, a queue manager with privileges can change the priority of a
call on the agent console of the user web portal.
Fortinet Technologies Inc.
Page 219
FortiVoice Phone System 5.3.0 Administration Guide
To set caller priorities
1. Go to Call Center > Configuration > Global Settings.
2. For Call Center Settings, enter the caller’s highest and lowest priorities.
3. Click Apply.
Configuring agent profiles
Create agent profiles to define agent privileges for processing calls. Agent profiles become
effective when they are applied to the agent extensions. For more information, see “Setting up
local extensions” on page 136.
To create an agent profile
1. Go to Call Center > Profile > Profile.
2. Click New.
3. Configure the following:
GUI field
Description
Agent
Select the calls an agent can make or process.
Pickup call from
queue
Select to allow the agent to answer queue calls.
Ring no answer
Select the action to take when nobody answer a call in the queue.
• Do nothing: No action is taken and the call keeps ringing.
• Auto pause: The call is paused automatically.
• Auto logout: The agent to whom this profile applies is
automatically logged out of the queue.
• Auto hold off: The call is automatically put on hold.
Queue
Select to allow an agent to prioritize the calls in the queue or
transfer calls to another queue on the agent console of the user
web portal.
If you select Caller prioritization, the Priority button appears on the
agent console of the user web portal. If you select Transfer call to
another queue, the Transfer button appears on the agent console
of the user web portal.
Manager Privilege
If the agent is a manager, select the privileges to manage the
agents using the agent console of the user web portal.
The privileges include coaching, listening, and logging in and
logging out agents, or pausing and resuming agents.
Agent Console
Privilege
Select Enable agent console to choose the widget and GUI popup
alert for an agent to view on the agent console of the user web
portal.
Monitoring Console
Privilege
Select to enable monitoring console on the user web portal.
Monitoring Queue
Fortinet Technologies Inc.
Page 220
FortiVoice Phone System 5.3.0 Administration Guide
Member of
queues
Select to enable the agent to only monitor the queues of which the
agent is a member.
Selected
Select the queues the agent is allowed to monitor by moving the
selected queues from the Available field to the Selected field. The
Available field lists all queues regardless if the agent is a member
of them.
All
Select to allow the agent to monitor all call queues.
4. Click Create.
Working with call queue statistics
Go to Call Center > Statistics to view agent and queue daily summaries. You can also download
the summaries. The summaries cover a period of 30 days.
To view agent daily summary
1. Go to Call Center > Statistics > Agent Daily Summary.
GUI field
Description
Date
The date of the agent call summary.
Agent
The agent ID.
Work Time
The agent’s total work hours for the queue that the agent worked the
longest.
Talk Time
The total time the agent talked on the phone in all queues combined.
N/A Time
The total time the agent was away from the phone in all queues combined.
Total
Answered
The total calls the agent answered in all queues combined.
Total RNA
The total calls not answered by the agent in all queues combined.
Out Call
The outgoing calls made by the agent. This option is dependant on your
queue management configuration in “Member of Queues” on page 146.
Out Talk Time The total time of outgoing calls made by the agent. This option is
dependant on your queue management configuration in “Member of
Queues” on page 146.
Voicemail
The number of voicemails left on the agent’s extension.
To view queue daily summary
1. Go to Call Center > Statistics > Queue Daily Summary.
Fortinet Technologies Inc.
GUI field
Description
Date
The date of the call queue summary.
Queue
The queue name.
Page 221
FortiVoice Phone System 5.3.0 Administration Guide
Calls
The number of calls reached this queue.
Abandoned
The number of calls that gave up after reaching the queue.
Overflow
The number of callers exceeding the maximum waiting callers you set for
the queue. See “Maximum queue capacity” on page 202.
Talk Time
The total phone talk time of the queue.
Hold Time
The total time for holding calls in the queue.
Out Call
The outgoing calls made by the agents in the queue. This option is
dependant on your queue management configuration in “Member of
Queues” on page 146.
Out Talk Time The total time of outgoing calls made by the agents in the queue. This
option is dependant on your queue management configuration in “Member
of Queues” on page 146.
Configuring call center report profiles and generating reports
The Call Center > Report > Report tab displays a list of call center report profiles.
A report profile is a group of settings that contains the report name, its subject matter, its
schedule, and other aspects that the FortiVoice unit considers when generating reports from
call center log data. The FortiVoice unit presents the information in tabular and graphical format.
You can create one report profile for each type of report that you will generate on demand or on
a schedule.
Generating reports can be resource intensive. To avoid phone processing performance
impacts, you may want to generate reports during times with low traffic volume, such as at
night. For more information on scheduling the generation of reports, see “Configuring report
email notifications” on page 224.
To view and configure report profiles
1. Go to Call Center > Report > Report.
Fortinet Technologies Inc.
GUI field
Description
Generate
Select a report and click this button to generate a report
immediately. See “Generating a report manually” on page 225.
View Reports
Click to display the list of reports generated by the FortiVoice unit.
You can delete, view, and/or download generated reports. For more
information, see “Viewing generated reports” on page 33.
View supported
query
Click to display supported query summary.
Name
Displays the name of the report profiles.
Page 222
FortiVoice Phone System 5.3.0 Administration Guide
Department
The department to which the report belongs.
Schedule
Displays the frequency with which the FortiVoice unit generates a
scheduled report. If the report is designed for manual generation,
Not Scheduled appears in this column.
2. Click New to add a profile or double-click a profile to modify it.
3. In Name, enter a name for the report profile.
Report names cannot include spaces.
4. In Department, select the department for this report.
For information on departments, see “Creating extension departments” on page 166.
5. Click the arrow next to each option, and configure the following as needed:
• Configuring the report query selection
• Configuring the report time period
• Configuring report email notifications
• Configuring the report schedule
• Generating a report manually
6. Click Create.
Configuring the report query selection
When configuring a report profile, you can select the queries that define the subject matter of
the report.
Each report profile corresponds to a chart that will appear in the generated report.
To configure the report query selection
1. Go to Call Center > Report > Report.
2. Click New.
3. Expand Query List and click New.
4. Configure the following:
GUI field
Description
Name
Enter a name for this query.
Category
Select a query type for the report profile. The report chart will
correspond to the type selected.
Sub category
Select a sub query type for the report profile. The report chart will
correspond to the type selected.
Query
Depending on your selection of Category and Sub category, choose
the specific report you want to generate.
Depending on the report you choose, select queues or agents for
which you want to generate reports.
5. Click Create.
Fortinet Technologies Inc.
Page 223
FortiVoice Phone System 5.3.0 Administration Guide
Configuring the report time period
When configuring a call center report profile, you can select the time span of log messages from
which to generate the report.
To configure the report time period
1. Go to Call Center > Report > Report.
2. Expand Period.
3. Select the time span option you want. This sets the range of log data to include in the report.
4. For Type, choose a relative time, such as Today, Yesterday, Last N hours, and so on. If you
select an option with an unspecified “N” value, enter the number of hours, days or weeks in
the Value field, as applicable.
Configuring report email notifications
When configuring a call center report profile, you can have the FortiVoice unit email an attached
copy of the generated report, in either HTML or PDF file format, to designated recipients.
You can customize the report email notification. For more information, see “Customizing call
report and notification email templates” on page 109.
To configure an email notification
1. Go to Call Center > Report > Report.
2. Expand Email.
3. Enter the email address of the person who will receive the report notification in the
Recipients field. Click + to enter more email addresses if necessary, or click - to remove an
address.
4. In the File format field, select the format of the generated attachment, either HTML, PDF or
CSV.
Configuring the report schedule
When configuring a call center report profile, you can select when the report will generate. Or,
you can leave it unscheduled and generate it on demand. See “Generating a report manually”
on page 225.
To configure the report schedule
1. Go to Call Center > Report > Report.
2. Expand Schedule.
Fortinet Technologies Inc.
Page 224
FortiVoice Phone System 5.3.0 Administration Guide
3. Configure the following:
GUI field
Description
Type
• None: Select if you do not want the FortiVoice unit to generate
the report automatically according to a schedule. If you select this
option, the report can only be generated on demand. See
“Generating a report manually” on page 225.
• Daily: Select to generate the report each day. Also configure Hour.
• Weekdays: Select to generate the report on specific days of each
week, then select those days in These weekdays. Also configure
Hour.
• Dates: Select to generate the report on specific date of each
month, then enter those date numbers in These days. Also
configure Hour.
Generating a report manually
You can always generate a report on demand whether the call center report profile includes a
schedule or not.
To manually generate a report
1. Go to Call Center > Report > Report.
2. Click to select the report profile whose settings you want to use when generating the report.
3. Click Generate.
The FortiVoice unit immediately begins to generate a report. To view the resulting report, see
“Viewing generated reports” on page 33.
Fortinet Technologies Inc.
Page 225
FortiVoice Phone System 5.3.0 Administration Guide
Working with Property Management
System
Businesses such as hotels use Property Management System (PMS) to manage their services.
The PMS can be connected to a PBX such as the FortiVoice unit to configure a customer’s room
phone by displaying the customer’s name on the phone, emptying voicemails when a new
customer checks in, logging phone calls, setting wake-up calls, and other services. You can
also set the room condition codes for room maids to record the room cleaning status using the
room phone.
This option is only available if you have purchased the license.
This topic includes:
• Configuring hotel management settings
• Configuring hotel room status
Configuring hotel management settings
Hotel Management > Setting lets you configure the settings for the FortiVoice unit to
interoperate with your PMS, set the room condition codes, such as setting 1 to represent that
maid is present and 4 to represent out of service, and configure guest check in and check out
actions.
Configure your PMS settings accordingly.
To configure hotel management settings
1. Go to Hotel Management > Setting > PMS.
2. Configure the following:
GUI field
Description
Enabled
Select to enable the PMS.
Protocol
Select the protocol used by the FortiVoice unit to communicate with the
PMS.
Port
Enter the port number that connects to the PMS.
Note that you need to use an adaptor for the FortiVoice-PMS
connection. Fortinet recommends using iPocket232 by Precidia. From
the ports you configured, connect the PMS serial cable to the adaptor
and then connect the RJ45 cable from the FortiVoice unit to the adaptor.
Serial
connection
Select to connect to the PMS using a serial cable.
LRC
Select to perform longitudinal redundancy check (LRC).
This option is only available for Micros protocol.
This option is only available for Micros protocol.
Fortinet Technologies Inc.
Page 226
FortiVoice Phone System 5.3.0 Administration Guide
Mode
Choose to use the FortiVoice unit as server or client when connecting to
the PMS. If it is used as client, enter the server IP address in the Server
field.
This option is only available for Micros and Comtrol protocols.
Call billing
Select to activate call billing.
Network
Settings
Trusted
hosts
Enter the IP address and netmask of the PMS. If the PMS uses serial
connection to an adaptor, enter the IP address and netmask of the
adaptor.
If you have multiple PMSes, you may enter multiple trusted hosts.
Data sync
This option is only available for Micros and Comtrol protocols.
When the FortiVoice unit is connected to the PMS, it constantly receives
all room-based information such as guest name, room privileges, and
check in and check out times from the PMS.
Normally, you do not need to click the Data sync button since the data
synchronization is automatic. You only do so when there is a data
mismatch between the FortiVoice unit and the PMS.
Fortinet recommends performing a manual data sync at off hours
because all related operations, such as check in and check out, are
suspended during a data sync.
3. Click Apply.
To configure check in and check out actions
1. Go to Hotel Management > Setting > Option.
2. Configure the following:
GUI field
Description
Check in action
Reset
Set the guest information and room condition to make a room check-in
ready.
• Privilege: Select to enable phone call restriction (internal, local, or
long distance) and user privilege (option 1, 2, 3) for the room.
If you choose this option, select a Privilege for the room user. For
information on setting user privileges, see “Configuring user
privileges” on page 131
• Guest name: Select to display room number or guest name on the
room extension. In the Name field, enter %%NUMBER%% or %%NAME%%.
• Room condition: Select to clear any condition set for the room.
Check out action
Fortinet Technologies Inc.
Page 227
FortiVoice Phone System 5.3.0 Administration Guide
Reset
Set the guest information and room condition to make a room check-out
ready.
• Privilege: Select to enable phone call restriction (internal, local, or
long distance) and user privilege (option 1, 2, 3) for the room.
If you choose this option, select a Privilege for the room user. For
information on setting user privileges, see “Configuring user
privileges” on page 131
• Guest name: Select to display room number or guest name on the
room extension. In the Name field, enter %%NUMBER%% or %%NAME%%.
• Room condition: Select to clear any condition set for the room.
• Voice mail: Select to clear all voicemails for the room extension.
• Wakeup call: Select to clear all wakeup call setups for the room
extension.
Advanced
Choose the order for room maids to request for room item by phone.
You can choose to dial the item code or number first.
For example, if you choose to dial code first and want to request for two
beers (code 1) and three waters (code 2), you can dial 1*2*2*3.
For information on item code, see “To set mini bar code for room maids
to order room items” on page 228.
3. Click Apply.
To set mini bar code for room maids to order room items
1. Go to Hotel Management > Setting > Mini Bar Code.
2. Click New.
3. Enter the item name, for example, Beer.
4. Enter the item code, for example, 5.
5. Click Create.
A room maid can dial the code to order beer for the room using the room phone. For more
information, see “Advanced” on page 228.
Configuring hotel room status
Hotel Management > Room Status lets you set hotel room status.
Once the PMS and the FortiVoice unit is properly connected and the PMS is enabled on the
FortiVoice unit, all hotel room extensions appear on the FortiVoice unit.
To batch-configure hotel room statuses
1. Go to Hotel Management > Room Status.
A green dot at the top of the screen means the FortiVoice unit is connected with the PMS.
Otherwise, a red dot appears.
2. Select more than one room in the list.
Depending on the situations of the rooms you select, the Check in, Check out, Privilege,
Room condition, Room setting, and VIP setting buttons become active.
A green dot under Guest means this guest room’s extension is bound with the room.
Otherwise, a red dot appears. For more information, see “Guest phone” on page 229.
3. Click a button to batch-configure the room status and apply it to all rooms selected.
Fortinet Technologies Inc.
Page 228
FortiVoice Phone System 5.3.0 Administration Guide
To configure a single hotel room status
1. Go to Hotel Management > Room Status.
2. Select a room extension and click Edit.
3. Configure the following:
GUI field
Description
Number
The extension number of the room. You can click the number and
modify it if required. For more information, see “Configuring IP
extensions” on page 136.
Guest phone
Select to bind the extension with the room and make the room a guest
room.
Room
The hotel room number. You can click the number and modify it if
required.
Location
Click to enter the room location.
If you have selected Guest phone, configure the following:
Checkin status
Choose the room status to configure: Checked-out or Checked-in.
Guest name
Enter the name of the guest for this room.
This option is available only if the Checkin status is Checked-in.
Privilege
Select phone call restriction (internal, local, or long distance) and user
privilege (option 1, 2, 3) for the room. For information on setting user
privileges, see “Configuring user privileges” on page 131.
This option is available only if the Checkin status is Checked-in.
DND
Select if the guest of the room does not want to be disturbed.
This option is available only if the Checkin status is Checked-in.
VIP setting
Select to set the guest as a VIP. Specific VIP treatments are determined
by each hotel.
Room condition Select the cleaning status of the room.
You can add a new code or edit the current one:
• Click New to add a code or select an existing code and click Edit to
modify it.
• Select the protocol for connecting to your PMS.
• Enter a code number.
• Enter the code description.
• Click Create.
4. Click OK.
Fortinet Technologies Inc.
Page 229
FortiVoice Phone System 5.3.0 Administration Guide
Configuring phone auto dialer
With the auto dialer function, the FortiVoice unit can automatically dial telephone numbers.
Once the call is answered, the FortiVoice unit plays a recorded message.
This topic includes:
• Setting up an auto dialer campaign
• Creating a recorded broadcast message
• Adding contacts and contact groups
• Configuring auto dialer settings
• Viewing auto dialer reports
Setting up an auto dialer campaign
Auto Dialer > Campaign > Campaign allows you to set up an auto dialer task to broadcast a
recorded message to the dialed phone numbers.
To set up an auto dialer campaign
1. Go to Auto Dialer > Campaign > Campaign.
2. Click New and configure the following:
GUI field
Description
Name
Enter a name for the campaign.
Caller ID
Enter the caller ID to be displayed on a called phone. You can also
select an extension number instead.
Status
The current status of the campaign.
Sound file
Select a recorded message that you want to broadcast. You can also
create a new one. For more information, see “Creating a recorded
broadcast message” on page 231.
Retry
Enter the number of times you want to retry calling.
Description
Enter any notes you have for this campaign.
External
Numbers
Select the external phone numbers you want to autodial. You can add
these numbers by going to Auto Dialer > Contact > Contact/Contact
Group. See “Adding contacts and contact groups” on page 231.
Internal
Numbers
Select the internal phone numbers you want to autodial. These numbers
are the internal extensions on the FortiVoice unit.
3. Click Create.
4. If you want to start a campaign, in the campaign list, select one with a status other than
Completed and click Start on top of the screen.
5. Select a campaign start and end time.
6. Click OK.
Fortinet Technologies Inc.
Page 230
FortiVoice Phone System 5.3.0 Administration Guide
Creating a recorded broadcast message
Auto Dialer > Campaign > Audio allows you to create a sound file for the auto dialer to
broadcast.
To create a sound file
1. Go to Auto Dialer > Campaign > Audio.
2. Click New.
3. Enter a name for the sound file.
4. Select an Action:
• Upload: Click to upload a sound file. Uploaded sound file should be a WAVE file (*.wav) in
16bit PCM(8000Hz) compression format.
• Record: Click to enter a phone number and click Send. When the phone rings, pick it up
and record the message.
• Download: Once a file is uploaded or recorded, click to download it.
• Play: Once a file is uploaded or recorded, click to play it.
5. Click OK.
Adding contacts and contact groups
Auto Dialer > Contact > Contact/Contact Group allows you to add contacts and contact groups
that can be used in an auto dialer campaign.
To add a contact
1. Go to Auto Dialer > Contact > Contact.
2. Click New and enter the contact information.
3. Click Create.
To add a contact group
1. Go to Auto Dialer > Contact > Contact Group.
2. Click New.
3. Enter a name for the group.
4. Select the members for the group.
Members are created by adding contacts. See “To add a contact” on page 231.
5. Click Create.
Configuring auto dialer settings
Auto Dialer > Setting allows you to
• set the maximum call channels (64 by default) for campaigns. This value represents the
number of phones that can be auto dialed at the same time.
• set call timeout (600 seconds by default).
These values can be modified through the CLI.
Fortinet Technologies Inc.
Page 231
FortiVoice Phone System 5.3.0 Administration Guide
Viewing auto dialer reports
Auto Dialer > Report allows you to view the status of the auto dialer campaigns, including
campaign IDs, call status, total number of campaigns, number of uncalled, answered,
unanswered calls, and retries, and call duration and time.
Fortinet Technologies Inc.
Page 232
FortiVoice Phone System 5.3.0 Administration Guide
Configuring Call Features
The Call Features menu lets you configure the settings for many call features such as
conference call, auto attendant, faxing, and much more.
This topic includes:
• Configuring auto attendants
• Configuring user privileges
• Configuring account codes
• Mapping speed dials
• Configuring conference calls
• Recording calls
• Creating call queues and queue groups
• Configuring call parking
• Configuring fax
• Setting calendar reminder
• Modifying feature access codes
• Configuring Internet of things (IoT)
Configuring auto attendants
An auto attendant can answer a telephone line or VoIP number, and can be included in the call
cascade of a local extension, remote extension or ring group.
An auto attendant can answer a call if the receptionist is away or if you do not have a
receptionist. Each auto attendant has a message with options. The message tells the caller
what the options are. You can load a professionally pre-recorded message, or can record a
message using a handset.
To view the list of auto attendants, go to Call Features > Auto Attendant > Auto Attendant.
GUI field
Description
View Hierarchy
Click to view the hierarchical structure of the selected auto attendant.
For more information, see “Viewing auto attendant hierarchies” on
page 235.
Delete
Removes a selected auto attendant. You cannot remove an auto
attendant that is used in another auto attendant configuration.
Name
The name of the auto attendant.
Direct Actions
The number of key actions configured for the main auto attendant,
excluding the key actions for the subsidiary auto attendants. For more
information, see “Viewing auto attendant hierarchies” on page 235.
To create an auto attendant
1. Go to Call Features > Auto Attendant > Auto Attendant and click New.
Fortinet Technologies Inc.
Page 233
FortiVoice Phone System 5.3.0 Administration Guide
2. Configure the following:
GUI field
Description
Auto Attendant
Name
Enter a name for the auto attendant.
Default
language
Select the language for the auto attendant greeting message (sound
file). If you select Default, the greeting message will be the same as
what you set for the FortiVoice unit. For more information, see
“Setting PBX location and contact information” on page 106.
You can also select other languages. The language files are created
in “Adding prompt languages” on page 114.
Greeting
mode
If you select Simple, select a greeting message (sound file) for the
auto attendant. See “Greeting” on page 234.
If you select Scheduled to add a scheduled greeting, do the
following:
• In Scheduled Greeting Setting, click New.
• In the Schedule field, select a schedule for the greeting.
Scheduled are created in “Scheduling the FortiVoice unit” on
page 132.
• In the Greeting field, select a sound file. You can click New to add
a new file or Edit to modify the selected one. For more
information, see “Managing sound files and music on hold” on
page 119.
• Click Create.
Greeting
Select a greeting message (sound file) for the auto attendant. You
can edit a selected file or create a new one. For more information,
see “Managing sound files and music on hold” on page 119.
This option is only available if you select the Simple greeting mode.
Ringing for
Enter the number of seconds for the phone to ring before the auto
attendant answers with the greeting message.
Timeout after Enter the number of seconds that an auto attendant should be
allowed to wait before the caller takes further action according to the
voice instructions.
Timeout
action
Select the action when the auto attendant timeout is reached.
• Dial operator: The call is transferred to an operator.
• Dial extension: The call is transferred to the extension you select.
You can edit a selected extension or create a new one. For
details, see “Configuring IP extensions” on page 136.
• Start over: The auto attendant will repeat the instructions for the
caller. Also enter the maximum times to repeat.
• Hang up: The call will be terminated.
Invalid input
action
Fortinet Technologies Inc.
Select the action when the caller enters an invalid input.
Page 234
FortiVoice Phone System 5.3.0 Administration Guide
Dial Pad Key Action Configure the auto attendant keys for callers to use when navigating
through the auto attendant hierarchy. For more information, see
“Configuring key actions” on page 237.
Key
The key that transfers a call to a resource, for example, voicemail, if
pressed.
Action
The resource to which a call is transferred by pressing a key.
Target
The resource target if applicable. For example, an extension number,
sound file, or external phone number that leads to a resource.
Advanced
Upon finishing configuring these functions, you need to inform the
users on how to use them after they reach the auto attendant.
• Access voicemail: Enable to allow external callers to reach their
voicemail boxes by dialing the default voicemail prompt code *98
or the code you set. For more information about feature code, see
“Modifying feature access codes” on page 266.
• Dial local number: Select to enable an external caller to dial local
extensions.
• Override schedule: Select to allow a system administrator to dial
a code to replace the schedule with a system schedule. For more
information, see “Configuring system capacity” on page 117.
• Allow recording of prompt sound file:
• Call Bridge (DISA): Select an account code for external users to
dial into the FortiVoice unit and use the FortiVoice service just like
the local extensions. Callers must dial the DISA code followed by
the account code before making the calls. You can edit a selected
account code or create a new one. For more information on DISA
code, see “Modifying feature access codes” on page 266. For
more information on account code, see “Configuring account
codes” on page 243.
• Outbound dialplans allowed for access: Select the outbound dial
plan for users to call the FortiVoice unit and through it to make
outbound calls. For details, see “Configuring outbound dial
plans” on page 194.
3. Click Create.
Viewing auto attendant hierarchies
The FortiVoice unit provides a chart based on your auto attendant configurations to display the
layers of auto attendant hierarchy and the key actions. You can save the chart and load it later.
You can also drag the chart into the shape you want.
To view the auto attendant hierarchy
1. Go to Call Features > Auto Attendant > Auto Attendant.
2. From the auto attendant list, select the one of which you want to view its hierarchy chart.
3. Click View Hierarchy.
Fortinet Technologies Inc.
Page 235
FortiVoice Phone System 5.3.0 Administration Guide
Figure 1: Sample auto attendant hierarchy
Direct action: 1
Layers of
hierarchy: 2
Total actions: 4
This example shows the hierarchy of auto attendant 1.
• Based on the configuration, press 2 transfers the call to auto attendant 2.
• Auto attendant 2 configuration allows you to go to auto attendant 3 by pressing 3
and places you on a call queue if you press 5.
• Auto attendant 3 configuration allows you to go to the operator by pressing 8.
You can right-click an auto attendant node and select Edit to modify it or view the
snapshot of an auto attendant (other than the main one) by right-clicking it and
selecting Drill down.
Fortinet Technologies Inc.
Page 236
FortiVoice Phone System 5.3.0 Administration Guide
Table 1: Sample auto attendant hierarchy
Close
Closes the chart.
<<
If you selected viewing the snapshot of an auto attendant (other than
the main one) by right-clicking it and selecting Drill down on the
chart, clicking << restores the full chart.
Reset
Sets the chart to its default view. All the saved and unsaved views
will be lost.
Print preview
Click to preview the chart before printing it.
Show all actions
Select to display the total actions. Deselect to hide the end
resources to which a call is transferred by pressing a key. In this
sample, the end resources are Operator (8) and Queue extension (5).
Configuring key actions
Configure the auto attendant dial pad keys for callers to use when navigating through the auto
attendant hierarchy.
For more information, see “Dial Pad Key Action” on page 235.
To configure a key action
1. While configuring an auto attendant, click New under Dial Pad Key Action.
2. Enter the key number that transfers a call to a resource, if pressed.
3. Select an action:
GUI field
Description
No action
The call is not transferred to any resource.
Play announcement Play an announcement with directions, business hours, etc.
• Select an action to follow the announcement:
• No action: The auto attendant takes no action.
• Start over: The auto attendant will repeat the announcement.
• Hang up: The call will be terminated.
• Select the sound file for the announcement. You can click Edit to
modify an existing one or New to add a new one. For information
on sound files, see “Managing sound files and music on hold” on
page 119.
Dial operator
The call is transferred to the operator.
Dial extension
The call is transferred to a specified local extension.
Select the extension. You can click Edit to modify an existing one or
New to add a new one. For more information, see “Configuring
Extensions” on page 136.
Fortinet Technologies Inc.
Page 237
FortiVoice Phone System 5.3.0 Administration Guide
Go voicemail
The call is transferred to a voice mailbox, allowing the caller to leave
a message.
Select the voice mailbox. You can click Edit to modify an existing
one or New to add a new one. For more information, see
“Configuring IP extensions” on page 136.
Ring group
The call is transferred to the call queue of a ring group. The call is
placed on hold. The system will ring the next available extension in
the ring group.
Select the ring group. You can click Edit to modify an existing one or
New to add a new one. For more information, see “Creating
extension groups” on page 165.
Dial number
The call is transferred to a specified remote extension number.
Enter the remote extension number. For more information, see
“Setting up remote extensions” on page 150.
Call queue
The call is transferred to a call queue.
Enter the call queue configuration. For more information, see
“Creating call queues and queue groups” on page 200.
Lookup name
directory
Access the dial-by-name directory so the caller can find a user’s
extension number by entering the user’s name.
Change language
Change the auto attendant greeting language. Select the language
and a follow-up action. If you choose Auto attendant for the
follow-up action, select the auto attendant.
For Language, if you select Default, the greeting message will be the
same as what you set for the FortiVoice unit. For more information,
see “Setting PBX location and contact information” on page 106.
You can also select other languages. The language files are created
in “Adding prompt languages” on page 114.
Auto attendant
Route the call to another auto attendant, which allows actions to be
nested into a powerful call routing system. For example, the main
auto attendant can say “Press one for English. Oprima dos para
Español.” Option 1 goes to the English auto attendant and option 2
goes to the Spanish auto attendant.
Select an auto attendant. For information on creating auto
attendants, see “Configuring auto attendants” on page 233.
Start over
The auto attendant will repeat the announcement.
Go back
The auto attendant will repeat the previous level announcement.
Hang up
The call is terminated.
IVR
Route the call to the FortiVoice IVR system. For more information,
see “Configuring IVRs” on page 210.
4. Optionally, enter any comments about this key action.
5. Click Create.
Fortinet Technologies Inc.
Page 238
FortiVoice Phone System 5.3.0 Administration Guide
Configuring user privileges
A user privilege includes a collection of phone services and restrictions that can be applied to
each extension user.
The default user privilege configurations can be edited but not be deleted.
For information on extensions, see “Configuring Extensions” on page 136.
To configure a user privilege
1. Go to Call Features > User Privileges > User Privileges and click New.
2. Configure the following:
GUI field
Description
Name
Enter a name for this class of service.
Basic Settings
Auto provisioning
Select to enable auto-provisioning for the extension. For more
information, see “Configuring SIP phone auto-provisioning” on
page 112.
Once a FortiFone or supported DHCP-enabled phone
connects to the FortiVoice unit and is auto-discovered, the
FortiVoice unit assigns an IP address to the FortiFone and
sends the basic PBX setup information to it. The full PBX
configuration file will only be sent to the phone if this option is
selected in the user privilege applied to the extension
associated with the phone.
List in directory
Select to put the user’s name in the dial-by-name directory
which allows a caller to find a user’s extension number, and
connect to their local extension or remote extension. This way
the caller can reach their party without speaking to the
receptionist.
Configure
programmable
phone feature
key/PFK
Select to enable configuring the feature access codes. For
more information, see “Modifying feature access codes” on
page 266.
Internet of Things
Select to enable configuring Amazon Alexa and IFTTT web
service. For more information, see “Configuring Internet of
things (IoT)” on page 271.
Lookup directory
Select to enable a user to view the phone directory of the local
office. For more information, see “Viewing phone directories”
on page 39.
Lookup directory in Select to enable a user to view the phone directories of remote
remote office(s)
offices. For more information, see “Viewing phone directories”
on page 39.
Fortinet Technologies Inc.
Page 239
FortiVoice Phone System 5.3.0 Administration Guide
Twinning
Select to enable twinning function on an extension.
The twinning feature allows you to use an external telephone
(often a smartphone or home phone) to replicate your internal
office extension (often your desk phone), so that when your
desk phone rings, so does the “twin” phone. Once you return
to your desk, you may press the Twinning key on the phone to
terminate the twinning.
This is useful when you are away from your desk but still want
to receive calls to your desk phone.
With this feature selected, you can configure twinning. For
more information, see “Setting extension user preferences” on
page 156.
Role Settings
Operator role
Select to enable an extension user to process phone calls
using the FortiVoice user web portal.
You can select the four options to handle calls in each
category.
When the user privilege with this option selected is applied to
an extension, an Operator Console button will appear on the
top of the extension user’s FortiVoice web portal. Clicking the
button lets the user to process phone calls on the Web.
For more information, see the online help of the user web
portal.
Voice Mail
Enabled
Select to enable the voicemail service.
Maximum
messages
Enter the number of voice mails allowed.
Voicemail retention Enter the number of days to keep the voicemails.
days
Music
Music on hold
Select a music on hold file. For details, see “Managing sound
files and music on hold” on page 119.
Early media
Early media is the exchange of information between the PBXes
before the establishment of a phone connection, such as the
ring tone. You can select a music file for early media. For
details, see “Managing sound files and music on hold” on
page 119.
Fax
Fortinet Technologies Inc.
Set the user rules for faxing. For information on fax, see
“Configuring fax” on page 257.
Enabled
Select to set the fax rules for users.
Max incoming
messages
Enter the number of incoming faxes allowed.
Page 240
FortiVoice Phone System 5.3.0 Administration Guide
Max incoming fax
retention days
Enter the number of days to keep the incoming faxes.
Max outgoing
messages
Enter the number of outgoing faxes allowed.
Max outgoing fax
retention days
Enter the number of days to keep the outgoing faxes.
Call Restriction
Select call dialing restrictions for international, long distance,
local, and internal calls.
• Forbidden: Call is not allowed.
• Allowed: Call is allowed.
• Allowed with account code: Call is allowed by entering the
system account/exempt code. For information on account
code, see “Configuring account codes” on page 243.
Not applicable to internal calls.
• Allowed with personal code: Call is allowed by entering an
extension’s account/exempt code. For more information,
see “Configuring account codes” on page 243.
Not applicable to internal calls.
Other restricted
area code
You can specify area codes to which an extension is allowed
or denied to make phone calls.
1. Click New.
2. Enter a name for this call restriction.
3. Select Enable to activate this restriction.
4. Enter the area code that you want to set restriction.
5. If you do not want an extension to call the area code you
set, select None for Exempt code; otherwise, select a code.
For information on exempt code, see “Configuring account
codes” on page 243.
6. Click Create.
Misc
Monitor/Recording
The max number of concurrent calls: Set the maximum
number of concurrent incoming and outgoing calls on the
extension. The range is 1-10. The default is 4.
Configure monitoring and recording outgoing and incoming
calls of an extension to which this user privilege is applied.
Personal recording Select to allow users to configure personal recording of their
incoming and outgoing calls on the user web interface.
System recording
Select to allow users to configure system recording of their
incoming and outgoing calls on the user web interface.
Allow being barged Select to allow monitoring an extension to which this user
privilege is applied.
Fortinet Technologies Inc.
Page 241
FortiVoice Phone System 5.3.0 Administration Guide
Allow barging
Select to allow the extension to which this user privilege is
applied to monitor other extensions.
To barge a call, you need to enter your user PIN. For
information on user PIN, see “User PIN” on page 139.
Call barge option
Hot-desking
If you select Allow barging, choose a barging method.
Hot desking enables users to log into another phone. However,
unlike using Follow Me or Call Forwarding which simply
redirect a user's calls to another user’s phone, hot desking
takes total control of another phone by applying all of the
user's own phone settings to that phone until the user logs
out. Each user can log into another phone by pressing *11 and
enter his extension number and user PIN following the
prompts. To log out, a user can press *12 and enter his
extension number and user PIN.
You can view hot desking configurations by going to “Viewing
hot desking configurations” on page 27.
• Enable hot-desking login: Select to enable the hot-desking
login function.
• Automatic logout hours: Enter the time in hours for the
phone to automatically log out of hot-desking.
• Enable hosting hot-desking: Select if you want to log into a
regular phone with the hot-desking phone authentication
(by pressing *11 and enter your extension number and user
PIN following the prompts).
By doing so, the regular phone keeps its configuration and
extension number. However, outgoing calls display the
hot-desking number.
The regular phone logs out of hot-desking when the time
set in Automatic logout hours expires.
If the two phones use different programmable phone keys, the
host phone will reboot. For information on programmable
phone keys, see “Configuring phone profiles” on page 123.
User Portal Options
Enable or disable the web portal and select the features of the
user web portal. Only the selected ones will appear for the
extension to which this user privilege is applied.
Advanced
Fortinet Technologies Inc.
Page 242
FortiVoice Phone System 5.3.0 Administration Guide
Conference number Select the permission for conference calls:
• Allow all: Select to allow the extension to join all conference
calls.
• Disallow all: Select to prohibit the extension from joining all
conference calls.
• Allow all with exempt: If you select this option, click New to
enter the conference call number(s) that the extension is
banned to join.
• Disallow all with exempt: If you select this option, click New
to enter the conference call number(s) that the extension is
allowed to join.
For more information, see “Configuring auto attendants” on
page 233.
Paging/Intercom
Select the permission for paging/intercom:
• Allow all: Select to allow the extension to page/intercom all
paging numbers.
• Disallow all: Select to prohibit the extension to
page/intercom all paging numbers.
• Allow all with exempt: If you select this option, click New to
enter the paging/intercom number(s) that the extension is
banned to page/intercom.
• Disallow all with exempt: If you select this option, click New
to enter the paging/intercom number(s) that the extension
is allowed to page/intercom.
For more information on paging, see “Configuring auto
attendants” on page 233.
Trusted hosts
Click New to enter the IP address and netmask of the subnet
that can register with the SIP server. Only extensions on the
specified subnet can register with the SIP server.
Permit outgoing
rules
Select the available outbound calling rules in the Available
rules field and click -> to move them to the Selected rules field.
You can apply the rules to a user later. For more information on
calling rules, see “Configuring outbound dial plans” on
page 194.
7. Click Create.
Configuring account codes
You can set account codes to restrict long-distance and international calls, for instance. Users
must dial these codes first before making long-distance or international calls.
You apply the account codes in user privileges. For details, see “Configuring user privileges” on
page 239.
To set an account code
1. Go to Call Features > User Privileges > Account Code.
Fortinet Technologies Inc.
Page 243
FortiVoice Phone System 5.3.0 Administration Guide
2. Click New and configure the following:
GUI field
Description
Name
Enter an account code name.
Shared
Select to use this code on any extension.
Represented in CDR Select to display the account code by code or name in CDR. For
information about CDR, see “Viewing call records” on page 33.
Description
Enter any notes you may have for the account code.
Access Code Set
Click New to enter the account code such as 69, display name for
the code such as Finance, and any notes for the code.
Click Create.
3. Click Create.
Mapping speed dials
For fast and efficient dialing, use the speed dial pattern to map the phone numbers, mostly
outbound numbers.
For information on setting speed dial number pattern, see “Configuring PBX options” on
page 107.
To map speed dials
1. Go to Call Features > Speed Dials.
2. Click New.
3. Enter a name for the speed dial mapping.
4. For Code, enter the number based on the speed dial number pattern you set. For example,
333.
5. Enter the phone Number to map to the speed dial code.
You can enter digits 0–9, space, dash, comma, # and *.
If you want to enter an auto attendant number followed by an extension, you can use comma
(,) or semicolon (;) to pause the automatic dialing.
A comma pauses dialing for two seconds, for example, 1-123-222-1234, 5678#. In this case,
once pressing the speed dial code you set, auto attendant 1-123-1234 is reached, and after
two seconds, extension 5678 is automatically dialed.
A semicolon pauses dialing for one second, for example, 1-123-222-1234; 5678#. In this
case, once pressing the speed dial code you set, auto attendant 1-123-1234 is reached, and
after one second, extension 5678 is automatically dialed.
6. Optionally, enter a note for the mapping, such as “This is for customer A”.
7. Click Create.
Configuring conference calls
The Call Features > Conferencing > Conferencing tab lets you configure and enable conference
call settings.
Fortinet Technologies Inc.
Page 244
FortiVoice Phone System 5.3.0 Administration Guide
Depending on your preference, you can create either a static or dynamic (calendar-based)
conference call.
To configure a static conference call
1. Go to Call Features > Conferencing > Conferencing and click New.
2. Configure the following:
GUI field
Description
Name
Enter a conference call name.
Enabled
Select to activate this conference call.
Number
Select an extension number that callers can call and enter the user PIN to join
a conference call.
Show
Select and click in the Number field to display the extension numbers
suggested available for use. If it is deselected, clicking in the Number field displays the
numbers
extension numbers already in use.
This option also serves as a diagnostic tool for finding and fixing duplicate or
missing numbers. Missing numbers are the extensions that have user IDs but
not numbers.
When there are duplicate or missing numbers, an orange exclamation mark
icon appears beside this option. You can click the icon and fix the numbers.
For more information, see “Fixing duplicate or missing numbers” on page 143.
Setting
Display name
Enter the name displaying on the conference call extension,
such as “HR”.
User PIN
Enter a password for joining the conference call. A caller
needs to dial the conference call number and enter this
password to join the conference call. The default is 123456.
This password is always valid and should only be sent to
the people who need it.
Admin PIN
Enter the PIN number to be used by the conference host to
host a conference call. The default is 123123.
This password is always valid and should only be sent to
the people who need it.
Description
Enter any notes you have for this conference call.
Music on hold
Select to play background music that callers hear after the
joining message and leaving message are played.
For information on creating music on hold file, see
“Managing sound files and music on hold” on page 119.
Quiet mode
Fortinet Technologies Inc.
Select to not to record and announce participate's name.
Page 245
FortiVoice Phone System 5.3.0 Administration Guide
Recursive If you want conference calls on repeating schedules, select Enabled and click
Schedules New to select a schedule. Enter a password for joining the conference call and
click Create.
This option is useful if you want to limit the participants to a particular
recursive conference call only provided that they do not have the User PIN or
Admin PIN for the conference call. They can only join the conference call
during the scheduled time period and by entering the password you set.
For information on setting up a schedule, see “Scheduling the FortiVoice unit”
on page 132.
One Time If you want to set up a one time conference call, select Enabled and click New
Schedules to enter the start and end time. Enter a password for joining the conference
call and click Create.
This option is useful if you want to limit the participants to a particular one
time conference call only provided that they do not have the User PIN or
Admin PIN for the conference call. They can only join the conference call
during the scheduled time period and by entering the password you set.
If the one time schedule conflicts with the recursive schedule, the one time
schedule has priority.
3. Click Create.
To configure a dynamic conference call
1. Go to Call Features > Conferencing > Dynamic Conferencing and click New.
2. Configure the following:
GUI field
Description
Name
Enter a conference call name.
Enabled
Select to activate this conference call.
Number
Select an extension number that callers can call and enter the
user PIN to join a conference call.
Show suggested
numbers
Select and click in the Number field to display the extension
numbers available for use. If it is deselected, clicking in the
Number field displays the extension numbers already in use.
This option also serves as a diagnostic tool for finding and fixing
duplicate or missing numbers. Missing numbers are the
extensions that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can click
the icon and fix the numbers. For more information, see “Fixing
duplicate or missing numbers” on page 143.
Setting
Fortinet Technologies Inc.
Display name
Enter the name displaying on the conference call extension, such
as “HR”.
Description
Enter any notes you have for this conference call.
Page 246
FortiVoice Phone System 5.3.0 Administration Guide
Music on hold
Select to play background music that callers hear after the
joining message and leaving message are played.
For information on creating music on hold file, see “Managing
sound files and music on hold” on page 119.
Quiet mode
Select to not to record and announce participate's name.
3. Click Create.
4. In the conference call list, select the one you created.
5. Enter an extension number that callers can call and enter their user PIN to join a conference
call.
6. Double-click a date to schedule an event.
7. Click OK.
Recording calls
For supervising and monitoring purposes, you can record incoming and outgoing calls to and
from the extensions matching the caller number patterns or dialed number patterns you set.
You can also select the recorded file format and archive the recorded calls.
Configuring call recordings
Call Features > Call Recording > Policy allows you to configure call recordings by creating,
editing, removing, saving, or viewing a recording.
GUI field
Description
View Recordings
Click to view, listen, search, or save the recordings. You can also do so
by going to Status > Storage > Recorded Calls. For details, see “Playing
recorded calls” on page 31.
Enabled
Select to activate this call recording service.
Name
The name of the call recording service.
Description
Information of call recording configuration.
To configure call recording
1. Go to Call Features > Call Recording > Policy.
2. Click New.
GUI field
Description
Recording Policy
Fortinet Technologies Inc.
Name
Enter a name for this configuration.
Enabled
Select to activate this configuration.
Type
Select the category of calls you want to record: by phone
number, department, group, or trunk.
Page 247
FortiVoice Phone System 5.3.0 Administration Guide
If you select By phone number for Type, configure the following:
Caller number
pattern
Enter the number pattern to match the callers’ phone numbers
following the pattern:
^[0-9XNZ]*[^\.]*$
where X=(0-9), Z=(1-9), and N=(2-9).
For more information, see “Configuring PBX options” on
page 107.
The phone calls from the numbers matching the pattern will be
recorded.
Dialed number
pattern
Enter the number pattern to match the dialed phone numbers
following the pattern:
^[^_][0-9XNZ\.]*$
where X=(0-9), Z=(1-9), and N=(2-9).
For more information, see “Configuring PBX options” on
page 107.
The phone calls to the numbers matching the pattern will be
recorded.
If you select By department for Type, configure the following:
Department
Select the extension department of which you want to record the
calls. You can add a new department or modify an existing one.
For more information, see “Creating extension departments” on
page 166.
If you select By group for Type, configure the following:
Group
Select the user group of which you want to record the calls. You
can add a new group or modify an existing one. For more
information, see “Creating user groups” on page 165.
If you select By trunk for Type, configure the following:
Trunk
Select the trunk of which you want to record the calls. You can
add a new trunk or modify an existing one. For more information,
see “Configuring Trunks” on page 175.
If you select By queue, configure the following:
Queue
Select the call queue of which you want to record the calls. For
more information, see “Creating call queues and queue groups”
on page 200.
Record ratio
Enter the recording percentage.
Retention duration Enter the days for which you want to keep the recordings.
File name format
Select the format of the downloaded recorded call files generated
under this policy.
The file format is useful when you filter downloaded recorded call
files by going to Status > Storage.
Fortinet Technologies Inc.
Page 248
FortiVoice Phone System 5.3.0 Administration Guide
3. Click Create.
Setting the recorded file format
Select the format for recording calls.
To set the recorded file format
1. Go to Call Features > Call Recording > Setting.
2. Select the format: Standard or Low rate.
3. Click Apply.
Archiving recorded calls
Configure the settings to archive the recorded calls.
To configure the recording archive settings
1. Go to Call Features > Call Recording > Archive.
2. Configure the following:
GUI field
Description
Rotation Settings
Recording rotation Enter the recorded file rotation size and time.
size/time
When the file reaches either the rotation size or time specified,
whichever comes first, the archiving file is automatically renamed.
The FortiVoice unit generates a new file, where it continues
saving recording archives. You can access all rotated files
through search.
Archiving options Specify what the FortiVoice unit should do if it runs out of disk
when disk quota is space. Select Overwrite to remove the oldest archived folder in
full
order to make space for the new archive, or select Do not archive
to stop archiving more recorded calls.
Destination Settings
Destination
Select an archiving destination:
• Local: the FortiVoice unit’s local hard drive or a NAS server.
• Remote: a remote FTP or SFTP storage server.
Local disk quota
If Local is the archiving destination, enter the disk space quota.
The total disk quota for archiving calls cannot exceed 50% of the
total storage disk size. For example, if the storage disk has a size
of 100 GB, a maximum of 50 GB can be used for call archiving.
If this quota is met and a new call must be archived, the
FortiVoice unit either automatically removes the oldest call
archive folder in order to make space for the new archive or stops
archiving, depending on the settings you specify under “Rotation
Settings” on page 249.
If Remote is the archiving destination, configure the following:
Fortinet Technologies Inc.
Page 249
FortiVoice Phone System 5.3.0 Administration Guide
Protocol
Select the protocol that the FortiVoice unit will use to connect to
the remote storage server, either SFTP or FTP.
IP address
Enter the IP address of the remote storage server.
User name
Enter the user name of an account the FortiVoice unit will use to
access the remote storage server, such as FortiVoice.
Password
Enter the password for the user name of the account on the
remote storage server.
Remote directory
Enter the directory path on the remote storage server where the
FortiVoice unit will store archived calls, such as
/home/fortivoice/call-archives.
Remote cache
quota
Enter the FortiVoice cache quota that is allowed to be used for
remote host archiving. The total cache quota for archiving calls
cannot exceed 20% of the total storage disk size. For example, if
the storage disk has a size of 100 GB, a maximum of 20 GB can
be used for call archiving.
If this quota is met and a new call must be archived, the
FortiVoice unit either automatically removes the oldest call
archive folder in order to make space for the new archive or stops
archiving, depending on the settings you specify under “Rotation
Settings” on page 249.
Schedule
Select a schedule for the archiving.
3. Click Apply.
Creating call queues and queue groups
This option is available if you do not have the Call Center license. If you do, see “Setting up a
Call Center” on page 200.
Call queuing, or Automatic Call Distribution (ACD), enables the FortiVoice unit to queue up
multiple incoming calls and aggregate them into a holding pattern. Each call is assigned a rank
that determines the order for it to be delivered to an available agent (typically, first in first out).
The highest-ranked caller in the queue is delivered to an available agent first, and every
remaining caller moves up a rank.
With call queuing, callers do not need to dial back repeatedly trying to reach someone, and
organizations are able to temporarily deal with situations when callers outnumber agents.
This topic includes:
• Creating call queues
• Creating queue groups
Creating call queues
Configure a call queue and add it in an inbound dial plan as a call handling action to make it
effective. For more information, see “Configuring inbound dial plans” on page 189.
Fortinet Technologies Inc.
Page 250
FortiVoice Phone System 5.3.0 Administration Guide
Call queues consist of:
• Incoming calls waiting in the queue
• Agents who answer the calls in the queues
• A plan for how to handle the queue and assign calls to agents
• Music played while waiting in the queue
• Announcements for agents and callers
Depending on their privileges, agents can log into a queue to answer calls or transfer calls to
another queue, which can then be answered by another available agent.
Agents can be static or dynamic. Static agents are always connected to the queues, and
dynamic agents need to log into the queue in order to process calls.
To view the call queues, go to Call Features > Call Queue > Call Queue.
GUI field
Description
Queue ID
The name of the call queue.
Display Name
The queue name displaying on the queue extension.
Number
The extension number for the call queue.
Department
The departments of the agents enrolled in the queue.
Agents
The extensions of the agents enrolled in the queue.
To create a call queue
1. Go to Call Features > Call Queue > Call Queue.
2. Click New.
3. Configure the following:
GUI field
Description
Call Queue
Queue ID
Enter an ID for the queue.
Number
Enter an extension for callers to dial and enter into a call
queue following the extension number pattern. See
“Configuring PBX options” on page 107.
This is another way to use a call queue configuration in
addition to adding it in an inbound dial plan as a call handling
action.
Even if you enter an extension, you can still add the call queue
configuration in an inbound dial plan as a call handling action.
In this case, the dial plan ignores this extension and still uses
the extension to which it is applied for call queue action.
Fortinet Technologies Inc.
Page 251
FortiVoice Phone System 5.3.0 Administration Guide
Show suggested
numbers
Select and click in the Number field to display the extension
numbers available for use. If it is deselected, clicking in the
Number field displays the extension numbers already in use.
This option also serves as a diagnostic tool for finding and
fixing duplicate or missing numbers. Missing numbers are the
extensions that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can
click the icon and fix the numbers. For more information, see
“Fixing duplicate or missing numbers” on page 143.
Status
Select to enable the call queue.
4. From the call queue list, select the queue you just create.
5. Configure the following:
GUI field
Description
Call Queue
Number
Enter an extension for callers to dial and enter into a call
queue following the extension number pattern. See
“Configuring PBX options” on page 107.
This is another way to use a call queue configuration in
addition to adding it in an inbound dial plan as a call handling
action.
Even if you enter an extension, you can still add the call queue
configuration in an inbound dial plan as a call handling action.
In this case, the dial plan ignores this extension and still uses
the extension to which it is applied for call queue action.
Show suggested
numbers
Select and click in the Number field to display the extension
numbers available for use. If it is deselected, clicking in the
Number field displays the extension numbers already in use.
This option also serves as a diagnostic tool for finding and
fixing duplicate or missing numbers. Missing numbers are the
extensions that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can
click the icon and fix the numbers. For more information, see
“Fixing duplicate or missing numbers” on page 143.
Status
Select to enable the call queue.
Display name
Enter the queue name displaying on the queue extension,
such as Support.
Description
Enter any notes about this queue.
Department
Select the department to which the queue belongs. For
information on creating departments, see “Creating extension
departments” on page 166.
Queue Setting
Fortinet Technologies Inc.
Page 252
FortiVoice Phone System 5.3.0 Administration Guide
Distribution policy
Select the method for calls in the queue to be delivered to the
agents.
Maximum queue
capacity
Enter the maximum number of callers for the call queue.
When the call queue is full, other callers will be dealt with
according to the Overflow call handling action you set in
“Queue Overflow” on page 255.
The maximum is 100.
Maximum queuing
time
Enter the maximum call queue waiting time in minutes. When
the call waiting time is due, the callers in the queue will be
dealt with according to the call handling action you set in
“Queue Timeout” on page 255.
The maximum is 720 minutes.
Ring duration
Enter the time in seconds to ring each agent. If a call is not
answered when the ring duration is due, the call is transferred
to the next agent. The range is between 5 to 120 seconds.
Music on hold
Select a sound file or music on hold file to play when a caller
is waiting. For more information, see “Managing sound files
and music on hold” on page 119.
Additional Settings
Distinctive settings Announce queue name: Select a sound file that announces
for agent
the queue name. You can add a new one or modify an existing
one. For more information, see “Managing sound files and
music on hold” on page 119.
Caller ID option: Select how you want the IDs of the calls to
this queue to display. If you select Prefix, the queue Display
name is added before the caller ID on the agent’s phone. If
you select Replace, the queue Display name replaces the
caller ID on the agent’s phone.
Ring Pattern: Select a queue extension ring pattern.
Business schedule
Fortinet Technologies Inc.
Select a operation schedule for the queue. For example,
“business_hour” schedule means agents are only available to
answer the calls for this queue during business hours. For
information on scheduling, see “Scheduling the FortiVoice
unit” on page 132.
Page 253
FortiVoice Phone System 5.3.0 Administration Guide
Announcement to
caller
Announcement holdtime: Select if you want to announce the
queue waiting time to a caller at the set interval. You may also
select to announce only once.
Announcement position: Select to announce a caller’s waiting
position in the queue, such as “You are caller No. 5 in the call
queue”.
• No: Do not announce a caller’s position.
• Always: Always announce a caller’s position.
• Abbreviated: Announce a caller’s position only once if the
caller is over the marked position and always announce
once the caller is within the marked position.
• Minimal: Announce only when the caller is within the
marked position.
• Mark position: Enter the benchmark for selecting
Abbreviated or Minimal setting.
For example, if you select Abbreviated and enter 5, a
caller’s position is announced when the caller becomes
No. 5 in the queue and announced only once before the
caller becomes No. 5 in the queue.
Announcement interval: Enter the announcement frequency in
seconds.
Custom announcement: You can also customize the
announcement settings.
• Mode: Select the method of greeting announcement to the
caller once the caller enters this call queue. You can also
select to diable this function.
If you select Periodic or Random, enter the announcement
frequency in seconds in Announcement interval.
• Audio: Select a greeting sound file for the announcement.
For more information, see “Managing sound files and
music on hold” on page 119.
Queue entry announcement: Select Enable to announce to
callers when they enter a call queue.
Agent
Agent members
• Click >> to expand Agent members for enrolling agents
into the queue.
• In the Available field, select the agents for this queue.
• Click -> to move it into the Selected field.
• Click Done.
You can type an agent’s extension or name in the Search field
and press Enter to search for the agent.
Call Handling
Scheduled Business Click to configure the business hour call handling action for
Hour call handling the queue. For details, see “Configuring scheduled business
hour queue call handling actions” on page 255.
Fortinet Technologies Inc.
Page 254
FortiVoice Phone System 5.3.0 Administration Guide
Non Scheduled
Business Hour call
handling
Click to configure the non business hour call handling action
for the queue. For details, see “Configuring call handling
actions” on page 262.
6. Click Create.
Configuring scheduled business hour queue call handling actions
Configure the call handling action for the queue. This action applies to all calls once they enter
into the queue.
This option is only available when you edit a queue.
To configure the call handling action
1. Go to Call Features > Call Queue > Call Queue.
2. Select a call queue for which you want to configure queue call handling actions and click
Edit.
3. In Call Handling, click Scheduled Business Hour call handling.
4. Configure the situation upon which the FortiVoice unit can be configured to take
corresponding actions:
GUI field
Description
Queue Overflow
The situation when callers exceed the maximum waiting callers
you set. See “Maximum queue capacity” on page 253.
A popup notification appears when this barometer is triggered.
Queue Timeout
Callers waiting time exceeds the maximum waiting time set in
“Maximum queuing time” on page 253.
A popup notification appears when this barometer is triggered.
Call Processing
Click New to configure call handling action for the situation you
selected.
For some processes that may require further actions, you need
to add one or more call processes to complete the call
handling. For example, after adding a process that contains a
Set call queue priority action, you can add another process with
a Transfer to queue action to complete the call handling. In this
case, the call will be processed again with new priority after it is
transferred to the queue.
Schedule
Select the FortiVoice operation schedule to implement this call
handling action. For more information on schedules, see
“Scheduling the FortiVoice unit” on page 132.
Action
Select the call handling action. Depending on the action
selected, further configuration may be needed. For example, if
you select Dial extension for Action, enter the extension to
which a call is transferred.
5. Click Create, then OK.
Fortinet Technologies Inc.
Page 255
FortiVoice Phone System 5.3.0 Administration Guide
Configuring non scheduled business hour queue call handling actions
Configure the call handling action for the queue. This action applies to all calls once they enter
into the queue.
For some processes that may require further actions, you need to add one or more call
processes to complete the call handling. For example, after adding a process that contains a
Set call queue priority action, you can add another process with a Transfer to queue action to
complete the call handling. In this case, the call will be processed again with new priority after it
is transferred to the queue.
This option is only available when you edit a queue.
To configure the call handling action
1. Go to Call Features > Call Queue > Call Queue.
2. Select a call queue for which you want to configure queue call handling actions and click
Edit.
3. In Call Handling, click Non Scheduled Business Hour call handling.
4. On the Call Processing page, click New to configure call handling action.
5. For Schedule, select the FortiVoice operation schedule to implement this call handling
action. For more information on schedules, see “Scheduling the FortiVoice unit” on
page 132.
6. For Action, select the call handling action. Depending on the action selected, further
configuration may be needed. For example, if you select Dial extension for Action, enter the
extension to which a call is transferred.
7. Click Create, then OK.
Creating queue groups
You can group queues together to facilitate queue management.
To create a call queue
1. Go to Call Features > Call Queue > Queue Group.
2. Click New.
3. Enter a name for the group.
4. Select the available call queues that you want to include in the group and click -> to move
them into the Selected field.
5. Click Create.
Configuring call parking
Call park is a feature for placing a call on hold and then retrieving it from any other local
extension. By default, the FortiVoice unit has 20 park orbits, 301–320.
To view the parked calls, see “Viewing parked calls” on page 26.
To configure call parking
1. Go to Call Features > Call Parking > Call Parking.
Fortinet Technologies Inc.
Page 256
FortiVoice Phone System 5.3.0 Administration Guide
2. For Park call number, enter the number to dial to park a call. The default is 300.
For example, if you enter 300, depending on the phone, when a user receives a call and
wants to park it, the user may:
• Press *1300.
The FortiVoice unit selects the first available park orbit (301–320). The user hears a
confirmation indicating the caller has been parked successfully and into which park orbit.
By default, dialing *1 and then 300 parks a call.
• Provide the park orbit to the person with the parked call through paging or other means
(e.g. “Mary, there is a call parked for you in 301”. Mary can then pick up any phone and
dial 301 to retrieve the parked call.).
3. For Park line start, enter the starting park orbit. The default is 301.
4. For Park line end, enter the ending park orbit. The default is 320.
5. For Parking time out, enter the time, in seconds, to time out the parked call. The default is 60
seconds.
6. For Music on hold, select the music on hold file to play while the call is place on hold. Click
Edit to modify the selected file or click New to configure a new one. For more information on
music on hold, see “Managing sound files and music on hold” on page 119.
7. Click Apply.
Configuring fax
The FortiVoice unit supports fax in the following ways:
• Use the FortiVoice unit to send and receive faxes. The FortiVoice unit contains a full featured
fax server that is able to receive faxes and forward them in PDF format to an extension’s user
web portal or a user’s email. End users can log into their web portal to view the faxes and
upload PDF or JPEG files to send faxes. For configuration information, see “Receiving
Faxes” on page 257 and “Sending faxes” on page 259.
• If you want to continue using your fax machine with the VoIP phone system, connect the fax
machine to an adapter (such as OBIHAI OBi 200, Cisco SPA 112, or Grandstream HT 702)
that supports T.38 first before connecting to the FortiVoice unit. T.38 is a protocol designed
to allow fax to travel over a VoIP network.
In this case, the fax machine is treated like an extension. The FortiVoice unit receives faxes
and relays them to the fax machine. Faxes sent from the fax machine will follow the fax
sending dial plans.
To use this option, you need to create and enable the fax extensions first. You then need to
configure the FortiVoice unit to receive and relay the faxes to the fax machine. See
“Configuring fax extensions” on page 153, “Receiving Faxes” on page 257 and “Sending
faxes” on page 259.
• With FortiVoice 200D-T, if you want to use your existing analog phone line, connect the fax
machine directly to the FXS port. Make sure that the fax function is enabled when
configuring the analog extension. See “Modifying analog extension (200D-T, 1000E-T, and
20E2 models only)” on page 147.
Receiving Faxes
Configure the FortiVoice unit to receive faxes over the VoIP network and forward the faxes to
extensions or emails. You can configure one or more faxes to meet the needs of different
departments, for example.
Fortinet Technologies Inc.
Page 257
FortiVoice Phone System 5.3.0 Administration Guide
To configure receiving faxes
1. Go to Call Features > Fax > eFax Account and click New.
2. Configure the following:
GUI field
Description
Name
Enter a name for the receiving fax configuration.
Number
Enter an extension for this fax. This is where the incoming faxes go
to.
Display name
Enter the name displaying on the extension.
Show suggested
numbers
Select and click in the Number field to display the extension numbers
available for use. If it is deselected, clicking in the Number field
displays the extension numbers already in use.
This option also serves as a diagnostic tool for finding and fixing
duplicate or missing numbers. Missing numbers are the extensions
that have user IDs but not numbers.
When there are duplicate or missing numbers, an orange
exclamation mark icon appears beside this option. You can click the
icon and fix the numbers. For more information, see “Fixing duplicate
or missing numbers” on page 143.
Enabled
Select to activate this fax.
External Numbers
Map the DID numbers to the extension of the fax. Incoming faxes to
the DIDs will all reach the extension. For information on DID, see
“Mapping DIDs” on page 193.
To map the DID numbers:
• Click New.
• Select Enabled to activate this DID mapping.
• Select the trunk used for dialing the DIDs.
• Enter the DID number that you want to map to an extension.
• Click Create.
Select Fax Monitors Select the users that can monitor the faxes received on this fax
extension in their FortiVoice user web portal and can choose to view,
delete, resend, forward, or download the faxes. For more
information, see the online help of the web user portal.
The selected users will also receive email notifications when a fax is
received if their extensions are linked with email addresses. The
notification will also have a PDF attachment of the fax if their
extensions are configured with email notification attachment option.
For more information, see “Setting extension user preferences” on
page 156.
This is useful if you have a fax that serves several departments.
Fortinet Technologies Inc.
Fax to Email
Enter the email addresses to receive the faxes sent to this extension.
Users will receive the faxes in PDF format.
Relay to Fax
Machine
Select the fax machines connected to the FortiVoice unit via T.38
adapters. Faxes will be relayed to the selected machines.
Page 258
FortiVoice Phone System 5.3.0 Administration Guide
Archive
Select Fax archive to activate fax archiving. Enter the maximum
number of faxes to archive and the maximum number of days to
keep them.
To view faxes sent and received through the FortiVoice unit, see
“Viewing archived faxes” on page 31.
Description
Optionally, you can enter some notes about this configuration.
3. Click Create.
Sending faxes
Configure the dial plans for sending faxes. The dialed fax numbers matching the configured
number pattern will be subject to the call handling actions.
The fax sending dial plans will not interfere with phone call dial plans since the FortiVoice unit
deals with the dial plans separately.
For information on dial plans, see “Configuring Call Routing” on page 189.
You send faxes in the user web portal. Senders will receive email notifications when a fax is sent
if their extensions are linked with email addresses. The notification will inform if the fax has been
successfully sent and have a PDF attachment of the fax if their extensions are configured with
email notification attachment option. For more information, see “Setting extension user
preferences” on page 156.
In addition, senders can always view the status of the fax sent in their FortiVoice user web
portal. For more information, see the online help of the web user portal.
To view the outbound dial plans, go to Call Features > Fax > Sending Rule.
GUI field
Description
Test
Select to test if the dial plan is created successfully.
For more information, see “Testing dial plans for sending faxes” on
page 260.
Enabled
Select to activate this dial plan.
Name
The name of the dial plan.
Pattern
The phone number pattern in the dial plan that matches other numbers.
For details, see “Dialed Number Match” on page 260.
Call handling
The call handling action for the numbers matching the configured
number pattern and the caller IDs matching the caller ID pattern. For
details, see “Call Handling” on page 260.
To set up a fax sending dial plan
1. Go to Call Features > Fax > Sending Rule.
2. Click New.
3. Configure the following:
Fortinet Technologies Inc.
GUI field
Description
Name
Enter a name for this plan.
Page 259
FortiVoice Phone System 5.3.0 Administration Guide
Enabled
Select to activate this dial plan.
Dialed Number Match
With dialed number pattern matching, you can create one
phone number pattern in your dial plan that matches many
different numbers.
The dialed numbers matching this pattern will follow this dial
plan rule.
For information on adding a dialed number match, see
“Creating dialed number match” on page 261.
Call Handling
Click New to configure the call handling action for the
numbers matching the configured number pattern. For details,
see “Configuring call handling actions” on page 262.
4. Click Create.
Testing dial plans for sending faxes
After you create a dial plan, you can select the dial plan and click Test to see if the dial plan
works.
For more information, see “Test” on page 259.
To test a dial plan
1. Go to Call Features > Fax > Sending Rule.
2. Select the dial plan that you want to test and click Test.
The call test page appears.
3. Configure the following:
GUI field
Description
Test Call - Dry Run
Run a system outbound dial plan test without making a real
phone call.
Destination number Enter a destination number to call.
From number
Enter the number from which you want to call the destination
number. The FortiVoice unit will connect this number with the
destination number for the test.
Test
Click to start the dry run test and view the Test result.
Reset
Click to remove the test result in order to start a new test.
Test Call
Test the dial plan by making a real phone call.
Destination number Enter a destination number to call.
Fortinet Technologies Inc.
Page 260
FortiVoice Phone System 5.3.0 Administration Guide
After call is
established
Select the FortiVoice action once it calls the destination
number:
• Play welcome message: The FortiVoice unit will play a
message to the destination number.
• Connect test call to number: In the Number field, enter the
number from which you want to call the destination
number. The FortiVoice unit will connect this number with
the destination number to test the trunk.
Test
Click to start the test and view the Test result.
Reset
Click to remove the test result in order to start a new test.
Creating dialed number match
You can create one extension number pattern in your dial plan that matches many different
numbers for outbound calls.
The numbers matching this pattern will follow this dial plan rule.
The FortiVoice unit supports the following pattern-matching syntax:
Table 2: Pattern-matching syntax
Syntax
Description
X
Matches any single digit from 0 to 9.
Z
Matches any single digit from 1 to 9.
N
Matches any single digit from 2 to 9.
[15-7]
Matches a single character from the range of digits specified. In this case, the
pattern matches a single 1, as well as any number in the range 5, 6, 7.
.
Wildcard match; matches one or more characters, no matter what they are.
!
Wildcard match; matches zero or more characters, no matter what they are.
Table 3: Pattern-matching examples
Pattern
Description
NXXXXXX
Matches any seven-digit number, as long as the first digit is 2 or higher.
NXXNXXXXXX
This pattern matches with areas with 10-digit dialing.
1NXXNXXXXXX
Matches the number 1, followed by an area code between 200 and 999,
then any seven-digit number. In the North American Numbering Plan calling
area, you can use this pattern to match any long-distance number.
011.
Matches any number that starts with 011 and has at least one more digit.
To create a dialed number match
1. Go to Call Features > Fax > Sending Rule.
2. Click New.
3. In Dialed Number Match, click New.
Fortinet Technologies Inc.
Page 261
FortiVoice Phone System 5.3.0 Administration Guide
4. Configure the following:
GUI field
Description
Match Pattern
New
Modification
Strip
Click to add the number pattern in the Value field following
“Pattern-matching syntax” on page 261 and “Pattern-matching
examples” on page 261 for this dial plan. Repeat to add more
patterns.
You can manipulate the number patterns you entered.
Enter a number to omit dialing the starting part of a pattern. 0
means no action.
For example, if your Match Pattern is 9XXX and Strip is 1, you
only need to dial the last three digits for this pattern.
Prefix
Add a number before a pattern, such as area code.
For example, if your Match Pattern is 123XXXX and its area
code is 555, you can enter 555 for the Prefix. When you dial a
number under this pattern, you do not need to dial the area
code 555.
Postfix
Add a number after a pattern.
For example, if your Match Pattern is 9XXX and the numbers
under this pattern have been upgraded to have an additional
digit 5 at the end, you can enter 5 for the Postfix. When you dial
a number under this pattern, you do not need to dial the last
digit 5.
5. Click Create.
Configuring call handling actions
Configure the call handling action for the numbers matching the configured number pattern.
To configure the call handling action
1. Go to Call Features > Fax > Sending Rule.
2. Click New.
3. In Call Handling, click New.
4. Configure the following:
GUI field
Description
Call Handling Action
Fortinet Technologies Inc.
Schedule
Select the FortiVoice operation schedule to implement this
plan. Click Edit to modify the selected schedule or click New to
configure a new one. For more information on PBX schedule,
see “Scheduling the FortiVoice unit” on page 132.
Action
Select the call handling action for the numbers matching the
configured number pattern and the caller IDs matching the
caller ID pattern.
Page 262
FortiVoice Phone System 5.3.0 Administration Guide
Outgoing trunk
Select the trunk for sending faxes. Click Edit to modify the
selected trunk or click New to configure a new one. For more
information on trunks, see “Configuring Trunks” on page 175.
Caller ID
modification
Select the caller ID modification configuration. Click Edit to
modify the selected configuration or click New to configure a
new one. For more information on caller ID modification, see
“Modifying caller IDs” on page 122.
Warning message
If you select Allow with warning or Deny with warning in the
Action field, select the sound file for the warning. Click Edit to
modify the selected file or click New to configure a new one.
For more information on sound files, see “Managing sound files
and music on hold” on page 119.
Delay
Optionally, if you want to discourage certain users for sending
faxes, enter the call delay time in seconds.
5. Click Create.
Configuring other fax settings
Configure the station IDs, fax header, T.38 fax options, and fax sending queue for outgoing
faxes.
To configure fax settings
1. Go to Call Features > Fax > Setting.
2. Configure the following:
GUI field
Description
System station ID
Enter a station ID that shows on each fax sent from the
FortiVoice unit.
System fax header
Enter a fax subject header that shows on each fax sent from
the FortiVoice unit.
T.38 Fax
Sending Fax: Initiate Select if the fax receiving terminal does not reply to a T.38
a T.38 reinvite if the invitation.
remote end does
not
Sending/Receiving: Select to use G.711 mode if T.38 communication fails.
Fallback to audio
(G.711) mode on
T.38 failure
UDPTL port start
T.38/UDPTL uses UDP as its transport protocol.
Enter the UDP Transport Layer start port.
UDPTL port end
Enter the UDP Transport Layer end port.
Send Queue
Fortinet Technologies Inc.
Page 263
FortiVoice Phone System 5.3.0 Administration Guide
Max retry times
Enter the maximum number of times to resend a fax. This is
useful if a fax cannot be sent due to busy lines or other
reasons.
Retry interval
Enter the time interval between fax sending retries.
Wait time for an
answer
Enter the waiting time for a “go-ahead” signal from the fax
receiving terminal. After the waiting time is over, the FortiVoice
unit will either retry to send the fax or stop sending it
depending on the Max retry times configuration.
3. Click Apply.
Archiving faxes
Configure the settings to archive the faxes.
To configure archiving faxes
1. Go to Call Features > Fax > Archive.
2. Configure the following:
GUI field
Description
Rotation Settings
Fax rotation
size/time
Enter the archived fax file rotation size and time.
When the file reaches either the rotation size or time specified,
whichever comes first, the archiving file is automatically renamed.
The FortiVoice unit generates a new file, where it continues
saving recording archives. You can access all rotated files
through search.
Archiving options Specify what the FortiVoice unit should do if it runs out of disk
when disk quota is space. Select Overwrite to remove the oldest archived folder in
full
order to make space for the new archive, or select Do not archive
to stop archiving more recorded calls.
Schedule
Select a schedule for the rotation.
Destination Settings
Destination
Select an archiving destination:
• Local: the FortiVoice unit’s local hard drive or a NAS server.
• Remote: a remote FTP or SFTP storage server.
Local disk quota
If Local is the archiving destination, enter the disk space quota.
The total disk quota for archiving calls cannot exceed 20% of the
total data disk size. For example, if the data disk has a size of 100
GB, a maximum of 20 GB can be used for fax archiving.
If this quota is met and a new fax must be archived, the
FortiVoice unit either automatically removes the oldest fax archive
folder in order to make space for the new archive or stops
archiving, depending on the settings you specify under “Rotation
Settings” on page 249.
Fortinet Technologies Inc.
Page 264
FortiVoice Phone System 5.3.0 Administration Guide
If Remote is the archiving destination, configure the following:
Protocol
Select the protocol that the FortiVoice unit will use to connect to
the remote storage server, either SFTP or FTP.
IP address
Enter the IP address of the remote storage server.
User name
Enter the user name of an account the FortiVoice unit will use to
access the remote storage server, such as FortiVoice.
Password
Enter the password for the user name of the account on the
remote storage server.
Remote directory
Enter the directory path on the remote storage server where the
FortiVoice unit will store archived calls, such as
/home/fortivoice/call-archives.
Remote cache
quota
Enter the FortiVoice cache quota that is allowed to be used for
remote host archiving. The above statement regarding the Local
disk quota also applied to the cache quota.
3. Click Apply.
Setting calendar reminder
You can schedule daily events and send event reminders. You first create a reminder record
before setting up reminder events. One reminder record can contain multiple reminder events.
To schedule an event
1. Go to Call Features > Reminder and click New.
2. Enter a name for the reminder.
3. Enable the reminder and add notes if required.
4. Click Create.
5. In the reminder list, select the reminder record you just created.
6. Click Edit in calendar mode.
7. Double-click a date.
8. Configure the following:
Fortinet Technologies Inc.
GUI field
Description
Title
Enter a name for the reminder event.
Location
Enter the location for the event.
Start time
Specify when the event starts.
Recurrence
Click None to configure recurrence settings.
Description
Enter any notes as required.
Page 265
FortiVoice Phone System 5.3.0 Administration Guide
Guest
Click Add to select the internal and external phone numbers to
which you want to send event reminder calls.
If you want to delete a number, select the number and click
Remove.
Reminder audio
Configure the reminder audio that are sent to the selected guest
phones.
• Default: The reminder audio will be a beep sound.
• Create New: Click to customize the reminder audio. For
Action, click Call me to record a message from an extension;
Upload to look for an existing reminder audio; and Download
to save the audio file. For Extension, if you select Call me for
Action, select the extension on which you want to record a
message.
• Click Create and Create to exit.
Modifying feature access codes
By default, the FortiVoice unit defines the following codes for users to access certain features
by dialing the codes. You can go to Call Features > Feature Code > Vertical Service
Code/Mid-Call/DTMF Code and double-click a feature name to modify its code and description,
but that does not change the mapping between the code and the feature. For example, if you
change the DISA code from the default ** to 12, dialing 12 still accesses the DISA feature.
There are:
• Vertical Service Codes: a sequence of digits and the signals star (*) and number sign (#)
dialed on a telephone keypad or rotary dial to enable or disable certain telephony service
features.
• Mid-Call/DTMF Codes: allow you to hold, transfer, and conference calls by using DTMF digit
codes entered on the phone.
Table 4: Vertical Service Codes
GUI field
Description
Call bridge (DISA)
Direct Inward System Access (DISA) service allows external users to dial
into PBX and use PBX service just like the local extensions.
To use DISA, dial the PBX main number and then ** or the code you set.
The PBX will prompt you to enter the account code (account code set at
PBX > Class of Service > Account code). Once you pass authorization,
you can use PBX service just like a local extension.
Check hot desk
login status
Hot-desking refers to the sharing of one phone by multiple users at
different time periods.
Dial *10 or the code you set to check hot desk login status including login
expiry time.
Hot desk user
login
Fortinet Technologies Inc.
Hot-desking refers to the sharing of one phone by multiple users at
different time periods. Each user can log into the phone by pressing *11
or the code you set and enter his extension number and voicemail PIN
following the prompts.
Page 266
FortiVoice Phone System 5.3.0 Administration Guide
Table 4: Vertical Service Codes
GUI field
Description
Hot desk user
logout
To log out hot desking, press *12 or the code you set.
Reset the phone
This code is used to remove the extension number of a FortiFone by the
to be 'unassigned' administrator.
by admin
Dial *15 or the code you set on any FortiFone that connects to the
FortiVoice unit and enter the phone configuration PIN.
For information on setting the phone configuration PIN, see “Configuring
SIP phone auto-provisioning” on page 112.
Reset the phone
This code is used to remove the extension number of a FortiFone by the
to be 'unassigned' user.
by user
Dial *16 or the code you set on your FortiFone that connects to the
FortiVoice unit and enter the phone configuration PIN.
For information on setting the phone configuration PIN, see “Configuring
SIP phone auto-provisioning” on page 112.
Configure phone This code is used to set an extension number for a FortiFone by the
to an extension by administrator.
administrator
Dial *17 or the code you set on any FortiFone that connects to the
FortiVoice unit and enter the phone configuration PIN. You can then enter
an existing extension to set it as the extension of this phone.
For information on setting the phone configuration PIN, see “Configuring
SIP phone auto-provisioning” on page 112.
Configure phone This code is used to set an extension number for a FortiFone by a phone
to an extension by user.
user
Dial *18 or the code you set on your FortiFone that connects to the
FortiVoice unit and enter the phone configuration PIN provided by the
administrator. You can then enter an existing extension to set it as the
extension of this phone.
Lookup name
directory from
extension
Dial *411 or the code you set to access the phone directory where you
can look for an extension by entering a person’s name.
Listen/Barge on a Dial *50 or the code you set to monitor a call by listening to it. You also
call
need to enter your voicemail PIN. For details, see “Monitor/Recording”
on page 241
Agent login to all
queues
Dial *61 or the code you set to log into the queues of which your
extension is a member.
Agent logout from Dial *62 or the code you set to log out of the queues of which your
all queues
extension is a member.
Agent login to a
queue
Dial *63 or the code you set and enter your voicemail password and the
queue extension to log into this queue.
The voicemail password is required only if this option is selected for your
extension. For more information, see “Call Center” on page 142.
Fortinet Technologies Inc.
Page 267
FortiVoice Phone System 5.3.0 Administration Guide
Table 4: Vertical Service Codes
GUI field
Description
Agent login from a Dial *64 or the code you set and enter your voicemail password and the
queue
queue extension to log out of this queue.
The voicemail password is required only if this option is selected for your
extension. For more information, see “Call Center” on page 142.
Login all queue
members
Dial *65 or the code you set to login all members of a queue of which
your extension is a member. This is an action by the administrator.
Logout all queue
members
Dial *66 or the code you set to logout all members of a queue of which
your extension is a member. This is an action by the administrator.
Pause agent all
queues
Dial *67 or the code you set and enter your voicemail password and the
reason code to pause all queues of which this extension is a member.
For information on reason codes, see “Modifying agent reason code
descriptions” on page 219.
Unpause agent all Dial *68 or the code you set and enter your voicemail password and the
queues
reason code to unpause all queues of which this extension is a member.
For information on reason codes, see “Modifying agent reason code
descriptions” on page 219.
Set call forward
Dial *71 followed by a code to set user’s call forward: 1 to enable, 0 to
disable, and 9 to change the forwarding number.
User’s quick mode Dial *72 followed by 1, 2, or 3 and enter your voicemail password to
switch
temporarily replace the original personal schedule with one of the three
default ones. You may also modify the temporary schedule. Dial *720 to
go back to the original schedule.
User’s twinning
mode switch
Dial *73 followed by 1 to enable twinning and 0 to disable twinning. For
information on twinning, see “Twinning Setting” on page 162.
Enter floating
mode and make
outgoing call on
floating host
device
This code allows you to make international or long distance calls from a
floating host device which is a device (usually a phone) that allows other
extensions to originate a call.
Fortinet Technologies Inc.
Dial *74 or the code you set and dial the outgoing call number when
hearing the dial tone. When you are prompted to input the code, enter
the code based on the call restriction in the user privileges associated
with your extension. For more information, see “Floating code format” on
page 271.
Page 268
FortiVoice Phone System 5.3.0 Administration Guide
Table 4: Vertical Service Codes
GUI field
Description
Hotel room
condition
Dial *75 or the code you set and enter a maid code to show the room
condition.
The maid codes include:
• 1: Maid present
• 2: Clean
• 3: Not clean
• 4: Out of service
• 5: To be inspected
• 6: Occupied/clean
• 7: Occupied/not clean
• 8: Vacant/clean
• 9: Vacant/not clean
For information on maid codes, see “Configuring hotel management
settings” on page 226.
Minibar
notification
Dial *76 or the code you set and enter a minibar code to order room
items.
For information on minibar codes, see “Configuring hotel management
settings” on page 226.
Wake-up call
Dial *77 or the code you set and enter a time for a wake-up call. The time
format should be in the format of hhmm. For example, 15:30 is entered as
1530.
DND on
Dial *78 or the code you set to turn on the Do Not Disturb service. Callers
will hear the busy sound when they dial your number.
DND off
Dial *79 or the code you set to turn off the Do Not Disturb service.
Otherwise, callers will hear the busy sound when they dial your number.
Pickup any ringing As a pickup group member, you can dial *80 or the code you set on your
extension in
phone to pick up a call from any ringing extension.
pickup group
For information on pickup groups, see “Creating pickup groups” on
page 169.
Pickup group
extension
As a pickup group member, you can dial *81 or the code you set on your
phone followed by a ringing extension number to pick up a call from that
extension.
For information on pickup groups, see “Creating pickup groups” on
page 169.
System schedule
override
Fortinet Technologies Inc.
An administrator with the privilege can dial *82 followed by 1, 2, or 3 and
the administrator PIN to temporarily replace the original system schedule
with one of the three default ones. You may also modify the temporary
schedule. Dial *820 to go back to the original schedule. See “Configuring
system capacity” on page 117.
Page 269
FortiVoice Phone System 5.3.0 Administration Guide
Table 4: Vertical Service Codes
GUI field
Description
Amazon Alexa
Dial *91 or the code you set on your phone to use voice command. See
“Configuring Internet of things (IoT)” on page 271.
Intercom
Dial *92 or the code you set and an extension to intercom that extension.
Prompt sound file Dial *93 or the code you set and enter the prompt file ID and select the
recording
language to record your prompt file.
Voicemail direct
Dial *97 or the code you set from your own phone and then enter your
voicemail password to directly access your voice mailbox.
Voicemail prompt
Dial *98 or the code you set from any extension and then enter your
extension number and voicemail password to access your voice mailbox.
Operator
Dial 0 or the code you set to access the operator.
One key DND
This is for supporting the DND key on the FortiFones. Press the DND key
on the FortiFone to turn DND on or off.
Page group
Enter PAGEGROUP or the code you set then the page group number to
page the extension group.
Unpark
This is for supporting the Unpark key on the FortiFones. Press this key on
the FortiFone to unpark a call.
Table 5: Mid-Call/DTMF Codes
GUI field
Description
Blind transfer
Blind transfer serves 2 purposes:
• During a call, dial *11 or the code you set and then the extension number
of a second person to transfer the call to the person without talking to the
person.
• During a call, dial *11 and then the call parking number (default is 300) to
park a call. For details, see “Configuring call parking” on page 256.
Attended
transfer
During a call, dial *12 or the code you set and then the extension number of
a second person to transfer the call to the person. Since you want to inform
the second person about the call, you can have a private conversation with
the person without the first person who made the call hearing it.
Start personal
recording
Dial *30 or the code you set to start personal call recording. Personal
recordings can be reviewed on the user web portal.
Before doing so, have the agreement of the person you talk with or check
your local laws regarding phone recording.
Start system
recording
Dial *35 or the code you set to start system call recording. System
recordings need administrator permission and can be viewed on the system
admionistration web GUI.
Before doing so, have the agreement of the person you talk with or check
your local laws regarding phone recording.
Fortinet Technologies Inc.
Page 270
FortiVoice Phone System 5.3.0 Administration Guide
Table 5: Mid-Call/DTMF Codes
GUI field
Description
Pause system
recording
Dial *36 or the code you set to pause system call recording.
Resume
system
recording
Dial *37 or the code you set to resume system call recording.
Cancel system Dial *38 or the code you set to cancel system call recording.
recording
Park
Dial *40 or the code you set to park a call.
Table 6: Floating code format
Caller privilege
Code format
Allow
Extension number + * + extension user PIN
or extension number + * + extension PIN
(account code)
Allow with personal code
Extension number + * + extension user PIN
Allow with account code
Extension number + * + user privilege
account code
Allow with account and personal code
Extension number + * + user privilege
account code
or extension number + * + extension user PIN
Configuring Internet of things (IoT)
The FortiVoice unit integrates with Amazon Alexa which allows you to operate your FortiVoice
unit through voice commands. It also supports integration with IFTTT Web service for 3rd party
applications.
To view the IoT accounts, go to Call Features > Internet of Things > IoT Account.
GUI field
Description
Register
Select an account and click this option to register it on the IoT proxy
server to start the service.
Name
The name of the account.
Extension
The extension number associated with the account.
Services
The type of the account, Amazon Alexa or IFTTT.
Description
The comments on the account.
Status
Displays if the account has been registered on the IoT proxy server.
Fortinet Technologies Inc.
Page 271
FortiVoice Phone System 5.3.0 Administration Guide
To configure an IoT account
1. Go to Phone System > Advanced Settings > Miscellaneous.
2. Depending on the type of account you want to configure, select Amazon Alexa or IFTTT
under Internet of Things, and click Apply.
3. Go to Call Features > Internet of Things.
4. Click New.and configure the following:
GUI field
Description
Account/Email
Enter the your email address as the account name.
Authorization code
Enter a password or click Generate to have a system generated
password.
Extension
Select the extension number associated with the account.
Description
Enter any notes as required.
Service
Select the Amazon Alexa or IFTTT service for the account. If you
wish to use the phone to initiate requests to Alexa, select Allow
FortiVoice extension.
5. Click Create.
6. If you want to automatically register this account on the IoT proxy server, click Yes.
Otherwise, click No.
Fortinet Technologies Inc.
Page 272
FortiVoice Phone System 5.3.0 Administration Guide
Configuring Logs and Reports
The Log & Report menu lets you configure FortiVoice logging and reporting.
FortiVoice units provide extensive logging capabilities for voice incidents and system events.
Detailed log information provides analysis of network activity to help you identify network issues
and reduce network misuse and abuse.
Logs are useful when diagnosing problems or when you want to track actions the FortiVoice unit
performs as it receives and processes phone calls.
Reports provide a way to analyze log data without manually going through a large amount of
logs to get to the information you need.
This topic includes:
• About FortiVoice logging
• Configuring logging
• Configuring report profiles and generating call reports
• Submitting CDRs to a database
• Configuring Station Messaging Detail Record (SMDR)
• Configuring alert email
About FortiVoice logging
FortiVoice units can log:
• system-related events, such as configuration changes and administrator login/logout
• phone call events
You can select which severity level an activity or event must meet in order to be recorded in the
logs. For more information, see “Log message severity levels” on page 274.
A FortiVoice unit can save log messages to its hard disk or a remote location, such as a Syslog
server or a FortiAnalyzer™ unit. For more information, see “Configuring logging” on page 275. It
can also use log messages as the basis for reports. For more information, see “Configuring
report profiles and generating call reports” on page 279.
This topic includes:
• FortiVoice log types
• Log message severity levels
FortiVoice log types
FortiVoice units can record the following types of log messages. The Event log also contains
several subtypes. You can view and download these logs from the Logs submenu of the Status
tab.
Fortinet Technologies Inc.
Page 273
FortiVoice Phone System 5.3.0 Administration Guide
Table 7: Log types
Log type
Subtype
Description
Event
config
admin
system
smtp
ha
dhcp
voice mail
monitor
Includes system and administration events, such as
downloading a backup copy of the configuration.
Voice
Includes phone calls events.
Fax
Includes fax events.
DTMF
Includes DTMF (Dual Tone Multi-Frequency) events.
Hotel
Includes hotel management events, such as guest
check-in and check-out.
Call center
IVR
Includes call center IVR events.
AGT
Includes call center agent events.
Avoid recording highly frequent log types such as voice logs to the local hard disk for an
extended period of time. Excessive logging frequency can cause undue wear on the hard disk
and may cause premature failure.
Log message severity levels
Each log message contains a field that indicates the severity level of the log message, such as
warning.
Table 8: Log severity levels
Levels
Description
0 - Emergency
Indicates the system has become unusable.
1 - Alert
Indicates immediate action is required.
2 - Critical
Indicates functionality is affected.
3 - Error
Indicates an error condition exists and functionality could be
affected.
4 - Warning
Indicates functionality could be affected.
5 - Notification
Provides information about normal events.
6 - Information
Provides general information about system operations.
6 - Debug
Provides information useful to debug a problem.
For each location where the FortiVoice unit can store log files, you can define the severity
threshold of the log messages to be stored there.
Fortinet Technologies Inc.
Page 274
FortiVoice Phone System 5.3.0 Administration Guide
Avoid recording log messages using low severity thresholds such as Information or
Notification to the local hard disk for an extended period of time. A low log severity threshold
is one possible cause of frequent logging. Excessive logging frequency can cause undue wear
on the hard disk and may cause premature failure.
The FortiVoice unit stores all log messages equal to or exceeding the severity level you select.
For example, if you select Error, the FortiVoice unit stores log messages whose severity level is
Error, Critical, Alert, or Emergency.
Configuring logging
The Log Settings submenu includes two tabs, Local Log Settings and Remote Log Settings,
that let you:
• set the severity level
• configure which types of log messages to record
• specify where to store the logs
You can configure the FortiVoice unit to store log messages locally (that is, in RAM or to the hard
disk), remotely (that is, on a Syslog server or FortiAnalyzer unit), or at both locations.
Your choice of storage location may be affected by several factors, including the following:
• Local logging by itself may not satisfy your requirements for off-site log storage.
• Very frequent logging may cause undue wear when stored on the local hard drive. A low
severity threshold is one possible cause of frequent logging. For more information on
severity levels, see “Log message severity levels” on page 274.
For information on viewing locally stored log messages, see “Viewing log messages” on
page 34.
This section includes the following topics:
• Configuring logging to the hard disk
• Choosing which events to log
• Configuring logging to a Syslog server or FortiAnalyzer unit
Configuring logging to the hard disk
You can store log messages locally on the hard disk of the FortiVoice unit.
To ensure that the local hard disk has sufficient disk space to store new log messages and that
it does not overwrite existing logs, you should regularly download backup copies of the oldest
log files to your management computer or other storage, and then delete them from the
FortiVoice unit. (Alternatively, you could configure logging to a remote host.)
You can view and download these logs from the Log submenu of the Monitor tab. For more
information, see “Viewing log messages” on page 34.
For logging accuracy, you should also verify that the FortiVoice unit’s system time is accurate.
For details, see “Configuring the time and date” on page 77.
To configure logging to the local hard disk
1. Go to Log & Report > Log Settings > Local Log Settings.
2. Select the Enable option to allow logging to the local hard disk.
Fortinet Technologies Inc.
Page 275
FortiVoice Phone System 5.3.0 Administration Guide
3. In Log file size, enter the file size limit of the current log file in megabytes (MB). The log file
size limit must be between 10 MB and 1000 MB.
4. In Log time, enter the time (in days) of file age limit.
5. In At hour, enter the hour of the day (24-hour format) when the file rotation should start.
When a log file reaches either the age or size limit, the FortiVoice unit rotates the current log
file: that is, it renames the current log file (elog.log) with a file name indicating its sequential
relationship to other log files of that type (elog2.log, and so on), then creates a new current
log file. For example, if you set the log time to 10 days at hour 23, the log file will be rotated
at 23 o’clock of the 10th day.
Large log files may decrease display and search performance.
6. From Log level, select the severity level that a log message must equal or exceed in order to
be recorded to this storage location.
7. From Log options when disk is full, select what the FortiVoice unit will do when the local disk
is full and a new log message is caused, either:
• Do not log: Discard all new log messages.
• Overwrite: Delete the oldest log file in order to free disk space, and store the new log
message.
8. In Logging Policy Configuration, click the arrow to review the options and enable the types of
logs that you want to record to this storage location. For details, see “Choosing which
events to log” on page 276.
9. Click Apply.
Choosing which events to log
Both the local and remote server configuration recognize the following events. Select the check
boxes of the events you want to log.
Fortinet Technologies Inc.
Page 276
FortiVoice Phone System 5.3.0 Administration Guide
Table 9: Events logging options
Event Log
Select this check box and then select specific events. No event types
are logged unless you enable this option.
• When configuration has changed: Log configuration changes.
• Admin login/logout event: Log all administrative events, such as
logins, resets, and configuration updates.
• System activity event: Log all system-related events, such as
rebooting the FortiVoice unit.
• SMTP server event: Log SMTP relay or proxy events. This option is
for local log setting only.
• HA: Log all high availability (HA) activity.
• DHCP event: Log DHCP server events. This option is for local log
setting only.
• Voice mail event: Log voicemail events. This option is for remote log
setting only.
• Monitor: Log call recording, call barging, and traffic capture events.
Voice Log
Log phone call events. This option is for local log setting only.
Fax Log
Log fax events.
DTMF Log
DTMF (Dual Tone Multi-Frequency) events.
Hotel Log
Log hotel management events, such as guest check-in and check-out.
Call Center Log
Log call center events, such as IVR and agent events.
Configuring logging to a Syslog server or FortiAnalyzer unit
Instead of or in addition to logging locally, you can store log messages remotely on a Syslog
server or a FortiAnalyzer unit.
You can add a maximum of three remote Syslog servers.
Logs stored remotely cannot be viewed from the web-based manager of the FortiVoice unit. If
you require the ability to view logs from the web-based manager, also enable local storage.
For details, see “Configuring logging to the hard disk” on page 275.
Before you can log to a remote location, you must first enable logging. For details, see
“Choosing which events to log” on page 276. For logging accuracy, you should also verify that
the FortiVoice unit’s system time is accurate. For details, see “Configuring the time and date” on
page 77.
To configure logging to a Syslog server or FortiAnalyzer unit
1. Go to Log & Report > Log Settings > Remote Log Settings.
Fortinet Technologies Inc.
GUI field
Description
Enabled
Select to enable remote storage on the server. Clear to disable
storage.
Page 277
FortiVoice Phone System 5.3.0 Administration Guide
Profile Name
Displays the remote host name.
Server
Displays the IP of the Syslog server or FortiAnalyzer unit.
Port
Displays the port on the Syslog server or FortiAnalyzer unit.
Level
Displays the minimum severity level for logging purposes.
Facility
Displays the facility identifier the FortiVoice unit uses to identify itself.
2. Click New to create a new entry or double-click an existing entry to modify it.
GUI field
Description
Log to Remote Host
Enable
Select to allow logging to a remote host.
Name
Enter a name for the remote host.
IP
Enter the IP address of the Syslog server or FortiAnalyzer unit
where the FortiVoice unit will store the logs.
Port
If the remote host is a FortiAnalyzer unit, enter 514; if the remote
host is a Syslog server, enter the UDP port number on which the
Syslog server listens for connections (by default, UDP 514).
Level
Select the severity level that a log message must equal or exceed
in order to be recorded to this storage location.
For information about severity levels, see “Log message severity
levels” on page 274.
Facility
Select the facility identifier that the FortiVoice unit will use to
identify itself when sending log messages.
To easily identify log messages from the FortiVoice unit when they
are stored on a remote logging server, enter a unique facility
identifier, and verify that no other network devices use the same
facility identifier.
CVS format
Enable this option if you want to send log messages in
comma-separated value (CSV) format.
Do not enable this option if the remote host is a FortiAnalyzer
unit. FortiAnalyzer units do not support CSV-formatted log
messages.
Logging Policy
Configuration
Click the arrow to review the options and enable the types of logs
you want to record to this storage location. For details, see
“Choosing which events to log” on page 276.
3. Click Create.
4. If the remote host is a FortiAnalyzer unit, confirm with the FortiAnalyzer administrator that the
FortiVoice unit was added to the FortiAnalyzer unit’s device list, allocated sufficient disk
space quota, and assigned permission to transmit logs to the FortiAnalyzer unit. For details,
see the FortiAnalyzer Administration Guide.
Fortinet Technologies Inc.
Page 278
FortiVoice Phone System 5.3.0 Administration Guide
5. To verify logging connectivity, from the FortiVoice unit, trigger a log message that matches
the types and severity levels that you have chosen to store on the remote host. Then, on the
remote host, confirm that it has received that log message.
For example, if you have chosen to record event log messages to the remote host and if they
are more severe than Information, you could log in to the web-based manager or download a
backup copy of the FortiVoice unit’s configuration file in order to trigger an event log
message.
If the remote host does not receive the log messages, verify the FortiVoice unit’s network
interfaces (see “Configuring the network interfaces” on page 43 and “About the
management IP” on page 42) and static routes (see “Configuring static routes” on page 48),
and the policies on any intermediary firewalls or routers. If ICMP ECHO (ping) is enabled on
the remote host, you can use the execute traceroute command to determine the point where
connectivity fails. For details, see the FortiVoice CLI Reference.
Configuring report profiles and generating call reports
The Log & Report > Call Report > Call Report tab displays a list of report profiles.
A report profile is a group of settings that contains the report name, its subject matter, its
schedule, and other aspects that the FortiVoice unit considers when generating reports from log
data. The FortiVoice unit presents the information in tabular and graphical format.
You can create one report profile for each type of report that you will generate on demand or on
a schedule.
Generating reports can be resource intensive. To avoid phone processing performance
impacts, you may want to generate reports during times with low traffic volume, such as at
night. For more information on scheduling the generation of reports, see “Configuring report
email notifications” on page 282.
To view and configure report profiles
1. Go to Log & Report > Call Report > Call Report.
Fortinet Technologies Inc.
Page 279
FortiVoice Phone System 5.3.0 Administration Guide
Figure 2: Configuration tab
GUI field
Description
Generate
Select a report and click this button to generate a report
immediately. See “Generating a report manually” on page 283.
View Reports
Click to display the list of reports generated by the FortiVoice unit.
You can delete, view, and/or download generated reports. For more
information, see “Viewing generated reports” on page 33.
Report Name
Displays the name of the report profiles.
Schedule
Displays the frequency with which the FortiVoice unit generates a
scheduled report. If the report is designed for manual generation,
Not Scheduled appears in this column.
2. Click New to add a profile or double-click a profile to modify it.
A multisection dialog appears.
Figure 3: New report configuration
3. In Name, enter a name for the report profile.
Report names cannot include spaces.
4. Click the arrow next to each option, and configure the following as needed:
• Configuring the report query selection
• Configuring the report time period
• Configuring report email notifications
• Configuring the report schedule
• Choosing call rate
• Generating a report manually
5. Click Create.
Configuring the report query selection
When configuring a report profile, you can select the queries that define the subject matter of
the report.
Fortinet Technologies Inc.
Page 280
FortiVoice Phone System 5.3.0 Administration Guide
Each report profile corresponds to a chart that will appear in the generated report.
To configure the report query selection
1. Go to Log & Report > Call Report > Call Report.
2. Click New.
3. Expand Query List and click New.
4. Configure the following:
GUI field
Description
Name
Enter a name for this query.
Category
Select a category for the report profile. The report chart will
correspond to the category selected.
• Call Usage: The number of calls.
• Phone Bill: The cost of making the phone calls.
• Trunk Usage: The status of the trunks being used.
Subcategory
Select to have a summary or detailed report on the report category
you select.
From
Select to include the source of the incoming calls: Internal, External,
or Any.
To
Select to include the source of the outgoing calls: Internal, External,
or Any.
Region
Select the call region, such as international or long-distance.
Report column
Select the source of the call statistics: from caller or receiver. For
details, see Figure 4 on page 282.
Sort column
Select the value for filtering the call information. The caller or receiver
with the higher value moves to the top of the table.
If you select Report column, the sort column value is equal to what
you select in the Report column field.
For details, see Figure 4 on page 282.
Separate table
Depending on the query values, if a report table is too long, it can be
divided into separate tables. Selecting Default keeps the pre-defined
table settings of the query values and is recommended.
You can select to enable or disable the pre-defined table settings of
the query values, although this is not recommended.
5. Click Create.
Fortinet Technologies Inc.
Page 281
FortiVoice Phone System 5.3.0 Administration Guide
Figure 4: Sample report with Report column as Caller and Sort column as Duration
Sort column
Report column
Call duration of caller
80@61 <80>
Call duration of caller
6819 <6819>
Note: Since the sort column is Duration and the call time of caller 80@61 <80> is longer, this
caller is placed before caller 6819 <6819>.
Configuring the report time period
When configuring a report profile, you can select the time span of log messages from which to
generate the report.
To configure the report time period
1. Go to Log & Report > Call Report > Call Report.
2. Expand Period.
3. Select the time span option you want. This sets the range of log data to include in the report.
• For Type, choose a relative time, such as Today, Yesterday, Last N hours, and so on. If you
select an option with an unspecified “N” value, enter the number of hours, days or weeks
in the Value field, as applicable.
• Set a specific time range. Set the start date and hour in From field and end date and hour
in To field.
Configuring report email notifications
When configuring a report profile, you can have the FortiVoice unit email an attached copy of
the generated report, in either HTML or PDF file format, to designated recipients.
You can customize the report email notification. For more information, see “Customizing call
report and notification email templates” on page 109.
To configure an email notification
1. Go to Log & Report > Call Report > Call Report.
2. Expand Email.
3. Enter the email address of the person who will receive the report notification in the Mail to
field. Click + to enter more email addresses if necessary, or click - to remove an address.
4. In the Format field, select the format of the generated attachment, either Html or Pdf.
Fortinet Technologies Inc.
Page 282
FortiVoice Phone System 5.3.0 Administration Guide
Configuring the report schedule
When configuring a report profile, you can select when the report will generate. Or, you can
leave it unscheduled and generate it on demand. See “Generating a report manually” on
page 283.
To configure the report schedule
1. Go to Log & Report > Call Report > Call Report.
2. Expand Schedule.
3. Configure the following:
GUI field
Description
Type
• None: Select if you do not want the FortiVoice unit to generate
the report automatically according to a schedule. If you select this
option, the report can only be generated on demand. See
“Generating a report manually” on page 283.
• Daily: Select to generate the report each day. Also configure Hour.
• Weekdays: Select to generate the report on specific days of each
week, then select those days in These weekdays. Also configure
Hour.
• These dates: Select to generate the report on specific date of
each month, then enter those date numbers in These days. Also
configure Hour.
Choosing call rate
You can choose the call rate for calculating the phone bills. For information on setting the call
rates, see “Setting call rates” on page 284.
To choose the call rate
1. Go to Log & Report > Call Report > Call Report.
2. Expand Rate Setting.
3. Select an available rate and click -> to move it to the Selected rates field.
Only one call rate is allowed per report.
4. Click Create.
Generating a report manually
You can always generate a report on demand whether the report profile includes a schedule or
not.
To manually generate a report
1. Go to Log & Report > Call Report > Call Report.
2. Click to select the report profile whose settings you want to use when generating the report.
3. Click Generate.
The FortiVoice unit immediately begins to generate a report. To view the resulting report, see
“Viewing generated reports” on page 33.
Fortinet Technologies Inc.
Page 283
FortiVoice Phone System 5.3.0 Administration Guide
Setting call rates
The Log & Report > Call Report > Rate tab lets you set call rates for calculating phone bills.
To set call rates
1. Go to Log & Report > Call Report > Rate and click New.
2. Configure the following:
GUI field
Description
Name
Enter a name for the rating profile.
Trunk
Select the trunk that will use the rates.
Local
Enter the rate for local phone calls.
Long distance
Enter the rate for long-distance phone calls.
International
Enter the rate for international phone calls.
Other rate
Enter the rate for other types of phone calls.
Comment
Enter any notes you have for this rating profile.
3. Click Create.
Submitting CDRs to a database
If you have a remote third party database, you may submit the Call Detail Records (CDR) to the
database. Each CDR contains the full life cycle of a call. Using the database’s interface, you can
display and review the CDRs.
To enable CDR submission, make sure to select Remote CDR name. For more information, see
“Setting up an IVR” on page 211.
This section includes the following topics:
• Configuring CDR submission
• Modifying CDR templates
• Creating CDR filters
Configuring CDR submission
The Log & Report > CDR > Submit CDR submenu lets you configure sending CDR to a
database. The configuration values should match those of the database server.
To submit a CDR
1. Go to Log & Report > CDR > Submit CDR.
Fortinet Technologies Inc.
Page 284
FortiVoice Phone System 5.3.0 Administration Guide
2. Click New and configure the following:
GUI field
Description
Name
Enter a name for the configuration.
Status
Select to enable the configuration.
Description
Click to enter any notes you have for the configuration.
Remote RESTful Configure the database to which CDRs are submitted.
Server
Protocol
Select the protocol used for information transmission between the
FortiVoice unit and the database server.
Http headers
Select Click to edit to enter a HTTP header for sending information to
the database server.
Http timeout
Enter the time allowed for the submission to be processed. The range is
1-60 minutes.
URI
Enter the Uniform Resource Identifier to represent the CDR to be
submitted.
Authentication Select to enter the user name and password for logging onto the
database server.
SSL
verification
Select if required.
Options
Retry
Enter the times to retry submission. The range is 1-10 times.
Retry interval
Enter the retry interval in minutes (5-60).
CDR template
Click Edit to customize the default CDR submission template based on
the requirements of the database server. Click OK when it is done.
For more information, see “Modifying CDR templates” on page 285.
CDR filter
Choose or create a new CDR filter to screen CDRs submitted to the
database. For more information, see “Creating CDR filters” on
page 286.
Custom value
Click New to add a custom value (a token, for example) that is required
by the database server for information exchange.
3. Click Create.
Modifying CDR templates
When configuring CDR submission, you need to customize the default CDR submission
template based on the requirements of the database server.
To modify a CDR template
1. Go to Log & Report > CDR > CDR Template.
2. Select the default CDR template and click Edit.
Fortinet Technologies Inc.
Page 285
FortiVoice Phone System 5.3.0 Administration Guide
3. Modify the template and click OK.
Creating CDR filters
You can use filters to limit the amount of CDRs submitted to the database.
To create a CDR filter
1. Go to Log & Report > CDR > CDR Filter.
2. Click New.
3. Enter a name for the filter.
4. Using XML, enter the CDR filters based on the values you want, such as call queues or call
IDs and so on.
5. For Description, enter any notes you have for the filter.
6. Click OK.
Configuring Station Messaging Detail Record (SMDR)
FortiVoice SMDR component provides FortiVoice call detail records to third party devices on
certain communication and format protocols based on third party's device requirements. For
example, Property Management System (PMS) uses the FortiVoice SMDR to manage hotel
guest call charges.
Configuring FortiVoice SMDR requires advanced SMDR knowledge and should be performed
by advanced administrative users and field engineers.
This section contains the following topics:
• Configuring SMDR settings
• Setting SMDR formats
Configuring SMDR settings
Configure SMDR settings to enable the FortiVoice communications with third party devices.
To configure SMDR settings
1. Go to Log & Report > SMDR Settings > SMDR.
2. Select Enabled to activate the FortiVoice SMDR function.
3. Select a format protocol for the FortiVoice communications with the third party devices.
For information on format, see “Setting SMDR formats” on page 287.
4. For Port, enter the port number that connects to the third party devices.
5. For Max clients, enter the number of third party devices to which the FortiVoice unit provides
SMDR. The range is 1-10.
6. For Trusted hosts, enter the IP address and netmask of the third party device.
If you have multiple third party devices, you may enter up to 10 trusted hosts.
7. Click OK.
Fortinet Technologies Inc.
Page 286
FortiVoice Phone System 5.3.0 Administration Guide
Setting SMDR formats
To communicate with third party devices, the FortiVoice SMDR format needs to be defined
based on the device requirements so that the devices can recognize the FortiVoice SMDR.
The FortiVoice unit provides example XML SMDR format files. You can modify the files to meet
with your needs. The following is an example format file:
Figure 5: Example SMDR format file
An SMDR format is composed of parts as shown in the above example:
• smdr_type id: the name of the SMDR format file.
• discard_filter: the data you do not want to send to the third party devices.
• formatting: the body of the SMDR format file in the form of field values (for example, <field
name="AnswerTime"/>), plus the field lengths (for example, length="13") required by the
third party devices.
To set SMDR format
1. Go to Log & Report > SMDR Settings > Formats.
2. Select an example format file and click Edit.
3. Click FortiVoice SMDR field names to display the complete list of FortiVoice SMDR field
names.
4. Follow the SMDR format requirements of the third party device and the example format file
above, choose the displayed FortiVoice field names you need to set your SMDR format.
5. Click OK.
6. If errors appear, click SMDR XML types to view the Fortinet SMDR format file and correct
your format file accordingly.
Configuring alert email
The Alerts submenu lets you configure the FortiVoice unit to notify selected users (including
administrators) by email when specific types of events occur and are logged. For example, if
you require notification about system activity event detections, you can have the FortiVoice unit
send an alert email message whenever the FortiVoice unit detects a system activity event.
To set up alerts, you must configure both the alert email recipients (see “Configuring alert
recipients” on page 288) and which event categories will trigger an alert email message (see
“Configuring alert categories” on page 288).
Alert email messages also require that you supply the FortiVoice unit with the IP address of at
least one DNS server. The FortiVoice unit uses the domain name of the SMTP server to send
Fortinet Technologies Inc.
Page 287
FortiVoice Phone System 5.3.0 Administration Guide
alert email messages. To resolve this domain name into an IP address, the FortiVoice unit must
be able to query a DNS server. For information on DNS, see “Configuring DNS” on page 49.
You can customize the alert email. For more information, see “Customizing call report and
notification email templates” on page 109.
This section contains the following topics:
• Configuring alert recipients
• Configuring alert categories
Configuring alert recipients
Before the FortiVoice unit can send alert email messages, you must create a recipient list.
To configure recipients of alert email messages
1. Go to Log & Report > Alerts > Configuration.
GUI field
Description
Test
Select one or more email accounts and click Test to verify that
alert email is configured correctly. This sends a sample alert email
to all selected recipients.
(button)
Alert Email Account
Displays the names of email accounts receiving email alerts.
2. Click New to add the email address of a recipient.
A single-field dialog appears.
3. In Email to, enter a recipient email address.
4. Click Create.
5. Repeat the previous steps to add more users.
Configuring alert categories
Before the FortiVoice unit can send alert email messages, you must specify which events cause
the FortiVoice unit to send an alert email message to your list of alert email recipients (see
“Configuring alert recipients” on page 288).
To select events that will trigger an alert email message
1. Go to Log & Report > Alerts > Categories.
2. Select one or more of the following event categories check boxes:
Table 10: Alert email category choices
GUI field
Description
Fortinet Technologies Inc.
Critical events
Send an alert email message when the FortiVoice unit detects a system
error that may affect its operation.
Disk is full
Send an alert email message when the hard disk of the FortiVoice unit
is full.
HA events
Send an alert email message when any high availability (HA) event
occurs.
Archive quota is
exceeded
Send an alert email message when the recorded call archiving account
reaches its quota of hard disk space. For information about recorded
call archiving account quota, see “Archiving recorded calls” on
page 249.
Page 288
FortiVoice Phone System 5.3.0 Administration Guide
Table 10: Alert email category choices
GUI field
Description
Deferred emails # Send an alert email message if the deferred email queue contains
over
greater than this number of email messages. Enter a number between 1
and 10 000 to define the alert threshold, then enter the interval of time
between each alert email message that the FortiVoice unit will send
while the number of email messages in the deferred email queue
remains over this limit.
Daily call summary Send an alert email with a daily call summary including the number of
total calls, long distance calls, and international calls.
You need to enter the time for generating the summary which is for the
24 hours period prior to the time you set. For example, if you set 9 for
Schedule at hour, the summary will be for the period from 9am of the
previous day to 9am of the day when you receive the alert email.
PRI alarm
Send an alert email when the PSTN digital line has a problem. This
option is not available for FortiVoice 200D.
FXO alarm
Send an alert email when the PSTN analog line has a problem. This
option is not available for FortiVoice 200D.
Trunk lines are
saturated
Send an alert email when the SIP/PSTN/PRI trunk lines are fully
occupied.
SIP trunk alert only works if you select Overflow check when
configuring SIP trunk. See “Setting up VoIP trunks” on page 175.
Massive SIP
authentication
failure
Send an alert email when big scale SIP authentication sessions fail.
Trunk alert
Select the trunks of which an alert email is sent when a trunk has an
issue.
Also set the time interval for sending alert email in seconds.
3. Click Apply.
Fortinet Technologies Inc.
Page 289
FortiVoice Phone System 5.3.0 Administration Guide
Installing firmware
Fortinet periodically releases FortiVoice firmware updates to include enhancements and
address issues. After you have registered your FortiVoice unit, FortiVoice firmware is available
for download at http://support.fortinet.com.
New firmware can also introduce new features which you must configure for the first time.
For information specific to the firmware release version, see the Release Notes available
with that release.
In addition to major releases that contain new features, Fortinet releases patch releases that
resolve specific issues without containing new features and/or changes to existing features. It
is recommended to download and install patch releases as soon as they are available.
Before you can download firmware updates for your FortiVoice unit, you must first register
your FortiVoice unit with Fortinet Technical Support. For details, go to
http://support.fortinet.com/ or contact Fortinet Technical Support.
This section includes:
• Testing firmware before installing it
• Installing firmware
• Clean installing firmware
Testing firmware before installing it
You can test a new firmware image by temporarily running it from memory, without saving it to
disk. By keeping your existing firmware on disk, if the evaluation fails, you do not have to
re-install your previous firmware. Instead, you can quickly revert to your existing firmware by
simply rebooting the FortiVoice unit.
To test a new firmware image
1. Connect your management computer to the FortiVoice console port using an RJ-45 to DB-9
serial cable or a null-modem cable.
2. Initiate a connection from your management computer to the CLI of the FortiVoice unit.
3. Connect port1 of the FortiVoice unit directly or to the same subnet as a TFTP server.
4. Copy the new firmware image file to the root directory of the TFTP server.
5. Verify that the TFTP server is currently running, and that the FortiVoice unit can reach the
TFTP server.
To use the FortiVoice CLI to verify connectivity, enter the following command:
execute ping 192.168.2.99
where 192.168.2.99 is the IP address of the TFTP server.
Enter the following command to restart the FortiVoice unit:
execute reboot
Fortinet Technologies Inc.
Page 290
FortiVoice Phone System 5.3.0 Administration Guide
6. As the FortiVoice units starts, a series of system startup messages are displayed.
Press any key to display configuration menu........
Immediately press a key to interrupt the system startup.
You have only 3 seconds to press a key. If you do not press a key soon enough, the FortiVoice
unit reboots and you must log in and repeat the execute reboot command.
If you successfully interrupt the startup process, the following messages appears:
[G]: Get firmware image from TFTP server.
[F]: Format boot device.
[B]: Boot with backup firmware and set as default.
[I]: Configuration and information.
[Q]: Quit menu and continue to boot with default firmware.
[H]: Display this list of options.
Enter G,F,B,I,Q,or H:
7. Type G to get the firmware image from the TFTP server.
The following message appears:
Enter TFTP server address [192.168.2.99]:
8. Type the IP address of the TFTP server and press Enter.
The following message appears:
Enter Local Address [192.168.2.99]:
9. Type a temporary IP address that can be used by the FortiVoice unit to connect to the TFTP
server.
The following message appears:
Enter File Name [image.out]:
10.Type the firmware image file name and press Enter.
The FortiVoice unit downloads the firmware image file from the TFTP server and displays a
message similar to the following:
Save as Default firmware/Backup firmware/Run image without
saving:[D/B/R]
Type R.
The FortiVoice image is loaded into memory and uses the current configuration, without
saving the new firmware image to disk.
11.To verify that the new firmware image has been loaded, log in to the CLI and type:
get system status
12.Test the new firmware image.
• If the new firmware image operates successfully, you can install it to disk, overwriting the
existing firmware, using the procedure “Installing firmware” on page 292.
• If the new firmware image does not operate successfully, reboot the FortiVoice unit to
discard the temporary firmware and resume operation using the existing firmware.
Fortinet Technologies Inc.
Page 291
FortiVoice Phone System 5.3.0 Administration Guide
Installing firmware
You can use either the web-based manager or the CLI to upgrade or downgrade the firmware of
the FortiVoice unit.
Administrators whose access profile contains Read-Write access in the Others category, such
as the admin administrator, can change the FortiVoice firmware.
Firmware changes are either:
• an upgrade to a newer version
• a reversion to an earlier version
To determine if you are upgrading or reverting your firmware image, examine the firmware
version number. For example, if your current firmware version is FortiVoice-200D
2.00,build0082,120827, changing to FortiVoice-200D 2.00,build0081,120801, an
earlier build number and date, indicates that you are reverting.
Reverting to an earlier version may cause the FortiVoice unit to remove parts of the
configuration that are not valid for that earlier version. In some cases, you may lose all call data
and configurations.
When upgrading, there may also be additional considerations. For details, see “Upgrading” on
page 296.
Therefore, no matter if you are upgrading or downgrading, it is always a good practice to back
up the configuration and call data. For details, see “Backing up configuration” on page 103.
To install firmware using the web-based manager
1. Log in to the Fortinet Technical Support web site, https://support.fortinet.com/.
2. Download the firmware image file to your management computer.
3. Log in to the web-based manger as the admin administrator, or an administrator account
that has system configuration read and write privileges.
4. Install firmware in one of two ways:
• Go to Monitor > System Status > Status, and in the System Information area, in the
Firmware version row, click Update. Click Browse to locate the firmware and then click
Upload.
• Go to System > Maintenance > Configuration, under Restore Firmware, click Browse to
locate the firmware. Then click Restore.
Your web browser uploads the firmware file to the FortiVoice unit. The FortiVoice unit installs
the firmware and restarts. Time required varies by the size of the file and the speed of your
network connection.
If you are downgrading the firmware to a previous version, the FortiVoice unit reverts the
configuration to default values for that version of the firmware. You must either reconfigure
the FortiVoice unit or restore the configuration file.
5. Clear the cache of your web browser and restart it to ensure that it reloads the web-based
manager and correctly displays all changes.
6. To verify that the firmware was successfully installed, log in to the web UI and go to
Monitor > System Status > Status. Text appearing in the Firmware version row indicates the
currently installed firmware version.
To install firmware using the CLI
1. Log in to the Fortinet Technical Support web site, https://support.fortinet.com/.
2. Download the firmware image file to your management computer.
Fortinet Technologies Inc.
Page 292
FortiVoice Phone System 5.3.0 Administration Guide
3. Connect your management computer to the FortiVoice console port using an RJ-45 to DB-9
serial cable or a null-modem cable.
4. Initiate a connection from your management computer to the CLI of the FortiVoice unit, and
log in as the admin administrator, or an administrator account that has system configuration
read and write privileges.
5. Connect port1 of the FortiVoice unit directly or to the same subnet as a TFTP server.
6. Copy the new firmware image file to the root directory of the TFTP server.
7. Verify that the TFTP server is currently running, and that the FortiVoice unit can reach the
TFTP server.
To use the FortiVoice CLI to verify connectivity, enter the following command:
execute ping 192.168.2.99
where 192.168.2.99 is the IP address of the TFTP server.
8. Enter the following command to download the firmware image from the TFTP server to the
FortiVoice unit:
execute restore image tftp <name_str> <tftp_ipv4>
where <name_str> is the name of the firmware image file and <tftp_ipv4> is the IP
address of the TFTP server. For example, if the firmware image file name is image.out and
the IP address of the TFTP server is 192.168.2.99, enter:
execute restore image tftp image.out 192.168.2.99
One of the following messages appears:
This operation will replace the current firmware version!
Do you want to continue? (y/n)
or:
Get image from tftp server OK.
Check image OK.
This operation will downgrade the current firmware version!
Do you want to continue? (y/n)
9. Type y.
The FortiVoice unit downloads the firmware image file from the TFTP server. The FortiVoice
unit installs the firmware and restarts. Time required varies by the size of the file and the
speed of your network connection.
If you are downgrading the firmware to a previous version, the FortiVoice unit reverts the
configuration to default values for that version of the firmware. You must either reconfigure
the FortiVoice unit or restore the configuration file.
10.If you also use the web-based manager, clear the cache of your web browser and restart it to
ensure that it reloads the web-based manager and correctly displays all tab, button, and
other changes.
11.To verify that the firmware was successfully installed, log in to the CLI and type:
get system status
12.If you have downgraded the firmware version, reconnect to the FortiVoice unit using its
default IP address for port1, 192.168.1.99, and restore the configuration file. For details, see
“Reconnecting to the FortiVoice unit” on page 294 and “Restoring the configuration” on
page 295.
If you have upgraded the firmware version, to verify the conversion of the configuration file,
see “Verifying the configuration” on page 296. If the upgrade is unsuccessful, you can
downgrade the firmware to a previous version.
Fortinet Technologies Inc.
Page 293
FortiVoice Phone System 5.3.0 Administration Guide
Reconnecting to the FortiVoice unit
After downgrading to a previous firmware version, the FortiVoice unit reverts to default settings
for the installed firmware version, including the IP addresses of network interfaces through
which you connect to the FortiVoice web-based manager and/or CLI.
If your FortiVoice unit has not been reset to its default configuration, but you cannot connect
to the web-based manager or CLI, you can restore the firmware, resetting the FortiVoice unit
to its default configuration in order to reconnect using the default network interface IP
address. For more information, see “Clean installing firmware” on page 297.
To reconnect using the CLI
1. Connect your management computer to the FortiVoice console port using an RJ-45 to DB-9
serial cable or a null-modem cable.
2. Start HyperTerminal, enter a name for the connection and click OK.
3. Configure HyperTerminal to connect directly to the communications (COM) port on your
computer and click OK.
4. Select the following port settings and click OK:
Table 11: Port settings
Bits per second
9600
Data bits
8
Parity
None
Stop bits
1
Flow control
None
5. Press Enter to connect to the FortiVoice CLI.
The login prompt appears.
6. Type admin and press Enter twice.
The following prompt appears:
Welcome!
Fortinet Technologies Inc.
Page 294
FortiVoice Phone System 5.3.0 Administration Guide
7. Enter the following command:
set system interface <interface_str> mode static ip <address_ipv4>
<mask_ipv4>
where:
• <interface_str> is the name of the network interface, such as port1
• <address_ipv4> is the IP address of the network interface, such as 192.168.1.10
• <mask_ipv4> is the netmask of the network interface, such as 255.255.255.0
Enter the following command:
set system interface <interface_str> config allowaccess
<accessmethods_str>
where:
• <interface_str> is the name of the network interface configured in the previous step,
such as port1
• <accessmethods_str> is a space-delimited list of the administrative access protocols
that you want to allow on that network interface, such as ping ssh https
The network interface’s IP address and netmask is saved. You can now reconnect to either
the web UI or CLI through that network interface. For information on restoring the
configuration, see “Restoring the configuration” on page 295.
Restoring the configuration
You can restore a backup copy of the configuration file from your local PC using either the
web-based manager or CLI. For information about configuration backup, see “Backing up
configuration” on page 103.
If you have just downgraded or restored the firmware of the FortiVoice unit, restoring the
configuration file can be used to reconfigure the FortiVoice unit from its default settings.
To restore the configuration file using the web UI
1. Clear your browser’s cache. If your browser is currently displaying the web-based manager,
also refresh the page.
2. Log in to the web-based manager.
3. Go to System > Maintenance > Configuration.
4. Under Restore Configuration, click Browse to locate and select the configuration file that you
want to restore, then click Restore.
The FortiVoice unit restores the configuration file and reboots.Time required varies by the
size of the file and the speed of your network connection.
5. After restoring the configuration file, verify that the settings have been successfully loaded.
For details on verifying the configuration restoration, see “Verifying the configuration” on
page 296.
To restore the configuration file using the CLI
1. Initiate a connection from your management computer to the CLI of the FortiVoice unit, and
log in as the admin administrator, or an administrator account that has system configuration
read and write privileges.
2. Connect a network interface of the FortiVoice unit directly or to the same subnet as a TFTP
server.
3. Copy the new firmware image file to the root directory of the TFTP server.
Fortinet Technologies Inc.
Page 295
FortiVoice Phone System 5.3.0 Administration Guide
4. Verify that the TFTP server is currently running, and that the FortiVoice unit can reach the
TFTP server.
To use the FortiVoice CLI to verify connectivity, enter the following command:
execute ping 192.168.2.99
where 192.168.2.99 is the IP address of the TFTP server.
5. Enter the following command:
execute restore config tftp <file_name> <tftp_ipv4>
The following message appears:
This operation will overwrite the current settings!
(The current admin password will be preserved.)
Do you want to continue? (y/n)
6. Enter y.
The FortiVoice unit restores the configuration file and reboots. Time required varies by the
size of the file and the speed of your network connection.
7. After restoring the configuration file, verify that the settings have been successfully loaded.
For details on verifying the configuration restoration, see “Verifying the configuration” on
page 296.
Verifying the configuration
After installing a new firmware file, you should verify that the configuration has been
successfully converted to the format required by the new firmware and that no configuration
data has been lost.
In addition to verifying successful conversion, verifying the configuration also provides
familiarity with new and changed features.
To verify the configuration upgrade
1. Clear your browser’s cache and refresh the login page of the web-based manager.
2. Log in to the web-based manager using the admin administrator account.
Other administrator accounts may not have sufficient privileges to completely review the
configuration.
3. Review the configuration and compare it with your configuration backup to verify that the
configuration has been correctly converted.
Upgrading
If you are upgrading, it is especially important to note that the upgrade process may require a
specific path. Very old versions of the firmware may not be supported by the configuration
upgrade scripts that are used by the newest firmware. As a result, you may need to upgrade to
an intermediate version of the firmware first, before upgrading to your intended version.
Upgrade paths are described in the Release Notes.
Before upgrading the firmware of the FortiVoice unit, for the most current upgrade
information, review the Release Notes for the new firmware version. Release Notes are
available from http://support.fortinet.com when downloading the firmware image file.
Release Notes may contain late-breaking information that was not available at the time this
guide was prepared.
Fortinet Technologies Inc.
Page 296
FortiVoice Phone System 5.3.0 Administration Guide
Clean installing firmware
Clean installing the firmware can be useful if:
• you are unable to connect to the FortiVoice unit using the web-based manager or the CLI
• you want to install firmware without preserving any existing configuration
• a firmware version that you want to install requires that you format the boot device (see the
Release Notes accompanying the firmware)
Unlike upgrading or downgrading firmware, clean installing firmware re-images the boot device.
Also, a clean install can only be done during a boot interrupt, before network connectivity is
available, and therefore requires a local console connection to the CLI. A clean install cannot
be done through a network connection.
Back up your configuration before beginning this procedure, if possible. A clean install resets
the configuration, including the IP addresses of network interfaces. For information on
backups, see “Backing up configuration” on page 103. For information on reconnecting to a
FortiVoice unit whose network interface configuration has been reset, see “Reconnecting to
the FortiVoice unit” on page 294.
If you are reverting to a previous FortiVoice version, you might not be able to restore your
previous configuration from the backup configuration file.
To clean install the firmware
1. Download the firmware file from the Fortinet Technical Support web site,
https://support.fortinet.com/.
2. Connect your management computer to the FortiVoice console port using an RJ-45 to DB-9
serial cable or a null-modem cable.
3. Initiate a local console connection from your management computer to the CLI of the
FortiVoice unit, and log in as the admin administrator, or an administrator account that has
system configuration read and write privileges.
4. Connect port1 of the FortiVoice unit directly to the same subnet as a TFTP server.
5. Copy the new firmware image file to the root directory of the TFTP server.
6. Verify that the TFTP server is currently running, and that the FortiVoice unit can reach the
TFTP server.
To use the FortiVoice CLI to verify connectivity, if it is responsive, enter the following
command:
execute ping 192.168.2.99
where 192.168.2.99 is the IP address of the TFTP server.
7. Enter the following command to restart the FortiVoice unit:
execute reboot
or power off and then power on the FortiVoice unit.
8. As the FortiVoice units starts, a series of system startup messages are displayed.
Press any key to display configuration menu........
Fortinet Technologies Inc.
Page 297
FortiVoice Phone System 5.3.0 Administration Guide
9. Immediately press a key to interrupt the system startup.
You have only 3 seconds to press a key. If you do not press a key soon enough, the FortiVoice
unit reboots and you must log in and repeat the execute reboot command.
If you successfully interrupt the startup process, the following messages appear:
[G]: Get firmware image from TFTP server.
[F]: Format boot device.
[B]: Boot with backup firmware and set as default.
[I]: Configuration and information.
[Q]: Quit menu and continue to boot with default firmware.
[H]: Display this list of options.
Enter G,F,B,I,Q,or H:
10.If the firmware version requires that you first format the boot device before installing
firmware, type F. (Format boot device) before continuing.
11.Type G to get the firmware image from the TFTP server.
The following message appears:
Enter TFTP server address [192.168.2.99]:
12.Type the IP address of the TFTP server and press Enter.
The following message appears:
Enter Local Address [192.168.1.188]:
13.Type a temporary IP address that can be used by the FortiVoice unit to connect to the TFTP
server.
The following message appears:
Enter File Name [image.out]:
14.Type the firmware image file name and press Enter.
The FortiVoice unit downloads the firmware image file from the TFTP server and displays a
message similar to the following:
Save as Default firmware/Backup firmware/Run image without
saving:[D/B/R]
15.Type D.
The FortiVoice unit downloads the firmware image file from the TFTP server. The FortiVoice
unit installs the firmware and restarts. Time required varies by the size of the file and the
speed of your network connection.
The FortiVoice unit reverts the configuration to default values for that version of the firmware.
16.Clear the cache of your web browser and restart it to ensure that it reloads the web-based
manager and correctly displays all tab, button, and other changes.
17.To verify that the firmware was successfully installed, log in to the CLI and type:
get system status
The firmware version number appears.
18.Either reconfigure the FortiVoice unit or restore the configuration file from a backup. For
details, see “Restoring the configuration” on page 295.
Fortinet Technologies Inc.
Page 298
FortiVoice Phone System 5.3.0 Administration Guide
Appendix A: Installing Click-to-Dial
software
If you use MicroSoft Outlook, you can install the FortiVoice Click-to-Dial plugin to dial the phone
numbers of your contacts.
For information on installing the software, go to FortiVoice Click-to-Dial Software Installation.
Step 4 in the instructions is specific to FortiVoice 40/70/100 models. For FortiVoice
200D/200D-T, do the following:
• System IP Address: Enter the FortiVoice IP address. For details, see “Configuring the
network interfaces” on page 43.
• User Extension #: Enter the user ID of the extension. For details, see “Configuring IP
extensions” on page 136.
• Password: Enter the password used for configuring your SIP phone from the phone or the
Web. For details, see “Configuring IP extensions” on page 136.
Fortinet Technologies Inc.
Page 299
FortiVoice Phone System 5.3.0 Administration Guide
Index
A
CPU 24, 84
CSV import 144
active-passive HA 59
address bar 21
administrative access 44
administrator
"admin" account 16, 17, 292, 293, 295, 296, 297
log messages 277
alert email 60, 287
recipients 288
appearance, web-based manager 91
authentication 16
LDAP 126
D
B
backup unit 57
bandwidth 24
Base64 100, 101
bind DN 128, 129
boot interrupt 297
browser 15, 16, 20
warnings 16
Buffalo TeraStation 94
C
cable
null modem 17
call statistics 25
certificate
backup 102
default 16
mismatch 16
options 98
self-signed 16
server 96
warning 16
certificate authority (CA) 16, 97, 98, 100, 101, 102, 103
certificate request
downloading and submitting 100
certificate revocation list (CRL) 103
certification 9
CIDR 13
clean install firmware 297
CLI 47
connecting to 17
column view
logs 36
command line interface (CLI) 10, 12, 15
comma-separated value (CSV) 278
common name (CN) field 16
communications (COM) port 17
configuration, verifying the 296
configured operating mode 61
connecting
web UI 16
conventions 10
Fortinet Technologies Inc.
dashboard 22
date 77
daylight savings time (DST) 77
default
administrator account
16, 17, 292, 293, 295, 296, 297
bridge configuration 42
certificate 16
gateway 48
password 16, 17, 18, 19
route 48
settings 17
DHCP 46
DNS server 49, 287
documentation 10
conventions 10
Release Notes 297
domain name
certificate 16
DOS 15
dotted decimal 13
downgrade 292
download
report 33
dynamic DNS (DDNS) 99
dynamic IP address 46
E
effective operating mode 63
HA 61
_email 13
end-user guide 20
Ethernet 16, 17
expected input 12
extended unique identifier (EUI) 95
F
factory default settings 17
failover 64, 66, 67, 83
HA 70
FAQ 10
Fedora 94
firmware 292
change 23
clean install 297
downgrade 292
upgrade 292
version 22
formatted view
logs 36
formatting the boot device 297
Page 300
FortiVoice Phone System 5.3.0 Administration Guide
FortiAnalyzer 94, 275, 277
Fortinet
Knowledge Base 10
MIB 87, 88
Technical Documentation 10
conventions 10
Technical Support 9
Technical Support, registering with 9
Technical Support, web site 9
Training Services 9
_fqdn 13
frame size 47
FreeNAS 94
fully qualified domain name (FQDN) 13, 99
fully-qualified domain name (FQDN) 99
G
gateway 48
glossary 10
graphical user interface (GUI) 15
H
HA
active-passive 59
alert email 60
backup unit 57
configuration not synchronized 58
configuration options 58, 63
configured operating mode 61
effective operating mode 61, 63
failover 64, 66, 67, 70, 83
forcing configuration synchronization 62
forcing data synchronization 62
heartbeat 58, 59
interface configuration synchronization 58
log messages 60
mail queue sync after a failover 59
master 57
monitoring 58, 69
MTA spool directory sync after a failover 59
network interface 58
primary unit 57
service monitoring 59, 60
slave 57
synchronization 57, 59
virtual IP 69
wait for recovery then assume slave role 65, 72
wait for recovery then restore original role 65, 72
halt 24
hard disk
logging to 275
heartbeat 59
HA 58
high availability (HA) 56
log messages 277
host name 16
in HA 58
how-to 10
HA 59
Fortinet Technologies Inc.
HTTP
web-based manager 47
HTTPS 16, 47, 96, 99
HyperTerminal 17
I
ICMP ECHO 47
idle timeout 81
import
user in CSV 144
_index 13
index number 13
InetOrgPerson 129
input constraints 12
_int 13
Internet service provider (ISP) 49
IP address 16, 17, 21
private network 10
_ipv4 13
_ipv4/mask 13
_ipv4mask 13
_ipv6 13
_ipv6mask 13
iSCSI
qualified name (IQN) 95
K
Knowledge Base 10
L
language
web-based manager 92
LDAP
bind 128
bind DN 129
cache 130
password 128
profile 126
query 129
schema 129
timeout 130
TTL 130
LDAPS 127, 128
Linux 94
local certificate
options 98
location 21
log
column view 36
formatted view 36
FortiAnalyzer 277
rotate 276
search 38
severity level 274
storage 275
storing 275
Syslog 277
to the hard disk 275
Page 301
FortiVoice Phone System 5.3.0 Administration Guide
M
management IP 42
master 57
master, HA mode 65
maximum transmission unit (MTU) 47
media access control (MAC) 45
memory usage 24
MIB 88
Fortinet 87
RFC 1213 87
RFC 2665 87
Microsoft
Internet Explorer 16
Microsoft Active Directory 129
Microsoft Windows Service for NFS 94
mode
HA 56
monitor
HA 58
monitoring services
for HA 59
Mozilla Firefox 16
N
_name 13
network
interface 17
network address authority (NAA) 95
network attached storage (NAS) 93
server 94
network file system (NFS) 93, 95
network interface
in HA 58
network time protocol (NTP) 77, 78
next-hop router 48, 49
null modem cable 17
O
objectClass 129
on HA failure
wait for recovery then assume slave role 65, 72
wait for recovery then restore original role 65, 72
Openfiler 94
OpenSUSE 94
P
password 16, 17, 18, 19
administrator 54
certificate 102
LDAP bind 128
_pattern 13
pattern 13
PDF report 224, 282
ping 47
PKCS #10 100
PKCS #12 101, 102
port1 17
primary unit 57
Fortinet Technologies Inc.
privacy-enhanced email (PEM) 101
product registration 9
profile
administrator access 55
LDAP 126
protocol 130
administrative access 55
public key 101
Q
query
cache 130
filter 129
LDAP 129
report 223, 280
SNMP 86, 87
R
reachable 48
read & write
administrator 55
reconnecting to the FortiMail unit 294
RedHat 94
registering
with Fortinet Technical Support 9
regular expression 13
Release Notes 297
report
configure 222, 279
download 33
HTML format 224, 282
on demand 222, 279
PDF format 224, 282
periodically generated 222, 279
query 223, 280
subject matter 223, 280
time span 224, 282
view 33
reset
effective operating mode for HA 62
restart 24
restore
factory defaults 41
previous configuration 295
RFC
1213 83, 87
1918 11
2665 83, 87
RJ-45 16, 17
route
default 48
static 48
S
secure (S/MIME) 102
Secure Shell (SSH) 15
secure shell (SSH) 47
security certificate 16
self-signed 16
Page 302
FortiVoice Phone System 5.3.0 Administration Guide
services
monitoring for HA 59
severity level 274
shut down 24
slave 57
slave, HA mode 65
SMB 95
SNMP 47
community 85, 86
event 86, 87
manager 85, 86, 87, 88
MIB 88
MIBs 87
query 86, 87
RFC 12123 87
RFC 2665 87
traps 88
SSL 127, 128
static route 48
static routing 48
storing logs 275
_str 13
string 13
subject matter 223, 280
synchronization 57
syntax 12
Syslog 275, 277
system options
changing 81
data and time 77
system resource usage 22
system time 22
T
T11 network address authority (NAA) 95
technical
documentation 10
notes 10
Telnet 15
telnet 47
terminal 15, 17
time 77
time to live (TTL)
cache 130
LDAP 130
time zone 77
timeout 130
Fortinet Technologies Inc.
Training Services 9
transport layer security (TLS) 102
traps, SNMP 88
troubleshooting 130
Syslog 279
trust certificate 16
trusted host 55
U
Ubuntu 94
UNIX 15
update 292
verify 296
uptime 22
URL 16, 21
_url 13
Use secure connection 127
user
group 126
query 129
user guide 20
V
_v4mask 13
_v6mask 13
value parse error 13
variable
Predefined 110
virtual IP
HA 69
W
wait for recovery then assume slave role
on HA failure 65, 72
wait for recovery then restore original role
on HA failure 65, 72
web browser 15, 16, 20
warnings 16
web UI 16
web-based manager
customizing appearance 91
HTTP 47
HTTPS 47
language 92
widget 22
wild cards 13
Windows share 95
Page 303
FortiVoice Phone System 5.3.0 Administration Guide
Download PDF
Similar pages