Knowlege base

PBX Configuration

Article ID: 880
Last updated: 01 Apr, 2022

The configuration of CUCM for Imagicle Manager Assistant (IMA) goes through the following steps:

  • Partitions and CSS definitions
  • SIP Trunk Security Profile definition
  • SIP Trunk definitions
  • Routing:
    • Route Group
    • Route List
    • Route Patterns
    • SIP Route Patterns

1. CSS and manager(s) partition configuration

The following Partitions and CSS are required to allow rerouting to the IMA Server:

  • one new partition (PT_IMA_Managers), used to host the Manager DNs
  • one new CSS (CSS_for_IMA) to be assigned to Imagicle SIP trunks to reach the managers DNs and, possibly, external destinations triggered by the forward status.

Assistant(s) and other users (including incoming VG/SBC) will keep using their original CSS.

The IMA service via the SIP Trunk will be the only one with an assigned CSS able to reach directly the manager(s) device (phone/softphone). Hereafter, we will suppose assistants and other users DN are placed in the PT_IP_Phones partition.

Define a new partition called PT_IMA_Managers. After that, move the manager(s) DN to this new partition.

Create a new CSS called CSS_for_IMA and add the following partitions in the following order:

  1. PT_IMA_Managers (as first partition)
  2. PT_IP_Phones
  3. Any other relevant partition to reach out PSTN destinations

2. SIP Trunk Security Profile

Define a new SIP trunk security profile called "IMA_SIP_Trunk_Security_Profile", with following relevant settings to be set:

Outgoing Transport Type UDP*
Incoming Port 5060
Accept presence subscription enabled
Accept out-of-dialog refer enabled
Accept unsolicited notification enabled
Accept replaces header enabled

* NOTE: you can configure "Outgoing Transport Type" to use UDP (default) or TCP, both options are supported.

All the other parameters can be kept to their default values.

Note: If you need to define a Secure (TLS) SIP Trunk, please refer to the relevant section below.

3. SIP Profile

Define a new SIP Profile called IMA_SIP_Profile, with following relevant settings to be set:

SIP Profile Information
Redirect by Application enabled
Assured Services SIP conformance enabled
Parameters used in Phone
Semi Attended Transfer enabled
Trunk Specific Configuration
SIP Rel1XX Options Disabled
Early Offer support for voice and video calls Mandatory (insert MTP if needed)
SIP OPTIONS Ping
Enable OPTIONS Ping to monitor destination status for Trunks with Service Type "None (Default)" enabled
Ping Interval for In-service and Partially In-service Trunks (seconds) 10
Ping Interval for Out-of-service Trunks (seconds) 20
Ping Retry Timer (milliseconds) 500
Ping Retry Count 6

All the other parameters can be kept to their default values.

4. SIP Trunk

Define a new SIP Trunk called IMA_SIP_Trunk_Primary for the (primary) IMA instance, with following relevant settings to be set:

Device Information
Device Name IMA_SIP_Trunk_Primary
Media Resource Group List not required*
Media Termination Point Required not required*
Inbound Calls
Calling Search Space CSS_for_IMA (see above)
SIP Information
Destination Address IPv4 of the (primary) IMA instance
Destination Port 5060
MTP Preferred Originating Codec (if necessary) can be either G.711U/G.711A/G.729/G.729A
SIP Trunk Security Profile IMA_SIP_Trunk_Security_Profile (see above)
Rerouting Calling Search Space CSS_for_IMA (see above)
Out-Of-Dialog Refer Calling Search Space CSS_for_IMA (see above)
SUBSCRIBE Calling Search Space CSS_for_IMA (see above)
SIP Profile IMA_SIP_Profile (see above)

* NOTE: Media Resource Group and Media Termination Point are not required but this may depend on the specific CUCM configuration.

All the other parameters can be kept to their default values.

In case of HA, create a second SIP Trunk repeating the same procedure for the backup IMA instance.

5. Route Group (only if HA deployment)

Define a new Route Group called RG_Imagicle_IMA, with following relevant settings to be set:

Route Group Information
Distribution Algorithm Top Down
Route Group Member Information
Selected Devices all the trunks pointing to IMA instances

All the other parameters can be kept to their default values.

6. Route List (only if HA deployment)

