metasys ui technical bulletin

Metasys UI Technical Bulletin

LIT-12012115

Release 10.0

Building Technologies & Solutionswww.johnsoncontrols.com2018-12-17

ContentsContentsMetasys UI Introduction...................................................................................................................3

Summary of Changes............................................................................................................................3

Concepts............................................................................................................................................3

Metasys UI............................................................................................................................................... 3

Installing the Metasys UI............................................................................................................ 3

Browsing to the Metasys UI........................................................................................................4

Authentication............................................................................................................................. 4

Security Certificate Warnings.................................................................................................... 4

Features of the Metasys UI.........................................................................................................4

Metasys UI Offline.................................................................................................................................. 8

Installing the Metasys UI Offline................................................................................................8

Browsing to the Metasys UI Offline...........................................................................................8

Authentication............................................................................................................................. 8

Security Certificate Warnings.................................................................................................... 8

Features of the Metasys UI Offline............................................................................................ 9

Configuration....................................................................................................................................... 10

SCT and Site Archives............................................................................................................... 10

User Authorization in the Metasys UI..................................................................................... 10

Repositories..........................................................................................................................................11

Metasys UI Uses for Repositories............................................................................................ 12

Trend Repository Database..................................................................................................... 12

Audit Repository Database...................................................................................................... 13

Event Repository Optimization............................................................................................... 13

Metasys UI Reporting Repository Database......................................................................... 14

Spaces Authorization Repository Database.......................................................................... 14

Data Usage...........................................................................................................................................15

Detailed Procedures.......................................................................................................................15

Adding the Metasys UI Site as a Bookmark in Launcher................................................................ 15

Adding the Metasys UI Offline Site as a Bookmark in Launcher....................................................15

Graphics Association...........................................................................................................................16

Associating Graphics+ Graphics..............................................................................................17

Associating Standard Graphics............................................................................................... 18

Working with Metasys System Preferences...................................................................................... 19

Changing the Status Color, State Colors, and Flash Settings..............................................20

Changing the New Alarm Indicator Setting.......................................................................... 21

Changing the Alarm Sound Interval, Alarm Sound, and Alarm Priorities......................... 21

Changing the Trend Line Color and Markers........................................................................ 22

Adding and Managing Annotation Text.................................................................................22

Troubleshooting............................................................................................................................. 23

Related Documentation................................................................................................................ 29

Metasys UI and Metasys UI Offline Technical Specifications......................................................30

Metasys UI Technical Bulletinii

Metasys UI Introduction

This document contains important information about the Metasys® User Interface (UI) and theMetasys UI Offline. The Metasys UI is a mobile-optimized software component that consolidatesexisting Metasys user interface products into a single, simplified, and easy-to-learn interface. TheMetasys UI Offline is a software component that uses the System Configuration Tool (SCT) archivesto validate and view the spaces, equipment, and graphics association configurations.This document covers high-level installation, configuration, and site management tasks for bothMetasys UI and Metasys UI Offline sites. If not explicitly called out in this document, Metasys UIrefers to both the online and offline sites.

Summary of Changes

The following information is new or revised:• Changed licensing document referenced in Related Documentation to Software Activation

Manager Help (LIT-12012389).

• Updated the Features of the Metasys UI and Features of the Metasys UI Offline sections for thenew features at Release 4.0. New features include Scheduled Report, Bulk Modify, Multiple ChartTrend Viewer, Priority Array, Advanced Search filter by Equipment Definition short names, SmartFiltering, Time Picker, Building Network Tree in Graphics Editor, Custom Symbols Library, context-sensitive Binding Tree, Path Tool Editing, link from Alarm Manager and Commanding Dialog toBuilding Network, and Graphic Association Manager for Aliased Graphics.

• Added Troubleshooting information about Sync Engine command, spaces and equipmentlimitations, application pool recycle, Status Summary issues, and failure of Scheduled Reportemail delivery.

• Updated the Metasys UI and Metasys UI Offline Technical Specifications.

Concepts

Metasys UI

The Metasys UI provides a simple location-based navigation approach to finding informationabout the Metasys site, including the ability to search for any location or equipment by name andto bookmark a location or equipment in a web browser. All data displayed in the Metasys UI isorganized in a dashboard format that gives you the overview of what is happening within a space,equipment, or central plant. You can also create, edit, and manage graphics and their associationsto equipment, spaces, and equipment definitions. You can access the Metasys UI from any type ofclient device with any screen size.

Installing the Metasys UI

The Metasys UI is installed as part of Metasys Server installation. For more information aboutinstalling the Metasys Server and the Metasys UI, refer to the Metasys® Server Installation andUpgrade Instructions Wizard (LIT-12012162) or the Metasys® Server Lite Installation and UpgradeInstructions (LIT-12012258).

3Metasys UI Technical Bulletin

Browsing to the Metasys UI

To browse to the Metasys UI from a client computer or device in a supported web browser, goto https://[host name]/UI, where [host name] is the host name, server name, or IP address ofthe Application and Data Server (ADS), Extended Application and Data Server (ADX), or ADS-Litecomputer.

Authentication

The Metasys UI uses the same credentials as the ADS/ADX or ADS-Lite and Site Management Portal(SMP). To log in to the Metasys UI, use the SMP user name and password.

Security Certificate Warnings

When you browse to the Metasys UI, and if the Metasys UI site does not have a trusted securitycertificate, the web browser displays a security certificate warning.

Note: Ensure that your web browser has cookies enabled before browsing to the Metasys UI.

If you see the security certificate warning, browse to the Metasys UI site by doing the following:• For Google® Chrome™:

a. Tap or click Advanced.

b. Tap or click Proceed to [IP Address], where [IP Address] is the IP Address of the ADS/ADXor ADS-Lite computer. The Metasys UI login screen appears.

• For Windows® Internet Explorer® 11 and Microsoft Edge: Tap or click Continue to this website(not recommended). The Metasys UI login screen appears.

• For Apple® Safari® 10 or later: Tap or click Continue in the Cannot Verify Server Identity window.The Metasys UI login screen appears.

Note: The Metasys UI does not support autofill functionality for the user name or passwordfields.

We strongly recommend installing a trusted security certificate. For more information aboutsecurity certificate implementation for the Metasys UI, see Metasys® Server Installation and UpgradeInstructions Wizard (LIT-12012162).

Features of the Metasys UI

The Metasys UI has the following features:

Navigating by Spaces

Spaces help you organize the information displayed for the Metasys system into physicallocations (a campus and buildings) and areas within those locations (floors, zones, androoms). The hierarchy resembles the physical world to help you navigate your Metasyssystem. Each space has a hierarchical relationship to other spaces, and a served-byrelationship to the equipment that provides services to the space.

Navigating by Building Network

The Building Network provides access to all objects using an alternative navigation treeto the Spaces tree. The Building Network organizes objects according to the Metasyscomponent hierarchy, similar to the All Items tree in the Site Management Portal (SMP). TheBuilding Network supports a Focus view, Summary view, Network view, Relationships view,and Trend view. Objects listed in the Building Network tree are identified by name and byicons, that support Global Status indicators.

Metasys UI Technical Bulletin4

Viewing a site by Dashboards

The Space dashboard provides a comprehensive summary of the selected space, includingthe equipment that serves the space and potential problem areas in the space. TheEquipment dashboard provides a cohesive summary of a selected piece of equipment.Information displayed includes alarm history, user change history, historical trendinformation, and relationships with other equipment and spaces.

Searching by Space and Equipment

You can search for the exact string that is contained in the space or equipment name. Forexample, if you search floor, the results include any space or equipment with the word floorcontained in the name of any given space. Or, if you search fan, the results include anyequipment with the word fan. You can also search words and phrases with varying case andobtain the same search results.

Learning about Equipment and Potential Problem Areas

The Potential Problem Areas widget provides a single display showing all items in alarm,warning, overridden, out of service, and offline statuses within a space. This display lets youfilter and view data that is important to you. The Potential Problem Areas widget can beused as a daily punch list to manage buildings more efficiently. With the Equipment Activitywidget, you can easily see and understand the correlation between disparate events withinthe system.

Adding Annotations

