Download - Metasys - LIT-12011964 - Software Application - System Configuration Tool - 16.0

SCT: System Configuration Tool Help

Brand
Metasys
Product name
System Configuration Tool
Document type
User Guide
Document number
LIT-12011964
Version
16.0
Revision date
2023-10-02
Language
English

You can use the Manage Archive wizard download option to transfer a copy of the archive database from the SCT to the engine or server database. During the download process, the SCT archive database overwrites the engine or server database. At the end of the download, the engine or server restarts and does not control or monitor the system until the restart is complete. However, for network engines at Release 10.1 or later, a Background File Transfer (BFT) feature is built into SCT 14.x. During BFT, an engine remains online and continues to control the building. The Background File Transfer feature is available with the Activate Immediately and Enable SNC Logic options on the Action window (Figure 1).

Important: If you do not manually set the Advanced Security Enabled attribute for a Site to False before you upgrade to SCT Release 14.x, a previous default value of False changes to True after you upgrade. When the value is set to True, after you perform a download, a Site Director at SCT Release 14.x discards all communication attempts from network engines prior to SCT Release 14.0. For more details, see Site Attributes.
Important: From Metasys Release 10.0, if you enable DHCP for a site, and a supervisory device is in a different domain to the Site Director, add the domain of the Site Director to the Completion Domains attribute of the supervisory device. See Engine Attributes. If you do not add the domain of the Site Director, then the supervisory device loses connection to the Site Director after you perform a download.
Note: You can use SCT to schedule downloads for various devices at a specific time. However, SCT can only run ten device downloads simultaneously. For instance, if you select 20 devices to download, SCT processes the first 10 downloads simultaneously and continues to pick up the other 10 engine downloads one at a time as the first downloads complete.
Download options include:
  • Include Security

    You can choose to include the security database when you perform a download. To include a security database, select the Include Security check box. However, only include the security database if one exists in the archive. To transfer a security database to the archive, perform an upload. If you include the security database, the download time increases.
    Important: If your security database includes Active Directory users, you must always select Include Security when you upgrade the engine or server database. Otherwise, the Active Directory users are no longer present and the option to select Active Directory users on the SMP UI log on screen no longer appears. To retrieve your Active Directory users, download the database again, but this time select Include Security.
    Note: Network engines require additional security certificates to be stored locally on the devices. When you download certificates, all of the certificates stored in the SCT archive are transferred to a network engine. For more information, see Certificate Management.
  • Download Code

    Use the Download Code option to update the software disk image of a supervisory device, and as a convenient alternative to the NAE Update Tool. The software image of the supervisory device that you want to download must be stored in the default location used when the file is unzipped. That location is C:\NAEUpdateTool\tftpfiles. If you use the SCT to update an NxE to a Release 10.0 or later image, a PXE download is performed. The SCT computer must be on the same subnet as the NxE. After you use the SCT to update the software disk image of the supervisory engine, the archive database is automatically downloaded to the supervisory engine.

    Important: You cannot use Release 9.0.7 image files in a code download. Also, if more than one image file is installed on the SCT computer, SCT selects the most recent image file for the model of NxE that you are downloading. If the SCT does not support the image that you want to download, either use the Reflash Device option in SCT Pro, or use the NAE Update Tool to perform a code download. Both methods require the SCT computer and the NxE to be on the same subnet. For Release 9.0.7 images and later, select the PXE Only option in the NAE Update Tool for the update process. If for any reason SCT or SCT Pro fails to download code to a network engine, use the NAE Update Tool over the same subnet using the PXE Only method.
    Note: If you use the NAE Update Tool feature of SCT at a release before SCT 10.0, the NAE Update Tool and SCT must match release versions. For SCT 10.0 and later, the NAE Update Tool and SCT are part of a common installation, so the tools are the same release.
  • Only Metasys UI Spaces and Equipment

    Note: You can use this function instead of Synchronize when only updating the server with Metasys UI changes.

    From SCT Release 11.0, you can download Metasys UI spaces and equipment information to your server-class device with the Manage Archive wizard. The Metasys UI Spaces and Equipment download option allows you to easily transfer SCT-configured Metasys UI spaces, equipment definitions, and equipment objects to an ADS, ADX, or ADS Lite that is configured at Metasys Release 8.0 or later. The new spaces and equipment download option does not include graphics and is not intended to replace a full download to your server; instead, it offers a specific and simplified download for offline UI configuration.

    Note: After an Only Metasys UI Spaces and Equipment download, the Metasys UI needs to re-initialize and users need to login again.
  • Include UI resource files on N40 Class Devices

    N40 Class devices include NCE25s, NIE29s, NAE35s, NIE39s, NAE45s, and NIE49s. You can clear this check box to reduce the time required for the download, and to save memory space on the engine. You must include UI resources on an engine to log on to it directly using SMP. However, after you log on to an engine, the UI resources are cached in the Launcher application. You can log on to a different engine of the same model and Release to cache the required UI resources.

  • Include HTTPS Certificates

    The download function lets you download HTTPS certificates to a network engine.

  • Activate Immediately

    When you use SCT Release 13.2 or later to perform a download to an NAE55-2, NAE55-3, SNE, or SNC, you can choose when to activate the downloaded files. If you select this check box, the files activate after the download completes. If you clear this check box, you download the files but do not activate them. To manually activate files, use the SMP to issue an Apply staged files command. For more details, see Background File Transfer.
    Note: Some firewall software blocks port 443 on public networks. To use BFT, unblock port 443.
  • Enable SNC Logic

    Select this check box to enable logic on the SNC device after the download activates. Clear this check box to disable logic after the download activates. To enable logic at a later time, edit the Focus window for the Program object, change Enabled to equal True, and then save the change. To control when the download activates, see the Activate Immediately check box.

