Unified Communication Model

Description

This module implements and centralizes the business logic related to the access of the Unified Communication model on the SOP.

Typical objects of the UC model are described in the Unified Communication Administration Guide. It includes objects such as: directory, profile, status, global parameters...

Optional features:
  • Clustering support: Dynamic profile synchronization in active/active configurations where phones and extensions are registered on two SOPs.
  • External contacts integration: Import an external data source to be merged with the SMP directory.

Release notes

Show release notes
Version 1.15.0 - Early deployment
  • Improvement: Remove netDesktop requirement for extra status (M23939)
  • Dependency:
    • Baseline 2.x or Baseline 1.x
    • Database Schema module v.3.6.0 or higher
    • Application Management Server v.3.4.0 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.8.0 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.14.0 - Early deployment
  • Feature: Added field site (M21790)
  • Dependency:
    • Baseline 2.x or Baseline 1.x
    • Database Schema module v.3.6.0 or higher
    • Application Management Server v.3.4.0 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.8.0 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.13.3 - Early deployment
  • Bugfix: Phone status incorrect because incorrect startup dependency (M21758)
  • Dependency:
    • Baseline 2.x or Baseline 1.x
    • Database Schema module v.1.21.0 or higher
    • Application Management Server v.3.4.0 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.8.0 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.13.2 - Early deployment
  • Bugfix: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Baseline 2.x or Baseline 1.x
    • Database Schema module v.1.21.0 or higher
    • Application Management Server v.3.4.0 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.8.0 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.13.1 - Deprecated
  • Bugfix: Phone status propagation in a cluster could fail (M0)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Baseline 2.x or Baseline 1.x
    • Database Schema module v.1.21.0 or higher
    • Application Management Server v.3.4.0 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.8.0 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.13.0 - Deprecated
  • Feature: Allow netConsole to obtain language from the SOP (M12497)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Baseline 2.x or Baseline 1.x
    • Database Schema module v.1.21.0 or higher
    • Application Management Server v.3.4.0 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.8.0 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.12.0 - Deprecated
  • Bugfix: External contact synchronization failed when one of the extension fields was NULL (M11393)
  • Bugfix: Some password could result in invalid login (M0)
  • Improvement: Evenly spread the load for recurrently scheduled tasks (M8018)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Baseline 2.x or Baseline 1.x
    • Database Schema module v.1.21.0 or higher
    • Application Management Server v.3.4.0 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.8.0 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.11.0 - Deprecated
  • Improvement: Do not store remote attributes to attribute_log, they are transmitted to the clients only (net.Desktop, net.Supervisor) (M9666)
  • Improvement: Avoid storing attribute_logs when value (M9666)
  • Improvement: Some scheduled tasks have been randomized in order to prevent load on vSOPs (M8018)
  • Bugfix: default values could be incorrect when upgrading from a previous version and new options are available (M10261)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.21.0 or higher
    • Application Management Server v.3.4.0 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.8.0 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.10.0 - Deprecated
  • Feature: Publish IP and registration information after bulk admin of resources (M5818)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.21.0 or higher
    • Application Management Server v.3.3.3 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.7.0 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.9.6 - Deprecated
  • Bugfix: Authentication issue when using specific passwords (M6201)
  • Bugfix: WebAPI would not initialize properly if contact name is empty (M5566)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.21.0 or higher
    • Application Management Server v.3.3.3 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.6.0 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher (if lower version installed)

Version 1.9.5 - Deprecated
  • Feature: Added internal command to force sync between sops (M0005448)
  • Bugfix: Database not updated after migration from proxy.pl to call management (M0005221)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.21.0 or higher
    • Application Management Server v.3.3.3 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.6.0 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.9.4 - Deprecated
  • Bugfix: Fetching call history would take a lot of CPU (M0004544)
  • Bugfix: OutOfMemory error occurred when importing 40000 or more contacts (M00005402)
  • Improvement: Show configuration files in SOP Shell (M0004912)
  • Improvement: Merging of directory and external contacts to a single table (M0005364)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.21.0 or higher
    • Application Management Server v.3.3.3 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.5.5 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.9.3 - Deprecated
  • Bugfix: Profile synchronization not working when extension hidden (M0004912)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.16.0 or higher
    • Application Management Server v.3.3.0 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.5.5 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.9.2 - Deprecated
  • Bugfix: Profile synchronization not working due to missing mapping file (M0004826)
  • Bugfix: Licenses for x100 (mConnect) (M0004160)
  • Improvement: review security - using POST instead of GET for authentication requests (M0004155)
  • Improvement: Show only the buddy list in the directory search start interface (M0004548)
  • Feature: Facilitate remote net.Console debugging by accessing local client's logs (M0004165)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.16.0 or higher
    • Application Management Server v.3.3.0 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.5.5 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.9.1 - Deprecated
  • Feature: Provides a replacement of proxy.pl for the phone status and phone registration (M0004545)
  • Bugfix: Directory entry which doesn't have an existing callflow assigned to it causes NullPointerException in UC Model (M0004756)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.16.0 or higher
    • Application Management Server v.3.3.0 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.5.5 or higher
    • Watchdog 1.0.3 or higher
    • SOP API 2.33.0+ (You must install v2.33 of the SOP API Module if the SOP API Module is installed on your SOP)
    • SOP Base module 1.3.1 or higher
    • System Status module 2.3.1 or higher(if lower version installed)