You can add an annotation of 1–255 characters that may be used to describe anyoperational tasks that should be performed in response to the cause or condition thatprompted the event message. You can add and view annotations to commands (userchange), alarm instances, and system changes. In addition to user-defined annotations,discards and acknowledgments of alarms display as annotations.

Viewing Trends through the Custom Trend Viewer and the Trend Widget

The Custom Trend Viewer allows you to view historical trend data for up to 10 points oncomputer platforms and tablets, and up to four points on smart phones for several piecesof equipment configured for the Metasys UI. The Trend widget allows you to view historicaltrend data for up to 10 points for a single piece of equipment. The Trend widget can alsoplot points from the equipment being served by the equipment you are currently viewing.Starting at Release 10.0, the user can view trended data points on up to three differentcharts at once. This helps operators visualize trended points of drastically different ranges.

Commanding with integrated Priority Array

An updated commanding dialog view with integrated Priority Array identifies the currentcommand priorities. This helps operators troubleshoot issues faster by making it easier forthem to determine what command priority is currently active on a point object. In addition,you can navigate directly from the Commanding Dialog to the Building Network through alink, without having to manually search the network tree after finding the root cause of analarm or other issue.

Creating and Managing Graphics

Use the Graphics Manager and Graphics Editor to create and manage graphics and theirassociations for the Metasys UI graphics. You can import and export Custom Symbolsinto the Graphics Library with the new Custom Symbols Library. Custom Symbol Librariesintegrate seamlessly with the base graphics package. With the Graphics Manager, you


can also manage associations for supported legacy graphics. When the graphics areassociated with a space, equipment, or equipment definition, you can view the graphicson the associated Equipment dashboard or Space dashboard. You can bind graphics toan equipment definition with the Graphics Association Manager for Aliased Graphicsfeature, so that all equipment associated with that definition will be assigned the graphicautomatically. You can also bind Network Tree items to graphics with the Building NetworkTree binding option in the Graphics Editor. The binding tree is context-sensitive, whichensures that the binding tree opens to the appropriate space or equipment when the userlaunches the Graphics Editor from a particular space or equipment. Lastly, you can edit anexisting path that was drawn with the drawing tool with the Path Tool editing feature.

Viewing Legacy Graphics+ Graphics and Standard Graphics

You can view graphics associated with a space or a piece of equipment. Graphics provide avisual representation of the monitored systems that enable you to quickly check the statusof spaces or equipment and recognize unusual system conditions. Graphics can be designedto allow you to navigate to buildings, floors, and other areas, and to view building systemsand control processes.

Managing Schedules

You can edit and view schedules associated with a space or a piece of equipment. Schedulesprovide a visual representation of the monitored systems that enable you to quickly check ifa schedule associated with your space is enabled or disabled. The Schedule widget providesa summary of how a space is affected by a scheduling strategy so that you can understandthe complete picture. The Schedule widget also provides a way to view effective scheduleinformation for a specific date in the future, so that you can ensure it is set up correctly.

Acting on Alarms

Using your computer or tablet, you can view and take action on Metasys system alarms withthe Alarm Manger and Alarm Monitor. Starting at Release 10.0, you can navigate directlyfrom the Alarm Manager to the Building Network through a link, without having to manuallysearch the network tree after finding the root cause of an alarm. Use your smartphone toview and take action on alarms in the Alarms list (Alarm Announcement) on your phoneplatform.

Authorizing Users within the Metasys UI

With User Authorization within the Metasys UI, you can explicitly grant access to specificspaces, which indirectly grants access to equipment serving the spaces.

Advanced Search, Commanding in Bulk, Modifying in Bulk, Reporting, and Smart Filtering

The Advanced Search and Reporting feature brings powerful insights to all Metasys users byproviding an intuitive and easy method to gather and analyze data. Users can quickly searchfor data across the Building Network tree or by spaces or equipment. Using a series offilters, including wildcards, you can refine your search results. For example, you can searchfor all zone temperature points in a specific space.

With the Advanced Search results, you can:

• create reports showing historical activity, alarms, audits, and trend data based on adefined time range.

• export report data to CSV or PDF file formats on an ad hoc basis or by scheduling areport.


• issue bulk commands to selected points.

• perform bulk modify of multiple objects or attributes on a single object

Table 1: New Advanced Search and Reporting features at Release 10.0

Feature DescriptionScheduled Reports Provides the ability to schedule the email delivery of reports to up to 10

specified recipients. Report templates can be saved and be executed "ondemand" in the future.

Advanced Searchfilter by EquipmentDefinition shortnames

Enables the filtering down of an Advanced Search to only include specificEquipment Definition short names.

Time Picker Enables the initiation of reporting and filtering for a specified time range,including for ranges less than one day.

Bulk Modify Enables the modification of multiple objects or multiple attributes on asingle object.

Smart Filtering Enables launching directly from certain widgets into a pre-populatedAdvanced Search. The filters are populated based on the equipment, space,and object information included in the widget. Users can launch AdvancedSearch from the following widgets:• Equipment Summary widget• Equipment Serving Space widget• Equipment Data widget• Graphics widget• Summary View widget

Important: Spaces and equipment do not need to be configured for users to takeadvantage of the Advanced Search and Reporting feature. Advanced Search isavailable on computer and tablet platforms, but it is not available on phone platforms.Additionally, the Reporting, Bulk Commanding, and Bulk Modifying features ofAdvanced Search are not available on tablet or phone platforms.

Custom Behaviors

A Custom Behavior is a user-defined behavior made up of an effect, trigger, and optionalrule. A Custom Behavior can be applied to a shape, symbol, element of a symbol, or image.With Custom Behaviors you can create custom symbols to meet unique operational needs.

Custom Dashboards

Custom dashboards allow Metasys UI designers to customize their dashboards by thewidgets to include, the widget order, the widget appearance, and by device type (desktop,tablet, and phones). These custom dashboards can be applied to all spaces and equipment,including spaces (by type) and equipment (by definition).

Usage Analytics

Release 10.0 also includes a new usage statistics feature that collects information on howbuilding operators use Metasys UI and what types of devices they use to access it. Thishelps improve the Metasys experience by providing insights to Metasys developers on howoperators navigate and interact with Metasys software. You can enable or disable Usage


Analytics in the Metasys UI either at the site level or the user level. As an Administrator, youcan enable Usage Analytics at both levels. As a Non-Administrator, you can only enableUsage Analytics at user level, provided that the Administrator has already enabled UsageAnalytics for the entire Metasys site.

Metasys UI Offline

The Metasys UI Offline provides the ability to view spaces and equipment configuration, and createand manage graphics and their associations to equipment and spaces. You can also and create andmanage graphics and their associations to equipment and spaces. The Metasys UI Offline leveragesthe SCT archives instead of the live site. Access the Metasys UI from any type of client device withany screen size.

Installing the Metasys UI Offline

The Metasys UI Offline is installed as part of the SCT installation. For more detailed informationabout installing the Metasys UI Offline, refer to SCT Installation and Upgrade Instructions(LIT-12012067).

Browsing to the Metasys UI Offline

To browse to the Metasys UI Offline from a client computer or device, in a supported web browsergo to https://[host name]/UIOffline, where [host name] is the host name, server name, or IP addressof the SCT computer.

Authentication

The Metasys UI Offline uses the same credentials as the SCT. To log in to the Metasys UI offline, useyour SCT user name and password.

Security Certificate Warnings

When browsing to the Metasys UI Offline, if the Metasys UI Offline site does not have a trustedsecurity certificate, the web browser displays a security certificate warning.

Note: Ensure your web browser has cookies enabled before browsing to the Metasys UIOffline.

If you see this warning, browse to the Metasys UI Offline site by doing the following:• For Google® Chrome™:

a. Tap or click Advanced.

b. Tap or click Proceed to [IP Address], where [IP Address] is the IP Address of the SCTcomputer. The Metasys UI Offline login screen appears.

• For Windows® Internet Explorer® 11 and Microsoft Edge: Tap or click Continue to this website(not recommended). The Metasys UI Offline login screen appears.

• For Apple® Safari® 10 or later: Tap or click Continue in the Cannot Verify Server Identity window.The Metasys UI Offline login screen appears.

Note: The Metasys UI Offline does not support autofill functionality for the user name orpassword fields.

We strongly recommend installing a trusted security certificate. For more information aboutsecurity certificate implementation for the Metasys UI Offline, see refer to the SCT Installation andUpgrade Instructions (LIT-12012067).


