System

In this chapter we will cover:

System extensions lists all local and remote UADs/Phones connected to the PBXware with the following details:

Table 3.1. Extensions

Field Description Example Field Type

Name

Full name of the user device is registered to

Peter Doyle

Display

Extension

UAD/Phone extension number

1111

Display

User Agent

UAD/Phone type

Sipura SPA-841

Display

Status

UAD/Phone system status

Active/Inactive

Display

Protocol

Protocol used by the UAD/Phone

SIP/IAX

Display

Edit UAD/Phone configuration

  Button

Delete UAD/Phone from the system

  Button


Add/Edit Extension

Procedure of adding a new system extension is divided into two steps. In first step UAD/Phone type and extension location needs to be provided.

[Tip] Tip

By default, 'Single Extension' will be created. 'Advanced Options' offer the facility to add multiple extensions as well. For more information check the 'Adding Multi Extensions' chapter.

Table 3.2. Add/Edit Extension

Field Description Example Field Type

UAD (User Agent Device)

Select the model of new system UAD/Phone.

In case that UAD/Phone is not listed here, navigate to 'Settings: UAD' Edit desired UAD/Phone and set its 'Status' to 'Active'. Now, that UAD/Phone will be available in this list.

Linksys SPA-941

Select box

Location

Select the location of new UAD/Phone

Location refers to whether UAD/Phone is in 'Local' or 'Remote' network.

Local/Remote

Select box


In second step, basic UAD/Phone information is set.

Table 3.3. Add/Edit Extension

Field Description Example Field Type

Extension

System extension number

By default, this field is automatically populated, but can be changed to any Extension number.

Setting '1008' here will create new system extension with the same network number. By default, this field is automatically populated, but can be changed to any Extension number.

[0-9]

Name

Full name of the person using the Extension. This name is sent in a Caller ID information

Setting 'Joanna Cox' here will show this name on other UAD/Phone display when the call is made

[a-z][0-9]

E-mail

Email address associated with the extension and used for various system notifications

Setting '[email protected]' here will transfer all Voicemail notifications, Extension PIN and other details to this email

[a-z][0-9]

Reset Inclusive

Reset extension inclusive minutes

Click on this button and confirm with 'Yes' to reset inclusive minutes.

  Button

Credit/Debit

Opens a window for adding extension credit/debit

Credit/Debit

  Button

Service Plan

Service plan applied to extension

Select among available service plans to apply its rates to extension

Select box

Username

Username used by the UAD/Phone for the registration with the PBXware

By default, this field is the same as Extension network number and cannot be changed.

In this case this value is set to '1008'.

[0-9]

Secret

Secret/Password used by the UAD/Phone for the registration with the PBXware

By default this field is automatically populated, but can be changed to any value

  [a-z][0-9]

PIN (Personal Identification Number)

Four digit number used for account authorization. NOTE: This number must always be four (4) digits long

If PIN for this extension is set to '8474', provide it when asked for it by the PBXware when checking your Voice inbox or other Enhanced Services

[0-9]


[Tip] Tip
  • After Extension is created, 'Permissions' group will be editable for the administration.

  • Do not paste a value to 'Name' and 'Email' fields but please type it in. If these values are pasted, 'Advanced options' will need to be opened and the system will prompt for missing values.

  • Once extension is created, 'Save & Email' button becomes available. This command sends Extension details on provided 'E-mail' address.

Search

Search bar filters extensions by name, e-mail and number

Table 3.4. Search Extensions

Field Description Example Field Type

Search

Search phrase

Provide a search phrase here and hit enter to filter the records

[a-z][0-9]

Name

Should search filter be applied to names UADs are registered to

Check the box to search the names Check box

E-mail

Should search filter be applied to email addressed associate with the UADs

Check the box to search the email addresses Check box

Number

Should search filter be applied to extension numbers

Check the box to search extension numbers Check box


Adding Multi Extensions

There are two ways to add multiple extensions to PBXware:

Table 3.5. Adding Multi Extensions

   
Manually

To create a list manually provide details to 'Name', 'Email', 'Ext', 'Secret', 'PIN' [, 'MAC'] fields and clicking the Add(+) icon.

Uploading a '.csv' file

To Upload a '.csv' file:

  • Open text editor on your desktop

  • Add following lines for example ('Name', 'Email', 'Ext', 'Secret', 'PIN' [, 'MAC'])

    John Doe,[email protected],4444,1234,4444

    Joanna Cox,[email protected],5555,2345,5555

  • Save file as 'ext.csv'

  • Click on the 'Browse' button

  • Select 'ext.csv' from Desktop

  • Click the 'Upload' button

  • New Extensions will be created


Table 3.6. 

Field Description Field Type
Single/Multiple Extension

Switch between the single and multi extension adding options

Option buttons


Advanced Options

General Fields

The following options are used frequently and are mostly required for normal extension operation. Some of these fields are pre-configured with the default values. It is not recommended to change these unless prompted for doing so while saving the changes.

Table 3.7. General Fields

Field Description Example Field Type

User Type

Extensions can be set to make calls only, receive calls only or both make and receive calls

Select 'User' to make the calls only; 'Peer' to receive the calls only; or 'Friend' for both, to make and receive calls

Select box

DTMF Mode (Dual Tone Multi-Frequency)

A specific frequency, consisting of two separate tones. Each key has a specific tone assign to it so it can be easily identified by a microprocessor.

This is a sound heard when dialing digits on touch-tone phones. Each phone has different 'DTMF Mode'.

By default, this field is populated automatically for supported devices. If adding other UAD/Phone select between 'inband', , 'rfc2833' or 'info' options

Select box

Context

Every system extension belongs to a certain system context. Context may be described as a collection/group of extensions. Default context used by the PBXware is 'default' and must not be used by custom extensions

Set this field to 'test' for example

[a-z] [0-9]

Status

Extension status/presence on the network

Rather then deleting the extension and then recreating it again later on, extension can be activated/deactivated using this field.

Setting this field to 'Not Active' will disable all calls to this extension.

Select Box


Authentication

These options are used for UAD/Phone authentication with the PBXware

Table 3.8. Authentication

Field Description Example Field Type

Username

Username used by the UAD/Phone for the registration with the PBXware