Figure 1. Download to Device

Figure 2. Download Workflow Diagram

To Download Changes to a Device:

  1. On the Tools menu, select Manage Archive. The Manage Archive wizard appears.
  2. Select Download to Device.
  3. If you want to exclude the security database, select the Include Security check box to deselect the option.
    Note: By default, the Include Security check box is selected at SCT Release 10.0 or later.
  4. If you want to include the UI on N40 devices, select the Include UI on N40 Class Devices check box. This option is only available if you select the Download Code check box.
  5. If you want to include HTTPS certificates, select the Include HTTPS Certificates check box to select the option.
  6. Click Next.
  7. Select the devices to download and click Next.
  8. Select the download Schedule method and click Next.
  9. Select the Site Login method.
    Note: Do not select Communicate via Site Director for a network engine that was newly updated with the NAE Update Tool. For more information, see Table 1.
    Figure 3. Site Login Screen

    To communicate through the Site Director:

    1. Select the check box.
    2. Enter the username and password for an administrator account for the Site Director.
    3. Click Test Login.
    4. If you use the default username and password to log on, you are prompted to enter a new password for the Site Director. However, if you select to include security, and the archive contains a security database for the Site Director, the account details stored in the security database override the new password that you enter.
    5. When the log on is successful, click Next.

    To communicate through individual devices:

    1. Enter the username and password for an administrator account on each physical device.
    2. Click Test Login.
    3. If you use the default username and password to log on, you are prompted to enter a new password. All engines that use the default credentials are updated to use the new password. However, if you select to include security, the account details stored in a security database override the new password that you enter.
    4. If the Status column has a Login ID is not OK for any devices, repeat steps 9a through 9c 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.
    5. When Login ID is OK is shown for all devices, click Next.
  10. Optional: Pair NxEs at Metasys Release 10.0 or later with a Site Director (see Pairing supervisory devices with Site Director During a Code Download).
  11. Review the download Summary and click Finish to perform the download.
  12. After the download process is complete, verify the Completion Status column in the Completed Actions window reports OK.
Note: After you perform a download to a device, some changes do not appear in active sessions of the SMP connected to that device. For example, if you perform a download to an ADX, the Signature and Annotation settings shown in the SMP remain unchanged. After a download completes, close any active sessions of the SMP, restart the SMP, then reconnect to the device.

Download Only Metasys UI Spaces and Equipment:

Note: The Metasys UI Spaces and Equipment download option allows a user to transfer SCT-configured spaces, equipment definitions, and equipment objects to an ADS, ADX, ADS-Lite, or OAS at Release 8.0 or later. This download does not include graphics and is not intended to replace a full download to your server.
  1. On the Tools menu, select Manage Archive. The Manage Archive wizard appears.
  2. Select Download to Device.
  3. Click Only Metasys UI Spaces and Equipment and click Next.
    Note: The Metasys server must be at Release 8.0 or later to select Only Metasys UI Spaces and Equipment.
  4. Select your server Site Director and click Next.
    Note: Metasys UI Spaces and Equipment download only supports ADX, ADS, ADS-Lite, and OAS servers. If you attempt to download Metasys UI to an NAE, the download fails.
  5. Select Download now and click Next.
  6. Select the Site Login method.
    Note: Do not select Communicate via Site Director for a network engine that was newly updated with the NAE Update Tool. For more information, see Table 1.

    To communicate through the Site Director:

    1. Select the check box.
    2. Enter the username and password for an administrator account for the Site Director.
    3. Click Test Login.
    4. If you use the default username and password to log on, you are prompted to enter a new password for the Site Director. However, if you select to include security, and the archive contains a security database for the Site Director, the account details stored in the security database override the new password that you enter.
    5. When the log on is successful, click Next.

    To communicate through individual devices:

    1. Enter the username and password for an administrator account on each physical device.
    2. Click Test Login.
    3. If you use the default username and password to log on, you are prompted to enter a new password. All engines that use the default credentials are updated to use the new password. However, if you select to include security, the account details stored in a security database override the new password that you enter.
    4. If the Status column has a Login ID is not OK for any devices, repeat step 6a and 6c 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.
    5. When Login ID is OK is shown for all devices, click Next.
  7. Review the download summary and click Finish to perform the download.
Note: After an Only Metasys UI Spaces and Equipment download, the Metasys UI needs to re-initialize and users need to log on again.

Table 1. Manage Archive wizard Screens

Screen

Purpose

Action

Select Download To Device as the type of action and select the download options.

Select Devices

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

Schedule

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

Device Change

  • Appears in the Download wizard when only one device is selected for download.
  • To change the Name and Computer Name of a device during the download, click Use this option to rename a device via download and enter the new name in the text box.
  • To change the address of a device during the download, click Use this option to change a device address via download and enter the new address in the text box.
Note: You cannot use this Device Change option to change the name of a server. The name of the server object is the same as the computer host name. To change the name of the server object, you must follow the rename procedure defined in the ADS/ADX Commissioning Guide (LIT-1201645) or the ODS Commissioning Guide (LIT-12011944).

Site Login

Select Communicate via Site Director if the destination device is not accessible on the local area network. This option slows down the operation if used unnecessarily.

Note: A network engine download may fail with the error Device Type Mismatch if you select Communicate via Site Director for a network engine that was newly updated with the NAE Update Tool. By design, a newly updated engine is its own Site Director, so you do not need to select the Communicate via Site Director option.

If a different user name and password are required, enter the user name and password. For example, on a newly updated engine, specify the default user name (MetasysSysAgent) and default password. If you log on using the default credentials during a download, you are prompted to change the password.

Device Pairing

You have the option to pair NxEs at Metasys Release 10.0 or later with a Site Director during a code Download (see Pairing supervisory devices with Site Director During a Code Download)

Summary

View the basic parameters of the device or devices to be downloaded.
ActionQ Processing of Downloads:
Figure 4. Download Process

Table 2. Download Process

Number

Process Description

1

After configuring a download in the Manage Archive wizard, the Manage Archive wizard sends the download command to the ActionQ in the SCT.

2

  1. The ActionQ polls for progress during the download process.
  2. The ActionQ begins the download process at the time defined for the download.

3

The ActionQ transfers the SCT archive database file to the engine or server database. If you selected the Download Code option, the software image for the engine is transferred first before the database. If you selected the Only Metasys UI Spaces and Equipment option, SCT-configured Metasys UI spaces, equipment definitions, and equipment objects are transferred to the server at Release 8.0 or later. If you selected the Include HTTPS Certificates option, ActionQ also sends down the certificate file of the supervisory controller stored in the archive for engines at Release 8.1 or later.

Notes:
  • If there are multiple versions of a disk image on the site, SCT selects the most recent image of any given release.
  • If you need to update an NCE25, follow a two-step process: download its code first, then download its local application.

4

The ActionQ displays the final status of the download.