Features of the Metasys UI Offline

The Metasys UI Offline has the following features:

Navigating by Spaces:

Validates the spaces configuration. Spaces help you organize the information displayed forthe Metasys system into physical locations (a campus and buildings) and areas within thoselocations (floors, zones, and rooms).

Navigating by Building Network:

The Building Network provides access to all objects using an alternative navigation treeto the Spaces tree. The Building Network organizes objects according to the Metasyscomponent hierarchy, similar to the All Items tree in the Site Management Portal. TheBuilding Network supports a Focus view, Summary view, Network view, and Trend view.Object listed in the Building Network tree are identified by name and by icon and includesGlobal Status indicators.

Viewing a Site by Dashboards:

Validates the spaces and equipment configuration. The Space dashboard provides acohesive summary of the selected space, including the equipment that serves the space.The Equipment dashboard provides a cohesive summary of a selected piece of equipment.

Searching by Space and Equipment:

Search looks for the exact string that is contained in the space or equipment name. Forexample, if you search floor, the results include any space or equipment with the word floorcontained in the name of any given space. Or, if you search fan, the results include anyequipment with the word fan. You can also search words and phrases with varying case andobtain the same search results.

Viewing Point Information:

View a point's fully qualified reference (FQR).

Creating and Managing Graphics:

Use the Graphics Manager and Graphics Editor to create and manage graphics and theirassociations for the Metasys UI graphics. You can import and export Custom Symbolsinto the Graphics Library with the new Custom Symbols Library. Custom Symbol Librariesintegrate seamlessly with the base graphics package. With the Graphics Manager, youcan also manage associations for supported legacy graphics. When the graphics areassociated with a space, equipment, or equipment definition, you can view the graphicson the associated Equipment dashboard or Space dashboard. You can bind graphics toan equipment definition with the Graphics Association Manager for Aliased Graphicsfeature, so that all equipment associated with that definition will be assigned the graphicautomatically. You can also bind Network Tree items to graphics with the Building NetworkTree binding option in the Graphics Editor. The binding tree is context-sensitive, whichensures that the binding tree opens to the appropriate space or equipment when the userlaunches the Graphics Editor from a particular space or equipment. Lastly, you can edit anexisting path that was drawn with the drawing tool with the Path Tool editing feature.


Viewing Legacy Graphics+ Graphics and Standard Graphics:

View graphics associated with a space or a piece of equipment. Graphics can be designed toallow you to navigate to buildings, floors, and other areas, and to view building systems andcontrol processes.

Configuration

SCT and Site Archives

SCT is used for offline configuration of the Metasys system, including the Metasys UI and Metasys UIOffline. The site archives created and managed in SCT contain all the configuration for the MetasysUI and Metasys UI Offline. When you edit a site archive with the Metasys UI configuration, you mustload configuration changes created in SCT to the Site Director or the engine for settings to takeeffect. Before loading configuration changes to the Site Director or the network engine, validateyour changes by accessing the site archive in the Metasys UI Offline.The key features and functions that SCT provides for the Metasys UI and Metasys UI Offline includethe following:• Create space objects, equipment objects, and equipment definition objects using the Facility

menu options.

• Manage multiple site archives in one local instance of SCT.

• Access a single archive with multiple users at once, enabling simultaneous updates. However,keep in mind that simultaneous archive updates exhibit a last user wins behavior.

• Associate Graphics+ graphics and Standard graphics to space objects, equipment objects, andfield controllers to view in the Metasys UI and Metasys UI Offline.

• Upgrade the site archives to SCT version 13.0, so you can access the archives in the MetasysUI Offline and validate the spaces and equipment configuration, in addition to the graphicsassociations.

User Authorization in the Metasys UI

Metasys system administrators can set user authorization for spaces in the Metasys UI. The userauthorization is not the same authorization or permissions granted in the Site Management Portal(SMP) or in the SCT. The user authorization set in the Metasys UI is not available in, and does notaffect, the Metasys UI Offline.Metasys system administrators can set user authorization for other users by selecting the UserAuthorization option in the User Menu in the Metasys UI. The following table describes the threeauthorization options available per space.Table 2: User Authorization Options

Option DescriptionAllow Allow access to the space dashboard, the equipment dashboard of the

equipment directly serving the space, and any associated alarms, schedules,and graphics for the space.

Deny Deny access to the space dashboard, the equipment dashboard of theequipment directly serving the space, and any associated alarms, schedules,and graphics for the space.

Inherit Inherit authorization from the parent space.

User authorization information is contained in the Spaces Authorization database.


For more information about user authorization, refer to the User Authorization section in Metasys®UI Help (LIT-12011953).

Repositories

Important: The ADS Repository attribute in the engine or server determines where the devicesends historical information. The Default ADS Repository attribute in the Site object defineswhere historical data is stored. By default, these repository attributes are blank. Be sureto enter the address or name of your repository device (typically the Site Director) in theseattributes to ensure that you do not lose historical data. For the Site Director itself, leave theADS Repository attribute blank if the Site Director also serves as the repository. The DefaultADS Repository attribute defines the location of the ADS repository for all devices on thesite that do not have the ADS Repository attribute defined on their own. The ADS Repositoryattribute, once defined on an NAE, overwrites the Default ADS Repository attribute of the sitefor that NAE.

A repository provides long-term storage for historical data. Typically, the ADS/ADX configured asthe Site Director also provides the individual repositories for trend data, event messages, auditmessages, annotations, reporting, and spaces authorization data. Individual repositories mayreside in the SQL Server database. For a split ADX, the repositories are on the database serverwhere the SQL Server software is installed. You can install a split ADX where the database servercomputer stores all historical data.

Note: The ADS-Lite cannot be a Site Director for other ADS or ADX servers.

The following table lists the ADS/ADX repositories, the corresponding online Metasys® SMP Help(LIT-1201793) or Metasys UI Help (LIT-12011953) topic, and the corresponding file name. The nextsections describe the repositories in more detail and suggest ways to optimize the repositories.Table 3: ADS/ADX Repositories

Repository Refer To Database File Name on theADS/ADX Computer

Trends Trend Extensions in the Metasys®SMP Help (LIT-1201793)

JCIHistorianDB

Audits Audit Trail in the Metasys® SMP Help(LIT-1201793)

JCIAuditTrails

Events Alarm and Event Managementin the Metasys® SMP Help(LIT-1201793)

JCIEvents

AnnotationNote: Metasys UI doesnot use this database.

Object Message Annotations in theMetasys® SMP Help (LIT-1201793)

JCIItemAnnotation

Reporting Advanced Reporting in theMetasys® SMP Help (LIT-1201793)

MetasysReporting

Metasys UI Reporting Reporting: Trend Widget andCustom Trend Viewer in theMetasys® UI Help (LIT-12011953)

JCIReportingDB

Spaces Authorization User Authorization and DashboardManager in the Metasys® UI Help(LIT-12011953).

SpacesAuthorization


Metasys UI Uses for Repositories

The following table lists the corresponding features of the Metasys UI that use the repositorydatabases.Table 4: Metasys UI Uses for Repositories

Repository Metasys UI Feature DatabaseTrends Reporting data that displays in the

Trend widget and the Custom Trendviewer; syncs with the JCIReportingDBrepository at installation and then oncein every 24-hour period

JCIHistorianDB

Audits Audit data for user and systemcommands and user annotationson commands that display in theEquipment Activity widget.

JCIAuditTrails

Events Alarm data, event messageannotations, and user annotationson alarm events that display in theEquipment Activity widget, Alarm Panel,Alarm Manager, and Alarm Monitor

JCIEvents

Reporting Reporting data that displays in theTrend widget and Custom Trend viewer

JCIReportingDB

Spaces Authorization User permissions data for Spaces andCustom Dashboard settings

SpacesAuthorization

At installation time, the JCIHistorianDB synchronizes with the JCIReportingDB. This initialsynchronization can take several hours. The average synchronization takes an hour per 5 to 10 GB.While the synchronization takes place, the Metasys UI Trend widget is available, but the historicaltrend data may not appear until the synchronization is complete.The Metasys UI does not support annotations on objects, such as an engine, controller, or points.

Trend Repository Database

