Bulk import for SIP Entities

Last Updated : May 10, 2021 |

The following rules apply when creating an XML bulk import file:

  • The name of a SIP Entity must be unique. Other elements refer to the SIP Entity name.

  • The value of <adaptationName> must be an adaptation or refer to an existing adaptation with the same name. The <adapationName> must appear in the System Manager database or in an import file that exists in the same import operation as the SIP Entity. SIP Entity of type ASM <Avaya Session Manager> cannot contain an adaptation entry.

  • <adaptationName> contains the adaptation module name and parameters separated by spaces <examples below>.

  • When the Regular Expression Adaptation feature is enabled, use <adaptations> as a child element and <adaptationName> for multiple assignments. If the Regular Expression Adaptation feature is disabled, use <adaptationName> for assigning single adaptation.

  • Listen ports (<listenports>) are only relevant for SIP Entity of type ASM. Do not include these entries for any other type of SIP Entity.

  • Multiple listen ports entries (<listenports>) can be configured for one ASM SIP Entity.

    • <sipdomainName> must refer to an existing domain with the same name. It must appear in the System Manager database or in an import file that exists in the same import operation as the SIP Entity.

    • The values in <transportprotocol> must appear same (being case sensitive) as they appear in the System Manager user interface.

  • The values of <timezoneName> should be same (being case sensitive) as that of the field Time Zone in the SIP Entity user interface in System Manager.

  • The field <userfc3263> corresponds to the Override Port & Transport with DNS SRV check box in the SIP Entity Details form.

  • The value of <entitytype> must contain one of the following values. Being case sensitive, must exactly appear as follows:

    • CM: Communication Manager in the user interface.

    • ASM: Session Manager in the user interface.

    • Messaging: Session Manager in the user interface.

    • VP: Voice Portal in the user interface.

    • Gateway: Gateway in the user interface.

    • SIP Trunk: SIP Trunk in the user interface.

    • OTHER: Other in the user interface.

  • The values in <cdrSetting> are case sensitive and must appear exactly as in the System Manager user interface.

  • The field <do_monitoring> corresponds to the field SIP Link Monitoring in the SIP Entity Details form.

    • To enable SIP Link monitoring, set the <do_monitoring> value to yes.

    • To disable SIP Link monitoring, set the <do_monitoring> value to no.

    • To use the Session Manager configuration, the <do_monitoring> tag must be omitted.

Example

This is an example when a single adaptation is assigned to SIP Entity and the Regular Expression Adaptation feature is disabled.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<sipentityFullTOList>
   <buildNumber>0</buildNumber>
  <implementationVersion>0</implementationVersion>
  <specificationVersion>0</specificationVersion>
   <SipentityFullTO>
     <notes></notes>
     <entitytype>ASM</entitytype>
     <fqdnoripaddr>10.64.15.6</fqdnoripaddr>
     <fqdnoripaddr2>2a07:2a42:adc0:14:10:64:15:6</fqdnoripaddr2>
     <ipaddrFamilyType>IPv46</ipaddrFamilyType>
     <ipaddrTolerant>false</ipaddrTolerant>
     <name>Lucifer</name>
     <adaptationName>a digit adaptation</adaptationName>
     <cac_capable>false</cac_capable>
     <cdrSetting>none</cdrSetting>
     <credentialname></credentialname>
     <crlfKeepAliveSecs>0</crlfKeepAliveSecs>
     <do_monitoring>use-instance</do_monitoring>
     <loop_detect_interval_msec>200</loop_detect_interval_msec>
     <loop_detect_mode>off</loop_detect_mode>
     <loop_detect_threshold>5</loop_detect_threshold>
     <monitor_okresponses>1</monitor_okresponses>
     <monitor_proactive_secs>900</monitor_proactive_secs>
     <monitor_reactive_secs>120</monitor_reactive_secs>
     <monitor_retries>1</monitor_retries>
     <securable>false</securable>
     <tcp_failover_port>5060</tcp_failover_port>
     <tcp_failover_port_v6>5060</tcp_failover_port_v6>
     <timer_bf_secs>4</timer_bf_secs>
     <timezoneName>Australia/Melbourne</timezoneName>
     <tls_failover_port>5061</tls_failover_port>
     <tls_failover_port_v6>5061</tls_failover_port_v6>
     <userfc3263>false</userfc3263>
     </SipentityFullTO>
 </SipentityFullTOList>

Example

This is an example when multiple adaptations of digit or regular expression are assigned to s SIP Entity and the Regular Expression Adaptation feature is enabled.

If multiple adaptations are assigned by import, the adaptations must have <adaptationOrder> starting with 1.

If the <adaptationName> or <adaptations> elements does not exist, all adaptations assigned to a SIP Entity are removed.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<sipentityFullTOList>
<buildNumber>0</buildNumber>
<implementationVersion>0</implementationVersion>
<specificationVersion>0</specificationVersion>
 <SipentityFullTO>
        <notes> </notes>
        <entitytype>CM </entitytype>
        <fqdnoripaddr>10.15.64.100 </fqdnoripaddr>
        <ipaddrFamilyType>IPv4 </ipaddrFamilyType>
        <ipaddrTolerant>false </ipaddrTolerant>
        <name>sipentity A </name>
     <adaptations>
         <name>a digit adaptation</name>
         <adaptationOrder>1</adaptationOrder>
     </adaptations>
     <adaptations>
         <name>a regex adaptation</name>
         <adaptationOrder>2</adaptationOrder>
     </adaptations>
     <cac_capable>false </cac_capable>
     <cdrSetting>none </cdrSetting>
     <commproftype>CM </commproftype>
     <credentialname> </credentialname>
     <crlfKeepAliveSecs>1900 </crlfKeepAliveSecs>
     <do_monitoring>use-instance </do_monitoring>
     <loop_detect_interval_msec>200 </loop_detect_interval_msec>
     <loop_detect_mode>on </loop_detect_mode>
     <loop_detect_threshold>5 </loop_detect_threshold>
     <monitor_okresponses>1 </monitor_okresponses>
     <monitor_proactive_secs>900 </monitor_proactive_secs>
     <monitor_reactive_secs>120 </monitor_reactive_secs>
     <monitor_retries>1 </monitor_retries>
     <securable>false </securable>
     <timer_bf_secs>4 </timer_bf_secs>
     <timezoneName>America/Fortaleza </timezoneName>
     <userfc3263>false </userfc3263>
   </SipentityFullTO>
</sipentityFullTOList>