metasys ui technical bulletinmetasys ui introduction this document contains important information...

Building Technologies & Solutions

www.johnsoncontrols.com

2020-10-30

Metasys UI Technical Bulletin

LIT-12012115

Release 11.0

2 Metasys UI Technical Bulletin

ContentsContentsMetasys UI introduction................................................................................................................................ 5

Summary of changes.......................................................................................................................... 5Concepts.......................................................................................................................................................... 5

Metasys UI............................................................................................................................................ 5Installing the Metasys UI.......................................................................................................................... 5Licensing Metasys UI features................................................................................................................. 5Browsing to the Metasys UI...................................................................................................................... 7Authentication............................................................................................................................................ 7Security certificate warnings.................................................................................................................... 7Features of the Metasys UI....................................................................................................................... 8

Metasys UI Offline............................................................................................................................. 12Installing the Metasys UI Offline............................................................................................................ 12Browsing to the Metasys UI Offline....................................................................................................... 13Authentication.......................................................................................................................................... 13Security certificate warnings.................................................................................................................. 13Features of the Metasys UI Offline........................................................................................................ 13

Configuration..................................................................................................................................... 15SCT and site archives............................................................................................................................... 15Space Authorization in the Metasys UI................................................................................................. 15

Repositories........................................................................................................................................ 16Metasys UI uses for repositories........................................................................................................... 17Trend repository database...................................................................................................................... 18Audit repository database...................................................................................................................... 19Event repository optimization................................................................................................................ 19Metasys UI reporting repository database........................................................................................... 20Spaces Authorization repository database........................................................................................... 20

Data usage......................................................................................................................................... 21Detailed procedures.................................................................................................................................... 21

Adding the Metasys UI site as a bookmark in Launcher.............................................................. 21Adding the Metasys UI Offline site as a bookmark in Launcher................................................. 21Graphics association......................................................................................................................... 22

Associating Graphics+ Graphics............................................................................................................. 23Associating standard graphics............................................................................................................... 24

Working with Metasys system preferences................................................................................... 25Changing the status color, state colors, and flash settings................................................................ 26Changing the new alarm indicator setting........................................................................................... 27Changing the alarm sound interval, alarm sound, and alarm priorities.......................................... 28Changing the trend line color and markers......................................................................................... 29Adding and managing annotation text................................................................................................. 29

Troubleshooting........................................................................................................................................... 30Related documentation............................................................................................................................... 38Metasys UI and Metasys UI Offline technical specifications.................................................................. 39

Metasys UI Technical Bulletin 3

Product warranty......................................................................................................................................... 42Software terms............................................................................................................................................. 42Patents........................................................................................................................................................... 43Contact information..................................................................................................................................... 43

Metasys UI Technical Bulletin4

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 UIrefers to both the online and offline sites.

Summary of changesThe following information is new or revised:

• Updated Licensing Metasys UI features.• Updated the Features of the Metasys UI and Features of the Metasys UI Offline sections for

the new features at Metasys Release 11.0. New Metasys UI Online features include FaultDetection and Fault Triage; Add, Delete, and Configure Objects; Show Involvement; SendAnnouncement; System Activity; Notification of new software availability; save and reuse TrendStudies; live trending; and Active Directory Federation Services (ADFS) integration with two-factor authentication. Show Involvement is the only new feature in Metasys UI Offline.

• Removed references to Remote Authentication Dial-In User Service (RADIUS), because this isno longer supported at Release 11.0.

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

Concepts

Metasys UIThe 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.

Note: Metasys UI is not available for Metasys for Validated Environments (MVE) systems.

Installing the Metasys UIThe 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.

5Metasys UI Technical Bulletin

The Software Manager manages software licenses on a machine. For more information aboutsoftware licensing in general, refer to the Software Manager Help (LIT-12012389).

Finding out more about your licensesNavigate to User menu Help > About to access details about your Metasys product and Metasys UIfeature licenses, the version, license status, and expiry date.

License expirationAs an Administrator user, you receive a notification in the form of a message on the Metasys UIscreen when a license has expired. Click the link to Details, which redirects you to the Aboutwindow, where you can see more information about the feature name along with the version,license status, and expiry date.As an Administrator user, you receive a notification in the form of a message on the Metasys UIscreen when a license is about to expire in the next 14 days. Click the link to Details, which redirectsyou to the About window, where you can see more information about the feature name along withthe version, license status, and expiry date.In addition, a red bubble icon appears next to Help and About in the User menu when a license isabout to expire in the next 14 days.

Metasys UI features that require licensingPotential Problem Areas widgetYou do not require a license to access the Points tab of the widget on an Application and DataServer (ADS), on an ADS Lite, and on an Extended Application and Data Server (ADX). For an OpenApplication Server (OAS), you require the Metasys Potential Problem Areas license to access thePoints functionality of the widget.

Starting at Metasys Release 11.0, there are additional licensing requirements for new advancedcapabilities within the Potential Problem Areas widget. The widget itself consists of two separatelicensable features, namely Fault Detection and Fault Triage. You require the Metasys FaultDetection and the Metasys Fault Triage licenses to access both Fault Detection and Fault Triage.You can use Fault Detection without a Fault Triage license, but you require both licenses for FaultDetection and Fault Triage to use Fault Triage.

Note: Fault Detection and Fault Triage are not included with any server. You must purchasethese features separately.

Refer to the Potential Problem Areas widget section in Metasys UI Help (LIT-12011953) for moreinformation about various combinations of licenses and feature availability and behavior.

