Engineering Procedure

SAEP-1626 19 October 2017

Configuration and Graphics Guidelines
Document Responsibility: Process Control Standards Committee

Contents

1 Scope ...................................................... 2
2 Conflicts and Deviations .......................... 2
3 Applicable Documents ............................. 2
4 Responsibilities........................................ 3
5 Instructions .............................................. 3
6 Definitions ................................................ 4
Revision Summary ........................................ 5

Appendix 1 - Configuration and Graphics

Guidelines Content .................. 6

Previous Issue: 25 July 2012 Next Planned Update: 19 October 2020

Page 1 of 15
Contact: Hashim, Asaad M. (hasham0q) on phone +966-13-8621625

©Saudi Aramco 2017. All rights reserved.

Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

1 Scope

This Saudi Aramco Engineering Procedure (SAEP) defines the Non-material

Requirements (NMR) for the preparation of database configuration and graphics
guidelines for Process Automation Systems (PAS) projects.

The Configuration and Graphics Guidelines shall provide the design guidelines,
standards, and implementation practices that are to be used for design of the PAS
database configuration.

SAEP-1626 is applicable to all Saudi Aramco Projects that are subject to SAEP-16,
Project Execution Guide for Process Automation Systems. Per SAEP-16, the
Configuration and Graphics Guidelines document is required for the Preliminary Design
Review (PDR) and Critical Design Review (CDR) stages of a project.

2 Conflicts and Deviations

Any conflict between this document and other Applicable Mandatory Saudi Aramco
Engineering Requirements (MSAERs) shall be addressed in writing to the EK&RD
Coordinator.

Any deviation from the requirements herein shall follow internal company procedure
SAEP-302, waiver of a Mandatory Saudi Aramco Engineering Requirements.

3 Applicable Documents

All referenced Procedures, Standards, Specifications, Codes, Forms, Drawings, and

similar material or equipment supplied shall be considered part of this Procedure to the
extent specified herein and shall be of the latest issue (including all revisions, addenda,
and supplements) unless stated otherwise.

 Saudi Aramco Engineering Procedures

SAEP-16 Project Execution Guide for Process Automation
Systems
SAEP-302 Instructions for Obtaining a Waiver of a Mandatory
Saudi Aramco Engineering Requirement

 Saudi Aramco Engineering Standard

SAES-Z-001 Process Control Systems

 Saudi Aramco Best Practice

SABP-Z-074 Guidelines for Virtual Servers and Thin Clients for

Page 2 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

Process Automation Systems

4 Responsibilities

4.1 Saudi Aramco Project Management Team (SAPMT)

Responsibilities include:
a. Ensure that the Guidelines meet the Functional Specification Document
requirements.
b. Ensure that the guidelines meet the requirements of SAES-Z-001.
c. Ensure that the procedures in this SAEP are used to prepare the guidelines.
d. Submit the guidelines for review as part of the Preliminary Design Review
(PDR) documents.
e. Submit the revised guidelines for review as part of the Critical Design
Review (CDR) documents.
f. Review and approve the guidelines submitted for PDR.
g. Review and approve the guidelines submitted for CDR.

4.2 Operating Organization

Responsibilities include:
a. Review and approve the guidelines submitted for PDR.
b. Review and approve the revised guidelines submitted for CDR.

5 Instructions

5.1 Purpose

The purpose of the Configuration and Graphics Guidelines is to ensure that the
database configuration will conform to standards that will provide consistency in
operation and presentation and will enhance system engineering and
maintainability. The guidelines shall also ensure that Saudi Aramco's
configuration practices are met and that Vendor's standards are followed as
much as possible.

5.2 Content

5.2.1 Appendix 1 provides an outline for the minimum required content of

topics addressed in the Configuration and Graphics Guidelines. If using
Virtual Servers and Thin Clients for Process Automation Systems; then,

Page 3 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

SABP-Z-074 shall be used also as a guideline. Conventions to be used

for configuring I/O, controls, databases, alarms, graphics, reporting and
trending are included.

5.2.2 The format suggested by Appendix 1 need not be followed. A format that
is appropriate to the needs of a particular project may be developed.

5.2.3 The guidelines shall be organized in a logical manner and shall convey all
information necessary for understanding precisely how the system will be
configured.

5.2.4 The text must be concise, specific, clearly worded, and illustrated.
Tabular data such as charts, tables, and diagrams should be used whenever
practicable.

5.2.5 Graphic Display shall have the capabilities of 3D visualization and 3D