By default, this field is the same as extension network number and cannot be changed. In this case this value is set to '1008'.

[0-9]

Authname

Name used for authentication with sip provider

If you set this field to 12345 for example, sent SIP header will look like [email protected] for example

[0-9]

Secret

Secret/Password used by the UAD/Phone for the registration with the PBXware

By default this field is automatically populated, but can be changed to any value

[a-z][0-9]

PIN (Personal Identification Number)

Four digit number used for account authorization. NOTE: This number must always be four (4) digits long

If PIN for this extension is set to '8474', provide it when asked for it by the PBXware when checking your Voice inbox or other 'Enhanced Services'

[0-9]


Billing

These options are used for billing of incoming and outgoing calls. Extension is assigned to a service plan and its call rates, and additional billing options are set here as well.

Table 3.9. Billing

Field Description Example Field Type

Slave

Set whether two extensions should share the same billing funds

If ext 1000 has 100.00 in credit, enable this option and set 'Slave Account Code'='1001'. Now, any call made by these two extensions will take the credit off the 1000 extension

Option buttons

Slave Account Code

Set the slave account code (extension number) of the second extensions sharing the same billing funds

If ext 1000 has 100.00 in credit, enable this option and set 'Slave'='Yes' and set this field to '1001'. Now, any call made by these two extensions will take the credit off the 1000 extension

[0-9]

Reminder Balance

Account balance at which reminder should be sent to user

If this field is set to 10, user will receive email notification when account balance reaches this amount

[0-9]

Credit Limit

Maximum amount system will extend to billing account

If this field is set to '10' and account balance has dropped down to '0', your account will still have '10' units in available funds

[0-9]

Package Date (dd-mm-YYYY)

Inclusive minutes expiry date

If this field is set to 12-06-2007, inclusive minutes will be reset on that date. So, if all 5 inclusive minutes were used by user, on this day inclusive minutes will be reset back to 5 minutes

[dd-mm-YYY]


Billing Info

This information displays extension's billing information. Amount left, inclusive minutes left etc...

Table 3.10. Billing Info

Field Description Example Field Type

Account Balance

Displays available account balance - the exact sum spent by user

If user has a 100 units credit, 100 units + credit limit can be spent. If this amount displays negative value (e.g. -4.00000) that means that account balance has reached 0 and credit limit is being used

Display

Available Funds

Displays available account funds (account balance + credit limit)

If user account balance has a 100 units + 10 credit limit units, 110 units will be displayed here

Display

Inclusive Minutes Left

Displays left inclusive minutes

As long as there is any inclusive time left, billing is not calculated for outgoing calls.

You'll see the inclusive minutes left in following form '0d 0h 4m 25s'

Display

Creation Date

Extension creation date. NOTE: If your system was updated to 2.0 or newer version, old extensions will have this field displaying 'unknown' and all new extensions will display extension creation date

14-06-2007 12:30:36

Display

First Use Date

Date/Time of the first extension use

11 Jun 2007 18:58:25

Display

Last Use Date

Date/Time of the last extension use

11 Jun 2007 19:25:12

Display


Network Related

These options set important network related values regarding NAT, monitoring and security

Table 3.11. Network Related

Field Description Example Field Type

NAT (Network Address Translation)

Set the appropriate Extension - PBXware NAT relation

If extension 1000 is trying to register with the PBXware from a remote location/network and that network is behind NAT, select the appropriate NAT settings here:

  • yes - Always ignore info and assume NAT

  • no - Use NAT mode only according to RFC3581

  • never - Never attempt NAT mode or RFC3581 support

  • route - Assume NAT, don't send report

Option buttons

Qualify

Timing interval in milliseconds at which a 'ping' is sent to UAD/Phone or trunk, in order to find out its status(online/offline).

Set this option to '2500' to send a ping signal every 2.5 seconds to UAD/Phone or trunk. Navigate to 'Monitor: Extensions' or 'Monitor: Trunks' and check the 'Status' field

[0-9]

Host

Set the way UAD/Phone registers to PBXware.

Set this field to 'dynamic' to register UAD/Phone from any IP address. Alternately, IP address or hostname can be provided as well

[dynamic][a-z][0-9]

Default IP

Default UAD/Phone IP address

Even when the 'Host' is set to 'dynamic' this field may be set. This IP address will be used when dynamic registration could not been performed or when it times out. NOTE: UAD/Phone must be on static IP address.

[0-9]


Caller ID

Caller's name and number displayed here are sent to party you call and are shown on their UAD/Phone display. Information you see here is taken from extension number and user name. To set different Caller ID information please go to 'Enhanced services: Caller ID' and set new information there.

Table 3.12. Caller ID

Field Description Example Field Type

Set Caller ID

Enable 'Caller ID' service

Set this option to 'Yes' to enable the Caller ID service

Option buttons

Caller ID

Extension Number and Name that are displayed on dialed party UAD/Phone display

These options are read-only. Caller ID information can be changed only through 'Enhanced Services'

Read-only

Caller ID Presentation

The way Caller ID is sent by the Extension

If PBXware is connected to a third-party software and there are problems with passing the Caller ID information to it, applying different 'Caller ID Presentation' methods should sort out the problem

  Select box


Voicemail

These options mimic the functions of an answering machine but with many additional features added. Voice messages are saved on central file-system location instead on a UAD/Phone.

Table 3.13. Voicemail usage

Description

Accessing voice-box:

To access a voice-box dial '*123', enter extension PIN and follow the instructions.

Leaving a voice message:

When user is transferred to voice-box, 'Please leave your message after the tone. When done, hangup or press the # key' message will be heard. Two options are available:

  1. Leave a voice message(ended by pressing '#' key or by hanging up), or

  2. Reach an operator by dialing '0'

If '0' is dialed, 'Press 1 to accept this recording, otherwise please continue to hold' message will be heard. Two options are available:

  1. Press '1' to save your message, after which the operator will be dialed. 'Please hold while i try that extension' message will be heard, or

  2. Continue to hold, which will delete any left messages, after which the operator will be dialed. 'Message deleted, please hold while i try that extension' message will be heard.

File-system usage:

With continuous tone 60 seconds:

  • wav49 = 91.0kb

  • wav = 863.0kb

  • gsm = 91.0kb

