- Brekeke PBX basic Info
- Security
- Update & Upgrade
- Configuration
- Brekeke PAL option
- Integration with Zoho Products
- Add-ons
- Troubleshooting
- Developer's Guides
- User's Guide
- Version History
4.5.2.8.Options
The following list displays the settings under the [Options] menu, which is only available to system administrators:
Settings
General Settings
| Name | Default value | Description |
| Start up | Auto | Auto: Brekeke PBX starts up automatically with the Tomcat (Brekeke PBX HTTP Service).
Manual: Start up manually. Options: Auto / Manual |
- From v 3.6.x, The [Start up] item is moved under [Start/Shutdown] menu as an [Auto Start] check box.
PBX System Settings
| Name | Default value | Description |
| Call pickup prefix | * | Prefix for picking up calls. |
| Port number | 5052 | Port number that Brekeke PBX will use.
Modify as needed to avoid port conflicts. |
| Max concurrent sessions | Depends on license | Maximum number of concurrent sessions that Brekeke PBX can handle (cannot be modified). |
| Max number of UAs (User Agents) | Depends on license | Maximum number of SIP UAs that Brekeke PBX can handle (cannot be modified). |
| Min RTP port | 30000 | Minimum port number the RTP Protocol uses for sending voice data. Adjust setting as needed. |
| Max RTP port | 49999 | Maximum port number the RTP uses for sending voice data. Adjust setting as needed. |
| RTP relay | on | on – RTP is handled by Brekeke PBX.
off – RTP is not handled by Brekeke PBX. (Applied unless there is a different RTP relay setting specified at the user phone type or the ARS Routes.) |
| SRTP | off | on – need to set [RTP relay] on, enable SRTP for all calls at Brekeke PBX system
off – applied unless there is a different SRTP setting specified at the user extension phone type or the ARS route [SRTP] field |
| Video | off | on – need to set [RTP relay] on, enable video for all calls at Brekeke PBX system
off – applied unless there is a different video setting specified at the user extension phone type or the ARS route [Video] field |
| Codec priority | 0 | G.711 u-law (PCMU) is used by default. When specifying multiple payloads, separate them with a comma (,). The following payload types can be used at Brekeke PBX:
0 – G.711 u-law 8 – G.711 A-law 18 – G.729 98 – iLBC If the codec priority is not set in ARS Routes or user phone type, this setting will be applied. From Brekeke PBX v3.3.x, Brekeke PBX supports dynamic payload type of iLBC even only payload 98 can be set for iLBC from Brekeke PBX Admintool [Codec priority] field. |
| Use remote preferred codec | no | Use the codec setting that is preferred at the remote SIP UA. If “default” is set in [Use Remote Preferred Codec] or in ARS or user phone type, this setting will be applied. |
| Max concurrent recording sessions | 10 | Maximum number of concurrent sessions with call recording. |
| Use user’s name as Display Name | Yes | Use user account name as display name. |
| Ringing timeout (ms) | 240000 | Amount of time to wait for an answer from the dialed party after ringing starts. |
| Talking timeout (ms) | 259200000 | Maximum length of time a call can last in talking, measured by the amount of time since the last SIP packet was received. Value 0 signifies infinite. |
| Max hop number | 20 | Maximum number of SIP servers or Brekeke PBX that a call can go through (hop number). |
| Days to keep call logs | 90 | Number of days to keep call logs. |
| Session Timer (sec, 0=disable) | 0 | Interval to allow UAs and SIP server to determine whether the SIP session is still active. |
| Session keep alive (sec) | 600 | Interval to send keep-alive packets to UAs during a call when RTP relay is set to off and session timer has not been used. |
| RTP Session Timeout (ms) | 600000 | Timeout value for Brekeke PBX awaiting the next RTP packet. |
| 100rel | off | Enable (on) / Disable (off) for using reliable provisional responses (1xx series). |
| RFC2833 | on | Enable (on) / Disable (off) RFC2833 setting. |
| Valid client IP pattern | Web service security – used by Brekeke PAL and Brekeke Web Service; Set with regular expressions of the PAL and Web Service clients IP pattern. | |
| Java VM arguments | Parameters passed to VM. |
Media Server System Settings
| Name | Default value | Description |
| Port number | 5056 | Port number that the Media server system uses.
Modify as needed to avoid port conflicts. |
| Max concurrent session limit | Depends upon the license | Maximum number of concurrent sessions for the Media server (cannot be modified). |
| Codec priority | 0 | G.711 u-law (PCMU) is used by default. Separate with comma (,) when specifying multiple codecs. Also see the PBX [Codec priority] description. |
| Use remote preferred codec | no | Enable (no) / Disable (yes) on using remote codec by the endpoints. |
| Max stored messages | 50 | Maximum number of saved voicemail messages, plus any recorded files for each user’s voicemail. |
| Message recording length (sec) | 600 | Maximum length of recording time for a voicemail message. If [Message recording length (sec)] in User setting is blank, this value will be applied. |
| Days to keep unsaved messages | 30 | Number of days before unsaved messages are deleted automatically from each user’s voicemail inbox. |
| Conversation recording length (sec) | 3600 | Maximum recording length for each call. |
| Conversation recording file in voicemail inbox | Yes | Yes – save recording file in user’s voicemail box.
No – don’t save recording file in user’s voicemail box, but show recording files in call logs. |
| Days to keep conversation recording files | 30 | This field will be enabled when [Conversation recording file in voicemail inbox] is set to No. |
| Min RTP port | 50000 | Minimum port number the RTP uses for sending voice data. |
| Max RTP port | 59999 | Maximum port number the RTP uses for sending voice data. |
| Ringing timeout (ms) | 240000 | Timeout value for awaiting an answer from the dialed party once the ringing starts. |
| Talking timeout (ms) | 259200000 | Maximum length of time a call can last in talking, measured by the amount of time since the last SIP packet was received. Value 0 signifies infinite. |
| RTP Session Timeout (ms) | 600000 | Timeout value for awaiting the next RTP packet. |
| Java VM arguments | Parameters passed to VM. |
- ms = 0.001 second
Email Settings
| Name | Default value | Description |
| SMTP Server | The SMTP server address for sending email notifications when the user receives a new voicemail message. | |
| SMTP port | 25 | SMTP server’s listening port. |
| SMTP authentication | on | Enable (on) / Disable (off) SMTP authentication setting. |
| Encrypted connection (SSL) | off | Enable (on) / Disable (off) Encrypted Connection (SSL), available in v2.3 or later. |
| POP3 server | Address of the POP3 server (for POP-before-SMTP authentication). | |
| POP3 port | 110 | POP3 server’s listening port. |
| User | Email account username for the above SMTP server. | |
| Password | Email account password. | |
| Password (confirm) | Input field for confirming the above password. | |
| Email address (from) | Email notification sender’s address. | |
| Email subject | voicemail({to}) : from {from} | Email subject for the email notifications.
The following variables can be configured: {from}: SIP URI who left the voicemail message {to}: voicemail box’s SIP URI {from-number}: number in {from} {to-number}: number in {to} {time}: time when the messaged is recorded {recording-length}: length in time of the recorded message |
| Email body | from:{from}
to:{to} time:{time} recording length(sec):{recording-length |
Email body for email notifications.
Variables that can be used in this field are the same as in the [Email subject] above. |
PAL Settings
| Name | Default value | Description |
| Notification for registration | yes | Sends notification to Brekeke PAL or Brekeke PAL WebSocket application (or not) when a user phone has registered. |
| PAL WebSocket | yes | This field has been available in v 3.4 or later.
Yes – PAL WebSocket is enabled. No – PAL WebSocket is disabled. |
| Valid WebSocket client IP Pattern | Web service security – used by Brekeke PAL WebSocket; Set with regular expressions of the WebSocket clients IP pattern. |
User Access Settings
Restricts the features and menus that are displayed and modifiable from a User or Admin account when the user logs into Brekeke PBX Admintool.
Phone Type
| Name | Default value | Description |
| Type name | Type 1
Type 2 Type 3 Web Phone* |
The default phone types that users can choose. User extension > [Phones] page [Type] field.
Default setting is Type 1. *[Web Phone] is added for v3.6 or later. This phone type is used when the bundled web phone is used. Currently in v3.6, the web phone is provided as a beta release. It will be provided as a standard release in v3.7. |
| Description | Describe phone type. | |
| WebRTC | no | When set to :yes, Brekeke PBX provides a WebRTC connection to WebRTC clients that have phones assigned to this Phone Type. |
| RTP relay | default | When set to default, user phones assigned with this phone type will apply the RTP relay setting in the [Options] menu.
When set to off, Brekeke PBX will not relay RTP for the user phones assigned with this phone type. |
| SRTP | default | default – user phones assigned with this phone type will apply the SRTP setting in the [Options] menu.
Optional – Both RTP and SRTP calls can be made with the user phones assigned with this phone type. Available with [RTP relay] on mandatory – only SRTP call will be made with the user phones assigned with this phone type. Available with [RTP relay] on off – Brekeke PBX will not enable SRTP for the calls with the user phones assigned with this phone type |
| Video | default | default – the user phones assigned with this phone type will apply the video setting in the [Options] menu.
On – Brekeke PBX will enable video for the calls of the user phones assigned with this phone type off – Brekeke PBX will not enable video for the calls of the user phones assigned with this phone type |
| Codec priority | The default setting will apply the [Codec Priority] setting in the [Options] menu.
Brekeke PBX will first apply the [Codec Priority] setting in the phone type assigned to user phones if the setting in the phone type is different from the one in the [Options] menu. |
|
| Use remote preferred codec | default | When set to default, the setting in the [Options] menu will be applied.
Brekeke PBX will first apply the setting in the phone type assigned to user phones if the setting in the phone type is different from the one in the [Options] menu. |
| Keypad commands | on | When set to on, the phones assigned with this phone type can use Brekeke PBX keypad commands, such as #9, #8, etc.
When set to off, the phones assigned with this phone type cannot use Brekeke PBX keypad commands. |
| MWI (NOTIFY without SUBSCRIBE) | off | When set to off, the phones assigned with this phone type can send SUBSCRIBE for MWI.
When set to on, the phones assigned with this phone type cannot send SUBSCRIBE for MWI. |
| Tag in Display Name | off | This feature has been available in v 3.4 or later.
Add as a prefix – Tag feature is enabled. Tag value is displayed as an added prefix of a “from” header on the devices assigned with this phone type. Replace – Tag feature is enabled. Tag value is displayed as a “from” header on the devices assigned with this phone type. Off – This feature is disabled. |
| Update remote party ID | off | When “re-INVITE” is set at this setting, remote-party ID will be updated with a re-INVITE request. This feature has been added in the v3.6 or later. |
| Stand-alone video client | off | Video client is available for use when this is set to “on”, a video client is available for use. This feature has been added in the v3.6 or later. |
| Phonebook for Display Name | Yes | If caller’s entry is in phone book, the first and last name registered in phonebook will be shown at callee’s device. |
| Properties | Set properties that do not have corresponding fields in Brekeke PBX Admintool. |
SA (MT Edition)
SA is the only system administrator in Brekeke PBX MT Edition. From the [SA] page, you can change the SA login password and set the system language.
- From v3.6, The [SA] section is integrated with [System Administrators] menu. With this change, multiple administrators can be created under one system.
Advanced
The [Advanced] field allows you to set properties that do not have corresponding fields in Brekeke PBX Admintool. Please refer to other manuals and tutorials regarding the type of properties that may be edited here.