Sky Networks Wiki - User contributions [en]

Sky Phone

2017-08-11T16:52:33Z

Admin:

As the world continues its march towards everything being online, the role of mobile devices continues to change. Mobile devices are becoming more and more integral to our everyday interwork with the electronic universe. Sky Networks's Sky Dance's architecture was specifically created to address the technical challenges with building and deploying applications which may span multiple devices and serve multiple roles. Building on that architecture, the Sky Phone was created using this architecture to deliver communications services to mobile users who prefer to use the internet as the backbone due to the flexibility and cost savings offered by service providers using VOIP technology. Because of the platform it is based on, "the Sky is No Limit" for adding new features at your request.

Sky Network's "Skyphone" app leverages the the latest technology to offer, SIP based voice, video and text messaging services on the popular iOS (iphone, ipad, itouch) and Android platforms. Based on 3GPP IMS (IP Multimedia Subsystem standards , SkyPhone is designed as an OEM product that can be customized to fit service providers exact needs. It is perfect for service providers that offer wholesale, international and prepaid VoIP services to enterprise and retail customers. The incorporated SIP stack follows RFC 3261 and 3GPP TS 24.229 Rel-9 specifications, this will allow you to connect to any compliant SIP registrar. It also partially implements GSMA Rich Communication Suite release 3 and The One Voice profile V1.0.0 (LTE/4G, also known as GSMA VoLTE) specifications. The phone is setup to be centrally provisioned using encrypted http and our standard installation includes the provisioning server. It also features a visual voicemail with preintegrated implementations for both Asterisk and Freeswitch based voicemail systems. The phone includes support for the STUN (RFC 3489/RFC 5389), ICE (RFC 5245) and TURN (RFC 5766) specifications allowing it to be used with the Sky Dance STUN/ICE/TURN Media server independently of a session border controller for far end NAT traversal or in conjunction with a SBC depending on scale and needs.

[[File:Ioskeypad.png|thumb|upright=2|left]]

== '''Sky Phone Usage''' ==

Follow the links below to find out more about specific actions

*[[Logging in]]
*[[Favorites]]
*[[Recents]]
*[[Contacts]]
*[[Keypad]]
*[[Messaging]]
*[[Voicemail]]
*[[Settings]]
*[[Provisioning]]

Sky Phone can be integrated as a web application using Web RTC. The Sky Phone splash screens and setup screens can be customized dynamically based on reseller/company logins using javascript. (Call us for details)

Sky Phone

2017-08-11T16:48:10Z

Admin:

As the world continues its march towards everything being online, the role of mobile devices continues to change. Mobile devices are becoming more and more integral to our everyday interwork with the electronic universe. Sky Networks's Sky Dance's architecture was specifically created to address the technical challenges with building and deploying applications which may span multiple devices and serve multiple roles. Building on that architecture, the Sky Phone was created using this architecture to deliver communications services to mobile users who prefer to use the internet as the backbone due to the flexibility and cost savings offered by service providers using VOIP technology. Because of the platform it is based on, "the Sky is No Limit" for adding new features at your request.

Sky Network's "Skyphone" app leverages the the latest technology to offer, SIP based voice, video and text messaging services on the popular iOS (iphone, ipad, itouch) and Android platforms. Based on 3GPP IMS (IP Multimedia Subsystem standards , SkyPhone is designed as an OEM product that can be customized to fit service providers exact needs. It is perfect for service providers that offer wholesale, international and prepaid VoIP services to enterprise and retail customers. The incorporated SIP stack follows RFC 3261 and 3GPP TS 24.229 Rel-9 specifications, this will allow you to connect to any compliant SIP registrar. It also partially implements GSMA Rich Communication Suite release 3 and The One Voice profile V1.0.0 (LTE/4G, also known as GSMA VoLTE) specifications. The phone is setup to be centrally provisioned using encrypted http and our standard installation includes the provisioning server. It also features a visual voicemail with preintegrated implementations for both Asterisk and Freeswitch based voicemail systems. The phone includes support for the STUN (RFC 3489/RFC 5389), ICE (RFC 5245) and TURN (RFC 5766) specifications allowing it to be used with the Sky Dance STUN/ICE/TURN Media server independently of a session border controller for far end NAT traversal or in conjunction with a SBC depending on scale and needs.

[[File:Ioskeypad.png|thumb|upright=2|left]]

== '''Sky Phone Usage''' ==

Follow the links below to find out more about specific actions

*[[Logging in]]
*[[Favorites]]
*[[Recents]]
*[[Contacts]]
*[[Keypad]]
*[[Messaging]]
*[[Voicemail]]
*[[Settings]]
*[[Provisioning]]

Sky Phone will soon also be offered on Windows mobile, OSX, and Windows platforms as well as part of a web application using Web RTC. (Call us for updates on availability)

Sky Phone

2017-08-11T15:38:13Z

Admin:

As the world continues its march towards everything being online, the role of mobile devices continues to change. Mobile devices are becoming more and more integral to our everyday interwork with the electronic universe. Sky Networks's Sky Dance's architecture was specifically created to address the technical challenges with building and deploying applications which may span multiple devices and serve multiple roles. Building on that architecture, the Sky Phone was created using this architecture to deliver communications services to mobile users who prefer to use the internet as the backbone due to the flexibility and cost savings offered by service providers using VOIP technology. Because of the platform it is based on, "the Sky is No Limit" for adding new features at your request.

Sky Network's "Skyphone" app leverages the the latest technology to offer, SIP based voice, video and text messaging services on the popular iOS (iphone, ipad, itouch) and Android platforms. Based on 3GPP IMS (IP Multimedia Subsystem standards , SkyPhone is designed as an OEM product that can be customized to fit service providers exact needs. It is perfect for service providers that offer wholesale, international and prepaid VoIP services to enterprise and retail customers. The incorporated SIP stack follows RFC 3261 and 3GPP TS 24.229 Rel-9 specifications, this will allow you to connect to any compliant SIP registrar. It also partially implements GSMA Rich Communication Suite release 3 and The One Voice profile V1.0.0 (LTE/4G, also known as GSMA VoLTE) specifications. The phone is setup to be centrally provisioned using encrypted http and our standard installation includes the provisioning server. It also features a visual voicemail with preintegrated implementations for both Asterisk and Freeswitch based voicemail systems. The phone includes support for the STUN (RFC 3489/RFC 5389), ICE (RFC 5245) and TURN (RFC 5766) specifications allowing it to be used with the Sky Dance STUN/ICE/TURN Media server independently of a session border controller for far end NAT traversal or in conjunction with a SBC depending on scale and needs.

[[File:Ioskeypad2.png|thumb|upright=2|left]]

== '''Sky Phone Usage''' ==

Follow the links below to find out more about specific actions

*[[Logging in]]
*[[Favorites]]
*[[Recents]]
*[[Contacts]]
*[[Keypad]]
*[[Messaging]]
*[[Voicemail]]
*[[Settings]]
*[[Provisioning]]

Sky Phone will soon also be offered on Windows mobile, OSX, and Windows platforms as well as part of a web application using Web RTC. (Call us for updates on availability)

File:Ioskeypad2.png

2017-08-11T15:37:38Z

Admin:

Sky Phone

2017-08-11T15:37:04Z

Admin:

As the world continues its march towards everything being online, the role of mobile devices continues to change. Mobile devices are becoming more and more integral to our everyday interwork with the electronic universe. Sky Networks's Sky Dance's architecture was specifically created to address the technical challenges with building and deploying applications which may span multiple devices and serve multiple roles. Building on that architecture, the Sky Phone was created using this architecture to deliver communications services to mobile users who prefer to use the internet as the backbone due to the flexibility and cost savings offered by service providers using VOIP technology. Because of the platform it is based on, "the Sky is No Limit" for adding new features at your request.

Sky Network's "Skyphone" app leverages the the latest technology to offer, SIP based voice, video and text messaging services on the popular iOS (iphone, ipad, itouch) and Android platforms. Based on 3GPP IMS (IP Multimedia Subsystem standards , SkyPhone is designed as an OEM product that can be customized to fit service providers exact needs. It is perfect for service providers that offer wholesale, international and prepaid VoIP services to enterprise and retail customers. The incorporated SIP stack follows RFC 3261 and 3GPP TS 24.229 Rel-9 specifications, this will allow you to connect to any compliant SIP registrar. It also partially implements GSMA Rich Communication Suite release 3 and The One Voice profile V1.0.0 (LTE/4G, also known as GSMA VoLTE) specifications. The phone is setup to be centrally provisioned using encrypted http and our standard installation includes the provisioning server. It also features a visual voicemail with preintegrated implementations for both Asterisk and Freeswitch based voicemail systems. The phone includes support for the STUN (RFC 3489/RFC 5389), ICE (RFC 5245) and TURN (RFC 5766) specifications allowing it to be used with the Sky Dance STUN/ICE/TURN Media server independently of a session border controller for far end NAT traversal or in conjunction with a SBC depending on scale and needs.

[[File:Ioskeypad2.png|thumb|upright=2|left]]
[[File:Ioskeypad.png|thumb|upright=2|left]]

== '''Sky Phone Usage''' ==

Follow the links below to find out more about specific actions

*[[Logging in]]
*[[Favorites]]
*[[Recents]]
*[[Contacts]]
*[[Keypad]]
*[[Messaging]]
*[[Voicemail]]
*[[Settings]]
*[[Provisioning]]

Sky Phone will soon also be offered on Windows mobile, OSX, and Windows platforms as well as part of a web application using Web RTC. (Call us for updates on availability)

Resource Groups

2017-06-14T00:55:28Z

Admin:

Click Here to return to the main Screen: '''[[Routing |Back]]'''

The Resource Group defines the status, direction, translations and other technical parameters needed to identify a carrier in the network. A carrier can have one or more incoming and/or outgoing resource groups. If a carrier is used as for both inbound and outbound traffic, a resource group will need to be defined for each direction. To edit a row, click on the yellow pencil to the left of the row. For other operations, click the appropriate button after selecting the row with a checkbox.

