hmi · 2020-03-25 · 2. select hmi > mimic. the mimic card displays data in the context of the...

HMI

© 2020 General Electric Company

Contents

Chapter 1: Getting Started 1Introduction 2

Context Navigation 2

Chapter 2: Mimics and Alarms 4Access a Mimic Card 5

Access an Alarm Card 5

Chapter 3: KPI View Customization 7KPI View 8

Customize a KPI View 8

Chapter 4: Mimic Management 9Import Mimics 10

Associate a Mimic with a Classification 10

Associate a Mimic with an Asset 11

Manually Bind Mimic Fields to Variables 11

Manually Bind Target Zones to Descendants 12

Disassociate a Mimic from a Classification 13

Disassociate a Mimic from an Asset 13

Delete a Mimic 13

Chapter 5: Release Notes 15Fourth Quarter of 2018 16

Third Quarter of 2018 16

ii HMI

Copyright GE Digital© 2020 General Electric Company.

GE, the GE Monogram, and Predix are either registered trademarks or trademarks of All other trademarksare the property of their respective owners.

This document may contain Confidential/Proprietary information of and/or its suppliers or vendors.Distribution or reproduction is prohibited without permission.

THIS DOCUMENT AND ITS CONTENTS ARE PROVIDED "AS IS," WITH NO REPRESENTATION ORWARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TOWARRANTIES OF DESIGN, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. ALL OTHERLIABILITY ARISING FROM RELIANCE UPON ANY INFORMATION CONTAINED HEREIN IS EXPRESSLYDISCLAIMED.

Access to and use of the software described in this document is conditioned on acceptance of the EndUser License Agreement and compliance with its terms.

© 2020 General Electric Company iii

Chapter

1Getting StartedTopics:

• Introduction• Context Navigation

© 2020 General Electric Company 1

IntroductionThe HMI module is a cloud-based human machine interface (HMI) that allows you to monitor yourproduction equipment and processes and provide remote support.

You can view your systems remotely using an Internet connection and a compatible browser. Offsiteexperts and stakeholders can provide diagnostic support for operators who are in direct contact with thephysical systems being monitored by the HMI module.

The HMI module enables the creation of a custom digital representation (mimic) of multiple assets orprocesses in the context of an overall Asset Model that represents your production environment. The HMImodule also provides a comprehensive alarm grid to display details about each alarm and event occurringfor selected assets and processes.

The HMI module runs on an Asset Performance Management (APM) tenant, which is a partitioned area onthe Predix cloud for each customer or plant. Each tenant has a unique Asset Model, database, andingestion service that consumes time series data from one or more Edge/On Premise devices calledPredix Field Agents. The Predix Field Agent securely sends data from PLC and HMI/SCADA sources to thePredix Cloud services, as shown in the following illustration.

Context NavigationYou view and navigate through your production equipment and processes in the context of an AssetModel. This model is a hierarchy of the assets that are needed for you to monitor your productionenvironment.

You navigate the Asset Model by browsing the context menu and selecting target zones.

When you select an asset in the context menu, its relevant information appears in the selected layout.This can include alarms for that asset and the alarms for its descendants. Layouts consist of cards that

2 © 2020 General Electric Company

provide a specific view of the HMI/SCADA system. A card displays data according to the context of itsassociated asset. When configured, you can view a Mimic Card, an Alarm Card, or both at the same time.

Target zones represent areas in a mimic (picture) that were set as selectable in the HMI/SCADA system. Atarget zone navigates you directly to the descendants of a current asset using a Mimic Card rather thannavigating through the context menu. You can investigate any issues associated with a child of an asset.For example, you can select a closed valve in a water storage station to evaluate why it stopped pumpingwater.


Chapter

2Mimics and AlarmsTopics:

• Access a Mimic Card• Access an Alarm Card


Access a Mimic CardA Mimic Card provides digital pictures of assets and processes called mimics. If an asset is not associatedwith a mimic, this card lists its Key Performance Indicators (KPIs) tags and current values, and, if set, atrend-line analysis view of these KPIs.

About This Task

When configured, you can select certain areas, called target zones, in a Mimic Card to navigate to thedescendants of the current asset. These selectable target zones are highlighted with a blue backgroundwhen you hover over them.

Before You Begin

Select to verify the Mimic Card is connected to the cloud services, and to check when the last good

data was sent to this page. When disconnected, appears.

Procedure

1. Select an asset in the context menu.2. Select HMI > Mimic.

The Mimic Card displays data in the context of the selected asset.3. Optional: For assets listing KPIs, you can select the tag name to display the full name of the tag, the

timestamp when the current tag value was last retrieved, and the description of the tag.4. Optional: You can also view a mimic and the alarms of an asset at the same time by selecting HMI >