Define a new Route List called RL_Imagicle_IMA, with following relevant settings to be set:

Route List Member Information
Selected Groups RG_Imagicle_IMA (see above)

All the other parameters can be kept to their default values.

7. Route Pattern

Define a new Route Pattern called RP_Imagicle_IMA, with following relevant settings to be set:

Pattern Definition
Route Pattern route pattern must be equal to the manager's DN*
Gateway/Route List trunk pointing to the IMA instance. In case of HA deployment, the route list RL_Imagicle_IMA (see above)

* NOTE: if there are more than one manager, create more Route Pattern, one for each manager

All the other parameters can be kept to their default values.

Secure (TLS) SIP Trunk

To support SIP over TLS, you have to do some different configurations respect the "not secure" scenario. In particular, you have to:

  • upload the certificate onto the CUCM
  • define a SIP Trunk Security Profile with specific settings
  • define a SIP Trunk toward port 5061 of the IMA instance(s)

for all other steps, you can refer to the sections above, hence they are the same also for the "secure" scenario.

1. Certificate upload

First step is to upload the relevant certificates in CallManager-trust repository. Relevant certificates are:

  • the root and the intermediate CA certificates, for signed certificates
  • the certificate itself, for self-signed certificates

To load the certificate on CUCM:

  • Log on CUCM as Administrator
  • Select OS Administration
  • From the menu, choose Security, Certificate Management
  • Press the "Upload Certificate / Certificate chain" button
  • As certificate purpose, choose "Callmanager-trust"
  • Enter a description and then select Imagicle certificate from your PC and upload it
  • Press "Close" to go back to the certificate list

  • Press "Find" to list the certificates. Locate the IMA certificate you just uploaded.
  • Take note of the certificate Common Name for later use (in the example below, imagicle.com)

Note:  if you have uploaded a CA cert, you must restart CUCM and TFTP services after the upload.

2. SIP Trunk Security Profile

Define a new SIP trunk security profile called "IMA_SIP_Trunk_Security_Profile", with following relevant settings to be set:

Device Security Mode Encrypted
Incoming Transport Type TLS
Outgoing Transport Type TLS
X.509 Subject Name Common Name included in the certificate imported to CUCM (imagicle.com in the example above)
Incoming Port 5061
Accept presence subscription enabled
Accept out-of-dialog refer enabled
Accept unsolicited notification enabled
Accept replaces header enabled
Transmit security status enabled

All the other parameters can be kept to their default values.

3. SIP Trunk

Define a new SIP Trunk called IMA_SIP_Trunk_Primary for the (primary) IMA instance, with following relevant settings to be set:

Device Information
Device Name IMA_SIP_Trunk_Primary
Media Resource Group List not required*
Media Termination Point Required not required*
Inbound Calls
Calling Search Space CSS_for_IMA (see above)
SIP Information
Destination Address IPv4 of the (primary) IMA instance
Destination Port 5061
MTP Preferred Originating Codec (if necessary) can be either G.711U/G.711A/G.729/G.729A
SIP Trunk Security Profile IMA_SIP_Trunk_Security_Profile (see above)
Rerouting Calling Search Space CSS_for_IMA (see above)
Out-Of-Dialog Refer Calling Search Space CSS_for_IMA (see above)
SUBSCRIBE Calling Search Space CSS_for_IMA (see above)
SIP Profile IMA_SIP_Profile (see above)

* NOTE: Media Resource Group and Media Termination Point are not required but this may depend on the specific CUCM configuration.

All the other parameters can be kept to their default values.

In case of HA, create a second SIP Trunk repeating the same procedure for the backup IMA instance.

IMA Filter BLF/Speed Dial configuration

It is possible to configure a BLF/SD button to control the status of the IMA filter. Thanks to this feature, an assistant can see the current status of the IMA filter for each manager he/she is associated to and he/she can also change the IMA filter status directly from the deskphone.

Note: To configure the IMA filter BLF/SD button, the phone must be configured in SIP (SCCP is not supported).

This is what you have to configure:

  • a Route Pattern for each manager you want to control the IMA Filter for
  • a BLF/SD on the assistant(s) phone(s)

1. Route Pattern

