TBwiki - User contributions [en]

Toolpack v2.3:Configuring a TMS Network System

2009-12-01T08:05:41Z

Ka-Lok Yeung: /* To configure a TMS Network */

Two TMS1600 Switches can be configured to operate a TMS Network, thereby providing redundancy backup. One TMS1600 Switch is configured as the primary switch while the other is configured as the secondary or backup switch.

== To configure a TMS Network ==

'''1. Select 'TMS Network' from the navigation panel.'''

[[Image:Navigation_Panel_v2.3_TMS_Network.png]]

The TMS network list is displayed.

'''2. Click Edit to access the TMS Network configuration window.'''

[[Image:Web_Portal_v2.3_TMS_Network_Edit.png|700px]]

'''3. Edit the parameters of the TMS Network
*Select the name of the primary switch from the Primary Adapter field. This switch will operate as the active or main switch.'''
*Select the name of the secondary switch from the Secondary Adapter field. This switch will function as the backup switch.
*If you enable "Use Link Switch Over", switchover between TMS port A and B would be allowed. (This should be enabled if dual TMS connection is available for redundancy.)
*If you enable "Use Link Switch Over Recovery", TMS port A would become active again when available if switch to port B has occurred. Leaving this option off will cause less switchovers, and thus less clock glitches through the TMS system, but will make unpredictable which port is active at a given time.
*If you enable "Use Clock Ref. Recovery", the system will use the highest available external clock source of the TMS system (by highest I mean the first one in the list in the "Clocking" configuration of Toolpack). If this option is off, the system will remain on any secondary clock reference even after the primary is back. This also cause less clock switchovers, but make unpredictable which external clock source is used at a given time.

*Click Save to save the configuration.

[[Image:Web_Portal_v2.3_TMS_Network_Create.png|700px]]

*The TMS Network was successfully created message is displayed.

[[Image:Web_Portal_v2.3_TMS_Network_Successful.png|700px]]

== Verifying Status ==
To verify the status of the TMS Network configuration, select Status from the Navigation panel.

Toolpack: How to Use RegEx in Called and Calling Number Mask

2009-10-28T03:55:49Z

Ka-Lok Yeung: /* Example 1 */

== The Rule ==
Any regular expression used in a called number mask or a calling number mask must be enclosed by two backslash characters (i.e., '/' ).

Please refer to [[Toolpack: Commonly Used Regular Expression Pattern|Commonly Used Regular Expression Pattern]] for the patterns that are typically used.

=== Example 1 ===
If you need to match a called number starts with the digits 450 and then 7 other digits, please put this in the called number mask:

/^450[0-9]{7}$/

^ means the matching is done from the beginning of the number. $ means the matching is done to the end of then number.

450 is the exact prefix to match.

[0-9]{7} means there should be 7 occurrences of the digits 0 - 9.

=== Example 2 ===
In this example, we have to match a called number starts with optional 1, then digits 450 and then 7 other digits.

/^1?450[0-9]{7}$/

? means the preceding pattern, i.e. the digit '1', is optional.

=== Example 3 ===
In this example, we have to match a called number with 4 possible prefixs followed by 7 other digits.

/^(800|888|877|866)[0-9]{7}/

== Caution ==

It is recommended to use ^ and $ to specify the matching of beginning and end of the number if it is appropriate so as to avoid ambiguity in matching.

For example, if you specify the mask as /450[0-9]{7}/, the following numbers would match this mask and that may not be desirable.

* 864501234567 (the later part of the number matches the mask)
* 4501234567890 (more than 7 digits after '450' is still a match)

Toolpack:Profile SDP Description

2009-09-15T06:52:49Z

Ka-Lok Yeung: /* Media Announcement */

You can specify the Profile SDP Description to define which [[voice codecs]] are supported in the [[NAP]] using this Profile.

Here is the default Profile SDP Description.

m=audio 0 RTP/AVP 0 8 4 96 97 18 98 13
a=rtpmap:96 iLBC/8000
a=rtpmap:97 iLBC/8000
a=fmtp:97 mode=20
a=rtpmap:98 telephone-event/8000

