S OFTWARE D ESIGN

S PECIFICATION - HMI
Version : 1.00

This document aims to identify clearly and precisely what

CooperVision seeks to achieve with this project/system. It
defines the function of the system and how system must behave
when presented with specific inputs and conditions.

Luis Callegari
15-May-17
 15-May-17

REVISION HISTORY
Revision Date Completed by Comments
V1.00 15-May-2017 L Callegari Initial version

2
 15-May-17

1 CONTENTS
2 Software General Requirements ...................................................................................... 4
3 Hardware General Requirements .................................................................................... 4
4 Terminology....................................................................................................................... 4
5 Navigation Hierarchy ....................................................................................................... 5
6 Colour Styles ..................................................................................................................... 6
7 Naming Conventions ........................................................................................................ 6
7.1 Project Application ................................................................................................... 6
7.2 Screen Displays ........................................................................................................ 7
7.3 Parameter Files ........................................................................................................ 7
8 Security .............................................................................................................................. 8
8.1 Security - Levels of Access ....................................................................................... 8
9 Application Template ....................................................................................................... 9
10 Global Object Library................................................................................................... 9
10.1 Header....................................................................................................................... 9
10.2 Footer ...................................................................................................................... 11
10.3 User Controls and Navigation ............................................................................... 12
10.3.1 Control Bar ..................................................................................................... 12
10.3.2 Pushbuttons .................................................................................................... 14
10.3.3 Numeric Inputs .............................................................................................. 14
10.3.4 String Inputs .................................................................................................. 15
11 Standard Screens ....................................................................................................... 16
11.1 Navigation Screen .................................................................................................. 16
11.2 Alarms Summary ................................................................................................... 17
11.3 Alarm History ......................................................................................................... 17
11.4 Setup ....................................................................................................................... 18
11.5 FTTM / Transaction Diagnostics ........................................................................... 18
11.6 FTTM Transaction Log .......................................................................................... 19
11.7 FTTM Transaction Data ........................................................................................ 20
11.8 Shift Performance Monitoring ............................................................................... 21
11.9 Hourly Performance Monitoring ........................................................................... 22
................................................................................................................................................. 23
12 Table of Figures .......................................................................................................... 23
13 References ................................................................................................................... 25

3
 15-May-17

SOFTWARE DESIGN SPECIFICATION -

HMI
Version : 1.00

This software specification relates to all equipment to be supplied to CooperVision that

incorporates the Allen Bradley PanelView Plus Graphic Terminals.

The purpose of this section is to describe the standards for the implementation of HMI
applications. These standards shall provide consistency of look and feel across
applications which shall help reduce the learning curve associated with the
implementation of new systems.

2 SOFTWARE GENERAL REQUIREMENTS

The HMI shall at all times present a consistent and intuitive interface to the operator.
Plain English shall be employed wherever possible.

3 HARDWARE GENERAL REQUIREMENTS

The standard HMI for CooperVision is the Allen Bradley range of PanelView Plus
systems. This may only be changed with the prior consent of CooperVision.

For each main module of a machine there should be a main HMI for overall control and
monitoring of the module. This should be a minimum 15” screen. Additional terminals
may be required as appropriate to the machine layout for ease of operation these should
be 7” screens.

The latest version of the hardware generally available to CooperVision should be used.

4 TERMINOLOGY

The use of plain English shall be adhered to throughout the application, ensuring that all
Operator prompts and messages are displayed in a clear and concise manner.

The use of computer jargon shall be avoided. CVI specific jargon shall be agreed with the
User before development commences and where used shall be pertinent to the process it
describes.

4
 15-May-17

5 NAVIGATION HIERARCHY
The layout of the front-end system shall be built around the principle of a hierarchical
tree. The Screen at the top of the tree shall provide an overview of the machine (the
‘unit’) encompassing a large amount of machinery but showing very little detail.