Mimic+Alarms.5. Optional: You can also view a mimic and the alarms of an asset at the same time by selecting HMI >

Mimic+Alarms.6. Optional: If configured, you can navigate through the hierarchy of descendants for that asset by

selecting a target zone.The child asset set for that target becomes the active asset, changing the mimic and content of anyother cards that appear.

7. Optional: You can use the context menu to navigate through the hierarchy of an asset.

Access an Alarm CardAn Alarm Card provides details of the active alarms by their severity levels in the HMI/SCADA system forthe selected asset and the descendants of that asset. The severity of an alarm is based on the prioritiesset in the HMI/SCADA system.

About This Task

A summary of alarms by each severity level icon for the selected context appears at the top of the AlarmCard. The summary reflects unfiltered alarm counts that cannot be modified by applying a filter. Below thesummary data is a table showing the following details of each alarm associated with the selected asset:

• Severity level of the alarm.• State to indicate if the alarm is active.• Acknowledgement (Acked) status of the alarm.• Date and time the alarm started.


• Asset and its property causing the alarm.• Source where alarm originated.• Substate of a property tag. For example, HiHi is the highest state for the temperature property.• Message about the alarm, such as its description and steps to fix it. If this information is not available,

a description about the tag (data source) appears.

Before You Begin

Select to verify the Alarm Card page is connected to the cloud services, and to check when the last

good data was sent to this page. When disconnected, appears.

Procedure

1. Select an asset in the context menu.2. Select HMI > Alarms.

The Alarm Card displays the alarms for the asset and the descendants of that asset.3. Optional: You can also view the mimic and the alarms at the same time by selecting HMI > Mimic

+Alarms.4. Optional: To view data in a column in ascending or descending order, select the heading column

name.5. Optional: To temporarily hide columns in the alarm page, select Show/Hide Column, and then select

the columns to hide.6. Optional: To define specific column criteria for viewing alarms in the table, such as displaying only

critical alarms, select and set the criteria accordingly.

Filters do not persist after you close your browser.

Alarm IconsEach alarm icon is color-coded and contains a specific number of dots to indicate its severity level. Thenumber next to an icon indicates how many alarms are currently active for that severity level.

The following table describes the severity levels of the alarm icons.

Icon Description

Alarm is critical.

Alarm is high priority.

Alarm is medium priority.

Alarm is low priority.


Chapter

3KPI View CustomizationTopics:

• KPI View• Customize a KPI View


KPI ViewThe Key Performance Indicator (KPI) view displays the current values of the KPI tags for an asset whileshowing the trends of these tags.

Purposes of the KPI View

Use can use the KPI view to do the following:

• After setting up the HMI module to send data to the cloud, you can quickly verify whether asset data isflowing to the cloud.

• In some circumstances, you may want to view the key performance indicators of a complex asset intext format rather than in a mimic visualization.

• You want a trend-line analysis view to monitor the performance of the KPIs for an asset.

Runtime

The KPI view appears when you select a Mimic Card or a Mimic + Alarms Card for an asset that is notassociated to a mimic. For each selected asset, you see a list of data source tags with their current valuesand trend lines. Once an asset is bound to a mimic, it no longer appears in the Runtime KPI view.

By default, this view lists all the KPI tags of any selected asset in the model. You can customize this viewto list only certain tags of an asset, and then select which of these tags to trend. You can trend up to 25tags per asset.

Customize a KPI ViewYou can change the KPI view of an asset to only display certain key performance indicators, and thenselect which of these KPIs to trend at Runtime.

About This Task

This task assumes you are customizing the default KPI view of an asset.

Procedure

1. Select HMI Designer.2. Select the asset in the context menu, and then select Open.3. Select the KPI section.4. In the KPI column, deselect any key performance indicator tags that you do not want to appear on a

Mimic Card and a Mimic + Alarms Card.5. In the Trend column for each selected KPI tag, deselect any KPI tags that you do not want to trend.

You can trend up to 25 KPI tags per asset.6. Select Save.


Chapter

4Mimic ManagementTopics:

• Import Mimics• Associate a Mimic with a

Classification• Associate a Mimic with an

Asset• Manually Bind Mimic Fields to

Variables• Manually Bind Target Zones to

Descendants• Disassociate a Mimic from a

Classification• Disassociate a Mimic from an

Asset• Delete a Mimic


Import MimicsMimics are the digital pictures of assets and processes that were created in the HMI/SCADA system. Youimport these pictures to use as mimics in the HMI layouts.

Before You BeginVerify the related iFIX pictures or CimEdit screens were exported for importing in to the HMI module.

Procedure

