Experion PKS Display toolkit

LAB HMI
ExxonMobil Chemical Company
Version 3.1.0 March 2011

This information is considered CONFIDENTIAL and shall not be released to or

discussed with any persons except (a) employees of ExxonMobil Affiliates who have
an appropriate research agreement with ExxonMobil Research and Engineering
Company (EMRE), and (b) consultants, contractors, or employees of third parties with
whom proper secrecy agreements have been executed with EMRE or such ExxonMobil
Affiliates.

This information is considered CONFIDENTIAL and shall not be released to or

discussed with any persons except (a) employees of ExxonMobil Affiliates who
have an appropriate research agreement with ExxonMobil Research and
Engineering Company (EMRE), and (b) consultants, contractors, or employees of
third parties with whom proper secrecy agreements have been executed with
EMRE or such ExxonMobil Affiliates.
 Rev: 3.1.0 LAB HMI
Introduction

Revision History

Rev. Date Author Change Description

3.1.0 March 2011 Philippe F. Besson Update for Display toolkit rev 3.0
0 August, 2005 Philippe F. Besson Initial Document issued for PMX Migration Program

Page(s): 2/17 ExxonMobil Use Only Experion PKS™

Confidential Toolkit
File: 827045852.doc
 LAB HMI Rev: 3.1
Introduction

Table of Contents
1. Introduction 5
1.1. Overview.............................................................................................................. 5
1.2. Change Management.......................................................................................... 5
1.3. Associated Documentation..................................................................................5
1.4. Designer's Notes and Assumptions.....................................................................5
1.5. Revision Notes.................................................................................................... 5

2. Style Sheet 7

3. Script Package 7

4. Dynamic Shapes 7
4.1. Overview.............................................................................................................. 7
4.2. Interaction with the Process.................................................................................7
4.3. Integration with the Generic Script Holder Shape................................................7
4.4. Embedded Shape Custom Properties.................................................................9
4.5. Embedded Shape Shortcut Menus....................................................................10
4.6. Summary Table of the Lab Validation Shapes...................................................12

5. PopUp windows & Faceplates 14

5.1. Popup windows................................................................................................. 14
5.2. Custom Faceplate.............................................................................................. 15

6. Installation Instructions 16
6.1. Popups.............................................................................................................. 16
6.2. Scripts................................................................................................................ 16
6.3. Shapes.............................................................................................................. 16
6.4. Shortcutmenus.................................................................................................. 17

Experion PKS™ ExxonMobil Use Only Page(s): 3/17

Toolkit Confidential
File: 827045852.doc
 Rev: 3.1.0 LAB HMI
Introduction

Table of Tables

Table 1 - VBS script routine list............................................................................................ 7

Table 2 - EPKS Lab Validation Dynamic Shape Custom Properties..................................9
Table 3 - EPKS Lab Validation dynamic Shape ShortcutMenu........................................10
Table 4 - EPKS Lab Validation Shortcutmenus.................................................................11
Table 5 - EPKS Validation Shapes......................................................................................13
Table 6 - EPKS Lab Validation Custom Faceplate.............................................................15

Page(s): 4/17 ExxonMobil Use Only Experion PKS™

Confidential Toolkit
File: 827045852.doc
 LAB HMI Rev: 3.1
Introduction

1. Introduction
1.1. Overview
This document presents the display elements developed in conjunction with the Lab result validation toolkit.

1.2. Change Management

Tookit change management is described in
 EMCC - EPKS Toolkit Change Management - Rev4.doc.

1.3. Associated Documentation

Other documentation that may provide some helpful information:
 ASM Guidelines - contains recommendations for display design.
 EMCC-EPKS-Display-Toolkit-Rev3.0.doc

1.4. Designer's Notes and Assumptions

The display elements described in this document requires display toolkit revision 2.0 to work.

1.5. Revision Notes

Ver 1.0:
Update notes:
 This package includes Display toolkit 3.0 architecture enhancements.
New:
 N/A