With continuous silent tone 60 seconds:

  • wav49 = 0.38kb

  • wav = 3.0kb

  • gsm = 0.32kb


Table 3.14. Voicemail option

Field Description Example Field Type

Voicemail:

Enable the Voicemail service

When call is placed and no one picks up the handset after some time, calling party will be transferred to dialed extension voice box and offered to leave a voice message

  Option buttons

Mailbox:

Mailbox extension number

This value is the same as the extension number and cannot be modified

Readonly

Name:

Full name of the user associated with the voice box.

This value is the same as the 'Name' field and cannot be modified.

[a-z] [0-9]

PIN: (Personal Identification Number)

Password used for accessing voicemail. The value of this field is set under 'Authentication: PIN'.

When B wants to access his voicemail, he is asked to authenticate with personal 4(four) digit PIN.

[0-9]

E-mail:

E-mail address associated with the voice box. The value of this field is set under 'General: E-mail'.

When A calls B and leaves a voice message, B will get an email notification about new voice message on this email address.

[a-z] [0-9] [@._-]

Pager e-mail:

Pager e-mail address associated with the voice box.

When A calls B and leaves a voice message, B will get a pager email notification about new voice message on this email address.

[a-z] [0-9] [@._-]

Greeting message:

Greeting message played to users upon entering the voice box.

When A gets to B voice box, the selected 'Greeting message' is played to A before he is allowed to leave a message.

Select box

Reset Unavailable message:

Resets the user recorded/uploaded unavailable message.

Custom unavailable messages can be recorded through UAD/Phone or uploaded to voice box through 'Self Care'.

To revert to default system unavailable message select 'Yes' and save the extension settings.

Option buttons

Reset Busy message:

Resets the user recorded/uploaded busy message.

Custom busy messages can be recorded through UAD/Phone or uploaded to voice box through 'Self Care'.

To revert to default system busy message select 'Yes' and save the extension settings.

Option buttons

Skip Instructions:

Skip the instructions on how to leave a voice message.

Once user A reaches the dialed voice box, if this option is set to 'Yes', A will hear the 'Greeting message', and then be transferred directly to the 'beep' sound.

Option buttons

Attach:

Send the voice message as an attachment to user email.

Once B gets the new voice message, if this option is set to 'Yes', the message sound file will be attached to the new voicemail notification email.

Option buttons

Delete After E-mailing:

Delete voice message after sending it as an attachment to user email.

Once B gets the new voice message, if this option is set to 'Yes', the message will be deleted from the voice box after it has been emailed to B.

Option buttons

Say Caller ID:

Announce the extension number from which the voice message has been recorded.

If this option is set to 'Yes', when checking voicemail, 'From phone number {$NUMBER}' message will be heard.

Option buttons

Allow Review mode:

Allow B to review the voice message before committing it permanently to A's voice box.

B leaves a message on A's voice box, but instead of hanging up, he presses '#'. Three options are offered to B:

  • Press 1 to accept this recording

  • Press 2 to listen to it

  • Press 3 to re-record your message

Option buttons

Allow Operator:

Allow B to reach an operator from within the voice box.

B leaves a message on A's voice box, but instead of hanging up, B presses '#'.

'Press 0 to reach an operator' message played (Once '0' is pressed, user is offered the following options):

  • Press 1 to accept this recording (If selected, 'Your message has been saved. Please hold while I try that extension' is played and operator is dialed)

  • Or continue to hold (If B holds for a moment, 'Message deleted. Please hold while I try that extension' is played and operator is dialed)

Option buttons

Operator Extension:

Local extension number that acts as an operator.

If A's voice box has an option 'Allow Operator' set to 'Yes', all users dialing '#0' inside the voice box will reach this operator extension.

[0-9]

Play Envelope message:

Announces the Date/Time and the Extension number from which the message was recorded.

Once voice box is checked for new messages, if this option is set to 'Yes', 'Received at {$DATE}. From phone number {$NUMBER}' will be played, giving more details about the message originator.

Option buttons

Voicemail Delay:

How long to pause in seconds, before asking user for PIN/Password.

Some UADs/Phones have tendency to garble the beginning of a sound file. Therefore, user checking the voice box, when asked for password would hear '...sword' instead of 'Password'. Setting this field to 1-2 seconds will provide long enough gap to fix this anomaly.

[0-9]

Timezone:

Sets the correct date/time stamp.

NOTE: Timezones are taken from '/usr/share/zoneinfo' system directory

By setting the correct time zone, user would always be notified of the exact date/time voice message was left on their box. Set the correct time zone if user is located in different time zone then PBXware.

Select box


Groups

These options define who is allowed to pickup our calls, and whose calls we are allowed to pickup.

Table 3.15. Groups

Field Description Example Field Type

Call Group:

Set the Call Group extension belongs to.

Similar to 'Context' grouping, only this option sets to which call group extension belongs

Allowed range 0-63 [0-9] [,-]

Pickup Group:

Set groups extension is allowed to pickup.

Similar to 'Context' grouping, only this option sets the Call Groups extension is allowed to pickup by dialing '*8'.

  [0-9] [,-]


Example:

Extension A:

  • Call Group = 1

  • Pickup Group = 3,4

Extension B:

  • Call Group = 2

  • Pickup Group = 1

  • If A is ringing, B can pickup the ringing call by dialing '*8'.

  • If B is ringing, A cannot pickup the ringing call because B's Call Group = 2, and A can pickup only Call Groups 3,4

[Tip] Tip

Grouping works only within a technology(SIP to SIP or IAX to IAX).

Call Control

These options set the number of simultaneous incoming and outgoing extension calls.

Table 3.16. Call Control

Field Description Example Field Type

Incoming Limit:

Sets the maximum number of simultaneous incoming calls.

If extension receives more incoming calls then set here, they are all redirected to extension voice-box.

2 [0-9]

Outgoing Limit:

Sets the maximum number of simultaneous outgoing calls.

Outgoing call can be placed on hold and another call can be made from the same extension. However, this feature has to be supported by the UAD/Phone

2 [0-9]


Trunks

These options enable extension to use custom default trunks for all outgoing calls.

Table 3.17. Trunks

Field Description Field Type

Primary/Secondary/Tertiary Trunk:

Set the default trunks for all routes dialed from this extension.

