PBX Platforms : New System Setup Guide

Logging into PBXact UC

1. Determine the IP address of the PBXact appliance by plugging in a monitor and keyboard.
If your appliance connects using an RJ45 console port, please visit this
page: http://wiki.FreePBX.org/display/PPS/Appliance+USB+to+Serial+Cable .
All PBXact UC appliances come with DHCP enabled on the server so it will grab a IP address
for you. The default root password is set to "sangoma" .

Type “ifconfig” from the command line to determine what the current IP address.
2. ----------------------------------------------------------------------------
3. Welcome to The PBXact Distro
4. ----------------------------------------------------------------------------
5.
6. [root@static ~]# ifconfig
7.
8. eth0 Link encap:Ethernet HWaddr EE:BA:AC:63:F0:84
9. inet addr:192.168.1.1 Bcast:66.185.28.127 Mask:255.255.255.224
10. inet6 addr: fe80::ecba:acffLfe63:f084/64 Scope:Link
11. UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
12. RX packets:122132 errors:0 dropped:0 overruns:0 frame:0
13. TX packets:8202 errors:0 dropped:0 overruns:0 carrier:0
14. collisions:0 txqueuelen:1000
15. RX bytes:18643790 (17.7 MiB) TX bytes:1649490 (1.5 MiB)
16. Interrupt:10 Base address:0xa000
17.
18.
[root@static ~]#
Now that you know your IP address you can log into the PBXact GUI.

In case you do not have DHCP Server running and you want to set the static IP address from
Console refer to How to set Network Settings from the CLI

19. Change the root password to something more secure. You can do this from the Linux CLI by
typing “passwd” and then it will prompt you to type your new password twice

20. [root@static ~]# passwd

21. Changing password for user root.
New password:

22. Now that you know your IP address you can log into the PBXact GUI. To do this type the IP
address of your PBXact system and the port number of 2001 into a web browser on the
same network as your PBXact system (e.g. http://192.168.1.1:2001 replacing 192.168.1.1 with your
IP address). You should be prompted to create a user and password. If you are prompted
with a login screen, log in using "admin" and "sangoma" as the password

23. You can now login as a PBX administrator by clicking on the PBX Administration button as
shown below.
24. Click on the "PBX Administrator" icon to begin the Quick Wizard.
25. You will be prompted to log in with your Username and Password that you created earlier. I

26. Top change network settings please review the Changing Network Settings Wiki here.
Quick Setup Wizard
The Quick Setup Wizard is designed to quickly and easily setup your PBXact within minutes. It
provides basic PBX setup. For more advanced options, you can exit the wizard at any point.

• Upon first login to PBXact you will be greeted with the Quick Wizard.
If you wish to skip to advanced mode click on Advanced Mode from the top menu

STEP 1: Time Zone and Email

• System Time Zone- Pick which time zone you want the PBX to use
• System Email Address- Optionally change what email address the PBX will appear to be
sending messages from for things like fax to email or voicemail to email

• Click the Next button to move to the next step of the Quick Wizard

STEP 2: Extension Creation

• this step will create all the extensions for your system. The extensions will be in consecutive
order based on the initial created.
• Insert the first extension number you want in your PBX in Starting Extension
o In the above example, we selected 4000
• Insert the number of extensions you want in Extension Count
 o In the above example we selected 15
o This will create extensions 4000 to 4015
• Click Next to move to the next step of the Quick Wizard

STEP 3: Extension Customization

This step will display all the extensions created from the previous step. As seen in the screen below,
the extensions have been created in consecutive order.

•
o Name- For each extension, you can optionally set a name that internal users will see
when receiving a call from this extension. This will also show up at the top of the
extension's phone.
o Email Address- For each extension, you need to set the email address associated
with this user.
o Voicemail Password- You can optionally change the voicemail password here.
o Administrator- If set to yes, this user can log into the PBXact Admin Panel.
o Direct Dial DID- If you want a phone number to ring directly to a user's extension,
you can choose from your purchased DID (direct inward dial) numbers here
o Click Next to move to the next step of the Quick Wizard
The Quick Wizard will now exit and bring you to the PBXact UC Dashboard, as seen in the screen
below

• Click the Apply Config button on the top right of the window to apply all the configuration