Trend Repository Overview

The Trend repository database resides on the ADS/ADX within the SQL Server software database.The installation program places the Trend repository on the same computer where the ADXsoftware resides. The default directory location is C:\ProgramData\Johnson Controls\MetasysIII\SQLData (pre-Release 8.0) or C:\Program Files\Microsoft SQL Server\MSSQL<version>.MSSQLSERVER\MSSQL\DATA (Release 8.0 or later). For a split ADX, the directory location is on the database serveron the same drive where the SQL Server software is installed. If you want to change where thedatabases are loaded (for example, E:\MyDatabases), you need to do so before you install the ADS/ADX software. For details, refer to the Metasys® Server Installation and Upgrade Instructions Wizard(LIT-12012162) or the Metasys Server Lite Installation and Upgrade Instructions (LIT-12012258).The ADS/ADX performance degrades as the number of Trend samples coming in to the ADS/ADXTrend repository increases. In addition, the frequency of the trend samples to be stored in theTrend repository increases, depending on the hardware resources used for the ADS/ADX computer.

Trend Repository Optimization

Optimize the required storage size of the ADS/ADX Trend repository using the following methods:


• configure larger sample intervals for individual trends

• determine which trends to store long-term and transfer only these samples

• configure the trends of non-critical objects to sample on large Change-of-Value (COV) incrementsIn addition, optimize the network communication performance for transferring trend samples fromNAE/NCE or NIE devices to the ADS/ADX repository using the following methods:• configure the Transfer Setpoint on individual trends so they transfer their samples at intervals

different from other trends

• use the ADS Delivery Time of the Network Automation Engine (NAE)/Network Control Engine(NCE) or Network Integration Engine device to transfer the samples at the time when user accessto the system is minimal

Refer to the Trend Extensions topic in the Metasys® SMP Help (LIT-1201793) for more information.

Audit Repository Database

Audit Repository Database Overview

The Audit Repository resides on the ADS/ADX within the SQL Server software database.The installation program places the Audit repository on the same computer where the ADXsoftware resides. The default directory location is C:\ProgramData\Johnson Controls\MetasysIII\SQLData (pre-Release 8.0) or C:\Program Files\Microsoft SQL Server\MSSQL<version>.MSSQLSERVER\MSSQL\DATA (Release 8.0 or later). For a split ADX, the directory location is on the database servercomputer on the same drive where the SQL Server software is installed. If you want to changewhere the databases are loaded (for example, E:\MyDatabases), you need to do so before you installthe ADS/ADX software. For details, refer to the Metasys® Server Installation and Upgrade InstructionsWizard (LIT-12012162) or the Metasys Server Lite Installation and Upgrade Instructions (LIT-12012258).The ADS/ADX performance degrades as the number of audit samples coming in to the ADS/ADXAudit repository increases. In addition, the frequency of the audit samples to be stored in the Auditrepository increases, depending on the hardware resources used for the ADS/ADX computer.

Audit Repository Optimization

Optimize the required storage size of the ADS/ADX Audit repository by specifying the Audit level (1through 4) for the audit messages that need to be reported and archived.In addition, optimize the network communication performance for transferring audit messagesfrom NAE/NCE or NIE devices to the ADS/ADX Event repository by optimizing the Audit repositorysize in the device object of each NAE/NCE or NIE.Audit Level 1 provides the minimum information. Audit Level 4 provides the most information.Audit Level 2 is the default setting. Refer to the Audit Trail topic in the Metasys® SMP Help(LIT-1201793) for more information.

Event Repository Optimization

Event Repository Overview

The Event repository resides on the ADS/ADX within the SQL Server software database. You mayview and acknowledge ADS/ADX alarms and events in the event repository. The newest and highestpriority alarm or event that requires acknowledgment appears in the Alarms window. Use theEvent Viewer to see all the events in a device repository. When the device repository receives anacknowledgment either from the user interface or through a web service, the original source deviceof the alarm is notified.


The installation program places the Event repository on the same computer where the ADXsoftware resides. The default directory location is C:\ProgramData\Johnson Controls\MetasysIII\SQLData (pre-Release 8.0) or C:\Program Files\Microsoft SQL Server\MSSQL<version>.MSSQLSERVER\MSSQL\DATA (Release 8.0 or later). For a split ADX, the directory location is on the database servercomputer on the same drive where the SQL Server software is installed. If you want to changewhere the databases are loaded (for example, E:\MyDatabases), you need to do so before youinstall the ADS/ADX software. For details, refer to the Metasys® Server Installation and UpgradeInstructions Wizard (LIT-12012162) or the Metasys Server Lite Installation and Upgrade Instructions(LIT-12012258)The ADS/ADX performance degrades as the number of event samples coming into the ADS/ADXEvent repository increases. In addition, the frequency of the event samples to be stored in the Eventrepository increases, depending on the hardware resources used for the ADS/ADX computer.

Event Repository Optimization

Optimize the required storage size of the ADS/ADX Event repository by only defining intrinsicalarming, Event Enrollment objects, or alarm extensions for point objects for which event messagesneed to be processed and archived.In addition, optimize the network communication performance for transferring event messagesfrom NAE/NCE or NIE devices to the ADS/ADX Event repository by optimizing the Alarm repositorysize in the device object of each NAE/NCE or NIE.Refer to the Alarm and Event Management section in the Metasys® SMP Help (LIT-1201793) for moreinformation.

Metasys UI Reporting Repository Database

Metasys UI Reporting Repository Database Overview

The JCIReporting database for Metasys UI is used for the custom trend viewer and resides on theADS/ADX within the SQL Server Software database. The folder location of the database files thatstore trend data is selected during the Metasys server installation. The default directory locationis C:\Program Files\Microsoft SQL Server\MSSQL<version>.MSSQLSERVER\MSSQL\DATA (Release 8.0 orlater).

Note: The installation program places the Metasys UI Reporting repository on the samecomputer where the ADX software resides. For a split ADX, the directory location is on thedatabase server on the same drive where the SQL Server software is installed. If you wantto change where the databases are loaded (for example, E:\MyDatabases), you need to doso before you install the ADS/ADX software. For details, refer to the Custom Locations forMetasys Server Application and Databases section in the Metasys® Server Installation and UpgradeInstructions Wizard (LIT-12012162).

Metasys UI Reporting Repository Database Optimization

Optimize your JCIReporting repository database by following the optimization options in TrendRepository Optimization.

Spaces Authorization Repository Database

Spaces Authorization Repository Database Overview

The Spaces Authorization Repository resides within the SQL Server software database. Thefolder location of the database files that store authorization data is selected during the Metasysserver installation. The default directory location is C:\Program Files\Microsoft SQL Server\MSSQL<version>.MSSQLSERVER\MSSQL\DATA (Release 8.0 or later).


Note: The installation program places the Spaces Authorization repository on the samecomputer where the ADX software resides. For a split ADX, the directory location is on thedatabase server on the same drive where the SQL Server software is installed. If you wantto change where the databases are loaded (for example, E:\MyDatabases), you need to doso before you install the ADS/ADX software. For details, refer to the Custom Locations forMetasys Server Application and Databases section in the Metasys® Server Installation andUpgrade Instructions Wizard (LIT-12012162).

Data Usage

When you first navigate to the Metasys UI, the Metasys UI consumes approximately 3.8 MB ofbandwidth. The following table shows typical data consumption for one user on a site.Table 5: Metasys UI Bandwidth Consumption

Initial page navigation once logged into the Metasys UI: 3.8 MBSubsequent page navigation after the Metasys UI is cached:Space dashboard Approximately 275 KBEquipment dashboard Approximately 326 KBPer minute dataconsumption

Approximately 30–200 KB

Detailed Procedures

Adding the Metasys UI Site as a Bookmark in Launcher

To add the Metasys UI as a bookmark profile:1. Open the Launcher.

2. On the Launcher screen, click Add, then click the Bookmark tab. The Add New Screen appears.

3. Type a description for the profile. For example, you could specify My Metasys UI in this field.

4. Type the URL for the profile. For example, https://localhost/UI if you are creating the bookmarkon the ADS/ADX or ADS-Lite computer. Or, https://[hostname]/UI, where [host name] is the hostname, server name, or IP Address of the ADS/ADX or ADS-Lite computer.

