metasys ui technical bulletincgproducts.johnsoncontrols.com › met_pdf › 12012115.pdf4 metasys ui...

42
LIT-12012115 Release 10.1 Building Technologies & Solutions www.johnsoncontrols.com 2019-10-14 Metasys UI Technical Bulletin

Upload: others

Post on 27-Jun-2020

41 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

LIT-12012115

Release 10.1

Building Technologies & Solutions

www.johnsoncontrols.com

2019-10-14

Metasys UI Technical Bulletin

Page 2: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys
Page 3: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

ContentsContentsMetasys UI introduction................................................................................................................. 3

Summary of changes.......................................................................................................................... 3

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

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

Installing the Metasys UI.......................................................................................................... 4

Licensing Metasys UI features................................................................................................. 4

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

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

Security certificate warnings................................................................................................... 5

Features of the Metasys UI....................................................................................................... 5

Metasys UI Offline................................................................................................................................ 9

Installing the Metasys UI Offline............................................................................................ 10

Browsing to the Metasys UI Offline....................................................................................... 10

Authentication......................................................................................................................... 10

Security certificate warnings................................................................................................. 10

Features of the Metasys UI Offline........................................................................................ 10

Configuration..................................................................................................................................... 12

SCT and Site Archives............................................................................................................. 12

Space Authorization in the Metasys UI................................................................................. 13

Repositories........................................................................................................................................ 13

Metasys UI uses for repositories........................................................................................... 14

Trend Repository Database................................................................................................... 15

Audit Repository Database.................................................................................................... 15

Event Repository Optimization.............................................................................................. 16

Metasys UI Reporting Repository Database........................................................................ 17

Page 4: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Spaces Authorization Repository Database......................................................................... 17

Data usage......................................................................................................................................... 17

Detailed Procedures..................................................................................................................... 18

Adding the Metasys UI site as a bookmark in Launcher............................................................... 18

Adding the Metasys UI Offline site as a bookmark in Launcher.................................................. 18

Graphics association......................................................................................................................... 18

Associating Graphics+ Graphics............................................................................................ 19

Associating standard graphics.............................................................................................. 20

Working with Metasys System Preferences.................................................................................... 22

Changing the status color, state colors, and flash settings............................................... 23

Changing the new alarm indicator setting.......................................................................... 24

Changing the alarm sound interval, alarm sound, and alarm priorities......................... 24

Changing the trend line color and markers........................................................................ 25

Adding and managing annotation text................................................................................ 26

Troubleshooting........................................................................................................................... 27

Related documentation............................................................................................................... 35

Metasys UI and Metasys UI Offline technical specifications..................................................... 36

Software terms............................................................................................................................. 39

Product warranty.......................................................................................................................... 39

Patents........................................................................................................................................... 39

Metasys UI Technical Bulletinii

Page 5: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Metasys UI introductionThis 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 UI refersto both the online and offline sites.

Summary of changes

The following information is new or revised:

• Added Licensing Metasys UI features.

• Added references to Open Application Server (OAS).

• Updated the Features of the Metasys UI and Features of the Metasys UI Offline sections for thenew features at Release 4.1. New Metasys UI Online features include Cyber Health Dashboard,Remote Notifications (DDA), User Management, My Profile, Additional Commanding, ForcedAnnotation with preset list, and restructured User Menu.

• Updated SCT and Site Archives.

• Updated Space Authorization in the Metasys UI, as the User Authorization feature was renamedSpace Authorization.

• Updated Troubleshooting to include information about conditions under which points may notresolve in a graphic and about managing large IIS logs.

• Updated Related Documentation to include Open Application Server (OAS) documents and toinclude more information about licensing.

• Updated the Metasys UI and Metasys UI Offline technical specifications.

• Added Software terms, Product warranty, and Patents.

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.

3Metasys UI Technical Bulletin

Page 6: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

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).

Licensing Metasys UI features

We recommend that you license Metasys software immediately after installation.The Software Manager manages software licenses on a machine. For more information aboutsoftware licensing, refer to the Software Manager Help (LIT-12012389).To enable the Potential Problem Areas widget and the Scheduled Reports feature, which includesthe ability to save report templates, you require the appropriate Metasys license. If unlicensed,these features are unavailable or limited in the Metasys UI.The Potential Problem Areas feature and the Scheduled Reports feature are included in theMetasys Server license for the Application and Data Server (ADS), the ADS Lite, and the ExtendedApplication and Data Server (ADX). However, these two features are not included in the OpenApplication Server (OAS) license. To enable these features on an OAS, you require the MetasysPotential Problem Areas license and the Metasys Scheduled Reports license. The following tablesummarizes which features are included in the base product license.Table 1: Metasys UI feature licensing on ADS/ADS Lite/ADX and OASFeature Included in the ADS/ADS