The screens at the middle of the tree, which may be more than one level, will provide
detail of individual machine areas, such as stations (the ‘equipment modules’). These
screens should be used to show the state of the equipment module for diagnostic purposes
as well as to navigate to the bottom of the tree.

Screens at the bottom of the tree shall show the plant down to individual Pumps and
Valves, and shall therefore represent the greatest level of detail (the ‘control modules’).
Screens at this level should be defined as popup windows unless the amount of detail and
information required is large enough to encompass more than 50% of the screen.

Unit

Equipment Equipment
Module Module

Control Control Control Control

Module Module Module Module

Figure 1 – Navigation Hierarchy

In cases where the machine is complex or large enough to be comprised of multiple units,
an additional level may be added at the top of the hierarchal tree to provide an overview
of the whole process.

Process

Unit Unit

Equipment Equipment Equipment Equipment

Module Module Module Module

Control Control Control Control Control Control Control Control

Module Module Module Module Module Module Module Module

Figure 2 – Navigation Hierarchy for Complex Systems

5
 15-May-17

6 COLOUR STYLES

All screen backgrounds should be light grey as specified in the table below to
maintain uniformity across the whole application. Where colour is used to distinguish
display elements, low saturation shades should be used to avoid distracting from the
essential information on the display. Large areas of highly saturated colour should be
avoided as they can contribute to operator visual fatigue and lack of ability to focus on an
item.

Colour Name Appearance Red Green Blue

White 255 255 255
Background blue 50 72 97
Light Blue 197 209 224
Grey 192 192 192
Light Grey 224 224 224
Yellow 255 255 128
Light Green 128 255 128
Light Red 255 128 128
Dark Grey 63 63 63

7 NAMING CONVENTIONS

This section will describe the naming convention to be used throughout the application.

7.1 Project Application

The application name shall follow the Unit naming convention as specified in the
Software Design Specification for PLCs.

XX-YY-<line number> <Description>

This is the ‘filename’ for the physical application that controls the process cell which
could include, but not be limited to, PLC, DCS, HMI or SCADA applications.

Where:

XX is the abbreviated Area descriptor (e.g. FU for Frequent Use, HV for High Volume)

YY is an abbreviated Unit descriptor (e.g. FC for Fill & Close, VO for Vertical Oven)

The abbreviated area and unit descriptors will be provided by CooperVision Controls
Department. These will contain at least two characters. An optional line number and
description can be added to the process cell name if required.

This convention is to be followed when software is tested for Site Acceptance Test.
CooperVision will issue the required name on request prior to SAT.

6
 15-May-17

7.2 Screen Displays

The naming convention for screen displays follows the following structure:

XXXXX_<EquipmentModule>_<Description/Optional>

Where XXXXX is the unique identifier of the screen based on the Equipment Module
number, as shown below.

Figure 3 – Screen Display Naming Convention

Displays below 0000 to 00010 are to be used by CooperVision as part of the standard HMI
screens in the template application, while displays above 99900 are to be used as the
standardised diagnostics screens and parameterised control modules screens.

7.3 Parameter Files

Parameter files should be named in accordance to the following convention

Figure 4 – Parameter File Naming Convention

XXXXX_<EM_YYYY>_<CM_ZZZZ>

Where

7
 15-May-17

XXXX is the screen identifier which will use the parameter file.

YYYY is the relevant equipment module – this may be ignored if irrelevant.

ZZZZ is the relevant control module – this may be ignored if irrelevant.

8 SECURITY

Navigation around the application shall not require an Operator to be logged in. Certain
operations will also not require an operator to log in. However, for higher level access to
the control parameters of the system, a higher level log in may be required.

The security configuration of the application shall be done through the use of the
Lightweight Directory Access Protocol (LDAP) functionality for Active Directory built into
the Allen Bradley PanelView Plus terminals. The template application provided includes
the predefined user groups and an ‘Admin’ account to be used by the vendor for
commissioning.

8.1 Security - Levels of Access

The range of functionality available to the user shall be dependent upon his or her user
level. The following is a list of the different levels of user together with a guide to the type
of access each user level shall provide and MUST be followed in the application, no extra
users or different user names SHOULD be used:

Security
Access Level Description Codes
(A –P)
Default User that the system will log out to, it is a standard A
Rockwell function within the HMI. General Line
operation and some diagnostic capability, this is the
default logon level.

Operator General Line operation and some diagnostic A, B.

capability.

Technical Advanced line operation with some machine setup A, B, C.

Operator capability. View recipe and any parameter
information, not able to alter settings.

Supervisor Advanced line operation with some machine setup A, B, C,

capability. D, E.

Maintenance Low-level fault finding, access to diagnostics, direct A, B, C,

machine control and machine setup parameters, I/O D, F.

8
 15-May-17

testing.

Engineering Full access to all line operations / maintenance and A, B, C,

setup parameters. Ability to adjust recipes and D, E, F,
process parameters G.

Administrator Full access, access to the operating system of the A, B, C,

HMI. For use by the Controls Department and the D, E, F,
Suppliers G, H, I,
J, K, L,
M, N, O,
P.

Passwords have been intentionally omitted from the above table and can be issued on
request.

On log out or on boot up of the HMI the Default user MUST be logged in.

ME Runtime 4.00 and later security MUST be used, and ME Runtime 3.20 and earlier
security MUST not be used.

9 APPLICATION TEMPLATE

Two standard application templates will be provided to the vendor prior to configuration
of the HMI application, a PanelView Plus 1500 application and a PanelView Plus 700
application. These will be used as the basis for the vendor’s application.

All objects provided in the application must be used ‘as is’ unless agreed by CooperVision.
Please note that the example screens given here may change as the standard projects are
developed further.

10 GLOBAL OBJECT LIBRARY

As part of the application template, a library of global objects will be provided to the
vendor in order to maintain consistent functionality, look and feel across different
systems in CVI production facilities. These global objects shall not be modified by the
vendor unless previously agreed.

10.1 Header

The header is contained within the CV_Common global object and must be located at
the top left of any replace type screen. This object contains machine-wide controls and
indications along with security management for the application.

9
 15-May-17

Figure 5 – Global Object Library – Header

1. Machine Cycle Start button.

2. Machine Cycle Stop button.
3. Machine Guards Unlock Request button.
4. Line / Process and date & time.
5. Active machine mode.
6. User currently logged in and access level.
7. Alarm banner.
8. CooperVision logo.

This global object can be easily configured by using the following parameters
when deploying it on every screen:

Figure 6 – Global Object Library – Header Parameters

The tables below describe the way the buttons in the header behave relative to
the associated tag value.

Indicator Machine Control

Description
Value (Header)

Start Available 0

10
 15-May-17

Starting 1

Running 2

One+ stations
3
stopped (flashing)

Faulted 4

Indicator Machine Control

Description
Value (Header)

Stop Available 0

Stopping (Flashing) 1

Stopped 2

Indicator Machine Control

Description
Value (Header)

Guard Unlock
0
Available

Guards Unlocked –
1
Reset Required

Guards Locked –
2
Station Running

10.2 Footer

The footer is contained within the CV_Common global object and must be located at
the bottom left of any replace type screen. This object contains the reset button and
essential navigation options commonly used on all CVI machines.

Figure 7 – Global Object Library – Footer

11
 15-May-17

1. Reset button
2. Alarms
3. Setup
4. Transactions / FTTM
5. Performance Monitoring
6. Previous page
7. Main Overview
8. Navigation

Figure 8 – Global Object Library – Footer Parameters

10.3 User Controls and Navigation

Several user control elements have been provided as part of the global object
library in the template application, these facilitate the design of new applications while
maintaining a consistent functionality, look, and feel across diverse systems.

10.3.1 Control Bar

The control bar is intended for use in applications where safety zones or certain
equipment modules can be faulted, stopped or started without affecting the operation of
the rest of the machine. Said bar provides an indication of the status of each equipment
module or unit and control to start/stop and unlock the guards of each area.