trending.

6 Definitions

6.1 Acronyms
CDR Critical Design Review
DCS Distributed Control System
ESD Emergency Shutdown System
DAHS Data Acquisition and Historization System
NMR Non-Material Requirement
PC Personal Computer
PLC Programmable Logic Controller
PDR Preliminary Design Review
SCADA Supervisory Control and Data Acquisition
CCS Compressor Control System

6.2 Definitions of Terms

Process Automation System: A network of computer-based or

microprocessor-based modules whose primary purpose is process automation.
The functions of a PAS may include process control, safety, data acquisition,
advanced control and optimization, historical archiving, and decision support.
Examples of process automation systems are DCS, SCADA, DAHS, ESD, CCS,
and PLC-based systems.

Page 4 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

Revision Summary
25 July 2012 Revised the “Next Planned Update.” Reaffirmed the content of the document, and reissued
with editorial revision to replace document’s Primary Contact.
19 Ocotober 2017 Reaffirmed the content of the document and reissued with minor wording changes for clarity.

Page 5 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

Appendix 1 – Configuration and Graphics Guidelines Content

1. Controller Configuration Guidelines

The guidelines used for the configuration of controllers shall be provided. The controller
guidelines shall include the following:

1.1 General Guidelines

1.1.1 Point Naming Conventions

Process Automation systems (PAS) should have certain naming

conventions to maintain consistency. The guidelines shall include
naming conventions for:
 Loop points
 Analog indication points
 Discrete indication points
 FF indication points
 Calculated points
 Auxiliary Systems communication points

1.1.2 Hardware Address Assignments

1.1.3 To ensure optimal system performance on peak load conditions,

the guideline should identify:
 Upper limits to scan rates
 Phasing
 Console sample intervals
 Display update intervals
 Number of real-time data to be displayed in graphics page

1.2 Analog Control Guidelines

The guidelines that will be used to develop continuous/analog control strategies

shall be provided.

1.2.1 Process Variable Signal Conditioning

 Filters

Page 6 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

 Rate of change limits

 Linearization

1.2.2 Scan rates for control and monitoring points and update method,
i.e., periodic, by exception (including deadbands), etc.

1.2.3 Alarm Processing for Analog Control and Monitoring Points

1.2.3.1 Conventions for high, high-high, low, low-low, and deviation

alarm values.

1.2.3.2 Analog Input Signal Failure Detection and Action

The guidelines shall include methods for detecting and

alarming invalid signals and methods by which detected errors
are propagated within a control loop and communicated to the
operator. Discussions shall include point failure and out of
service actions taken by the following types of loops:
 Simple loops (no logic)
 Complex loops (containing logic)
 Cascade loops (Primary and secondary controllers)
 Feedforward loops
 Flow compensation

1.2.3.3 Analog Value Alarm Descriptors

Conventions for naming alarm descriptions for low, low-low,

high, high-high, deviation, etc. alarms shall be provided.

1.2.4 Control Loop Characteristics

Guidelines to be used for control configuration shall include:

1.2.4.1 Setpoint tracking for bumpless transfer.

1.2.4.2 Output tracking logic.

1.2.4.3 Anti-reset windup.

1.2.4.4 Output and setpoint tracking and anti-reset windup for

cascaded loops.

1.2.4.5 Setpoint limiting.

Page 7 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

1.2.4.6 Default tuning parameters.

1.2.4.7 Anti-reset windup limits.

1.2.4.8 Failsafe action taken if controller fails.

1.2.4.9 Loop restart parameters (mode, setpoint, output) utilized by

controllers when power is restored.

1.2.4.10 Initialization - Procedures and parameters invoked when a

control loop is turned on, a block is reconfigured, or a
controller is reloaded.

1.3 Discrete Control Guidelines

Guidelines to be used for configuring discrete control strategies shall be

provided. Discrete loops may be single input (monitoring), single output, or
multiple I/O. The guidelines shall cover the following topics.

1.3.1 Scan rates and phasing.

1.3.2 Initialization - Procedures and parameters invoked when a control loop is

turned on, a block is reconfigured, or a controller is reloaded.

1.3.3 Alarm Processing.

1.3.4 Alarm Descriptors.

1.3.5 Error handling/Failsafe setpoints.

1.3.6 Methods of control logic implementation including overrides and

interlocks.

1.3.6.1 Use of points configured from multiple I/O.

1.3.6.2 Use of calculation and logic blocks.