Lite/ADX licenseIncluded in theOAS license

Metasys Potential Problem Areas Yes No (separatelicense required)

Metasys Scheduled Reports Yes No (separatelicense required)

For information about activating licenses, refer to the Starting a license activation section in theSoftware Manager Help (LIT-12012389).There are additional Metasys licenses that do not enable a specific Metasys UI feature, but stillapply to ADS/ADX and/or OAS. In particular, the Metasys Historical Data Add-on license enablesretention of historical data for the OAS, which affects the quantity of data available to certainMetasys UI features on an OAS. For more information about other licensable features of the MetasysServer refer to the Licensing section in the Metasys® Server Installation and Upgrade InstructionsWizard (LIT-12012162) and Open Application Server (OAS) Installation and Upgrade Instructions(LIT-12013222), respectively.

Browsing to the Metasys UI

To browse to the Metasys UI from a client computer or device in a supported web browser, go tohttps://[host name]/UI, where [host name] is the host name, server name, or IP address of theApplication and Data Server (ADS), Extended Application and Data Server (ADX), ADS-Lite computer,or Open Application Server (OAS).

Authentication

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

Metasys UI Technical Bulletin4

Page 7: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

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/ADX,OAS, or 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 User menu

Access Advanced Search & Reporting, Administrative Tasks, Help, My Profile, and Log Out inthe User menu.

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.

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. The

5Metasys UI Technical Bulletin

Page 8: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Equipment 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.

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).

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.

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 a report.

• issue bulk commands to selected points.

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

Table 2: Advanced Search and Reporting featuresFeature 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.

Metasys UI Technical Bulletin6

Page 9: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 2: Advanced Search and Reporting featuresFeature DescriptionSmart Filtering Enables launching directly from certain widgets into a pre-populated

Advanced 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.

Learning about security-related issues and system issues

Newly added at Release 10.1, the Cyber Health Dashboard provides a comprehensivesummary of system security risks, system status details, and user activity information. Thedashboard provides a Metasys Administrator with a centralized view of security-relatedissues or system issues which are detectable by a Metasys Server, but which may not surfaceas part of general system alarms. The Administrator can also see out-of-date software atone glance. The information is grouped into critical issues, potential risks, and informationalitems. The Cyber Health Dashboard is supported on desktop, tablets, and smartphones; andcan be accessed through the Administrative Tasks in the User menu.

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.

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 pointson computer platforms and tablets, and up to four points on smart phones for severalpieces of equipment configured for the Metasys UI. The Trend widget allows you to viewhistorical trend data for up to 10 points for a single piece of equipment. The Trend widgetcan also plot points from the equipment being served by the equipment you are currentlyviewing. You can view trended data points on up to three different charts at once. This helpsoperators visualize trended points of drastically different ranges.

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 if

7Metasys UI Technical Bulletin

Page 10: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

a 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.

Commanding with integrated priority array

A Commanding dialog view with integrated Priority Array identifies the current commandpriorities. This helps operators troubleshoot issues faster by making it easier for them todetermine what command priority is currently active on a point object. In addition, youcan navigate directly from the Commanding dialog to the Building Network through a link,without having to manually search the network tree after finding the root cause of an alarmor other issue. Additional commands are available at Release 10.1. For a list of all supportedcommands refer to List of objects and supported commands table in the Metasys® UI Help(LIT-12011953).

Acting on alarms

Use your computer or tablet to view and take action on Metasys system alarms with theAlarm Manager and Alarm Monitor. You can navigate directly from the Alarm Manager tothe Building Network through a link, without having to manually search the network treeafter finding the root cause of an alarm. Use your smartphone to view and take action onalarms in the Alarms list (Alarm Announcement) on your phone platform.

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. Starting at Release10.1, Administrators can also choose to enforce annotations. Moreover, users can selectannotations from a list of preset annotations, if they were configured in SMP.

Authorizing users within the Metasys UI

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

Managing users and roles within the Metasys UI