12
 15-May-17

Figure 9 – Global Object Library – Control Bar

The tables below describe the way the buttons in the panel behave relative to the
associated tag value.

Indicator Station Control

Description
Value (Station Page)

Start Available 0

Starting 1

Running 2

One+ stations
3
stopped (flashing)

Faulted 4

Indicator Station Control

Description
Value (Station Page)

Stop Available 0

Stopping (Flashing) 1

Stopped 2

Indicator Station Control

Description
Value (Station Page)

Guard Unlock
0
Available

13
 15-May-17

Guards Unlocked –
1
Reset Required

Guards Locked –
2
Station Running

10.3.2 Pushbuttons

Pushbuttons shall be used to provide control in the same way that they are used
to facilitate navigation. The main application of Pushbuttons shall be where the operator
is required to issue commands to the system, such as Start/Stop or Open/Close. The
global object for these is located in the CV_Common display. This

Figure 10 – Global Object Library – Pushbuttons

Figure 11 – Global Object Library – Pushbuttons Parameters

10.3.3 Numeric Inputs

Numeric inputs shall be used to edit settings and parameters. The global object
for these is located in CV_Common screen. One of the parameters is the access level
required by the user, this will control whether the numeric input editable or view only.

14
 15-May-17

Figure 12 – Global Object Library – Numeric Inputs

Figure 13 – Global Object Library – Numeric Inputs Parameters

10.3.4 String Inputs

String inputs shall be used to edit settings and parameters. The global object for
these is located in CV_Common screen. One of the parameters is the access level required
by the user, this will control whether the numeric input editable or view only.

Figure 14 – Global Object Library – String Inputs

15
 15-May-17

Figure 15 – Global Object Library – String Inputs Parameters

11 STANDARD SCREENS

A set of standard screens are provided as part of the application template, a

library of global objects will be provided to the vendor in order to maintain consistent
functionality, look and feel across different system.

11.1 Navigation Screen

The navigation screen is accessible from the ‘Navigation’ button at the right hand
side of the footer. This screen provides the user with easy access to all ‘Unit’ and
‘Equipment Module’ level screens contained within the application. Several versions of
the screen are provided for projects of different size, these are to be manually modified by
the vendor to suit the specific application requirements.

Figure 16 – Standard Screens – Navigation Screen for Complex Applications

Figure 17 – Standard Screens – Navigation Screen for medium-sized applications

16
 15-May-17

Figure 18 – Standard Screens – Navigation Screen for simple applications.

11.2 Alarms Summary

The alarms summary page will display all active alarms in the machine, including
warnings.

Figure 19 – Standard Screens – Alarm Summary Screen

11.3 Alarm History

The alarm history page will display all current and previous alarms, including warnings.

17
 15-May-17

Figure 20 – Standard Screens – Alarm History Screen

11.4 Setup

The setup page will provide easy access to several of the standard diagnostic
functions and screens for the machine, along with mode settings for the machine
operation.

Figure 21 – Standard Screens – Setup

11.5 FTTM / Transaction Diagnostics

18
 15-May-17

The Transaction Diagnostics page will enable the user to quickly view the
transaction status, along with access to the logs, data and manual retry and abort
functions. This screen is comprised of global objects that provide the FTTM (FactoryTalk
Transaction Manager) diagnostic information.

Figure 22 – Standard Screens – Transactions Diagnostics

The main global object is the diagnostic bar for each transaction, this one is located
within the CV_Engineering display. This object has the following parameters:

Figure 23 – Standard Screens – Transaction Diagnostics Bar Parameters

11.6 FTTM Transaction Log

The FTTM (FactoryTalk Transaction Manager) Transaction log is automatically

parameterised based on the diagnostic bar, this is a popup that can be displayed by
pressing the button with the transaction name.

19
 15-May-17

Figure 24 – Standard Screens – Transaction Log

11.7 FTTM Transaction Data