Each line of the Profile SDP Description consists of text of the form <type>=<value>. <type> is always exactly one character and is case-significant. <value> is a structured text string whose format depends on <type>. It also will be case-significant unless a specific field defines otherwise. Whitespace is not permitted either side of the `=' sign. In general <value> is either a number of fields delimited by a single space character or a free format string.

In our Profile SDP Description, only 2 <type> are used.

===Media Announcement===

The format of media announcement is as follows.

:m=<media> <port> <transport> <fmt list>

*The first sub-field is the media type. Currently defined media for TMedia is "audio".

*The second sub-field is the transport port to which the media stream will be sent. In Toolpack, it is not specified in Profile SDP Description and therefore you should specify "0".

*The third sub-field is the transport protocol. For most of the application, you may specify it as "RTP/AVP" - the IETF's Realtime Transport Protocol using the Audio/Video profile carried over UDP.

*The fourth and subsequent sub-fields are media formats. For audio and video, these will normally be media payload types as defined in the RTP Audio/Video Profile. When a list of payload formats is given, this implies that all of these formats may be used in the session, but the first of these formats is the default format for the session. When the transport protocol is specified as "RTP/AVP", the payload format can be specified as either
**the payload type number for static payload types
**the payload type number along with additional encoding information for dynamically allocated payload types.

The payload type, which is carried in the actual RTP packet header, is used to identify the type of codec information carried in the packet. A list of payload type values for each codec is defined within RFC3551. Unfortunately, since the payload type field is only 7 bits-wide, all codecs cannot have a permanent payload type value understood universally by all VoIp systems. Therefore, some codecs have dynamic values that need to be negotiated through a call control or session control protocol such as SIP before the actual RTP session can take place.

Here is the list of codec payload type values per RFC3551.
<table border="1">
<tr><th>Codec</th><th>Payload type value</th></tr>
<tr><td>G.711 uLaw</td><td>0</td></tr>
<tr><td>G.723.1</td><td>4</td></tr>
<tr><td>G.711 aLaw</td><td>8</td></tr>
<tr><td>Comfort Noise</td><td>13</td></tr>
<tr><td>G.728</td><td>15</td></tr>
<tr><td>G.729AB</td><td>18</td></tr>
<tr><td>G.726-40</td><td>dynamic</td></tr>
<tr><td>G.726-32</td><td>2 or dynamic (depends on the network)</td></tr>
<tr><td>G.726-24</td><td>dynamic</td></tr>
<tr><td>G.726-16</td><td>dynamic</td></tr>
<tr><td>G.729EG</td><td>dynamic</td></tr>
<tr><td>AMR</td><td>dynamic</td></tr>
<tr><td>EVRC</td><td>dynamic</td></tr>
<tr><td>QCELP</td><td>dynamic</td></tr>
</table>

When you use dynamic payload types, you need to specify the additional encoding information using the attribute for media announcement.

===Attribute for Media Announcement===

A media description may have any number of attributes ("a=" fields) which are media specific. The format of attribute is as follows.

:a=<attribute>

:or

:a=<attribute>:<value>

Here are some examples of attributes.

====Dynamic payload type====

You specify the additional encoding information for dynamic payload type in the following format:

a=rtpmap:<payload type> <encoding name>/<clock rate>[/<encoding parameters>]

For audio streams, <encoding parameters> may specify the number of audio channels. This parameter may be omitted if the number of channels is one provided no additional parameters are needed.

====Other media specific attribute====

The use of other media specific attributes depends on the specification of the RTP payload format for the specific media type. Here are some example of attributes.

*a=fmtp:<format> <format specific parameters>

This attribute allows parameters that are specific to a particular format to be conveyed in a way that SDP doesn't have to understand them. The format must be one of the formats specified for the media. Format-specific parameters may be any set of parameters required to be conveyed by SDP and given unchanged to the media tool that will use this format.

*a=ptime:<packet time>

This gives the length of time in milliseconds represented by the media in a packet. This is probably only meaningful for audio data. It should not be necessary to know ptime to decode RTP or vat audio, and it is intended as a recommendation for the encoding/packetisation of audio. It is a media attribute, and is not dependent on charset.

====Examples====

Here are 2 examples of the attributes found in the default profile SDP description.

a=rtpmap:97 iLBC/8000
a=fmtp:97 mode=20

The above defines iLBC codec of 8000/sec sample rate with 20ms frame size.

a=rtpmap:98 telephone-event/8000

The above defines the [[DTMF]] relay using RFC2833.

==References==
*[http://www.ietf.org/rfc/rfc2327.txt rfc2327 - SDP: Session Description Protocol]
*[http://www.ietf.org/rfc/rfc3551.txt rfc3551 - RTP Profile for Audio and Video Conferences with Minimal Control]
*[http://www.ietf.org/rfc/rfc3952.txt rfc3952 - Real-time Transport Protocol (RTP) Payload Format for internet Low Bit Rate Codec (iLBC) Speech]
*[http://www.ietf.org/rfc/rfc2833.txt rfc2833 - RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals]

Toolpack:Profile SDP Description

2009-09-15T06:52:11Z

Ka-Lok Yeung: /* Media Announcement */

You can specify the Profile SDP Description to define which [[voice codecs]] are supported in the [[NAP]] using this Profile.

Here is the default Profile SDP Description.

m=audio 0 RTP/AVP 0 8 4 96 97 18 98 13
a=rtpmap:96 iLBC/8000
a=rtpmap:97 iLBC/8000
a=fmtp:97 mode=20
a=rtpmap:98 telephone-event/8000

Each line of the Profile SDP Description consists of text of the form <type>=<value>. <type> is always exactly one character and is case-significant. <value> is a structured text string whose format depends on <type>. It also will be case-significant unless a specific field defines otherwise. Whitespace is not permitted either side of the `=' sign. In general <value> is either a number of fields delimited by a single space character or a free format string.

In our Profile SDP Description, only 2 <type> are used.

===Media Announcement===

The format of media announcement is as follows.

:m=<media> <port> <transport> <fmt list>

*The first sub-field is the media type. Currently defined media for TMedia is "audio".

*The second sub-field is the transport port to which the media stream will be sent. In Toolpack, it is not specified in Profile SDP Description and therefore you should specify "0".

*The third sub-field is the transport protocol. For most of the application, you may specify it as "RTP/AVP" - the IETF's Realtime Transport Protocol using the Audio/Video profile carried over UDP.

*The fourth and subsequent sub-fields are media formats. For audio and video, these will normally be media payload types as defined in the RTP Audio/Video Profile. When a list of payload formats is given, this implies that all of these formats may be used in the session, but the first of these formats is the default format for the session. When the transport protocol is specified as "RTP/AVP", the payload format can be specified as either
**the payload type number for static payload types
**the payload type number along with additional encoding information for dynamically allocated payload types.