Scheduled Reports featureTo enable the Scheduled Reports feature, you require the appropriate Metasys license. Ifunlicensed, this feature is unavailable or limited in the Metasys UI. The Scheduled Reports featureis included in the Metasys Server license for the Application and Data Server (ADS), the ADS Lite,and the Extended Application and Data Server (ADX). However, this feature is not included in theOpen Application Server (OAS) license. To enable this feature on an OAS, you require the MetasysScheduled Reports license.

Active Directory Federation Services (ADFS) for Active Directory (AD) Integration and Two-Factor Authentication (2FA) featureThe ADFS Authentication for Metasys license enables the ADFS for AD Integration and 2FAfeature in the Metasys UI. This add-on feature always appears in the Software Manager wheneverMetasys UI Online is installed. This add-on feature is not included in the Metasys Server license forthe ADS, the ADS Lite, the ADX, and OAS) license, but has to be licensed separately. Refer to the UserManagement section in Metasys UI Help (LIT-12011953) for more information about ADFS.


For information about activating licenses, refer to the Starting a license activation section in theSoftware Manager Help (LIT-12012389).

Additional licenses that are relevant to Metasys UIThere are additional Metasys licenses that do not enable a specific Metasys UI feature, but stillapply to ADS/ADX and/or OAS.Metasys Historical Data Add-onThe Metasys Historical Data Add-on license enables retention of historical data for the OAS, whichaffects the quantity of data available to certain Metasys UI features on an OAS.

Federal Information Processing Standard Publication 140-2 (FIPS PUB 140-2)The FIPS 140-2 for Metasys license enables the FIPS PUB 140-2 component. FIPS PUB 140-2 is aUnited States government computer security standard used to approve cryptographic modulesin software components. When the Metasys FIPS 140-2 component is installed and licensed on aMetasys Server or PC for the ADS/ADX/OAS/NAE85/LCS85, the computer system becomes FIPScompliant. This level of compliance is often required at the facilities of most federal governmentagencies. The name of this feature license in the Software Manager is FIPS 140-2 for Metasys.

For more information about other licensable features of the Metasys Server refer to the Licensingsection in the Metasys Server Installation and Upgrade Guide (LIT-12012162) and Open ApplicationServer (OAS) Installation and Upgrade Guide (LIT-12013222), respectively.

Browsing to the Metasys UITo 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).To access the Alarm Monitor, you do not need to log in to your Metasys UI site. Simply navigate tohttps://[host name]/UI/alarms, where [host name] is replaced with host name, server name,or IP address of your Metasys Site Director. However, an administrator user must first log in to theMetasys UI and enable the Alarm Monitor after you install the Metasys UI.

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

Security certificate warningsWhen 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: Metasys UI uses cookies as part of its protocols, so ensure that your web browser doesnot block all cookies before you browse 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 Microsoft Edge: Tap or click Continue to this website (not recommended). The MetasysUI login screen appears.


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

Note: The Metasys UI does not support auto-complete 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, refer to Metasys Server Installation andUpgrade Guide (LIT-12012162).

Features of the Metasys UIThe Metasys UI facilitates the following actions:Acting on alarmsUse your computer or tablet to view and take action on Metasys system alarms with the AlarmManager and Alarm Monitor. You can navigate directly from the Alarm Manager to the BuildingNetwork through a link, without having to manually search the network tree after finding the rootcause of an alarm. Use your smartphone to view and take action on alarms in the Alarms list (AlarmAnnouncement) on your phone platform.

Acting on faultsStarting at Release 11.0, you can investigate and manage faults that occur on your site with thenew Fault Detection and Fault Triage features, if these features are licensed. You can access thesefeatures through the Potential Problem Areas widget. Compared to alarms, faults utilize moresystem points, delays, and thresholds that are directly related to each individual fault. Fault Triageprovides a unique view, which provides additional information on a particular fault, correctiveactions in the order of their likeliness to resolve the issue, a description of the fault, charting ofsupporting data, and an activity log to track progress. Fault Triage also enhances the sortingorder and information in the Faults tab of the Potential Problem Areas widget to introduce faultoccurrences and durations to better drive the most problematic issues to the top of the list.

Adding, deleting, and configuring objectsStarting at Release 11.0, you can manage objects in Metasys UI Online directly. You can add,delete, and configure objects directly from the Building Network tree in Metasys UI. You can add,delete, and configure the following objects: integrations, devices and point objects, trends, alarms,schedules, and scheduled items. Managing objects was previously supported in SMP only. Creatingan item in Metasys UI does not require switching between different views, resulting in a morestreamlined and efficient workflow as compared to SMP.

Adding annotationsYou can add an annotation of 1–255 characters that may be used to describe any operational tasksthat should be performed in response to the cause or condition that prompted the event message.You can add and view annotations to commands (user change), alarm instances, and systemchanges. In addition to user-defined annotations, discards and acknowledgments of alarms displayas annotations. Administrators can also choose to enforce annotations. Moreover, users can selectannotations from a list of preset annotations, if they were configured in SMP.

Advanced search, commanding in bulk, modifying in bulk, reporting, and smart filteringThe 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 search fordata across the Building Network tree or by spaces or equipment. Using a series of filters, includingwildcards, you can refine your search results. For example, you can search for all zone temperaturepoints in a specific space.


With the Advanced Search results, you can:

• Create reports that show historical activity, alarms, audits, and trend data based on a definedtime range, or create reports showing the present values of selected objects.