Version 1.9.0 - Deprecated
  • Improvement: Moved WebAPI from API Module to Unfied Communication Model (M0004545)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.16.0 or higher
    • Application Management Server v.3.3.1 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Call Management module v1.5.4 or higher
    • Watchdog 1.0.3 or higher
    • SOP Base module 1.3.1 or higher

Version 1.8.3 - Deprecated
  • Bugfix: Backport from 1.9.3, Fixed hidden extension synchronization issue (M0004912)
  • Bugfix: Backport from 1.9.1, Directory entry which doesn't have an existing callflow assigned to it causes NullPointerException in Unified Communication Model
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.16.0 or higher
    • Application Management Server v.3.3.1 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Watchdog 1.0.3 or higher
    • SOP Base module 1.3.1 or higher

Version 1.8.2 - Deprecated
  • Bugfix: Fixed profile synchonization configuration files
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.16.0 or higher
    • Application Management Server v.3.3.1 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Watchdog 1.0.3 or higher
    • SOP Base module 1.3.1 or higher

Version 1.8.1 - Deprecated
  • Feature: Make optional profile synchronization (M0004526)
  • Bugfix: Imported contact growing in case of invalid XML (M0004432)
  • Bugfix: Do not allow downgrade of escaux-ucmodel package which is required by other modules (M0004540)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.16.0 or higher
    • Application Management Server v.3.3.1 or higher
    • Cluster & Active-Active Support v.1.2 or higher (optional: in a cluster only)
    • Watchdog 1.0.3 or higher
    • SOP Base module 1.3.1 or higher

Version 1.8.0 - Deprecated
  • Improvement: Added login, operation and note in callarchive (M0003773)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.15.0 or higher
    • Application Management Server v.3.3.1 or higher
    • Cluster & Active-Active Support v.1.2 or higher (In a cluster )
    • Watchdog 1.0.3 or higher

Version 1.7.4 - Deprecated
  • Bugfix: Improved robustness of model synchronization (M0004059)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.14.0
    • Application Management Server v.3.3.1
    • Cluster & Active-Active Support v.1.2+ (optional)
    • Watchdog 1.0.3

Version 1.7.3 - Deprecated
  • Improvement: Added POLYCOM phone class (M0003970)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.14.0
    • Application Management Server v.3.2.1
    • Cluster & Active-Active Support v.1.2+ (optional)
    • Watchdog 1.0.3

Version 1.7.2 - Deprecated
  • Feature: mConnect: Buddy List (M0003583)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.14.0
    • Application Management Server v.3.2.1
    • Cluster & Active-Active Support v.1.2+ (optional)
    • Watchdog 1.0.3

Version 1.6.3 - Deprecated
  • Improvement: Added Polycom support
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.12.0
    • Application Management Server v.3.1.0
    • Cluster & Active-Active Support v.1.2+ (optional)
    • Watchdog 1.0.3

Version 1.6.2 - Deprecated
  • Bugfix: Module installation tries to query mserver which is down on a standby machine (M0003742)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.12.0
    • Application Management Server v.3.1.0
    • Cluster & Active-Active Support v.1.2+ (optional)
    • Watchdog 1.0.3

Version 1.6.1 - Deprecated
  • Bugfix: Exception when updating phone status in case of zaptel device (M0003506)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.12.0
    • Application Management Server v.3.1.0
    • Cluster & Active-Active Support v.1.2+ (optional)
    • Watchdog 1.0.3

Version 1.6.0 - Deprecated
  • Bugfix: Error in resolving global vars for a profile class leads to contact download failure (M0002823)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.12.0
    • Application Management Server v.3.1.0
    • Cluster & Active-Active Support v.1.2+ (optional)
    • Watchdog 1.0.3

Version 1.5.4 - Deprecated
  • Improvement: better statistics to DbLayer (M3270)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.12.0
    • Application Management Server v.3.0.16
    • Cluster & Active-Active Support v.1.2+ (optional)
    • Watchdog 1.0.3

Version 1.5.3 - Deprecated
  • Improvement: added statistics to DbLayer (M3270)
  • Dependency:
    • Database Schema module v.1.12.0
    • Application Management Server v.3.0.16
    • Cluster & Active-Active Support v.1.2+ (optional)
    • Watchdog 1.0.3

Version 1.5.2 - Deprecated
  • Bugfix: More cached connections (M3227)
  • Improvement: Better phone config reading (M3231)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.12.0
    • Application Management Server v.3.0.15
    • Cluster & Active-Active Support v.1.2+ (optional)
    • Watchdog 1.0.3

Version 1.5.1 - Deprecated
  • Improvement: Memory efficient device ids (M3180)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.12.0
    • Application Management Server v.3.0.14
    • Cluster & Active-Active Support v.1.2+ (optional)
    • Watchdog 1.0.3