You will now need to configure the individual modules as seen on the dahsboard. Proceed to the
next section for details
Dashboard Module Configuration
PBXact has a simple compact dashboard designed to provide control to the basic items typically
required to configure and maintain a phone system

Extensions
• To edit or assign user extensions click on the Extensions icon:

o The below screen shows all the extensions created for this example PBXact system
▪ Click the Add Extension Button to add one or more SIP extensions:

▪ Insert all the SIP extension details in the screen as seen below:

▪ For details on what each field means please visit Extensions Module - SIP
Extension
▪ Click the Submit button when SIP extension creation is completed:
IVR

Inbound Routes
• Inbound routing is one of the key pieces to a functional PBX. The Inbound Routes module is
the mechanism used to tell your PBX where to route inbound calls based on the phone
number or DID dialed. This module is used to handle SIP, PRI and analog inbound routing.
Setting up inbound routing properly is a critical step in the deployment of a PBX system.
Inbound routes are often used in conjunction with time conditions and IVRs. A typical setup
will go from an inbound route to a time condition, then to an IVR or after-hours answering
service depending on the time condition met.
• To create inbound routes click on the Inbound Routes Icon:

• Click on the Add Inbound Route button

• Enter the details for the inbound route

o Description: Enter a unique description for the route.

o DID (Direct Inward Dialing) Number: Routing is based on the trunk on which the call
is coming in. In the DID field, you will define the expected “DID Number“ if your trunk
passes the DID on incoming calls. Leave this blank to match calls with any or no DID
info. The DID number entered must match the format of the provider sending the
DID. You can also use a pattern match to match a range of numbers. Patterns must
begin with an underscore (_) to signify they are patterns. Within patterns, X will
match the numbers 0-9 and specific numbers can be matched if they are placed
between square parentheses. This field can also be left blank to match calls from all
DIDs. This will also match calls that have no DID information.
o Caller ID Number: Routing calls based on the caller ID number of the person that is
calling. Define the caller ID number to be matched on incoming calls. Leave this field
 blank to match any or no CID info. In addition to standard dial sequences, you can
also put “Private,” “Blocked,” “Unknown,” “Restricted,” “Anonymous” or “Unavailable”
in order to catch these special cases if the telco transmits them.
o Set Destination: The PBX provides multiple ways to route a call. This is the place
where the desired call target is selected.
• Click the Submit button when done

• For more details on inbound routes please visit Inbound Route User Guide

Music on Hold
• The Music on Hold module is intended to reassure callers that they are still connected to
their calls. The PBX comes with 11 built in songs that are the default hold music. You can
easily add your own music or sound files to the system by uploading them in .wav or .mp3
format, or stream a live feed. Adding custom music on hold is a great way to bring
personality to your phone system. The PBX allows two styles of music on hold – static files
and streaming. Static files are audio files (WAV or MP3 files) that are uploaded to the server
and played back when a caller is placed on hold. Streaming audio is used to connect to a live
audio feed from a particular source. This could be an Internet stream, or a stream from a
sound card or other audio device. MoH categories can be applied to inbound routes as well
as to queues, ring groups, outbound routes and conferences. Categories assigned at the call
level will override the MOH category for that target only. Once a call leaves that target, it will
fall back into the category specified in the inbound route it was matched against
• To create Music on Hold, click on the Music on Hold button:

• Here you can upload a custom recording by simply dragging the specific audio file within
the Upload Recording box.
Upload files from your local system. Supported upload formats are: WAV, aiff, alaw, flac, g722,
gsm, mp3, oga, ogg, sln, sln12, sln16, sln192, sln24, sln32, sln44, sln48, sln96, ulaw, wav, wav16.
This includes archives (that include multiple files) and multiple files
 • Click the Submit button when done

• For more details on inbound routes please visit Music on Hold User Guide

Ring Groups
• The Ring Groups module provides a method to ring several extensions with a variety of ring
strategies. It allows for several useful features such as announcements, CID name prefix, call
confirmation, and others. Ring groups can include local extensions and DIDs (which become
outbound calls from the system).
• To create a ring group click on the Ring Groups button

• Click the Add Ring Group button

 • For details on each field visit Ring Groups Module User Guide