If the connection is not established through the primary, secondary trunk is used etc. Default trunks can be set per extension and on the Default Trunks level. Please look at the 'Precedence' section.

Select box

Routes:

Set Extension default trunks 'per Destination/Country provider' (Routes: Example)

In case that some countries/providers are to be reached through non primary trunks, or when one of the default trunks needs to be given higher precedence over another, a route may be set for each destination provider.

Select box


Precedence

Settings:

  • Default Trunks: All System calls go through trunks defined here

  • MiniLCR: Overrides 'Default Trunks' and sets a specific trunk for a destination

Extensions:

  • Trunks: Overrides 'Settings: Default Trunks'

  • Routes: Overrides 'Settings: MiniLCR'

Routes: Example

The list of countries that start with letter 'A' is displayed when you click on a 'A' in the upper navigation. After the countries are listed, click on one of them to see default trunks for their providers. Once default trunk is selected for a provider, all calls made from that extension to set provider will be made using set trunk.

Permissions

In this chapter we will cover:

Destinations

These options grant/deny certain local/worldwide destinations, conferences, enhanced services or call monitoring to edited extension.

If the image below is displayed, all destinations are allowed for the user extension. Should extension permissions be changed, click 'Set destinations manually' button.

Manually, destinations are set through the following groups:

  • Remote - E164 PSTN destinations, ITSPs, other VoIP networks etc.

  • Local - All destinations within the system/network (Extensions, IVR, Queues, Conferences...).

  • Other Networks - Other PBX networks we are connected to.

Possible extension permissions to destinations are:

  • Authorized:

  • PIN Required:

  • Not Authorized:

Conferences

These options grant/deny access to PBXware conferences. Conferences allow multiple users to participate in a conversations simultaneously.

Possible extension permissions to destinations are:

  • Authorized:

  • PIN Required:

  • Not Authorized:

Edit

These options apply specific conference rules to user extension.

Table 3.18. Edit

Field Description Field Type

Set talk only mode:

Sets the talk only conference mode

If this option is enabled, conference calls coming from this extension will be allowed to talk only(no voice will be heard on the UAD/Phone).

Check box

Set listen only mode:

Sets the listen only conference mode

If this option is enabled, conference calls coming from the extension will be allowed to listen only(no voice will be sent from the UAD/Phone).

Check box

Set admin mode:

Sets the admin conference mode

If this option is enabled, conference calls coming from the extension will be treated with admin privileges.

Check box

Set marked mode:

Sets the marked conference mode

If this option is enabled, conference calls coming from the extension will be treated with less then admin, but higher then regular conference participants privileges.

Check box

Allow user to exit by pressing #:

If this option is enabled, user will be allowed to exit the conference by dialing the '#' key.

Check box

Allow user to exit with a valid single digit:

If this option is enabled, user will be allowed to exit the conference by dialing any digit.

Check box


Enhanced Services

In this chapter we will cover:

Precedence

Enhanced services are ordered by priority (marked by numbers 01, 02 ...). Higher the priority equals higher precedence of the enhanced service. For example, due to a similarity of 'Follow Me' and 'Group Hunt' services, if both are enabled, 'Follow Me' will be executed due to higher precedence and not the 'Group Hunt'.

Accessibility

Each service has two or more accessibility options:

  • Unavailable

  • PIN Required

  • Available

Caller ID

Custom Caller ID displayed on UAD/Phone display of the called party. Any information provided here will override default Caller ID (Extension number and user name)

Table 3.19. Caller ID

Field Description Example Field Type

System/Network Caller ID:

Information provided here will replace default Caller ID information on System/Network level

Set this option to 'JaKe 2007' and call extension 1005 for example. On the display of the 1005 UAD/Phone, 'JaKe 2007' will be displayed as a caller id information on system/network level

[a-z][0-9]

Trunk CallerID:

For each trunk available on the system there will be a field in which you may set custom caller id data that is used when calling over that specific trunk

  [a-z][0-9]


Call Pickup

Table 3.20. Call Pickup

Field Description Example Field Type

Call Pickup:

This service enables user to pickup ringing calls of the same call group

Dial '*8' to pickup a call from the same call group, or '*88 + $EXTENSION' to pickup calls from different call groups

Option buttons


Example:

Extension A:

  • Call Group = 1

  • Pickup Group = 3,4

Extension B:

  • Call Group = 2

  • Pickup Group = 1

  • If A is ringing, B can pickup the ringing call by dialing '*8'.

  • If B is ringing, A cannot pickup the ringing call because B's call group = 2, and A can pickup only call groups 3,4

[Tip] Tip

Grouping works only within a technology(SIP to SIP or IAX to IAX).

Last Caller

Table 3.21. Last Caller

Field Description

Last Caller:

This service will dial the last extension that was calling you. For example, dial '*149' to hear the extension number and then press '0' to call that number

NOTE: Access code for this service can be customized through 'Settings: Access Codes'.


Call Filters & Blocking

This service filters and blocks all incoming calls based on a set of rules. For example, calls can be filtered based on whether they are anonymous, belong to specific caller or telemarketer.

[Tip] Tip

Access code for this service can be customized through 'Settings: Access Codes'.

Table 3.22. Call Filters & Blocking

Field Description Example Field Type

Anonymous Calls:

Action taken once anonymous (call without Caller ID) is received

If 'Always Busy' is selected, all calls without Caller ID information will hear the Busy signal

Select option

Specific callers:

Action taken once specific number dials

If this field is set to '1000' and action taken is 'Busy', once the extension 1000 dials in, Busy signal will be heard

Select option

Telemarketer block:

Set to 'Yes' to block the telemarketer calls.

  Select option


Do Not Disturb

This service temporarily redirects all incoming calls to set destination number. For example, if you wish not to be disturbed, you may activate this service, Set 'Destination'='Voicemail', enter '1000' in the field bellow and set 'Duration'='1'. This will redirect all calls coming to your extension to voice inbox of the extension 1000.

Table 3.23. Do Not Disturb

Field Description Example Field Type

Do Not Disturb:

Activate the DND service

This service can be set only on a temporary basis. Select 'Temporary' to activate it

Option buttons

Destination:

Destination to be dialed once DND is enabled

Select between 'Voicemail' or 'Call forward'. If Voicemail is set, then in the field bellow type the voice mailbox number, '1002' for example