5. Select Create Shortcut to create a shortcut icon on your desktop.

6. Click Save. The new profile is saved, and the Launcher main screen appears with the newprofile shown under the Bookmark tab. If you clicked Create Shortcut, a shortcut labeled withthe Description you entered is created on the computer desktop.

Adding the Metasys UI Offline Site as a Bookmark in Launcher

To add the Metasys UI Offline as a bookmark profile:1. Open the Launcher.

2. On the Launcher screen, click Add, then click the Bookmark tab. The Add New Screen appears.

3. Type a description for the profile. For example, you could specify My Metasys UI Offline in this


field.

4. Type the URL for the profile. For example, https://localhost/UIOffline if you are creating thebookmark on the SCT computer. Or, https://[host name]/UIOffline, where [host name] is the hostname, server name, or IP Address of the SCT computer.

5. Select Create Shortcut to create a shortcut icon on your desktop.

6. Click Save. The new profile is saved, and the Launcher main screen appears with the newprofile shown under the Bookmark tab. If you clicked Create Shortcut, a shortcut labeled withthe Description you entered is created on the computer desktop.

Graphics Association

The following table lists the types of graphics you can associate with the types of objects. In SCT,you can associate graphics to a space object, equipment object, and field controller.Table 6: Graphics Association by Type

Object Type Standard Graphic Using SCT Graphics+ Graphic Using SCTSpace Object Yes YesEquipment Object Yes YesField Controller Yes Yes

You can associate multiple graphics of the same type or of varying types to each object or fieldcontroller. If an object has multiple graphics associated with it, a count of the number of thegraphics appears in the Graphics widget.

Note: Do not place graphics in the Facility Graphics folder or folders nested within it in the AllItems tree. Graphics saved in this folder are Metasys UI graphics saved by the system that youshould not edit in SCT. Equipment and graphics are not viewable in SMP, therefore, the FacilityGraphics folder is not displayed in SMP.

Figure 1: Facility Graphics Folders

At Metasys UI Release 2.1 and later, graphics associations can be managed in the Graphics Managerof the Metasys UI and Metasys UI Offline. For more information, refer to the Metasys® UI Online Help(LIT-12011953), or Metasys® UI Offline Help (LIT-12012116).


Associating Graphics+ Graphics

Note: In Metasys® UI 2.1 and later, you can associate Graphics+ graphics to spaces orequipment in the Graphics Manager of the Metasys UI or Metasys UI Offline. You can alsoassociate Metasys UI graphics to spaces, equipment, or Equipment Definitions. For moreinformation, refer to Metasys® UI Help (LIT-12011953) or Metasys® UI Offline Help (LIT-12012116).

Associating Graphics+ Graphics to a Space Object

The following steps presume that you are logged into SCT and your archive has spaces, equipment,Equipment Definitions, and Graphics+ graphics configured for the site. For more information aboutGraphics+ graphics, refer to the Graphic Generation Tool Help (LIT-12011697).Any graphics associations performed in SCT require a download to the ADS/ADX to view thegraphics in the Metasys UI. A download is not required to view the graphics in the Metasys UIOffline.To associate a Graphics+ graphic to a Space object in SCT:1. Select the Space object in the Spaces tree.

2. In the Configuration tab of the Space object, click Edit.

3. Select the Graphics+ graphic from the All Items tree. Drag the Graphics+ graphic to the Graphicattribute field.

Note: You can have several graphics associated to a Space object.

4. Click Save.

Associating a Graphics+ Graphic to an Equipment Object

The following steps presume that you are logged into SCT and your archive has spaces, equipment,Equipment Definitions, and Graphics+ graphics configured for the site. For more information aboutGraphics+ graphics, refer to the Graphic Generation Tool Help (LIT-12011697).Any graphics associations performed in SCT require a download to the ADS/ADX to view thegraphics in the Metasys UI. A download is not required to view the graphics in the Metasys UIOffline.To associate a Graphics+ graphic to an Equipment object in SCT:1. Select the Equipment object in the Equipment tree.

2. In the Configuration tab of the Equipment object, click Edit.


Note: You can have several graphics associated to an Equipment object.

4. Click Save.

Associating a Graphics+ Graphic to a Field Controller

The following steps presume that you are logged into SCT and your archive has spaces, equipment,Equipment Definitions, and Graphics+ graphics configured for the site. For more information aboutGraphics+ graphics, refer to the Graphic Generation Tool Help (LIT-12011697).Any graphics associations performed in SCT require a download to the ADS/ADX (and the engine,if changes were made to the engine) to view the graphics in the Metasys UI. A download is notrequired to view the graphics in the Metasys UI Offline.


To associate a Graphics+ graphic to field controller in SCT:1. Select the field controller from the All Items tree.

2. In the Configuration tab of the field controller, click Edit.


Note: You can have several graphics associated to a field controller.

4. Click Save.

Associating Standard Graphics

Note: In Metasys® UI 2.1 and later, you can associate Standard graphics to spaces orequipment in the Graphics Manager of the Metasys UI or Metasys UI Offline. You can alsoassociate Metasys UI graphics to spaces, equipment, or Equipment Definitions. For moreinformation, refer to Metasys® UI Help (LIT-12011953) or Metasys® UI Offline Help (LIT-12012116).

Associating a Standard Graphic to a Space Object

The following steps presume that you are logged into SCT and your archive has spaces, equipment,Equipment Definitions, and Standard graphics configured for the site. For more information aboutstandard graphics, refer to the Metasys® SCT Help (LIT-12011964).Any graphics associations performed in SCT require a download to the ADS/ADX to view thegraphics in the Metasys UI. A download is not required to view the graphics in the Metasys UIOffline.To associate a Standard graphic to a Space object in SCT:1. Select the Space object in the Spaces tree.

2. In the Configuration tab of the Space object, click Edit.

3. Select the Standard graphic from the All Items tree. Drag the Standard graphic to the Graphicattribute field.

Note: You can have several graphics associated to a Space object.

4. Click Save.

Associating a Standard Graphic to an Equipment Object

The following steps presume that you are logged into SCT and your archive has spaces, equipment,Equipment Definitions, and standard graphics configured for the site. For more information aboutStandard graphics, refer to the Metasys® SCT Help (LIT-12011964).Any graphics associations performed in SCT require a download to the ADS/ADX to view thegraphics in the Metasys UI. A download is not required to view the graphics in the Metasys UIOffline.To associate a Standard graphic to an Equipment object in SCT:1. Select the Equipment object in the Equipment tree.

2. If graphics are not already associated to device objects, then go to the Configuration tab of theEquipment object and click Edit.

3. Select the Standard graphic from the All Items tree. Drag the Standard graphic to the Graphicattribute field.


Note: You can have several graphics associated to an Equipment object.

4. Click Save.

Associating a Standard Graphic to a Field Controller

The following steps presume that you are logged into SCT and your archive has spaces, equipment,Equipment Definitions, and Standard graphics configured for the site. For more information aboutstandard graphics, refer to the Metasys® SCT Help (LIT-12011964).Any graphics associations performed in SCT require a download to the ADS/ADX (and the engine,if changes were made to the engine) to view the graphics in the Metasys UI. A download is notrequired to view the graphics in the Metasys UI Offline.To associate a Standard graphic to field controller in SCT:1. Select the field controller from the All Items tree.

2. In the Configuration tab of the field controller, click Edit.

3. Select the standard graphic from the All Items tree. Drag the standard graphic to the Graphicattribute field.

Notes:- Only one Standard graphic or Graphics+ graphic can be associated to a field

controller.

- If a graphic is associated to a field controller, you do not need to associate thegraphics to equipment that was derived from the controller.

4. Click Save.

Working with Metasys System Preferences

The Metasys UI uses settings from the Metasys system preferences. The following table lists thecomponents that use the Metasys system preferences.Table 7: Metasys System Preferences Used by the Metasys UI

Metasys UI Component Metasys System Preference SettingStatus Colors, State Colors, andFlash Settings

Graphic Settings tab

New Alarm Indicator

Alarm Panel, Alarm Monitor, andAlarm Manger

Display Settings > View Settings

Alarm Icon based on AlarmPriority

Equipment Activity widget, AlarmPanel, Alarm Monitor, and AlarmManger

Alarm Settings tab

Alarm Sound