Newly added to Metasys UI at Release 10.1, the User Management feature facilitates thecreation and management of users and their roles, category-based permissions, andprivileges directly in Metasys UI Online, without the need to install software on clientmachines. Administrators can create and manage user details for Active Directory, RADIUS,and Metasys local users. This feature is also available in SMP, but over time it will be availablein Metasys UI Online only.

View user details, system privileges, and category access

Newly added to Metasys UI at Release 10.1, the My Profile feature shows the user details,system privileges, and category access for the logged-in user. The details shown in MyProfile are based on the details entered in User Management. When authorized users edittheir profile information in My Profile, their profile details are automatically updated in UserManagement.

Metasys UI Technical Bulletin8

Page 11: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Configure the routing and filtering of event and audit messages within the Metasys UI

With the Remote Notifications feature you can configure the routing and filtering ofevent and audit messages directly in the Metasys UI for each server or engine, withoutinstalling software on client machines. The Remote Notifications feature is known as theDestination Delivery Agents (DDAs) feature in SMP. Starting at Release 10.1, all ServerRemote Notifications are created and modified in Metasys UI and no longer in SMP.However, SMP management of Server DDAs is still available for MVE sites.

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 Symbols intothe Graphics Library with the Custom Symbols Library. Custom Symbol Libraries integrateseamlessly with the base graphics package. With the Graphics Manager, you can alsomanage associations for supported legacy graphics. When the graphics are associated witha space, equipment, or equipment definition, you can view the graphics on the associatedEquipment dashboard or Space dashboard. You can bind graphics to an equipmentdefinition with the Graphics Association Manager for Aliased Graphics feature, so that allequipment associated with that definition will be assigned the graphic automatically. Youcan also bind Network Tree items to graphics with the Building Network Tree binding optionin the Graphics Editor. The binding tree is context-sensitive, which ensures that the bindingtree opens to the appropriate space or equipment when the user launches the GraphicsEditor from a particular space or equipment. Lastly, you can edit an existing path that wasdrawn 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.

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.

Usage Analytics

Usage Analytics is a usage statistics feature that collects information on how buildingoperators use Metasys UI and what types of devices they use to access it. This helps improvethe Metasys experience by providing insights to Metasys developers on how operatorsnavigate and interact with Metasys software. You can enable or disable Usage Analytics inthe Metasys UI either at the site level or the user level. As an Administrator, you can enableUsage Analytics at both levels. As a Non-Administrator, you can only enable Usage Analyticsat the user level, provided that the Administrator has already enabled Usage Analytics forthe 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 and

9Metasys UI Technical Bulletin

Page 12: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

manage 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 IPaddress of 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 User menu

Access Administrative Tasks, Help, Archive, and Log Out in the User menu.

Metasys UI Technical Bulletin10

Page 13: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

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. TheEquipment 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).

Configure the routing and filtering of event and audit messages within the Metasys UI

With the Remote Notifications feature you can configure the routing and filtering ofevent and audit messages directly in the Metasys UI for each server or engine, withoutinstalling software on client machines. The Remote Notifications feature is known as theDestination Delivery Agents (DDAs) feature in SMP. Starting at Release 10.1, all ServerRemote Notifications are created and modified in Metasys UI and no longer in SMP.However, SMP management of Server DDAs is still available for MVE sites.

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 to anequipment definition with the Graphics Association Manager for Aliased Graphics feature, sothat all equipment associated with that definition will be assigned the graphic automatically.You can also bind Network Tree items to graphics with the Building Network Tree bindingoption in the Graphics Editor. The binding tree is context-sensitive, which ensures that thebinding tree opens to the appropriate space or equipment when the user launches the

11Metasys UI Technical Bulletin

Page 14: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Graphics Editor from a particular space or equipment. Lastly, you can edit an existing paththat 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 Facilitymenu 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.2, so you can access the archives in the MetasysUI Offline and validate the spaces and equipment configuration, in addition to the graphicsassociations.

Important: SCT is backward compatible with older Metasys releases, but Metasys UI Offline isnot compatible with older releases of Metasys UI. Therefore, ensure that you edit Metasys UIgraphics with a matching version of Metasys UI or Metasys UI Offline. The following table liststhe Metasys Release versions with their matching SCT/Metasys UI Release versions:

Table 3: Metasys version with matching SCT and Metasys UI versionsMetasys version SCT/Metasys UI version10.1 SCT 13.2/Metasys UI 4.110.0 SCT 13.0/Metasys UI 4.09.0 SCT 12.0/Metasys UI 3.08.1 SCT 11.1/Metasys UI 2.18.0 SCT 11.0/Metasys UI 2.07.0 SCT 10.0/Metasys UI 1.0

