[Index]
To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com
This section provides more details on the functionality of the Change Notification Feature (CNF) components in VOSS Automate.
Change Notification Collector
The data/DeviceChanges model has an instance per UCM cluster and will provide the data collector status and pending changes in the cache for that cluster. An instance of the model will appear for all UCM clusters whether change notification is enabled or not. It gives you access to:
The data/DeviceChanges model should be included in menu layouts for roles that need access to this level of detail for the CNF syncs.
Change Notification Sync Type
When a Change Notification Sync type is used in a data sync, there are a number of differences in the sync behavior in comparison with a normal pull sync:
A GUI portal rule on the Data Sync interface will change some of the settings visible on the Data Sync GUI interface when the Sync Type is set to Change Notification Sync. This selection hides settings that are not relevant and exposes new settings for this type only.
Number of Changes to Process - This input field becomes available from the Data Sync interface. Leaving the input box blank or typing in 0 will mean the sync will process all the pending changes collected - subject to the selected model type list and Disabled Operations set up on the sync. If you enter a number, the sync will process that number of changes only and leave any additional changes in the change collection for the next sync.
Typically this value should be 0 or blank, unless there is a specific reason to limit the number of changes to process, for example when managing how long the sync may run.
All other visible settings are the same as with a normal pull sync, for example, device filters, workflows, and so on.
When a sync runs (either a normal pull sync or a change notification sync), it will clear out the change notification collection of any model types and changes processed for that cluster.
The model type lists and disabled operations define which models and types of actions are processed in either a pull or a change notification sync:
Pull Sync and Change Notification Sync details:
This sync behavior means that you may wish to set up multiple syncs for a cluster to handle different types of sync and sync schedules to meet your needs. Ensure that you generally have all the model types covered in your scheduled syncs if CNF is enabled, otherwise some changes may never be cleared from the change collection, thereby taking up space.
For additional considerations and information around sync setup best practices, see the Best Practices Guide.
VOSS Automate Setup to enable Change Notification
Enabling the Change Notification capability is completed on a per UCM Cluster basis. This can be done on the UCM Server configuration page for a publisher via the publisher tab and selecting the Enable Change Notification Sync check box. When selected and saved, the system will:
When CNF is disabled on the Publisher configuration page (or if the cluster is removed from the system), the following will occur:
Note
If the collector is only disabled via the data/DeviceChanges model, then the schedules and sync will remain. This is the best approach if you need to temporarily disable the CNF sync (for example, for a maintenance window).
Used (per device) for configuring the change notification collector process & for monitoring unprocessed change notifications
Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Device ID * | The resource ID of the associated device |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Device Name * | The name of the associated device |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Device Type * | The type of the associated device |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Last Collection Time | The last time the associated device was checked for changes |
|
|||||||||||||||||||||||||||||||||||||||||||||||
CUCM Cluster Notes | CUCM Cluster Notes Field |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Pending Change Notifications | Pending changes for the associated device |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Model Type * | The model type of the pending changes in this section |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Add Count | The number of pending add changes |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Update Count | The number of pending update changes |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Delete Count | The number of pending delete changes |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Settings | Change collector settings for this device |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Polling Interval (seconds) | How often the change collector service will check this device for changes (seconds) Default: 300 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Enable Change Collection | Tick to enable change collection for this device Default: True |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Ignored Operations | Indicates which operations should not be collected. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Add | Do not collect "add" changes. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Update | Do not collect "update" changes. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Remove | Do not collect "remove" changes. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Displayed Model Types | These model types will be displayed un-grouped in the pending changes section |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Model Type | The model type that will have counts displayed in the pending changes section |
|