Enhancements:
 Modified shortcutmenu to support new ACMHelp popup (core+popup+ACMHelp+a.htm) structure
(i.e. handling of up to 5 function blocks)
 Created the following script (under scripts directory) to ease up maintenance:
o core+script+LAB.vbs
 Added database link to alarmState Icon (<tag>.almenbstate / <tag>.alenbst), linSelect object
(<tag>.name) where no alarm icon is not present in shape to support faceplate call-up based on
CM detail display setting.
 Added journalonly parameter to linselect object where relevant
 Added journalonly handling in ondatachange script to display "J" when CM journalonly setting is
ticked off.
 Modified shortcutmenus to use GSH Trend and History subroutines.
 Modified shortcutmenus to call up faceplate using database bound objects (AlarmState icon or
linSelect) or shortcumenu defined faceplate.
Fixes:
 N/A
Known Issues:
 Same as Display toolkit 3.0
Unknown:
 This version has been tested on EPKS R301.3

Experion PKS™ ExxonMobil Use Only Page(s): 5/17

Toolkit Confidential
File: 827045852.doc
 Rev: 3.1.0 LAB HMI
Introduction

Notes:
 These elements are included in XOM_PKS_Rev3.0 download
 Lab result trend is not available.
Ver 0.0: Initial Version of Display elements.
Notes:
 These elements are included in XOM_PKS_Rev2.0 download
 Lab result trend is not available.
Known Issues:
 Same as Display toolkit 2.0
Unknown:
 This version has been tested on EPKS R210 Update 8 SP 1

Page(s): 6/17 ExxonMobil Use Only Experion PKS™

Confidential Toolkit
File: 827045852.doc
 LAB HMI Rev: 3.1
Introduction

2. Style Sheet
The standard Display Toolkit 3.0 style sheets are used.

3. Script Package
The Lab interface specific display scripts are stored in the core+script+LAB.vbs file.

Table 1 - VBS script routine list

VBS Name Routine Name

core+script+LAB subCORE_LabData_ondatachange(osource)
SubCORE_labpoint_ondatachange(osource, POINT, PVALG, CHKALG, PVFORMAT)
subCORE_LabPoint_onoperatorkey(osource, Point, PVALG)
SubCORE_LabPointSummary_ondatachange(osource, POINT, PVALG, CHKALG, PVFORMAT)

Note: Script package load is controlled thru toolkit setting style attributes.

4. Dynamic Shapes
4.1. Overview
The dynamic shape library provides the symbols that represent EPKS Lab result points and follow Display Toolkit 2.0
implementation.

4.2. Interaction with the Process

The following keys are active.
 DETAIL : Open point detail page

4.3. Integration with the Generic Script Holder Shape

The dynamic shapes use the following events:
 Page
 Onoperatorkey : Call the local onoperatorkey subroutine script
 Group001
 Onclick : Call the GSH Group001_onclick subroutine
 Onmouseenter : Call the relevant GSH onmouseenter subroutine to set the set the shape tooltip and
send away tagname and equipment when they are visible.
 Onmouseleave : Call the relevant GSH onmouseleave subroutine to display tagname and
equipment name if requested.
 LinSelect
 ondatachange : Call the local ondatachange subroutine.

The Shapes require the core+script+LAB.vbs script

Experion PKS™ ExxonMobil Use Only Page(s): 7/17

Toolkit Confidential
File: 827045852.doc
 Rev: 3.1.0 LAB HMI
Introduction

Page(s): 8/17 ExxonMobil Use Only Experion PKS™

Confidential Toolkit
File: 827045852.doc
 LAB HMI Rev: 3.1
Introduction

4.4. Embedded Shape Custom Properties

The table below provides the list of custom properties that are used in the EPKS Lab result validation dynamic
shapes.

Table 2 - EPKS Lab Validation Dynamic Shape Custom Properties

Custom Property Description and Use

