Difference between revisions of "IP PBX Manual Branch Offices"
Drew Harrell (talk | contribs) |
|||
(24 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTITLE__ {{IP_PBX_Manual|sortkey=Branch Offices}} | ||
+ | |||
== Branch Offices == | == Branch Offices == | ||
− | |||
+ | Branch Offices provide a powerful tool for interconnecting PBX Systems. Through Branch Offices you can create a network of systems where dialing phones on remote systems is as easy as dialing local extensions. You can route calls inbound to a destination on any branched PBX, and outbound through the trunks of other systems networked in this way. Branch office extensions can even participate in ring groups. | ||
+ | <p>[[File:Samplebranchoffice.png]] | ||
− | {| style="border-spacing:0 | + | {| style="border-spacing:0" |
− | | style="border-top:0.0069in solid #000000;border-bottom:0.0069in solid #000000;border-left:0.0069in solid #000000;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in | + | |- |
− | | style="border:0.0069in solid #000000;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in | + | | style="border-top:0.0069in solid #000000; border-bottom:0.0069in solid #000000; border-left:0.0069in solid #000000; border-right:none; padding-top:0in; padding-bottom:0in; padding-left:0.075in; padding-right:0.075in" | |
− | + | | style="border:0.0069in solid #000000; padding-top:0in; padding-bottom:0in; padding-left:0.075in; padding-right:0.075in" | '''IMPORTANT: Branch Offices communicate using IAX2 protocol over Port 4569. Refer to the Port Forwarding Configuration Table earlier in this manual for more information.''' | |
|} | |} | ||
− | + | [[File:editbranchoffice.png]] | |
− | {| style="border-spacing: | + | {| style="border-spacing: 0px" class="wikitable" |
− | | | + | |- |
− | + | | <center>'''Sections/Fields'''</center> | |
+ | | <center>'''Description'''</center> | ||
+ | |- | ||
+ | | style="text-align: center" | '''Name<br/>''' | ||
+ | | The name that is associated with the branch office. Both sites involved in the Branch Office connection must use the same Name. | ||
+ | NOTE: This field will not allow spaces in the name. It must be all one word. Symbols can be used (i.e. underscore “_” dashes “-”, etc.) can be used in place of spaces. | ||
|- | |- | ||
− | | style=" | + | | style="text-align: center" | '''Host<br/>''' |
− | + | | Enter the static IP of the system your PBX is connecting to. If they do not have a static IP address, enter the word dynamic. | |
− | | | ||
− | |||
− | |||
− | |||
|- | |- | ||
− | | style=" | + | | style="text-align: center" | '''Dial Prefix<br/>''' |
− | + | | The dial prefix must be an asterisk, plus two numbers (ie. *22). This prefix must be dialed to reach any destination on another PBX that has not been entered as a Branch Extension. | |
− | | | ||
− | |||
|- | |- | ||
− | | style=" | + | | style="text-align: center" | '''Password<br/>''' |
− | + | | This is the password that will allow access to the PBX. Both sites involved in the Branch Office connection must use the same Password. | |
− | |||
− | |||
|- | |- | ||
− | | style=" | + | | style="text-align: center" | '''Register<br/>''' |
− | + | | YES - Only used if the Host is set to dynamic. | |
− | | | + | NO - does not require that the branch office register with the PBX system. |
|- | |- | ||
− | | style=" | + | | style="text-align: center" |''' Enable As Trunk ''' |
− | + | | YES - Branched PBXs are able to dial calls out your PBXs trunks. | |
− | + | NO - Branched PBXs are not able to dial calls out your PBXs trunks. | |
− | |||
− | |||
− | |||
|- | |- | ||
− | | style=" | + | |style="text-align: center" | '''Trunk Settings''' |
− | + | |Check to Generate Ringing, Allow Call Recording, Allow CID Override, or Allow Outbound Transfer. Also allows you to set CID Override if this trunk is used in a branch connection. | |
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | | style=" | + | | style="text-align: center" | '''Enable Multisite Manager Connection<br/>''' |
− | + | | Defines if Multi-Site Call Manager functionality is enabled. This feature requires a license from IPitomy to be functional. | |
− | |||
− | |||
|- | |- | ||
− | | style=" | + | | style="text-align: center" | '''Qualify<br/>''' |
− | + | | The time in milliseconds that the PBX should check that the branch office is still online. Setting this to zero may increase Branch Office stability. | |
− | |||
− | |||
|- | |- | ||
− | | style=" | + | | style="text-align: center" | '''Enable IAX2 Trunking<br/>''' |
− | + | | Indicates whether to use IAX trunking. If enabled (YES), this setting can help eliminate packet overhead by cutting the cost of continuous communication.<br/> | |
− | |||
− | |||
|- | |- | ||
− | | style=" | + | | style="text-align: center" | '''Allow Codecs<br/>''' |
− | + | | Defines what codecs this branch office can use for calls. Priority for codecs are defined from top to bottom. | |
− | |||
− | |||
|- | |- | ||
− | | style=" | + | | style="text-align: center" | '''Class of Service<br/>''' |
− | + | | Allows for individual Branch Offices to use different COS. Setting to None will follow the default Branch Office COS defined under PBX SetupGeneral.<br/> | |
− | |||
− | |||
|} | |} | ||
− | + | [[File:branchofficepage.png]] | |
+ | ===Configuring Office 1=== | ||
'''STEPS:''' | '''STEPS:''' | ||
− | # Click on ''' | + | #Click on '''Destinations->Branch Offices'''. The '''Branch Offices''' page is displayed. |
− | # Click on the '''ADD office''' button. The '''Edit Branch Office''' page appears. | + | #Click on the '''ADD office''' button. The '''Edit Branch Office''' page appears. |
− | # Give a unique '''NAME''' for the connection. The name should only contain alpha-numeric characters and no spaces. It should be '''ONE WORD ONLY'''. | + | #Give a unique '''NAME''' for the connection. The name should only contain alpha-numeric characters and no spaces. It should be '''ONE WORD ONLY'''. |
− | # Enter the '''External IP''' of the PBX in the '''Host''' field. | + | #Enter the '''External IP''' of the PBX in the '''Host''' field. |
− | # Enter a unique '''DIALING PREFIX''' of an asterisk followed by two numbers. | + | #Enter a unique '''DIALING PREFIX''' of an asterisk followed by two numbers. |
− | # Give a unique '''PASSWORD''' for the connection. | + | #Give a unique '''PASSWORD''' for the connection. |
− | # Select '''NO''' for '''REGISTER '''(Note: that registration is not required if host is known). | + | #Select '''NO''' for '''REGISTER '''(Note: that registration is not required if host is known). |
− | # Configure '''Enable Trunking '''as needed. | + | #Configure '''Enable Trunking '''as needed. |
− | # Configure '''Enable Multisite Manager Connection''' as needed. | + | #Configure '''Enable Multisite Manager Connection''' as needed. |
− | # Set '''QUALIFY''' at '''0'''. | + | #Set '''QUALIFY''' at '''0'''. |
− | # Configure '''Enable IAX2 Trunking''' as needed. | + | #Configure '''Enable IAX2 Trunking''' as needed. |
− | # Click the button to save the changes. | + | #Click the [[File:savechanges.png]] button to save the changes. |
− | # Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database | + | #Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database |
− | + | ===Configuring Office 2=== | |
'''STEPS:''' | '''STEPS:''' | ||
− | # Click on ''' | + | #Click on '''Destinations->Branch Offices'''. The '''Branch Offices''' page is displayed. |
− | # Click on the '''ADD Office''' button. The '''Edit Branch Office''' page appears. | + | #Click on the '''ADD Office''' button. The '''Edit Branch Office''' page appears. |
− | # Enter a name in the '''NAME''' field that matches that given to the Office 1 PBX. The name should only contain alpha-numeric characters and no spaces. It should be '''ONE WORD ONLY'''. | + | #Enter a name in the '''NAME''' field that matches that given to the Office 1 PBX. The name should only contain alpha-numeric characters and no spaces. It should be '''ONE WORD ONLY'''. |
− | # Enter an '''external''' '''IP address''' or '''domain''' corresponding to the IP of the main office PBX in the '''HOST''' field. | + | #Enter an '''external''' '''IP address''' or '''domain''' corresponding to the IP of the main office PBX in the '''HOST''' field. |
− | # Enter a '''UNIQUE''' dialing prefix for the extensions connected to the Office 2 PBX. | + | #Enter a '''UNIQUE''' dialing prefix for the extensions connected to the Office 2 PBX. |
− | # The '''PASSWORD''' for Branch Office 2 needs to be the '''same''' as the one assigned in the Branch Office 1 PBX. | + | #The '''PASSWORD''' for Branch Office 2 needs to be the '''same''' as the one assigned in the Branch Office 1 PBX. |
− | # Select '''NO''' for '''REGISTER'''. | + | #Select '''NO''' for '''REGISTER'''. |
− | # Configure '''Enable Trunking '''as needed. | + | #Configure '''Enable Trunking '''as needed. |
− | # Configure '''Enable Multisite Manager Connection''' as needed. | + | #Configure '''Enable Multisite Manager Connection''' as needed. |
− | # Set '''QUALIFY''' at '''0'''. | + | #Set '''QUALIFY''' at '''0'''. |
− | # Configure '''Enable IAX2 Trunking''' as needed. | + | #Configure '''Enable IAX2 Trunking''' as needed. |
− | # Click the button to save the changes. | + | #Click the [[File:savechanges.png]] button to save the changes. |
− | # Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database | + | #Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database |
To setup additional Branch Offices in the PBX, use the steps outlined above. Keep in mind to use the same logic (pattern) and make sure that the dialing prefix is unique to each office. | To setup additional Branch Offices in the PBX, use the steps outlined above. Keep in mind to use the same logic (pattern) and make sure that the dialing prefix is unique to each office. | ||
− | === Edit Branch Office === | + | === Edit Branch Office<br/> === |
+ | |||
'''STEPS:''' | '''STEPS:''' | ||
− | # From the '''Destinations | + | #From the '''Destinations->Branch Office '''page, locate the schedule name that you want to edit. |
− | # Click on icon to the right of the '''Name '''of the Branch Office you want to update. The '''Edit Branch Office '''page appears. | + | #Click on [[File:penciledit.png]] icon to the right of the '''Name '''of the Branch Office you want to update. The '''Edit Branch Office '''page appears. |
− | # Edit the necessary parameters to configure the branch office. | + | #Edit the necessary parameters to configure the branch office. |
− | # Click the button to save the changes. | + | #Click the [[File:Savechanges.png]] button to save the changes. |
− | # Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database | + | #Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database |
+ | |||
+ | === Delete Branch Office<br/> === | ||
− | |||
'''STEPS:''' | '''STEPS:''' | ||
− | # From the '''Destinations | + | #From the '''Destinations->Branch Offices '''page, locate to the '''Name''' from the Branch Office listing that you want to remove. |
− | # Click on icon to the right of the '''Name '''of the '''Branch Office''' you want to delete. The Branch Office is removed from the listing page. | + | #Click on [[File:deleteselected.png]] icon to the right of the '''Name '''of the '''Branch Office''' you want to delete. The Branch Office is removed from the listing page. |
− | # Click the button to save the changes. | + | #Click the [[File:savechanges.png]] button to save the changes. |
− | # Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database | + | #Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database |
− | '''Branch Extensions''' | + | === '''Branch Extensions'''<br/> === |
Branch Extensions are created through the add extension field at the bottom of the branch office edit page. Branch extensions can be dialed directly without a prefix, provided that these extensions are properly configured on the PBX for which the branch extensions are defined. Branch extensions will appear in call routing drop down lists throughout the system after they are created. If needed, you can add Ring Group and Menu numbers as Branch Extensions. | Branch Extensions are created through the add extension field at the bottom of the branch office edit page. Branch extensions can be dialed directly without a prefix, provided that these extensions are properly configured on the PBX for which the branch extensions are defined. Branch extensions will appear in call routing drop down lists throughout the system after they are created. If needed, you can add Ring Group and Menu numbers as Branch Extensions. | ||
− | ==== Configuring Office 2 with Branch Extensions ==== | + | ==== Configuring Office 2 with Branch Extensions<br/> ==== |
+ | [[File:branchextensions.png]] | ||
'''STEPS:''' | '''STEPS:''' | ||
− | # Click on '''Destinations | + | #Click on '''Destinations->Branch Offices. '''The Branch Offices page appears. |
− | # Click on the '''Branch Office''' connection ('''Name''') assigned to Office 1. | + | #Click on the '''Branch Office''' connection ('''Name''') assigned to Office 1. |
− | # Assuming Office 1 has extension numbers 100 thru 110, enter the numbers 100 to 110 in the field above the Add button then click '''ADD'''. You will enter (add) each extension one at a time. '''Note: Using the format X-Y will add all extensions in the specified range.''' | + | #Assuming Office 1 has extension numbers 100 thru 110, enter the numbers 100 to 110 in the field above the Add button then click '''ADD'''. You will enter (add) each extension one at a time. '''Note: Using the format X-Y will add all extensions in the specified range.''' |
− | # If the extension number is valid (not already in use), the new extension will appear in the list of Branch Extensions. | + | #If the extension number is valid (not already in use), the new extension will appear in the list of Branch Extensions. |
− | # Click the button to save the changes. | + | #Click the [[File:Savechanges.png]] button to save the changes. |
− | # Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database. | + | #Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database. |
− | # Verify the new extension by calling the number from phones located (registered) at Branch Office 2. | + | #Verify the new extension by calling the number from phones located (registered) at Branch Office 2. |
To place a call from one Branch Office to another simply dial the prefix that was assigned to that locations PBX + the extension of the user trying to be reached at the other office. This same easy concept works for transferring calls from one Branch Office to another. Or, if you have the extension configured as a Branch Extension on your PBX, you can simply dial the extension number and it will be automatically routed to the branch. | To place a call from one Branch Office to another simply dial the prefix that was assigned to that locations PBX + the extension of the user trying to be reached at the other office. This same easy concept works for transferring calls from one Branch Office to another. Or, if you have the extension configured as a Branch Extension on your PBX, you can simply dial the extension number and it will be automatically routed to the branch. | ||
− | ==== View Branch Office Extensions ==== | + | ==== View Branch Office Extensions<br/> ==== |
+ | [[File:Showextensionspage.png]] | ||
+ | <br> | ||
'''STEPS:''' | '''STEPS:''' | ||
− | # From the '''Destinations''' | + | #From the '''Destinations'''->'''Branch Office '''page, click on the '''Show Extensions''' button located at the top of the Branch Office list page. |
− | # A popup window appears displaying all the extension information for each Branch Office that is currently in the system. | + | #A popup window appears displaying all the extension information for each Branch Office that is currently in the system. |
− | # Click on the “'''X'''” to close the popup window. | + | #Click on the “'''X'''” to close the popup window. |
+ | |||
+ | ==== Parking at a Branch ==== | ||
+ | In order to Park and retrieve parked calls at a Branch Office, you will have to do a little bit of programming. | ||
+ | |||
+ | '''Parking''' | ||
+ | *Create a Phantom Extension at the remote end PBX | ||
+ | *Add this as a Branch Extension in the local PBX | ||
+ | *Unconditionally Forward this ext to PSTN number ##700# | ||
+ | *When a user wants to park a call at the Branch Office, have them transfer the call to the Branch Extension | ||
+ | |||
+ | '''Retrieving Park''' | ||
+ | *Note the Branch Prefix Code | ||
+ | *To retrieve a call Parked at a branch, dial the prefix code plus the slot the call is parked in | ||
+ | **eg. With a Branch Prefix Code of *28 and a call Parked in 702, the user will dial *28702 to retrieve the call |
Revision as of 16:31, 25 October 2016
Branch Offices
Branch Offices provide a powerful tool for interconnecting PBX Systems. Through Branch Offices you can create a network of systems where dialing phones on remote systems is as easy as dialing local extensions. You can route calls inbound to a destination on any branched PBX, and outbound through the trunks of other systems networked in this way. Branch office extensions can even participate in ring groups.
IMPORTANT: Branch Offices communicate using IAX2 protocol over Port 4569. Refer to the Port Forwarding Configuration Table earlier in this manual for more information. |
Name |
The name that is associated with the branch office. Both sites involved in the Branch Office connection must use the same Name.
NOTE: This field will not allow spaces in the name. It must be all one word. Symbols can be used (i.e. underscore “_” dashes “-”, etc.) can be used in place of spaces. |
Host |
Enter the static IP of the system your PBX is connecting to. If they do not have a static IP address, enter the word dynamic. |
Dial Prefix |
The dial prefix must be an asterisk, plus two numbers (ie. *22). This prefix must be dialed to reach any destination on another PBX that has not been entered as a Branch Extension. |
Password |
This is the password that will allow access to the PBX. Both sites involved in the Branch Office connection must use the same Password. |
Register |
YES - Only used if the Host is set to dynamic.
NO - does not require that the branch office register with the PBX system. |
Enable As Trunk | YES - Branched PBXs are able to dial calls out your PBXs trunks.
NO - Branched PBXs are not able to dial calls out your PBXs trunks. |
Trunk Settings | Check to Generate Ringing, Allow Call Recording, Allow CID Override, or Allow Outbound Transfer. Also allows you to set CID Override if this trunk is used in a branch connection. |
Enable Multisite Manager Connection |
Defines if Multi-Site Call Manager functionality is enabled. This feature requires a license from IPitomy to be functional. |
Qualify |
The time in milliseconds that the PBX should check that the branch office is still online. Setting this to zero may increase Branch Office stability. |
Enable IAX2 Trunking |
Indicates whether to use IAX trunking. If enabled (YES), this setting can help eliminate packet overhead by cutting the cost of continuous communication. |
Allow Codecs |
Defines what codecs this branch office can use for calls. Priority for codecs are defined from top to bottom. |
Class of Service |
Allows for individual Branch Offices to use different COS. Setting to None will follow the default Branch Office COS defined under PBX SetupGeneral. |
Configuring Office 1
STEPS:
- Click on Destinations->Branch Offices. The Branch Offices page is displayed.
- Click on the ADD office button. The Edit Branch Office page appears.
- Give a unique NAME for the connection. The name should only contain alpha-numeric characters and no spaces. It should be ONE WORD ONLY.
- Enter the External IP of the PBX in the Host field.
- Enter a unique DIALING PREFIX of an asterisk followed by two numbers.
- Give a unique PASSWORD for the connection.
- Select NO for REGISTER (Note: that registration is not required if host is known).
- Configure Enable Trunking as needed.
- Configure Enable Multisite Manager Connection as needed.
- Set QUALIFY at 0.
- Configure Enable IAX2 Trunking as needed.
- Click the button to save the changes.
- Click the Apply Changes link located at the top right hand corner of the page, to commit the changes to the database
Configuring Office 2
STEPS:
- Click on Destinations->Branch Offices. The Branch Offices page is displayed.
- Click on the ADD Office button. The Edit Branch Office page appears.
- Enter a name in the NAME field that matches that given to the Office 1 PBX. The name should only contain alpha-numeric characters and no spaces. It should be ONE WORD ONLY.
- Enter an external IP address or domain corresponding to the IP of the main office PBX in the HOST field.
- Enter a UNIQUE dialing prefix for the extensions connected to the Office 2 PBX.
- The PASSWORD for Branch Office 2 needs to be the same as the one assigned in the Branch Office 1 PBX.
- Select NO for REGISTER.
- Configure Enable Trunking as needed.
- Configure Enable Multisite Manager Connection as needed.
- Set QUALIFY at 0.
- Configure Enable IAX2 Trunking as needed.
- Click the button to save the changes.
- Click the Apply Changes link located at the top right hand corner of the page, to commit the changes to the database
To setup additional Branch Offices in the PBX, use the steps outlined above. Keep in mind to use the same logic (pattern) and make sure that the dialing prefix is unique to each office.
Edit Branch Office
STEPS:
- From the Destinations->Branch Office page, locate the schedule name that you want to edit.
- Click on icon to the right of the Name of the Branch Office you want to update. The Edit Branch Office page appears.
- Edit the necessary parameters to configure the branch office.
- Click the button to save the changes.
- Click the Apply Changes link located at the top right hand corner of the page, to commit the changes to the database
Delete Branch Office
STEPS:
- From the Destinations->Branch Offices page, locate to the Name from the Branch Office listing that you want to remove.
- Click on icon to the right of the Name of the Branch Office you want to delete. The Branch Office is removed from the listing page.
- Click the button to save the changes.
- Click the Apply Changes link located at the top right hand corner of the page, to commit the changes to the database
Branch Extensions
Branch Extensions are created through the add extension field at the bottom of the branch office edit page. Branch extensions can be dialed directly without a prefix, provided that these extensions are properly configured on the PBX for which the branch extensions are defined. Branch extensions will appear in call routing drop down lists throughout the system after they are created. If needed, you can add Ring Group and Menu numbers as Branch Extensions.
Configuring Office 2 with Branch Extensions
- Click on Destinations->Branch Offices. The Branch Offices page appears.
- Click on the Branch Office connection (Name) assigned to Office 1.
- Assuming Office 1 has extension numbers 100 thru 110, enter the numbers 100 to 110 in the field above the Add button then click ADD. You will enter (add) each extension one at a time. Note: Using the format X-Y will add all extensions in the specified range.
- If the extension number is valid (not already in use), the new extension will appear in the list of Branch Extensions.
- Click the button to save the changes.
- Click the Apply Changes link located at the top right hand corner of the page, to commit the changes to the database.
- Verify the new extension by calling the number from phones located (registered) at Branch Office 2.
To place a call from one Branch Office to another simply dial the prefix that was assigned to that locations PBX + the extension of the user trying to be reached at the other office. This same easy concept works for transferring calls from one Branch Office to another. Or, if you have the extension configured as a Branch Extension on your PBX, you can simply dial the extension number and it will be automatically routed to the branch.
View Branch Office Extensions
- From the Destinations->Branch Office page, click on the Show Extensions button located at the top of the Branch Office list page.
- A popup window appears displaying all the extension information for each Branch Office that is currently in the system.
- Click on the “X” to close the popup window.
Parking at a Branch
In order to Park and retrieve parked calls at a Branch Office, you will have to do a little bit of programming.
Parking
- Create a Phantom Extension at the remote end PBX
- Add this as a Branch Extension in the local PBX
- Unconditionally Forward this ext to PSTN number ##700#
- When a user wants to park a call at the Branch Office, have them transfer the call to the Branch Extension
Retrieving Park
- Note the Branch Prefix Code
- To retrieve a call Parked at a branch, dial the prefix code plus the slot the call is parked in
- eg. With a Branch Prefix Code of *28 and a call Parked in 702, the user will dial *28702 to retrieve the call