Metasys UI Technical Bulletin12

Page 15: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Space Authorization in the Metasys UI

Metasys system administrators can set user authorization for spaces in the Metasys UI. The spaceauthorization is not the same authorization or permissions granted in the Site Management Portal(SMP) or in the SCT. The space authorization set in the Metasys UI is not available in, and does notaffect the Metasys UI Offline.Metasys system administrators can set space authorization for other users by selecting the SpaceAuthorization option in the User Menu in the Metasys UI (Administrative Tasks). The following tabledescribes the three authorization options available per space.Table 4: Space Authorization optionsOption 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.

Space authorization information is contained in the Spaces Authorization database.For more information about space authorization, refer to the Space Authorization section inMetasys® 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 Server 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. On an OAS, the amount of historical data retained in itsrepositories (and therefore available to Metasys UI) is affected by the Metasys Historical Data Add-on license.

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

The following table lists the ADS/ADX/OAS repositories, the corresponding online Metasys® SMPHelp (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.

13Metasys UI Technical Bulletin

Page 16: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 5: ADS/ADX/OAS RepositoriesRepository Refer To Database File Name on the

ADS/ADX/OAS ComputerTrends 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 Space Authorization andDashboard Manager in theMetasys® 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 6: Metasys UI Uses for RepositoriesRepository 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

Metasys UI Technical Bulletin14

Page 17: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

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/OAS within the SQL Server softwaredatabase.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, thedirectory location is on the database server on the same drive where the SQL Server software isinstalled. If you want to change where the databases are loaded (for example, E:\MyDatabases),you need to do so before you install the ADS/ADX/OAS software. For details, refer to the Metasys®Server Installation and Upgrade Instructions Wizard (LIT-12012162) or the Metasys Server LiteInstallation and Upgrade Instructions (LIT-12012258).The ADS/ADX/OAS performance degrades as the number of Trend samples coming in to the ADS/ADX/OAS Trend repository increases. In addition, the frequency of the trend samples to be stored inthe Trend repository increases, depending on the hardware resources used for the ADS/ADX/OAScomputer.

Trend repository optimization

Optimize the required storage size of the ADS/ADX/OAS Trend repository using the followingmethods:

• 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) increments

In addition, optimize the network communication performance for transferring trend samples fromnetwork engine devices to the ADS/ADX/OAS repository using the following methods:

• configure the Transfer Setpoint on individual trends so they transfer their samples at intervalsdifferent from other trends

• use the ADS Delivery Time of the network engine device to transfer the samples at the time whenuser access to 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/OAS 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, thedirectory location is on the database server computer on the same drive where the SQL Server

15Metasys UI Technical Bulletin

Page 18: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

software is installed. If you want to change where the databases are loaded (for example, E:\MyDatabases), you need to do so before you install the ADS/ADX/OAS software. For details, referto the Metasys® Server Installation and Upgrade Instructions Wizard (LIT-12012162) or the MetasysServer Lite Installation and Upgrade Instructions (LIT-12012258).The ADS/ADX/OAS performance degrades as the number of audit samples coming in to the ADS/ADX/OAS Audit repository increases. In addition, the frequency of the audit samples to be stored inthe Audit repository increases, depending on the hardware resources used for the ADS/ADX/OAScomputer.

Audit repository optimization

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

Event Repository Optimization

Event repository overview

The Event repository resides on the ADS/ADX/OAS within the SQL Server software database. Youmay view and acknowledge ADS/ADX/OAS alarms and events in the event repository. The newestand highest priority alarm or event that requires acknowledgment appears in the Alarms window.Use the Event Viewer to see all the events in a device repository. When the device repositoryreceives an acknowledgment either from the user interface or through a web service, the originalsource device of 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, thedirectory location is on the database server computer on the same drive where the SQL Serversoftware is installed. If you want to change where the databases are loaded (for example, E:\MyDatabases), you need to do so before you install the ADS/ADX/OAS software. For details, referto the Metasys® Server Installation and Upgrade Instructions Wizard (LIT-12012162) or the MetasysServer Lite Installation and Upgrade Instructions (LIT-12012258)The ADS/ADX/OAS performance degrades as the number of event samples coming into the ADS/ADX/OAS Event repository increases. In addition, the frequency of the event samples to be storedin the Event repository increases, depending on the hardware resources used for the ADS/ADX/OAScomputer.

Event repository optimization