[0-9]

Duration:

Time in hours DND service will be active for

Set '1' to enable the service for one hour

[0-9]


Call Forwarding

This service forwards calls to other extensions depending on extension response/status. For example, calls can be forwarded to other extensions(local/remote) or voice boxes unconditionally, or only if extension is busy, when nobody answers the call or when line is unavailable.

[Tip] Tip

Access code for 'Unconditional Call Forwarding' can be customized through 'Settings: Access Codes'.

Table 3.24. Call Forwarding

Field Description Example Field Type

Play Call Forwarding Message:

Notify users of a transfer being made

If this option is set to 'Yes', the caller would hear a 'Please wait, your call is being forwarded. You're not being charged for the forwarding part of the call' message, notifying user that a transfer is being made

Option buttons

Unconditional:

Forward all incoming calls

Calls can be forwarded to other extension numbers(Local or Remote) and to local voicemail boxes no matter who is calling

 

Busy:

Forward all incoming calls if the extension is busy

Calls can be forwarded to other extension numbers(Local or Remote) and to local voicemail boxes if the line has reached the maximum incoming calls limit

Option button

No Answer:

Forward all incoming calls if the extension doesn't answer the incoming call

Calls can be forwarded to other extension numbers(Local or Remote) and to local voicemail boxes if no one answers the call.

Option button

Line Unavailable:

Forward all incoming calls if the line is unavailable

In case your line gets cut off or from any reason you cannot connect UAD/Phone to system, all calls that were supposed to reach you can be redirected to extension/voice box number set here

Option button


Follow Me

This service rings all provided destinations in a sequence. If call is not answered by any of the provided extensions, call gets transferred to 'Last Destination' extension

Example: For extension 5555 we have set the following extensions under 'Priority' fields: 1000, 1001, 1002 and cell phone 55510205. When someone calls extension 5555, extension 1000 will ring for 'Timeout' number of seconds. If noone answers extensions 1001 is dialled etc. If none of the priority extensions answers the call, 'Last Destination' extension is called.

[Tip] Tip

If placing calls to mobile/proper number it may take 2-3 seconds until call is placed over Zaptel

Table 3.25. Follow Me

Field Description Example Field Type

Priority *:

Local/Proper/Mobile numbers to be dialed

Enabling this option for extension 1005 and setting 'Priority 1' is set to '1008' and 'Priority 2' to '55510205' will dial local network number 1008. If no one answers during the 'Timeout' period local proper phone 55510205 is dialed etc...

[0-9]

Timeout:

Ring time in seconds

Time in seconds 'Priority' destinations will ring. If the call is not answered during this period, it gets transferred to next priority number

[0-9]

Dial Options:

Additional call properties

This service can be assigned additional call properties, such as allowing the called party to transfer the call etc

[a-z]

Last Destination:

The last destination number dialed if none of the 'Priority' numbers answers the call

Set this field to 1005. If none of the Priority extensions answers, extension 1005 is dialed

[0-9]


Dial Options:

  • t - Allow the called user to transfer the call by hitting #

  • T - Allow the calling user to transfer the call by hitting #

  • r - Generate a ringing tone for the calling party, passing no audio from the called channel(s) until one answers. Use with care and don't insert this by default into all your dial statements as you are killing call progress information for the user. Really, you almost certainly do not want to use this. Asterisk will generate ring tones automatically where it is appropriate to do so. 'r' makes it go the next step and additionally generate ring tones where it is probably not appropriate to do so.

  • R - Indicate ringing to the calling party when the called party indicates ringing, pass no audio until answered. This is available only if you are using kapejod's bristuff.

  • m - Provide Music on Hold to the calling party until the called channel answers. This is mutually exclusive with option 'r', obviously. Use m(class) to specify a class for the music on hold.

  • o - Restore the Asterisk v1.0 Caller ID behaviour (send the original caller's ID) in Asterisk v1.2 (default: send this extension's number)

  • j - Asterisk 1.2 and later: Jump to priority n+101 if all of the requested channels were busy (just like behaviour in Asterisk 1.0.x)

  • M(x) - Executes the macro (x) upon connect of the call (i.e. when the called party answers)

  • h - Allow the callee to hang up by dialing *

  • H - Allow the caller to hang up by dialing *

  • C - Reset the CDR (Call Detail Record) for this call. This is like using the NoCDR command

  • P(x) - Use the Privacy Manager, using x as the database (x is optional)

  • g - When the called party hangs up, exit to execute more commands in the current context.

  • G(context^exten^pri) - If the call is answered, transfer both parties to the specified priority; however it seems the calling party is transferred to priority x, and the called party to priority x+1

  • A(x) - Play an announcement (x.gsm) to the called party.

  • S(n) - Hangup the call n seconds AFTER called party picks up.

  • d: - This flag trumps the 'H' flag and intercepts any dtmf while waiting for the call to be answered and returns that value on the spot. This allows you to dial a 1-digit exit extension while waiting for the call to be answered - see also RetryDial

  • D(digits) - After the called party answers, send digits as a DTMF stream, then connect the call to the originating channel.

  • L(x[:y][:z]) - Limit the call to 'x' ms, warning when 'y' ms are left, repeated every 'z' ms) Only 'x' is required, 'y' and 'z' are optional. The following special variables are optional for limit calls: (pasted from app_dial.c)

    • + LIMIT_PLAYAUDIO_CALLER - yes|no (default yes) - Play sounds to the caller.

    • + LIMIT_PLAYAUDIO_CALLEE - yes|no - Play sounds to the callee.

    • + LIMIT_TIMEOUT_FILE - File to play when time is up.

    • + LIMIT_CONNECT_FILE - File to play when call begins.

    • + LIMIT_WARNING_FILE - File to play as warning if 'y' is defined. If LIMIT_WARNING_FILE is not defined, then the default behaviour is to announce ('You have [XX minutes] YY seconds').

  • f - forces callerid to be set as the extension of the line making/redirecting the outgoing call. For example, some PSTNs don't allow callerids from other extensions than the ones that are assigned to you.

  • w - Allow the called user to start recording after pressing *1 or what defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)

  • W - Allow the calling user to start recording after pressing *1 or what defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)

Group Hunt