• Export report data to .csv or .pdf file formats on an ad hoc basis or by scheduling a report.You can send scheduled reports to an email address or a network location automatically.

• Issue bulk commands to selected points.• Bulk modify selected points.

Authorizing users within the Metasys UIWith Space Authorization within the Metasys UI, you can explicitly grant access to specific spaces,which indirectly grants access to equipment serving the spaces.

Commanding with integrated priority arrayA Commanding dialog view with integrated Priority Array identifies the current command priorities.This helps operators troubleshoot issues faster by making it easier for them to determine whatcommand priority is currently active on a point object. In addition, you can navigate directly fromthe Commanding dialog to the Building Network through a link, without having to manuallysearch the network tree after finding the root cause of an alarm or other issue. For a list of allsupported commands refer to List of objects and supported commands table in the Metasys UI Help(LIT-12011953).

Configuring the routing and filtering of event and audit messages within the Metasys UI andsending announcementsWith the Remote Notifications feature you can configure the routing and filtering of event andaudit messages directly in the Metasys UI for each server or engine, without installing softwareon client machines. The Remote Notifications feature is known as the Destination Delivery Agents(DDAs) feature in SMP. Starting at Release 10.1, all Server Remote Notifications are created andmodified in Metasys UI and no longer in SMP. However, SMP management of Server DDAs is stillavailable for MVE sites. Starting at Release 11.0, administrators can also configure announcementswith the Remote Notifications feature in Metasys UI Online. The Send Announcement featurefacilitates mass communication. For example, you can announce a scheduled downtime due tosystem upgrades or maintenance to all Metasys users.

Creating and managing graphicsUse 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 into theGraphics Library with the Custom Symbols Library. Custom Symbol Libraries integrate seamlesslywith the base graphics package. With the Graphics Manager, you can also manage associationsfor supported legacy graphics. When the graphics are associated with a space, equipment, orequipment definition, you can view the graphics on the associated Equipment dashboard orSpace dashboard. You can bind graphics to an equipment definition with the Graphics AssociationManager for Aliased Graphics feature, so that all equipment associated with that definition willbe assigned the graphic automatically. You can also bind Network Tree items to graphics with theBuilding Network Tree binding option in the Graphics Editor. The binding tree is context-sensitive,which ensures that the binding tree opens to the appropriate space or equipment when the userlaunches the Graphics Editor from a particular space or equipment. Lastly, you can edit an existingpath that was drawn with the drawing tool with the Path Tool editing feature.


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

Custom dashboardsCustom dashboards allow Metasys UI designers to customize their dashboards by the widgets toinclude, 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).

Learning about potential problem areasThe 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 you filter and viewdata that is important to you. Starting at Release 11.0, you can also use this widget to investigateand manage faults that occur on your site, if faults are licensed. The Potential Problem Areas widgetcan be used as a daily punch list to manage buildings more efficiently.

Learning about security-related issues and system issuesThe Cyber Health Dashboard provides a comprehensive summary of system security risks, systemstatus details, and user activity information. The dashboard provides a Metasys Administrator witha centralized view of security-related issues or system issues which are detectable by a MetasysServer, but which may not surface as part of general system alarms. The Administrator can also seeout-of-date software at one glance. The information is grouped into critical issues, potential risks,and informational items. Administrators can export Cyber Health Dashboard data in the form of a.pdf report. The Cyber Health Dashboard is supported on desktop, tablets, and smartphones; andcan be accessed through the Administrative Tasks in the User menu.

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

Managing users and roles within the Metasys UIThe User Management feature facilitates the creation and management of users and their roles,category-based permissions, and privileges directly in Metasys UI Online, without the need to installsoftware on client machines. Administrators can create and manage user details for Metasys localusers and Active Directory users.

Starting at Release 11.0, Active Directory includes Microsoft® Active Directory Federation Services(ADFS), including two-factor authentication (2FA) when you configure the ADFS Server for 2FA, inaddition to Active Directory LDAP authentication. When you enable ADFS authentication in the UserManagement feature, Metasys UI Online users with an Active Directory Metasys user account havea way to authenticate through their company-provided sign-in process rather than entering theircredentials into the Metasys UI Login page. This provides an opportunity for a single sign-on (SSO)experience for Metasys UI users when the required SSO conditions are met. It also provides theability for the customer to enforce two-factor authentication for Metasys UI Online users. Also newat Release 11.0 is the ability to create a user who can access the public Application ProgrammingInterface (API).


Navigating by Building NetworkThe Building Network provides access to all objects using an alternative navigation tree to theSpaces tree. The Building Network organizes objects according to the Metasys componenthierarchy, similar to the All Items tree in the Site Management Portal (SMP). The Building Networksupports a Focus view, Summary view, Network view, Relationships view, and Trend view. Objectslisted in the Building Network tree are identified by name and by icons, that support Global Statusindicators.

Navigating by SpacesSpaces help you organize the information displayed for the Metasys system into physical locations(a campus and buildings) and areas within those locations (floors, zones, and rooms). Thehierarchy resembles the physical world to help you navigate your Metasys system. Each space hasa hierarchical relationship to other spaces, and a served-by relationship to the equipment thatprovides services to the space.

Navigating by User menuAccess Advanced Search & Reporting, System Activity, Administrative Tasks, Help, My Profile, andLog Out in the User menu.

Receiving software update notifications and licensing notificationsStarting at Release 11.0, you receive software update notifications that identify software updatesfor ADS/ADX, ADS-Lite A, ADS-Lite E, and OAS. This includes software updates for patches, minorreleases, and major releases. Software Manager data is thereby displayed directly in the MetasysUI.

