Solutions Series: Using System Data Synchronization
Solutions Series: Using System Data Synchronization
Solutions Series: Using System Data Synchronization
SOLUTIONS SERIES
Trademarks
Mitel is a registered trademark of Mitel Networks Corporation.
Mozilla and Firefox are trademarks of Mozilla.
Other product names mentioned in this document may be trademarks of their respective companies and
are hereby acknowledged.
CHAPTER 1: INTRODUCTION
Topology of solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
iii
Using System Data Synchronization
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Preventing synchronization problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Adding elements for sharing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Removing network elements from sharing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Managing network elements using Application Reach-Through . . . . . . . . . . . . . . . . . . . . . . . . 35
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Resolving SDS Distribution Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Advanced Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Overwrite vs. Merge in the Sync operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Overwrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Merge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
SDS Distribution errors and maintenance logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Errors during a Sync operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Errors during an automatic change propagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Using the Sharing scope in Admin Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
iv
Chapter 1
INTRODUCTION
Using System Data Synchronization
2
Introduction
The SDS feature reduces the time required to set up and manage elements in an SDS sharing
network by allowing you to:
• Share data among elements in a network, cluster, and admin group, and resilient pairs, as
it changes.
• Synchronize the form data from a master element with the forms on the other elements in
the network, cluster or administrative group at a single point in time, by clicking the Sync
button.
Note: This guide uses MiVoice Business Release 7.2 System Administration Tool form
names, but the SDS concepts, terminology, and operation applies to all MCD/MiVoice
Business releases from MCD Release 4.0 up.
Note: This guide includes new features introduced in MiVoice Business Releases 7.2,
and MiCollab Release 7.0.
3
Using System Data Synchronization
Topology of solution
SDS works in any topology of Mitel MiVoice Business controllers, regardless of location, and
can also encompass a MiCollab server under specific conditions.
Note that, in the following figures, the controllers could be any combination of:
• 3300 ICP controllers
• MiVoice Business controller running on industry standard servers (ISS)
• MiVoice Business Multi-instance - multiple MiVoice Business instances running on ISS
• MiVoice Business Virtual
The following servers can also be added as network elements for the purposes of sharing data:
• Enterprise Manager
• MiCollab server
• Mitel Open Integration Gateway (OIG) server (from Mitel OIG 2.1 and newer, the OIG must
be set up for SDS sharing with the MiVoice Business controllers.)
In Figure 1, the network is divided into two clusters. In this example, the Telephone Directory
is shared across the entire network, while Class of Service data is shared at the cluster level.
In this example, all the nodes are Mitel 3300 ICPs, but they could be MiVoice Business
controllers or virtual MiVoice Business Virtual instances running on any supported platform, as
mentioned above.
Other network elements (SX-2000 or MiVoice Office, for example) can exist in the network, but
they are not capable of sharing data using SDS.
4
Introduction
5
Using System Data Synchronization
Figure 2 shows phone devices connected to two controllers. For the device at the top of the
figure, Network Element A is the primary controller and Network Element B is the secondary
controller. For the device at the bottom of the figure, the primary and secondary controllers are
reversed.
In this example, while much of the data will be shared across the entire network (the network
scope), device changes are shared only at the resilient pair scope; between Network Element
A and Network Element B.
6
Introduction
7
Using System Data Synchronization
8
Chapter 2
USING SYSTEM DATA
SYNCHRONIZATION
Using System Data Synchronization
10
Using System Data Synchronization
Overview
With SDS, all additions, modifications, and deletions to shared data are automatically distributed
to the other elements in the network at the specified sharing scopes.
In resilient configurations, SDS synchronizes the data of resilient users and devices between
primary and secondary controllers in a cluster.
Note: All nodes in the network must be running MCD Release 4.1+, MiVoice Release
7.0+, or MCD Release 4.0 migrated to RDN Synchronization Mode. For information
about applying this migration, refer to the Migrating to RDN Synchronization Mode
Solutions Guide.
11
Using System Data Synchronization
Form data
Controllers in the network are programmed using specifically-designed forms in the System
Administration Tool. Forms are organized by function. You can also search an alphabetical list
of all the forms to find the form you want to view and change.
There are forms for every type of data, including, for example, Feature Access Codes (FAC),
Class of Service (COS), and Class of Restriction (COR). All users and devices are set up using
forms, as are Automatic Call Distribution and Automatic Route Selection rules. All of the
changes and actions you perform on each MiVoice Business network element in your network
is done through these forms. You also use the forms to view the system logs and use the
maintenance commands. Note that the systems logs forms are not shared.
When setting up a network for SDS sharing, you use the Network Elements form, which has
an entry for each element in the network. This is where you add elements to your network, and
this is the form to use to start SDS sharing and to Sync the data in the network.
SDS sharing
SDS sharing happens in two ways:
• Every time a change is made to any of the nodes in the sharing group, the change is
propagated to all of the other network elements, automatically, at the record level, and at
the defined sharing scope.
• When you click the Sync button on the Network Elements form, data in the selected forms
is sent from the current master element, in bulk, to the selected elements that are selected
and configured for SDS sharing.
Change propagation
There is some data that you need to share with every node in the network, while other data
needs to be shared only within the Cluster. Some data will be shared only between the primary
and secondary controllers in a resilient pair. There is also some data—physical trunking
information, for example—that should not be shared at all because it is specific to one controller.
The sharing scope for each form is pre-set, and the default sharing scopes work well for most
applications. You can edit them, if required, but you probably will not need to.
12
Using System Data Synchronization
SDS sharing occurs whenever a change is made on a network element, (if the change is on a
form that is shared). This happens automatically every time a change is made. SDS sharing
affects only the database records that were changed. If one COS record is changed on a network
element, this record is shared with the rest of the network elements, without updating any of
the unchanged records on the form.
Note: Forms that are shared are identified with this icon:
You can add one MiCollab server as a Network Element in a MiVoice Business network. This
configuration is subject to the following conditions and limitations. Outside of these conditions,
synchronization must be managed manually.
• Only one MiCollab is allowed per SDS sharing network.
• All MiVoice Business controllers are in one Admin Group, and there is only one MiVoice
Business cluster in the network.
• MiCollab is at Release 7.0+ and all MiVoice Business nodes are at 7.1 SP1+
• Flow Through Provisioning must be enabled (started) either from the Mitel Integrated Con-
figuration wizard or manually from a MiVoice Business platform in the administration group
of the cluster.
• If resiliency is configured for a MiVoice Business solution, data updates are sent from
MiCollab to the primary controller. If the primary controller is out of service, the MiCollab
USP application does not provide data updates to the secondary controller. Instead, an
error message is presented in MiCollab indicating that the primary controller cannot be
reached.
• Although you can view analog and DNIC phones from MiCollab User and Services Provisioning
(USP), you cannot create them.
• A maximum of three phones are supported in a shared MiCollab template. You cannot use
a template that is programmed with more than three phones.
• The synchronization of MiVoice Business elements with MiCollab takes substantially longer
than the synchronization of just MiVoice Business element form data.
For detailed configuration, conditions, and limitations, refer to the Flow Through Provisioning
topics in the MiCollab Server Manager Help.
To synchronize all of the data at once, use the Sync button on the Network Elements form.
After clicking Sync, you must choose which forms to synchronize. You can select all forms, or
specific forms. The data in the forms is sent to all of the other network elements in the sharing
scope. The network element you are logged in to when you initiate the Sync operation is the
master (Sync master), and the data from the master generally takes precedence over any of
the data on any of the other elements (slaves) in the sharing scope.
13
Using System Data Synchronization
Note: It is strongly recommended that you do frequent backups so that the restore files
are up-to-date.
When you make changes on a network element, this element becomes the change master,
and the changes are propagated automatically to all of the other network elements set up
for sharing with this element. The new information on the change master is written to each
of the slave elements, and the original data on the slave elements is overwritten.
If you make a change on Element A, for example, the change is propagated to all the other
elements set up for sharing with Element A. In this example, Element A is the change master
for this particular change.
If you finish the change on Element A, and then log in to make changes on Element B, any
changes you make on Element B are propagated to the other elements in the sharing scope,
and Element B becomes the change master. Sharing scope is explained in “Sharing scope”
on page 15.
• Sync master
The Sync master is the network element from which you click Sync to synchronize the
elements of the network. The Sync button is available on the Network Elements form.
The Sync slave is any network element you select before clicking Sync. Database records
on the Sync slave are overwritten or merged with the data on the Sync master, depending
on the type of the data and the Sync settings. For more information about “overwrite” and
“merge” operations, see “Overwrite vs. Merge in the Sync operation” on page 41.
For certain shared forms, you can select one or more records that are not to be shared (or
Sync’d). This is done using the option called All records except those specified below
in the SDS Form Sharing form.
Note: Do not use a Mitel 3300 ICP AX Controller as a Sync master; the AX controller
does not have enough storage space to accommodate a large number of SDS
Distribution Errors and pending updates.
This could result in multiple Sync operations being required to complete the
synchronization.
14
Using System Data Synchronization
Sharing scope
System data can be shared form by form at a sharing scope you set in the SDS Form Sharing
form (or you can use the default sharing scopes). The sharing scope can be set to share form
data within an administrative group, across the entire network, or across resilient pairs, for
example.
The following sections list the available sharing scopes, and describe the data distribution of
updates for the named sharing scope.
• All Network Elements
Distribute updates only to the MiVoice Business elements in the network. This includes all
MiVoice Business and MiVoice Business Multi-instance elements, including 3300 ICP
appliances.
• Admin Group Members
Distribute updates to all elements that belong to the administrative group. Use
administrative groups to share data among groups of elements within the network.
• Resilient Pair
Distribute resilient user and device data between a primary and secondary controller.
• Member Hosts
Distribute group information and group member data between all the elements on which
the group members reside.This sharing scope applies to pick-up groups but does not apply
to network hunt groups or resilient ACD hunt groups.
This sharing scope is predefined, according to the type of group, and it is read-only; you
cannot change it.
• Host and Gateway
Distribute updates to the Guest Room DNs primary node, and the hospitality gateway node.
• None
15
Using System Data Synchronization
shows the status of pending updates and updates that were not distributed successfully to other
network elements.
Note: It is important to check this form after making data changes, particularly in networks
that are out of synchronization.
SDS Distribution Errors must be resolved to keep your network elements synchronized.
Pending updates
Pending updates are updates that have not yet been written. If you see pending updates in the
SDS Distribution Errors form, it is usually because the receiving node is busy or there are so
many changes that they cannot all be processed in the current cycle. Generally, pending
updates are completed in the allotted time. Unless there is an error, pending updates will be
retried at predetermined intervals.
16
Using System Data Synchronization
Every shared form in the system has a default sharing scope. See “Sharing scope” on page 15
for more information about the sharing scope.
For most forms, you can change the sharing scope, but plan your network carefully before
making changes. Because sharing form data may overwrite data on other network elements,
sharing data inappropriately could result in loss of data, or even loss of service.
Note: It is recommended that you perform Sync operations during periods of lower call
activity.
You should also use SDS Form Comparison to determine whether you should or should not
synchronize specific data. There may be data that must be kept specific to each node. In the
case where data sharing is not appropriate, or would cause reprogramming work you are not
currently prepared to do, you can set the forms not to share during SDS automatic updates by
disabling synchronization for that form.
17
Using System Data Synchronization
For an installation of just one node, SDS is not relevant, because the one node does not need
to be synchronized with anything—unless you also have one or more nodes in other locations
on the same network.
Resilient networks use SDS in the same way as non-resilient networks do, except that there
is an additional level of synchronization between primary and secondary controllers for groups
of devices. For more information, see “SDS and resilient devices” on page 30.
To add a MiCollab server in the sharing network, select it on the Network Elements form in the
same way that you add MiVoice Business nodes. When adding a MiCollab server, you must
also run the MiCollab Reconcile tool once at first sharing. For details and instructions, refer to
the MiCollab Server Manager Help, in the Flow Through Provisioning topics.
You can also use Reach Through from the MiCollab server, and you can view and change form
data on any of the connected MiVoice Business nodes.
Note: Reach Through is supported only using Internet Explorer (version 7.0 or later) or
Mozilla Firefox (version 17 or later) browsers and you must have installed the browser
with the Mitel Root Certificate. If you attempt to use any other type of browser to reach
through from MiCollab to MiVoice Business, reach through will be blocked. Note that
Internet Explorer is not supported in Compatibility Mode.
18
Using System Data Synchronization
Note: To use Reach Through, you must enable SNMP agents on every element in the
Admin Group.
Distributed network
A distributed network can comprise any number of nodes—from one to hundreds of network
elements—and can be configured for resiliency, or not.
You may not want to perform a Sync with all nodes at once. You could Sync with the local nodes
first, and resolve any errors before starting a Sync operation with the remote sites. If you have
many network elements at each site, you might perform the Sync with just a few network
elements at a time until you have performed an error-free synchronization with all of the
elements in the network.
Note: If you are running a mixed-release network, you may always have SDS errors on
certain nodes, since different MCD/MiVoice Business releases may have database
schema differences that result in some data not being accepted on some nodes.
19
Using System Data Synchronization
In MCD Release 6.0, the CESID length was changed from 10 digits to 12 digits. If an
11 or 12 digit CESID is shared (by SDS) with a node that supports only 10 digit
CESIDs, SDS Distribution errors are generated on the change master. CESID is
shared at resilient scope (between pairs of resilient nodes). Primary and secondary
nodes should always be running the same version of MCD/MiVoice Business.
Enterprise network
An Enterprise network is assumed to include networks in multiple locations around the world,
many with hundreds or thousands of users. Enterprise networks are configured with resiliency,
and SDS changes are propagated over the LAN, locally, and the MAN or WAN, for information
transfer to other sites.
20
Using System Data Synchronization
Limitations
Note the following limitations when using voice mail on SDS-enabled MiVoice Business
networks:
• SDS does not share changes that are made to embedded voice mail user data through the
telephone user interface.
• You must assign the same number to a user's extension and voice mailbox. SDS will be
unable to distribute this data if you use different numbers.
21
Using System Data Synchronization
If you use a different number for the voice mailbox, the voice mailbox number will not be
entered in the Remote Directory Number table and will not be distributed by SDS.
• Data in the VM Network Users form is not propagated by SDS to other nodes in the
network/cluster. Any changes must be manually entered in the VM Network Users form
at other nodes where necessary.
For complete and detailed instructions for programming Networked Voice Mail, refer to the
MiVoice Business System Administration Tool Online Help.
22
Using System Data Synchronization
Note: All nodes in the network must be running MCD Release 4.1+ or Release 4.0
migrated to RDN Synchronization Mode. For information about applying this migration,
refer to the Migrating to RDN Synchronization Mode Solutions Guide.
Note: Only one MiCollab server is allowed in an SDS sharing network, and all of the
connected MiVoice Business nodes must be in the same Admin group if sharing with
the MiCollab server. Refer to the MiCollab Server Manager Help.
The Network Element form allows you to add, delete, and change the elements in your network.
All of the network elements in your network must be added to this list. This includes network
elements that may be in other clusters that are part of this network.
When you are using SDS sharing, all of the network elements share basic data about the
elements and the connections. Examples of forms that are always shared at the All Network
Elements scope are Network Elements and Admin Groups.
For more information and detailed instructions, refer to the System Administration Tool Online
Help.
2. Specify the forms to share, and the scope of the sharing (optional)
This is an optional step; you should generally leave sharing settings at their defaults. The scope
at which a form can be shared depends on whether its data is local (specific to that MiVoice
Business controller) or global in nature.
The data-sharing scope of the 3300 Network Element Properties, Network Elements,
Cluster Definition, and Cluster Member forms cannot be changed, because the default scope
settings of these forms are required to support SDS.
23
Using System Data Synchronization
SDS sharing for many of the other forms allows you to specify what data will be shared, down
to the record level. You can also specify which network elements to share—or not share—data
with.
While the default sharing scope for each form is usually exactly what you require, there may
be situations that require changes to the defaults. For example; you might want to allow
unrestricted access to long distance to one Admin Group, and restrict long distance for another
Admin Group. In this case, you would share Class of Service and Class of Restriction at the
Admin Group scope. For more information about sharing at the Admin Group scope, see “Using
the Sharing scope in Admin Groups” on page 42.
The SDS Form Sharing form (formerly Shared Forms Configuration) allows you to:
• Select the scope of sharing for each form. For more information about SDS sharing scope,
see “Sharing scope” on page 15.
It is recommended that you leave the sharing scope at the defaults, at least when you first
start SDS sharing.
• Prevent specific records in a form from being shared, by setting filter criteria. Leave these
settings at their defaults for now.
There are some forms for which the sharing scope and record sharing is set, and cannot be
changed. These are shown in the SDS Form Sharing form in grey italic font. For example, the
Cluster Elements form is always shared at the All 3300 ICP sharing scope, and this cannot
be changed.
Even in those forms that are not greyed-out, some forms have limits on what you can change.
For example, you can change the sharing scope of the Alarm Email Notification form (the
default is All 3300 ICP), but you cannot change which records are shared.
For most of the forms, you can change the sharing scope (Share Form With column) and the
records in the form to share (Share Records column). Clicking Change displays the SDS Form
Sharing dialog box. For each field, you can set filter conditions to set which records to share,
based on their value.
For more information and detailed instructions, refer to the System Administration Tool Online
Help.
3. Start Sharing
The Start Sharing button, available on the Network Elements form, initiates data sharing from
the local element with the selected remote elements at the defined scope. This action
synchronizes only forms always selected by default. (You will see these forms in the Confirm
Synchronization dialog box—you cannot de-select them.)
Note: Start Sharing does not synchronize the databases of the selected elements. See
“4. Synchronize your network elements” for more information.
24
Using System Data Synchronization
Start Sharing adds each selected network element to the sharing community, so that when a
record is added or modified in a shared form of any of the network elements, the update will
be sent automatically to the databases of the other network elements.
Note: To access other nodes in the network, their IP addresses must be added to the
intranet zone on the administration PC. For more information, refer to Mitel Knowledge
Base article 09-5173-00058.
Note: You cannot join two existing SDS networks. Choose one SDS sharing community
to be your starting SDS network. On each element in the other SDS sharing group,
disable System Data Synchronization in the System Options form, and then
re-enable it; then add the elements to your starting SDS network, using the instructions
in “Adding elements for sharing” on page 33.
To start sharing:
1. Log in to the System Administration Tool on the network element that will be your Sync
master. It is recommended that this be your fastest and least-loaded element.
2. Navigate to the Network Elements form.
3. Select the network elements that will be in your sharing community.
4. Click Start Sharing.
Note: To ensure that the Microsoft Internet Explorer browser session does not time out
before the Start Sharing operation is complete, install the additional Internet Explorer
registry file, as described in Mitel Knowledge Base article 07-3829-00006 on Mitel
Online.
If Start Sharing fails with a Connection error, check the System Options Form on the failing
network elements, and ensure that System Data Synchronization is set to Yes.
For details and conditions, refer to the System Administration Tool Online Help.
The Sync button on the Network Elements form allows you to synchronize the shared data
on the local element with one or more remote elements selected on the form.
It is recommended that you provision data sharing from just one master element in the network
or cluster. When you provision data sharing from one master element, you can monitor errors
from that one master element. If you configure data sharing from multiple elements, then you
must log in separately to each element to check for errors.
You can attempt to synchronize all of the network elements at the same time, but a prioritized
approach generally saves time. It is recommended that you perform the Sync operation on one
element at a time, particularly if there are elements that are significantly out of sync. Then you
25
Using System Data Synchronization
repeat the Sync procedure, adding forms to synchronize, and then progressing to other network
elements.
4. Leave Merge selected. The synchronization operation will combine data from the Master
and Slave, where applicable.
5. In the Shared Forms To Be Synchronized list, select the forms to synchronize.
Consider performing the Sync procedure multiple times, fixing any errors that appear, and
then synchronizing again with more or different forms selected. The following order is
recommended:
• On the first pass, select only the Service Hosting form. Fix any errors that appear.
See “5. Resolve SDS Sync failures” on page 27.
• On the second Sync, select only the User form. If resiliency (device or groups) are
configured between the Sync master and slave systems, you can also select Device
Level Resiliency or System Level Call Handling on the second Sync.
• On the third Sync, select only the Telephone Directory form (under User).
Note: In MCD Release 6.0 and MiVoice Business Release 7.0, the User group of forms
is automatically selected when you select Telephone Directory for Sync. If the user
definition forms have already been successfully synchronized, then you can de-select
the user definition section before doing the Telephone Directory form.
• When these forms synchronize successfully, continue to synchronize the rest of the
network elements and forms to be synchronized.
6. Click OK.
Note: If you do not select any forms when you start a Sync operation, the synchronization
that takes place is exactly the same as what happens when you click Start Sharing. To
synchronize database information like user records, device records, and the telephone
directory, you must select these forms during the Sync operation.
26
Using System Data Synchronization
Note: In some cases, devices may not be recognized by the slave node as RDN entries,
so you may have to perform the Sync twice to remove errors associated with Trunk
Attributes, Call Rerouting, and Visual Voice mail forms. In this case, the first Sync
initiates the RDN entries and they exist as a reference when the second Sync occurs.
Then the second Sync finishes with no errors.
Note: it is recommended that the Sync operation be performed when the volume of
check-ins and check-outs in the Property Management System (PMS) is low. Check-ins
and check-outs may fail with errors.
2. Although multiple network elements are selected to Sync, the point-to-point Sync process-
es the network elements one by one. The Merge Sync first collects the data from the slave
node, then add the records that exist only on the slave side to the Sync Master (local node),
to create a superset of the data.
3. For the records that exist on both master and slave but with fields containing different data,
the data on the master takes precedence; no changes are made on the master. The master
then collects its local data (superset data) and sends it to the slave. The slave overwrites
its local data with the superset data received from the master. For more information about
data merge and data overwrite, see “Overwrite vs. Merge in the Sync operation” on page 41.
4. Distribution errors and updates to the remote nodes are removed from the local node
because they are no longer needed (this applies only to forms that have been selected for
synchronization).
5. Any data updates sent from the other elements to an element currently involved in a
synchronization will be rejected by that element and recorded as an error on the change
master. These updates will be re-tried automatically.
If the Sync operation finishes without errors, skip to “6. Perform backups of your network
elements” on page 29.
If the Sync operation results in synchronization errors, continue with “5. Resolve SDS Sync
failures”.
27
Using System Data Synchronization
Start by checking the Maintenance Logs - All form on the Sync master so that you can see
which forms have failed. Then check the Maintenance Logs forms on the Sync slaves.
Information in the logs explains the Sync errors.
For more information, refer to the Troubleshooting help topic in the System Administration
Tool Online Help.
After there are no outstanding SDS distribution errors, configure Flow Through Provisioning.
1. Review the Conditions and Limitations. If MiCollab will manage a group of MiVoice Business
systems, they must be configured in a single administration group within an SDS sharing
network. All the MiVoice Business servers in the sharing network must be at MiVoice
Business Release 7.1 SP1 or later.
2. Check that there are no outstanding SDS distribution errors on the MiVoice Business
network. Refer to the MiVoice Business System Administration Tool help for instructions
on how to resolve SDS distribution errors.
3. Create backups of the MiCollab database and all MiVoice Business databases.
4. Add the MiCollab server as a network element (server type MSL Server) to the Network
Element form of one of the MiVoice platforms in the existing sharing cluster.
a. Log into the MiVoice Business System Administration Tool.
b. In the top left corner, select View Alphabetically.
c. In the left forms menu, click Network Elements.
d. Click Add and add the MiCollab server with type MSL Server.
By default, the MiCollab server is added to the Network Element tab of Users and Services
application.
5. Start sharing with the MiCollab server.
a. Check the box of the MiCollab server (MSL Server type)
b. Click Start Sharing.
c. Verify that the correct elements are listed.
d. Click OK. After the start sharing operation is complete, the Data Sharing field for the
MiCollab server (MSL Server) will change to YES. This operation also synchronizes
the entries in the MiCollab network element tab with the MiVoice Business Network
Element form.
Note: Templates will be associated with the network element from which you started
sharing.
6. In the Network Element tab of the User and Services application, edit the newly added
network elements and enter the desired Set Registration Codes and Set Replacement
Codes.
28
Using System Data Synchronization
7. Log in to the MiCollab server manager. There will be a red warning banner present if you
are required to run the Reconcile Wizard. This wizard compares the data entries in the
MiVoice Business databases with the data entries in the MiCollab database and merges
matching entries into a single entry with multiple phones.
Note: If you need to run the Reconcile Wizard, do not make any user updates from the
MiCollab USP until after you have run the wizard and the databases are in sync. While
the databases are out of sync, MiCollab USP updates are not shared to the network
elements.
Refer to the MiCollab Server Manager Help for instructions.
For each network element, log in to the network element, and perform the backup, following
the instructions in the MiVoice Business System Administration Tool Online Help.
If you are running pre-Release 4.2 MCDs, remember to use the DBMS SAVE maintenance
command when installing and licensing are complete. This stores the database so that, on
reset, it recovers to the last stored state—the current updated version.
29
Using System Data Synchronization
Note: The primary and secondary MCD or MiVoice Business elements should be at the
same software release level to ensure that users have access to the same features on
secondary controllers when they fail over.
After you set up data sharing between the primary and secondary controllers, the application
automatically keeps user and device data, such as feature key programming and do-not-disturb
(DND) settings synchronized between the primary and secondary controller when changes are
made on either the primary or the secondary controller:
• If resilient users modify their set programming while their sets are being supported on the
primary controller, SDS automatically updates the secondary controller with the changes.
• If resilient users fail over to their secondary and modify their set programming, SDS updates
the primary controller with the changes after the primary controller returns to service.
• If an administrator updates resilient user and device data on either the primary or secondary
controller, SDS automatically updates the database of the other controller.
Note: The primary and secondary controllers must be in the same cluster. You define
a cluster using the Cluster Elements form.
Check the SDS Distribution Errors form regularly during these operations, and resolve any
errors that appear.
30
Using System Data Synchronization
31
Using System Data Synchronization
Maintenance
When you start SDS sharing, you set up and configure your network, set up your clusters and
Admin groups, Start Sharing, and then click Sync. After all this is done, your network elements
are synchronized, and every update is automatically propagated to the other network elements,
based on the sharing scopes you configured.
At first glance, you might be tempted to think you never need to touch the sharing settings, and
you never need to click Sync again.
In the real world, however, there are network changes, additions, and equipment failures that
require you to keep an eye on the SDS data sharing. For example:
• A network link goes down.
• A shared network element fails.
• A new network element is added, or a network element is removed.
• An erroneous change is made on one of the network elements.
• A backup is restored, and the recent changes need to be shared to bring the restored
element up to date.
The older the backup, the more out-of-sync it is with respect to the other network elements,
so it is recommended that you take frequent backups.
• A software upgrade of some (but not all) MiVoice Business elements to a new version may
result in a mismatch of the fields to be synchronized.
All of these events result in SDS distribution errors that you must repair to bring the network
elements back into synchronization. You should examine each SDS distribution error carefully,
and repair each one as described in “Resolving SDS Distribution Errors” on page 36.
SDS Distribution Errors trigger alarms on the System Administration Tool. Alarms appear in
the banner at the top of the System Administration Tool user interface, and at login. When you
see an alarm message, it means:
• One or more system data errors has occurred.
System failures include errors in the core data forms, such as the Network Elements form.
• 100 or more user data errors have occurred.
These are errors that occur when propagating user and device data through the network.
Ensuring that all SDS distribution errors are resolved regularly will help keep your network
working smoothly.
32
Using System Data Synchronization
You use Start Sharing when first setting up your clusters and Admin groups, but you also
use Start Sharing whenever you add a new network element to your sharing group.
Remember to click Sync after the Start Sharing action is complete.
• Investigate and resolve all SDS distribution errors.
If you resolve SDS distribution errors regularly, you can prevent small problems from
snow-balling into large problems.
• Keep up-to-date backups for every network element.
When you need to restore a database, the number of differences you have to resolve
between the system state and the backup you are restoring is low.
Tip: After restoring, remember to Sync the restored node. Log into an up-to-date node,
and, in the Network Elements form, select the restored network element, and click Sync.
Note: You cannot join two existing SDS networks. Choose one SDS sharing community
to be your starting SDS network. On each element in the other SDS sharing group,
disable System Data Synchronization in the System Options form, and then
re-enable it; then add the elements to your starting SDS network, using the following
procedure.
Note: It is strongly recommended that each Admin Group contain no more than 20
network elements. To avoid performance impact, some functionality is automatically
disabled if one or more Admin Groups are too large.
5. Ensure that the new element is not currently a member of any other data-sharing network.
If it is still a member of another data sharing network, remove it using the instructions in
“Removing network elements from sharing”.
33
Using System Data Synchronization
Note: To remove the element from the network completely, refer to the Voice Clustering
Design and Implementation Guide or the System Administration Tool Online Help.
If you want to keep the node in the network, but you want to disable sharing, use one of the
following procedures.
Note: You can add the network element back in at any time by re-enabling the System
Data Synchronization option, and starting sharing again. Then a new Sync from an
up-to-date master will synchronize the network element with the existing network
elements again.
1. If the name of the network element to be removed from sharing includes a space, rename
the network element to remove the space before proceeding. If the network element has
a blank name, name the element before continuing.
34
Using System Data Synchronization
REMOVESHARINGNE NodeName
4. Check the SDS Distribution Errors form to ensure that all nodes received the instruction to
remove the node from sharing.
Conditions for use of Reach-Through to view and edit forms on other MiVoice Business
controllers:
• The controllers must be in the same Administrative Group, and they must be sharing data.
• The User Authorization forms must be shared.
• The date and time settings must be matched. Use the Date and Time form on each con-
troller to set the date and time to the same time zone.
• The IP addresses of the controllers you want to view or change using Reach-Through must
all be added in the local intranet sites list in your browser.
Note: If controllers are on different platforms; for example, 3300 ICP CX compared to
MiVoice Business on ISS, certain forms may not be visible. For example, the MiVoice
Business on ISS has no PSTN trunk connectivity. These forms are not displayed using
Reach-Through to the CX from the MiVoice Business on ISS.
You can also use Reach-Through from the MiCollab server, if there is one in the sharing network.
Observe the following conditions:
• Reach Through is supported only using Internet Explorer (version 7.0 or later) or Mozilla
Firefox (version 17 or later) browsers and you must have installed the browser with the
Mitel Root Certificate. If you attempt to use any other type of browser to reach through from
MiCollab to MiVoice Business, reach through will be blocked. Note that Internet Explorer
is not supported in Compatibility Mode.
• Reach through from MiCollab USP to the MiVoice Business System Administration Tool
and from the MiVoice Business System Administration Tool to MiCollab USP is in the context
of the administrator account for audit purposes.
• You must enable the SNMP Agents on every element in the SDS Admin Group.
35
Using System Data Synchronization
Troubleshooting
For general troubleshooting, refer to the System Administration Tool Online Help, and the Mitel
3300 IP Communications Platform Troubleshooting Guide.
The three most common problems that cause trouble for network administrators are:
• Restoring a foreign database
Pre-MCD-Release 5.0: Restoring a database from another controller in the network results
in having duplicate controllers in the network, and this is not supported by SDS.
Restoring a database from another controller, even from outside the network, often causes
problems because of the hardware-specific records like trunk and DN programming. This
results in references to network elements not in the current network, so SDS does not
recognize the data.
• Forgetting to run a full Sync after Start Sharing
Clicking Start Sharing adds the network elements to the data sharing community and
shares some of the basic networking forms, and it enables data sharing, but it does not
synchronize all of the data.
If you click Start Sharing, but you do not follow that by performing a Sync operation, your
network elements will recognize each other, and changes on any of the network elements
are propagated to other network elements in the network, but any data that has not been
changed is not synchronized. You must click Sync to synchronize the data on all the network
elements.
Note: When you click Sync, remember to select which forms to synchronize. If you do
not select any forms, you will see a successful sync message, but only core data was
shared.
SDS distribution errors, if not resolved, can prevent data sharing for parts of your database,
and over time, network elements can become significantly out of synchronization.
For information about resolving the different types of SDS distribution errors, see “Resolving
SDS Distribution Errors” on page 36.
CAUTION: Do not delete an error record before investigating the source of the
error. Deleting the error may cause subsequent retry operations to fail if the
errors are caused by a connection problem.
36
Using System Data Synchronization
Note: Try to keep the number of SDS errors to work on to a minimum. The best way to
do this is to resolve the errors frequently, so they do not accumulate.
3. Click the Action ID field heading to sort the errors by action ID. You can sort the errors
based on any of the column headings by clicking on the desired heading (for example,
Reason).
4. Select the record using the check box, and apply Retry or Force Change. To see the
details of a record, highlight the record.
Note: You can check the boxes of multiple records, and the operation that you choose
will be applied to all of the checked records. To select all SDS distribution errors, click
Select All.
When you select multiple records, the Retry and Force Change operations will be
available only if the records selected are of the same type.
Note: The system automatically retries updates that have failed because of connection
problems. After updates are completed successfully, they will disappear from the SDS
Distribution Errors form (you may have to click Data Refresh).
7. After you have corrected an error, you may have to delete the error record, if it is not cleared
automatically. Go back to the SDS Distribution Errors form on the local element, select
the error record and click Delete. The update error is removed from the main window and
37
Using System Data Synchronization
the error log is removed from the logs. You can also choose to delete an error record if you
understand the error and determine that the update is not required.
38
Appendix A
ADVANCED SCENARIOS
Using System Data Synchronization
40
Advanced Scenarios
Advanced Scenarios
In this section, you will find information that you probably will not need for day to day operation,
but that you might be interested in knowing when you are setting up something special, or you
need to do advanced debugging.
Overwrite
For the types of data designated as overwrite data, the master data is written onto each slave
element so that they match. Any data that was on the slave previously is overwritten.
Note: Any errors that might occur appear on the slave, since all of the data transfer is
in the direction of master to slave.
Merge
For the types of data designated as merge data, the master adds its data to the slave data,
creating a data superset. The master then overwrites the slave data with the superset of the
data. As with overwrite mode, master and slave end up with exactly the same data set, but in
the merge case, the final data set is the superset of master data plus slave data.
Merge is the sharing method used for user lists. If, for example, the master network element
(the element you initiate the Sync operation from) has records for John, Mary, and Paul, and
the slave element has user records for John, Paul, and Susan, when the Sync is complete,
both master and slave will contain information about John, Mary, Susan, and Paul.
Data that is updated is merged from the master. In the case where John's data is not the same
on the master and the slave, the data from the synchronization master takes precedence. See
“Synchronization master vs. change master” on page 14 for more information.
Note: Since data is being written in both directions—master to slave, and slave to
master—you may see errors on both master and slave.
41
Using System Data Synchronization
When you do a full synchronization (using the Sync button), if there are errors or warnings,
you will see them in the Maintenance Logs forms on the various network elements involved
in the synchronization. In addition to viewing the errors on the change master element, you
should also check the Maintenance Logs on the slave elements. Depending on the type of
error, one or the other may contain more information, which will help you resolve the error.
There is one exception to this rule. If, for example, Sync master A is synchronizing with slave
B, then changes may also be shared with slave C (depending on the sharing scope of the forms
being synchronized, and the relationship between the network elements). Any errors that occur
between elements A and B will appear in the Maintenance Logs forms as expected. If, however,
errors occur when the Sync operation results in sharing with element C, any errors resulting
from merge operations will appear in the SDS Distribution Errors form.
When errors occur during automatic change propagation, any errors that occur will appear in
the SDS Distribution Errors form. You should make it a practice to check this form regularly
and address any update errors that appear.
Alarms in the banner and at login alert you to the errors that have occurred. Check and resolve
these frequently.
Let’s say, for example, that you want all the departments in your company to be in the same
cluster, but the Sales group and the Product Support group need different Feature Access
Codes. You set up one Admin Group for Sales, and another Admin Group for Product
Support, and then configure the Feature Access Codes to share at the Admin Group sharing
scope.
For more information about configuring multi-node networks, refer to the Multi-node Networking
Solutions Guide on Mitel Online.
42
© Copyright 2015, Mitel Networks Corporation. All Rights Reserved.
The Mitel word and logo are trademarks of Mitel Networks Corporation.
Any reference to third party trademarks are for reference only and Mitel makes no representation of the ownership of these marks.