The payload type, which is carried in the actual RTP packet header, is used to identify the type of codec information carried in the packet. A list of payload type values for each codec is defined within RFC3551. Unfortunately, since the payload type field is only 7 bits-wide, all codecs cannot have a permanent payload type value understood universally by all VoIp systems. Therefore, some codecs have dynamic values that need to be negotiated through a call control or session control protocol such as SIP before the actual RTP session can take place.

Here is the list of codec payload type values per RFC3551
<table border="1">
<tr><th>Codec</th><th>Payload type value</th></tr>
<tr><td>G.711 uLaw</td><td>0</td></tr>
<tr><td>G.723.1</td><td>4</td></tr>
<tr><td>G.711 aLaw</td><td>8</td></tr>
<tr><td>Comfort Noise</td><td>13</td></tr>
<tr><td>G.728</td><td>15</td></tr>
<tr><td>G.729AB</td><td>18</td></tr>
<tr><td>G.726-40</td><td>dynamic</td></tr>
<tr><td>G.726-32</td><td>2 or dynamic (depends on the network)</td></tr>
<tr><td>G.726-24</td><td>dynamic</td></tr>
<tr><td>G.726-16</td><td>dynamic</td></tr>
<tr><td>G.729EG</td><td>dynamic</td></tr>
<tr><td>AMR</td><td>dynamic</td></tr>
<tr><td>EVRC</td><td>dynamic</td></tr>
<tr><td>QCELP</td><td>dynamic</td></tr>
</table>

When you use dynamic payload types, you need to specify the additional encoding information using the attribute for media announcement.

===Attribute for Media Announcement===

A media description may have any number of attributes ("a=" fields) which are media specific. The format of attribute is as follows.

:a=<attribute>

:or

:a=<attribute>:<value>

Here are some examples of attributes.

====Dynamic payload type====

You specify the additional encoding information for dynamic payload type in the following format:

a=rtpmap:<payload type> <encoding name>/<clock rate>[/<encoding parameters>]

For audio streams, <encoding parameters> may specify the number of audio channels. This parameter may be omitted if the number of channels is one provided no additional parameters are needed.

====Other media specific attribute====

The use of other media specific attributes depends on the specification of the RTP payload format for the specific media type. Here are some example of attributes.

*a=fmtp:<format> <format specific parameters>

This attribute allows parameters that are specific to a particular format to be conveyed in a way that SDP doesn't have to understand them. The format must be one of the formats specified for the media. Format-specific parameters may be any set of parameters required to be conveyed by SDP and given unchanged to the media tool that will use this format.

*a=ptime:<packet time>

This gives the length of time in milliseconds represented by the media in a packet. This is probably only meaningful for audio data. It should not be necessary to know ptime to decode RTP or vat audio, and it is intended as a recommendation for the encoding/packetisation of audio. It is a media attribute, and is not dependent on charset.

====Examples====

Here are 2 examples of the attributes found in the default profile SDP description.

a=rtpmap:97 iLBC/8000
a=fmtp:97 mode=20

The above defines iLBC codec of 8000/sec sample rate with 20ms frame size.

a=rtpmap:98 telephone-event/8000

The above defines the [[DTMF]] relay using RFC2833.