This service rings all provided destinations at the same time. If call is not answered by any of the provided extensions, call gets transferred to 'Last Destination' extension.

Example: For extension 5555 we have set the following extensions under 'Priority' fields: 1000, 1001, 1002 and cell phone 55510205. When someone calls extension 5555, extension 1000, 1001, 1002 and cell phone 55510204 will ring at the same time for 'Timeout' number of seconds. If noone answers extensions 1001 is dialled etc. If none of the Priority extensions answers the call, 'Last Destination' extension is called.

[Tip] Tip

If placing calls to mobile/proper number it may take 2-3 seconds until call is placed over Zaptel

Table 3.26. Group Hunt

Field Description Example Field Type

Priority *:

Local/Proper/Mobile numbers to be dialed

Enabling this option for extension 1005 and setting 'Priority 1' is set to '1008' and 'Priority 2' to '55510205' will dial local network number 1008. If no one answers during the 'Timeout' period local proper phone 55510205 is dialed etc...

[0-9]

Timeout:

Ring time in seconds

Time in seconds 'Priority' destinations will ring. If the call is not answered during this period, it gets transferred to next priority number

[0-9]

Dial Options:

Additional call properties

This service can be assigned additional call properties, such as allowing the called party to transfer the call etc

[a-z]

Last Destination:

The last destination number dialed if none of the 'Priority' numbers answers the call

Set this field to 1005. If none of the priority extensions answers, extension 1005 is dialed

[0-9]


Dial Options:

  • t - Allow the called user to transfer the call by hitting #

  • T - Allow the calling user to transfer the call by hitting #

  • r - Generate a ringing tone for the calling party, passing no audio from the called channel(s) until one answers. Use with care and don't insert this by default into all your dial statements as you are killing call progress information for the user. Really, you almost certainly do not want to use this. Asterisk will generate ring tones automatically where it is appropriate to do so. 'r' makes it go the next step and additionally generate ring tones where it is probably not appropriate to do so.

  • R - Indicate ringing to the calling party when the called party indicates ringing, pass no audio until answered. This is available only if you are using kapejod's bristuff.

  • m - Provide Music on Hold to the calling party until the called channel answers. This is mutually exclusive with option 'r', obviously. Use m(class) to specify a class for the music on hold.

  • o - Restore the Asterisk v1.0 Caller ID behaviour (send the original caller's ID) in Asterisk v1.2 (default: send this extension's number)

  • j - Asterisk 1.2 and later: Jump to priority n+101 if all of the requested channels were busy (just like behaviour in Asterisk 1.0.x)

  • M(x) - Executes the macro (x) upon connect of the call (i.e. when the called party answers)

  • h - Allow the callee to hang up by dialing *

  • H - Allow the caller to hang up by dialing *

  • C - Reset the CDR (Call Detail Record) for this call. This is like using the NoCDR command

  • P(x) - Use the Privacy Manager, using x as the database (x is optional)

  • g - When the called party hangs up, exit to execute more commands in the current context.

  • G(context^exten^pri) - If the call is answered, transfer both parties to the specified priority; however it seems the calling party is transferred to priority x, and the called party to priority x+1

  • A(x) - Play an announcement (x.gsm) to the called party.

  • S(n) - Hangup the call n seconds AFTER called party picks up.

  • d: - This flag trumps the 'H' flag and intercepts any dtmf while waiting for the call to be answered and returns that value on the spot. This allows you to dial a 1-digit exit extension while waiting for the call to be answered - see also RetryDial

  • D(digits) - After the called party answers, send digits as a DTMF stream, then connect the call to the originating channel.

  • L(x[:y][:z]) - Limit the call to 'x' ms, warning when 'y' ms are left, repeated every 'z' ms) Only 'x' is required, 'y' and 'z' are optional. The following special variables are optional for limit calls: (pasted from app_dial.c)

    • + LIMIT_PLAYAUDIO_CALLER - yes|no (default yes) - Play sounds to the caller.

    • + LIMIT_PLAYAUDIO_CALLEE - yes|no - Play sounds to the callee.

    • + LIMIT_TIMEOUT_FILE - File to play when time is up.

    • + LIMIT_CONNECT_FILE - File to play when call begins.

    • + LIMIT_WARNING_FILE - File to play as warning if 'y' is defined. If LIMIT_WARNING_FILE is not defined, then the default behaviour is to announce ('You have [XX minutes] YY seconds').

  • f - forces callerid to be set as the extension of the line making/redirecting the outgoing call. For example, some PSTNs don't allow callerids from other extensions than the ones that are assigned to you.

  • w - Allow the called user to start recording after pressing *1 or what defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)

  • W - Allow the calling user to start recording after pressing *1 or what defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)

Speakerphone Page

Table 3.27. Speakerphone Page

Field Description Example Field Type

Enter extensions here:

This service enables the message transmit to multiple phones by dialing '*399'

Set this field to '1000,1001,1002' for example. Now dial*399. Extensions 1000,1001,1002 will be paged. If UAD/Phone supports it, the call will automatically go to the speakerphone, otherwise it will just ring

[0-9]


Example: Set this field to '1000,1001,1002' for example. Now dial*399. Extensions 1000,1001,1002 will be paged. If UAD/Phone supports it, the call will automatically go to the speakerphone, otherwise it will just ring

[Tip] Tip

Phones by default have 10 seconds to auto answer.

Instant Recording

This service enables instant call recording, started anytime during the conversation, by dialing *159. For example, with this service enabled, you may listen to any call made by extension 1000 for example. Simply dial *159 + 1000

[Tip] Tip

Access code for this service can be customized through 'Settings: Access Codes'

Table 3.28. Instant Recording

Field Description Example Field Type

Silent:

Should parties in conversation be informed that calls are being recorded

With active 'Instant Recording' service, dial *159 anytime during the active call. From the point when you dial this code, the call will be recorded.

Option buttons


Delete Recordings

This service enables user to delete recorded calls via 'Self Care: CDR'. For example, with this option enabled, user logs into self care, navigates to 'CDR', selects recorded message and clicks on 'Advanced: Delete Recordings'

Listen to Recordings

This service enables user to listed recorded calls via 'Self Care: CDR'. For example, with this option enabled, user logs into Self Care, navigates to 'CDR', selects recorded message and clicks on 'Listen' button. Selected sound file will be downloaded to local computer from where it can be played in preferred audio player

