Related Settings

Enterprise Telephony > Common > DialPlan > Configure

Enabling dial plan

If the dial plan is disabled, the legacy mode can still be applied.

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

Enable dial plan application	truefalse
Key: profile.setting.dialplan.enabled Description: This setting allows to enable the application of the new dial plan mode. Activating this mode will enable: - The retrieval of Skype for Business dial plan rules from SfB severs - The application of Skype for Business dial plan rules on SfB lines - The application of the dial plan defined in user profile thanks to the regular expression based rules settings Constraint: true: the dial plan configuration is taken into account and applied. The old dial plan mode (profile.setting.dialingrule.enabled) is disabled. false: The dial plan is not applied. The old dial plan mode can still be applied. Related settings: Dialplan rule pattern for a line (profile.setting.dialplan.x.y.pattern) Defines a dial plan rule translation for a line (profile.setting.dialplan.x.y.translation) Block dial plan translation for unmatched address (profile.setting.dialplan.block.unmatched.address) Enable dial plan application on a forward rule's target (profile.setting.dialplan.onforward) Defines if SfB dial plan rules are applied (profile.setting.dialplan.ignore.sfb) Dialplan default rule pattern (profile.setting.dialplan.default.y.pattern) Defines a default dial plan rule translation (profile.setting.dialplan.default.y.translation) Advanced Dial Plan for call log entries (profile.setting.calllogs.dialplantypes)

Configuring dial plan for specific line

A dial plan is a set of ordered normalization rules, which each associates a matching pattern to a translation rule.

Example:

A dial plan of three normalization rules for a line of extension 4242:

profile.setting.dialplan.4242.1.pattern = ^(\d{4})$

profile.setting.dialplan.4242.1.translation = +3249842$1

profile.setting.dialplan.4242.2.pattern = ^22(\d{4})$

profile.setting.dialplan.4242.2.translation = +2249842$1

profile.setting.dialplan.4242.3.pattern = ^(\d+)$

profile.setting.dialplan.4242.3.translation = $1

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

Dialplan rule pattern for a line
Key: profile.setting.dialplan.x.y.pattern Description: This setting allows to define a part of the dial plan for a line of extension x. A line can have multiple pattern/translations associated with. The y is therefore a placeholder for a positive integer representing the priority of this rule. A pattern is a regular expression against which an outbound calling address is matched. If there is a match, the calling address will be translated given the associated translation setting (profile.setting.dialplan.x.y.translation) This setting must always be defined along its associated setting: profile.setting.dialplan.x.y.translation Constraint: x: the line extension, optionally containing the sip domain. Example: 1234@sfbtest.local or simply 1234 if sfbtest.local is configured as default sip domain on this turret. y: the rule priority (1 has a greater priority than 10) pattern: A regular expression following the ECMAScript syntax Related settings: Enable dial plan application (profile.setting.dialplan.enabled) Defines a dial plan rule translation for a line (profile.setting.dialplan.x.y.translation) Block dial plan translation for unmatched address (profile.setting.dialplan.block.unmatched.address) Defines if SfB dial plan rules are applied (profile.setting.dialplan.ignore.sfb) Dialplan default rule pattern (profile.setting.dialplan.default.y.pattern) Defines a default dial plan rule translation (profile.setting.dialplan.default.y.translation)

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

Defines a dial plan rule translation for a line
Key: profile.setting.dialplan.x.y.translation Description: This setting allows to define a part of the dial plan for a line of extension x. A line can have multiple pattern/translations associated with. The y is therefore a placeholder for a positive integer representing the priority of this rule. The translation setting defines how the matching with the pattern's regular expression will be transformed. The translation can contain placeholders "$N" where N is an integer strictly equals or greater than 1. These placeholders will be interpolated with the group captured by the pattern regular expression. Example: original extension: 424140 rule pattern: ^42(\d{2})(\d{2}}$ rule translation: +321234$2$1 outbound extension: +3212344041 This setting must always be defined along its associated setting: profile.setting.dialplan.x.y.pattern Constraint: x: the line extension, optionally containing the sip domain. Example: 1234@sfbtest.local or simply 1234 if sfbtest.local is configured as default sip domain on this turret. y: the rule priority (1 has a greater priority than 10) Related settings: Enable dial plan application (profile.setting.dialplan.enabled) Dialplan rule pattern for a line (profile.setting.dialplan.x.y.pattern) Block dial plan translation for unmatched address (profile.setting.dialplan.block.unmatched.address) Defines if SfB dial plan rules are applied (profile.setting.dialplan.ignore.sfb) Dialplan default rule pattern (profile.setting.dialplan.default.y.pattern) Defines a default dial plan rule translation (profile.setting.dialplan.default.y.translation)