These three displays are to be used as templates for displaying the data sent and received
for each transaction. These are to be customised by the vendor for every transaction in
the module by using the supplied global object for each data point.

Figure 25 – Standard Screens – Transaction Data – 10 Rows

20
 15-May-17

Figure 26 – Standard Screens – Transaction Data – 20 Rows

Figure 27 – Standard Screens – Transaction Data – 30 Rows

The provided global object can be used with real, integer and string data types by
modifying its parameters.

Figure 28 – Standard Screens – Transaction Data Global Object Parameters

11.8 Shift Performance Monitoring

21
 15-May-17

This display makes use of the 0007_ShiftStats parameter file included in the template
and the standard Coopervision PMS data structure to display the performance
information statistics on a shift by shift basis.

Figure 29 – Standard Screens – Shift Performance Monitoring

The only setup required by the vendor for the use of this screen is adjusting the
parameter file.

Figure 30 – Standard Screens –Shift Performance Monitoring Parameters

11.9 Hourly Performance Monitoring

This display makes use of the included 0008_HourlyStats parameter file and the
standard Coopervision PMS data structure to display the performance information
statistics on an hourly basis.

22
 15-May-17

Figure 31 – Standard Screens – Hourly Performance Monitoring

The only setup required by the vendor for the use of this screen is adjusting the
parameter file.

Figure 32 – Standard Screens – Hourly Performance Monitoring Parameters

12 TABLE OF FIGURES
Figure 1 – Navigation Hierarchy ............................................................................................ 5
Figure 2 – Navigation Hierarchy for Complex Systems ........................................................ 5
Figure 3 – Screen Display Naming Convention ..................................................................... 7
Figure 4 – Parameter File Naming Convention ..................................................................... 7
Figure 5 – Global Object Library – Header .......................................................................... 10
Figure 6 – Global Object Library – Header Parameters ..................................................... 10
Figure 7 – Global Object Library – Footer ........................................................................... 11
Figure 8 – Global Object Library – Footer Parameters ....................................................... 12

23
 15-May-17

Figure 9 – Global Object Library – Control Bar .................................................................. 13

Figure 10 – Global Object Library – Pushbuttons ............................................................... 14
Figure 11 – Global Object Library – Pushbuttons Parameters .......................................... 14
Figure 12 – Global Object Library – Numeric Inputs.......................................................... 15
Figure 13 – Global Object Library – Numeric Inputs Parameters ..................................... 15
Figure 14 – Global Object Library – String Inputs.............................................................. 15
Figure 15 – Global Object Library – String Inputs Parameters ......................................... 16
Figure 16 – Standard Screens – Navigation Screen for Complex Applications ................. 16
Figure 17 – Standard Screens – Navigation Screen for medium-sized applications ......... 16
Figure 18 – Standard Screens – Navigation Screen for simple applications. ................... 17
Figure 19 – Standard Screens – Alarm Summary Screen................................................... 17
Figure 20 – Standard Screens – Alarm History Screen ...................................................... 18
Figure 21 – Standard Screens – Setup ................................................................................. 18
Figure 22 – Standard Screens – Transactions Diagnostics ................................................. 19
Figure 23 – Standard Screens – Transaction Diagnostics Bar Parameters....................... 19
Figure 24 – Standard Screens – Transaction Log ................................................................ 20
Figure 25 – Standard Screens – Transaction Data – 10 Rows............................................ 20
Figure 26 – Standard Screens – Transaction Data – 20 Rows............................................ 21
Figure 27 – Standard Screens – Transaction Data – 30 Rows............................................ 21
Figure 28 – Standard Screens – Transaction Data Global Object Parameters ................. 21
Figure 29 – Standard Screens – Shift Performance Monitoring ......................................... 22
Figure 30 – Standard Screens –Shift Performance Monitoring Parameters ..................... 22
Figure 31 – Standard Screens – Hourly Performance Monitoring ..................................... 23
Figure 32 – Standard Screens – Hourly Performance Monitoring Parameters................. 23

24
 15-May-17

13 REFERENCES

25