TAG User enters the EPKS point name to reference.
ServiceCode User enters the service code of the CM based on site standard.
DETCTALG User enters the function block name used to detect new lab result. LVAL_DETCT is
the default value.
CHKALG User enters the name of the function block checking the lab result. LVAL_CHK is
the default value/
PVALG User enters the validated PV function block name. DACA is the default name.
PVFORMAT User enters the PV display format. D1 is the default.
CompID User enters the component ID associated with the point.
Doc User enters a document name to invoke. Used with the rigthclickmenu to invoke the
file. Default is None.
Proc User enters a procedure name to invoke. Used with the rigthclickmenu to invoke the
file. Default is None

Experion PKS™ ExxonMobil Use Only Page(s): 9/17

Toolkit Confidential
File: 827045852.doc
 Rev: 3.1.0 LAB HMI
Introduction

4.5. Embedded Shape Shortcut Menus

Each shape has a custom pop-up menu. The menu definition is as follows:

Table 3 - EPKS Lab

Validation dynamic Shape
ShortcutMenu
Menu Item Lab
Validation

Detail X
Faceplate X
Validation X
Manual Entry X
Alarm History X
Result Table X
PV Trend (1)
Alarm Response X
Documentation X
Procedure X
Limits & X
Trippoints
Specials *
Alarm Enable X
PV Source Option X
PV MAN X
PV AUTO X
PV TRACK
Bypass Permissive
Bypass
REDTAG
Execution Status X

(1) Not available

Page(s): 10/17 ExxonMobil Use Only Experion PKS™

Confidential Toolkit
File: 827045852.doc
 LAB HMI Rev: 3.1
Introduction

Table 4 - EPKS Lab Validation Shortcutmenus

Shape Shortcut menu

Lab Point core+sm+lab+a.xml

Lab Point Summary

Experion PKS™ ExxonMobil Use Only Page(s): 11/17

Toolkit Confidential
File: 827045852.doc
 Rev: 3.1.0 LAB HMI
Introduction

4.6. Summary Table of the Lab Validation Shapes

Table 4, displayed in the following pages, contains a summary of the Lab Validation shapes.

Page(s): 12/17 ExxonMobil Use Only Experion PKS™

Confidential Toolkit
File: 827045852.doc
 LAB HMI Rev: 3.1
Introduction

Table 5 - EPKS Validation Shapes

EPKS function Shape
File Name Objective
Blocks
core+custom+lab+point+a.sha Represents a lab result. LVAL TOOLKIT
Displays validated result,
service code and alarm enable
status. On demand shows
point name. Invokes
oncontext menu. CM name,
Description and Enigneering
Units are displayed in the
shape ToolTip.
core+custom+lab+point+summary+a.sha Represents a validated lab LVAL TOOLKIT
result. Displays validated
result, raw result, sample time,
received time, CAB error,
component name and alarm
enable status. On demand
shows point name. Invokes
oncontext menu. CM name,
Description and Enigneering
Units are displayed in the
shape ToolTip.

Experion PKS™ ExxonMobil Use Only Page(s): 13/17

Toolkit Confidential
File: 827045852.doc
 Rev: 3.1.0 LAB HMI
Introduction

5. PopUp windows & Faceplates

5.1. Popup windows
Two types of popup windows exist in the toolkit
 Information only:
 Result Table (core+popup+lab+table+a) displays 20 results per page up to 3 pages. It is possible to
scroll thru the pages using the bottom right corner arrows.

 Alarm history (core+popup+alarmH+a)

 Action enabled popup:
 Lab result Validation (core+popup+lab+validation+a) displays the last 3 result waitings to be
rejected/accepted. The window is closed when the last waiting result is accepted/rejected.

 Lab result Manual entry (core+popup+lab+entry+a) allows to enter samplenum (optional), sample result
and sample time in case of lab interface failure.

 Special (core+popup+ai+special+a)

Page(s): 14/17 ExxonMobil Use Only Experion PKS™

Confidential Toolkit
File: 827045852.doc
 LAB HMI Rev: 3.1
Introduction