Configuring dial plan's default rules

A dial plan is a set of ordered normalization rules, which each associates a matching pattern to a translation rule.

Example:

A dial plan of three normalization rules for a line of extension 4242:

profile.setting.dialplan.default.1.pattern = ^(\d{4})$

profile.setting.dialplan.default.1.translation = +3249842$1

profile.setting.dialplan.default.2.pattern = ^22(\d{4})$

profile.setting.dialplan.default.2.translation = +2249842$1

profile.setting.dialplan.default.3.pattern = ^(\d+)$

profile.setting.dialplan.default.3.translation = $1

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

Dialplan default rule pattern
Key: profile.setting.dialplan.default.y.pattern Description: This setting allows to define a part of the default dial plan. The deafult rules are applied if no specific rules exist for the given line. A line can have multiple pattern/translations associated with. The y is therefore a placeholder for a positive integer representing the priority of this rule. A pattern is a regular expression against which an outbound calling address is matched. If there is a match, the calling address will be translated given the associated translation setting (profile.setting.dialplan.global.y.translation) This setting must always be defined along its associated setting: profile.setting.dialplan.default.y.translation Constraint: y: the rule priority (1 has a greater priority than 10) pattern: A regular expression following the ECMAScript syntax Related settings: Enable dial plan application (profile.setting.dialplan.enabled) Dialplan rule pattern for a line (profile.setting.dialplan.x.y.pattern) Defines a dial plan rule translation for a line (profile.setting.dialplan.x.y.translation) Block dial plan translation for unmatched address (profile.setting.dialplan.block.unmatched.address) Defines if SfB dial plan rules are applied (profile.setting.dialplan.ignore.sfb) Defines a default dial plan rule translation (profile.setting.dialplan.default.y.translation)

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

Defines a default dial plan rule translation
Key: profile.setting.dialplan.default.y.translation Description: This setting allows to define a part of the default dial plan. A line can have multiple pattern/translations associated with. The y is therefore a placeholder for a positive integer representing the priority of this rule. The translation setting define how the matching with the pattern's regular expression will be transformed. The translation can contain placeholders "$N" where N is an integer strictly equals or greater than 1. These placeholders will be interpolated with the group captured by the pattern regular expression. Example: original extension: 424140 rule pattern: ^42(\d{2})(\d{2}}$ rule translation: +321234$2$1 outbound extension: +3212344041 This setting must always be defined along its associated setting: profile.setting.dialplan.default.y.pattern Constraint: y: the rule priority (1 has a greater priority than 10) Related settings: Enable dial plan application (profile.setting.dialplan.enabled) Dialplan rule pattern for a line (profile.setting.dialplan.x.y.pattern) Defines a dial plan rule translation for a line (profile.setting.dialplan.x.y.translation) Block dial plan translation for unmatched address (profile.setting.dialplan.block.unmatched.address) Defines if SfB dial plan rules are applied (profile.setting.dialplan.ignore.sfb) Dialplan default rule pattern (profile.setting.dialplan.default.y.pattern)

Others settings

Dial plan - History

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

History - Internal extension length
Key: profile.setting.calllogs.internalnumberlength Description: The value defines the number of digits used for internal extension. It is obtained from the dial plan or numbering plan used in the IP PBX. It is used by the local dial plan feature to determine whether a prefix must be added when recalling a number from the missed or placed call history. It can be altered by IT administrators only. Please note that "History - International phone number length (profile.setting.calllogs.internationalnumberlength)" must also be configured properly to have the international/national outband prefix working correctly. Constraint: A numerical value Related settings: History - International phone number length (profile.setting.calllogs.internationalnumberlength) History - National outbound call prefix (profile.setting.calllogs.outgoingprefix) History - International outbound call prefix (profile.setting.calllogs.internationaloutgoingprefix) Add prefix when creating shortcuts from history (profile.setting.calllogs.addprefixtoshortcuts)

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