Optimize the required storage size of the ADS/ADX/OAS 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 network engine devices to the ADS/ADX/OAS Event repository by optimizing the Alarmrepository size in the device object of each network engine.Refer to the Alarm and Event Management section in the Metasys® SMP Help (LIT-1201793) for moreinformation.

Metasys UI Technical Bulletin16

Page 19: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

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 onthe ADS/ADX/OAS within the SQL Server Software database. The folder location of the databasefiles that store trend data is selected during the Metasys server installation. The default directorylocation is C:\Program Files\Microsoft SQL Server\MSSQL<version>.MSSQLSERVER\MSSQL\DATA (Release 8.0 or later).

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 want tochange where the databases are loaded (for example, E:\MyDatabases), you need to do sobefore you install the ADS/ADX/OAS 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. The folderlocation of the database files that store authorization data is selected during the Metasys serverinstallation. 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/OAS software. For details, refer to the Custom Locationsfor Metasys 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 7: Metasys UI Bandwidth ConsumptionInitial 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

17Metasys UI Technical Bulletin

Page 20: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Detailed Procedures

Adding the Metasys UI site as a bookmark in Launcher

About this task: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 thebookmark on the ADS/ADX/OAS or ADS-Lite computer. Or, https://[hostname]/UI, where[host name] is the host name, server name, or IP Address of the ADS/ADX/OAS or ADS-Litecomputer. Use the fully qualified computer name to avoid the certificate warning pop-upscreen.

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

About this task: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 thisfield.

4. Type the URL for the profile. For example, https://localhost/UIOffline if you arecreating the bookmark on the SCT computer. Or, https://[host name]/UIOffline, where[host name] is the host name, server name, or IP Address of the SCT computer. Use the fullyqualified computer name to avoid the certificate warning pop-up screen.

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.

Metasys UI Technical Bulletin18

Page 21: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 8: Graphics Association by TypeObject 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 Help(LIT-12011953), Metasys UI Custom Symbols Technical Bulletin (LIT-12013054), or Metasys® UI OfflineHelp (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 canalso associate Metasys UI graphics to spaces, equipment, or Equipment Definitions. Formore information, refer to the Metasys® UI Help (LIT-12011953) or Metasys® UI Offline Help(LIT-12012116).

Associating Graphics+ Graphics to a space object

About this task: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/OAS to view thegraphics in the Metasys UI. A download is not required to view the graphics in the Metasys UI Offline.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.

19Metasys UI Technical Bulletin

Page 22: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

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

About this task: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/OAS to view thegraphics in the Metasys UI. A download is not required to view the graphics in the Metasys UI Offline.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.

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 an Equipment object.

4. Click Save.

Associating a Graphics+ Graphic to a field controller

About this task: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/OAS (and theengine, if changes were made to the engine) to view the graphics in the Metasys UI. A download isnot required 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.

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 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).

Metasys UI Technical Bulletin20

Page 23: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Associating a standard graphic to a space object

About this task: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/OAS to view thegraphics in the Metasys UI. A download is not required to view the graphics in the Metasys UI Offline.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

About this task: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/OAS to view thegraphics in the Metasys UI. A download is not required to view the graphics in the Metasys UI Offline.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

About this task: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/OAS (and theengine, if changes were made to the engine) to view the graphics in the Metasys UI. A download isnot required 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.

21Metasys UI Technical Bulletin

Page 24: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

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 the graphicsto 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 9: Metasys System Preferences Used by the Metasys UIMetasys UI Component Metasys System Preference SettingStatus Colors, State Colors, andFlash Settings

Graphic Settings tab

New Alarm Indicator

Alarms (phone), Alarm Monitor,and Alarm Manager

Display Settings > View Settings

Alarm Icon based on Alarm Priority

Equipment Activity widget, AlarmPanel, Alarm Monitor, and AlarmManager

Alarm Settings tab

Alarm Sound

Alarm Manager and AlarmMonitor

Alarm Settings tab

Audible Alarm Not a Metasys system preference setting. This is a setting for auser.

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 tab

Metasys UI Technical Bulletin22

Page 25: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 9: Metasys System Preferences Used by the Metasys UIMetasys UI Component Metasys System Preference SettingBuilding 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 10 as a reference for your changes.

Note: Status colors, state colors, flash settings, and animations appear in the Metasys UI only.These settings do not appear in the Metasys UI Offline site because real data values are notavailable when offline.

Table 10: Graphics Attribute SettingsGraphics 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).