• Click the Submit button when done

Time Conditions
• The Time Conditions module is used to control call flow based upon time and date.
Time Conditions module creates a destination to which you can route calls. When a call arrives at
the Time Condition destination, the system will check the current system time and date against
the Time Group that you selected. The system will then route the call to one of two destinations
that you define.

For example, you might create a Time Condition called "Closed at Lunch." You would then
select a Time Group that defines what time periods are "lunch," and then indicate that calls
that come in during lunchtime should go directly to voicemail, while calls that do not come
in at lunchtime should ring the Front Desk.

Time Conditions can also be used to route calls to different destinations during business
hours vs. after-hours, for example.

• To create time conditions click on the Time Conditions button:

 • Click on the Add Time Condition button

• Insert the time condition details

o Time Condition name: Enter a description to identify this time group. For example,
“Closed Hours” works better than something generic like “Time Condition 1.”
o Time Zone: Specify the time zone by name if the destinations are in a different time
zone than the server. Type two characters to start an auto-complete pick-list.
Important: Your selection here MUST appear in the pick-list or in the
/usr/share/zoneinfo/ directory.
o Time Group: The time group this time condition will be checked against. A time
group defines the times that are considered a "match." You can create new time
groups in the Time Group module .
o Destination matches: This destination will be used as the call target when the
current time matches the time group selected above.
o Destination non-matches: This destination will be used as the call target when the
current time does not match the time group selected above.
• For more details on Time Conditions visit Time Conditions User Guide
• Click the Submit button when done

EndPoint Manager
• With the commercially supportedEnd Point Manager (EPM), you can auto-provision and
configure popular desk phones, wireless phones, door phones, overhead paging devices,
gateways, and specialty devices
• To use Endpoint Manager click on the Endpoint Manager icon:
 • The following screen will appear

• Please visit the following page for full details on EPM: EndPoint Manager
• If you are configuring Sangoma Phones with your PBXact UC system, please visit Auto-
Provision Quick Start Guide

Advanced Mode
Phones : PBXact Administration

Requires being on FreePBX Distro or PBXact 10.13.66 release or newer

If using FreePBX you will need to make sure your PBX is registered with the FreePBX License
server to use Phone Apps or End Point Manager for Sangoma Phones for free.

The following information is assuming that you have already configured extension and User
Manager accounts within your FreePBX / PBXact . If you have an un-configured out-of-box server,
please start here: FreePBX Distro First Steps After Installation

Verify End-Point-Manager IP Address

The End-Point-Manager (EPM) module, inside FreePBX / PBXact, is responsible for auto-
provisioning Sangoma Phones. In order for EPM to be able to communicate with the phone(s) it
must be configured with the same IP address as your FreePBX / PBXact system.

You can verify the IP Address of EPM within the EPM Global Settings:

• Log into your PBX GUI.

• Under the Settings section, pick EndPoint Manager.

• Navigate to the Global Settings section of EPM from the right nav bar.

• Define the Internal IP Address or FQDN that phones will connect to when local to the PBX.

• Define the External IP Address or FQDN that phones will connect to when not local to the
PBX.
 • Also take note what port you have HTTP Provisioning setup on as that port needs to be
accessible for your phone to receive its configrations.

• Press the Save Global button.

Verify we have a proper Template setup

• In the right nav menu, under Brands, click on Sangoma.

• Either click on the New Template button at the top to create a new template, or click on
the default-sangoma template name to edit the included default template.

• Give the template a Name. For the Destination Address, pick either
the Internal or External option. This will pull in the IP address that you entered in the Global
Settings section earlier.
 • Define your Time Zone and if you want Daylight Savings time mode to be enabled.

• For Firmware Version, pick Firmware Slot 1 from the drop-down menu. (When you install
EPM it will install the latest firmware in slot 1.) See Firmware Management for more
information on updating firmware for your phones in the future.

