MetasysDatabaseManager Help LIT12011202
MetasysDatabaseManager Help LIT12011202
MetasysDatabaseManager Help LIT12011202
Installing the Metasys Database Manager Metasys Database Manager Installation LIT-12011553
Instructions
Working with Trends, Alarms/Events, Metasys system Help LIT-1201793
2
Monitoring
The monitoring feature continually reads database information and alerts you, via taskbar icon or e-mail or both,
based on user-configurable warning and alarm levels.
For more information, see these sections: To start using the Metasys Database Manager, see these sections:
Required Access Rights Checking Database Statistics
Taskbar Icon Backing up a Database
Status Bar Purging a Database
Tabs Restoring a Database
Expert Mode Managing Databases
Monitoring Settings Accessing/Starting Monitoring Settings
Split ADX Considerations Choosing Monitoring Settings
Interaction with the Metasys System Stopping Database Monitoring
Settings.xml Viewing the Log File
Log File
Taskbar Icon
The taskbar icon ( or or ) represents the status of your databases graphically and allows you to access
the Metasys Database Manager and its monitoring settings. As long as the icon is present (no matter which color it
is), the Metasys Database Manager is actively monitoring your databases.
Icon Colors
Icon Right-Click Menu
Opening the Metasys Database Manager to Manage Your Databases
Accessing/Starting Monitoring Settings
Metasys Database Manager Online Help PDF 5
Icon Colors
The Metasys Database Manager taskbar icon changes color and size to alert you if a database exceeds the limits
defined in the monitoring settings discussed in Choosing Monitoring Settings. If you click the icon, a balloon appears
that offers more details on the status of the databases.
The icon represents three states:
Normal
A green and small-sized database icon appears when all databases are within their limits. When you click the icon,
a balloon appears with the following text:
Status: Normal
All Metasys Databases are within acceptable file size limits.
When you click the balloon, the Statistics tab of the Metasys Database Manager appears.
Warning
A yellow and medium-sized database icon appears when one or more databases exceed their warning limits. When
you click the icon, a balloon appears with the following text:
Status: Warning
The following Databases are past their warning limits: DatabaseName
When you click the balloon, the Maintenance tab of the Metasys Database Manager appears so that you can maintain
the database.
To define Warning, see Choosing Monitoring Settings.
Alarm
Status Bar
The status bar provides information on the current activity of the Metasys Database Manager and is visible at the
bottom of all tabs (Figure 3). The status bar is not present on the Monitoring Settings window.
Figure 3: Status Bar
- ready
- action failed
- refreshing statistics
- restoring a database
- backing up a database
Note: During some maintenance operations, the Metasys Device Manager shuts down to
avoid possible database read/write conflicts. This process restarts the Metasys Device
Manager so that the Metasys user interface is once again available to users.
Note: During some maintenance operations, the Metasys Device Manager shuts down to
avoid possible database read/write conflicts. The Metasys user interface is unavailable
to users during this time.
- action successful
2 Text Includes text that describes the action currently taking place. If the Metasys Database Manager
is not currently performing a task, this part of the status bar shows when the data was gathered
from the database (when the snapshot was taken).
3 Additional Text Provides additional status description text. For example, when purging records, this part of the
status bar displays the number of records deleted out of the total number of records.
Tabs
The Metasys Database Manager contains a Status Bar and four tabs (Figure 4). Click a tab below to learn more
about the contents of that tab.
• Statistics Tab
• Maintenance Tab
• Backup Tab
• Restore Tab
Note: The Restore tab is available only in Expert mode.
Figure 4: Tabs in the Metasys Database Manager
Metasys Databases
The Metasys Databases section contains statistical information about the trend, alarm (event), audit, and annotation
databases (Table 6). The SQL Server software directly supplies all information on the tab. For more information on
the fields in the tab, refer to your SQL Server software documentation.
1 The background for these attributes changes color if they have exceeded the warning or alarm limitations defined in Choosing
Monitoring Settings. A yellow background indicates that the warning limitation has been exceeded, whereas a red background
indicates that the alarm limitation has been exceeded or the Database Manager cannot connect to the SQL Server database.
See Figure 5 for an example.
Maintenance Tab
The Maintenance tab provides an easy method of purging records from your Metasys server trend, alarm (event),
audit, and annotation databases. Figure 6 shows the Maintenance tab. Click a section below to learn more about
the contents of that section.
See Interaction with the Metasys System for information on ADS/ADX disruption during database maintenance.
Note: MetasysReporting does not appear on this list as it is self-maintaining.
Note: If you cannot see this tab, see Required Access Rights.
Note: Selected by default, currently this is the only option available to maintain your
databases.
Create Backup Prior to When checked, creates a backup file as defined by the parameters entered on the Backup
Maintenance? tab prior to removing data from the databases.
Note: Backups fail if there is not enough free disk space where you attempt to save the
backup file.
Maintenance Thresholds
The Maintenance Thresholds section allows you to purge the databases while still leaving a certain number of days
of data in the database. Select the number of days worth of data you want to retain. If you want to delete all records,
choose 0.
This section also contains the button that triggers the purge. You must make selections in the Backup
File Tab and Database Selection sections and select a database to purge before you click the Purge Data Now
button.
Backup Tab
The Backup tab allows you to create a SQL Server software backup of a database.
Note: If you cannot see this tab, see Required Access Rights.
Figure 7: Backup Tab
Database Selection
The Database Selection section allows you to choose which databases you wish to back up:
• JCIHistorianDB - trends
• JCIEvents - alarms (events)
• JCIAuditTrails - audits
• JCIItemAnnotation - annotations
• MetasysReporting - Metasys Advanced Reporting System information and Energy Essentials configuration
information
begins backing up the selected databases immediately. The backup is a full SQL Server database
backup and is performed without the need to shut down the Metasys Device Manager.
Note: The backup fails if there is not enough disk space for the backup file.
If you check the Rebuild Indexes during backup process option, SQL Server software rebuilds the database
indexes after the database is backed up. Index rebuilding using the Metasys Database Manager can slow down the
backup process but can speed up database access later.
Note: Re-indexing your database temporarily increases your database size (up to twice its original size). Make sure
you have enough hard disk space when checking this option.
Note: SQL Server software index rebuilding is a normal SQL Server software database maintenance operation
that should be done weekly or monthly depending on data change volume. Refer to the SQL Server software
documentation for details on the index rebuilding procedure.
Note: Rebuilding indexes can slow down the backup process.
Note: You cannot back up the JCIItemAnnotation database in Releases 2.2, 3.0, and 3.1.
Important: Restoring a database deletes any information that is in the database from the time the backup was
created to when it was restored. Use this option only as a last option to repair a corrupted database or
to restore a database during an ADS/ADX new release upgrade. This feature should not be used to
view historical data in the Metasys system. Instead, use the Export Utility for storing and viewing
historical data in more user-friendly formats.
You cannot restore database backups from a newer version of SQL Server software to an older version
of SQL Server software. For example, you cannot create a backup of Metasys databases that are
hosted on SQL Server 2008 software and restore them to SQL Server 2005 software. You can, however,
restore database backups from a older version of SQL Server to a newer version of SQL Server. If you
restore a database that was created using a version of SQL Server software that is older than the
version you are currently using, the Metasys Database Manager upgrades the database to function
with the current SQL Server software version.
If you restore a database from an earlier release of Metasys software than you are using, the ADS/ADX
stops functioning. No fail-safes exist to prevent you from restoring a database that is older than the
database you are using. Be sure to restore databases from the same release you are using if the
ADS/ADX is already installed. Beginning at Release 5.0, you can restore a Release 2.2 or later database
before the Release 5.0 ADS/ADX is installed (as part of data preservation during the upgrade process).
If you are not performing an out-of-place upgrade as detailed in the ADS, ADX, SCT Installation and
Upgrade Instructions Wizard Content (LIT-12011331), you cannot restore a database from a system
that does not have the Metasys Advanced Reporting System installed to a system that does have the
reporting system installed. The database does not contain all the stored procedures required to use
the reporting system. If you attempt to do this, the reporting system does not function.
Once you enter Expert mode and close the window, if you enter the Metasys Database Manager in standard mode,
the Expert mode functionality does not remain. You can have the Expert mode open at the same time as the standard
Metasys Database Manager. The snapshot time in the status bar indicates when each set of data is collected.
See Restoring a Database.
Restore Tab
The Restore tab is available only when you are using the Metasys Database Manager Expert mode. The Restore
tab provides a simple method to recover if your Metasys system database becomes corrupted. Perform a restore
only if there is no other alternative, and use the most recent successful backup file.
See Interaction with the Metasys System for information on ADS/ADX disruption during database restoration.
Note: If you cannot see this tab, see Required Access Rights.
The Restore tab opens with a warning and the choice to continue with or cancel the restore (Figure 8).
The text of the warning states: Warning!!! The restore function should only be used when a Metasys database
becomes corrupt OR when upgrading from one Metasys release to another. If the Metasys database already
exists, by performing a restore you will overwrite the existing Metasys database with the backup Metasys
database, thus losing any data in the existing database that is not in the backup Metasys database!!!
Cancel returns you to the Statistics tab. Continue allows you to choose the database to restore (Figure 9).
Figure 9: Restore Tab Contents
The Backup File box allows you to select the database to restore to the ADS/ADX using .
Important: Restoring a database deletes any information that exists in the database from the time the backup was
created to when it was restored. Use this option only as a last option to repair a corrupted database or
when upgrading from one Metasys Release to another. This feature should not be used to view
historical data in the Metasys system. Instead, use Metasys® Export Utility for storing and viewing
historical data in more user-friendly formats.
Monitoring Settings
Metasys Database Manager monitoring capabilities include indication of database status compared with three levels
of custom status standards. You must access the monitoring settings in a different window from the database
management functions that use the tabbed window discussed in Tabs.
When you log on to the Windows OS on an ADS/ADX computer, the monitoring starts automatically. Monitoring
does not stop unless you exit monitoring or log off of the Windows OS on the ADS/ADX computer. If you exit and
wish to restart monitoring, you either must log on to the Windows OS on the ADS/ADX or restart the monitoring
itself. See Stopping Database Monitoring and Accessing/Starting Monitoring Settings for information.
Figure 10: Monitoring Settings Window
By default, the Metasys Database Manager Monitor checks the databases every hour on the 53rd minute so it does
not interfere in any way with the default ADS Delivery Time of 12:15 A.M.
Email
E-mail is an optional feature for Metasys servers that is not often used. It requires a valid Simple Mail Transfer
Protocol (SMTP) e-mail account and access to the SMTP server. For the e-mail functionality to work, you must enter
at least one valid entry for SMTP server (outgoing), Email address (From), and Email address (To/CC/BCC)
(Table 10).
Table 10: Email Section Contents
Field Description
SMTP Server (outgoing) Enter either the IP address or the name of the SMTP server. We recommend using the IP
address because it does not rely on the Domain Name System (DNS) to resolve the name.
Example: 167.206.112.6 (mail-hub.optonline.net)
To avoid having the Monitoring Settings window appear when you restart the ADS/ADX, enter
the SMTP server in this field.
Note: If you are not sure of the SMTP server address or name, contact your Information IT
department.
Email Address (From) Enter the e-mail address from which the Metasys Database Manager Monitor e-mail comes.
Metasys Database Manager is used as an alias for e-mail clients that support it.
The Address List box allows you to enter e-mail addresses and cell phone numbers (for text messaging) that receive
notification from the Metasys Database Manager (Figure 13). See Email for selections that use the Address List
box.
1 Many cell phones have the ability to send and receive text messages. The Metasys Database Manager Monitor provides an
easy way to add e-mail addresses that correspond to this type of text messaging for cell phones that have this capability.
Warning
Use the Warning section to define the warning limit parameters (Table 12).
Table 12: Warning Section Contents
Field Description
Warning File Size Limit Choose the percentage of the maximum file size that the database file must reach before
a warning appears.
Show Warning Reminder every Check the box to show a warning balloon whenever a database size exceeds the value
in Warning File Size Limit.
Choose the interval for which you wish to show the balloon. By default, every 24th interval
is selected, which shows the warning balloon once a day until the database has been
reduced to an acceptable level.
Email on Warning Check this box to enable the e-mailing feature of the Metasys Database Manager Monitor.
Only one e-mail is sent the first time the database exceeds its warning limits.
Alarm
The Alarm section allows you to define the alarm limit parameters (Table 13).
Database Login
If you leave the fields in the Database Login section blank, the Metasys Database Manager uses the credentials of
the user logged on to the Windows OS to access the SQL Server database.
If you enter text into the Database User Account and Password fields, the Metasys Database Manager uses this set
of credentials to access the SQL Server database.
To ensure full access to Metasys Database Manager functionality:
• The credentials you enter must belong to a SQL Server System Administrator (sysadmin).
• Your Windows OS login must be that of the Administrator or a member of the Administrator group. Standard
Windows OS users cannot backup and restore or change monitoring settings, even if you enter SQL Server
sysadmin credentials in this box. However, Standard users can still view statistics.
See Taskbar Icon for information on required access rights.
2. The Metasys system terminates the session and displays the logon screen.
After maintenance and restore functions are complete, users can log on to the UI again.
Note: At Release 3.1 and later, the Metasys Database Manager on a unified ADX with the Simple Recovery
model no longer shuts down the Metasys system for the entire time that it takes to purge records. The
Metasys system shuts down only long enough to perform database cleanup.
Settings.xml
The Settings.xml file stores settings from both the Metasys Database Manager and Metasys Database Manager
Monitor. The file is stored in the XML directory in the same directory as the Metasys Database Manager. This file is
necessary for proper operation of both applications and should not be moved or removed. It is possible to edit the
.xml file, but we do not recommend it for most users.
Log File
Log information is stored in the Windows Event Viewer and accessed via the Taskbar Icon right-click menu. Figure
15 shows sample entries.
See Viewing the Log File for information on opening the log file.
Detailed Procedures
Procedures are divided into two major sections: Managing Databases and Monitoring Databases.
To manage databases, see these sections: To monitor databases, see these sections:
Opening the Metasys Database Manager to Manage Your Databases Accessing/Starting Monitoring Settings
Checking Database Statistics Choosing Monitoring Settings
Backing up a Database Stopping Database Monitoring
Purging a Database
Restoring a Database
Also, see Viewing the Log File for information on opening the log file.
Managing Databases
Managing databases involves the following steps:
• Opening the Metasys Database Manager to Manage Your Databases
• Checking Database Statistics
• Purging a Database
• Backing up a Database
• Restoring a Database
Opening the Metasys Database Manager to Manage Your Databases
Database management capabilities appear in a different window from the monitoring capabilities.
To open the Metasys Database Manager to manage your databases:
1. Do one of the following:
2. On Windows 7 or Windows Server 2008, if the User Account Control box appears, click Yes or Allow. If you do
not click Allow, only the Statistics tab is available for you.
If no box appears and the Metasys Database Manager opens with only the Statistics tab available, the other
tabs are not available to you based on your Windows OS login rights.
See Required Access Rights for information on both of these scenarios.
Go to Checking Database Statistics, Backing up a Database, or Purging a Database.
Checking Database Statistics
Use the Statistics Tab tab to check database statistics.
To check database statistics:
1. Open the Metasys Database Manager. See Opening the Metasys Database Manager to Manage Your Databases.
2. On the Statistics tab, note information about the databases and server.
Purging a Database
Use the Maintenance Tab tab to purge databases.
Important: Unless you create a backup file of a database before you purge it, the database information is
irrecoverable once you click Purge Data Now.
The Maintenance tab is not available to all users based on their Windows OS login credentials. See Required Access
Rights.
To purge a database:
1. Open the Metasys Database Manager. See Opening the Metasys Database Manager to Manage Your Databases.
2. Click the Maintenance tab.
Note: If the Maintenance tab is not visible, this tab may not be available to you based on your Windows OS
login rights or for Windows 7 or Windows Server 2008 OS, and you did not click Yes or Allow on the User
Account Control box. See Required Access Rights and Opening the Metasys Database Manager to
Manage Your Databases for details.
3. Under Maintenance Type, click Create Backup prior to maintenance if you would like to create a backup before
you purge the database.
Note: If you click this box, you must enter information on the Backup tab before you click Purge Data Now,
including the location where the backup files are saved.
4. Under Maintenance Thresholds, select an amount of data to leave in the database, if desired.
5. Under Database Selection, choose the databases you would like to purge.
Note: If you click the Create Backup prior to maintenance box, you must enter information on the Backup
tab before you click Purge Data Now
6. Click Purge Data Now. The status bar reflects the status of the purge.
• If your Metasys system databases are on a unified ADX and set to the Simple Recovery model, the Metasys
system is not shut down at the start of the purge (Figure 17).
Figure 17: Purge Only Screen (No Metasys System Shutdown)
Regardless of the recovery model you are using, all Metasys systems are shut down at the end of the purge process
to perform database cleanup.
When the purge is complete, the status bar looks like Figure 18.
Figure 18: Successful Purge
Backing up a Database
Use the Backup Tab to back up a database. You do not have the option to rename a backup file, but if you select
Create New File when you back up a file, the backup version does not overwrite the previous version and has the
date added to its name.
We recommend that you occasionally delete database backups to save room on your computer. If you are aware
of a database that is no longer needed, delete it from the computer.
If desired, you can back up a database before purging it. Backing up a database ensures that if you purge data that
you need, you can restore the data and attempt the purge again. See Purging a Database.
If you check the Create Backup prior to maintenance box on the Maintenance tab, you must fill in the fields on the
Backup tab before you purge a database.
The Backup tab is not available to all users based on their Windows OS login credentials. See Required Access
Rights.
To back up a database:
1. Open the Metasys Database Manager. See Opening the Metasys Database Manager to Manage Your Databases.
Restoring a Database
Important: Restoring a database deletes any information that exists in the database from the time the backup was
created to when it was restored. Use this option only as a last option to repair a corrupted database.
This feature should not be used to view historical data in the Metasys system. Instead, use the Export
Utility for storing and viewing historical data in more user-friendly formats.
You cannot restore database backups from a newer version of SQL Server software to an older version
of SQL Server software. For example, you cannot create a backup of Metasys databases that are
hosted on SQL Server 2008 software and restore them to SQL Server 2005 software. You can, however,
restore database backups from a older version of SQL Server to a newer version of SQL Server. If you
restore a database that was created using a version of SQL Server software that is older than the
version you are currently using, the Metasys Database Manager upgrades the database to function
with the current SQL Server software version.
If you restore a database from an earlier release of Metasys software than you are using, the ADS/ADX
stops functioning. No fail-safes exist to prevent you from restoring a database that is older than the
database you are using. Be sure to restore databases from the same release you are using if the
ADS/ADX is already installed. Beginning at Release 5.0, you can restore a Release 2.2 or greater
database before the Release 5.0 ADS/ADX is installed (as part of data preservation during the upgrade
process).
For more information on the fields on the Restore tab, see Restore Tab. The Restore tab is available in Expert mode
only.
Expert mode and the Restore tab are not available to all users based on their Windows OS login credentials. See
Required Access Rights.
To restore a database:
1. Using Windows Explorer, browse to C:\Program Files\Johnson Controls\Metasys Database Manager. See Figure
20 for an example.
2. Double-click Expert Mode. The Metasys Database Manager opens in Expert mode with the Restore tab enabled.
Note: For the Windows 7, Windows Server 2008 R2, and Window Server 2008 operating systems, if the User
Account Control box appears, click Yes or Allow.
If you do not click Yes or Allow, no box appears and the Metasys Database Manager opens with only the
Statistics tab available. Expert mode is not available to you based on your Windows OS login rights.
Monitoring Databases
Monitoring databases involves the following steps:
• Accessing/Starting Monitoring Settings
• Choosing Monitoring Settings
• Stopping Database Monitoring
Accessing/Starting Monitoring Settings
This procedure starts monitoring if you have stopped it and allows you to access settings while monitoring is taking
place.
To choose Metasys Database Manager monitoring settings:
Windows XP/Windows Server 2003
1. Log on as a user with Administrator privileges.
2. Do one of the following:
• Right-click or or in the taskbar and select Settings. This setting only appears if you are logged
on as a user with Administrator privileges.
• On the Windows Start menu, browse to All Programs > Johnson Controls > Metasys Database Manager >
Metasys Database Monitor. You should only perform this step if you do not see the Monitor icon in the system
tray.
Note: Use this option if you clicked Exit on the Metasys Database Manager icon right-click menu.
Windows 7/Windows Server 2008 R2/Windows Server 2008
1. Log on as a user with Administrator privileges.
2. If the Settings selection or Monitoring Settings window does not appear, this may be a result of your Windows
OS login privileges (see Required Access Rights). Do the following:
a. On the Windows Start menu, browse to All Programs > Johnson Controls > Metasys Database Manager.
b. Right-click Metasys Database Monitor and select Run as Administrator.
If you are not a member of the Administrator group, a credentials box appears. Enter your credentials.
If you have sufficient privileges, the User Account Control box appears. Click Yes or Allow. The Metasys
Database Manager icon appears in the taskbar.
c. Right-click or or in the taskbar and select Settings. The Metasys Database Manager Monitoring
Settings window appears.
Go to Choosing Monitoring Settings for information on choosing Monitoring settings.
Choosing Monitoring Settings
For more information on the contents of the Monitoring Settings window, see Monitoring Settings.
To choose the Metasys Database Manager monitoring settings:
1. Access the monitoring settings. See Accessing/Starting Monitoring Settings.
1. Right-click or or in the taskbar and select Exit. A message box appears asking if you would like to
exit database monitoring (Figure 22).
2. Click OK.
Note: The log creates an entry when you exit database monitoring. See Log File.
1. Right-click or or in the taskbar and select View Log File. The Windows Event Viewer opens.
Building Efficiency
507 E. Michigan Street, Milwaukee, WI 53202
Metasys® and Johnson Controls® are registered trademarks of Johnson Controls, Inc.
All other marks herein are the marks of their respective owners. © 2013 Johnson Controls, Inc.