Default State Colors The Default State Colors affect the status bars and value colors forpoints 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 shape afterit is added to a graphic.

23Metasys UI Technical Bulletin

Page 26: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 10: Graphics Attribute SettingsGraphics Attribute AffectsSimple 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 andAlarm Color)

• State Color/Alternate Color (Flashes between the State Color andthe Alternate Color)

The default value is 0: Disabled (No Flashing)

4. Click OK.

Changing the new alarm indicator setting

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

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 their time ofoccurrence in the Metasys system). The default value is 15 minutes. New alarms are marked with ablue star.4. Click OK.

Changing the alarm sound interval, alarm sound, and alarm priorities

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

2. Select the Alarm Settings tab.

3. Change the settings as desired. Use Table 11 as a reference for your changes.

Table 11: Alarm Attribute SettingsAlarm 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.

Metasys UI Technical Bulletin24

Page 27: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 11: Alarm Attribute SettingsAlarm 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.

Note: Metasys UI is limited to 6 levels that can beconfigured, compared to the 10 levels that SMP allows.

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

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

2. Select the Trend Settings tab.

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

4. Click OK.

25Metasys UI Technical Bulletin

Page 28: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Adding and managing annotation text

About this task: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, clickthe annotation in the Predefined Annotation List.4. Click OK.

Metasys UI Technical Bulletin26

Page 29: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

TroubleshootingTable 12: TroubleshootingError 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.

27Metasys UI Technical Bulletin

Page 30: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 12: TroubleshootingError 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 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.

Metasys UI Technical Bulletin28

Page 31: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 12: TroubleshootingError 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 import theCustom Symbols pack, refresh the browser (Ctrl + F5) andrefresh 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.

An issue requires a Metasys UIapplication pool recycle.

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.

An issue requires a Metasys UIOffline application pool recycle.

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.

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 theUIOffline_AppPool.

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

29Metasys UI Technical Bulletin

Page 32: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 12: TroubleshootingError or error message Description with resolutionAn issue requires an SCTapplication pool recycle.

To 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.

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 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 while theMetasys UI is running, theaveraged data is not calculatedaccurately. The reportingdatabase used by the Metasys UIdoes not sync for data injectedin this manner, therefore, theaveraged data calculations maybe 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/OAS.

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

4. Reinstall the ADS/ADX/OAS.

Metasys UI Technical Bulletin30

Page 33: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 12: TroubleshootingError 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.

On an OAS, this issue may also occur if the Historical Data Add-On feature is unlicensed.

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/OAS.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 whencommanding, 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.

31Metasys UI Technical Bulletin

Page 34: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 12: TroubleshootingError or error message Description with resolutionWhen 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.

No CSV Trend Report is created. The CSV builder has limited memory and cannot handlegenerating 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.

Metasys UI Technical Bulletin32

Page 35: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 12: TroubleshootingError or error message Description with resolutionCommand 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 SMP

• After a download is performed on OASWith 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.

Online 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 and later cannot read values from engines thatare at Metasys Release 3.0 or earlier. This means that onlinepoints, engines, or controllers associated with a network enginethat is at Release 3.0 or earlier can have a status of RemoteDevice Offline , Value Inaccessible, or Value Cannotbe 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 is 20,000spaces. A larger number can cause upload, download, andperformance issues. The same 20,000 limit applies to equipment.

33Metasys UI Technical Bulletin

Page 36: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 12: TroubleshootingError or error message Description with resolutionThe Status Summary displaysquestion marks (????) in theonline mode.

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.

A point does not resolve in agraphic and you see questionmarks (????) in the graphic.

The following conditions may prevent points from resolving:• The engine is either offline or disconnected from the server.

• Equipment definition is changed after it has been mappedwith an equipment and the points are used from the sameequipment in the graphic.

• Equipment definition is deleted after it has been mappedwith an equipment and the points are used from the sameequipment in the graphic.

• Metasys services have stopped.

• Mapped points are deleted from the engine.

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 Remote Notifications

section of Metasys® UI Help (LIT-12011953) for details.

2. Configure your email settings through the RemoteNotifications feature in Metasys UI for ADS. Only SimpleMail Transfer Protocol (SMTP) type email settings aresupported for the Scheduled Report feature. POP BeforeSMTP type email settings are not supported for theScheduled Report feature.

3. If the file size of the generated report exceeds theemail server limit, which is by default 20MB, the reportgeneration is successful, but the email delivery of theScheduled Report may fail.