==References==
*[http://www.ietf.org/rfc/rfc2327.txt rfc2327 - SDP: Session Description Protocol]
*[http://www.ietf.org/rfc/rfc3551.txt rfc3551 - RTP Profile for Audio and Video Conferences with Minimal Control]
*[http://www.ietf.org/rfc/rfc3952.txt rfc3952 - Real-time Transport Protocol (RTP) Payload Format for internet Low Bit Rate Codec (iLBC) Speech]
*[http://www.ietf.org/rfc/rfc2833.txt rfc2833 - RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals]

Regular expression quick start guide

2009-09-15T06:36:53Z

Ka-Lok Yeung:

<table border="1" cellpadding="2">
<tr><th align="left" width="250">Regular Expression Pattern</th><th align="left">Explanations</th></tr>
<tr><td>^</td><td>Matches beginning of a line</td></tr>
<tr><td>$</td><td>Matches the end of a line</td></tr>
<tr><td>\d</td><td>Matches a digit</td></tr>
<tr><td>[characters]</td><td>Matches any single character between the brackets</td></tr>
<tr><td>re1|re2</td><td>Match either re1 or re2</td></tr>
<tr><td>re*</td><td>Matches zero or more occurrences of re</td></tr>
<tr><td>re+</td><td>Matches one or more occurrences of re</td></tr>
<tr><td>re?</td><td>Matches zero or one occurrences of re</td></tr>
<tr><td>Re{m,n}</td><td>Matches at least “m” and at most “n” occurrences of re</td></tr>
<tr><td>(...)</td><td>Parentheses are used to group regular expressions</td></tr>
<tr><td>\0, \1, \2, ...</td><td>Substitute the value matched by the nth grouped sub-expression, used in remapped fields.
</td></tr>
</table>

Here are some examples:

Add 2720 prefix:
/(\d+)/2720\1/
or
/([0-9]*)/2720\1/

Strip first 4 digits:
/([0-9]{4})([0-9]*)/\2/

== References ==

* [[Toolpack: How to Use RegEx in Called and Calling Number Mask|How to Use RegEx in Called and Calling Number Mask]]
* [[Toolpack: How to Use RegEx in Remapped Called and Calling Number Mask|How to Use RegEx in Remapped Called and Calling Number Mask]]

Regular expression quick start guide

2009-09-15T06:30:49Z

Ka-Lok Yeung:

Troubleshooting Toolpack

2009-09-03T06:41:52Z

Ka-Lok Yeung: /* Web portal */

This page contains pointers to help troubleshooting the Toolpack system.

== Installation ==

Problem:
: The Toolpack system does not start
*How to [[Toolpack_Installation:Validate_Toolpack_Installation|validate the Toolpack installation]]

Problem:
: I want to change the Ip Address of the TMG800/TMG3200 from static to DHCP or from DHCP to static.
*How to [[TBLinux:How to change_the_ip_address|change the IP address of a TMG800/TMG3200]]

Problem:
: I want to change the hostname of the server running Toolpack
*How to [[Toolpack_Installation:Change hostname]]

== Web portal ==

Problem:
: The web portal do not start or is not accessible.
*How to [[Toolpack_Troubleshooting:Web_Portal|troubleshoot the web portal]].
*How to get status of the system.
*How to change the configuration of the system.

Problem:
: I cannot perform addition or modification of configuration in the web portal. Usually this occurs in a new Toolpack Platform, for example, when new Toolpack software has been just installed on a host or a new TMG3200 is started up.
*How to [[Toolpack Troubleshooting:Cannot Add or Edit Configuration|solve this problem]].

Problem:
: Do not have permission to add features.
*How to modify system configuration

Problem:
: The system does not work properly with a copied configuration.
*How to [[Web_Portal:Configuration_Copy|copy a configuration]]

== Toolpack application suite ==

Problem:
:

== Calls ==
Problem:
: The Tmedia do not accept or generate calls
*How to get the protocol messages by [[Toolpack_Debug_Application:Tbsigtrace|using tbsigtrace]]

== How to gather all logs ==
Problem:
: Which application logs should I gathered?
*How to gathered logs with [[Toolpack_Debug_Application:Tbdebug|tbdebug]]

== How to submit a problem ==
Problem:
: Don't know what else to do
*Help our support team help you by giving as much information as possible [[Support:How_To_Submit_A_Problem]]

Toolpack Troubleshooting:Cannot Add or Edit Configuration

2009-09-03T06:40:29Z

Ka-Lok Yeung: /* Solution */

== Symptom ==

Normally we should be able to modify the configuration of Toolpack System through Web Portal. For example, we should be able to add hardware in the Hardware page by clicking the link "Create New Hardware" in the top left hand corner for the page as in the diagram below.

[[Image:Troubleshooting-CannotAdd-NormalCase.jpg|600px| ]]

However, I cannot modify the configuration. For example, in the Hardware page, the link "Create New Hardware" is not available as in the diagram below.

[[Image:Troubleshooting-CannotAdd-ProblemCase.jpg|600px| ]]

== Solution ==

This problem usually occurs in a new Toolpack Platform, for example, when you have just installed a new Toolpack software on a host or you have a new TMG3200.

The reason is that the active configuration is locked.

To solve this, first select Systems from the navigation panel. Select Edit on the configuration in the System List.

If you find that the checkbox of Lock active configuration is checked as in the diagram below, uncheck it and click the Save button to save.

[[Image:Troubleshooting-CannotAdd-HowToSolve.jpg|600px| ]]

Troubleshooting Toolpack

2009-09-03T06:39:58Z

Ka-Lok Yeung: /* Web portal */

This page contains pointers to help troubleshooting the Toolpack system.

== Installation ==

Problem:
: The Toolpack system does not start
*How to [[Toolpack_Installation:Validate_Toolpack_Installation|validate the Toolpack installation]]

Problem:
: I want to change the Ip Address of the TMG800/TMG3200 from static to DHCP or from DHCP to static.
*How to [[TBLinux:How to change_the_ip_address|change the IP address of a TMG800/TMG3200]]

Problem:
: I want to change the hostname of the server running Toolpack
*How to [[Toolpack_Installation:Change hostname]]

== Web portal ==

Problem:
: The web portal do not start or is not accessible.
*How to [[Toolpack_Troubleshooting:Web_Portal|troubleshoot the web portal]].
*How to get status of the system.
*How to change the configuration of the system.

Problem:
: I cannot perform addition or modification of configuration in the web portal. Usually this occurs in a new Toolpack Platform, for example, when you just installed a new Toolpack software on a host or you have a new TMG3200.
*How to [[Toolpack Troubleshooting:Cannot Add or Edit Configuration|solve this problem]].

Problem:
: Do not have permission to add features.
*How to modify system configuration

Problem:
: The system does not work properly with a copied configuration.
*How to [[Web_Portal:Configuration_Copy|copy a configuration]]

== Toolpack application suite ==

Problem:
:

== Calls ==
Problem:
: The Tmedia do not accept or generate calls
*How to get the protocol messages by [[Toolpack_Debug_Application:Tbsigtrace|using tbsigtrace]]

== How to gather all logs ==
Problem:
: Which application logs should I gathered?
*How to gathered logs with [[Toolpack_Debug_Application:Tbdebug|tbdebug]]

== How to submit a problem ==
Problem:
: Don't know what else to do
*Help our support team help you by giving as much information as possible [[Support:How_To_Submit_A_Problem]]

Toolpack Troubleshooting:Cannot Add or Edit Configuration

2009-09-03T06:37:23Z

Ka-Lok Yeung: Created page with '== Symptom == Normally we should be able to modify the configuration of Toolpack System through Web Portal. For example, we should be able to add hardware in the Hardware page b…'

== Symptom ==

Normally we should be able to modify the configuration of Toolpack System through Web Portal. For example, we should be able to add hardware in the Hardware page by clicking the link "Create New Hardware" in the top left hand corner for the page as in the diagram below.

[[Image:Troubleshooting-CannotAdd-NormalCase.jpg|600px| ]]

However, I cannot modify the configuration. For example, in the Hardware page, the link "Create New Hardware" is not available as in the diagram below.

[[Image:Troubleshooting-CannotAdd-ProblemCase.jpg|600px| ]]

== Solution ==

This problem usually occurs in new Toolpack Platform, for example, when you just installed a new Toolpack software on a host or you have a new TMG3200.

The reason is that the active configuration is locked.

To solve this, first select Systems from the navigation panel. Select Edit on the configuration in the System List.

If you find that the checkbox of Lock active configuration is checked as in the diagram below, uncheck it and click the Save button to save.

[[Image:Troubleshooting-CannotAdd-HowToSolve.jpg|600px| ]]

File:Troubleshooting-CannotAdd-ProblemCase.jpg

2009-09-03T06:25:30Z

Ka-Lok Yeung:

File:Troubleshooting-CannotAdd-NormalCase.jpg

2009-09-03T06:24:46Z

Ka-Lok Yeung:

File:Troubleshooting-CannotAdd-HowToSolve.jpg

2009-09-03T06:22:27Z

Ka-Lok Yeung:

Toolpack: How to Use RegEx in Remapped Called and Calling Number Mask

2009-09-03T06:00:00Z

Ka-Lok Yeung:

== The Rule ==

The remapped called number mask or remapped calling number mask must have 2 regular expressions, and it must be in the form of '/regexWithCapturingGroup/replaceString/'. In the first regular expression, you specify capturing groups using parentheses (...) while in the second regular expression, you specify how to remap the number by referencing the capturing group using \1, \2, etc.

Please refer to [[Toolpack: Commonly Used Regular Expression Pattern|Commonly Used Regular Expression Pattern]] for the patterns usually used.

== Example 1 ==

In the remapped called number mask, the following is specified.

/^(1?)450([0-9]{7})$/\1514\2/

The first regular expression, regexWithCapturingGroup, is '^(1?)450([0-9]{7})$'. There are 2 capturing groups. The first one is '(1?)', the optional digit '1'. The second one is '([0-9]{7})', the 7 digits following '450'.

The second regular expression, replaceString, is '\1514\2' which specifies how the remapped number is composed. The rule is that the digits in the called number which match the expressions in the capturing groups would be substituted in replaceString.

In this example, suppose the incoming call has the called number as '15141234567'. The digit '1' in the beginning matches the first capturing group '(1?)' and the digits '1234567' match the second capturing group '([0-9]{7})'. Therefore, the remapped called number would be '1' followed by '514' followed by '1234567', that is '15141234567'.

== Example 2 ==

This is a simpler example. The following remapped called number mask would remove the prefix '852' and keep the 8 digits following the prefix.

/^852([0-9]{8})$/\1/

Toolpack: How to Use RegEx in Called and Calling Number Mask

2009-09-03T05:59:24Z

Ka-Lok Yeung:

== The Rule ==

Any regular expression used in called number mask or calling number mask must be enclosed by two '/'.

Please refer to [[Toolpack: Commonly Used Regular Expression Pattern|Commonly Used Regular Expression Pattern]] for the patterns usually used.

== Example 1 ==

If you need to match a called number starts with the digits 450 and then 7 other digits, please put this in the called number mask:

/^450[0-9]{7}$/

^ means the matching is done from the beginning of the number. $ means the matching is done to the end of then number.

450 is the exact prefix to match.

[0-9]{7} means there should be 4 occurrences of the digits 0 - 9.

== Example 2 ==

In this example, we have to match a called number starts with optional 1, then digits 450 and then 7 other digits.

/^1?450[0-9]{7}$/

? means the preceding pattern, i.e. the digit '1', is optional.

== Example 3 ==

In this example, we have to match a called number with 4 possible prefixs followed by 7 other digits.

/^(800|888|877|866)[0-9]{7}/

== Caution ==

It is recommended to use ^ and $ to specify the matching of beginning and end of the number if it is appropriate so as to avoid ambiguity in matching.

For example, if you specify the mask as /450[0-9]{7}/, the following numbers would match this mask and that may not be desirable.

* 864501234567 (the later part of the number matches the mask)
* 4501234567890 (more than 7 digits after '450' is still a match)

Toolpack: How to Use RegEx in Remapped Called and Calling Number Mask

2009-09-03T05:48:07Z

Ka-Lok Yeung:

The remapped called number mask or remapped calling number mask must have 2 regular expressions, and it must be in the form of '/regexWithCapturingGroup/replaceString/'. In the first regular expression, you specify capturing groups using parentheses (...) while in the second regular expression, you specify how to remap the number by referencing the capturing group using \1, \2, etc.

Please refer to [[Toolpack: Commonly Used Regular Expression Pattern|Commonly Used Regular Expression Pattern]] for the patterns usually used.

== Example 1 ==

In the remapped called number mask, the following is specified.

/^(1?)450([0-9]{7})$/\1514\2/

The first regular expression, regexWithCapturingGroup, is '^(1?)450([0-9]{7})$'. There are 2 capturing groups. The first one is '(1?)', the optional digit '1'. The second one is '([0-9]{7})', the 7 digits following '450'.

The second regular expression, replaceString, is '\1514\2' which specifies how the remapped number is composed. The rule is that the digits in the called number which match the expressions in the capturing groups would be substituted in replaceString.

In this example, suppose the incoming call has the called number as '15141234567'. The digit '1' in the beginning matches the first capturing group '(1?)' and the digits '1234567' match the second capturing group '([0-9]{7})'. Therefore, the remapped called number would be '1' followed by '514' followed by '1234567', that is '15141234567'.

== Example 2 ==

This is a simpler example. The following remapped called number mask would remove the prefix '852' and keep the 8 digits following the prefix.

/^852([0-9]{8})$/\1/

Toolpack: How to Use RegEx in Remapped Called and Calling Number Mask

2009-09-03T04:21:35Z

Ka-Lok Yeung:

Any regular expression used in remapped called number mask or remapped calling number mask must have 2 regular expression in the form of /regexWithCapturingGroup/replaceString/'. In the first regular expression, you specify the capturing group using parentheses (...) while in the second regular expression, you specify how to remap the number by referencing the capturing group using \1, \2, etc.

Please refer to [[Toolpack: Commonly Used Regular Expression Pattern|Commonly Used Regular Expression Pattern]] for the patterns usually used.

Toolpack: How to Use RegEx in Called and Calling Number Mask

2009-09-03T04:21:18Z

Ka-Lok Yeung:

Any regular expression used in called number mask or calling number mask must be enclosed by two '/'.

Please refer to [[Toolpack: Commonly Used Regular Expression Pattern|Commonly Used Regular Expression Pattern]] for the patterns usually used.

== Example 1 ==

If you need to match a called number starts with the digits 450 and then 7 other digits, please put this in the called number mask:

/^450[0-9]{7}$/

^ means the matching is done from the beginning of the number. $ means the matching is done to the end of then number.

450 is the exact prefix to match.

[0-9]{7} means there should be 4 occurrences of the digits 0 - 9.

== Example 2 ==

In this example, we have to match a called number starts with optional 1, then digits 450 and then 7 other digits.

/^1?450[0-9]{7}$/

? means the preceding pattern, i.e. the digit '1', is optional.

== Example 3 ==

In this example, we have to match a called number with 4 possible prefixs followed by 7 other digits.

/^(800|888|877|866)[0-9]{7}/

Toolpack: How to Use RegEx in Remapped Called and Calling Number Mask

2009-09-03T04:14:41Z

Ka-Lok Yeung: Created page with 'Any regular expression used in remapped called number mask or remapped calling number mask must have 2 regular expression in the form of '/re1/re2/'. Please refer to [[Toolpack:…'

Any regular expression used in remapped called number mask or remapped calling number mask must have 2 regular expression in the form of '/re1/re2/'.

Please refer to [[Toolpack: Commonly Used Regular Expression Pattern|Commonly Used Regular Expression Pattern]] for the patterns usually used.

Regular expression quick start guide

2009-09-03T04:12:31Z

Ka-Lok Yeung:

Regular expression quick start guide

2009-09-03T04:12:10Z

Ka-Lok Yeung: Created page with '<table border="1" cellpadding="2"> <tr><th align="left" width="300">Regular Expression Pattern</th><th align="left">Explanations</th></tr> <tr><td>^</td><td>Matches beginning of …'

<table border="1" cellpadding="2">
<tr><th align="left" width="300">Regular Expression Pattern</th><th align="left">Explanations</th></tr>
<tr><td>^</td><td>Matches beginning of a line</td></tr>
<tr><td>$</td><td>Matches the end of a line</td></tr>
<tr><td>[characters]</td><td>Matches any single character between the brackets</td></tr>
<tr><td>re1|re2</td><td>Match either re1 or re2</td></tr>
<tr><td>re*</td><td>Matches zero or more occurrences of re</td></tr>
<tr><td>re+</td><td>Matches one or more occurrences of re</td></tr>
<tr><td>re?</td><td>Matches zero or one occurrences of re</td></tr>
<tr><td>Re{m,n}</td><td>Matches at least “m” and at most “n” occurrences of re</td></tr>
<tr><td>(...)</td><td>Parentheses are used to group regular expressions</td></tr>
<tr><td>\0, \1, \2, ...</td><td>Substitute the value matched by the nth grouped sub-expression, used in remapped fields.
</td></tr>
</table>

Toolpack: How to Use RegEx in Called and Calling Number Mask

2009-09-03T04:02:56Z

Ka-Lok Yeung: Created page with 'Any regular expression used in called number mask or calling number mask must be enclosed by two '/'. Please refer to [[Toolpack: Commonly Used Regular Expression Pattern|Common…'

Any regular expression used in called number mask or calling number mask must be enclosed by two '/'.

Please refer to [[Toolpack: Commonly Used Regular Expression Pattern|Commonly Used Regular Expression Pattern]] for the patterns usually used.

== Example 1 ==

Here are some examples.

If you need to match a called number starts with the digits 450 and then 7 other digits, please put this in the called number mask:

/^450[0-9]{7}$/

^ means the matching is done from the beginning of the number. $ means the matching is done to the end of then number.

450 is the exact prefix to match.

[0-9]{7} means there should be 4 occurrences of the digits 0 - 9.

== Example 2 ==

In this example, we have to match a called number starts with optional 1, then digits 450 and then 7 other digits.

/^1?450[0-9]{7}$/

? means the preceding pattern, i.e. the digit '1', is optional.

== Example 3 ==

In this example, we have to match a called number with 4 possible prefixs followed by 7 other digits.

/^(800|888|877|866)[0-9]{7}/

File:Menu-configurations.jpg

2009-09-03T03:21:14Z

Ka-Lok Yeung: uploaded a new version of "File:Menu-configurations.jpg"

Screenshot showing location of 'Configurations' menu item

File:Screenshot-list-of-routing-rules.jpg

2009-09-02T10:52:34Z

Ka-Lok Yeung: uploaded a new version of "File:Screenshot-list-of-routing-rules.jpg"

Screenshot showing list of routing rules

File:Screenshot-routing-rule-videotron-bell.jpg

2009-09-02T10:37:51Z

Ka-Lok Yeung: uploaded a new version of "File:Screenshot-routing-rule-videotron-bell.jpg"

Screenshot showing a routing rule for a 911 call from one NAP provider to another

Toolpack:Profile SDP Description

2009-08-24T08:09:15Z

Ka-Lok Yeung:

==Toolpack: Profile SDP Description==

You can specify the Profile SDP Description to define which codecs are supported in the NAP using this Profile.

Here is the default Profile SDP Description.

:m=audio 0 RTP/AVP 0 8 4 96 97 18 98 13
:a=rtpmap:96 iLBC/8000
:a=rtpmap:97 iLBC/8000
:a=fmtp:97 mode=20
:a=rtpmap:98 telephone-event/8000

Each line of the Profile SDP Description consists of text of the form <type>=<value>. <type> is always exactly one character and is case-significant. <value> is a structured text string whose format depends on <type>. It also will be case-significant unless a specific field defines otherwise. Whitespace is not permitted either side of the `=' sign. In general <value> is either a number of fields delimited by a single space character or a free format string.

In our Profile SDP Description, only 2 <type> are used.

===Media Announcement===

The format of media announcement is as follows.

:m=<media> <port> <transport> <fmt list>

*The first sub-field is the media type. Currently defined media for TMedia is "audio".

*The second sub-field is the transport port to which the media stream will be sent. In Toolpack, it is not specified in Profile SDP Description and therefore you should specify "0".

*The third sub-field is the transport protocol. For most of the application, you may specify it as "RTP/AVP" - the IETF's Realtime Transport Protocol using the Audio/Video profile carried over UDP.

*The fourth and subsequent sub-fields are media formats. For audio and video, these will normally be media payload types as defined in the RTP Audio/Video Profile. When a list of payload formats is given, this implies that all of these formats may be used in the session, but the first of these formats is the default format for the session. When the transport protocol is specified as "RTP/AVP", the payload format can be specified as either
**the payload type number for static payload types
**the payload type number along with additional encoding information for dynamically allocated payload types.

Here are a few examples of the payload type numbers.

<table border="1">
<tr><th>PT</th><th>encoding name</th></tr>
<tr><td>0</td><td>PCMU</td></tr>
<tr><td>4</td><td>G.723</td></tr>
<tr><td>8</td><td>PCMA</td></tr>
<tr><td>13</td><td>Comfort Noise</td></tr>
<tr><td>18</td><td>G.729</td></tr>
<tr><td>96-127</td><td>Dynamic</td></tr>
</table>

When you use dynamic payload types, you need to specify the additional encoding information using the attribute for media announcement.

===Attribute for Media Announcement===

A media description may have any number of attributes ("a=" fields) which are media specific. The format of attribute is as follows.

:a=<attribute>

:or

:a=<attribute>:<value>

Here are some examples of attributes.

====Dynamic payload type====

You specify the additional encoding information for dynamic payload type in the following format:

a=rtpmap:<payload type> <encoding name>/<clock rate>[/<encoding parameters>]

For audio streams, <encoding parameters> may specify the number of audio channels. This parameter may be omitted if the number of channels is one provided no additional parameters are needed.

====Other media specific attribute====

The use of other media specific attributes depends on the specification of the RTP payload format for the specific media type. Here are some example of attributes.

*a=fmtp:<format> <format specific parameters>

This attribute allows parameters that are specific to a particular format to be conveyed in a way that SDP doesn't have to understand them. The format must be one of the formats specified for the media. Format-specific parameters may be any set of parameters required to be conveyed by SDP and given unchanged to the media tool that will use this format.

*a=ptime:<packet time>

This gives the length of time in milliseconds represented by the media in a packet. This is probably only meaningful for audio data. It should not be necessary to know ptime to decode RTP or vat audio, and it is intended as a recommendation for the encoding/packetisation of audio. It is a media attribute, and is not dependent on charset.

====Examples====

Here are 2 examples of the attributes found in the default profile SDP description.

:a=rtpmap:97 iLBC/8000
:a=fmtp:97 mode=20

The above defines iLBC codec of 8000/sec sample rate with 20ms frame size.

:a=rtpmap:98 telephone-event/8000

The above defines the dtmf relay using rfc2833.

==References==
*[http://www.ietf.org/rfc/rfc2327.txt rfc2327 - SDP: Session Description Protocol]
*[http://www.ietf.org/rfc/rfc3551.txt rfc3551 - RTP Profile for Audio and Video Conferences with Minimal Control]
*[http://www.ietf.org/rfc/rfc3952.txt rfc3952 - Real-time Transport Protocol (RTP) Payload Format for internet Low Bit Rate Codec (iLBC) Speech]
*[http://www.ietf.org/rfc/rfc2833.txt rfc2833 - RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals]

Toolpack:Profile SDP Description

2009-08-24T08:08:53Z

Ka-Lok Yeung:

Toolpack:Profile SDP Description

2009-08-24T08:07:32Z

Ka-Lok Yeung: /* To configure a SIP profile / Profile SDP Description */

==Toolpack: Profile SDP Description==

You can specify the Profile SDP Description to define which codecs are supported in the NAP using this Profile.

Here is the default Profile SDP Description.

:m=audio 0 RTP/AVP 0 8 4 96 97 18 98 13
:a=rtpmap:96 iLBC/8000
:a=rtpmap:97 iLBC/8000
:a=fmtp:97 mode=20
:a=rtpmap:98 telephone-event/8000

Each line of the Profile SDP Description consists of text of the form <type>=<value>. <type> is always exactly one character and is case-significant. <value> is a structured text string whose format depends on <type>. It also will be case-significant unless a specific field defines otherwise. Whitespace is not permitted either side of the `=' sign. In general <value> is either a number of fields delimited by a single space character or a free format string.

In our Profile SDP Description, only 2 <type> are used.

===Media Announcement===

The format of media announcement is as follows.

:m=<media> <port> <transport> <fmt list>

*The first sub-field is the media type. Currently defined media for TMedia is "audio".

*The second sub-field is the transport port to which the media stream will be sent. In Toolpack, it is not specified in Profile SDP Description and therefore you should specify "0".

*The third sub-field is the transport protocol. For most of the application, you may specify it as "RTP/AVP" - the IETF's Realtime Transport Protocol using the Audio/Video profile carried over UDP.

*The fourth and subsequent sub-fields are media formats. For audio and video, these will normally be media payload types as defined in the RTP Audio/Video Profile. When a list of payload formats is given, this implies that all of these formats may be used in the session, but the first of these formats is the default format for the session. When the transport protocol is specified as "RTP/AVP", the payload format can be specified as either
**the payload type number for static payload types
**the payload type number along with additional encoding information for dynamically allocated payload types.

Here are a few examples of the payload type numbers.

<table border="1">
<tr><th>PT</th><th>encoding name</th></tr>
<tr><td>0</td><td>PCMU</td></tr>
<tr><td>4</td><td>G.723</td></tr>
<tr><td>8</td><td>PCMA</td></tr>
<tr><td>13</td><td>Comfort Noise</td></tr>
<tr><td>18</td><td>G.729</td></tr>
<tr><td>96-127</td><td>Dynamic</td></tr>
</table>

When you use dynamic payload types, you need to specify the additional encoding information using the attribute for media announcement.

===Attribute for Media Announcement===

A media description may have any number of attributes ("a=" fields) which are media specific. The format of attribute is as follows.

:a=<attribute>

:or

:a=<attribute>:<value>

Here are some examples of attributes.

====Dynamic payload type====

You specify the additional encoding information for dynamic payload type in the following format:

a=rtpmap:<payload type> <encoding name>/<clock rate>[/<encoding parameters>]

For audio streams, <encoding parameters> may specify the number of audio channels. This parameter may be omitted if the number of channels is one provided no additional parameters are needed.

====Other media specific attribute====

The use of other media specific attributes depends on the specification of the RTP payload format for the specific media type. Here are some example of attributes.

*a=fmtp:<format> <format specific parameters>

This attribute allows parameters that are specific to a particular format to be conveyed in a way that SDP doesn't have to understand them. The format must be one of the formats specified for the media. Format-specific parameters may be any set of parameters required to be conveyed by SDP and given unchanged to the media tool that will use this format.

*a=ptime:<packet time>

This gives the length of time in milliseconds represented by the media in a packet. This is probably only meaningful for audio data. It should not be necessary to know ptime to decode RTP or vat audio, and it is intended as a recommendation for the encoding/packetisation of audio. It is a media attribute, and is not dependent on charset.

Here are 2 examples of the attributes found in the default profile SDP description.

:a=rtpmap:97 iLBC/8000
:a=fmtp:97 mode=20

The above defines iLBC codec of 8000/sec sample rate with 20ms frame size.

:a=rtpmap:98 telephone-event/8000

The above defines the dtmf relay using rfc2833.

==References==
*[http://www.ietf.org/rfc/rfc2327.txt rfc2327 - SDP: Session Description Protocol]
*[http://www.ietf.org/rfc/rfc3551.txt rfc3551 - RTP Profile for Audio and Video Conferences with Minimal Control]
*[http://www.ietf.org/rfc/rfc3952.txt rfc3952 - Real-time Transport Protocol (RTP) Payload Format for internet Low Bit Rate Codec (iLBC) Speech]
*[http://www.ietf.org/rfc/rfc2833.txt rfc2833 - RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals]

[[Category:Glossary]]