Remote Access

This service enables user access system from remote location. For example, IVR '1001' has the following options set, '4'='Remote access', 'Extensions'='Destination'. Once remote user enters the IVR through the trunk and DID, he will press '4', type in his extension number and PIN number (both confirmed with '#') and dial any local, mobile or proper number.

Call Monitoring

This service monitors active calls in real time.

For example, extensions 1000 and 1001 are in conversation. Extension 1005 dials '*199 1000'. From that moment, active call and all other calls made by extension 1000 will be monitored by extension 1005, until 1005 hangs up.

Add/Edit

Click 'Add extension' button to add extension to monitoring list

Table 3.29. Add/Edit

Field Description Example Field Type

Extension:

Extension number that is to be monitored.

NOTE: By typing 'ALL' in this field, you'll be able to monitor all PBXware extensions

If you wish to monitor extension 1000, just provide extension number here. If PBXware contains hundreds of extensions it would be impractical to type all of them here. Instead type 'ALL' to monitor all of them.

[0-9] [ALL]

Permission:

Sets the way monitored extension is accessed

  • Access Granted - Monitor without providing PIN

  • PIN Required - Ask for PIN before monitoring other extension

  • No Access - Don't monitor this extension, but leave it in the 'Monitoring' window.

Select box


Auto Provisioning

These options enable PBXware to automatically provision UAD/Phone. Configuration files are downloaded from PBXware's TFTP server

Table 3.30. Auto Provisioning

Field Description Example Field Type

Auto Provisioning:

Enable auto provisioning service for this extension

Connect UAD/Phone to PBXware without any hassle by providing UAD/Phone MAC address( and optionally adding Static UAD/Phone IP address and network details)

Option Buttons

MAC Address( Media Access Control ):

UAD/Phone MAC address

Provide the UAD/Phone address here. Its a 48-bit hexadecimal number( 12 characters )

[a-z] [0-9]

DHCP ( Dynamic Hosts Configuration Protocol ):

Set whether UAD/Phone is on DHCP or Static IP address

Set DHCP = Yes if UAD/Phone is on dynamic or DHCP = No if UAD/Phone is on static IP address. If on static IP, you will have to provide more network details in the fields bellow.

Option buttons

Static IP:

Static UAD/Phone IP address

DHCP = No, has to be set. Provide the UAD/Phone static IP address here

[0-9][.]

Netmask:

UAD/Phone netmask

Netmask applied to UAD/Phone static IP address

[0-9][.]

Gateway:

Gateway IP address

Local area network gateway IP address

[0-9][.]

DNS Server1 and Server2( Domain Name Server ):

DNS Server IP address

Local area network DNS IP address( Usually the same as your gateway )

[0-9][.]


Call Properties

These options fine-tune incoming/outgoing call settings.

Table 3.31. Call Properties

Field Description Example Field Type

Ringtime:

UAD/Phone ring time

Time in seconds UAD/Phone will ring before the call is considered unanswered( default: 32 )

[0-9]

Incoming Dial Options:

Advanced dial options for all incoming calls

Please see below for detail list of all available dial options( default: tr )

[a-z]

Outgoing Dial Options:

Advanced dial options for all outgoing calls

Please see below for detail list of all available dial options( default: empty )

[a-z]


Dial Options:

  • t - Allow the called user to transfer the call by hitting #

  • T - Allow the calling user to transfer the call by hitting #

  • r - Generate a ringing tone for the calling party, passing no audio from the called channel(s) until one answers. Use with care and don't insert this by default into all your dial statements as you are killing call progress information for the user. Really, you almost certainly do not want to use this. Asterisk will generate ring tones automatically where it is appropriate to do so. 'r' makes it go the next step and additionally generate ring tones where it is probably not appropriate to do so.

  • R - Indicate ringing to the calling party when the called party indicates ringing, pass no audio until answered. This is available only if you are using kapejod's bristuff.

  • m - Provide Music on Hold to the calling party until the called channel answers. This is mutually exclusive with option 'r', obviously. Use m(class) to specify a class for the music on hold.

  • o - Restore the Asterisk v1.0 Caller ID behaviour (send the original caller's ID) in Asterisk v1.2 (default: send this extension's number)

  • j - Asterisk 1.2 and later: Jump to priority n+101 if all of the requested channels were busy (just like behaviour in Asterisk 1.0.x)

  • M(x) - Executes the macro (x) upon connect of the call (i.e. when the called party answers)

  • h - Allow the callee to hang up by dialing *

  • H - Allow the caller to hang up by dialing *

  • C - Reset the CDR (Call Detail Record) for this call. This is like using the NoCDR command

  • P(x) - Use the Privacy Manager, using x as the database (x is optional)

  • g - When the called party hangs up, exit to execute more commands in the current context.

  • G(context^exten^pri) - If the call is answered, transfer both parties to the specified priority; however it seems the calling party is transferred to priority x, and the called party to priority x+1

  • A(x) - Play an announcement (x.gsm) to the called party.

  • S(n) - Hangup the call n seconds AFTER called party picks up.

  • d: - This flag trumps the 'H' flag and intercepts any dtmf while waiting for the call to be answered and returns that value on the spot. This allows you to dial a 1-digit exit extension while waiting for the call to be answered - see also RetryDial

  • D(digits) - After the called party answers, send digits as a DTMF stream, then connect the call to the originating channel.

  • L(x[:y][:z]) - Limit the call to 'x' ms, warning when 'y' ms are left, repeated every 'z' ms) Only 'x' is required, 'y' and 'z' are optional. The following special variables are optional for limit calls: (pasted from app_dial.c)

    • + LIMIT_PLAYAUDIO_CALLER - yes|no (default yes) - Play sounds to the caller.

    • + LIMIT_PLAYAUDIO_CALLEE - yes|no - Play sounds to the callee.

    • + LIMIT_TIMEOUT_FILE - File to play when time is up.

    • + LIMIT_CONNECT_FILE - File to play when call begins.

    • + LIMIT_WARNING_FILE - File to play as warning if 'y' is defined. If LIMIT_WARNING_FILE is not defined, then the default behaviour is to announce ('You have [XX minutes] YY seconds').

  • f - forces callerid to be set as the extension of the line making/redirecting the outgoing call. For example, some PSTNs don't allow callerids from other extensions than the ones that are assigned to you.

  • w - Allow the called user to start recording after pressing *1 or what defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)

  • W - Allow the calling user to start recording after pressing *1 or what defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)