Reduced disk space due to largelog file size in inetpub>Logsfolder.

The folder size can exceed 50 GB due to large IIS log files, whichreduces the available disk space. The location of these logs isnot maintained by Johnson Controls. For information aboutdeleting old log files by script go to: https://docs.microsoft.com/en-us/iis/manage/provisioning-and-managing-iis/managing-iis-log-file-storage. On larger Metasys sites, you may wantto create a scheduled task to delete log files by script. Forinformation about creating scheduled tasks go to: https://docs.microsoft.com/en-us/iis/manage/provisioning-and-managing-iis/managing-iis-log-file-storage#run-the-script-as-a-scheduled-task.

Metasys UI Technical Bulletin34

Page 37: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 12: TroubleshootingError or error message Description with resolutionCertain Metasys UI featuresdisplay limited data or no dataon an OAS.

When the Historical Data add-on feature for an OAS isunlicensed, the data is limited for any feature that referenceshistorical data. In addition to Trend, this includes PotentialProblem Areas, Advanced Search & Reporting (includingScheduled Reports), Equipment Activity, and Alarm Manager/Monitor.

When the Potential Problem Areas add-on feature for an OASis unlicensed, the Potential Problem Areas widget does not showany data. Instead, it shows a message to indicate the feature isnot licensed.

When the Scheduled Reports add-on feature for an OAS isunlicensed, users can download and immediately email reportsfrom Advanced Search & Reporting, but they cannot save,view, or edit scheduled reports and templates. Additionally, theprocess to generate and deliver existing scheduled reports willnot run.

Commanding options are notdisplaying in the Metasys UICommanding dialog

If the FQR of an object contains the & symbol, the commandingoptions are not displaying in the Metasys UI Commanding dialog.

To resolve this issue, delete the object that contains the &symbol in SMP and then add it in SMP with a new name. Ensurethat you upload the changes to your SCT Archive. You may needto do a sync engine command in the Metasys UI if the data is outof sync.

Related documentationThe following table lists the related documentation for the Metasys UI and Metasys UI Offline.Table 13: Related documentationFor information about Refer to 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 Wizard(LIT-12012258)

How to install and upgrade theOAS

Open Application Server (OAS) Installation and UpgradeInstructions (LIT-12013222)

How to install the SCT and theMetasys UI Offline

SCT Installation and Upgrade Instructions (LIT-12012067)

How to install the GraphicGeneration Tool (GGT)

Graphic Generation Tool Installation Instructions (LIT-12011685)

Licensing information Software Manager Help (LIT-12012389)Configuring of spaces andequipment for the Metasys UI

Metasys® SCT Help (LIT-12011964)

35Metasys UI Technical Bulletin

Page 38: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 13: Related documentationFor information about Refer to documentUsing 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 technicalspecificationsThe 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 OAS technicalspecifications, refer to the Open Application Server (OAS) Catalog Page (LIT-1901122). For moreinformation about the SCT technical specifications, refer to the System Configuration Tool CatalogPage (LIT-1900198).Table 14: Metasys UI client technical specifications for phones and tabletsSupported mobilephone operatingsystems

Android OS 5.1 or later

iOS® 11.0 or later

Supported tabletoperating systems

Note: For mostfeatures andfunctionality,use the tablet inlandscape modewith a resolutionhigher than1280x800.

Android 5.1 or later

iOS 11.0 or later

Metasys UI Technical Bulletin36

Page 39: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 15: Metasys UI client technical specifications for computersWindows® 10 Pro and Windows 10 Enterprise Editions (version 1809 orlater) (64-bit)Web Browsers Supported:• Google® Chrome™ version 72.0.3626.121 or later

• Microsoft® Edge® version 44 or later

Windows® 8.1 Pro and Windows 8.1 Enterprise Editions with Update(KB2919355) (64-bit)Web Browsers Supported:• Windows® Internet Explorer® 11.0.9600.18816 Update version 11.0.47

or later

• Google® Chrome™ version 72.0.3626.121 or later

Windows® 7 Professional, Enterprise, and Ultimate Editions with SP1 (64-bit)Web Browsers Supported:• Windows® Internet Explorer® 11.0.9600.18816 Update version 11.0.47

or later

• Google® Chrome™ version 72.0.3626.121 or later

Windows® 7 Professional, Enterprise, and Ultimate Editions with SP1 (32-bit)Web Browsers Supported:• Windows® Internet Explorer® 11.0.9600.18816 Update version 11.0.47

or later

