Synchronize - Metasys - LIT-12011964 - Software Application - System Configuration Tool - 13.2

Metasys SCT: System Configuration Tool Help

Brand
Metasys
Product name
System Configuration Tool
Document type
User Guide
Document number
LIT-12011964
Version
13.2
Revision date
2020-01-21
Language
English
Note: Read this section thoroughly before using the Synchronize feature to fully understand the implications of synchronizing databases. We recommend that you create a backup of the SCT database before proceeding with a synchronization.

The Manage Archive wizard Synchronize option synchronizes an engine or Metasys server database with the SCT archive database. In synchronization, changes made since the last load process in the online database merge with changes made in the SCT database since the last load process, resulting in two databases that contain the same information. One of the benefits of the Synchronization feature is that the engine and server do not have to restart after the synchronization is complete. The synchronize process should only be performed on relatively small change sets, not on large change sets (such as after an upgrade).

If changes made since the last load process conflict, the SCT data supersedes the engine or server data. For example, if a Relinquish Default attribute of a set point is changed to 77° in the SCT and the same attribute is changed to 78° in the engine or Metasys server device, the attribute after synchronization is set to 77° in both databases.

Notes:
  • The UI does not indicate where discrepancies exist between the SCT data and the engine or Metasys server data. Use care when using the synchronize option.
  • When synchronizing an NCE, the load only synchronizes the object database. The local application .caf file is not part of the synchronization process.
  • If the archive database you want to synchronize was imported with the Import Database option, you must first upload or download the database before you synchronize. If not, a database merge error may occur. This requirement only applies to the first synchronization after import; subsequent synchronizations do not require the upload or download step.
  • When only updating the server with Metasys UI changes, you can use the Only Metasys UI Spaces and Equipment procedure in Download.
Figure 1. Synchronization Workflow

To Synchronize a Device
  1. On the Tools menu, select Manage Archive. The Manage Archive wizard appears.
  2. Select Synchronize.
  3. For SNCs, select the Enable SNC Logic check box to enable logic after the synchronization completes, or clear the check box to disable logic after the synchronization completes.
  4. Click Next.
  5. Select the devices to synchronize to and click Next.
  6. Select the synchronize Schedule method and click Next.
  7. Select the Site Login method.
    Figure 2. Site Login Screen

    To communicate through the Site Director:
    1. Select the Communicate via Site Director check box.
    2. Enter the username and password for an administrator account for the Site Director.
    3. Click Test Login. When login has passed click Next.
    To communicate through individual devices:
    1. Enter the username and password for an administrator account on each physical device.
    2. Select the check box for the devices you want to communicate with.
    3. Click Test Login. If the Status column has a Login ID is not OK for any devices, repeat steps 5a through 5c until all devices have a Login ID is OK status. Devices with a blank status indicate you have not attempted Site Login through the Manage Archive wizard.
      Note: Successful logins are no longer able to be re-checked after they have reached a Login ID is OK status.
  8. Select Synchronize Reoccurrences and click Next.
  9. Review the synchronize Summary and click Finish to perform the synchronize.
  10. After the synchronize process is complete, verify the Completion Status column in the Completed Actions window reports OK.
Table 1. Manage Archive wizard Screens

Screen

Purpose

Action

Select the Synchronize option. Choose to enable or disable logic for SNCs after the synchronization completes.

Select Devices

Select one or more devices to be synchronized. Use the Ctrl and Shift keys to select more than one device.

Schedule

To synchronize now, click Synchronize Now. To synchronize a device at a later date, click Schedule Synchronize, and select the date and time you want to synchronize the device.

Site Login

Select Communicate via Site Director if the destination device is not accessible on the local area network.

Note: This option slows down the operation if used unnecessarily.

If a different user name and password are required, enter the user name and password.

Summary

View the basic parameters of the device or devices just synchronized.

Table 2. Synchronization Scenarios

Change in SCT

Change in Device

Final Result after Synchronization

Delete an Object

No Change

Object is deleted from both databases.

No Change

Delete an Object

Object is deleted from both databases.

Add an Object

No Change

Object is added to both databases.

No Change

Add an Object

Object is added to both databases.

No Change

Edit an Attribute

Attribute value is changed in both databases.

Edit an Attribute

No Change

Attribute value is changed in both databases.

Edit an Attribute

Edit Same Attribute to a Different Value

SCT attribute value is used in both databases.

Add an FEC to the FC Bus with an Address of 11

Add an IOM to the Same FC Bus with an Address of 11

The FEC with an address of 11 is added to both databases.

Add Object to the XYZ Folder

Delete the XYZ Folder

The databases stay the same as they were prior to the synchronization attempt.
Note: Structural errors like this cause the synchronization process to fail with an error.

Copying and Pasting a Logic Controller Tool (LCT) Process and its LCT Child

No Change

LCT processes are empty.
Note: It is recommended that you perform a full download for LCT Process and their LCT Child Processes.

Creating New User View folder and downloading ADS/ADX

No Change

The User View Folder remains marked with green change arrows.

ActionQ Processing for Synchronization
Figure 3. Synchronize Process

Table 3. Database Synchronization Process

Number

Process Description

1

After configuring a synchronization load in the Load wizard, the Manage Archive wizard sends the synchronization command to the ActionQ in the SCT.

2

  1. The ActionQ locks the engine or Metasys server in the archive database.
  2. The ActionQ polls for progress during the synchronization process.

3, 4

  1. The ActionQ begins the synchronization process either immediately or at the time that you select. To start the synchronization, the ActionQ uploads the engine or Metasys server database into the SCT archive database.
  2. The SCT archive database saves a copy of the engine or Metasys server database and then uses the new file to rebuild the engine or Metasys server database.
  3. The SCT archive database applies all changes from the engine or Metasys server database to its own archive database.
  4. If the SCT detects structural errors, it restores the saved copy of the original database to the engine or Metasys server , an error message appears, and the both the device and SCT databases remain unchanged.
    Note: A structural error is a change made to one database that invalidates the other database. For example, a structural error occurs if you add an object to a folder in the SCT, but delete the corresponding folder online from the engine or Metasys server database.
  5. If structural errors are not detected, the ActionQ continues and downloads the new file from the SCT to the engine or Metasys server database. However, the engine or Metasys server applies the changes from the new file to the database and goes through the startup process without resetting.
  6. The ActionQ unlocks the engine or Metasys server in the archive database.
  7. The ActionQ displays the final status of the synchronization.