Alarm Manager and AlarmMonitor

Alarm Settings tab


Table 7: Metasys System Preferences Used by the Metasys UI

Metasys UI Component Metasys System Preference SettingAudible Alarm Not a Metasys system preference setting. This is a setting for a

user.

Tools > Administrator, then right-click on the user and selectProperties > User Profile > Enable Audible Alarm

Trend Chart Line Color and LineMarkers

Trend Widget and Custom TrendViewer

Trend Settings > Chart Color and Marker Preferences

Annotations Annotations tabBuilding Network Metasys administrators automatically have access to the

Building Network tree.

To allow others users access to the Building Network tree,while in SMP:

Click User Properties, check the User Can View the ItemNavigation Tree (Default Tree) box.

Changing the Status Color, State Colors, and Flash Settings

1. In SMP, go to Tools > Configure Preferences.

2. Select the Graphics tab.

3. Change the settings as desired. Use Table 8 as a reference for your changes.Note: Status colors, state colors, flash settings, and animations appear in the Metasys UIonly. These settings do not appear in the Metasys UI Offline site because real data valuesare not available when offline.

Table 8: Graphics Attribute Settings

Graphics Attribute AffectsStatus Colors The Status Colors affect the status bars and value colors for points

in various widgets. The Status Colors also apply to value boxes, basicshapes (circle, triangle, and square), and the Room Status symbolused in standard graphics and Graphics+ graphics.

Fan Status The Fan Status colors allow you to customize the fan status color ofthe attribute that appears in system graphics. The Fan Status colorsapply only to fans.• The Stopped Color defines the background color used for a fan

symbol when its bound object's value indicates the fan is stopped.Stopped is defined as State 0 (for binary and multistate objects) oras zero (for analog object).

• The Running Color defines the background color used for a fansymbol when its bound object's value indicates the fan is running.Running is defined as State 1+ (for binary and multistate objects) oras non-zero (for analog object).


Table 8: Graphics Attribute Settings

Graphics Attribute AffectsDefault State Colors The Default State Colors affect the status bars and value colors for

points in various widgets. The Default State Colors settings allowyou to customize the default state color of the attribute that appearsin system graphics. The Default State Colors apply to basic shapes(circle, triangle, square) that are bound to a binary or multistateobject. These default state colors can be changed for each shapeafter it is added to a graphic.

Simple Symbol FlashSettings

The Simple Symbols Flash Settings affect the flash animation ofsymbols in the Graphics widget. Defines the type of flashing appliedto basic shape symbols:• Disabled (No Flashing)• State Color/Alarm Color (Flashes between the State Color and

Alarm Color)• State Color/Alternate Color (Flashes between the State Color and

the Alternate Color)The default value is 0: Disabled (No Flashing)

4. Click OK.

Changing the New Alarm Indicator Setting


2. Select the Display tab.

3. Change the New entry timeframe attribute to the desired setting. The default setting is 15minutes.The New entry timeframe is the amount of time alarms are considered new (based on theirtime of occurrence in the Metasys system). The default value is 15 minutes. New alarms aremarked with a blue star.

4. Click OK.

Changing the Alarm Sound Interval, Alarm Sound, and Alarm Priorities


2. Select the Alarm Settings tab.

3. Change the settings as desired. Use Table 9 as a reference for your changes.Table 9: Alarm Attribute Settings

Alarm Attribute AffectsAlarm Sound Interval Sets the audible alarm beeping time delay in seconds.Use default system beep Specifies whether the system uses sound files with the four

level alarming feature or the system uses the default systembeep.


Table 9: Alarm Attribute Settings

Alarm Attribute AffectsPriority Indicates the range of priorities of each priority level. The

number of priorities is adjustable, but in each case, the firstpriority begins at 0 and the next range begins one numberhigher than where the previous range stopped, up to 255.

For example, the following describes the priority ranges if youhad four priority levels:• The Level 1 range starts at priority 0 and ends at the

number configured here. The default Level 1 range is 0–39.• The Level 2 range starts at priority Level 1 + 1 (39 + 1 = 40)

and ends at the number configured here. The default Level2 range is 40–79.

• The Level 3 range starts at priority Level 2 + 1 (79 + 1 = 80)and ends at the number configured here. The default Level3 range is 80–139.

• The Level 4 range starts at priority Level 3 + 1 (139 + 1 =140) and ends at the number configured here. The defaultLevel 4 range is 140–255.

Audio FileNote: The sound files ona device are only used bythe Metasys UI when youare directly logged in tothat device. If a sound fileis missing from the device,the Metasys system uses thedefault system beep in itsplace.

Indicates the sound file that plays for each priority level whenan alarm comes in. The default files for levels 1 through 4are alarm1.wav, alarm2.wav, alarm3.wav, and alarm4.wav,respectively. Refer to the ADS/ADX Commissioning Guide(LIT-1201645) for more information configured on .mp4 filesfor use with Metasys UI and Internet Explorer 11.

Color Allows you to customize the background color and text colorfor each priority level. The color you specify here appears inthe alarms window and in the event viewer in SMP.

4. Click OK.

Changing the Trend Line Color and Markers


2. Select the Trend Settings tab.

3. Change the Chart Color and Marker Preferences settings to the desired settings.

4. Click OK.

Adding and Managing Annotation Text

Add annotation text to alarm events in the Metasys UI. The following procedure is an alternativemethod.1. In SMP, go to Tools > Configure Preferences.


2. Select the Annotation Settings tab.

3. Click in the Annotation Text field and enter a new annotation to be added to the list ofpredefined annotations. The text can be from 1 to 255 characters in length. Click Add.Predefined annotations can be edited or deleted. To edit or delete a predefined annotation,click the annotation in the Predefined Annotation List.

4. Click OK.

Troubleshooting

Table 10: Troubleshooting

Error or error message Description with resolutionAfter installing Metasys UI orMetasys UI Offline, you receivethe following error whenbrowsing to the site:

HTTP Error 500.21 –Internal Server Error.

Handler“ExtensionlessUrlHandler-Integrated-4.0″has a bad module“ManagedPipelineHandler”in its module list.

The ASP.NET component experiences a registration issue. Thisissue occurs when the ASP.NET component installs before theInternet Information Services (IIS) component is installed andconfigured appropriately.

To resolve this issue:• Windows 10, Windows 8.1, Windows Server 2012 R2, and

Windows Server 2012:a. Right-click Windows PowerShell and select Run as

Administrator.

b. Enter the following line: Install-WindowsFeature Web-Asp-Net45.

c. Press Enter.• Windows 7 (64-bit) and Windows Server 2008 R2 (64-bit):

a. Right-click Command Prompt and select Run asAdministrator.

b. Enter the following line: C:\Windows\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis.exe -i.

Note: Ensure you include the -i at the end of thecommand line.

c. Press Enter.For more information about this solution, go tohttps://msdn.microsoft.com/en-us/library/k6h9cz8h%28v=vs.140%29.aspx.

If this solution does not resolve the error, see the followingsolution.


https://msdn.microsoft.com/en-us/library/k6h9cz8h%28v=vs.140%29.aspx

https://msdn.microsoft.com/en-us/library/k6h9cz8h%28v=vs.140%29.aspx


Error or error message Description with resolutionThe UI_AppPool or the UIOffline_AppPool's Managed PipelineMode is set to Classic instead of Integrated.

To change the Managed Pipeline Mode setting:1. On the ADS/ADX or ADS-Lite where Metasys UI is installed,

go to Start > Control Panel > Administrative Tools anddouble-click Internet Information Services (IIS).

2. In the Connections pane, expand Default Web Site andselect UI or UIOffline.

3. In the Actions pane, click Basic Settings.

4. The Edit Applications window appears. Verify that theApplication pool field is set to UI_AppPool. Click OK.

5. In the Connections pane, select Application Pools.

6. In the Application Pools, select UI_AppPool orUIOffline_AppPool.

7. In the Actions pane under Edit Application Pool, click BasicSettings.

8. The Basic Settings window appears. In the Managedpipeline mode field, change the mode from Classic toIntegrated.

9. Click OK.For more information about managing Request-Processing forApplication Pools, go to https://technet.microsoft.com/en-us/library/cc725564(v=ws.10).aspx.


