<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2023"><meta name="DC.rights.owner" content="(C) Copyright 2023"><meta name="DC.type" content="topic"><meta name="prodname" content="For Mediatrix Sentinel"><meta name="version" content="DGW 49.12.28842941"><meta name="platform" content="Sentinel"><meta name="DC.date.modified" content="2023-0308-2809"><meta name="DC.date.issued" content="2023-0308-2809"><meta name="DC.date.available" content="2023-0308-2809"><meta name="ChapterNumbering" content="no"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="topic_title_Basic_Configuration_Concepts_d1e15"><link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet"><link rel="stylesheet" type="text/css" href="https://documentation.media5corp.com/download/attachments/62825785/commonltr.css"><link rel="stylesheet" type="text/css" href="https://documentation.media5corp.com/download/attachments/62825785/custom.css"><title>Sbc Service User Guide</title></head><body class="nobody"><header role="banner"><div class="topicmeta title">Sbc Service User Guide</div><div class="topicmeta date">2023-0308-28<09</div><div class="topicmeta product">For Mediatrix Sentinel</div><div class="topicmeta version">DGW 49.12.2884<2941</div><div class="topicmeta pdf"><a href="https://documentation.media5corp.com/download/attachments/62825785/Sbc%20Service%20User%20Guide.pdf" rel="nofollow">Download PDF Document</a></div><hr><span style="float: inline-end;"></span></header><nav role="toc"><ul><li><a href="#topic_title_Basic_Configuration_Concepts_d1e15">Basic Configuration Concepts</a><ul><li><a href="#concept_mb2_vfp_bq">Call Agents</a></li><li><a href="#concept_mxn_44y_nr">phone_lines_ca Call Agent</a></li><li><a href="#concept_img_sqy_nr">trunk_lines_ca Call Agent</a></li><li><a href="#concept_ot1_2xy_nr">local_users_ca Call Agent</a></li><li><a href="#concept_oqp_rrs_4r">remote_users_ca Call Agent</a></li><li><a href="#concept_etk_1xs_4r">lan_ip_pbx_ca Call Agent</a></li><li><a href="#concept_pzc_xzs_4r">wan_ip_trunk_ca Call Agent</a></li><li><a href="#concept_nl2_wft_4r">secondary_ip_trunk_ca Call Agent</a></li><li><a href="#concept_w5x_qxd_lr">registration_ca Call Agent</a></li><li><a href="#concept_xqq_sgx_kr">Signaling and Media Interfaces</a></li><li><a href="#concept_jyq_vxd_lr">Penalty Box</a></li><li><a href="#concept_smx_2jq_zp">Keep-Alive</a></li></ul></li><li><a href="#topic_title_Basic_Ruleset_Concepts_d1e29">Basic Ruleset Concepts</a><ul><li><a href="#concept_bfk_fdq_bq">Rulesets</a></li><li><a href="#concept_h1b_gbp_dw">Ruleset Replacement Expressions</a><ul><li><a href="#reference_ylj_b4k_dw">Ruleset Replacement Expression Exhaustive List</a></li></ul></li></ul></li><li><a href="#topic_title_Basic_Registration_Concepts_d1e33">Basic Registration Concepts</a><ul><li><a href="#concept_y53_xtn_rt">Registration Caching</a></li><li><a href="#concept_s4k_4w4_rt">Registration Throttling</a></li><li><a href="#concept_ltc_rtq_sr">Registration Agent</a></li><li><a href="#concept_u12_xw4_rt">Registration Cache Clearing</a></li></ul></li><li><a href="#topic_title_Basic_Configuration_Tasks_d1e38">Basic Configuration Tasks</a><ul><li><a href="#task_v1x_dlp_bq">Configuring a Call Agent</a></li><li><a href="#task_awr_pkx_bq">Creating a Media Interface</a></li><li><a href="#task_yyy_lcw_bq">Creating a Signaling Interface </a></li><li><a href="#task_zd3_srp_bq">Changing the Execution Priority Level of a Call Agent Ruleset</a></li><li><a href="#task_nhs_djh_wr">Changing the Execution Priority Level of a Routing Ruleset</a></li><li><a href="#task_szl_nlq_bq">Associating Call Agent Rulesets to a Call Agent </a></li><li><a href="#task_zdg_vlx_bq">Associating Routing Rulesets to Your Configuration</a></li><li><a href="#task_pln_xdr_sq">Configuring the Call Agent Penalty Box</a></li><li><a href="#task_lzt_1k1_mr">Setting the Keep-Alive Interval</a></li></ul></li><li><a href="#topic_title_Basic_Ruleset_Tasks_d1e48">Basic Ruleset Tasks</a><ul><li><a href="#task_a5v_y2q_bq">Importing Rulesets</a></li><li><a href="#task_xvg_rlx_bq">Modifying a Ruleset</a></li><li><a href="#task_nck_ktr_sr">Adding Rules to a Ruleset</a></li><li><a href="#task_xhw_xxk_sr">Changing the Name and Description of a Ruleset</a></li><li><a href="#task_xfw_mkq_sr">Deleting a Ruleset</a></li><li><a href="#task_s4d_xyk_sr">Cloning a Ruleset</a></li><li><a href="#task_mnj_qvk_sr">Creating a New Ruleset</a></li><li><a href="#task_k33_yqr_sr">Changing the Execution Priority Level of a Ruleset Rule</a></li><li><a href="#task_bsk_dqp_5r">Changing the Execution Priority Level of a Rule Action</a></li><li><a href="#task_lbp_bsp_5r">Changing the Execution Priority Level of a Rule Condition</a></li></ul></li><li><a href="#topic_title_Basic_Registration_Tasks_d1e59">Basic Registration Tasks</a><ul><li><a href="#task_lmn_cfm_hq">Configuring a Registration Agent</a></li><li><a href="#task_nrh_wyq_sq">Finding a Specific AoR in the Registration Cache</a></li><li><a href="#task_rj1_lkp_ks">Clearing the Registration Cache</a></li></ul></li><li><a href="#topic_title_Parameters_d1e63">Parameters</a><ul><li><a href="#reference_lxl_ljw_bq">SBC/Configuration Parameters</a></li><li><a href="#reference_hsg_1mf_qr">SBC/Status Parameters</a></li></ul></li><li><a href="#reference_j4g_nbv_gfb">Online Help</a></li><li><a href="#concept_v4k_q3h_1r">DGW Documentation</a></li><li><a href="#concept_fqm_rv4_k4">Copyright Notice</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="nested0" aria-labelledby="ariaid-title1" id="topic_title_Basic_Configuration_Concepts_d1e15">
<h1 class="title topictitle1" id="ariaid-title1">Basic Configuration Concepts</h1>
<article class="topic concept nested1" aria-labelledby="ariaid-title2" id="concept_mb2_vfp_bq">
<h2 class="title topictitle2" id="ariaid-title2">Call Agents</h2>
<div class="body conbody"><p class="shortdesc">Call Agents represent logical end-points that connect the Mediatrix unit to
peers.</p>
<p class="p">For security reasons, the Mediatrix unit communicates by default only with well-known and
defined peers. When a request cannot be associated with a Call Agent, it is rejected. Each Call
Agent is tied to a specific peer, ensuring all inbound and outbound communications with that
peer. Routing rulesets are used to route SIP signaling between Call Agents, where inbound
requests from a Call Agent are sent to another (or the same) Call Agent that will send an
outbound request to it's related peer. Call Agents can be associated with one or several Rulesets
which can be applied to the inbound or the outbound requests.</p>
<p class="p">When there is an inbound request, to determine the Call Agent the inbound request will go
through, the Mediatrix unit uses the destination IP address to choose the Network interface. Then
the destination port of the inbound request will determine the Signaling or Media Interface used.
Finally, the source address and the source port, will allow the Mediatrix unit to direct the
request to the appropriate Call Agent. At this point any Rulesets associated with the Call Agent
will be applied in order of priority.</p>
<div class="p">
<br><div class="imagecenter"><img class="image imagecenter" id="concept_mb2_vfp_bq__image_hrs_b1t_2q" src="https://documentation.media5corp.com/download/attachments/62825785/inboundrequest.png" width="400"></div><br>
</div>
<p class="p">When a request is sent out, i.e. there is an outbound request, the Routing Rulesets will
determine which Call Agent will be used. Then the Call Agent Rulesets will be applied to the
outbound request, in reverse priority order. The outbound request will then be sent through the
Signaling and Media Interface associated with the Call Agent. If the public IP address is used,
then the SIP request will use this address as the source IP address. The outbound request will
then be sent to the peer address of the Call Agent or according to the routing Ruleset if the
peer is a Network. </p>
<div class="p">
<br><div class="imagecenter"><img class="image imagecenter" id="concept_mb2_vfp_bq__image_zq2_lpy_2q" src="https://documentation.media5corp.com/download/attachments/62825785/outboundrequest.png" width="400"></div><br>
</div>
<p class="p">In addition, a Call Agent tracks REGISTER requests or monitor the peer host using SIP options.
When these features are activated, the Call Agent registration state and monitoring state are
updated allowing a Routing Ruleset to select another Call Agent based on the state of a primary
Call Agent.</p>
<p class="p">Eight default types of Call Agents were created for Mediatrix unit. This should be enough to
cover all your needs. However, for advanced users, it is possible to create new Call Agents. </p>
<p class="p">Seven of the eight default Call Agents allow the Mediatrix unit to communicate with seven
different types of end-points.</p>
<div class="p">
<table class="table frame-all" id="concept_mb2_vfp_bq__table_nd5_d5x_sq"><caption></caption><colgroup><col style="width:50%"><col style="width:50%"></colgroup><thead class="thead">
<tr class="row">
<th class="entry colsep-1 rowsep-1" id="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__1">Call Agent Name</th>
<th class="entry colsep-1 rowsep-1" id="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__2">SIP or Endpoint Peer</th>
</tr>
</thead><tbody class="tbody">
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__1"><span class="keyword wintitle">wan_ip_trunk_ca</span></td>
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__2">SIP server located on the WAN.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__1"><span class="keyword wintitle">trunk_lines_ca</span></td>
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__2">Public Switch Telephony Network (PSTN), through PRI, BRI or FXO ports.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__1"><span class="keyword wintitle">phone_lines_ca</span></td>
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__2">Telephones, through FXS ports.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__1"><span class="keyword wintitle">lan_ip_pbx_ca</span></td>
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__2">IP Private branch exchange (PBX) located on the LAN.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__1"><span class="keyword wintitle">local_users_ca</span></td>
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__2">Users via SIP telephony located on the LAN.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__1"><span class="keyword wintitle">remote_users_ca</span></td>
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__2">Users using SIP telephony located on the WAN.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__1"><span class="keyword wintitle">registration_ca</span></td>
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__2">Used to route the registrations issued by the Registration Agent.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__1"><span class="keyword wintitle">secondary_ip_trunk_ca</span></td>
<td class="entry colsep-1 rowsep-1" headers="concept_mb2_vfp_bq__table_nd5_d5x_sq__entry__2">SIP server if the <span class="keyword wintitle">wan_ip_trunk_ca</span> Call Agent is not available.</td>
</tr>
</tbody></table>
</div>
<p class="p"><img class="image" id="concept_mb2_vfp_bq__image_i2t_qdd_5r" src="https://documentation.media5corp.com/download/attachments/62825785/CallFlow.jpg" width="800"></p>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title3" id="concept_mxn_44y_nr">
<h2 class="title topictitle2" id="ariaid-title3"><span class="keyword wintitle">phone_lines_ca</span> Call Agent</h2>
<div class="body conbody"><p class="shortdesc">The <span class="keyword wintitle">phone_lines_ca</span> Call Agent is
used to route calls via an FXS port of the Mediatrix unit. </p>
<p class="p">Typically it will route calls to and from analog phones and faxes within the enterprise
premises. This Call Agent will be used for example when a call is routed from one colleague to
another using analog phones connected on the FXS ports of the Mediatrix unit. In such a scenario,
the call does not go through the LAN network nor the Internet. Since by default this Call Agent
uses the <span class="ph uicontrol">loop_m</span> Media Interface to
route the media, the <span class="keyword wintitle">media_relay</span> Ruleset
is usually associated with this Call Agent.</p>
<div class="p">
<br><img class="image" id="concept_mxn_44y_nr__image_mg4_qpy_nr" src="https://documentation.media5corp.com/download/attachments/62825785/phone_lines_ca.jpg" width="550"><br>
</div>
<p class="p">The <span class="keyword wintitle">phone_lines_ca</span> Call Agent is
associated with the <span class="keyword wintitle">phone_lines_gw</span>
gateway of the SipEp service. By default, each FXS port sends a REGISTER by the <span class="keyword wintitle">phone_lines_ca</span> Call Agent. Therefore, the
administrator must make sure to route these REGISTERs to a server, or to disable them in the
SipEp service. If needed, FXS ports can be configured in the Pots service.</p>
<div class="p">
<br><img class="image" id="concept_mxn_44y_nr__image_ijl_3mr_qr" src="https://documentation.media5corp.com/download/attachments/62825785/PhoneLinesCAflow.jpg" width="800"><br>
</div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title4" id="concept_img_sqy_nr">
<h2 class="title topictitle2" id="ariaid-title4"><span class="keyword wintitle">trunk_lines_ca</span> Call Agent</h2>
<div class="body conbody"><p class="shortdesc">The <span class="keyword wintitle">trunk_lines_ca</span> Call Agent is
used to route calls to the Public Switch Telephony Network (PSTN) or a enterprise's existent PBX
through the PRI, BRI or FXO ports of the unit.</p>
<p class="p">Calls made outside the enterprise premises to telecommunication service providers or calls made
within the enterprise through a PBX will typically be routed through this Call Agent. Since by
default this Call Agent uses the <span class="ph uicontrol">loop_m</span>
Media Interface to route the media, the <span class="keyword wintitle">media_relay</span> Ruleset is usually associated with
this Call Agent.</p>
<p class="p">If there are no PRI, BRI or FXO card on the unit, calls through trunk lines can also be routed
by the <span class="keyword wintitle">wan_ip_trunk_ca</span> or <span class="keyword wintitle">secondary_ip_trunk_ca</span> Call Agent, provided there is
an analog or digital gateway to convert the VoIP call to an analog or digital call, or vice
versa.</p>
<div class="p">
<br><img class="image" id="concept_img_sqy_nr__image_rgg_bwy_nr" src="https://documentation.media5corp.com/download/attachments/62825785/trunk_lines_2ca.jpg" width="500"><br>
</div>
<p class="p">Further more, the <span class="keyword wintitle">trunk_lines_ca</span> Call
Agent is associated with the <span class="keyword wintitle">trunk_lines_gw</span> of the SipEp service. FXO/PRI/BRI ports will need to be configured in either the Pots, Isdn,
R2 or Eam services for the calls to be routed properly. </p>
<div class="p">
<br><img class="image" id="concept_img_sqy_nr__image_ndp_wkr_qr" src="https://documentation.media5corp.com/download/attachments/62825785/TrunkLinesCAflow.jpg" width="550"><br>
</div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title5" id="concept_ot1_2xy_nr">
<h2 class="title topictitle2" id="ariaid-title5"><span class="keyword wintitle">local_users_ca</span> Call Agent</h2>
<div class="body conbody"><p class="shortdesc">The <span class="keyword wintitle">local_users_ca</span> Call Agent is
used to route calls from and to local users, i.e. located in the LAN, via VoIP calls. </p>
<p class="p">For the call to use this Call Agent, the endpoint must belong to the company and use the
company's system. This Call Agent is often used as a regrouping point of all local endpoints to
be routed to a PBX or Trunk lines. For instance, if you are a Media5 corporation employee, with a
cell phone using the Media5 fone application and the entreprise IP-PBX, then your call will be
routed through the <span class="keyword wintitle">local_users_ca</span> Call
Agent. If an internal employee is using an analog phone, the call can also be routed through this
Call Agent provided the call goes first through a gateway to convert the analog call into a VoIP
call.</p>
<div class="p">
<br><img class="image" id="concept_ot1_2xy_nr__image_mqc_wyy_nr" src="https://documentation.media5corp.com/download/attachments/62825785/local_users_ca.jpg" width="550"><br>
</div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title6" id="concept_oqp_rrs_4r">
<h2 class="title topictitle2" id="ariaid-title6"><span class="keyword wintitle">remote_users_ca</span> Call Agent</h2>
<div class="body conbody"><p class="shortdesc">The <span class="keyword wintitle">remote_users_ca</span> Call Agent
is used to route calls from users working out the office and using VoIP calls through an external
network or Internet. </p>
<p class="p"> Calls are routed through a WAN then to the Mediatrix unit via the <span class="keyword wintitle">remote_users_ca</span> Call Agent. </p>
<div class="p">
<br><img class="image" id="concept_oqp_rrs_4r__image_d1n_qss_4r" src="https://documentation.media5corp.com/download/attachments/62825785/remote_users_ca_ca.jpg" width="650"><br>
</div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title7" id="concept_etk_1xs_4r">
<h2 class="title topictitle2" id="ariaid-title7"><span class="keyword wintitle">lan_ip_pbx_ca</span> Call Agent</h2>
<div class="body conbody"><p class="shortdesc">The <span class="keyword wintitle">lan_ip_pbx_ca</span> Call Agent
routes calls to and from an IP PBX located in the LAN. The IP PBX manages all internal
communications between different SIP clients (soft phones or SIP gateways). </p>
<p class="p">This Call Agent is usually used to link a local PBX with an external trunk (IP or PSTN).</p>
<div class="p"><br><img class="image" id="concept_etk_1xs_4r__image_fdv_szs_4r" src="https://documentation.media5corp.com/download/attachments/62825785/lan_ip_pbx_ca.jpg" width="700"><br></div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title8" id="concept_pzc_xzs_4r">
<h2 class="title topictitle2" id="ariaid-title8"><span class="keyword wintitle">wan_ip_trunk_ca</span> Call Agent</h2>
<div class="body conbody"><p class="shortdesc">The wan_ip_trunk_ca Call Agent is used to route VoIP calls. </p>
<p class="p"> Calls are routed from or to the main SIP server or provider located in the WAN. Typical peers
for this Call Agent are the head office of the enterprise, an Internet telephony service provider
(ITSP) or an IP Multimedia Core Network Subsystem (IMS).</p>
<div class="p">
<br><img class="image" id="concept_pzc_xzs_4r__image_d5y_c2t_4r" src="https://documentation.media5corp.com/download/attachments/62825785/wan_ip_trunk_ca.jpg" width="600"><br>
</div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title9" id="concept_nl2_wft_4r">
<h2 class="title topictitle2" id="ariaid-title9"><span class="keyword wintitle">secondary_ip_trunk_ca</span> Call
Agent</h2>
<div class="body conbody"><p class="shortdesc">The <span class="keyword wintitle">secondary_ip_trunk_ca</span>Call
Agent is used to route VoIP calls.</p>
<p class="p">This Call Agent is identical to the <span class="keyword wintitle">wan_ip_trunk_ca</span> Call Agent. The <span class="keyword wintitle">secondary_ip_trunk_ca</span> can be used for different
purposes. The most common use for this Call Agent, is to route calls to and from the backup
server in the event the primary server does not respond. However, this Call Agent can also be
used, for example, to route calls directly to and from a Branch Office or route a specific type
of call such as international calls. Typical peers for this Call Agent are the head office of the
enterprise, an Internet telephony service provider (ITSP) or an IP Multimedia Core Network
Subsystem (IMS).</p>
<div class="p"><br><img class="image" id="concept_nl2_wft_4r__image_qbz_n3t_4r" src="https://documentation.media5corp.com/download/attachments/62825785/secondary_ip_trunk_ca.jpg" width="550"><br></div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title10" id="concept_w5x_qxd_lr">
<h2 class="title topictitle2" id="ariaid-title10"><span class="keyword wintitle">registration_ca</span> Call Agent</h2>
<div class="body conbody"><p class="shortdesc">The <span class="keyword wintitle">registration_ca</span> Call Agent
is used to route the registrations issued by the Registration Agent. </p>
<p class="p">The <span class="keyword wintitle">registration_ca</span> Call Agent should
not be used for other purposes. The registrations issued by the Registration Agent must be routed
from the <span class="keyword wintitle">registration_ca</span> to the Call
Agent facing the destination Sip registrar (typically <span class="keyword wintitle">wan_ip_trunk_ca</span>_ca or <span class="keyword wintitle">secondary_ip_trunk_ca</span>).</p>
<p class="p">The registration is routed using the User Name, Password and Domain to build the AOR and the
R-URI . The Contact is the contact header of the registration, it should contain the IP-address
or FQDN of the Mediatrix unit.</p>
<div class="p">
<br><img class="image" id="concept_w5x_qxd_lr__image_jnw_2wr_qr" src="https://documentation.media5corp.com/download/attachments/62825785/registrationCAflow.jpg" width="600"><br>
</div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title11" id="concept_xqq_sgx_kr">
<h2 class="title topictitle2" id="ariaid-title11">Signaling and Media Interfaces</h2>
<div class="body conbody"><p class="shortdesc">The Signaling Interface is used for SIP signaling and the Media Interface is used for
media ( RTP, UDPTL ) processing. </p>
<p class="p">When configuring a Call Agent, you must select a Signaling Interface and a Media Interface.
These interfaces are used whenever SIP signaling or media packets are sent to or received by the
Call Agent.</p>
<p class="p">It is possible to create several Signaling and Media Interfaces on the same Network Interface
but for different purposes. For example, one set of Signaling and Media Interfaces for a WAN SIP
Trunk and another set of Signaling and Media Interfaces for remote user calls. This means, for
instance, that two Signaling Interfaces will be created on the same Network Interface, using the
same IP address, but with a port range that will differ according to their intended use and to
avoid conflicts. </p>
<p class="p">A Media or Signaling Interface can be used by more than one Call Agent, but a specific
Signaling or Media Interface can be created for a specific Call Agent. This provides the liberty
to define non conflicting range of contactable interfaces on any physical network interfaces of
the units for your network structure needs (such as Vlans, PPPoE interfaces, multiple Ethernet
ports or multiple addresses on a link).</p>
<div class="p">The following Signaling and Media Interfaces are supplied by default: <ul class="ul" id="concept_xqq_sgx_kr__ul_nyb_hg5_mr">
<li class="li"><span class="keyword wintitle">lan1_m</span></li>
<li class="li"><span class="keyword wintitle">lan1_s</span></li>
<li class="li"><span class="ph uicontrol">loop_m</span></li>
<li class="li"><span class="ph uicontrol">loop_s</span></li>
<li class="li"><span class="keyword wintitle">uplink_s</span></li>
<li class="li"><span class="keyword wintitle">uplink_m</span></li>
</ul>
</div>
<p class="p"><span class="ph uicontrol">loop_m</span> and <span class="ph uicontrol">loop_s</span> interfaces are used to communicate with
the internal services of the unit. For example, the loop interfaces can be used to communicate
with the SipEp service to access phone ports.</p>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title12" id="concept_jyq_vxd_lr">
<h2 class="title topictitle2" id="ariaid-title12">Penalty Box</h2>
<div class="body conbody"><p class="shortdesc">The penalty box feature is enabled for a specific Call Agent to temporarily avoid
contacting the peer hosts (addresses) that are expected not to answer.</p>
<p class="p">Without the use of the penalty box, DNS SRV failover is delayed until the SIP transaction
times out. In a DNS SRV failover, without the use of the penalty box, the Call Agent will
first try to communicate with the peer host on the first server, then once the SIP transaction
has timed out, it will try the second and so on, always waiting for the SIP transaction timer
to expire. With the penalty box, the call Agent will not try any servers that are already in
the penalty box. Remember, dynamic call routing (e.g. survivability) based on server
availability requires the penalty box to be enabled. </p>
<div class="p">There are typically three situations that will cause a peer host to be put in the penalty
box: <ul class="ul" id="concept_jyq_vxd_lr__ul_dqz_csf_mr">
<li class="li">If the transaction timer of a communication is expired, the peer host will be considered
Down and will be put in the penalty box. </li>
<li class="li">If the transaction timer of a keep-alive communication is expired, the peer host will be
considered Down and will be put in the penalty box.</li>
<li class="li">If after sending a keep-alive request or any other message to a peer host, the Call
Agent receives one of the selected error codes, the peer host will be put in the penalty
box. It is the error code that will indicate that the peer host cannot be used. <div class="note note note_note"><span class="note__title">Note:</span>
When configuring the Call Agent it is possible to indicate the error codes that will
trigger the peer host to be sent to the penalty box.( <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>/<span class="keyword wintitle">Blacklisting Error Codes</span>)</div></li>
</ul></div>
<p class="p">It is possible to configure how much time a peer host will remain in the penalty box, and the
delay before which a peer host is considered down. This delay starts after the expiration of
the transaction timer. It is also possible to disable the penalty box feature by using the
special value 0 as the duration the peer host will remain in the penalty box.</p>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title13" id="concept_smx_2jq_zp">
<h2 class="title topictitle2" id="ariaid-title13">Keep-Alive</h2>
<div class="body conbody"><p class="shortdesc">The Keep-Alive monitoring parameter allows the unit to periodically send messages to a
server to make sure the server can still be reached. </p>
<p class="p">The Keep-Alive parameter is set individually for each Call Agent. SIP options are sent
periodically for each Call Agent to their corresponding server. Any response received from the
server means that it can be reached. No additional processing is performed on the response. If no
response is received after the retransmission timer expires, the Sbc service considers the server
as unreachable. In this case, any call attempt through the Call Agent is refused and the peer
host will be sent to the Penalty Box. SIP options are still sent when the server cannot be
reached and as soon as it can be reached again, new calls are allowed.</p>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title14" id="topic_title_Basic_Ruleset_Concepts_d1e29">
<h1 class="title topictitle1" id="ariaid-title14">Basic Ruleset Concepts</h1>
<article class="topic concept nested1" aria-labelledby="ariaid-title15" id="concept_bfk_fdq_bq">
<h2 class="title topictitle2" id="ariaid-title15">Rulesets</h2>
<div class="body conbody"><p class="shortdesc">Rulesets define one or several rules used to filter, manipulate or route inbound or
outbound requests. </p>
<div class="p">There are two types of Rulesets: <ul class="ul" id="concept_bfk_fdq_bq__ul_xgv_t3z_cq">
<li class="li">Call Agent Rulesets: they describe how inbound or outbound requests are handled by a
specific Call Agent. They can also implement services or collect data. </li>
<li class="li">Routing Rulesets: they are used to globally route outbound requests, i.e. that they apply to
all Call Agents.</li>
</ul></div>
<p class="p">When a request arrives at a Call Agent from a peer, the inbound rules of the Rulesets
associated with the Call Agent are executed. Then, Routing Rulesets are executed until a Call
Agent is selected for the destination. Last, the outbound rules of the Rulesets associated with
the destination Call Agent are executed before sending the request to the peer.</p>
<p class="p">Inbound rules of the Ruleset are executed in ascending Ruleset priority order. Outbound rules
are executed in descending Ruleset priority order.</p>
<p class="p">The Mediatrix unit is fundamentally rule driven. This means that almost all features can be
activated based on certain conditions evaluated at run-time, based on parts of the signaling
messages or media payload. All rules are constructed using the same pattern. They consist of a
set of one or more conditions. If all conditions apply (logical conjunction), a set of one or
more actions is executed. It is important to understand that rules are generally applied only on
incoming or outbound requests. However, some rules have a scope that goes beyond these incoming
or outbound requests. For example, header filters apply to all requests exchanged, including
incoming requests.</p>
<div class="p"> Call Agents can have two origins: <ul class="ul" id="concept_bfk_fdq_bq__ul_lgt_vsq_ns">
<li class="li">Factory: Read only Ruleset delivered with the application.</li>
<li class="li">Custom: User defined Ruleset.</li>
</ul>A custom Ruleset has priority over a factory Ruleset. If a custom Ruleset is created with
the same name as a factory Ruleset, it is the custom Ruleset that will be shown and used. Once
the custom Ruleset is deleted, the factory Ruleset will be reactivated. Cloning, editing and
saving a factory Ruleset will create a custom Ruleset without modifying the factory Ruleset.</div>
<p class="p">Call Agent Rulesets have an *.crs extension and Routing Rulesets use the *.rrs extension. For
more details on Ruleset conditions and descriptions, refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Reference+Guide" target="_blank">DGW Configuration Guide - Reference Guide</a> document published on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>.</p>
<div class="p">Refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Ruleset+Replacement+Expressions" target="_blank">DGE Configuration Guide - Ruleset Replacement
Expressions</a> also published on the Media5 documentation portal. <div class="note important note_important"><span class="note__title">IMPORTANT:</span> Although it is possible to configure existing ruleset parameters via the CLI, it is not
possible to create or edit a ruleset from the CLI: it must be either imported or directly
created or edited in the DGW Web interface.</div></div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title16" id="concept_h1b_gbp_dw">
<h2 class="title topictitle2" id="ariaid-title16">Ruleset Replacement Expressions</h2>
<div class="body conbody"><p class="shortdesc">Ruleset replacement expressions are used when the value of a parameter, a command or an
action is not known in advance, i.e. the value depends on the result of the SIP message
processing.</p>
<p class="p">A Ruleset replacement expression is a string that represents a SIP processing status.
Replacement expressions always start with the dollar (“$”) sign followed by an identifier.
When the Ruleset uses a replacement expression, the replacement expression is replaced by the
value of the SIP processing status representing the replacement expression.</p>
<div class="p">For example, <ul class="ul" id="concept_h1b_gbp_dw__ul_rhb_scp_dw">
<li class="li">$aU uses the User part of the <span class="keyword wintitle">P-Asserted-Identity</span> header</li>
<li class="li">$th uses the Host part of the <span class="keyword wintitle">To</span> header</li>
<li class="li">sip:$aU@$th, used as the parameter of the Set R-URI action, uses the
<span class="keyword wintitle">P-Asserted-Identity</span> and <span class="keyword wintitle">To</span> headers of the
incoming request and puts them into the Request URI of the outgoing request.</li>
</ul></div>
<div class="p">
<div class="note note note_note"><span class="note__title">Note:</span> Special characters should be backslash-escaped, for example, as follows: \ → \\ or $ →
\$</div>
<div class="note note note_note"><span class="note__title">Note:</span> It is important to know that if a mediation action (Section SIP Mediation) changes the
content of a SIP message, the replacement expression will refer to the value after
modification. E.g., if you apply the rule action “SetFrom(sip:new@from.com)”, $fu will
return new@from.com!</div>
</div>
</div>
<hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested2" aria-labelledby="ariaid-title17" id="reference_ylj_b4k_dw">
<h3 class="title topictitle3" id="ariaid-title17">Ruleset Replacement Expression Exhaustive List</h3>
<div class="body refbody">
<table class="table" id="reference_ylj_b4k_dw__table_a5h_24k_dw"><caption></caption><colgroup><col style="width:22.32142857142857%"><col style="width:27.00892857142857%"><col style="width:50.66964285714285%"></colgroup><thead class="thead">
<tr class="row">
<th class="entry colsep-1 rowsep-1" id="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">Macro </th>
<th class="entry colsep-1 rowsep-1" id="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2"> Replacements</th>
<th class="entry colsep-1 rowsep-1" id="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3"> Description</th>
</tr>
</thead><tbody class="tbody">
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$r</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">Request-URI (R-URI). The expression refers to
current Request-URI which may be changed during the course of request
processing</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$r.</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Complete R-URI header</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$ru</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">user@host[:port] part of R-URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$rU</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">User part of the R-URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$rd</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">R-URI domain (host:port)</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$rh</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Host part of the R-URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$rp</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Port number of the R-URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$rP</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">R-URI Parameters</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$f</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">From header</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$f.</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Complete From header field</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$fu</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">user@host[:port] part of the From URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$fU</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">User part of the From URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$fd</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">From URI domain (host:port)</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$fh</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Host part of the From URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$fp</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Port number of the From URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$fn</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Display name of the From header field</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$fP</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Parameters of the From header field. Does not include the parameters of the
URI.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$ft</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">The tag of the From header field</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$fH</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">The name of the From header field, exactly as it is stated in the SIP
request.</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$t</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">To header</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$t.</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Complete To header</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$tu</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">user@host[:port] part of the To URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$tU</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">User part of the To URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$td</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">To URI domain (host:port)</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$th</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Host part of the To URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$tp</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Port number of the To URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$tn</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Display name of the To header field</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$tP</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Parameters of the To header field. Does not include the parameters of the
URI.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$tt</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">The tag of the To header</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$tH</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">The name of the To header, exactly as it is stated in the SIP request.</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$a</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">P-Asserted-Identity (PAI)</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$a.</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Complete PAI header.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$au</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">user@host[:port] part of the PAI URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$aU</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">User part of the PAI URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$ad</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">PAI URI Domain (host:port).</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$ah</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Host part of the PAI URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$ap</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Port number of the PAI URI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$aP</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Parameters of the PAI header field. Does not include the parameters of the
URI.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$at</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">The tag of the PAI</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$aH</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">The name of the PAI header field, exactly as it is stated in the SIP
request.</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$p</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">P-Preferred-Identity (PPI)</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$p.</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Complete PPI header field.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$pu</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">user@host[:port] part of the PPI URI.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$pU</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">User part of the PPI URI.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$pd</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">PPI URI Domain (host:port).</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$ph</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Host part of the PPI URI.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$pp</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Port number of the PPI URI.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$pP</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Parameters of the PPI header field. Does not include the parameters of the URI.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$pt</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">The tag of the PPI header field.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$pH</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">The name of the PPI header, exactly as it is stated in the SIP request.</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$c</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">Call-ID</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$ci</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Call-ID of the SIP request</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$s</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">Source party</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$si</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Source IP address of the inbound SIP request</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$sp</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Source port number of the inbound SIP request</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$d</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">Expected destination party</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$di</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Destination IP address of the outbound SIP request. This replacement expression is only available in outbound rules.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$dp</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Destination port number of the outbound SIP request. This replacement expression is only available in outbound rules.</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$R</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">Interface of the inbound SIP request</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$Ri</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">IP address of the Signaling Interface on which the inbound SIP request was
received</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$Rp</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Port number of the Signaling Interface on which the inbound SIP request was
received</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$Rf</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">ID of the Signaling Interface on which the inbound SIP request was
received</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$Rn</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Name of the Signaling Interface on which the inbound SIP request was
received</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$RI</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">The configured address of the <span class="keyword parmname">SignalingInterface.PublicIpAddr</span> parameter on which the inbound SIP request was received</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$H</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">Arbitrary Headers. <p class="p">The replacement expressions in
this group mention the name of an arbitrary header between parentheses. The core
headers (From, To, Call-ID, Via, Route, Record-Route, Contact) cannot be
replaced.</p><p class="p">Example: $H(Server) will be replaced by the value of the Server
header field.</p></td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$H(headername)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Value of the 'headername' header</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$HU(headername)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">User part of the URI in the 'headername' header.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$Hd(headername)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">URI Domain (host:port) of the 'headername' header.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$Hu(headername)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">user@host[:port] part of the URI in the 'headername' header.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"> </td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$Hh(headername)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Host part of the URI in the 'headername' header.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$Hp(headername)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Port number of the URI in the 'headername' header.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$Hn(headername)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Display name of the 'headername' header.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$HP(headername)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Parameters of the 'headername' header field. Does not include the parameters of the URI.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$HH(headername)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Header headername (as URI) headers</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$m</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">Request method</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$m</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">The method of the request.</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$V</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">Call parameter</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$V(gui.varname)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Value of the 'varname' call parameter.</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$B</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">Cnum and Rnum</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$B(cnum.rnum)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Value of the regular expression backreference. <ul class="ul" id="reference_ylj_b4k_dw__ul_a1v_4dv_gnb">
<li class="li">Rnum is the index of the rule condition containing the regular expression, starting at 1.</li>
<li class="li">Cnum is the index of the subexpression within the regular expression, starting at 1.</li>
</ul></td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$U</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">Register cache</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$Ua</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Originating AoR from the registration cache. This replacement expression can only be used after the execution of a‘Restore contact from registrar’ or a ‘Retarget R-URI from cache’ action.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$UA</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Originating alias from the registration cache. This replacement expression can only be used after the execution of a ‘Restore contact from registrar’ or a ‘Retarget R-URI from cache’ action.</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$_</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">Operations on Values</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$_u(value)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Changes the value to uppercase.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$_l(value)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Changes the value to lowercase.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$_s(value)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Size of the value.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$_5(value)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">MD5 sum of the value.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$_r(value)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Random number from 0 to 'value' - 1. Example: $_r(5) gives 0, 1, 2, 3 or 4.</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$#</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">URL-encoded</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$#(value)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Encodes the value into a URL format with appropriate escaping for characters outside the ASCII character set.</td>
</tr>
<tr class="row color">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1">$attr</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2 reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3" colspan="2">Global Attributes</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$attr(version)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Version number of the DGW firmware. The returned value matches with the %version% macro in DGW firmware.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$attr(profile)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Profile identification of the DGW firmware. The returned value matches with the %profile% macro in DGW firmware.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$attr(serial)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Serial number of the Mediatrix unit. The returned value matches with the %serial% macro in DGW firmware.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$attr(mac)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">MAC address of the Mediatrix unit. The returned value matches with the %mac% macro in DGW firmware.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$attr(product)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Product name of the Mediatrix unit. The returned value matches with the %product% macro in DGW firmware.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__1"></td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__2">$attr(productseries)</td>
<td class="entry colsep-1 rowsep-1" headers="reference_ylj_b4k_dw__table_a5h_24k_dw__entry__3">Product series name of the Mediatrix unit. The returned value matches with the %productseries% macro in DGW firmware.</td>
</tr>
</tbody></table>
</div>
</article></article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title18" id="topic_title_Basic_Registration_Concepts_d1e33">
<h1 class="title topictitle1" id="ariaid-title18">Basic Registration Concepts</h1>
<article class="topic concept nested1" aria-labelledby="ariaid-title19" id="concept_y53_xtn_rt">
<h2 class="title topictitle2" id="ariaid-title19">Registration Caching</h2>
<div class="body conbody"><p class="shortdesc">Registration processing allows maintaining an endpoint reachable even from behind
NATs.</p>
<p class="p">When a call is routed by a Ruleset that includes the REGISTER throttling and Enable REGISTER
caching actions, the SBC replaces the information of the Contact header with its own IP address
before forwarding the call to an endpoint. Because a private IP address is used as the contact
address in the Contact header field of the REGISTER messages, it becomes impossible to reach the
user from the public Internet without going through the SBC since the contact's address is
private.</p>
<p class="p">The manipulated registration information is then registered in the registrar. When a Call is
destined to the user, the call will be directed to the SBC. In order for the SBC to know which
user is actually being contacted, the SBC keeps a local copy of the user's registration. The
local copy includes the private IP address and the user’s SIP URI as well as the public IP
address included in the IP header that was assigned to the SIP message by the NAT.</p>
<p class="p">If periodic request-response traffic does not cross the NAT behind which the user is located,
the NAT address binding expires and the user becomes unreachable. Therefore, the SBC forces
re-registration to keep NAT bindings alive.</p>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title20" id="concept_s4k_4w4_rt">
<h2 class="title topictitle2" id="ariaid-title20">Registration Throttling</h2>
<div class="body conbody"><p class="shortdesc">Registration throttling protects SIP infrastructures against registration
overloads.</p>
<p class="p">Although registration overloads are often self-inflicted by the keep-alive functionality, it
may also be caused by a router outage, broken client or Denial of Service attack. The SBC fends
off such overloads by using high-performance in-memory registration cache that serves upstream
registrations at high-rate, handles them locally, and propagates them down-stream at
substantially reduced rate. That’s the case if the registrations were to create new bindings,
deleting existing ones or if they were to expire downstream. The propagated registration changes
become effective on the SBC only if confirmed by the downstream server. If a registration expires
without being refreshed the SBC issues a warning event.</p>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title21" id="concept_ltc_rtq_sr">
<h2 class="title topictitle2" id="ariaid-title21">Registration Agent</h2>
<div class="body conbody"><p class="shortdesc">The Registration Agent is a feature that performs REGISTERs on behalf of other
users.</p>
<div class="p">In some use cases, using the Registration Agent may be necessary to have a separate entity
perform the REGISTERs on behalf of users. For example: <ul class="ul" id="concept_ltc_rtq_sr__ul_o5d_vgs_sr">
<li class="li">When users cannot register themselves.</li>
<li class="li">To separate internal and external networks in Demarcation Point scenarios </li>
</ul>The Registration Agent is only involved with the registrations it initiates. If the
Registration Agent is used, its REGISTERs are routed to the Mediatrix unit via the
registration_ca Call Agent. </div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title22" id="concept_u12_xw4_rt">
<h2 class="title topictitle2" id="ariaid-title22">Registration Cache Clearing</h2>
<div class="body conbody"><p class="shortdesc">Clearing the registration cache will remove all inaccurate information that could remain
if an equipment connecting to the SBC is restarted with new information such as a new IP address. </p>
<p class="p">When the registration cache is cleared, all equipments connecting to the SBC need to
re-register themselves before being able to receive SIP requests because without re-registration
the SBC will not have the private contact address to know where to route the SIP.</p>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title23" id="topic_title_Basic_Configuration_Tasks_d1e38">
<h1 class="title topictitle1" id="ariaid-title23">Basic Configuration Tasks</h1>
<article class="topic task nested1" aria-labelledby="ariaid-title24" id="task_v1x_dlp_bq">
<h2 class="title topictitle2" id="ariaid-title24">Configuring a Call Agent</h2>
<div class="body taskbody">
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Call Agent Configuration</span>
table, click <span class="keyword wintitle">Edit</span>
located on the row of the Call Agent you wish to configure. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Configure Call Agent</span> table,
complete the fields as required and make sure the <span class="keyword wintitle">Enable</span> check box is
selected.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> <span class="keyword wintitle">Monitoring Parameters</span> are
not mandatory.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Complete the fields of the <span class="keyword wintitle">Call Agent Configuration</span> as
required.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The changes are saved, but not all applied to the configuration.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span> to apply
all changes to the configuration.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div><span class="keyword wintitle">No</span> will be displayed in
the <span class="keyword wintitle">Config.Modified</span> field,
indicating that the configuration that was modified is now applied to the system. When
the Mediatrix unit will use the selected Call Agent for a communication, the selected
parameters will be applied.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title25" id="task_awr_pkx_bq">
<h2 class="title topictitle2" id="ariaid-title25">Creating a Media Interface</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>A Network Interface must be configured.</section>
<section id="task_awr_pkx_bq__steps_ixw_hlx_bq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_awr_pkx_bq__steps_ixw_hlx_bq"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Media Interface Configuration</span>
table, click <img class="image" id="task_awr_pkx_bq__image_cpq_lqk_sr" src="https://documentation.media5corp.com/download/attachments/62825785/Plusbleu.jpg" width="12">.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> A new line of empty fields is added to the <span class="keyword wintitle">Media Interface Configuration</span> table. An error message will be displayed indicating that the
configuration of the row is invalid. This is normal as the Media Interface
is not yet configured.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Media Interface Configuration</span>
table, complete the fields as required.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The Network Interfaces displayed in the <span class="keyword wintitle">Network</span> column, are
created under <span class="keyword wintitle">Network</span> > <span class="keyword wintitle">Interfaces</span> tab.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The changes are saved, but not all applied to the configuration.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span> to apply
all changes to the configuration.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="ph uicontrol">restart required services</span>,
located at the top of the page.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The Media Interface will be available when configuring a Call Agent, in the
<span class="keyword wintitle">Media Interface</span> selection
list of the <span class="keyword wintitle">Configure Call Agent</span>
page. </section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title26" id="task_yyy_lcw_bq">
<h2 class="title topictitle2" id="ariaid-title26">Creating a Signaling Interface </h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div> A Network Interface must be configured. IPv6 is not supported, therefore Ipv6
configured Network interfaces cannot be used.</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Signaling Interface Configuration</span> table, click <img class="image" id="task_yyy_lcw_bq__image_v3g_vqk_sr" src="https://documentation.media5corp.com/download/attachments/62825785/Plusbleu.jpg" width="12">.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> A line is added to the <span class="keyword wintitle">Signaling Interface Configuration</span> table. An error message will be displayed indicating that the
configuration of the row is invalid. This is normal as the Signaling
Interface is not yet configured.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Signaling Interface Configuration</span> table, <span class="ph">complete the fields as required. </span>
</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The Network Interfaces displayed in the <span class="keyword wintitle">Network</span> column, are
created under <span class="keyword wintitle">Network</span> > <span class="keyword wintitle">Interfaces</span> page.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The changes are saved, but not all applied to the configuration.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span> to apply
all changes to the configuration.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="ph uicontrol">restart required services</span>,
located at the top of the page.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The Signaling Interface will be available when configuring a Call Agent, in the
<span class="keyword wintitle">Signaling Interface</span>
selection list of the <span class="keyword wintitle">Configure Call Agent</span> page. </section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title27" id="task_zd3_srp_bq">
<h2 class="title topictitle2" id="ariaid-title27">Changing the Execution Priority Level of a Call Agent Ruleset</h2>
<div class="body taskbody">
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Call Agent Configuration</span>
table, click <img class="image" id="task_zd3_srp_bq__image_axf_4xr_sr" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="14"> next to the Call Agent for which you wish to modify the Ruleset
priority level.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Use the arrows of the <span class="keyword wintitle">Call Agent Rulesets</span> table to
move a Ruleset up or down.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
<div class="itemgroup stepresult">The changes will be applied to the configuration, but the modified
configuration is not yet applied to the system.</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span> to apply
the modified configuration to the system.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>Inbound rules of the Ruleset will be executed in ascending Ruleset priority order
but Outbound rules will be executed in descending Ruleset priority order.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title28" id="task_nhs_djh_wr">
<h2 class="title topictitle2" id="ariaid-title28">Changing the Execution Priority Level of a Routing Ruleset</h2>
<div class="body taskbody">
<section id="task_nhs_djh_wr__steps_jzp_2jh_wr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_nhs_djh_wr__steps_jzp_2jh_wr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Use the arrows of the <span class="keyword wintitle">Routing Rulesets</span> table to
move a Ruleset up or down.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The changes will be applied to the configuration, but the modified
configuration is not yet applied to the system.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span> to apply
the modified configuration to the system.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>Inbound rules of the Ruleset will be executed in ascending Ruleset priority order
but Outbound rules will be executed in descending Ruleset priority order.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title29" id="task_szl_nlq_bq">
<h2 class="title topictitle2" id="ariaid-title29">Associating Call Agent Rulesets to a Call Agent </h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>
<ul class="ul" id="task_szl_nlq_bq__ul_ybr_vpp_bq">
<li class="li"> The Call Agents must be configured.</li>
<li class="li"><a class="xref" href="#task_a5v_y2q_bq">Importing Rulesets</a> must be completed.</li>
</ul>
</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Refer to the Call Agents section to identify which Rulesets are associated
with the Call Agents used in this Use Case. </div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Call Agent Configuration</span>
table, click <img class="image" id="task_szl_nlq_bq__image_f2f_cb4_tq" height="15" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg"> located on the same row as the Call Agent to which
you wish to associate a Ruleset.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Call Agent Rulesets</span> table,
click <img class="image" id="task_szl_nlq_bq__image_yzg_nb4_tq" height="15" src="https://documentation.media5corp.com/download/attachments/62825785/Plusbleu.jpg">.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Name</span>
selection list, select a Ruleset.</span>
</li><li class="li step stepexpand">
<span class="ph cmd"> To add other Rulesets, click <img class="image" id="task_szl_nlq_bq__image_tcx_2d4_tq" height="15" src="https://documentation.media5corp.com/download/attachments/62825785/Plusbleu.jpg">. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Configure Call Agent</span> page,
click <span class="keyword wintitle">Save</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span> to apply
all changes to the configuration.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>
<br><img class="image" id="task_szl_nlq_bq__image_bby_cs4_rs" src="https://documentation.media5corp.com/download/attachments/62825785/CallAgentRuleset.png" width="800"><br>
</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title30" id="task_zdg_vlx_bq">
<h2 class="title topictitle2" id="ariaid-title30">Associating Routing Rulesets to Your Configuration</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div><a class="xref" href="#task_a5v_y2q_bq">Importing Rulesets</a> must be completed for
Routing Rulesets to be available. </section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span></span>
</li><li class="li step stepexpand" id="task_zdg_vlx_bq__Step2">
<span class="ph cmd">In the <span class="keyword wintitle">Routing Rulesets</span> table click <img class="image" id="task_zdg_vlx_bq__image_ohp_2fm_3db" src="https://documentation.media5corp.com/download/attachments/62825785/Plusbleu.jpg" width="15"> to add the first route.</span>
</li><li class="li step stepexpand" id="task_zdg_vlx_bq__Step3">
<span class="ph cmd">From the <span class="keyword wintitle">Name</span>
selection list, select the Routing Ruleset you wish to apply to the
configuration.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Refer to the Routing Rulesets section to identify the Rulesets that apply
to this Use Case.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Repeat steps <a class="xref" href="#task_zdg_vlx_bq__Step2">2</a> and
<a class="xref" href="#task_zdg_vlx_bq__Step3">3</a> for each Routing
Ruleset you wish to associate to your configuration.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">If necessary, in the <span class="keyword wintitle">Parameters</span> field enter the
required parameters for each route. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span> to apply
all changes to the configuration.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>
<br><img class="image" id="task_zdg_vlx_bq__image_khp_lvl_hs" src="https://documentation.media5corp.com/download/attachments/62825785/RoutingRulesets.png" width="800"><br>
</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title31" id="task_pln_xdr_sq">
<h2 class="title topictitle2" id="ariaid-title31">Configuring the Call Agent Penalty Box</h2>
<div class="body taskbody">
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step">
<span class="ph cmd">Click <img class="image" id="task_pln_xdr_sq__image_s14_n2r_sq" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="15"> next to the Call Agent you wish to configure.</span>
</li><li class="li step">
<span class="ph cmd">In the <span class="keyword wintitle">Configure Call Agent</span> table,
set the <span class="keyword wintitle">Keep-Alive</span>
field to 30.</span>
</li><li class="li step">
<span class="ph cmd">Set the <span class="keyword wintitle">Blacklisting Duration</span> to
60.</span>
</li><li class="li step">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div><br><img class="image" id="task_pln_xdr_sq__image_cwt_3bg_vs" src="https://documentation.media5corp.com/download/attachments/62825785/MonitoringParameters.png" width="800"><br></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title32" id="task_lzt_1k1_mr">
<h2 class="title topictitle2" id="ariaid-title32">Setting the Keep-Alive Interval</h2>
<div class="body taskbody">
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Call Agent Configuration</span>
table, click <img class="image" id="task_lzt_1k1_mr__image_m2z_pmt_4r" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="14"> next to the Call Agent you wish to configure.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Keep-Alive Interval</span>, indicate
the interval in seconds for sending SIP options to the Call Agent Peer host. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> 30 seconds is a good compromise between the speed at which errors are
detected versus the resources used by the keep-alive signals.</div>
</div>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> 0 indicates that the keep-alive feature is disabled.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
</li></ol></section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title33" id="topic_title_Basic_Ruleset_Tasks_d1e48">
<h1 class="title topictitle1" id="ariaid-title33">Basic Ruleset Tasks</h1>
<article class="topic task nested1" aria-labelledby="ariaid-title34" id="task_a5v_y2q_bq">
<h2 class="title topictitle2" id="ariaid-title34">Importing Rulesets</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>Rulesets must be imported. The latest Ruleset package can be found on the <a class="xref" href="https://media5.secure.force.com/supportportal" target="_blank">
https://media5.secure.force.com/supportportal</a> (you will be required to supply
a user name and password). </section>
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>This procedure is valid for Call Agent and Routing Rulesets.</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">File</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Required Rulesets depend on the scenario being configured. Refer to the
Call Agent and Routing Ruleset sections of the configuration notes for
details on Rulesets needed to complete the configuration. </div>
</div>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Step 2 is only required when importing the first Ruleset and if you are
not using a secure connexion to access the Management Interface
(http://).</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Activate unsecure
file importation from the Web browser</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Path</span> field,
select sbc/rulesets/.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Browse</span>, and
navigate to the Ruleset you wish to import.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Ruleset file extension must be *.crs for Call Agent Rulesets or *.rrs for
Routing Rulesets.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Import</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The imported Ruleset will appear in the <span class="keyword wintitle">Internal files</span> table, with the
selected path in front of the name. The Ruleset will be available in the tables of the
<span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Rulesets</span> page.<br><img class="image" id="task_a5v_y2q_bq__image_x2z_fxl_hs" src="https://documentation.media5corp.com/download/attachments/62825785/ImportFileThroughWebBrowser_ruleset.png" width="800"><br></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title35" id="task_xvg_rlx_bq">
<h2 class="title topictitle2" id="ariaid-title35">Modifying a Ruleset</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>This procedure applies to Call Agent and Routing Rulesets</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Rulesets</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Rulesets</span> page,
click <img class="image" id="task_xvg_rlx_bq__image_bwp_vtk_sr" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="14"> located on the row of the Ruleset you wish to modify.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Ruleset Edit</span>
page, click <span class="keyword wintitle">Edit</span>
located on the row of the rule you wish to modify. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Conditions</span> and
<span class="keyword wintitle">Actions</span> section,
modify the fields as required. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> For more details on Actions and Conditions, refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGW2037/Reference+Guide" target="_blank">DGW Configuration Guide - Reference
Guide</a> published on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">If necessary, click <span class="keyword wintitle">Add condition</span> to add another
condition. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">If necessary, click <span class="keyword wintitle">Add</span> to add another action. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The modified rule is saved but the modified configuration is not yet
applied to the system.</div>
</div>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Rules are executed from top to bottom. Consider <a class="xref" href="#task_k33_yqr_sr">Changing the Execution Priority Level of a Ruleset Rule</a>. </div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The modified configuration is now applied to the system.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The Ruleset will be applied with the new changes. </section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title36" id="task_nck_ktr_sr">
<h2 class="title topictitle2" id="ariaid-title36">Adding Rules to a Ruleset</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>This procedure applies to Call Agent and Routing Rulesets</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Rulesets</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Rulesets</span> page,
click <img class="image" id="task_nck_ktr_sr__image_bwp_vtk_sr" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="14"> located on the row of the Ruleset for which you wish to add a rule.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Ruleset Edit</span>
page, </span>
<ul class="ul choices" id="task_nck_ktr_sr__choices_v2t_vtr_sr">
<li class="li choice">click <span class="keyword wintitle">Insert new rule</span> to add a
rule at the top of the list of rules</li>
<li class="li choice">click <span class="keyword wintitle">Append new rule</span> to add a
rule at the bottom of the list of rules. </li>
</ul>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Conditions</span> and
<span class="keyword wintitle">Actions</span> sections,
complete the fields as required. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> For more details on Actions and Conditions, refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Reference+Guide" target="_blank">DGW Configuration Guide - Reference
Guide</a> document published on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">If necessary, click <span class="keyword wintitle">Add condition</span> to add another
condition. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">If necessary, click <span class="keyword wintitle">Add</span> to add another action. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The new rule is added to the Ruleset and saved, but the modified
configuration is not yet applied to the system.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The modified configuration is now applied to the system.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The rule will be executed the next time the Ruleset is used.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title37" id="task_xhw_xxk_sr">
<h2 class="title topictitle2" id="ariaid-title37">Changing the Name and Description of a Ruleset</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>This procedure applies to Call Agent and Routing Rulesets.</section>
<section id="task_xhw_xxk_sr__steps_cfd_1yk_sr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_xhw_xxk_sr__steps_cfd_1yk_sr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Rulesets</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Rulesets</span> page,
click <img class="image" id="task_xhw_xxk_sr__image_bwp_vtk_sr" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="14"> located on the row of the Ruleset you wish to modify.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Ruleset Edit</span>
page, click <span class="keyword wintitle">Change Name /description</span>
located next to the name of the Ruleset.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Ruleset Change Name/Description</span>
page, modify the fields as required. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The new name is saved but the modified configuration is not yet applied to
the system.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span> >
<span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The modified configuration is now applied to the system.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>If you change de name of the Ruleset, you will need to re-associate the Ruleset to
the Call Agent it is associated with otherwise, the configuration will be considered
invalid.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title38" id="task_xfw_mkq_sr">
<h2 class="title topictitle2" id="ariaid-title38">Deleting a Ruleset</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>This procedure applies to Call Agent and Routing Rulesets.</section>
<section id="task_xfw_mkq_sr__steps_wtg_xvk_sr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_xfw_mkq_sr__steps_wtg_xvk_sr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Rulesets</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Rulesets</span> page,
click <img class="image" id="task_xfw_mkq_sr__image_drw_wkq_sr" src="https://documentation.media5corp.com/download/attachments/62825785/minus.jpg" width="14"> next
to the Ruleset you wish to delete.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">OK</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span><span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The modified configuration is now applied to the system.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The Ruleset will no longer be available in the <span class="keyword wintitle">Rulesets</span> page to be associated with
a Ruleset. If the Ruleset was associated with a Call Agent, it will need to be removed
manually from the list of Rulesets associated with the Call Agent otherwise, the
configuration will be considered invalid.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title39" id="task_s4d_xyk_sr">
<h2 class="title topictitle2" id="ariaid-title39">Cloning a Ruleset</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>This procedure applies to Call Agent and Routing Rulesets</section>
<section id="task_s4d_xyk_sr__steps_wtg_xvk_sr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_s4d_xyk_sr__steps_wtg_xvk_sr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Rulesets</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Rulesets</span> page,
click <img class="image" id="task_s4d_xyk_sr__image_mnd_zzk_sr" src="https://documentation.media5corp.com/download/attachments/62825785/clone.jpg" width="14"> next
to the Ruleset you wish to clone.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">OK</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The cloned Ruleset will be added at the end of the table. The name of the
cloned Ruleset will include a numerical suffix to distinguish it from the
original Ruleset.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Rulesets</span> page,
click <img class="image" id="task_s4d_xyk_sr__image_bwp_vtk_sr" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="14"> located on the row of the Ruleset you have just cloned.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Edit</span> next to
the rules you wish to modify. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Conditions</span> and
<span class="keyword wintitle">Actions</span> section,
modify the fields as required. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> For more details on Actions and Conditions, refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Reference+Guide" target="_blank">Reference Guide</a> published on the
Media5 documentation portal.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">If necessary, click <span class="keyword wintitle">Add condition</span> to add another
condition. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">If necessary, click <span class="keyword wintitle">Add</span> to add another action. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Change Name /description</span> to
change the name and the description of the Ruleset.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The new cloned rule is saved but the modified configuration is not yet
applied to the system.</div>
</div>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Rules are executed from top to bottom. Consider <a class="xref" href="#task_k33_yqr_sr">Changing the Execution Priority Level of a Ruleset Rule</a>. </div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span> >
<span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The modified configuration is now applied to the system.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The new Ruleset is available to be associated with a Call Agent.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title40" id="task_mnj_qvk_sr">
<h2 class="title topictitle2" id="ariaid-title40">Creating a New Ruleset</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>This procedure applies to Call Agent and Routing Rulesets.<div class="note note note_note"><span class="note__title">Note:</span> To save time,
consider <a class="xref" href="#task_s4d_xyk_sr">Cloning a Ruleset</a>.</div></section>
<section id="task_mnj_qvk_sr__steps_wtg_xvk_sr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_mnj_qvk_sr__steps_wtg_xvk_sr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Rulesets</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Rulesets</span> page,
enter a name in the empty field of either the <span class="keyword wintitle">Call Agent Rulesets</span> or
<span class="keyword wintitle">Routing Rulesets</span>
table.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <img class="image" id="task_mnj_qvk_sr__image_t4h_1wk_sr" src="https://documentation.media5corp.com/download/attachments/62825785/Plusbleu.jpg" width="12"> .</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The name of the Ruleset will be added at the end of the table.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Rulesets</span> page,
click <img class="image" id="task_mnj_qvk_sr__image_bwp_vtk_sr" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="14"> located on the row of the Ruleset you have just created.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Ruleset Edit</span>
page, in either the <span class="keyword wintitle">Outbound Rules</span> or <span class="keyword wintitle">Inbound Rules</span>, click
<span class="keyword wintitle">Insert new rule</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Conditions</span> and
<span class="keyword wintitle">Actions</span> section,
complete the fields as required. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> For more details on Actions and Conditions, refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Reference+Guide" target="_blank">DGW Configuration Guide - Reference
Guide</a> document published on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">If necessary, click <span class="keyword wintitle">Add condition</span> to add another
condition. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">If necessary, click <span class="keyword wintitle">Add</span> to add another action. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The new rule is saved but the modified configuration is not yet applied to
the system.</div>
</div>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Rules are executed from top to bottom. Consider <a class="xref" href="#task_k33_yqr_sr">Changing the Execution Priority Level of a Ruleset Rule</a>. </div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span> / <span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The modified configuration is applied to the system.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The new Ruleset is available to be associated with a Call Agent.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title41" id="task_k33_yqr_sr">
<h2 class="title topictitle2" id="ariaid-title41">Changing the Execution Priority Level of a Ruleset Rule</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>This procedure applies to Call Agent and Routing Rulesets.</section>
<section id="task_k33_yqr_sr__steps_wtg_xvk_sr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_k33_yqr_sr__steps_wtg_xvk_sr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Rulesets</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <img class="image" id="task_k33_yqr_sr__image_wt3_pnp_5r" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="14"> next to the Ruleset for which you wish to change the priority
level of rules.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Use the <span class="keyword wintitle">Up</span> and
<span class="keyword wintitle">Down</span> buttons to
move the rules. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span><span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The changes are saved to the configuration and the modified configuration
is now applied to the system.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>Inbound rules of the Ruleset are executed in ascending Ruleset priority order but
Outbound rules are executed in descending Ruleset priority order.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title42" id="task_bsk_dqp_5r">
<h2 class="title topictitle2" id="ariaid-title42">Changing the Execution Priority Level of a Rule Action</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>This procedure applies to Call Agent and Routing Rulesets</section>
<section id="task_bsk_dqp_5r__steps_wtg_xvk_sr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_bsk_dqp_5r__steps_wtg_xvk_sr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Rulesets</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <img class="image" id="task_bsk_dqp_5r__image_aj5_4qp_5r" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="14"> next to the Ruleset for which you wish to change the priority
level of rule actions.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Edit</span> next to
the rule for which you wish to change the actions order. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <img class="image" id="task_bsk_dqp_5r__image_jfl_yrp_5r" src="https://documentation.media5corp.com/download/attachments/62825785/FlecheDownNoirepp.jpg"> or
<img class="image" id="task_bsk_dqp_5r__image_zpf_y35_q5" src="https://documentation.media5corp.com/download/attachments/62825785/FlecheUpNoire.jpg"> to move
actions. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The new priority level is saved but the modified configuration is not yet
applied to the system.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The modified configuration is now applied to the system.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>When the Ruleset is used, the actions of a rule are always executed in the ascending
priority order. </section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title43" id="task_lbp_bsp_5r">
<h2 class="title topictitle2" id="ariaid-title43">Changing the Execution Priority Level of a Rule Condition</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>This procedure applies to Call Agent and Routing Rulesets</section>
<section id="task_lbp_bsp_5r__steps_wtg_xvk_sr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_lbp_bsp_5r__steps_wtg_xvk_sr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Rulesets</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <img class="image" id="task_lbp_bsp_5r__image_l5w_5gq_5r" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="14"> next to the Ruleset for which you wish to change the priority
level of rule conditions.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Edit</span> next to
the rule for which you wish to change the conditions order. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <img class="image" id="task_lbp_bsp_5r__image_fqn_tgq_5r" src="https://documentation.media5corp.com/download/attachments/62825785/FlecheDownNoirepp.jpg" width="16"> or <img class="image" id="task_lbp_bsp_5r__image_jm2_5gq_5r" src="https://documentation.media5corp.com/download/attachments/62825785/FlecheUpNoire.jpg" width="12"> to move conditions. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The new priority level is saved but the modified configuration is not yet
applied to the system.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The modified configuration is now applied to the system.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>When the Ruleset is used, the conditions of the rule are always executed in the
ascending priority order. </section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title44" id="topic_title_Basic_Registration_Tasks_d1e59">
<h1 class="title topictitle1" id="ariaid-title44">Basic Registration Tasks</h1>
<article class="topic task nested1" aria-labelledby="ariaid-title45" id="task_lmn_cfm_hq">
<h2 class="title topictitle2" id="ariaid-title45">Configuring a Registration Agent</h2>
<div class="body taskbody"><p class="shortdesc">Configure the registration agent used to issue the registrations.</p>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Registration</span>.</span>
</li><li class="li step stepexpand" id="task_lmn_cfm_hq__2">
<span class="ph cmd">In the <span class="keyword wintitle">Registration Agent Configuration</span> table, click <img class="image" id="task_lmn_cfm_hq__image_lrd_g3w_wr" src="https://documentation.media5corp.com/download/attachments/62825785/Plusbleu.jpg" width="14">.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> A new line of fields is added.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Complete the <span class="keyword wintitle">User Name</span>, <span class="keyword wintitle">Friendly Name</span>, and
<span class="keyword wintitle">Domain parameters</span>
fields according to the service provider's requirements.</span>
</li><li class="li step stepexpand" id="task_lmn_cfm_hq__4">
<span class="ph cmd">In the <span class="keyword wintitle">Contact</span> field,
enter credentials to register against the service provider. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Format must be sip:user@public_IP Address or sip:public_IP Address or
sips:user@public_IP_Address:sip listening port;uri-parameters of the unit.
</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">If necessary, repeat <a class="xref" href="#task_lmn_cfm_hq__2">step 2
</a> to <a class="xref" href="#task_lmn_cfm_hq__4">step 4 </a> if you
are using more than one service provider.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div><img class="image" id="task_lmn_cfm_hq__image_wky_sfg_v5" src="https://documentation.media5corp.com/download/attachments/62825785/RegistrationAgentConfiguration_edge.png"></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title46" id="task_nrh_wyq_sq">
<h2 class="title topictitle2" id="ariaid-title46">Finding a Specific AoR in the Registration Cache</h2>
<div class="body taskbody">
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Registration</span></span>
</li><li class="li step">
<span class="ph cmd">In the <span class="keyword wintitle">Filter</span> table,
enter the AoR.</span>
</li><li class="li step">
<span class="ph cmd">Click <span class="keyword wintitle">Search</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The <span class="keyword wintitle">Registration Cache</span> table only displays the registration(s)
related to the selected AoR.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title47" id="task_rj1_lkp_ks">
<h2 class="title topictitle2" id="ariaid-title47">Clearing the Registration Cache</h2>
<div class="body taskbody">
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">SBC</span>/<span class="keyword wintitle">Registration</span>.</span>
</li><li class="li step">
<span class="ph cmd">Click <span class="keyword wintitle">Clear Registration Cache</span>
located under the <span class="keyword wintitle">Registration Cache</span>
table.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div> All entries of the <span class="keyword wintitle">Registration Cache</span> table will be
erased and Registration Throttling will restart from scratch. The next REGISTERs will be
immediately relayed to their destinations on their first occurrence.</section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title48" id="topic_title_Parameters_d1e63">
<h1 class="title topictitle1" id="ariaid-title48">Parameters</h1>
<article class="topic reference nested1" aria-labelledby="ariaid-title49" id="reference_lxl_ljw_bq">
<h2 class="title topictitle2" id="ariaid-title49">SBC/Configuration Parameters</h2>
<div class="body refbody">
<section class="section"><div class="p">Although the services can be configured in great part in the web browser, some
aspects of the configuration can only be completed with the MIB
parameters by :<ul class="ul" id="reference_lxl_ljw_bq__ul_gfn_14v_wr">
<li class="li">using a MIB browser</li>
<li class="li">using the CLI</li>
<li class="li">creating a configuration script containing the
configuration parameters</li>
</ul></div>For more details on the following parameters ,refer to the
<a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Reference+Guide" target="_blank">DGW Configuration Guide - Reference
Guide</a> published on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>.</section>
<section class="section"><h3 class="title sectiontitle">Tcp Connect Timeout</h3>Refer to <span class="keyword parmname">
Sbc.SignalingInterface.TcpConnectTimeout</span> .</section>
<section class="section"><h3 class="title sectiontitle">Tcp Idle Timeout</h3> Refer to<span class="keyword parmname">
Sbc.SignalingInterface.TcpIdleTimeout</span>.</section>
<section class="section"><h3 class="title sectiontitle">Registration Expiration</h3>Refer to
<span class="keyword parmname">Sbc.RegistrationAgent.ExpireValue</span>.</section>
<section class="section"><h3 class="title sectiontitle">Registration Expiration</h3>Refer to
<span class="keyword parmname">Sbc.RegistrationAgent.RetryInterval</span>.</section>
<section class="section"><h3 class="title sectiontitle">Min Severity</h3>Refer to <span class="keyword parmname">Sbc.MinSeverity</span>.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested1" aria-labelledby="ariaid-title50" id="reference_hsg_1mf_qr">
<h2 class="title topictitle2" id="ariaid-title50">SBC/Status Parameters</h2>
<div class="body refbody">
<section class="section"><div class="p">Although the services can be configured in great part in the web browser, some
aspects of the configuration can only be completed with the MIB parameters by:<ul class="ul" id="reference_hsg_1mf_qr__ul_gfn_14v_wr">
<li class="li">using a MIB browser</li>
<li class="li">using the CLI</li>
<li class="li">creating a configuration script containing the configuration variables</li>
</ul></div>For more details on the following parameters, refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Reference+Guide" target="_blank">DGW Configuration Guide - Reference Guide</a> document published on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>.</section>
<section class="section"><h3 class="title sectiontitle">Tcp Connect Timeout</h3>Refer to<span class="keyword parmname">
Sbc.SignalingInterfaceStatus.TcpConnectTimeout</span>.</section>
<section class="section"><h3 class="title sectiontitle">Tcp Idle Timeout</h3> Refer to<span class="keyword parmname">
Sbc.SignalingInterfaceStatus.TcpIdleTimeout</span></section>
<section class="section"><h3 class="title sectiontitle">Need Restart Info </h3> Refer to<span class="keyword parmname">
Sbc.NeedRestartInfo</span>.</section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested0" aria-labelledby="ariaid-title51" id="reference_j4g_nbv_gfb">
<h1 class="title topictitle1" id="ariaid-title51">Online Help</h1>
<p class="shortdesc"><span class="ph">If you are not familiar with the meaning of the fields and
buttons, click <span class="keyword wintitle">Show Help</span>, located at the upper right corner of
the Web page. When activated, the fields and buttons that offer online help will
change to green and if you hover over them, the description will bedisplayed.</span></p>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title52" id="concept_v4k_q3h_1r">
<h1 class="title topictitle1" id="ariaid-title52">DGW Documentation</h1>
<div class="body conbody"><p class="shortdesc">Mediatrix devices are supplied with an exhaustive set of documentation. </p>
<p class="p">Mediatrix user documentation is available on the <a class="xref" href="http://documentation.media5corp.com" target="_blank">Media5 Documentation
Portal</a>.</p>
<div class="p">Several types of documents were created to clearly present the information you are looking for.
Our documentation includes:<ul class="ul" id="concept_v4k_q3h_1r__ul_bqy_cjh_1r">
<li class="li"><strong class="ph b">Release notes</strong>: Generated at each GA release, this document includes the known and
solved issues of the software. It also outlines the changes and the new features the release
includes.</li>
<li class="li"><strong class="ph b">Configuration notes</strong>: These documents are created to facilitate the configuration of a
specific use case. They address a configuration aspect we consider that most users will need to
perform. However, in some cases, a configuration note is created after receiving a question
from a customer. They provide standard step-by-step procedures detailing the values of the
parameters to use. They provide a means of validation and present some conceptual information.
The configuration notes are specifically created to guide the user through an aspect of the
configuration. </li>
<li class="li"><strong class="ph b">Technical bulletins</strong>: These documents are created to facilitate the configuration of a
specific technical action, such as performing a firmware upgrade.</li>
<li class="li"><strong class="ph b">Hardware installation guide</strong>: They provide the detailed procedure on how to safely and
adequately install the unit. It provides information on card installation, cable connections,
and how to access for the first time the Management interface.</li>
<li class="li"><strong class="ph b">User guide</strong>: The user guide explains how to customise to your needs the configuration
of the unit. Although this document is task oriented, it provides conceptual information to
help the user understand the purpose and impact of each task. The User Guide will provide
information such as where and how TR-069 can be configured in the Management Interface, how to
set firewalls, or how to use the CLI to configure parameters that are not available in the
Management Interface.</li>
<li class="li"><strong class="ph b">Reference guide</strong>: This exhaustive document has been created for advanced users. It
includes a description of all the parameters used by all the services of the Mediatrix units.
You will find, for example, scripts to configure a specific parameter, notification messages
sent by a service, or an action description used to create Rulesets. This document includes
reference information such as a dictionary, and it does not include any step-by-step
procedures. </li>
</ul></div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title53" id="concept_fqm_rv4_k4">
<h1 class="title topictitle1" id="ariaid-title53">Copyright Notice</h1>
<div class="body conbody"><p class="shortdesc">Copyright © 2023 Media5 Corporation.</p>
<p class="p">This document contains information that is proprietary to Media5 Corporation.</p>
<p class="p">Media5 Corporation reserves all rights to this document as well as to the Intellectual Property
of the document and the technology and know-how that it includes and represents.</p>
<p class="p">This publication cannot be reproduced, neither in whole nor in part, in any form whatsoever,
without written prior approval by Media5 Corporation.</p>
<p class="p">Media5 Corporation reserves the right to revise this publication and make changes at any time
and without the obligation to notify any person and/or entity of such revisions and/or
changes.</p>
</div>
</article></article></main></body></html> |