Version 1.5.0 - Deprecated
  • Bugfix: Search resulting in single item does not get it's status updated (M3138)
  • Bugfix: receptionists tab also lists non net.Console queues (M2556)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.12.0
    • Application Management Server v.3.0.13
    • Cluster & Active-Active Support v.1.2+ (optional)
    • Watchdog 1.0.3

Version 1.2.3 - Deprecated
  • Feature: Call Overview (M0)
  • Deprecated: Module was rejected by or has not been validated by our quality assurance department. (M5733)
  • Dependency:
    • Database Schema module v.1.12.0
    • Application Management Server v.3.0.8+
    • Cluster & Active-Active Support v.1.2+ (optional)

Version 1.2.2 - Deprecated
  • Improvement: Updated from status icons and probes (M0)
  • Deprecated: Module was rejected by or has not been validated by our quality assurance department. (M5733)
  • Dependency:
    • Database Schema module v.1.11+
    • Application Management Server v.3.0+
    • Cluster & Active-Active Support v.1.2+ (optional)

Version 1.2.0 - Deprecated
  • Feature: Possibility to import external contacts (M0002386)
  • Deprecated: Profile synchronization was not completely switched off (M18546)
  • Dependency:
    • Database Schema module v.1.11+
    • Application Management Server v.3.0+
    • Cluster & Active-Active Support v.1.2+ (optional)

Version 1.0.1 - Deprecated
  • Feature: Dynamic Profile synchronization for active/active configuration
  • Bugfix: query's statement redefinition in order to be compatible with mysql 4.0 (M0002179)
  • Dependency:
    • Database Server module v.1.0+
    • Database Schema module v.1.8+
    • Application Management Server v.2.1+
    • Cluster & Active-Active Support v.1.2+ (optional)

Version 1.0.0 - Deprecated
  • Feature: Dynamic Profile synchronization for active/active configuration
  • Dependency:
    • Database Server module v.1.0+
    • Database Schema module v.1.8+
    • Application Management Server v.2.1+
    • Cluster & Active-Active Support v.1.2+ (optional)

Module configuration interface

create_resource_form: .:/usr/share/escaux/glue/lib:/usr/share/escaux/glue/bin/gen_wiki_documentation/src/lib:/usr/share/escaux/glue/bin/gen_wiki_documentation/src/lib/

URL (external contacts source)
Cron (minutes, hours, day of month, month, day of week)
either day of month or day of week must be a ?
e.g. 0 23 ? * *
Specify for each of the following fields a priority 0 or 1: extension first_name last_name mobile_number fax_number home_number e_mail site department office owner source user_1 user_2 user_3 user_4 user_5 user_6 user_7 user_8 user_9 user_10
Matching field between your external source and the directory.
Profile Synchronization
Merge directory cron (minutes, hours, day of month, month, day of week)
either day of month or day of week must be a ?
e.g. 30 23 ? * *

Parameters

URL

Defines the location of the external contacts source. The xml file must adhere to the XSD Schema. See the Admininistrator Guide External Contacts Integration for more information.

Cron

Defines the frequency to fetch the external data source.
Five fields need to be specified separated by spaces:
Minutes Hours Day-of-month Month Day-Of-Week

These fields have the following format:

  • Minutes
    • allowed values: 0-59
    • special characters: * , - /
  • Hours
    • allowed values: 0-23
    • special characters: * , - /
  • Day-of-month
    • allowed values: 1-31
    • special characters: * , - / ?
  • Month
    • allowed values: 1-12
    • special characters: * , - /
  • Day-of-Week
    • allowed values: 1-7
    • special characters: * , - / ?

Day-of-month and Day-of-week are mutually exclusive. They can not be both be specified, a '?' must be used for one of them which means it is ignored.

Special characters

"*" is a shorthand used to specify a list with every allowed value for the chosen field.
E.g.:
* * * * ?
an import is occuring every minute.

"," is used to specify a list of allowed values.
Usage: value1,value2,value3
E.g.:
1,30 * * * ?
an import is occuring every 1st and 30th minute of each hour.

'-' is used to specify a range of values.
Usage: value1-value2
E.g.:
* 0-23 ? * *
an import is occuring every hour.

'/' is used to specify increments starting from a certain value.
Usage: value1/value2
E.g.:
0/5 * * * ?
an import is occuring every five minutes starting from the 0th minute (0,5,10,15,...).

Matching field between your external source and the directory

Matching field needs to be selected to specify how entries from the external source can be linked with contacts from the Internal Directory.

See the Admininistrator Guide External Contacts Integration for more information.

Profile Synchronisation (since v1.8.1)

  • yes: profiles will be synchronised between SOPs in the cluster. (default)
  • no: profiles will not be synchronised between SOPs in the cluster.

Merge directory cron

The merge cron determines when the merged contacts should be persisted to the database.

See the Admininistrator Guide External Contacts Integration for more information.

Post-Install Actions

ALERT! Application Management Server has to be restarted after module installation. This can be done through the SOPShell :
DONE Navigate to:  Subsystems > Management Server > Start/Stop
Copyright © Escaux SA