https://technet.microsoft.com/en-us/library/cc725564(v=ws.10).aspx

https://technet.microsoft.com/en-us/library/cc725564(v=ws.10).aspx


Error or error message Description with resolutionAn issue requires an applicationpool recycle.

Please refresh yourbrowser to check ifMetasys is available.

The following are examples of issues that may require anapplication pool recycle:• When a user is logged into SCT or Metasys UI Offline

for long periods of time with no session expiration, theMetasys UI Offline becomes unresponsive and displays anUnexpected Error message. To resolve this issue, recycle theUIOffline_AppPool and the MSEA_SCT_AppPool.

• When you work with Custom Symbols, after you importthe Custom Symbols pack, refresh the browser (Ctrl + F5)and refresh the Internet Information Services (IIS) Managerto resolve potential dictionary issues, and to ensure thatanimation and Custom Behavior work properly.

• Recycle the UI_AppPool to see new schedules added in SMP,schedules deleted from SMP, or new schedules from recentlyadded engines on SMP.

• Recycle the UI_AppPool when a Trend report is missing theTrend chart image.

Important: When you recycle a Metasys UI or Metasys UIOffline application pool, all users logged into the site arelogged out. When you recycle the Metasys UI applicationpool, users may lose work, such as adding exceptions orediting schedules in the Schedules widget. Use cautionwhen recycling the application pool.

To recycle the Metasys UI application pool:1. On the server where the Metasys UI software is installed, go

to Control Panel > Administrative Tools.

2. Double-click Internet Information Services (IIS) Manager.

3. In the Connection pane, select the server and clickApplication Pools.

4. On the Application Pools page, select the UI_AppPool.

5. In the Actions pane, click Recycle and click Yes.To recycle the Metasys UI Offline application pool:1. On the server or SCT computer where the Metasys UI Offline

software is installed, go to Control Panel > AdministrativeTools.



4. On the Application Pools page, select theUIOffline_AppPool.

5. In the Actions pane, click Recycle and click Yes.



Error or error message Description with resolutionTo recycle the SCT application pool:1. On the server or SCT computer where the Metasys UI Offline

software is installed, go to Control Panel > AdministrativeTools.



4. On the Application Pools page, select theMSEA_SCT_AppPool.

5. In the Actions pane, click Recycle and click Yes.

When attempting to view anAliased graphic, which is agraphic associated with anEquipment Definition, in theMetasys UI Graphics Manager,the Graphics List displays aDevice Offline error and thepreview of the graphic does notload.

This issue occurs when an offline device has points in theassociated Equipment Definition.To resolve this issue, ensure all devices associated with theEquipment Definition are online.To workaround this issue, create and edit Aliased graphics in theMetasys UI Offline.

In the Graphics widget,Graphics+ graphics do notdisplay the default bindingsin the Room Control Module(RCM).

This issue occurs because the Site Management Portal (SMP)handles the RCM data differently than the Metasys UI.

To resolve this issue:1. Open the Graphics+ graphics on the Graphic Generation

Tool (GGT).

2. Edit the bindings of the RCM. When you edit the bindings,you can simply delete and reenter the same binding data.

3. Save the Graphics+ graphics to the Metasys host.When you subsequently view the Graphics+ graphic in theGraphics widget, the RCM data should populate appropriately.

If adding data to the historiandatabase using MetasysDatabase Manager whilethe Metasys UI is running,the averaged data is notcalculated accurately. Thereporting database used by theMetasys UI does not sync fordata injected in this manner,therefore, the averaged datacalculations may be inaccurate.

Do not add data to the historian database using MetasysDatabase Manager while the Metasys UI is running.

If you have already added data to the historian database in thismanner, follow the solution below:1. Contact your Johnson Controls® field support

representative to obtain scripts that resolve this issue.

2. Uninstall the ADS/ADX.

3. Clear the JCIReporting database using the scripts from Step1.

4. Reinstall the ADS/ADX.



Error or error message Description with resolutionThe Trend widget and theCustom Trend Viewer do notdisplay data for time periodslonger than 7 days.

The ads-user is not mapped to the JCIReportingDB.

To resolve this issue, follow these steps on the databasecomputer:1. In SQL Server Management Studio, connect to the database

computer.

2. In the Object Explorer, expand Databases > JCIReportingDB.

3. Expand Security > Users.

4. Right-click the ads-user and select Delete.

5. In the Object Explorer, expand Security > Logins.

6. Right-click the ads-user and select Properties.

7. In Properties, select the User Mapping page.

8. Select the JCIReportingDB and select the db_owner andpublic database role membership options.

9. Restart the UI_AppPool or restart the ADS/ADX.At installation time, the JCIHistorianDB synchronizes with theJCIReportingDB. This initial synchronization can take severalhours. The average synchronization takes an hour per 5–10 GB.While the synchronization takes place, the Metasys UI Trendwidget is available but the historical trend data may not appearuntil the synchronization is complete.

On large sites, the followingissues may be observed inMetasys UI:• You may see disconnect and

reconnect messages.• You may receive error when

commanding, commandsmay fail, or commands maytake longer than 10 secondsto send.

• You may see a Network Errormessage in the widgets.

• You may see slow load timesfor dashboards.

This issue may be related to the Site object's Offline DetectionPoll Rate attribute being set to Fast.

On large sites where offline and online alarms are not critical,set the Site object's Offline Detection Poll Rate attribute to Slowto resolve the issues.

When you upgrade a sitewithout downloading anarchive to the ADS, there areno relationships availablewhen viewing the EquipmentRelationships widget for a pieceof equipment in the BuildingNetworks tree.

To view the relationships for a piece of equipment, you mustdownload an archive to the ADS you are viewing prior to loggingin to the Metasys UI.

Note: If you do not download an archive an error messageappears when viewing the Equipment Relationships widget.



Error or error message Description with resolutionNo CSV Trend Report is created. The CSV builder has limited memory and cannot handle

generating a report for the size of data for the selected datapoints.

To generate a report, select fewer data points.The Detail widget, Commandingdialog, or other widgets donot load completely, displaypartial data, or display Null as avalue after installing the MetasysServer software and duringinitial start-up of the Metasys UI.

Allow one to two hours per 500 engines for the Online Archiveto gather and populate the attributes and other data displayedin the Building Network tree. We recommend not accessing theBuilding Network tree objects and viewing the object’s Detailwidget during the initial start-up and sync. Furthermore, do notissue Bulk Commands through the Advanced Search feature inthe Metasys UI during initial start-up and sync.

One invalid point blocks otherpoint's subscriptions.

When equipment is deleted that used to have points bound in agraphic, those point subscriptions become invalid, causing otherpoints subscriptions to be blocked. To prevent this, delete thepoint that is now invalid from the binding. Equipment can onlybe deleted offline through a download, points can be deletedonline and offline.

Command states text valuesdisplayed in Metasys UI aredifferent from command statesdisplayed in SMP.

This issue requires a Sync Engine command.The following scenarios may also require a Sync Enginecommand:• Data is modified directly from a network engine and not from

the Site Director• An extension is created online with SMP• A point discovery is executed on a live site in SMPWith the Sync Engine command you can synchronize the latestattributes and information available on a network enginewith the online archive available on the Site Director. The SyncEngine command is not the same as an Archive command or anupload performed in SCT. You can only perform a Sync Enginecommand on an engine object in the Metasys UI. The commandpushes object attribute changes to the live system. An uploadin SCT pushes object attributes (and other data) to the archivedatabase. You can view the progress of an upload in the ActionQin SCT. Once you issue a Sync Engine command, it takes placein the background, and is not monitored by ActionQ. However,a flag appears on the Site object in the SMP and Metasys UIwhen an engine sync executed by a Sync Engine command is inprogress.To issue a Sync Engine command, follow these steps:1. In the Metasys UI, select the engine object from the Building

Network tree.

2. Tap or click on the status or value in the Detail widget. TheCommand dialog appears.

3. From the Command drop-down menu, select Sync Engine.

4. Tap or click Save.



Error or error message Description with resolutionOnline points, controllers,or engines show a RemoteDevice Offline , ValueInaccessible, or ValueCannot be Read status in theBuilding Network, Priority Array,or Potential Problem Areaswidget.