History - International phone number length
Key: profile.setting.calllogs.internationalnumberlength Description: The value defines the minimum number of digits used for international phone number. It is obtained from the dial plan or numbering plan used in the IP PBX and depends on the country. It is used by the local dial plan feature to determine whether a prefix must be added when recalling a number from the missed or placed call history. It can be altered by IT administrators only. Please note that "History - Internal extension length (profile.setting.calllogs.internalnumberlength)" must also be configured properly to have the international/national outband prefix working correctly. Constraint: Numerical value Related settings: History - Internal extension length (profile.setting.calllogs.internalnumberlength) History - National outbound call prefix (profile.setting.calllogs.outgoingprefix) History - International outbound call prefix (profile.setting.calllogs.internationaloutgoingprefix) Add prefix when creating shortcuts from history (profile.setting.calllogs.addprefixtoshortcuts)

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

History - International outbound call prefix
Key: profile.setting.calllogs.internationaloutgoingprefix Description: The value defines the prefix prepended to an international number when recalling it from the missed or placed calls history. It can be altered by IT administrators only. Constraint: A string value with digits and valid DTMF characters Related settings: History - Internal extension length (profile.setting.calllogs.internalnumberlength) History - International phone number length (profile.setting.calllogs.internationalnumberlength) History - National outbound call prefix (profile.setting.calllogs.outgoingprefix)

Location: Terminal Boot Settings, Terminal Profile Settings

Call History

History - International outbound use outboud call prefix	truefalse
Key: profile.setting.calllogs.addoutgoingoninternational Description: Defines if the outgoing prefix is automatically added before the international outgoing prefix when redialing a call to an international extension from history or creating a shortcut from an international call from history. Constraint: true\|false If true, the turret will use: [outgoing prefix] + [international outgoing prefix] + [phone extension] Otherwise, it will use: [international outgoing prefix] + [phone number]. Related settings: History - Internal extension length (profile.setting.calllogs.internalnumberlength) History - International phone number length (profile.setting.calllogs.internationalnumberlength) History - National outbound call prefix (profile.setting.calllogs.outgoingprefix) History - International outbound call prefix (profile.setting.calllogs.internationaloutgoingprefix) Add prefix when creating shortcuts from history (profile.setting.calllogs.addprefixtoshortcuts)

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

History - National outbound call prefix
Key: profile.setting.calllogs.outgoingprefix Description: The value defines the prefix prepended to a national number when recalling it from the missed or received calls history. It can be altered by IT administrators only. Constraint: A string value with digits and valid DTMF characters Related settings: History - Internal extension length (profile.setting.calllogs.internalnumberlength) History - International phone number length (profile.setting.calllogs.internationalnumberlength) History - International outbound call prefix (profile.setting.calllogs.internationaloutgoingprefix) Add prefix when creating shortcuts from history (profile.setting.calllogs.addprefixtoshortcuts)

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

Remove prefixes in placed call logs	truefalse
Key: profile.setting.calllogs.removeprefixfromoutgoing Description: Defines if prefixes are removed from numbers in call history placed entries. If enabled, the system will try to remove the longest prefix before logging the number. Prefixes to removed must be specified in the following key : profile.setting.shortcut.prefixes Constraint: true\|false Related settings: Ignored prefixes for calls (profile.setting.shortcut.prefixes) Remove prefixes in call logs (profile.setting.removeprefixinhistory)

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

Add prefix when creating shortcuts from history	truefalse
Key: profile.setting.calllogs.addprefixtoshortcuts Description: The rules for adding prefixes to call history entries are the same when redialing and when creating a shortcut. But other rules can be applied when dialing from shortcuts. To avoid applying both rules, set this key to false. Constraint: true \| false Related settings: History - Internal extension length (profile.setting.calllogs.internalnumberlength) History - International phone number length (profile.setting.calllogs.internationalnumberlength) History - National outbound call prefix (profile.setting.calllogs.outgoingprefix) Dial plan - Internal extension length (profile.setting.dialingrule.internalnumberlength) Dial plan - International phone number length (profile.setting.dialingrule.internationalnumberlength) Dial plan - National outbound call prefix (profile.setting.dialingrule.outgoingprefix) Dial plan - International outbound call prefix (profile.setting.dialingrule.internationaloutgoingprefix) Dial plan - Activate dial rule (profile.setting.dialingrule.enabled) Dial plan - Active from dialpad (profile.setting.dialingrule.fromdialpad) Dial plan - International outbound use outboud call prefix (profile.setting.dialingrule.addoutgoingoninternational) Dial plan - Activate dial rule on forward (profile.setting.dialingrule.onforward)