1.3.6.3 Bypass capability for permissives and interlocks.

1.3.6.4 Bypass alarming and historization.

1.3.6.5 Transition times for input signals to match setpoints and retries.

1.4 FF Control Guidelines

Guidelines to be used for configuring FF control strategies shall be provided.

Page 8 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

1.5 Non-Standard Control Applications Guidelines

Guidelines regarding configuration of analog and discrete control loops

that require more functionality than that provided by standard control
blocks/algorithms, e.g., advanced control strategies, shall be provided.
The guidelines shall include the following:

1.5.1 Programming

1.5.1.1 Units of calculations - engineering or scaled.

1.5.1.2 Use of comments to explain calculations and control action.

1.5.1.3 Use of standardized code.

1.5.1.4 I/O access.

1.5.2 Scan Rates and Phasing.

1.5.3 Initialization Action.

1.5.4 Alarming.

1.5.5 Diagnostics and Error Handling.

1.5.6 Scaling, Clamping, and Signal Conditioning.

1.5.7 Tracking and Overrides (Bumpless Transfer).

1.5.8 Documentation.

2. Operator Console Configuration Guidelines

Guidelines that will be used to configure the operator consoles shall be provided. These
guidelines shall include the following topics:

2.1 Operator Console General Guidelines

2.1.1 Console Reporting Modes (Periodic, by exception, change-of-state, etc.).

2.1.2 Console Sample Interval.

2.1.3 Deadbands used for Analog Updates.

2.1.4 Analog Value Formats (number of significant digits and decimal places).

2.1.5 Console Timing Preferences

Page 9 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

2.1.5.1 Input time-out - Time for an input area to be active with no

changes before the area clears.

2.1.5.2 Display Update Interval - screen update time for dynamic

information.

2.1.5.3 Field Edit Time-out - After editing a field begins, the time
allowed to complete edit before the value reverts to its original
value.

2.2 System Security

Guidelines regarding limitations of the ability to make changes to the control

system based on skill level and job responsibilities shall be provided.
These guidelines shall include the following:

2.2.1 User Access Levels (Operator, Engineer, Maintenance, etc.).

2.2.2 User Privilege Levels - Privileges and passwords for all access levels.

2.2.2.1 Accessible displays and resources.

2.2.2.2 Available actions.

2.2.2.3 Password reset

2.2.3 Anti-Virus protection

2.2.4 System Recovery planning

2.3 Operator Console Alarm Management Guidelines.

Guidelines for the configuration of the alarm system shall include:

2.3.1 Alarm Priority Definitions used to determine the characteristics for

alarms which control:
 Alarm appearance
 Order of appearance
 Color of alarm windows
 Alarm Acknowledgment
 Horns
 Logging to printer

Page 10 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

2.3.1.1 Process Alarm Notification Methods - System actions when

alarm condition occurs.

2.3.1.2 Alarm Horns

2.3.1.2.1 Use of multi-tone horns (tone pitch and rhythm).

2.3.1.2.2 Horn acknowledgment.

2.3.1.3 Alarm Acknowledgment.

2.3.2 Alarm Grouping - For alarms with common characteristics such as

process/unit area, equipment, importance, point type, etc.

2.3.3 Alarm Displays

Guidelines for alarm displays shall address maximum number of alarms,

sorting, and message information.

2.3.3.1 Current Alarm Displays.

 Systems Alarms
 Process Alarms

2.3.3.2 Alarm History Displays.

2.3.4 Techniques for Alarm Flood Prevention.

2.4 Operator Console Graphic Display Guidelines.

2.4.1 Display Hierarchy

Guidelines shall be provided for the organization of and actions available

from the following:

2.4.1.1 Overview displays - Plant, area, unit, etc.

2.4.1.2 Process graphic operating displays.

2.4.1.3 Control displays.

2.4.1.4 Catalog displays (display listings).

2.4.1.5 Group displays.

2.4.1.6 Equipment detail displays.

Page 11 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

2.4.1.7 Advanced control application displays.

2.4.1.8 Equipment shutdown displays.

2.4.1.9 Data entry displays.

2.4.1.10 Motor interlock displays.

2.4.1.11 Fire and gas displays.

2.4.1.12 Trend displays.

2.4.2 Display Access and Navigation.

Guidelines shall be provided for accessing displays and navigating

among the displays using pulldown menus, targets on displays,
keyboards, etc.

2.4.3 Graphical Standards

Guidelines to be used for configuring graphical displays shall address all