Metasys UI 4.0 cannot read values from engines that are atMetasys Release 3.0 or earlier. This means that online points,engines, or controllers associated with a network engine thatis at Release 3.0 or earlier can have a status of Remote DeviceOffline , Value Inaccessible, or Value Cannot be Read .

Various upload, download,and performance issues areoccurring in the Metasys UI.

The system may have too many spaces and equipment defined.The software allows you to configure an unlimited numberof buildings within a generic parent space object, as well asfloors in a building and rooms on a floor. You can also configurespaces within rooms. However, the recommended limit is20,000 spaces. A larger number can cause upload, download,and performance issues. The same 20,000 limit applies toequipment.

The Status Summary displaysquestion marks in the onlinemode.

Status Summary points do not resolve when you bind a genericspace with no filter. For the points to resolve in the Viewer,choose at least one filter (binding), so that the Status Summarycan search for that short name in all the equipment serving thespace.

Email delivery of a ScheduledReport fails.

To resolve this issue, implement the following functionalprerequisites for report delivery:1. Set up your email server. Refer to the Metasys SMP Help

(LIT-1201793) for details.

2. Configure your email settings in SMP for ADS. Only SimpleMail Transfer Protocol (SMTP) type email settings aresupported. POP Before SMTP type email settings are notsupported for the Schedule Report feature.

3. If the file size of the generated report exceeds the emailserver limit, which is by default 20MB, the report generationis successful, but the email delivery of the Scheduled Reportmay fail.

Related Documentation

The following table lists the related documentation for the Metasys UI and Metasys UI Offline.Table 11: Related Documentation

For Information On See DocumentHow to Install the Metasys Serverand the Metasys UI (online)

Metasys® Server Installation and Upgrade Instructions Wizard(LIT-12012162)

How to Install the Metasys ServerLite

Metasys Server Lite Installation and Upgrade Instructions(LIT-12012258)


Table 11: Related Documentation

For Information On See DocumentHow to Install SCT SCT Installation and Upgrade Instructions (LIT-12012067)How to Install the GraphicGeneration Tool (GGT)

Graphic Generation Tool Installation Instructions (LIT-12011685)

Licensing Information Software Activation Manager Help (LIT-12012389)Configuring of Spaces andEquipment for the Metasys UI

Metasys® SCT Help (LIT-12011964)

Using the Metasys UI Metasys® UI Help (LIT-12011953)Using the Metasys UI Offline Metasys® UI Offline Help (LIT-12012116)Setting up Trends, Annotations,Alarm Extensions, and StandardGraphics in SMP or SCT

Metasys® SMP Help (LIT-1201793)orMetasys® SCT Help (LIT-12011964)

Creating Graphics+ Graphics Graphic Generation Tool Help (LIT-12011697)Creating Custom Symbols Metasys® UI Custom Symbols Technical Bulletin (LIT-12013054)Network and IT Best Practicesfor the Metasys system and theMetasys UI

Network and IT Guidance Technical Bulletin (LIT-12011279)

Simplex® Fire System integration NAE Commissioning for Simplex Fire System IntegrationApplication Note (LIT-12013060)

Metasys UI and Metasys UI Offline TechnicalSpecifications

The following tables list the technical specifications for the Metasys UI and Metasys UI Offline. Formore information about the ADS/ADX technical specification, refer to the Application and DataServer (ADS) and Extended Application and Data Server (ADX) Product Bulletin (LIT-1201525). For moreinformation about the ADS-Lite technical specifications, refer to the Metasys® Server Lite Installationand Upgrade Instructions Wizard (LIT-12012258). For more information about the SCT technicalspecifications, refer to the System Configuration Tool Catalog Page (LIT-1900198).Table 12: Metasys UI and Metasys UI Offline Client Technical Specifications for Phones andTablets

Supported Mobile PhoneOperating Systems

Android 5.1 or later

iOS® 10 or laterSupported TabletOperating Systems

Android 5.1 or later

iOS 10 or later


Table 13: Metasys UI and Metasys UI Offline Client Technical Specifications for Computers

Windows® 10 Pro and Windows 10 Enterprise Anniversary Update(version 1607 or later) (64-bit)

Web Browsers Supported:• Microsoft® Edge• Google® Chrome™ version 54

Windows 8.1 Pro and Windows 8.1 Enterprise with Update 1 (64-bit)

Web Browsers Supported:• Windows® Internet Explorer® 11.0.9600.18449 Update version

11.0.35 or later• Google Chrome version 54

Windows 7 Professional, Enterprise, and Ultimate Editions withSP1 (64-bit)

Web Browsers Supported:• Windows Internet Explorer 11.0.9600.18449 Update version 11.0.35

or later• Google Chrome version 54

Windows 7 Professional, Enterprise, and Ultimate Editions withSP1 (32-bit)

Web Browsers Supported:• Windows Internet Explorer 11.0.9600.18449 Update version 11.0.35

or later• Google Chrome version 54

Apple® OS X® 10.13 High Sierra

Web Browsers Supported:• Apple® Safari® 11 or later• Google Chrome version 61

Apple® OS X® 10.12 Sierra

Web Browsers Supported:• Apple Safari 11 or later• Google Chrome version 61

Supported ClientComputer OperatingSystems and WebBrowser Combinations

Apple® OS X® 10.11 El Capitan

Web Browsers Supported:• Apple Safari 11 or later• Google Chrome version 61


Table 14: Metasys UI and Metasys UI Offline Client Technical Specifications for Web Browsers

Google® Chrome™ version 61 or later

Notes:• For better performance, we recommend using Google Chrome as

your preferred web browser for the Metasys UI and the Metasys UIOffline.

• The Metasys UI and the Metasys UI Offline does not support incognitomode. To exit incognito mode, click or tap the X icon of the browserwindow or tab and then open a new browser window or tab. Formore information on incognito mode in Google Chrome, refer tohttps://support.google.com/chrome/answer/95464?hl=en.

Windows® Internet Explorer® 11.0.9600.18449 Update version 11.0.35or later, and Microsoft Edge

Notes:• In Internet Explorer 11 to ensure that websites appear and function

correctly, select the Use Microsoft compatibility lists option, foundunder Tools > Compatibility View Settings.

• The Metasys UI and the Metasys UI Offline does not support InPrivateBrowsing. To exit In Private Browsing, close the browser window andopen a new browser window.

Apple® Safari® 11 or laterNote: The Metasys UI and the Metasys UI Offline does not supportPrivate browsing. To exit Private browsing, click or tap Private inthe browser window.

Supported WebBrowsers

General Web Browser Support Information:

Notes:• Other web browsers, such as Mozilla® Firefox®, are not officially

supported by the Metasys UI and the Metasys UI Offline. However,the Metasys UI and the Metasys UI Offline may appear and functionappropriately in other web browsers that are not officially supported.

• In supported web browsers on tablets and phones, Metasys UI andMetasys UI Offline does not support the desktop view options. To exitthe desktop view and load the mobile view:

- In Chrome, deselect the Request desktop site option.- In Safari, close the browser and open the Metasys UI and the

Metasys UI Offline.• Ensure your web browser has cookies enabled before browsing to

the Metasys UI and the Metasys UI Offline.• Ensure you have the Enable DOM Storage setting selected on the

client device. For Windows operating systems, go to Internet Options> Advanced > Security and verify the Enable DOM Storage setting isselected.


https://support.google.com/chrome/answer/95464?hl=en

Table 15: Metasys UI and Metasys UI Offline Client Technical Specifications for CommunicationChannels

SupportedCommunicationChannels

For optimal performance, we recommend a wired connection forcomputers browsing to the Metasys UI and the Metasys UI Offline.

Ethernet network interface card 10/100/1000 Mbps

Wireless IEEE 802.11 connection

4G Network

Notes:• The Metasys UI and the Metasys UI Offline may run over a 3G network.

However, browsing to the Metasys UI and the Metasys UI Offline over3G is not recommended or supported.

• High latency (also called lag or wait time) can cause the Metasys UIand the Metasys UI Offline to disconnect from the ADS or ADX, or SCTcomputer.

• Signal strength impacts the overall performance of the Metasys UI andthe Metasys UI Offline. For the best results, ensure that you have astrong signal for your wireless connection.

• To avoid high latency, we recommend a network with 20mbps uploadspeed.


metasys ui technical bulletin

Documents