Ignored prefixes for calls

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

Ignored prefixes for calls
Key: profile.setting.shortcut.prefixes Description: The value indicates a list of characters sequences to be removed from call numbers in the programmable key database and from any inbound/outbound/replaced calls call number before scanning the database. This is intended to be used when telephony infrastructure requires different presentations for inbound and out bound calls. It can be altered by IT administrators only. Constraint: A list of characters sequences separated by a semi-colon Related settings: Remove prefixes in call logs (profile.setting.removeprefixinhistory) Remove prefixes from basic calls extensions (profile.setting.crm.basiccall.removeprefixes) Emergency extensions list (profile.setting.emergencyextensions)

Block dial plan translation for unmatched address

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

Block dial plan translation for unmatched address	truefalse
Key: profile.setting.dialplan.block.unmatched.address Description: Defines if unmatched address blocks the dial plan translation. If there are no rules matching a calling address for a given line, no translation will be applied by the dial plan. When enabled, this setting allows to block an outbound call when no match has been found. Constraint: true\|false Related settings: Enable dial plan application (profile.setting.dialplan.enabled) Dialplan rule pattern for a line (profile.setting.dialplan.x.y.pattern) Defines a dial plan rule translation for a line (profile.setting.dialplan.x.y.translation) Defines if SfB dial plan rules are applied (profile.setting.dialplan.ignore.sfb) Dialplan default rule pattern (profile.setting.dialplan.default.y.pattern) Defines a default dial plan rule translation (profile.setting.dialplan.default.y.translation)

Enable dial plan application on a forward rule's target

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

Enable dial plan application on a forward rule's target	truefalse
Key: profile.setting.dialplan.onforward Description: When setting up a forwarding rule, either a global forward with the forward access button or a partial forward from the DDI Line edition in the room panel; defines if the dial plan is applied. Note: This setting requires the dial plan to be enabled and configured (see profile.setting.dialplan.enabled) Constraint: true\|false Related settings: Allowed extensions for diverting/forwarding/dispatching (profile.setting.forward.whitelist) Enable dial plan application (profile.setting.dialplan.enabled)

ImportantNote_Icon

When 'Enable dial plan application on a forward rule's target' and 'Enable forward whitelist' are both enabled, turret checks if the target is matching an extension in the whitelist before and after applying the dial plan to it.

If at least one (with or without dial plan) is matching, the forward will be allowed.

Allow to ignore Skype for Business server's dial plan

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

Defines if SfB dial plan rules are applied	truefalse
Key: profile.setting.dialplan.ignore.sfb Description: This setting allows to turn off the application of dial plan rules configured on a Skype for Business server. When this setting is set to true, the dial plan application do not take into account rules coming from the Skype for Business servers. Instead, it only relies on the rules configured via the user profile's settings. Constraint: true\|false true: Rules coming from Skype for Business are ignored when applying dial plan. false: Rules coming from Skype for Business are active when applying dial plan. Related settings: Enable dial plan application (profile.setting.dialplan.enabled) Dialplan rule pattern for a line (profile.setting.dialplan.x.y.pattern) Defines a dial plan rule translation for a line (profile.setting.dialplan.x.y.translation) Block dial plan translation for unmatched address (profile.setting.dialplan.block.unmatched.address) Dialplan default rule pattern (profile.setting.dialplan.default.y.pattern) Defines a default dial plan rule translation (profile.setting.dialplan.default.y.translation)

Apply advanced dial plan for call log entries

Location: Terminal Boot Settings, Terminal Profile Settings

Dial Plan

Advanced Dial Plan for call log entries
Key: profile.setting.calllogs.dialplantypes Description: Defines if the advanced DIal Plan (based on Regular Expressions) is applied when redialing entries from the Call History. This setting allows selecting which call log type has Dial Plan applied. Constraint: List of types, separated by semicolons. Example: received;missed;placed Related settings: Enable dial plan application (profile.setting.dialplan.enabled)