As an Administrator user, you receive a notification in the form of a message on the Metasys UIscreen when a license has expired or when a license is about to expire in the next 14 days.

Searching by space and equipmentYou can search for the exact string that is contained in the space or equipment name. For example,if you search floor, the results include any space or equipment with the word floor contained in thename of any given space. Or, if you search fan, the results include any equipment with the word fan.You can also search words and phrases with varying case and obtain the same search results.

Show InvolvementStarting at Release 11.0, you can use the Involvement widget to see a visual representationof how objects are related and impacting one another in the Metasys system. Operators candetermine more easily if troubleshooting is needed and they can identify everything that couldimpact an object's controlled state and everything that an object could impact. This makes thetroubleshooting process faster and more efficient.

Usage AnalyticsUsage Analytics is a usage statistics feature that collects information on how building operatorsuse Metasys UI and what types of devices they use to access it. This helps improve the Metasysexperience by providing insights to Metasys developers on how operators navigate and interactwith Metasys software. You can enable or disable Usage Analytics in the Metasys UI either at thesite level or the user level. As an Administrator, you can enable Usage Analytics at both levels.As a Non-Administrator, you can only enable Usage Analytics at the user level, provided that theAdministrator has already enabled Usage Analytics for the entire Metasys site.

Viewing a site by dashboardsThe Space dashboard provides a comprehensive summary of the selected space, including theequipment that serves the space and potential problem areas in the space. The Equipmentdashboard provides a cohesive summary of a selected piece of equipment. Information displayed


includes alarm history, user change history, historical trend information, and relationships withother equipment and spaces.

Viewing Legacy Graphics+ Graphics and Standard GraphicsYou can view graphics associated with a space or a piece of equipment. Graphics provide a visualrepresentation of the monitored systems that enable you to quickly check the status of spaces orequipment and recognize unusual system conditions. Graphics can be designed to allow you tonavigate to buildings, floors, and other areas, and to view building systems and control processes.

Viewing system-level activityStarting at Metasys Release 11.0, you can view and manage all audits that are forwarded from anengine to a Metasys server directly in Metasys UI with System Activity. The audit data is presentedin the form of a time line in System Activity. The feature helps you understand changes that haveoccurred in the Metasys system over a period of time.

Viewing trends and trend studies through the Custom Trend viewer and the Trend widgetWith the Custom Trend viewer you can view historical trend data for up to 10 points on computerplatforms and tablets, and up to four points on smart phones for several pieces of equipmentconfigured for the Metasys UI. With the Trend widget you can view historical trend data for up to 10points for a single piece of equipment. The Trend widget can also plot points from the equipmentbeing served by the equipment you are currently viewing. You can view trended data points onup to three different charts at once. This helps operators visualize trended points of drasticallydifferent ranges.

Starting at Release 11.0, you can use the Trend Study feature to save points plotted on a trendgraph, the trend graph type, and the trends' date and time range for review at a later time. Thissaves you time, as you are not required to recreate trend graphs. The Trend Study Manager is thesingle point of entry to create and edit Metasys UI trend studies. Also starting at Release 11.0, youcan plot real time trend values for any trendable object that does not have a trend extension onits default attribute. This functionality is called live trending. Further enhancements include anincreased total sample limit of 50,000 objects, instead of having 600 samples per trend; the abilityto choose between raw or aggregate data; and the ability to select points from anywhere in theSpaces tree or Building Network tree when you use the Custom Trend viewer.

Viewing user details, system privileges, and category accessThe My Profile feature shows the user details, system privileges, and category access forthe logged-in user. The details shown in My Profile are based on the details entered in UserManagement. When authorized users edit their profile information in My Profile, their profiledetails are automatically updated in User Management.

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

Installing the Metasys UI OfflineThe 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 OfflineTo 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.To access the Alarm Monitor, you do not need to log in to your Metasys UI site. Simply navigate tohttps://[host name]/UI/alarms, where [host name] is replaced with host name, server name,or IP address of your Metasys Site Director. However, an administrator user must first log in to theMetasys UI Online and enable the Alarm Monitor after you install the Metasys UI.

AuthenticationThe 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 warningsWhen 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: Metasys UI uses cookies as part of its protocols, so ensure that your web browser doesnot block all cookies before you browse to the Metasys UI Offline.

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 SCT

computer. The Metasys UI Offline login screen appears.

• For Microsoft Edge: Tap or click Continue to this website (not recommended). The MetasysUI Offline login screen appears.

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

Note: The Metasys UI Offline does not support auto-complete 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 OfflineThe Metasys UI Offline facilitates the following actions:Configuring the routing and filtering of event and audit messages within the Metasys UIWith the Remote Notifications feature you can configure the routing and filtering of event and auditmessages directly in the Metasys UI for each server or engine, without installing software on clientmachines. The Remote Notifications feature is known as the Destination Delivery Agents (DDAs)feature in SMP. Starting at Release 10.1, all Server Remote Notifications are created and modified inMetasys UI and no longer in SMP. However, SMP management of Server DDAs is still available forMVE sites.

Creating and managing graphicsUse 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 into the