<center>[[File: resource_groups.png]]</center>

<center>''Figure 23. Resource Groups Window.''</center>

Figure 24 displays the details of a specific RG.

<center>[[File: resource_groups_detail.png]]</center>

<center>''Figure 24. Resource Groups Detailed Window.''</center>

Following is a description of this window:

* General
** Id: This is the number that identifies the carrier's RG.
** Description: This field describes the Resource Group. It can tell, for example, the carrier that is associated with the RG, the purpose of the RG and the circuit direction.
** Admin Status: This field tells if the RG is active or not.
** CIR Direction: This field tells the circuit direction, IN, OUT, IN + OUT.
** SIP Proxy - For inbound calls this is the proxy instance being used for handling this call
** Proxy Address - This is the listening address that will be used by the SIP Proxy instance for inbound calls.
** Call Count - this is the maximum calls that will be allowed in or out (depending on circuit direction). A '0' call count means unlimited amount of simultaneous calls.

* IP
** IP Address, Netmask, Port.
*** For inbound RGs this is the IP address, netmask, and port of the inbound traffic. A '0' in the Port means that you process calls from any port.
*** For outbound RGs this should be the Sky Dance proxy's IP address as setup in the SIP Proxy table.

* Partitions
** Partition: This field defines the Called Translation partition.
** Pre Translation: This field defines the Called Pre Translation table if required.
** ANI Pre Translation: This field defines the Calling Pre Translation table if required.
** Post Translation: This field is mandatory for all outbound resource groups.
** ANI Post Translation: This field defines the Calling Post Translation table if required.

The fields Pre Translation and ANI Pre Translation are used when the RG is used as RG In (client). The fields Post Translation and ANI Post Translation are used when the RG is used as RG Out (provider).

* IP
** IP Address: When Sky DANCE serves as Registration server, this field can be left blank or as 0.0.0.0. Sky DANCE will populate this field when the remote SIP gateway is authenticated. Otherwise, this field should define the IP address of the remote SIP server.
** Netmask: This field defines Netmask which should be used to match the remote SIP gateway IP.
** Port: This field defines the SIP gateway port which should be used for SIP communication between SIP gateway and Sky DANCE.

* Registration Gateway
** Registration Gateway Type: Use this pull down list to select if Sky DANCE should be enabled as Registration Server. If so, Registration User ID and Registration User Password field should be populated, and IP Address and Port field for this Resource Group can be left blank. Once the remote gateway registers with Sky DANCE, Sky Proxy will have the remote gateway IP Address and Port fields updated. Before the first SIP REGISTER message comes into Sky DANCE, IP Address field will be shown as 0.0.0.0.
** Registration User ID: Sky DANCE will use User ID in the SIP REGISTER message to locate the Resource Group which the remote SIP gateway belongs to.
** Registration Password: Used to authenticate the remote SIP gateway.

* Modifiers
** Flag Pound: Select one of three options, LEAVE_POUND (the DNI is not modified), ADD_POUND and REM_POUND (remove pound).
** Pass - pass RTP through the SBC
** Spoof - used for far end NAT traversal
** Ringback - provide artificial ringback from the switch
** Clear Max Forward
** Forced Codec - only use the first codec in the preferred codec list
** Preferred Codec - select the codec preferred. Put this at the top of the list.
** Custom Flags - application specific

To add a new Resource Group:

# Click âAddâ to create a new Resource Group. The following window will appear:

<center>[[Image:Add_Resource_Group.png]]</center>

<center>'Resource Group Addition Window.''</center>

# Select an available ID. The available IDs will appear as you type one.
# Type the description of the Resource Group if required.
# Select the Administration Status, Circuit Direction and Device Driver.
# Depending on the RG type (client (inbound) or provider (outbound)), enter the Calling Pre Translation and Called Pre Translation, Calling Post Translation table numbers if required.
# Enter the Called Translation table number.
# Enter the Called Post Translation number for RG Out.
# Configure the IP address depending on the type of RG.
#* For inbound RGs this is the IP address, netmask, and port of the inbound traffic. A â0â in the Port means that you process calls from any port.
#* For outbound RGs this should be the Sky Dance proxyâs IP address as setup in the SIP Proxy table.
# Define the Call Count, the Flag Pound, and the other modifiers.
# Click âSaveâ to confirm the addition or âCancelâ to discard them.

To delete an existing Resource Group select the check box and click âDeleteâ. A confirmation window will appear. Click âYesâ to confirm the deletion or âNoâ to cancel it.

To edit an existing Resource Group select the check box next to the Resource Group you want to edit. The Resource Group window will open for that carrier. Edit and save the changes.

File:Add Resource Group.png

2017-06-13T23:49:56Z

Admin: uploaded a new version of "File:Add Resource Group.png"

File:Resource groups detail.png

2017-06-13T23:06:35Z

Admin: uploaded a new version of "File:Resource groups detail.png"

PBX

2016-05-05T18:08:48Z

Admin:

Click Here to return to the main Screen: '''[[Sky Dance Web User Interface |Back]]'''

Sky PBX is a Sky DANCE application which is designed to allow you to setup multi-tenant PBX services, IVRs and Call centers for use within Sky DANCE. The following documentation will provide you with information on how to set this up. If you have questions, feel free to call Sky Dance technical support.

==Quick Overview of the Setup==

* Create a domain to match the domain used for registering phones
* Create an extension under Accounts -> Extensions
* Register the phone to the extension. The extension number is the username for the end point.
* Test the phone by dialing the music on hold number *9664
* Setup an inbound route from Sky DANCE to the PBX.
* Validate the settings on the outbound route from Sky DANCE.
* Test

==Menu: Advanced->[[Domains]] (for Multi Tenant setup)==
Every Sky PBX instance will have its own domain. This will be the IP address or the name which is used when an extension will register to the PBX.
Note: The first PBX should already be mostly configured after installation by Sky Networks technicians. This can be used as an example when setting up new ones.

==Menu: Accounts->[[Extensions]]==
The first time the Extensions page is viewed, there will be no extensions listed. Click on the + next to the list in order to add an extension.

"Effective Caller ID" information is shown within your organization, "Outbound Caller ID" information will be seen by those receiving outside calls.

Fill in Extension in order to get a basic phone up and running. It is suggested that a system administrator complete the following:
Extension (according to the numbering scheme used in the implementation)
User list (assign a user to each extension – this allows the end-user to log into the SkyPBX web GUI and check voicemails, faxes and so on via the web. This does not have to be done immediately.)
Voicemail options (e.g. have voicemail sent to a designated email address.)
(editors: Toll allow is a new option – where is this used? I don’t have this set on my system yet my calls all still work)

*The range entry allows more than one extension to be created at a time. This would probably be most useful when doing automated telephone provisioning (note to editors – you’ll need to flesh this out as we now have a provisioning section on this page and I have no idea how to use it).

Save each configured extension (the save button is at the bottom of the GUI). When the save is complete, the screen is returned to the list of extensions.
Click on the extension just created.
Click on the password field to reveal the current password directly below the field. Note the password is displayed because it will be needed to configure a telephone to negotiate with SkyPBX. At this point, it might be prudent to test a telephone negotiating with successfully SkyPBX so that further testing can be performed, ensuring that the following are also properly configured:
IP address of SkyPBX (the phone might know this as the SIP server)
Extension (the extension number is the username for the phone)
Password for the extension

Read the manual for your IP phone or soft phone for more information.
Once the phone is connected you can test it by dialing *9664 which is a code for music on hold.
To use a phone to call somewhere other than music on hold or another extension, configuration of the Sky_Dance entry in the Dialplan Manager is required. (See more information about call provisioning and routing under DialPlan)

==Setup an Inbound Route from Sky DANCE==
There are 2 steps to create an inbound route from Sky DANCE for Sky PBX. (This assumes you already have an inbound route setup in Sky DANCE that can accept traffic)
1. For inbound DIDs, create a "Called Pre Translation" entry in Sky DANCE which routes a call to the PBX using a <9999> prefix

Example: 30550022* 9999665001 - would route to PBX1 with the default setup.

If you have more than 1 PBX planned, you will need to plan on adding 2 prefixes in the Called Pre Translation table with the following format: <Sky PBX application prefix - 9999><4 digit PBX ID><Number within the Dialplan Manager for that PBX>

2. Edit the Send_to_SkyPBX entry in the Dialplan Manager to change the condition to be more specific - ie. if the prefix from Sky DANCE was 99990001 - you could just match on the 0001. To add other PBX entries you can just duplicate the Send_toSkyPBX entry to make a Send_toSkyPBX2,3 4 etc.and edit the domain name to match the new domain for the new PBX and also to change the transfer action to route to the new context.

==Setup an Outbound Route to Sky DANCE==

1. Edit the Send_to_SkyDance entry to modify the sip_h_X-Rg-In=3000,1000;1;1000 entries to match your setup. They should match the inbound resource group and partition used for routing the call to this PBX.

==Voicemail to email==
For voicemail to email configure SMTP server settings in Advanced ->Default Settings. Configure the destination email account in the settings for each extension. SkyPBX does not use an MTA (Message Transfer Agent eg. sendmail or postfix). Instead SkyPBX uses a PHP script that acts as an SMTP client and connects to the SMTP server using the account and password specified by the system and/or extension administrator. As a result, there are no queues or logs where message sent or failed can be viewed. However, if the php script was executed (whether the voicemail was successfully sent or not) there will be a file in /tmp called voicemailtoemail.txt. If voicemailtoemail.txt was created and the voicemail was not received as an email, there could have been two possible results from the action. One possible result was that the script may have executed but it did not successfully negotiate with the SMTP server. Alternately, the script successfully sent the voicemail; however, the destination email account was incorrectly assigned in the settings. If the file is not present in /tmp then it is likely that the voicemail file and directory permissions to /var/www/Skypbx/secure are incorrect. The voicemail script is v_mailto.php. If it is inaccessible to Sky DANCE then the function will not run and the file in /tmp will not be created.