• Google® Chrome™ version 72.0.3626.121 or later

Apple® OS X® 10.14 MojaveWeb Browsers Supported:• Apple® Safari® 11 or later

• Google® Chrome™ version 72.0.3626.121 or later

Apple® OS X® 10.13 High SierraWeb Browsers Supported:• Apple® Safari® 11 or later

• Google® Chrome™ version 72.0.3626.121 or later

Apple® OS X® 10.12 SierraWeb Browsers Supported:• Apple® Safari® 11 or later

• Google® Chrome™ version 72.0.3626.121 or later

Supported clientcomputer operatingsystems andweb browsercombinations

Apple® OS X® 10.11 El CapitanWeb Browsers Supported:• Apple® Safari® 11 or later

• Google® Chrome™ version 72.0.3626.121 or later

37Metasys UI Technical Bulletin

Page 40: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 16: Metasys UI client technical specifications – web browsersGoogle® Chrome™ version 72.0.3626.121 or laterNotes:• For better performance, we recommend using Google Chrome as your

preferred web browser for the Metasys UI.

• The preferred browser for the Graphics Manager and the GraphicsEditor is Google Chrome. You may experience issues when using theGraphics Manager and Graphics Editor in other web browsers.

• Metasys UI does not support incognito mode. To exit incognito mode,click or tap the X icon of the browser window or tab and then opena new browser window or tab. For more information on incognitomode in Google Chrome, refer to https://support.google.com/chrome/answer/95464?hl=en.

• Starting at version 62, Google Chrome has stricter audio player rules.After a manual or automatic refresh, the Metasys UI alarm audio maynot play due to this stricter policy. To get alarms to autoplay withoutuser interaction, go to chrome://flags/#autoplay-policy and select Nouser gesture is required from the Autoplay policy drop-down menu.

Windows® Internet Explorer® 11.0.9600.18816 Update version 11.0.47 orlaterNotes:• In Internet Explorer 11 to ensure that websites appear and function

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

• Metasys UI does not support InPrivate Browsing. To exit InPrivateBrowsing, close the browser window and open a new browser window.

Apple® Safari® 11 or laterNote: Metasys UI does not support Private browsing. To exit Privatebrowsing, click or tap Private in the browser window.

Supported webbrowsers

General web browser support information:

Notes:• The Metasys UI does not officially support other web browsers, such as

Mozilla® Firefox®. However, the Metasys UI may appear and functionappropriately in other web browsers that are not officially supported.

• In supported web browsers on tablets and phones, the Metasys UI doesnot support the desktop view options. To exit the desktop view and loadthe mobile view:

- In Chrome, deselect the Request desktop site option.

- In Safari, close the browser and open the Metasys UI site.• Ensure your web browser has cookies enabled before browsing to the

Metasys UI.

• Ensure you have the Enable DOM Storage setting selected on the clientdevice. For Windows operating systems, go to Control Panel > InternetOptions > Advanced > Settings > Security and verify the Enable DOMStorage setting is selected.

Metasys UI Technical Bulletin38

Page 41: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

Table 17: Metasys UI client technical specifications – supported communication channelsSupportedcommunicationchannels

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

Ethernet network interface card 10/100/1000 Mbps

Wireless IEEE 802.11 connection

4G Network

Notes:• Metasys UI may run over a 3G network. However, browsing to the

Metasys UI over 3G is not recommended or supported.

• High latency (also called lag or wait time) can cause the Metasys UI todisconnect from the ADS or ADX.

• Signal strength affects the overall performance of the Metasys UI. Forthe best results, ensure that you have a strong signal for your wirelessconnection.

• To avoid slow performance, we recommend a network with at least 20mbps upload speed.

Software termsUse of the software that is in (or constitutes) this product, or access to the cloud, orhosted services applicable to this product, if any, is subject to applicable terms set forth atwww.johnsoncontrols.com/techterms. Your use of this product constitutes an agreement to suchterms.

Product warrantyThis product is covered by a limited warranty, details of which can be found atwww.johnsoncontrols.com/buildingswarranty.

PatentsPatents: http://jcipat.com

39Metasys UI Technical Bulletin

Page 42: Metasys UI Technical Bulletincgproducts.johnsoncontrols.com › MET_PDF › 12012115.pdf4 Metasys UI Technical Bulletin Security certificate warnings When you browse to the Metasys

© 2019 Johnson Controls. All rights reserved. All specifications and other information shown were current as of documentrevision and are subject to change without notice.