1. Select HMI Designer.The Mimic Management page appears.

2. Select the asset in the context menu, and then select Open.3. Select the Custom section.4. Select Import Mimic.5. In the Import Mimic window, choose Select File, navigate to the .zip file containing the mimics, and

then select Open.A green circle with a check mark appears next to each mimic that was successfully imported.

6. Select Close.The imported mimics appear in the AVAILABLE MIMICS subsection.

7. Select the mimic to view the picture and its mimic fields and target zones.8. Optional: To view the mimic in full screen, select the arrow next to the mimic.

Associate a Mimic with a ClassificationBy using a classification, you can associate a mimic with a group of similar asset instances instead of asingle asset.

About This TaskAfter you first associate a mimic, such as a pump, to a classification, the mimic is automatically bound toall similar asset instances, such as displacement pumps. This applies to existing asset instances as well asany assets you create in the future.

Procedure


2. Select the asset in the context menu, and then select Open.3. Select the Custom section.4. In the AVAILABLE MIMICS subsection, select the mimic to associate with the classification.

The mimic appears.5. In the Associated to box, select the name of the Classification.

The HMI module automatically binds mimic fields to data source variables and target zones to assetdescendants. When the HMI module cannot find a match to a mimic field based on a tag name, theHMI module assumes a binding based on a tag ID, and the assumed tag ID appears in the Tags column.When the HMI module cannot determine a match to target zones based on name, Do Not Bindappears in the Target Asset Name column. You can change these bindings, as explained in ManuallyBind Mimic Fields to Variables on page 11 and Manually Bind Target Zones to Descendants on page12.


The mimic name appears in the ASSOCIATED MIMIC - CLASSIFICATION subsection.6. Optional: To see which other classifications are associated with this mimic (if any), select Associated

Classifications - <number of associations>.7. Select Save.

Associate a Mimic with an AssetYou can indicate which mimic you want to appear in the HMI card when an asset is selected in the contextmenu. You can associate a mimic with as many assets as needed in the Asset Model.

About This Task

If a mimic is associated with a classification, you can override this association by selecting another mimicto appear in the HMI card for the selected asset.

Procedure


2. Select the asset in the context menu, and then select Open.3. Select the Custom section.4. In the AVAILABLE MIMICS subsection, select the mimic to associate to the selected asset.

The mimic appears.5. In the Associated to box, select Asset.

The HMI module automatically binds the mimic fields to the mimic. When the HMI module cannot finda match to a mimic field based on a tag name, the HMI module assumes a binding based on a tag ID,and the assumed tag ID appears in the Tags column. You can change these bindings, as explained inManually Bind Mimic Fields to Variables on page 11.

The mimic name appears in the ASSOCIATED MIMIC - ASSET subsection.6. Optional: To see which other assets are associated with this mimic (if any) and their asset hierarchy,

select Associated Assets - <number of associations>.7. Select Save.

Manually Bind Mimic Fields to VariablesAfter you associate a mimic with an asset, the HMI module automatically attempts to bind fields in amimic with similar data source variables of an asset. For example, a TPump asset object with a variablenamed Flow automatically binds with a mimic representing a pump with the @Flow@ animation.

About This Task

If the mimic field cannot automatically bind with a similarly named data source, the HMI module assumesa binding between the mimic field and a tag ID that matches the mimic field name. For example, a mimicrepresenting a pump with the @Flow@ animation assumes a TPump asset object has a tag with thesource tag ID of Flow and creates a binding between the field and the assumed tag ID.

You can change these bindings or select the data variable tag for the mimic fields that the HMI modulewas unable to match. You can also bind a mimic field to any variable in the asset model by using its datasource tag ID.


Procedure


2. Select the asset in the context menu, and then select Open.3. Select the Custom section.

Mimics that are not associated with any assets or classifications appear in the AVAILABLE MIMICSsubsection. For unassociated mimics, you can view their mimic fields, but no bindings exist betweenthe mimic fields and data source tags. Mimics that are associated with assets appear in theASSOCIATED MIMIC - ASSET subsection. For these associated mimics, you can view and change thebindings between the mimic fields and data source tags.

4. Select the mimic.5. For each mimic field you want to bind or whose binding you want to change, select whether you want

to bind by tag ID or variable name in the Binding Type column.6. Enter the tag ID, or select the variable name in the Tags column.7. Select Save.

The mimic fields are bound to the selected data source variables.

Manually Bind Target Zones to DescendantsAfter you associate a mimic to a classification, the HMI module automatically attempts to bind targetzones to corresponding child assets. You can change these bindings as well as select descendants for thetarget zones that the HMI module was unable to bind.

About This Task