Define a new Route Pattern called RP_Imagicle_IMA_Filter, with following relevant settings to be set:

Pattern Definition
Route Pattern *12<manager's DN> (i.e., *121000, if 1000 is the manager's DN) *
Partition Select the original partition of the manager DN
Gateway/Route List trunk pointing to the IMA instance. In case of HA deployment, the route list RL_Imagicle_IMA (see above)

* NOTES:

  • if there are more than one manager, create more Route Patterns, one for each manager, the prefix is always *12 and it cannot be changed;
  • If the manager DN is in +E.164 format, remember to escape the + symbol (i.e., *12\+3912345678987 ).

All the other parameters can be kept to their default values.

2. BLF/SD

To configure the BLF/SD for the IMA Filter, open the assistant's phone's configuration on the CUCM and select "Modify Button Items".
Then, from the "Unassigned Associated Items", select "Add a new BLF SD" and move it to the "Associated Items" list. It may be possible you have to remove an item from the "Associated Items" list before to be able to add the BLF SD item.

Then select the new link "Add a new BLD SD" under the Association menu

At this point set the following values:

Busy Lamp Field/Speed Dial Button Settings
Destination <Route Pattern configured above>@<Domain> (i.e., *121000@imagicle.com)
Directory Number None
Label IMA Filter (or what you prefer)

see example below:

Then click on Save and Close.

Finally, ensure the SUBSCRIBE Calling Search Space of the assistant(s) and manager phones includes the partition of the Route Pattern defined above.

Enabling IMA gadget in Jabber clients

Configuration task list

  1. Check access to the Imagicle server from the PC
  2. Ensure Imagicle Application Suite integrated Active Directory authentication is enabled
  3. Configure UC Service(s) for each Jabber client type 
  4. Restart the Cisco Jabber client

First two steps are the same available above into CuCM version <= 12.0 paragraph

1.  Configure UC Service(s) for each Jabber client type

CuCM allows to create multiple UC Services, related to specific Jabber configurations to associate to different Jabber clients type. Pls. access to this feature by logging into "Cisco Unified CM Administration" web portal and select User Management User Settings ⇒ UC service

Click on Add New to create a new UC Service Type "Jabber Client Configuration (jabber-config.xml)"

If not yet available, you can start compiling the first part of UC Service with some parameters related to Cisco environment. See a sample below:

Then you can add a "Client" section for each Jabber Gadget to enable, following the sample below:

Here is a list of URLs to add into Icon and URL field:

IMA Icon ⇒ http://IMA_IP_address/coresip/web/jabber/ima.png
IMA URL ⇒ http://IMA_IP_address/coresip/web/jabber/ima/

Please replace "IMA_IP_address" with Manager Assistant VM's IP address or DNS name. The parameter "internal" should be set to true to allow gadget tunneling over MRA. This is the correct configuration for gadgets associated to PC/Mobile Jabber clients.

For MacOS-based and Mobile Jabber clients, where gadget traffic MRA tunneling is currently not supported, you need direct access to Imagicle Manager Assistant Web Portal (via Internet or via VPN). To force Jabber to NOT use MRA tunneling, you need to set "internal" parameter to false. Please create a specific profile for Jabber mobile/MAC.

2.  Assigning UC Services into CUCM Service Profile

Once required UC Service(s) have been defined, please configure them into the CuCM Service Profile associated to each End User. You can add three different UC Services into each Service Profile. See sample below:

Troubleshooting

The gadget configuration is trivial. The most common mistakes are: wrong configuration file name, invalid xml syntax because of broken tags, wrong XML file format (must be UTF-8), invalid characters in the Jabber URL inside the config file. Please ensure you are typing only ANSI characters in the Imagicle Server DNS name and in the file name.

To test Imagicle IMA Jabber access, open a supported web browser and enter the application URL, replacing IMA_IP_address with the Imagicle Manager Assistant server's IP address or DNS name:

http://IMA_IP_address/coresip/web/jabber/ima/

​The login form should be displayed.

You can then test the access from a Cisco Jabber client, by manually adding the gadget as a custom tab.

Article ID: 880
Last updated: 01 Apr, 2022
Revision: 5
Views: 173
Print Export to PDF Subscribe Share
This article was:  
Prev   Next
Deployment     Product Administration