Graphics Library with the new Custom Symbols Library. Custom Symbol Libraries integrateseamlessly with the base graphics package. With the Graphics Manager, you can also manageassociations for supported legacy graphics. When the graphics are associated with a space,equipment, or equipment definition, you can view the graphics on the associated Equipmentdashboard or Space dashboard. You can bind graphics to an equipment definition with theGraphics Association Manager for Aliased Graphics feature, so that all equipment associated withthat definition will be assigned the graphic automatically. You can also bind Network Tree items tographics with the Building Network Tree binding option in the Graphics Editor. The binding tree iscontext-sensitive, which ensures that the binding tree opens to the appropriate space or equipmentwhen the user launches the Graphics Editor from a particular space or equipment. Lastly, you canedit an existing path that was drawn with the drawing tool with the Path Tool editing feature.

Navigating by Building NetworkThe Building Network provides access to all objects using an alternative navigation tree to theSpaces tree. The Building Network organizes objects according to the Metasys componenthierarchy, similar to the All Items tree in the Site Management Portal. The Building Networksupports a Focus view, Summary view, Network view, and Trend view. Object listed in the BuildingNetwork tree are identified by name and by icon and includes Global Status indicators.

Navigating by SpacesValidates the spaces configuration. Spaces help you organize the information displayed for theMetasys system into physical locations (a campus and buildings) and areas within those locations(floors, zones, and rooms).

Navigating by User menuAccess Administrative Tasks, Help, Archive, and Log Out in the User menu.

Searching by space and equipmentSearch looks for the exact string that is contained in the space or equipment name. For example,if you search floor, the results include any space or equipment with the word floor contained in thename of any given space. Or, if you search fan, the results include any equipment with the word fan.You can also search words and phrases with varying case and obtain the same search results.

Show InvolvementStarting at Release 11.0, you can use the Involvement widget to see a visual representationof how objects are related and impacting one another in the Metasys system. Operators candetermine more easily if troubleshooting is needed and they can identify everything that couldimpact an object's controlled state and everything that an object could impact. This makes thetroubleshooting process faster and more efficient.

Viewing a site by dashboardsValidates the spaces and equipment configuration. The Space dashboard provides a cohesivesummary of the selected space, including the equipment that serves the space. The Equipmentdashboard provides a cohesive summary of a selected piece of equipment.

Viewing legacy Graphics+ Graphics and Standard Graphics:View graphics associated with a space or a piece of equipment. Graphics can be designed to allowyou to navigate to buildings, floors, and other areas, and to view building systems and controlprocesses.

Viewing point informationView a point's fully qualified reference (FQR).


Configuration

SCT and site archivesSCT 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, and

field controllers to view in the Metasys UI and Metasys UI Offline.• Upgrade the site archives to SCT version 14.0, so you can access the archives in the Metasys

UI 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 1: Metasys version with matching SCT and Metasys UI versionsMetasys version SCT/Metasys UI version11.0 SCT 14.0/Metasys UI 5.010.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

Space Authorization in the Metasys UIMetasys 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 the Metasys UIOffline, and does not affect 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 2: 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 in MetasysUI Help (LIT-12011953).

RepositoriesImportant: 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 sure to enterthe address or name of your repository device (typically the Site Director) in these attributes toensure that you do not lose historical data. For the Site Director itself, leave the ADS Repositoryattribute blank if the Site Director also serves as the repository. The Default ADS Repositoryattribute defines the location of the ADS repository for all devices on the site that do not havethe ADS Repository attribute defined on their own. The ADS Repository attribute, once definedon an NAE, overwrites the Default ADS Repository attribute of the site for 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 DataAdd-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 SMP Help(LIT-1201793) or Metasys UI Help (LIT-12011953) topic, and the corresponding file name. The nextsections describe the repositories in more detail and suggest ways to optimize the repositories.Table 3: ADS/ADX/OAS repositoriesRepository Refer to Database file name on the

ADS/ADX/OAS computerTrends Trend extensions in the Metasys UI

Help (LIT-12011953)JCIHistorianDB

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

JCIAuditTrails

Events Alarm and Event Management inthe Metasys SMP Help (LIT-1201793)

JCIEvents


Table 3: ADS/ADX/OAS repositoriesRepository Refer to Database file name on the

ADS/ADX/OAS computerAnnotation

Note: Metasys UI doesnot use this database.

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

JCIItemAnnotation

Reporting Advanced Reporting in the MetasysSMP Help (LIT-1201793)

MetasysReporting

Metasys UI Reporting Reporting: Trend Widget andCustom Trend Viewer in the MetasysUI Help (LIT-12011953)

JCIReportingDB

Spaces Authorization Space Authorization andDashboard Manager in the MetasysUI Help (LIT-12011953).

SpacesAuthorization

Metasys UI uses for repositoriesThe following table lists the corresponding features of the Metasys UI that use the repositorydatabases.

Table 4: 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 and SystemActivity.

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


Table 4: Metasys UI uses for repositoriesRepository Metasys UI feature DatabasePotential ProblemAreas

Point data that displays in the Pointstab of the Potential Problem Areaswidget. The database self-maintainsand stores a rolling seven days' worthof data.

MetasysValue

Note: You need to licensethe Potential Problem AreasPoints on an OAS to activatethe MetasysValue database.

Fault Detection Fault data that displays in the Faults tabof the Potential Problem Areas widget.The database self-maintains and storesa rolling seven days' worth of data.

MetasysFault

Note: You need to licensethe Fault Detection featureto activate the MetasysFaultdatabase.

Fault Triage Fault Triage data that displays in theFault Triage feature.

MetasysFaultTriage