==Getting started (a topical approach to the wiki)==
This wiki is ordered around topics & menu screens. If you are here for the first time the best place to start is the topical section below. If you already have fusionpbx and want to know more about a particular function you can look up the menu screen section for more information.

* [[Multi-Tenant]] - Domain based multi-tenant. 
* [[Extensions]] - ie. your phones 
* [[IVR Menu]] - ie. if you want to setup an auto attendant or have automated prompts for a caller this is where you set this up 
* [[Conferences]] - allows you to define reservationless conference rooms 
* [[Call Groups]] - settings that allow you to group phones together 
* [[Music On Hold]] - ie. if you place someone on hold what will they hear? 
* [[Ring Groups]] - call one or more extensions

==Documentation for SkyPBX GUI screens==
Please note that the documentation in this section is in progress. Many of the menu items shown here are available only to the "super admin" or are reserved for advanced use. Further information can be found by clicking on the associated menu item.

The GUI is accessible using a web browser by going to the PBX entry in the Sky DANCE GUI.

'''[[System]]''' - the default page that is displayed when you log in to SkyPBX is the System page. You can access it later by clicking on System directly without selecting a sub-menu
* [[Account Settings]] - the account settings for the currently logged on user
* [[SkyPBX Logout |Logout]] - use this to log out of the SkyPBX administration web site
* [[Menu Manager]] - This is used to control which menu items are available to the various user levels.
* [[Modules]] - for enabling and disabling Sky DANCE modules
* [[SkyPBX Settings|Settings]] - (advanced) SkyPBX settings
* [[Variables]] - (advanced) Manage Sky DANCE internal variables
'''Accounts''' - clicking directly on Accounts without selecting a sub-menu will take you to the [[Extensions]] page
* [[Devices]] - for seeing and modifying all provisioned phones. See [[Extensions]] for more information
* [[Extensions]] - where you configure the extensions for the phones attached to your system
* [[Gateways]] - (advanced - should only be used by super admin) These are the gateways that can be used to terminate traffic.
* [[User Manager]] - Allows a superadmin/admin to manage USERs and GROUPs. Can create/delete users, edit their [[Account Settings]].
* [[XMPP Manager]] - Configure XMPP to work with Google talk or other jabber servers. (Advanced)

'''Dialplan''' - clicking directly on dialplan without selecting a sub-menu will take you to the [[Dialplan Manager]] page
* [[Dialplan Manager]] - used to update the dialplan controlling what happens when a number is dialed (note that this also includes the dialplan entries used for [[Outbound Routes]])
* [[Inbound Routes]] - (advanced) used to define what to do with calls coming from outside of your SkyPBX/Sky DANCE server
* [[Outbound Routes]] - (advanced) used to define dialplan entries that affect calls that leave your SkyPBX/Sky DANCE server to go to the outside world

'''Apps''' - clicking directly on apps without selecting a sub-menu will take you to the [[Call Detail Records]] page