• Define what Provision Server Protocol you want to use to have your phones receive their
config files:
o TFTP should be used when phones are local to the PBX, as it's easy to use and
requires no setup.
o HTTP should be used for local or remote phones and is easy to use and required no
other setup. The default HTTP port used for phone configs is port 83 but may be
different on your PBX. You can view the port that is currently setup for HTTP in the
Global Settings section we just went through above.
o FTP should be used if your phones are remote, as it requires the phone to know the
FTP username and password to receive the config file.
▪ If using FTP, you will need to set up an FTP username and password for the
PBX. Review the System Admin - FTP Setup wiki for information on setting up
a username and password for phones to receive their configuration files via
FTP.

• Press the Save Template button when done.

There are more options that can be set up in a template that we did not cover in this quick
overview. To learn more about each option, click on the links below.

• Default Template (Hot Desking)

• Background Image Options
• Line Labels
• MultiCast Options
• Dial Pattern
• Firmware Management
• Ring Tones
• Screen Saver Options
• Headset Settings
• Call Waiting Signal
• BLF Alert
• Hotline

Configuring Buttons on your Phone

Line Keys Setup
End Point Manager will help you set up the Line keys for your Sangoma Phones, based on the
phone family:

• S-Series

Line Key Types

• Depending on the phone family type, Line keys can be set up in End Point Manager either
for S-Series or P-Series with the following options.

• Line Key Types:

o BLF- ("Busy Lamp Field") - Monitors another extension or feature code that has state
information on your PBX. The state is indicated by the BLF button .
o Call Park- Used for one-touch Call Parking .
o Conference- Configures a conference button to allow 5-way conference calling .
o DTMF- Sends DTMF digits while on a active call, such as having the system dial a
feature code while on a active call.
o Hold- Places the caller on Hold .
o Intercom- Causes the dialed extension to answer using Intercom Calling/Auto
Answer instead of ringing.
o LDAP- Button to Launch LDAP directory
o Line- Sets up a line key. Each phone needs at least one line key.
o MultiCast Paging- Starts a page to a specific MultiCast address.
o Record- Toggles on-demand call recording. Requires the user to have on-demand
recording permissions in the PBX.
o Redial- Redials the last number.
o SpeedDial- Dials the programmed external number.
▪ To insert pauses, use a comma. Each comma adds a 500ms pause when
dialing.
▪ If you want to create a speed dial that dials a number and then waits for the
user to enter more digits on the keypad you would use a + at the end of your
speed dial such as *80+ would dial *80 when you press the speed dial button
and then wait for you to enter more digits.
o Transfer-Transfers a call to a new recipient.
o Voicemail- Dials the voicemail system, allowing the user to check voicemail .
 o XML API- Provides access to the specified Phone App.

Configuring Line Buttons

• S-Series Line Buttons
• P-Series Line Buttons

User Manager Permissions

Verify Groups Permissions are setup with Access to Phone

Apps
• Navigate in your PBX to the User Management module.

• Click on the Groups tab at the top

• Press the Edit button next to the group you want to edit permissions for. By default on
a new system we create a Group called All Users and when you create extension they should
be auto assigned to this group.

• We will first see all the users who are apart of this group and can add any missing users to
this group from here.
• Click on the tab at the top for Phone Apps

• From here we can see we have Allow Access to Phone Apps enabled

• Click on any specific application tab we can now set permissions on that application. In our
example we will select the Conference tab

• We will verify that access to the Conference Room is set to yes for this group.

• We can also then control what conference rooms the user can see.
o in our example below we are saying the user has access to their own conference
room that is linked to them from the conference room module in your PBX and also
we have shared the General Conference Room to all users in this group.

• From here go into each tab under Phone Apps and make sure you have your permissions
setup correct and press the submit button at the bottom of the page when done.
Verify my users are setup to inherit permissions from the
group
• By default when a new user is created most permissions for that user are told to be inherited
by the group they are apart of. We are going to go verify they are all setup correct. If a user
permission is not setup when they try to use a app on the phone or login to the phone they
will get error saying they do not have permissions.
• Navigate in your PBX to the User Management module.

• Click on the Users tab at the top

• Press the Edit button next to the user you want to edit permissions for.

• Click on the Phone Apps tab on the top

• For each permission you want to verify it is set to inherit from the group. If you wanted to
override a permission for a user to be different then the group permissions you can do that
here by not using the inherit option.

• From here go into each tab under Phone Apps and make sure you have your permissions
setup correct and press the submit button at the bottom of the page when done.