Note: You need tolicense the Fault Triagefeature to activate theMetasysFaultTriagedatabase.

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 overviewThe 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, the directorylocation is on the database server on the same drive where the SQL Server software is installed. Ifyou want to change where the databases are loaded (for example, E:\MyDatabases), you needto do so before you install the ADS/ADX/OAS software. For details, refer to the Metasys ServerInstallation and Upgrade Guide (LIT-12012162) or the Metasys Server Lite Installation and UpgradeInstructions (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 optimizationOptimize 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 timewhen user access to the system is minimal

Refer to the Trend extensions topic in the Metasys UI Help (LIT-12011953) for more information.

Audit repository database

Audit repository database overviewThe 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, the directorylocation is on the database server computer 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 MetasysServer Installation and Upgrade Guide (LIT-12012162) or the Metasys Server Lite Installation andUpgrade 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 optimizationOptimize 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 overviewThe 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, the directorylocation is on the database server computer 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 MetasysServer Installation and Upgrade Guide (LIT-12012162) or the Metasys Server Lite Installation andUpgrade 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 optimizationOptimize 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 reporting repository database

Metasys UI reporting repository database overviewThe 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 UpgradeGuide (LIT-12012162).

Metasys UI reporting repository database optimizationOptimize your JCIReporting repository database by following the optimization options in Trendrepository optimization.

Spaces Authorization repository database

Spaces Authorization repository database overviewThe 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 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 UpgradeGuide (LIT-12012162).

Data usageWhen you first navigate to the Metasys UI, the Metasys UI consumes approximately 3.8 MB ofbandwidth. The following table shows typical data consumption for one user on a site.Table 5: Metasys UI bandwidth 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 data consumption Approximately 30–200 KB

Detailed procedures

Adding the Metasys UI site as a bookmark in LauncherAbout 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 the

bookmark 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 new

profile shown under the Bookmark tab. If you clicked Create Shortcut, a shortcut labeledwith the Description you entered is created on the computer desktop.

Adding the Metasys UI Offline site as a bookmark inLauncherAbout 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 inthis field.

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 new

profile shown under the Bookmark tab. If you clicked Create Shortcut, a shortcut labeledwith the Description you entered is created on the computer desktop.

Graphics associationThe following table lists the types of graphics you can associate with the types of objects. In SCT,you can associate graphics to a space object, equipment object, and field controller.Table 6: Graphics association by 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 GraphicsManager of the Metasys UI and Metasys UI Offline. For more information, refer to the Metasys UIHelp (LIT-12011953), Metasys UI Custom Symbols Technical Bulletin (LIT-12013054), or Metasys UI OfflineHelp (LIT-12012116).


Associating Graphics+ GraphicsNote: In Metasys UI 2.1 and later, you can associate Graphics+ graphics to spaces or equipmentin the Graphics Manager of the Metasys UI or Metasys UI Offline. You can also associate MetasysUI graphics to spaces, equipment, or Equipment Definitions. For more information, refer to theMetasys UI Help (LIT-12011953) or Metasys UI Offline Help (LIT-12012116).

Associating Graphics+ Graphics to a space objectAbout 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 UIOffline.To associate a Graphics+ graphic to a Space object in SCT:

1. Select the Space object in the Spaces tree.2. In the Configuration tab of the Space object, click Edit.3. Select the Graphics+ graphic from the All Items tree. Drag the Graphics+ graphic to the

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

4. Click Save.

Associating a Graphics+ Graphic to an equipment objectAbout 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 UIOffline.To associate a Graphics+ graphic to an Equipment object in SCT:

1. Select the Equipment object in the Equipment tree.2. In the Configuration tab of the Equipment object, click Edit.3. Select the Graphics+ graphic from the All Items tree. Drag the Graphics+ graphic to the

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

4. Click Save.

Associating a Graphics+ Graphic to a field controllerAbout 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 theGraphic attribute field.

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

4. Click Save.

Associating standard graphicsNote: In Metasys UI 2.1 and later, you can associate standard graphics to spaces or equipmentin the Graphics Manager of the Metasys UI or Metasys UI Offline. You can also associate MetasysUI graphics to spaces, equipment, or Equipment Definitions. For more information, refer toMetasys UI Help (LIT-12011953) or Metasys UI Offline Help (LIT-12012116).

Associating a standard graphic to a space objectAbout 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 UIOffline.To associate a standard graphic to a Space object in SCT:

1. Select the Space object in the Spaces tree.2. In the Configuration tab of the Space object, click Edit.3. Select the Standard graphic from the All Items tree. Drag the Standard graphic to the Graphic

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

4. Click Save.

Associating a standard graphic to an equipment objectAbout 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 UIOffline.To associate a standard graphic to an Equipment object in SCT:

1. Select the Equipment object in the Equipment tree.2. If graphics are not already associated to device objects, then go to the Configuration tab of

the Equipment object and click Edit.3. Select the Standard graphic from the All Items tree. Drag the Standard graphic to the Graphic

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

4. Click Save.

Associating a standard graphic to a field controllerAbout 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.3. Select the standard graphic from the All Items tree. Drag the standard graphic to the Graphic

attribute 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 graphics

to equipment that was derived from the controller.

4. Click Save.

Working with Metasys system preferencesThe Metasys UI uses settings from the Metasys system preferences. The following table lists thecomponents that use the Metasys system preferences.Table 7: Metasys system preferences used by the Metasys 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 fora user.

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


Table 7: Metasys system preferences used by the Metasys UIMetasys UI component Metasys system preference settingTrend Chart Line Color and LineMarkers

Trend Widget and Custom TrendViewer

Trend Settings > Chart Color and Marker Preferences

Annotations Annotations tabBuilding Network Metasys administrators automatically have access to the

Building Network tree.

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

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

Changing the status color, state colors, and flash settings

1. In SMP, go to Tools > Configure Preferences.2. Select the Graphics tab.3. Change the settings as desired. Use Table 8 as a reference for your changes.

Note: Status colors, state colors, flash settings, and animations appear in the Metasys UIonly. These settings do not appear in the Metasys UI Offline site because real data valuesare not available when offline.


Table 8: Graphics attribute 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 afan symbol when its bound object's value indicates the fan isstopped. Stopped is defined as State 0 (for binary and multistateobjects) or as zero (for analog object).

• The Running Color defines the background color used for afan symbol when its bound object's value indicates the fanis running. Running is defined as State 1+ (for binary andmultistate objects) or as 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.

Simple Symbol FlashSettings

The Simple Symbols Flash Settings affect the flash animation ofsymbols in the Graphics widget. Defines the type of flashing appliedto basic shape symbols:

• Disabled (No Flashing)• State Color/Alarm Color (Flashes between the State Color and

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

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

4. Click OK.

Changing the new alarm indicator setting

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 15

minutes.The New entry timeframe is the amount of time alarms are considered new (based ontheir time of occurrence in the Metasys system). The default value is 15 minutes. Newalarms are marked with a blue 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 9 as a reference for your changes.

Table 9: 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.

Priority Indicates the range of priorities of each priority level. Thenumber 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 thenumber 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 defaultLevel 2 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 defaultLevel 3 range is 80–139.

• The Level 4 range starts at priority Level 3 + 1 (139 + 1= 140) and ends at the number configured here. Thedefault Level 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 File

Note: The sound files on adevice are only used by theMetasys UI when you aredirectly logged in to that device.If a sound file is missing fromthe device, the Metasys systemuses the default system beep inits place.

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.

Adding and managing annotation textAbout 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 of

predefined annotations. The text can be from 1 to 255 characters in length. Click Add.Predefined annotations can be edited or deleted. To edit or delete a predefined annotation,click the annotation in the Predefined Annotation List.

4. Click OK.


TroubleshootingTable 10: TroubleshootingError or error message Description with resolutionAfter installing Metasys UIor Metasys UI Offline, youreceive the following errorwhen browsing 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:

a. Right-click Windows PowerShell and select Run asAdministrator.

b. Enter the following line: Install-WindowsFeatureWeb-Asp-Net45.

c. Press Enter.

• Windows 7 (64-bit):a. Right-click Command Prompt and select Run as

Administrator.b. Enter the following line: C:

\Windows\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis.exe-i.

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

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

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


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

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

Table 10: TroubleshootingError or error message Description with resolutionAfter installing Metasys UIor Metasys UI Offline, youreceive the following errorwhen browsing 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 the

Application 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 or

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

Settings.8. The Basic Settings window appears. In the Managed

pipeline mode field, change the mode from Classic toIntegrated.

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


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

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

Table 10: 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 Offlinefor long periods of time with no session expiration, theMetasys UI Offline becomes unresponsive and displays anUnexpected Error message. To resolve this issue, recyclethe UIOffline_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 inSMP, schedules deleted from SMP, or new schedules fromrecently added 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 caution whenrecycling 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 click

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

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


Table 10: 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 >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 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 work around this issue, create and edit Aliased graphics inthe Metasys UI Offline.

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

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

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

Tool (GGT).2. Edit the bindings of the RCM. When you edit the bindings,

you can simply delete and reenter the same binding data.3. Save the Graphics+ graphics to the Metasys host.

When you subsequently view the Graphics+ graphic in theGraphics widget, the RCM data should populate appropriately.

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

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

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

representative to obtain scripts that resolve this issue.2. Uninstall the ADS/ADX/OAS.3. Clear the JCIReporting database using the scripts from Step

1.4. Reinstall the ADS/ADX/OAS.


Table 10: 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 and

public 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 disconnectand reconnect messages.

• You may receive errorwhen commanding,commands may fail, orcommands may takelonger than 10 seconds tosend.

• You may see a NetworkError message in thewidgets.

• You may see slow loadtimes for 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.


Table 10: 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 do notload completely, display partialdata, or display Null as a valueafter installing the MetasysServer software and duringinitial start-up of the MetasysUI.

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.


Table 10: 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 notfrom 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 OAS

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

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


Table 10: 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 mapped

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

Notifications 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 the emailserver limit, which is by default 20MB, the report generationis successful, but the email delivery of the Scheduled Reportmay 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.


https://docs.microsoft.com/en-us/iis/manage/provisioning-and-managing-iis/managing-iis-log-file-storage



https://docs.microsoft.com/en-us/iis/manage/provisioning-and-managing-iis/managing-iis-log-file-storage#run-the-script-as-a-scheduled-task




Table 10: 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 Commandingdialog.

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.

The Fault Detection feature andthe Fault Triage feature do notappear in Metasys UI after youlicense the features.

After you license the Fault Detection feature and the Fault Triagefeature, there is a brief delay before the faults become visible.Log out of Metasys UI and back in, if you were logged in whenyou licensed the feature.

Related documentationThe following table lists the related documentation for the Metasys UI and Metasys UI Offline.Table 11: Related documentationFor information about Refer to documentHow to install the Metasys Serverand the Metasys UI (online)

Metasys Server Installation and Upgrade Guide (LIT-12012162)

How to install the Metasys ServerLite

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

How to install and upgrade theOAS

Open Application Server (OAS) Installation and Upgrade Guide(LIT-12013222)

How to install the SCT and theMetasys UI Offline

SCT Installation and Upgrade Instructions (LIT-12012067)

Licensing information Software Manager Help (LIT-12012389)


Table 11: Related documentationFor information about Refer to documentConfiguring of spaces andequipment for the Metasys UI

Metasys SCT Help (LIT-12011964)

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

Metasys Site Management Portal Help (LIT-1201793)orMetasys SCT Help (LIT-12011964)

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.

• For more information about the ADS/ADX technical specifications, refer to the Application andData Server (ADS) and Extended Application and Data Server (ADX) Product Bulletin (LIT-1201525).

• For more information about the ADS-Lite technical specifications, refer to the Metasys ServerLite Installation and Upgrade Instructions (LIT-12012258).

• For more information about the OAS technical specifications, refer to the Open ApplicationServer (OAS) Catalog Page (LIT-1901122).

• For more information about the SCT technical specifications, refer to the System ConfigurationTool Catalog Page (LIT-1900198).

Table 12: Metasys UI client technical specifications for phones and tabletsSupported mobilephone operatingsystems

Android 5.1 or later

iOS® 11.4.1 or later

Supported tabletoperating systems

Android 5.1 or later

iOS® 11.4.1 or later

Notes:• You can use some desktop-specific Metasys UI features on your

iPad™ (iOS version 13.2.3), if you enable the desktop view. To enablethe desktop view on your iPad go to Settings > Safari > RequestDesktop Website.

• For most features and functionality, use tablets in landscape modeand have a resolution higher than 1280 x 800.


Table 13: Metasys UI client technical specifications for computersWindows® 10 Pro and Windows 10 Enterprise Editions versions 1903, 1909,and 2004 (64-bit). For all future Windows 10 updates after version 2004, wewill evaluate and certify that Metasys software can support the updatesbefore we provide guidance on support.Web browsers supported:

• Google® Chrome™ version 78 or later• Microsoft® Edge® version 44 or later

Windows® 8.1 Pro and Windows 8.1 Enterprise Editions with Update(KB2919355) (64-bit)Web browser supported:

• Google® Chrome™ version 78 or later

Windows® 7 Professional, Enterprise, and Ultimate Editions with SP1 (64-bit)Web browser supported:

• Google® Chrome™ version 78 or later

Supported clientcomputer operatingsystems andweb browsercombinations Apple® macOS® 10.15 Catalina

Apple® macOS® 10.14 Mojave

Apple® macOS® 10.13 High Sierra

Apple® macOS® 10.12 Sierra

Web browsers supported:• Apple® Safari® 11 or later• Google® Chrome™ version 78 or later

Note: When you use Chrome version 80 or later on a macOS, you needa certificate issued by the Certificate Authority (CA) due to a Chromebrowser change.


Table 14: Metasys UI client technical specifications for web browsersGoogle® Chrome™ version 78 or laterNotes:

• For better performance, we recommend that you use Google Chromeas 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 you usethe Graphics Manager and Graphics Editor in other web browsers.

• If you use the Metasys UI with Google Chrome and if yousimultaneously use other browsers, you may see the followingerror message in Metasys UI: Disconnected! The server isno longer sending value updates. Please refresh yourbrowser. To prevent this, disable background timer throttling asfollows:

a. Right-click on the Google Chrome icon in the task bar.b. Right-click on Google Chrome in the menu that opens, and

select Properties.c. In the Shortcut tab, add --disable-background-timer-

throttling to the end of the Target field. Insert a spacebetween the path and the flag: "C:\Program Files(x86)\Google\Chrome\Application\chrome.exe" --disable-background-timer-throttling

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

Microsoft® Edge® version 44 or later

Supported webbrowsers

Apple® Safari® 11 or later

Note: Metasys UI does not support Private browsing. To exit Privatebrowsing, click or tap Private in the browser window.


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

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

Table 14: Metasys UI client technical specifications for web browsers

General webbrowser supportinformation

• The Metasys UI does not officially support other web browsers, suchas Mozilla® Firefox®. However, the Metasys UI may appear andfunction appropriately in other officially unsupported web browsers.

• In supported web browsers on tablets and phones, the Metasys UIdoes not support the desktop view options. To exit the desktop viewand load the mobile view:

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

• Metasys UI uses cookies as part of its protocols, so ensure that yourweb browser does not block all cookies before you browse to theMetasys UI.

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

Table 15: Metasys UI client technical specifications for supported communication channels

Supportedcommunicationchannels

For optimal performance, we recommend a wired connection forcomputers that browse 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 to

disconnect from the ADS or ADX.• Signal strength impacts the overall performance of the Metasys UI.

For the best results, ensure that you have a strong signal for yourwireless connection.

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

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

Software termsUse of the software that is in (or constitutes) this product, or access to the cloud, or hostedservices applicable to this product, if any, is subject to applicable end-user license, open-


http://www.johnsoncontrols.com/buildingswarranty

source software information, and other terms set forth at www.johnsoncontrols.com/techterms. Your use of this product constitutes an agreement to such terms.

PatentsPatents: https://jcipat.com

Contact informationContact your local branch office: www.johnsoncontrols.com/locationsContact Johnson Controls: www.johnsoncontrols.com/contact-us


https://www.johnsoncontrols.com/techterms

https://www.johnsoncontrols.com/techterms

https://jcipat.com

http://www.johnsoncontrols.com/locations

http://www.johnsoncontrols.com/contact-us

metasys ui technical bulletinmetasys ui introduction this document contains important information...

Documents