features of the displays including colors, lines, text, data, and static and
dynamic elements.

2.4.3.1 Display Header - Information displayed, background and text

colors and size.

2.4.3.2 Static Graphic Elements - Process lines and shapes

representing process equipment.

2.4.3.2.1 Line widths.

2.4.3.2.2 Color codes.

2.4.3.3 Static Text

2.4.3.3.1 Color codes.

2.4.3.3.2 Use of, e.g., informational purposes.

2.4.3.3.3 Engineering units.

2.4.3.4 Dynamic Text - Numeric values, controller modes, permissive

character strings, alarm windows, etc.

2.4.3.4.1 Color coding - foreground and background.

Page 12 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

2.4.3.4.2 Numeric formatting.

2.4.3.4.3 Bad I/O and out-of-service representation.

2.4.3.5 Dynamic Graphic Elements - Symbols, shapes, bargraphs, and

lines that change color and/or shape based on changes in
process values and conditions.

Color codes - foreground/background/conditional.

2.4.3.6 Instrument Change Areas

2.4.3.6.1 Location on display.

2.4.3.6.2 Displayed attributes for all point types.

2.4.3.6.3 Changeable attributes for all point types.

2.4.4 Process Display Alarm Representation

Guidelines used to configure how alarms are shown on process displays

shall address the following:

2.4.4.1 Bad or out of service signal.

2.4.4.2 Foreground and background colors and use of blinking for:

 Emergency alarms
 Non-emergency alarms
 Unacknowledged alarm condition
 Acknowledged alarm condition
 Unacknowledged previous alarm condition

2.4.4.3 Discrete Alarms

2.4.4.3.1 Text - Message, color conventions, and blinking.

2.4.4.3.2 Equipment symbol color/shape changes.

2.4.4.4 LEL Alarms.

2.4.4.5 H2S Alarms.

Page 13 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

2.5 Faceplate Display

Guidelines to be used for configuring faceplate display shall address all features
of the displays including colors, visual and symbolic indications, text, data, and
control modes, and set point status.

3. Auxiliary System Interfaces

Guidelines shall be provided for configuration of databases that are used to interface
with applications that use the system data. These applications may include a host
computer, third party programs, data historian, SOE reporting, or any other application
that uses and/or modifies system data. The guidelines shall cover the following:

3.1 Database Content - Points and attributes.

3.2 Reporting Methods (periodic, by exception, etc.).

3.2.1 Analog Points

 Sample intervals
 Deadbands for report by exception

3.3.2 Digital Points.

3.3.3 Calculated Points.

4. Data Acquisition and Historization

Guidelines to be used for configuring Data Acquisition & Historization Systems

(DAHS) shall be provided. These guidelines shall include the following:

4.1 Data Collection

4.1.1 Points and attributes sampled.

4.1.2 Sampling Rates.

4.1.3 Retention Times.

4.1.4 Manual data entry.

4.1.5 Deadband settings for updates by exception.

4.1.6 Record format (Identifier, time stamp, etc.).

4.1.7 System Messages.

Page 14 of 15
Document Responsibility: Process Control Standards Committee SAEP-1626
Issue Date: 19 October 2017
Next Planned Update: 19 October 2020 Configuration and Graphics Guidelines

4.1.8 Alarms.

4.1.9 Operator Actions.

4.1.10 Hierarchy of files.

4.2 Data Reduction

4.2.1 Snapshots.

4.2.2 Averages (Hourly, shift, daily, etc.).

4.3 Organization of Data Files (By frequency, plant area, etc.).

4.4 Report Types (shift, daily, etc.)

The DAHS shall be configured to generate the following types of reports:

 Off simple plant/major equipment reports
 Off production status reports
 Shift reports

5. Logging Software Configuration Guidelines

Guidelines used to configure the logging software used to produce alarm and status
change logs and operator action logs shall be provided. The guidelines shall include:

5.1 Information contained in each message.

5.2 Time period for creating new message files.

5.3 Length of time message files are active after which they are archived.

5.4 Maximum number of message line that can be viewed on a report.

5.5 Maximum number of message lines to buffer when report destination is not
functioning.

6. Definitions

The guidelines shall contain a section listing definitions of terms, phrases, and
acronyms used in the document that are subject to interpretation. A simple translation
of an acronym is not sufficient unless the meaning of the translation is obvious.

7. Applicable Documents

This section lists all documents that are referenced within the guidelines.

Page 15 of 15