5.2. Custom Faceplate

The following faceplate is provided for lab result validation toolkit.

Table 6 - EPKS Lab Validation Custom

Faceplate
Faceplate name
core+fp+lab+point+a

Note: Faceplate is defined using Group001 popup (“viewable by ticking off group001 popup behavior).

Experion PKS™ ExxonMobil Use Only Page(s): 15/17

Toolkit Confidential
File: 827045852.doc
 Rev: 3.1.0 LAB HMI
Introduction

6. Installation Instructions
6.1. Popups
The following steps should be used to install the files contained in this package:
1. Copy the files from this package Popups folder to the Popups folder in the development display drive.
2. Promote the Popups display files from the development to the production display drive.

6.2. Scripts
The Scripts folder contains script packages used by shapes.
The following steps should be used to install the files contained in this package:
1. Copy the files from the Display Toolkit Scripts folder to the Scripts folder in the development display drive.
2. Copy the files from the Display Toolkit Scripts back-up folder to the Scripts back-up folder in the
development display drive.
3. Promote the Scripts files from the development to the production display drive.

6.3. Shapes
The following steps should be used to install the files contained in this package:
1. Copy the LAB_Shapes folder to the Shapes folder in the development display drive.
2. Update or Replace shapes in existing displays - All site displays should be upgraded to use the latest
shapes.
Replace Shapes. Depending on the number of display to update use the Display Builder Assistant or open
the file and replace one by the shape. Use Windows search feature to determine which display files use
these shapes in the display folders. Tip: Use a wildcard for the version identifier to return a complete set of
all previous versions which should be replaced (i.e. search for the filename core+custom+lab+data+?..sha to
find all earlier versions of the device control shape to be replaced with the new shape file
core+custom+lab+data+b.sha).
a. Open HMIWeb Display Builder
b. Select Tools > Display Builder Assistant... This will open a window titled "HMIWeb Display Builder
Assistant." (Display Builder Assistant is only available if a display is open for editing. If Display
Builder Assistant is not listed under the Tools menu, create a new blank display by selecting File >
New > Display and then try to open the Display Builder Assistant again.)
c. On the left side of the window, under the box labeled "Task" select Replace Shapes.
d. In the entry box labeled "Display folder:" enter the path or browse to the folder containing display
files to be updated. Note: certain types of non-HMIWeb files will cause errors. If the display folder
contains other types of files, you may want to copy the HMIWeb files to another folder to perform
the replacement and then copy the updated files back to the original folder.
e. Enter the following information into the shape entry boxes:
i. Current shape file: (enter the name of the shape file to be replaced (e.g.
core+xxxx+xxxx+a.sha))
ii. New shape file: (enter the full path to the replacement shape (e.g. R:\Shapes\
LAB_Shapes\ core+xxxx+xxxx+b.sha))

Page(s): 16/17 ExxonMobil Use Only Experion PKS™

Confidential Toolkit
File: 827045852.doc
 LAB HMI Rev: 3.1
Introduction

b. Enable the checkbox next to the Resize display objects to match size of new shape option. In most
cases, the shapes are renamed because the calculated size has changed. This checkbox should
be enabled so HMIWeb will not distort the shape by trying to force the new shape into the old
calculated size.
c. Press the Run button. The HMIWeb Display Builder Assistant will then search through the displays
located in the specified display folder and replace the specified shapes. This step can take several
minutes without showing any signs of progress so be patient.
d. Repeat the above steps in all folders containing the shapes to be replaced.
3. Promote the modified display files from the development to the production display drive.
4. Copy the PopUps_Shapes folder to the Shapes folder in the development display drive.

6.4. Shortcutmenus
The following steps should be used to install the files contained in this package:
1. Copy the files from the package Shortcutmenus folder to the Shortcutmenus folder in the development
display drive.
2. Promote the Shortcutmenus files from the development to the production display drive.

Experion PKS™ ExxonMobil Use Only Page(s): 17/17

Toolkit Confidential
File: 827045852.doc