In runtime, the background of a target zone changes to blue when an operator hovers over it. After anoperator selects a target in the Mimic Card, the target asset becomes the active one, changing the mimic,content, and alarms accordingly.

Before You Begin

• In iFIX, set regions on a picture as Is Selectable to appear as target zones in the Mimic Card.• In CIMPLICITY, only groups with the mouse-up or mouse-down event appear as selectable target

zones in the Mimic Card. When defining a mouse-up or mouse-down event for a group, you mustspecify the script action, and then create an empty script.

Procedure


2. Select asset in the context menu, and then select Open.3. Select the Custom section.

Mimics that are not associated with any assets or classifications appear in the AVAILABLE MIMICSsubsection. For unassociated mimics, you can view their click zones but no bindings exist between theclick zones and child asset targets. Mimics that are associated with classifications appear in theASSOCIATED MIMIC - CLASSIFICATION subsection. For these associated mimics, you can view andchange the bindings between the click zones and child asset targets.

4. Select the mimic.The mimic appears.

5. Select the Click Zones tab.The selectable target zones appear in the Click Zone Name column, and their corresponding childassets appear in the Target Asset Name column.


6. For each target zone that you want to bind to a child asset or whose binding you want to change,select its target from the list in the Target Asset Name column.

Assets that are grayed out do not exist in the selected context and cannot be set as a target.7. Select Save.

Disassociate a Mimic from a ClassificationYou can remove the association of a mimic to a classification. This removes the mimic from the group ofsimilar asset instances.

Procedure

1. Select asset in the context menu, and then select Open.2. Select HMI Designer.

The Mimic Management page appears.3. Select the Custom section.4. In the Associated to box, select No Association.5. Select Save.

The mimic is no longer associated with the classification and is removed from the similar assetinstances.

Disassociate a Mimic from an AssetYou can quickly remove the association of a mimic to an asset.

Procedure

1. Select the asset in the context menu, and then select Open.2. Select HMI Designer.

The Mimic Management page appears.3. Select the Custom section.4. In the Associated to box, select No Association.5. Select Save.

The mimic is no longer associated with the asset and does not appear in the ASSOCIATED MIMIC -ASSET subsection.

Delete a MimicWhen you delete a mimic, all its associations to assets are also removed.

Procedure


2. Select the asset in the context menu, and then select Open.3. Select the Custom section.

4. Next to the mimic you want to remove, select .

The Delete Mimic window appears showing you the number of assets associated with this mimic. Tolist the names of these assets, select Associated Assets - <number of associations>.


5. Select Continue to proceed with the deletion.A green circle with a check mark appears to indicate the mimic and its asset associations weresuccessfully removed.

6. Select Done.


Chapter

5Release NotesTopics:

• Fourth Quarter of 2018• Third Quarter of 2018


Fourth Quarter of 2018

HMI

Release Date: December 14, 2018

Table 1: Enhancements and New Features

The following enhancements and new features have been added.

Description Tracking ID

You can manually bind a mimic field to any variable in the asset model by using its data source

tag ID.

US289108

Table 2: Known Issues

The following issues are unresolved in this release.

Description Tracking ID

The Alarm Microservice caches Asset Model information for a tenant when it receives an alarm

for that tenant for the first time from the Event Hub. Afterwards, an Asset Model update check is

performed every two hours. During these checks, the Alarm Microservice is only informed of

Asset Model modifications done through the file-based Asset Ingestion process.

N/A

Third Quarter of 2018

HMIThis topic provides a list of product changes released for the HMI module on the date listed below.

Release Date: July 10, 2018

Table 3: Enhancements and New Features

Note Tracking ID

You can view the current value of the Key Performance Indicators (KPIs) for an asset, as well as

the trends of these KPIs. You can customize the KPI view of an asset to only display certain key

performance indicators, and then select which of these KPIs to trend.

N/A

You can associate a mimic with a group of similar asset instances instead of a single asset. N/A

You can select target zones that represent areas in a mimic set as selectable in the HMI/

SCADA system. A target zone navigates you directly to the descendants of a current asset.

N/A

When you associate a mimic to an asset instance or classification, the HMI module

automatically attempts to bind mimic fields with similar data source variables and target zones

to corresponding child assets. You have the option to manually change these bindings.

N/A


Table 4: Known Issues

Note Tracking ID

The Alarm Microservice caches Asset Model information for a tenant when it receives an alarm

for that tenant for the first time from the Event Hub. Afterwards, an Asset Model update check is

performed every two hours. During these checks, the Alarm Microservice is only informed of

Asset Model modifications done through the file-based Asset Ingestion process.

N/A


hmi · 2020-03-25 · 2. select hmi > mimic. the mimic card displays data in the context of the...

Documents