Speakerphone Page Auto-Answer SIP Header

These options allow caller to use UAD in a public announce system. If UAD fully supports this service, call is accepted automatically and put on a loudspeaker.

Table 3.32. 

Field Description Example Field Type

Choose Device Type:

Set predefined UAD/Phone type for this extension

Header will be added automatically depending on the selected device

Select box

Custom Header:

Set custom UAD/Phone header for this extension

If one of the predefined headers do not work, you might want to try setting a custom header for this service. Custom header line to be used 'Call-Info:\;answer-after=0'

[a-z][0-9]


Codecs

Codecs are used to convert analog to digital voice signals and vice versa. These options set preferred codecs used by the extension.

[Tip] Tip

If some of the desired codecs is disabled (cannot be selected), navigate to 'Settings: Servers: Edit: Default Codecs' and enable them under the 'Local' group.

Table 3.33. 

Field Description Example Field Type

Disallow:

Set the codecs extension is not allowed to use

This field is very unique. In order to work properly, this setting is automatically set to 'Disallow All' and it cannot be modified

Read only

Allow:

Set the codecs extension is allowed to use

Only the codecs set under 'Settings: Server' will be available to choose from

Check box


Codecs:

  • ITU G.711 ulaw - 64 Kbps, sample-based, used in US

  • ITU G.711 alaw - 64 Kbps, sample-based, used in Europe

  • ITU G.723.1 - 5.3/6.3 Kbps, 30ms frame size

  • ITU G.726 - 16/24/32/40 Kbps

  • ITU G.729 - 8 Kbps, 10ms frame size

  • GSM - 13 Kbps (full rate), 20ms frame size

  • iLBC - 15Kbps,20ms frame size: 13.3 Kbps, 30ms frame size

  • Speex - 2.15 to 44.2 Kbps

  • LPC10 - 2.5 Kbps

  • H.261 Video - Used over ISDN lines with resolution of 352x288

  • H.263 Video - Low-bit rate encoding solution for video conferencing

  • H.263+ Video - Extension of H.263 that provides additional features that improve compression over packet switched networks.

Recording

This group of options is used for recording of all incoming/outgoing calls.

[Tip] Tip
  • Laws in some countries may require notifying the parties that their call is being recorded.

  • Recorded calls, marked with

    icon, can be accessed from 'Self Care Interface' or 'Reports: CDR' PBXware' menu.

  • Call are recorded in audio format set under 'Settings: Servers: Recordings Format'.

Table 3.34. Recording

Field Description Example Field Type

Record Calls:

Enable call recording service

Select 'Yes' to enable the service. All incoming/outgoing calls will be recorded. If using call recording with many extensions, check server disk space from time to time. Please see below for bit rates table.

Options buttons

Silent:

Set weather call recordings should be announced to parties in conversation.

If Silent=No, calling parties will hear 'Recorded' or 'This call is recorded' message before their conversation starts

Options buttons


Disk Space Used By Call Recording

With continuously tone 60 seconds:

  • wav49 = 84.5kb

  • wav = 833.0kb

  • gsm = 85.0kb

With continuously silent tone (without sound) 60 seconds:

  • wav49 = 84.0kb

  • wav = 827.0kb

  • gsm = 84.0kb

Presence

This option enables simple notification of device presence.

Supported UADs:

  • Snom 190(Firmware >= 3.60s), 320/360(Firmware >= 4.1)

  • Polycom IP30x/IP50x/IP600

  • Xten EyeBeam

  • Grandstream GXP2000 (Firmware >= 1.0.1.13)

  • Aastra 480i

  • Aastra 9133i

CLI:

> show hints
-= Registered Asterisk Dial Plan Hints =-
1009                : SIP/1009             State:Idle              Watchers  0
2001                : SIP/2001             State:Idle              Watchers  0
1020                : SIP/1020             State:InUse             Watchers  0
1016                : SIP/1016             State:Unavailable       Watchers  0
1008                : SIP/1008             State:Idle              Watchers  0
1006                : SIP/1006             State:Unavailable       Watchers  0
1000                : SIP/1000             State:Ringing           Watchers  0
1003                : SIP/1003             State:Unavailable       Watchers  0
1030                : SIP/1030             State:Unavailable       Watchers  0
1234                : IAX2/1234            State:Unavailable       Watchers  0
7777                : IAX2/7777            State:Idle              Watchers  0
1017                : IAX2/1017            State:Unavailable       Watchers  0
----------------
- 12 hints registered
                                                                        

Table 3.35. 

Field Description Example Field Type

Presence Enabled:

Returns the information whether phone is on call, ringing or offline(not registered).

Select 'Yes' to enable presence support but not that not all UADs/Phones support this feature

Option buttons


User Agent Auto Provisioning Template

This option allows adding of additional settings to auto-provisioning template. Auto-provisioning settings are generally defined in the 'Settings: UAD' and are custom set for each device.

NOTE: Unless absolutely sure, do not change or add to this template.

Additional Config

This option is used for providing additional config parameters for SIP, IAX and MGCP configuration files. Values provided here will be written into these configuration files.

NOTE: Unless absolutely sure, do not change or add to this template.

Credit/Debit

Table 3.36. Credit/Debit

Field Description Example Field Type

Type:

Billing type

Select whether billing is credit or debit

Select box

Amount:

Billing amount

If billing type is in Euros, and you add 100 here, 100 Euros will be added to extension amount

[0-9]

Ref No:

Billing reference number

Depending on how your company bills clients, invoice number can be assigned here for example

[a-z][0-9]

Notes:

Additional billing notes

  [a-z][0-9]

Send:

Finalize billing action

Fill all previous fields and click this button to add funds

Button


Once funds are added, following details will be displayed:

  • Date: Time and date of the payment

  • User: Username used for login into system of the user who added the funds

  • Ref No: Billing reference number

  • Notes: Additional billing notes

  • Amount: Amount of funds added

  • Type: Billing type