* [[Call block]] - Block inbound callers, optional module must be installed from Dev/Apps
* [[Call Broadcast]] - (option)
* [[Call Center]] – Setup a SkyPBX call center
* [[Call Detail Records]] - Call history reports and detailed information on the calls.
* [[Conferences]] - to define permanently reserved conference numbers for individuals/groups to use
* [[Contact Manager]] - Manage your contact list and create [http://en.wikipedia.org/wiki/VCard vcards] if needed
* [[Fax Server]] - (option) to setup inbound and outbound faxing from SkyPBX (without needing a physical fax machine)
* [[Follow Me]] - Configure call forwarding, follow me, or do not disturb.
* [[Hot Desking]] (option)
* [[IVR Menu]] - To define Auto attendants, Interactive Voice Response menus (ie. press 1 for billing, press 2 for technical support, etc.)
* [[Music On Hold]] - to set up music for callers who are placed on hold or who are in a queue.
* [[Recordings]] - for making, modifying and reviewing recorded messages used within your phone system
* [[Ring Groups]] - allow you to ring one or more registered endpoints.
* [[Time Conditions]] - to define time conditions to affect how calls are handled at different times and on different days
* [[Queues]] - to define call queues to enable people to wait on hold until it is their turn to be answered
* [[PBX Voicemail|Voicemail]] - shows all voicemails that belongs to the current logged in user

'''Status''' - clicking directly on status without selecting a sub-menu will take you to the [[Active Extensions]] page
* [[Active Call Center]] - display queue status, agent status, tier status for call centers
* [[Active Calls]] - lists and allows you to interact with '''active calls''' being handled by your server
* [[Active Conferences]] - lists conferences that are active on your server (showing the number of participants)
* [[Active Extensions]] - lists and allows you to interact with calls being handled by phone extensions on your server
* [[Active Queues]] - displays queues that have one or more callers waiting
* [[Registrations]] - By default in this page you can see all the registered endpoints in profile '''internal'''.
* [[Agent Status]] - Show/Edit the status of the agents at a call center.
* [[Services]] - allows interaction with the processes running on your server
* [[SIP Status]] - shows the status of your internal and external sip connections, various server statistics and a static view of the Sky DANCE log file
* [[System Status]] - shows the status of the physical server you are running SkyPBX on
* [[Log Viewer]] - displays Sky DANCE log file.
* [[Traffic Graph]] - Shows the live traffic on the network interface

'''Advanced''' - clicking directly on Advanced without selecting a sub-menu will take you to the [[Command]] page

* NOTE: This menu should only be available to the super administrator

* [[Adminer]] - A database manager utility
* [[App Manager]] - advanced
* [[Command]] - allows you to interactively submit shell, PHP and Sky DANCE commands to your server
* [[Domains]] - used to setup new domains or edit existing ones.
* [[Group Manager]] - Used to manage SkyPBX groups
* [[PHP Editor]] - allows you to edit php files used in SkyPBX
* [[Provision Editor]] - allows you to edit phone/device provisioning files used in SkyPBX
* [[PHP Service]] - Manages multiple dynamic and customizable PHP services.
* [[Script Editor]] - allows you to edit javascript, lua and perl script used on your server
* [[SIP Profiles]] - allows you to customize the SIP profiles
* [[XML Editor]] - allows you to edit Sky DANCE XML files in the '''conf'''/ directory

Note: SkyPBX is based on the FusionPBX project.

PBX

2016-05-05T18:06:38Z

Admin:

Click Here to return to the main Screen: '''[[Sky Dance Web User Interface |Back]]'''

Sky PBX is a Sky DANCE application based off of the FusionPBX project which is designed to allow you to setup multi-tenant PBX services, IVRs and Call centers for use within Sky DANCE. The following documentation will provide you with information on how to set this up. If you have questions, feel free to call Sky Dance technical support.

==Quick Overview of the Setup==

* Create a domain to match the domain used for registering phones
* Create an extension under Accounts -> Extensions
* Register the phone to the extension. The extension number is the username for the end point.
* Test the phone by dialing the music on hold number *9664
* Setup an inbound route from Sky DANCE to the PBX.
* Validate the settings on the outbound route from Sky DANCE.
* Test

==Menu: Advanced->[[Domains]] (for Multi Tenant setup)==
Every Sky PBX instance will have its own domain. This will be the IP address or the name which is used when an extension will register to the PBX.
Note: The first PBX should already be mostly configured after installation by Sky Networks technicians. This can be used as an example when setting up new ones.

==Menu: Accounts->[[Extensions]]==
The first time the Extensions page is viewed, there will be no extensions listed. Click on the + next to the list in order to add an extension.

"Effective Caller ID" information is shown within your organization, "Outbound Caller ID" information will be seen by those receiving outside calls.

Fill in Extension in order to get a basic phone up and running. It is suggested that a system administrator complete the following:
Extension (according to the numbering scheme used in the implementation)
User list (assign a user to each extension – this allows the end-user to log into the SkyPBX web GUI and check voicemails, faxes and so on via the web. This does not have to be done immediately.)
Voicemail options (e.g. have voicemail sent to a designated email address.)
(editors: Toll allow is a new option – where is this used? I don’t have this set on my system yet my calls all still work)

*The range entry allows more than one extension to be created at a time. This would probably be most useful when doing automated telephone provisioning (note to editors – you’ll need to flesh this out as we now have a provisioning section on this page and I have no idea how to use it).

Save each configured extension (the save button is at the bottom of the GUI). When the save is complete, the screen is returned to the list of extensions.
Click on the extension just created.
Click on the password field to reveal the current password directly below the field. Note the password is displayed because it will be needed to configure a telephone to negotiate with SkyPBX. At this point, it might be prudent to test a telephone negotiating with successfully SkyPBX so that further testing can be performed, ensuring that the following are also properly configured:
IP address of SkyPBX (the phone might know this as the SIP server)
Extension (the extension number is the username for the phone)
Password for the extension

Read the manual for your IP phone or soft phone for more information.
Once the phone is connected you can test it by dialing *9664 which is a code for music on hold.
To use a phone to call somewhere other than music on hold or another extension, configuration of the Sky_Dance entry in the Dialplan Manager is required. (See more information about call provisioning and routing under DialPlan)

==Setup an Inbound Route from Sky DANCE==
There are 2 steps to create an inbound route from Sky DANCE for Sky PBX. (This assumes you already have an inbound route setup in Sky DANCE that can accept traffic)
1. For inbound DIDs, create a "Called Pre Translation" entry in Sky DANCE which routes a call to the PBX using a <9999> prefix

Example: 30550022* 9999665001 - would route to PBX1 with the default setup.

If you have more than 1 PBX planned, you will need to plan on adding 2 prefixes in the Called Pre Translation table with the following format: <Sky PBX application prefix - 9999><4 digit PBX ID><Number within the Dialplan Manager for that PBX>

2. Edit the Send_to_SkyPBX entry in the Dialplan Manager to change the condition to be more specific - ie. if the prefix from Sky DANCE was 99990001 - you could just match on the 0001. To add other PBX entries you can just duplicate the Send_toSkyPBX entry to make a Send_toSkyPBX2,3 4 etc.and edit the domain name to match the new domain for the new PBX and also to change the transfer action to route to the new context.

==Setup an Outbound Route to Sky DANCE==

1. Edit the Send_to_SkyDance entry to modify the sip_h_X-Rg-In=3000,1000;1;1000 entries to match your setup. They should match the inbound resource group and partition used for routing the call to this PBX.

==Voicemail to email==
For voicemail to email configure SMTP server settings in Advanced ->Default Settings. Configure the destination email account in the settings for each extension. SkyPBX does not use an MTA (Message Transfer Agent eg. sendmail or postfix). Instead SkyPBX uses a PHP script that acts as an SMTP client and connects to the SMTP server using the account and password specified by the system and/or extension administrator. As a result, there are no queues or logs where message sent or failed can be viewed. However, if the php script was executed (whether the voicemail was successfully sent or not) there will be a file in /tmp called voicemailtoemail.txt. If voicemailtoemail.txt was created and the voicemail was not received as an email, there could have been two possible results from the action. One possible result was that the script may have executed but it did not successfully negotiate with the SMTP server. Alternately, the script successfully sent the voicemail; however, the destination email account was incorrectly assigned in the settings. If the file is not present in /tmp then it is likely that the voicemail file and directory permissions to /var/www/Skypbx/secure are incorrect. The voicemail script is v_mailto.php. If it is inaccessible to Sky DANCE then the function will not run and the file in /tmp will not be created.

==Getting started (a topical approach to the wiki)==
This wiki is ordered around topics & menu screens. If you are here for the first time the best place to start is the topical section below. If you already have fusionpbx and want to know more about a particular function you can look up the menu screen section for more information.

* [[Multi-Tenant]] - Domain based multi-tenant. 
* [[Extensions]] - ie. your phones 
* [[IVR Menu]] - ie. if you want to setup an auto attendant or have automated prompts for a caller this is where you set this up 
* [[Conferences]] - allows you to define reservationless conference rooms 
* [[Call Groups]] - settings that allow you to group phones together 
* [[Music On Hold]] - ie. if you place someone on hold what will they hear? 
* [[Ring Groups]] - call one or more extensions

==Documentation for SkyPBX GUI screens==
Please note that the documentation in this section is in progress. Many of the menu items shown here are available only to the "super admin" or are reserved for advanced use. Further information can be found by clicking on the associated menu item.

The GUI is accessible using a web browser by going to the PBX entry in the Sky DANCE GUI.

'''[[System]]''' - the default page that is displayed when you log in to SkyPBX is the System page. You can access it later by clicking on System directly without selecting a sub-menu
* [[Account Settings]] - the account settings for the currently logged on user
* [[SkyPBX Logout |Logout]] - use this to log out of the SkyPBX administration web site
* [[Menu Manager]] - This is used to control which menu items are available to the various user levels.
* [[Modules]] - for enabling and disabling Sky DANCE modules
* [[SkyPBX Settings|Settings]] - (advanced) SkyPBX settings
* [[Variables]] - (advanced) Manage Sky DANCE internal variables
'''Accounts''' - clicking directly on Accounts without selecting a sub-menu will take you to the [[Extensions]] page
* [[Devices]] - for seeing and modifying all provisioned phones. See [[Extensions]] for more information
* [[Extensions]] - where you configure the extensions for the phones attached to your system
* [[Gateways]] - (advanced - should only be used by super admin) These are the gateways that can be used to terminate traffic.
* [[User Manager]] - Allows a superadmin/admin to manage USERs and GROUPs. Can create/delete users, edit their [[Account Settings]].
* [[XMPP Manager]] - Configure XMPP to work with Google talk or other jabber servers. (Advanced)

'''Dialplan''' - clicking directly on dialplan without selecting a sub-menu will take you to the [[Dialplan Manager]] page
* [[Dialplan Manager]] - used to update the dialplan controlling what happens when a number is dialed (note that this also includes the dialplan entries used for [[Outbound Routes]])
* [[Inbound Routes]] - (advanced) used to define what to do with calls coming from outside of your SkyPBX/Sky DANCE server
* [[Outbound Routes]] - (advanced) used to define dialplan entries that affect calls that leave your SkyPBX/Sky DANCE server to go to the outside world

'''Apps''' - clicking directly on apps without selecting a sub-menu will take you to the [[Call Detail Records]] page

* [[Call block]] - Block inbound callers, optional module must be installed from Dev/Apps
* [[Call Broadcast]] - (option)
* [[Call Center]] – Setup a SkyPBX call center
* [[Call Detail Records]] - Call history reports and detailed information on the calls.
* [[Conferences]] - to define permanently reserved conference numbers for individuals/groups to use
* [[Contact Manager]] - Manage your contact list and create [http://en.wikipedia.org/wiki/VCard vcards] if needed
* [[Fax Server]] - (option) to setup inbound and outbound faxing from SkyPBX (without needing a physical fax machine)
* [[Follow Me]] - Configure call forwarding, follow me, or do not disturb.
* [[Hot Desking]] (option)
* [[IVR Menu]] - To define Auto attendants, Interactive Voice Response menus (ie. press 1 for billing, press 2 for technical support, etc.)
* [[Music On Hold]] - to set up music for callers who are placed on hold or who are in a queue.
* [[Recordings]] - for making, modifying and reviewing recorded messages used within your phone system
* [[Ring Groups]] - allow you to ring one or more registered endpoints.
* [[Time Conditions]] - to define time conditions to affect how calls are handled at different times and on different days
* [[Queues]] - to define call queues to enable people to wait on hold until it is their turn to be answered
* [[PBX Voicemail|Voicemail]] - shows all voicemails that belongs to the current logged in user

'''Status''' - clicking directly on status without selecting a sub-menu will take you to the [[Active Extensions]] page
* [[Active Call Center]] - display queue status, agent status, tier status for call centers
* [[Active Calls]] - lists and allows you to interact with '''active calls''' being handled by your server
* [[Active Conferences]] - lists conferences that are active on your server (showing the number of participants)
* [[Active Extensions]] - lists and allows you to interact with calls being handled by phone extensions on your server
* [[Active Queues]] - displays queues that have one or more callers waiting
* [[Registrations]] - By default in this page you can see all the registered endpoints in profile '''internal'''.
* [[Agent Status]] - Show/Edit the status of the agents at a call center.
* [[Services]] - allows interaction with the processes running on your server
* [[SIP Status]] - shows the status of your internal and external sip connections, various server statistics and a static view of the Sky DANCE log file
* [[System Status]] - shows the status of the physical server you are running SkyPBX on
* [[Log Viewer]] - displays Sky DANCE log file.
* [[Traffic Graph]] - Shows the live traffic on the network interface

'''Advanced''' - clicking directly on Advanced without selecting a sub-menu will take you to the [[Command]] page

* NOTE: This menu should only be available to the super administrator

* [[Adminer]] - A database manager utility
* [[App Manager]] - advanced
* [[Command]] - allows you to interactively submit shell, PHP and Sky DANCE commands to your server
* [[Domains]] - used to setup new domains or edit existing ones.
* [[Group Manager]] - Used to manage SkyPBX groups
* [[PHP Editor]] - allows you to edit php files used in SkyPBX
* [[Provision Editor]] - allows you to edit phone/device provisioning files used in SkyPBX
* [[PHP Service]] - Manages multiple dynamic and customizable PHP services.
* [[Script Editor]] - allows you to edit javascript, lua and perl script used on your server
* [[SIP Profiles]] - allows you to customize the SIP profiles
* [[XML Editor]] - allows you to edit Sky DANCE XML files in the '''conf'''/ directory

XML Editor

2016-05-05T15:45:46Z

Admin:

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

These settings should only be changed by the super admin. Please contact Sky Networks support for help.

SIP Profiles

2016-05-05T15:45:33Z

Admin:

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

These settings should only be changed by the super admin. Please contact Sky Networks support for help.

Script Editor

2016-05-05T15:45:23Z

Admin:

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

These settings should only be changed by the super admin. Please contact Sky Networks support for help.

PHP Service

2016-05-05T15:45:10Z

Admin:

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

These settings should only be changed by the super admin. Please contact Sky Networks support for help.

PHP Editor

2016-05-05T15:44:47Z

Admin:

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

These settings should only be changed by the super admin. Please contact Sky Networks support for help.

XML Editor

2016-05-05T15:43:43Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

SIP Profiles

2016-05-05T15:43:33Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Script Editor

2016-05-05T15:43:26Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

PHP Service

2016-05-05T15:42:56Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

PHP Editor

2016-05-05T15:42:48Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Group Manager

2016-05-05T15:42:39Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

PBX

2016-05-05T15:42:32Z

Admin: /* Documentation for SkyPBX GUI screens */

Click Here to return to the main Screen: '''[[Sky Dance Web User Interface |Back]]'''

Sky PBX is a Sky DANCE application based on the FusionPBX project which is designed to allow you to setup multi-tenant PBX services, IVRs and Call centers for use within Sky DANCE. The following documentation will provide you with information on how to set this up. If you have questions, feel free to call Sky Dance technical support.

==Quick Overview of the Setup==

* Create a domain to match the domain used for registering phones
* Create an extension under Accounts -> Extensions
* Register the phone to the extension. The extension number is the username for the end point.
* Test the phone by dialing the music on hold number *9664
* Setup an inbound route from Sky DANCE to the PBX.
* Validate the settings on the outbound route from Sky DANCE.
* Test

==Menu: Advanced->[[Domains]] (for Multi Tenant setup)==
Every Sky PBX instance will have its own domain. This will be the IP address or the name which is used when an extension will register to the PBX.
Note: The first PBX should already be mostly configured after installation by Sky Networks technicians. This can be used as an example when setting up new ones.

==Menu: Accounts->[[Extensions]]==
The first time the Extensions page is viewed, there will be no extensions listed. Click on the + next to the list in order to add an extension.

"Effective Caller ID" information is shown within your organization, "Outbound Caller ID" information will be seen by those receiving outside calls.

Fill in Extension in order to get a basic phone up and running. It is suggested that a system administrator complete the following:
Extension (according to the numbering scheme used in the implementation)
User list (assign a user to each extension – this allows the end-user to log into the SkyPBX web GUI and check voicemails, faxes and so on via the web. This does not have to be done immediately.)
Voicemail options (e.g. have voicemail sent to a designated email address.)
(editors: Toll allow is a new option – where is this used? I don’t have this set on my system yet my calls all still work)

*The range entry allows more than one extension to be created at a time. This would probably be most useful when doing automated telephone provisioning (note to editors – you’ll need to flesh this out as we now have a provisioning section on this page and I have no idea how to use it).

Save each configured extension (the save button is at the bottom of the GUI). When the save is complete, the screen is returned to the list of extensions.
Click on the extension just created.
Click on the password field to reveal the current password directly below the field. Note the password is displayed because it will be needed to configure a telephone to negotiate with SkyPBX. At this point, it might be prudent to test a telephone negotiating with successfully SkyPBX so that further testing can be performed, ensuring that the following are also properly configured:
IP address of SkyPBX (the phone might know this as the SIP server)
Extension (the extension number is the username for the phone)
Password for the extension

Read the manual for your IP phone or soft phone for more information.
Once the phone is connected you can test it by dialing *9664 which is a code for music on hold.
To use a phone to call somewhere other than music on hold or another extension, configuration of the Sky_Dance entry in the Dialplan Manager is required. (See more information about call provisioning and routing under DialPlan)

==Setup an Inbound Route from Sky DANCE==
There are 2 steps to create an inbound route from Sky DANCE for Sky PBX. (This assumes you already have an inbound route setup in Sky DANCE that can accept traffic)
1. For inbound DIDs, create a "Called Pre Translation" entry in Sky DANCE which routes a call to the PBX using a <9999> prefix

Example: 30550022* 9999665001 - would route to PBX1 with the default setup.

If you have more than 1 PBX planned, you will need to plan on adding 2 prefixes in the Called Pre Translation table with the following format: <Sky PBX application prefix - 9999><4 digit PBX ID><Number within the Dialplan Manager for that PBX>

2. Edit the Send_to_SkyPBX entry in the Dialplan Manager to change the condition to be more specific - ie. if the prefix from Sky DANCE was 99990001 - you could just match on the 0001. To add other PBX entries you can just duplicate the Send_toSkyPBX entry to make a Send_toSkyPBX2,3 4 etc.and edit the domain name to match the new domain for the new PBX and also to change the transfer action to route to the new context.

==Setup an Outbound Route to Sky DANCE==

1. Edit the Send_to_SkyDance entry to modify the sip_h_X-Rg-In=3000,1000;1;1000 entries to match your setup. They should match the inbound resource group and partition used for routing the call to this PBX.

==Voicemail to email==
For voicemail to email configure SMTP server settings in Advanced ->Default Settings. Configure the destination email account in the settings for each extension. SkyPBX does not use an MTA (Message Transfer Agent eg. sendmail or postfix). Instead SkyPBX uses a PHP script that acts as an SMTP client and connects to the SMTP server using the account and password specified by the system and/or extension administrator. As a result, there are no queues or logs where message sent or failed can be viewed. However, if the php script was executed (whether the voicemail was successfully sent or not) there will be a file in /tmp called voicemailtoemail.txt. If voicemailtoemail.txt was created and the voicemail was not received as an email, there could have been two possible results from the action. One possible result was that the script may have executed but it did not successfully negotiate with the SMTP server. Alternately, the script successfully sent the voicemail; however, the destination email account was incorrectly assigned in the settings. If the file is not present in /tmp then it is likely that the voicemail file and directory permissions to /var/www/Skypbx/secure are incorrect. The voicemail script is v_mailto.php. If it is inaccessible to Sky DANCE then the function will not run and the file in /tmp will not be created.

==Getting started (a topical approach to the wiki)==
This wiki is ordered around topics & menu screens. If you are here for the first time the best place to start is the topical section below. If you already have fusionpbx and want to know more about a particular function you can look up the menu screen section for more information.

* [[Multi-Tenant]] - Domain based multi-tenant. 
* [[Extensions]] - ie. your phones 
* [[IVR Menu]] - ie. if you want to setup an auto attendant or have automated prompts for a caller this is where you set this up 
* [[Conferences]] - allows you to define reservationless conference rooms 
* [[Call Groups]] - settings that allow you to group phones together 
* [[Music On Hold]] - ie. if you place someone on hold what will they hear? 
* [[Ring Groups]] - call one or more extensions

==Documentation for SkyPBX GUI screens==
Please note that the documentation in this section is in progress. Many of the menu items shown here are available only to the "super admin" or are reserved for advanced use. Further information can be found by clicking on the associated menu item.

The GUI is accessible using a web browser by going to the PBX entry in the Sky DANCE GUI.

'''[[System]]''' - the default page that is displayed when you log in to SkyPBX is the System page. You can access it later by clicking on System directly without selecting a sub-menu
* [[Account Settings]] - the account settings for the currently logged on user
* [[SkyPBX Logout |Logout]] - use this to log out of the SkyPBX administration web site
* [[Menu Manager]] - This is used to control which menu items are available to the various user levels.
* [[Modules]] - for enabling and disabling Sky DANCE modules
* [[SkyPBX Settings|Settings]] - (advanced) SkyPBX settings
* [[Variables]] - (advanced) Manage Sky DANCE internal variables
'''Accounts''' - clicking directly on Accounts without selecting a sub-menu will take you to the [[Extensions]] page
* [[Devices]] - for seeing and modifying all provisioned phones. See [[Extensions]] for more information
* [[Extensions]] - where you configure the extensions for the phones attached to your system
* [[Gateways]] - (advanced - should only be used by super admin) These are the gateways that can be used to terminate traffic.
* [[User Manager]] - Allows a superadmin/admin to manage USERs and GROUPs. Can create/delete users, edit their [[Account Settings]].
* [[XMPP Manager]] - Configure XMPP to work with Google talk or other jabber servers. (Advanced)

'''Dialplan''' - clicking directly on dialplan without selecting a sub-menu will take you to the [[Dialplan Manager]] page
* [[Dialplan Manager]] - used to update the dialplan controlling what happens when a number is dialed (note that this also includes the dialplan entries used for [[Outbound Routes]])
* [[Inbound Routes]] - (advanced) used to define what to do with calls coming from outside of your SkyPBX/Sky DANCE server
* [[Outbound Routes]] - (advanced) used to define dialplan entries that affect calls that leave your SkyPBX/Sky DANCE server to go to the outside world

'''Apps''' - clicking directly on apps without selecting a sub-menu will take you to the [[Call Detail Records]] page

* [[Call block]] - Block inbound callers, optional module must be installed from Dev/Apps
* [[Call Broadcast]] - (option)
* [[Call Center]] – Setup a SkyPBX call center
* [[Call Detail Records]] - Call history reports and detailed information on the calls.
* [[Conferences]] - to define permanently reserved conference numbers for individuals/groups to use
* [[Contact Manager]] - Manage your contact list and create [http://en.wikipedia.org/wiki/VCard vcards] if needed
* [[Fax Server]] - (option) to setup inbound and outbound faxing from SkyPBX (without needing a physical fax machine)
* [[Follow Me]] - Configure call forwarding, follow me, or do not disturb.
* [[Hot Desking]] (option)
* [[IVR Menu]] - To define Auto attendants, Interactive Voice Response menus (ie. press 1 for billing, press 2 for technical support, etc.)
* [[Music On Hold]] - to set up music for callers who are placed on hold or who are in a queue.
* [[Recordings]] - for making, modifying and reviewing recorded messages used within your phone system
* [[Ring Groups]] - allow you to ring one or more registered endpoints.
* [[Time Conditions]] - to define time conditions to affect how calls are handled at different times and on different days
* [[Queues]] - to define call queues to enable people to wait on hold until it is their turn to be answered
* [[PBX Voicemail|Voicemail]] - shows all voicemails that belongs to the current logged in user

'''Status''' - clicking directly on status without selecting a sub-menu will take you to the [[Active Extensions]] page
* [[Active Call Center]] - display queue status, agent status, tier status for call centers
* [[Active Calls]] - lists and allows you to interact with '''active calls''' being handled by your server
* [[Active Conferences]] - lists conferences that are active on your server (showing the number of participants)
* [[Active Extensions]] - lists and allows you to interact with calls being handled by phone extensions on your server
* [[Active Queues]] - displays queues that have one or more callers waiting
* [[Registrations]] - By default in this page you can see all the registered endpoints in profile '''internal'''.
* [[Agent Status]] - Show/Edit the status of the agents at a call center.
* [[Services]] - allows interaction with the processes running on your server
* [[SIP Status]] - shows the status of your internal and external sip connections, various server statistics and a static view of the Sky DANCE log file
* [[System Status]] - shows the status of the physical server you are running SkyPBX on
* [[Log Viewer]] - displays Sky DANCE log file.
* [[Traffic Graph]] - Shows the live traffic on the network interface

'''Advanced''' - clicking directly on Advanced without selecting a sub-menu will take you to the [[Command]] page

* NOTE: This menu should only be available to the super administrator

* [[Adminer]] - A database manager utility
* [[App Manager]] - advanced
* [[Command]] - allows you to interactively submit shell, PHP and Sky DANCE commands to your server
* [[Domains]] - used to setup new domains or edit existing ones.
* [[Group Manager]] - Used to manage SkyPBX groups
* [[PHP Editor]] - allows you to edit php files used in SkyPBX
* [[Provision Editor]] - allows you to edit phone/device provisioning files used in SkyPBX
* [[PHP Service]] - Manages multiple dynamic and customizable PHP services.
* [[Script Editor]] - allows you to edit javascript, lua and perl script used on your server
* [[SIP Profiles]] - allows you to customize the SIP profiles
* [[XML Editor]] - allows you to edit Sky DANCE XML files in the '''conf'''/ directory

Command

2016-05-05T15:42:05Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Domains

2016-05-05T15:41:54Z

Admin:

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Mutli-tenant is done using Fully Qualified domain names (FQDN). They can be full domains or sub-domains are used. The domains separate the information between tenants. The domains need to be pointed to the SkyPBX application.

==Advanced -> System Settings==
To setup multi-tenant add domains under advanced -> domains. Choose a domain name that you are not planning on changing and add the context name you plan on using for this instance of the SkyPBX - ie. pbx1, pbx2 etc. It is possible to change a domain name but requires the domain to be changed in several places. After adding the second domain restart the internal sip profile this can be done at Status -> SIP Status then restart the Internal SIP Profile.

==Alias==
When adding a new tenant the domain alias will not show up until an extension has been added to the tenant and the internal sip profile has been rescanned or restarted. The alias can be viewed in Status -> SIP Status.

App Manager

2016-05-05T15:41:32Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Adminer

2016-05-05T15:41:24Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Traffic Graph

2016-05-05T15:41:12Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Log Viewer

2016-05-05T15:41:03Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

System Status

2016-05-05T15:40:55Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

SIP Status

2016-05-05T15:40:49Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Services

2016-05-05T15:40:43Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Agent Status

2016-05-05T15:40:36Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Registrations

2016-05-05T15:40:30Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Active Queues

2016-05-05T15:40:23Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Active Extensions

2016-05-05T15:40:17Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Active Conferences

2016-05-05T15:40:11Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Active Calls

2016-05-05T15:40:04Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Active Call Center

2016-05-05T15:39:54Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

PBX Voicemail

2016-05-05T15:39:39Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Queues

2016-05-05T15:38:53Z

Admin:

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Queues are used to setup waiting lines for callers.

You can use this feature for setting up simple FIFO queues or you can use the [[Call Center]] feature which is more comprehensive

Common FIFO Queue Definitions
Consumer - An off-hook agent, that is, an agent who logs into the FIFO queue (by calling the login extension number) and is waiting to 'consume' or receive incoming calls from the queue. The agent's phone is in use the entire time that he/she is logged in to the queue.
Member - An on-hook agent, that is, an agent who logs into the queue but whose phone is idle until an inbound call hits the queue. The agent's phone rings and he/she takes a call off the queue. Multiple members' phones can ring for each incoming call.
Caller - A person who has called into the queue. The caller can be "waiting" or can be speaking to an agent.

Agent Callback
This will call registered agents.

Backend Configuration Options: (Set in autoload_configs/fifo.conf.xml)
member timeout= how long to ring the extension (in seconds) before moving on
simo= number of simultaneous registrations to ring, must be set to at least 1
If you have multiple phones registered to the same extension, this controls how many to ring at once
Example: 10 phones registered to one extension, set simo="10" to ring all 10.
lag= seconds to wait before initiating another call (think wrapup-time in asterisk)
fifo_member_wait= possible values are either 'wait' or 'nowait'. (more info)

Note: If you wish to specify the caller ID presented when a fifo calls an agent, set the origination_caller_id_name and origination_caller_id_num variables to the values desired. These could be set within the {} of the dialstring, or they could be set using the set application in the dialplan which places the caller into the fifo (before the 'fifo in' executed on the caller).

Queues

2016-05-05T15:33:16Z

Admin:

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Queues are used to setup waiting lines for callers.

You can use this feature for setting up simple queues or you can use the [[Call Center]] feature which is more comprehensive

Definitions
Consumer - An off-hook agent, that is, an agent who calls into the FIFO queue and is waiting to 'consume' incoming calls from the queue. The consumer's phone is in use the entire time that he/she is logged in to the queue.
Member - An on-hook agent, that is, an agent who logs into the queue but whose phone is idle until an inbound call hits the queue. The agent's phone rings and he/she takes a call off the queue. Multiple members' phones can ring for each incoming call.
Caller - A person who has called into the queue. The caller can be "waiting" or can be speaking to an agent.

Agent Callback
This will call registered agents.

member timeout= how long to ring the extension (in seconds) before moving on
simo= number of simultaneous registrations to ring, must be set to at least 1
If you have multiple phones registered to the same extension, this controls how many to ring at once
Example: 10 phones registered to one extension, set simo="10" to ring all 10.
lag= seconds to wait before initiating another call (think wrapup-time in asterisk)
fifo_member_wait= possible values are either 'wait' or 'nowait'. (more info)

Note: If you wish to specify the caller ID presented when a fifo calls an agent, set the origination_caller_id_name and origination_caller_id_num variables to the values desired. These could be set within the {} of the dialstring, or they could be set using the set application in the dialplan which places the caller into the fifo (before the 'fifo in' executed on the caller).

Queues

2016-05-05T15:32:43Z

Admin:

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Queues are used to setup waiting lines for callers.

You can use this feature for setting up simple queues or you can use the [[Call Center]] feature which is more comprehensive

Definitions
Keep these terms in mind as they will help you with your mod_fifo endeavors:
Consumer - An off-hook agent, that is, an agent who calls into the FIFO queue and is waiting to 'consume' incoming calls from the queue. The consumer's phone is in use the entire time that he/she is logged in to the queue.
Member - An on-hook agent, that is, an agent who logs into the queue but whose phone is idle until an inbound call hits the queue. The agent's phone rings and he/she takes a call off the queue. Multiple members' phones can ring for each incoming call.
Caller - A person who has called into the queue. The caller can be "waiting" or can be speaking to an agent.

Agent Callback
This will call registered agents.

member timeout= how long to ring the extension (in seconds) before moving on
simo= number of simultaneous registrations to ring, must be set to at least 1
If you have multiple phones registered to the same extension, this controls how many to ring at once
Example: 10 phones registered to one extension, set simo="10" to ring all 10.
lag= seconds to wait before initiating another call (think wrapup-time in asterisk)
fifo_member_wait= possible values are either 'wait' or 'nowait'. (more info)

Note: If you wish to specify the caller ID presented when a fifo calls an agent, set the origination_caller_id_name and origination_caller_id_num variables to the values desired. These could be set within the {} of the dialstring, or they could be set using the set application in the dialplan which places the caller into the fifo (before the 'fifo in' executed on the caller).

Queues

2016-05-05T15:30:17Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back''' You can use this feature for setting up simple queues or you can use the Call Center feature which is mor..."

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

You can use this feature for setting up simple queues or you can use the Call Center feature which is more comprehensive

Time Conditions

2016-05-05T15:29:40Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

PBX

2016-05-05T15:28:18Z

Admin: /* Documentation for SkyPBX GUI screens */

Click Here to return to the main Screen: '''[[Sky Dance Web User Interface |Back]]'''

Sky PBX is a Sky DANCE application based on the FusionPBX project which is designed to allow you to setup multi-tenant PBX services, IVRs and Call centers for use within Sky DANCE. The following documentation will provide you with information on how to set this up. If you have questions, feel free to call Sky Dance technical support.

==Quick Overview of the Setup==

* Create a domain to match the domain used for registering phones
* Create an extension under Accounts -> Extensions
* Register the phone to the extension. The extension number is the username for the end point.
* Test the phone by dialing the music on hold number *9664
* Setup an inbound route from Sky DANCE to the PBX.
* Validate the settings on the outbound route from Sky DANCE.
* Test

==Menu: Advanced->[[Domains]] (for Multi Tenant setup)==
Every Sky PBX instance will have its own domain. This will be the IP address or the name which is used when an extension will register to the PBX.
Note: The first PBX should already be mostly configured after installation by Sky Networks technicians. This can be used as an example when setting up new ones.

==Menu: Accounts->[[Extensions]]==
The first time the Extensions page is viewed, there will be no extensions listed. Click on the + next to the list in order to add an extension.

"Effective Caller ID" information is shown within your organization, "Outbound Caller ID" information will be seen by those receiving outside calls.

Fill in Extension in order to get a basic phone up and running. It is suggested that a system administrator complete the following:
Extension (according to the numbering scheme used in the implementation)
User list (assign a user to each extension – this allows the end-user to log into the SkyPBX web GUI and check voicemails, faxes and so on via the web. This does not have to be done immediately.)
Voicemail options (e.g. have voicemail sent to a designated email address.)
(editors: Toll allow is a new option – where is this used? I don’t have this set on my system yet my calls all still work)

*The range entry allows more than one extension to be created at a time. This would probably be most useful when doing automated telephone provisioning (note to editors – you’ll need to flesh this out as we now have a provisioning section on this page and I have no idea how to use it).

Save each configured extension (the save button is at the bottom of the GUI). When the save is complete, the screen is returned to the list of extensions.
Click on the extension just created.
Click on the password field to reveal the current password directly below the field. Note the password is displayed because it will be needed to configure a telephone to negotiate with SkyPBX. At this point, it might be prudent to test a telephone negotiating with successfully SkyPBX so that further testing can be performed, ensuring that the following are also properly configured:
IP address of SkyPBX (the phone might know this as the SIP server)
Extension (the extension number is the username for the phone)
Password for the extension

Read the manual for your IP phone or soft phone for more information.
Once the phone is connected you can test it by dialing *9664 which is a code for music on hold.
To use a phone to call somewhere other than music on hold or another extension, configuration of the Sky_Dance entry in the Dialplan Manager is required. (See more information about call provisioning and routing under DialPlan)

==Setup an Inbound Route from Sky DANCE==
There are 2 steps to create an inbound route from Sky DANCE for Sky PBX. (This assumes you already have an inbound route setup in Sky DANCE that can accept traffic)
1. For inbound DIDs, create a "Called Pre Translation" entry in Sky DANCE which routes a call to the PBX using a <9999> prefix

Example: 30550022* 9999665001 - would route to PBX1 with the default setup.

If you have more than 1 PBX planned, you will need to plan on adding 2 prefixes in the Called Pre Translation table with the following format: <Sky PBX application prefix - 9999><4 digit PBX ID><Number within the Dialplan Manager for that PBX>

2. Edit the Send_to_SkyPBX entry in the Dialplan Manager to change the condition to be more specific - ie. if the prefix from Sky DANCE was 99990001 - you could just match on the 0001. To add other PBX entries you can just duplicate the Send_toSkyPBX entry to make a Send_toSkyPBX2,3 4 etc.and edit the domain name to match the new domain for the new PBX and also to change the transfer action to route to the new context.

==Setup an Outbound Route to Sky DANCE==

1. Edit the Send_to_SkyDance entry to modify the sip_h_X-Rg-In=3000,1000;1;1000 entries to match your setup. They should match the inbound resource group and partition used for routing the call to this PBX.

==Voicemail to email==
For voicemail to email configure SMTP server settings in Advanced ->Default Settings. Configure the destination email account in the settings for each extension. SkyPBX does not use an MTA (Message Transfer Agent eg. sendmail or postfix). Instead SkyPBX uses a PHP script that acts as an SMTP client and connects to the SMTP server using the account and password specified by the system and/or extension administrator. As a result, there are no queues or logs where message sent or failed can be viewed. However, if the php script was executed (whether the voicemail was successfully sent or not) there will be a file in /tmp called voicemailtoemail.txt. If voicemailtoemail.txt was created and the voicemail was not received as an email, there could have been two possible results from the action. One possible result was that the script may have executed but it did not successfully negotiate with the SMTP server. Alternately, the script successfully sent the voicemail; however, the destination email account was incorrectly assigned in the settings. If the file is not present in /tmp then it is likely that the voicemail file and directory permissions to /var/www/Skypbx/secure are incorrect. The voicemail script is v_mailto.php. If it is inaccessible to Sky DANCE then the function will not run and the file in /tmp will not be created.

==Getting started (a topical approach to the wiki)==
This wiki is ordered around topics & menu screens. If you are here for the first time the best place to start is the topical section below. If you already have fusionpbx and want to know more about a particular function you can look up the menu screen section for more information.

* [[Multi-Tenant]] - Domain based multi-tenant. 
* [[Extensions]] - ie. your phones 
* [[IVR Menu]] - ie. if you want to setup an auto attendant or have automated prompts for a caller this is where you set this up 
* [[Conferences]] - allows you to define reservationless conference rooms 
* [[Call Groups]] - settings that allow you to group phones together 
* [[Music On Hold]] - ie. if you place someone on hold what will they hear? 
* [[Ring Groups]] - call one or more extensions

==Documentation for SkyPBX GUI screens==
Please note that the documentation in this section is in progress. Many of the menu items shown here are available only to the "super admin" or are reserved for advanced use. Further information can be found by clicking on the associated menu item.

The GUI is accessible using a web browser by going to the PBX entry in the Sky DANCE GUI.

'''[[System]]''' - the default page that is displayed when you log in to SkyPBX is the System page. You can access it later by clicking on System directly without selecting a sub-menu
* [[Account Settings]] - the account settings for the currently logged on user
* [[SkyPBX Logout |Logout]] - use this to log out of the SkyPBX administration web site
* [[Menu Manager]] - This is used to control which menu items are available to the various user levels.
* [[Modules]] - for enabling and disabling Sky DANCE modules
* [[SkyPBX Settings|Settings]] - (advanced) SkyPBX settings
* [[Variables]] - (advanced) Manage Sky DANCE internal variables
'''Accounts''' - clicking directly on Accounts without selecting a sub-menu will take you to the [[Extensions]] page
* [[Devices]] - for seeing and modifying all provisioned phones. See [[Extensions]] for more information
* [[Extensions]] - where you configure the extensions for the phones attached to your system
* [[Gateways]] - (advanced - should only be used by super admin) These are the gateways that can be used to terminate traffic.
* [[User Manager]] - Allows a superadmin/admin to manage USERs and GROUPs. Can create/delete users, edit their [[Account Settings]].
* [[XMPP Manager]] - Configure XMPP to work with Google talk or other jabber servers. (Advanced)

'''Dialplan''' - clicking directly on dialplan without selecting a sub-menu will take you to the [[Dialplan Manager]] page
* [[Dialplan Manager]] - used to update the dialplan controlling what happens when a number is dialed (note that this also includes the dialplan entries used for [[Outbound Routes]])
* [[Inbound Routes]] - (advanced) used to define what to do with calls coming from outside of your SkyPBX/Sky DANCE server
* [[Outbound Routes]] - (advanced) used to define dialplan entries that affect calls that leave your SkyPBX/Sky DANCE server to go to the outside world

'''Apps''' - clicking directly on apps without selecting a sub-menu will take you to the [[Call Detail Records]] page

* [[Call block]] - Block inbound callers, optional module must be installed from Dev/Apps
* [[Call Broadcast]] - (option)
* [[Call Center]] – Setup a SkyPBX call center
* [[Call Detail Records]] - Call history reports and detailed information on the calls.
* [[Conferences]] - to define permanently reserved conference numbers for individuals/groups to use
* [[Contact Manager]] - Manage your contact list and create [http://en.wikipedia.org/wiki/VCard vcards] if needed
* [[Fax Server]] - (option) to setup inbound and outbound faxing from SkyPBX (without needing a physical fax machine)
* [[Follow Me]] - Configure call forwarding, follow me, or do not disturb.
* [[Hot Desking]] (option)
* [[IVR Menu]] - To define Auto attendants, Interactive Voice Response menus (ie. press 1 for billing, press 2 for technical support, etc.)
* [[Music On Hold]] - to set up music for callers who are placed on hold or who are in a queue.
* [[Recordings]] - for making, modifying and reviewing recorded messages used within your phone system
* [[Ring Groups]] - allow you to ring one or more registered endpoints.
* [[Time Conditions]] - to define time conditions to affect how calls are handled at different times and on different days
* [[Queues]] - to define call queues to enable people to wait on hold until it is their turn to be answered
* [[PBX Voicemail|Voicemail]] - shows all voicemails that belongs to the current logged in user

'''Status''' - clicking directly on status without selecting a sub-menu will take you to the [[Active Extensions]] page
* [[Active Call Center]] - display queue status, agent status, tier status for call centers
* [[Active Calls]] - lists and allows you to interact with '''active calls''' being handled by your server
* [[Active Conferences]] - lists conferences that are active on your server (showing the number of participants)
* [[Active Extensions]] - lists and allows you to interact with calls being handled by phone extensions on your server
* [[Active Queues]] - displays queues that have one or more callers waiting
* [[Registrations]] - By default in this page you can see all the registered endpoints in profile '''internal'''.
* [[Agent Status]] - Show/Edit the status of the agents at a call center.
* [[Services]] - allows interaction with the processes running on your server
* [[SIP Status]] - shows the status of your internal and external sip connections, various server statistics and a static view of the Sky DANCE log file
* [[System Status]] - shows the status of the physical server you are running SkyPBX on
* [[Log Viewer]] - displays Sky DANCE log file.
* [[Traffic Graph]] - Shows the live traffic on the network interface

'''Advanced''' - clicking directly on Advanced without selecting a sub-menu will take you to the [[Command]] page

* NOTE: This menu should only be available to the super administrator

* [[Adminer]] - A database manager utility
* [[App Manager]] - advanced
* [[Command]] - allows you to interactively submit shell, PHP and Sky DANCE commands to your server
* [[Domains]] - used to setup new domains or edit existing ones.
* [[Grammar Editor]] - allows you to edit Sky DANCE speech recognition grammar definitions
* [[Group Manager]] - Used to manage SkyPBX groups
* [[PHP Editor]] - allows you to edit php files used in SkyPBX
* [[Provision Editor]] - allows you to edit phone/device provisioning files used in SkyPBX
* [[PHP Service]] - Manages multiple dynamic and customizable PHP services.
* [[Script Editor]] - allows you to edit javascript, lua and perl script used on your server
* [[SIP Profiles]] - allows you to customize the SIP profiles
* [[XML Editor]] - allows you to edit Sky DANCE XML files in the '''conf'''/ directory

Follow Me

2016-05-05T15:27:04Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Hot Desking

2016-05-05T15:26:47Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back''' Please contact Sky Networks sales for more information and pricing."

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Please contact Sky Networks sales for more information and pricing.

Fax Server

2016-05-05T15:26:37Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back''' Please contact Sky Networks sales for more information and pricing."

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

Please contact Sky Networks sales for more information and pricing.

Contact Manager

2016-05-05T15:26:10Z

Admin: Created page with "Click Here to return to the Sky PBX main Screen: '''Back'''"

Click Here to return to the Sky PBX main Screen: '''[[PBX |Back]]'''

PBX

2016-05-05T15:25:43Z

Admin: /* Getting started (a topical approach to the wiki) */

Click Here to return to the main Screen: '''[[Sky Dance Web User Interface |Back]]'''

Sky PBX is a Sky DANCE application based on the FusionPBX project which is designed to allow you to setup multi-tenant PBX services, IVRs and Call centers for use within Sky DANCE. The following documentation will provide you with information on how to set this up. If you have questions, feel free to call Sky Dance technical support.

==Quick Overview of the Setup==

* Create a domain to match the domain used for registering phones
* Create an extension under Accounts -> Extensions
* Register the phone to the extension. The extension number is the username for the end point.
* Test the phone by dialing the music on hold number *9664
* Setup an inbound route from Sky DANCE to the PBX.
* Validate the settings on the outbound route from Sky DANCE.
* Test

==Menu: Advanced->[[Domains]] (for Multi Tenant setup)==
Every Sky PBX instance will have its own domain. This will be the IP address or the name which is used when an extension will register to the PBX.
Note: The first PBX should already be mostly configured after installation by Sky Networks technicians. This can be used as an example when setting up new ones.

==Menu: Accounts->[[Extensions]]==
The first time the Extensions page is viewed, there will be no extensions listed. Click on the + next to the list in order to add an extension.

"Effective Caller ID" information is shown within your organization, "Outbound Caller ID" information will be seen by those receiving outside calls.

Fill in Extension in order to get a basic phone up and running. It is suggested that a system administrator complete the following:
Extension (according to the numbering scheme used in the implementation)
User list (assign a user to each extension – this allows the end-user to log into the SkyPBX web GUI and check voicemails, faxes and so on via the web. This does not have to be done immediately.)
Voicemail options (e.g. have voicemail sent to a designated email address.)
(editors: Toll allow is a new option – where is this used? I don’t have this set on my system yet my calls all still work)

*The range entry allows more than one extension to be created at a time. This would probably be most useful when doing automated telephone provisioning (note to editors – you’ll need to flesh this out as we now have a provisioning section on this page and I have no idea how to use it).

Save each configured extension (the save button is at the bottom of the GUI). When the save is complete, the screen is returned to the list of extensions.
Click on the extension just created.
Click on the password field to reveal the current password directly below the field. Note the password is displayed because it will be needed to configure a telephone to negotiate with SkyPBX. At this point, it might be prudent to test a telephone negotiating with successfully SkyPBX so that further testing can be performed, ensuring that the following are also properly configured:
IP address of SkyPBX (the phone might know this as the SIP server)
Extension (the extension number is the username for the phone)
Password for the extension

Read the manual for your IP phone or soft phone for more information.
Once the phone is connected you can test it by dialing *9664 which is a code for music on hold.
To use a phone to call somewhere other than music on hold or another extension, configuration of the Sky_Dance entry in the Dialplan Manager is required. (See more information about call provisioning and routing under DialPlan)

==Setup an Inbound Route from Sky DANCE==
There are 2 steps to create an inbound route from Sky DANCE for Sky PBX. (This assumes you already have an inbound route setup in Sky DANCE that can accept traffic)
1. For inbound DIDs, create a "Called Pre Translation" entry in Sky DANCE which routes a call to the PBX using a <9999> prefix

Example: 30550022* 9999665001 - would route to PBX1 with the default setup.

If you have more than 1 PBX planned, you will need to plan on adding 2 prefixes in the Called Pre Translation table with the following format: <Sky PBX application prefix - 9999><4 digit PBX ID><Number within the Dialplan Manager for that PBX>

2. Edit the Send_to_SkyPBX entry in the Dialplan Manager to change the condition to be more specific - ie. if the prefix from Sky DANCE was 99990001 - you could just match on the 0001. To add other PBX entries you can just duplicate the Send_toSkyPBX entry to make a Send_toSkyPBX2,3 4 etc.and edit the domain name to match the new domain for the new PBX and also to change the transfer action to route to the new context.

==Setup an Outbound Route to Sky DANCE==

1. Edit the Send_to_SkyDance entry to modify the sip_h_X-Rg-In=3000,1000;1;1000 entries to match your setup. They should match the inbound resource group and partition used for routing the call to this PBX.

==Voicemail to email==
For voicemail to email configure SMTP server settings in Advanced ->Default Settings. Configure the destination email account in the settings for each extension. SkyPBX does not use an MTA (Message Transfer Agent eg. sendmail or postfix). Instead SkyPBX uses a PHP script that acts as an SMTP client and connects to the SMTP server using the account and password specified by the system and/or extension administrator. As a result, there are no queues or logs where message sent or failed can be viewed. However, if the php script was executed (whether the voicemail was successfully sent or not) there will be a file in /tmp called voicemailtoemail.txt. If voicemailtoemail.txt was created and the voicemail was not received as an email, there could have been two possible results from the action. One possible result was that the script may have executed but it did not successfully negotiate with the SMTP server. Alternately, the script successfully sent the voicemail; however, the destination email account was incorrectly assigned in the settings. If the file is not present in /tmp then it is likely that the voicemail file and directory permissions to /var/www/Skypbx/secure are incorrect. The voicemail script is v_mailto.php. If it is inaccessible to Sky DANCE then the function will not run and the file in /tmp will not be created.

==Getting started (a topical approach to the wiki)==
This wiki is ordered around topics & menu screens. If you are here for the first time the best place to start is the topical section below. If you already have fusionpbx and want to know more about a particular function you can look up the menu screen section for more information.

* [[Multi-Tenant]] - Domain based multi-tenant. 
* [[Extensions]] - ie. your phones 
* [[IVR Menu]] - ie. if you want to setup an auto attendant or have automated prompts for a caller this is where you set this up 
* [[Conferences]] - allows you to define reservationless conference rooms 
* [[Call Groups]] - settings that allow you to group phones together 
* [[Music On Hold]] - ie. if you place someone on hold what will they hear? 
* [[Ring Groups]] - call one or more extensions

==Documentation for SkyPBX GUI screens==
Please note that the documentation in this section is in progress. Many of the menu items shown here are available only to the "super admin" or are reserved for advanced use. Further information can be found by clicking on the associated menu item.

The GUI is accessible using a web browser by going to the PBX entry in the Sky DANCE GUI.

'''[[System]]''' - the default page that is displayed when you log in to SkyPBX is the System page. You can access it later by clicking on System directly without selecting a sub-menu
* [[Account Settings]] - the account settings for the currently logged on user
* [[SkyPBX Logout |Logout]] - use this to log out of the SkyPBX administration web site
* [[Menu Manager]] - This is used to control which menu items are available to the various user levels.
* [[Modules]] - for enabling and disabling Sky DANCE modules
* [[SkyPBX Settings|Settings]] - (advanced) SkyPBX settings
* [[Variables]] - (advanced) Manage Sky DANCE internal variables
'''Accounts''' - clicking directly on Accounts without selecting a sub-menu will take you to the [[Extensions]] page
* [[Devices]] - for seeing and modifying all provisioned phones. See [[Extensions]] for more information
* [[Extensions]] - where you configure the extensions for the phones attached to your system
* [[Gateways]] - (advanced - should only be used by super admin) These are the gateways that can be used to terminate traffic.
* [[User Manager]] - Allows a superadmin/admin to manage USERs and GROUPs. Can create/delete users, edit their [[Account Settings]].
* [[XMPP Manager]] - Configure XMPP to work with Google talk or other jabber servers. (Advanced)

'''Dialplan''' - clicking directly on dialplan without selecting a sub-menu will take you to the [[Dialplan Manager]] page
* [[Dialplan Manager]] - used to update the dialplan controlling what happens when a number is dialed (note that this also includes the dialplan entries used for [[Outbound Routes]])
* [[Inbound Routes]] - (advanced) used to define what to do with calls coming from outside of your SkyPBX/Sky DANCE server
* [[Outbound Routes]] - (advanced) used to define dialplan entries that affect calls that leave your SkyPBX/Sky DANCE server to go to the outside world

'''Apps''' - clicking directly on apps without selecting a sub-menu will take you to the [[Call Detail Records]] page

* [[Call block]] - Block inbound callers, optional module must be installed from Dev/Apps
* [[Call Broadcast]] - (option)
* [[Call Center]] – Setup a SkyPBX call center
* [[Call Detail Records]] - Call history reports and detailed information on the calls.
* [[Conferences]] - to define permanently reserved conference numbers for individuals/groups to use
* [[Contact Manager]] - Manage your contact list and create [http://en.wikipedia.org/wiki/VCard vcards] if needed
* [[Fax Server]] - (option) to setup inbound and outbound faxing from SkyPBX (without needing a physical fax machine)
* [[Follow Me]] - to setup follow me services
* [[Hot Desking]] (option)
* [[IVR Menu]] - To define Auto attendants, Interactive Voice Response menus (ie. press 1 for billing, press 2 for technical support, etc.)
* [[Music On Hold]] - to set up music for callers who are placed on hold or who are in a queue.
* [[Recordings]] - for making, modifying and reviewing recorded messages used within your phone system
* [[Ring Groups]] - allow you to ring one or more registered endpoints.
* [[Time Conditions]] - to define time conditions to affect how calls are handled at different times and on different days
* [[Queues]] - to define call queues to enable people to wait on hold until it is their turn to be answered
* [[PBX Voicemail|Voicemail]] - shows all voicemails that belongs to the current logged in user

'''Status''' - clicking directly on status without selecting a sub-menu will take you to the [[Active Extensions]] page
* [[Active Call Center]] - display queue status, agent status, tier status for call centers
* [[Active Calls]] - lists and allows you to interact with '''active calls''' being handled by your server
* [[Active Conferences]] - lists conferences that are active on your server (showing the number of participants)
* [[Active Extensions]] - lists and allows you to interact with calls being handled by phone extensions on your server
* [[Active Queues]] - displays queues that have one or more callers waiting
* [[Registrations]] - By default in this page you can see all the registered endpoints in profile '''internal'''.
* [[Agent Status]] - Show/Edit the status of the agents at a call center.
* [[Services]] - allows interaction with the processes running on your server
* [[SIP Status]] - shows the status of your internal and external sip connections, various server statistics and a static view of the Sky DANCE log file
* [[System Status]] - shows the status of the physical server you are running SkyPBX on
* [[Log Viewer]] - displays Sky DANCE log file.
* [[Traffic Graph]] - Shows the live traffic on the network interface

'''Advanced''' - clicking directly on Advanced without selecting a sub-menu will take you to the [[Command]] page

* NOTE: This menu should only be available to the super administrator

* [[Adminer]] - A database manager utility
* [[App Manager]] - advanced
* [[Command]] - allows you to interactively submit shell, PHP and Sky DANCE commands to your server
* [[Domains]] - used to setup new domains or edit existing ones.
* [[Grammar Editor]] - allows you to edit Sky DANCE speech recognition grammar definitions
* [[Group Manager]] - Used to manage SkyPBX groups
* [[PHP Editor]] - allows you to edit php files used in SkyPBX
* [[Provision Editor]] - allows you to edit phone/device provisioning files used in SkyPBX
* [[PHP Service]] - Manages multiple dynamic and customizable PHP services.
* [[Script Editor]] - allows you to edit javascript, lua and perl script used on your server
* [[SIP Profiles]] - allows you to customize the SIP profiles
* [[XML Editor]] - allows you to edit Sky DANCE XML files in the '''conf'''/ directory