ESS Naming Convention

Karin Rathsman2013-05-22

Introduction

ESS Naming Convention

Naming Convention

Revision: 1.2

Status: Accepted Project: ESS Naming Convention

Document ID: ESS/AD/0005 File: ESS Naming Convention.doc

Owner: Garry Trahern Last modification: Maay 17, 2011

Created: October 26, 2010

ESS Naming ConventionThe ESS Naming Convention apply to all devices and signals in technical systems and conventional facilities.

• operator screens• inventory system• drawings • design schematics • computer software • project databases• equipment name tags • test procedures• other sources of technical

information at ESS.

History

ESS Naming Convention is based on a standard developed for the Super Superconducting Collider (SSC) and later adopted to other large research facilities: • Spallation Neutron Source (SNS)• Facility for Rare Isotope Beams (FRIB)• International Thermonuclear

Experimental Reactor (ITER)• Continuous Electron Beam Accelerator

Facility (CEBAF)

Syntax

SSSS SystemBBBB SubsystemDDDD Device IdentifierIII Device QuantifierTTT Signal typeIII Signal instanceXXX Signal Suffix

Device NameSignal Name

SSSS-BBBB:DDDD-III:TTTIIIXXX

MotivationMillions of signals to control and thousands of devices to operate:

• Short, meaningful and structured names needed for communication and configuration.

• Can’t rely on high level industrial HMI (barcodes, touch screens, etc.) to operate the facility.

• Industry standards for naming not applicable- Not human readable. - One of the kind facility.

A uniform naming convention for ESS will help enforce system integration activities across all divisions.

Act Proactively• Establish a naming convention at an early stage

of the project. • Assign a Naming Czar

- Form naming committee- Assure consistency- Coordinate - Update the naming convention document.

• Communicate, communicate and communicate...- Accelerator, Target, Neutron instruments, Conventional

Facilities, Utilities etc. • Develop a naming tool

- Collect requirements from stakeholders- Name support- Enforce syntax- Assure unique names

Guidelines

• Names shall be short, yet meaningful and organised consistently.

• Name structure does not need to follow WBS, PBS or other project management structures.- These are mainly for optimising design and

construction. - Device names should however be used to name

equipment in these structures.• Database integration is vital.

Devices

From the ICS point of view, all equipment is modeled as devices

DefinitionDevice is the basic unit of granularity of the ICS the smallest that can still be standalone and loosely coupled to other components.• Device is an abstraction that can

represent either single pieces of equipment (low level code for interfacing with the hardware) ...

• ...or higher-level entities of the ICS ( e.g., device models, subsystems, instruments...)

… and this is also a device

This is a device...

Devices Inside Devices Devices are not organised hierarchically through the naming convention. Example: • There are four cavities inside a cryomodule.

Both cryomodule and cavities are devices.The structure are found in other systems where the names are used.

HB-Res:Cav-01a

HB-Res:Cmd-01

HB-Res:Cav-01bHB-Res:Cav-01c

HB-Res:Cav-01d

Concurrent Conventions

Having parallel conventions for mnemonic names will inevitably cause confusion.

Identification codes

Devices at ESS will be assigned several identification codes in for example • Work break down structure (WBS),• Project break down structure (PBS) • Inventory • BSAB 96 codes (conventional facilities).

Restrictions

To avoid confusion equipment identification codes other than device and signal names must not• be mnemonic, i.e. it shall not contain

abbreviations or acronyms. • simulate the naming convention syntax.

Device names shall be used in other systems as attributes.

Device Category Structure

Expect thousands different kind of devices. Devices are categorised on three levels in the naming convention.

Level 1 – DisciplineBranch of knowledge that indicates the context in which a device is used, Example:• Vacuum (Vac)• Water Cooling (WtrC)• Cryogenics (Cryo)• Proton Beam Instrumentation (PBI)• Proton Beam Optics (PBO) • Controls (Ctrl)

Level 2 – Generic Device TypeTwo devices of the same generic type provide the same functionExample:• Pump (Pmp)• Controlled Valve (CV)• Temperature Sensor (TSn)

These are interdisciplinary devices of e.g. Vacuum, Cryogenics as well as Water Cooling.

Level 3 – Specific Device Type

Two devices of the same specific type are identical from a controls perspective and among others have the same set of control signals. • Configuration of a device in the top-

down approach is initiated by selecting the specific device type.

Device Identifiers

Naming convention users prefer to use generic device type (level 2) as device identifier DDDD in the names. Therefore:• Device names will be constructed using

the generic device identifier (Level 2).• Naming Convention users are still

responsible for selecting the correct specific device type (Level 3).

Area Breakdown Structure

Zones, buildings and sections shall be named and labelled after the technical systems so that device and signal names can be linked to physical location.

Level 1 – Super Section

High level zones and buildings such as• Accelerator• Target Station• Neutron Science • Utilities

Level 2 – Section13 Accelerator Sections:

• Ion Source (ISrc)• Low Energy Beam Transport (LEBT)• …. • Dump Line (DmpL)

16 Target Systems:• Monolith (Mnlt)• Active Handling (ActH)

Neutron Science InstrumentsUtilities Plants.

• Water Cooling Plant (WCP)• Cryo Plant (CP)

Level 3 – SubsectionAccelerator has numbered subsections e.g.,• First HB subsection (HB-01)• Thirties HB subsection (HB-30)

Target Station has 80 subsections in total, for example• Water purification system (ActF-WtrP)• Active gas storage (ActF-Gsg)

Utilities• High Beta Water Substation (WCP-HBWS) is

a subsection under the Water Cooling Plant.

Labelling

• Conventional facilities have agreed to label the structures according to the section-subsections.

• The numbering system used by CF as identifications for buildings, rooms and sections, is independent on the ESS Naming Convention.

Name Construction

All information needed to construct device names (except for the quantifier III)is contained in the device category and area breakdown structures.

Complication...Target and accelerator, are both complex systems and structurally very different.• Accelerator have many devices of

several disciplines in a repetitive pattern • Target has a large fraction of unique

equipment. Having managed to consistently name devices for both target and accelerator we are confident that other parts of the facility can be named using the same underlying structures and tools.

Target has a PBS organised in two levels referred to as• System-Subsystem by the target

devision.• Section-Subsection in the Area

Breakdown Structure Devices like pumps, valves etc., appear in many subsystems.There is no desire to use discipline in the name.

Target

Accelerator

There are many devices of the same kind in the accelerator in a repetitive pattern.• The accelerator is divided into sections

and numbered subsections • Each subsection contains many devices

of different disciplines.- Resonators, Vacuum, Beam Optics, etc..

BLM

QV BPM

BBX

BCMHalo

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPMHalo

BBX

WS NPM

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPMHalo

BBX

WS NPM

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPM

BBX

WS NPM

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPM

BBX

WS NPM

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPM

BBX

BSM

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPM

BBX

BSM

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPM

BBX

BSM

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPM

BBX

Halo

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPM

BBX

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPM

BBX

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPM

BBX

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPM

BBX

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPM

BBX

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

QV BPM

BBX

BLM

BPM QH

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

BLM

GV

CMD

CAVH CAVH CAVH CAVHGV

HB-03! HB-04!HB-01! HB-02!

HB-07! HB-08!HB-05! HB-06!

HB-23! HB-24!HB-21! HB-22!

HB-15! HB-16!HB-13! HB-14!

HB-19! HB-20!HB-17! HB-18!

HB-11! HB-12!HB-09! HB-10!

HB-27! HB-28!HB-25! HB-26!

HB-29! HB-30!

Accelerator Section-Subsection

Two types of sectionsAccelerator and Target divisions agree to use • section names as systems names SSSS• generic device type as device identifier DDDD.

Therefore, systems SSSS (sections) are assigned either as • Accelerator type (A-type) • Target-type (T-type)

with different methods to construct names

Naming ProcessDevice Category Structure

Level 1Level 2

Level 3

Area Breakdown Structure

Level 3Level 2

Level 1

Name Components

Tools Rules

Name Components

System SSSS • Section convention name

Subsystem BBBB• T-type: Subsection convention name• A-type: Discipline convention Name

Generic Device Identifier DDDD • Generic device identifier

Device Quantifier III • T-type: Alphanumeric characters• A-type: Subsection number immediately followed by

alphabetic numbering (a, b, c or d etc.)

Tools

Web-based tools are under development to support the process of naming devices. Use-cases are being studied to collect requirements, e.g., filtering and sorting capabilities, as well as automated name generation.

Name IntegrityTo assure integrity of names the naming convention users will be asked to select1.device type from the three level device

category structure 2.subsection from the three level area

break down structure Device names are generated automatically, except for quantifier. User do not need to keep track of whether a device name is generated as A or T-type

Selection tool

Users should not have to be informed in detail on definitions of section, subsection, discipline or the distinction between generic and specific device types.• Ask explicitly: Which part of the facility

does the device provide services to?- Do NOT ask: Where is the device located?

• The answer shall be selected from a menu type list.

<Select><Select><Select>

Controls Ctrl ▶

Conventional Facilities CF ▶

Cryogenics Cryo ▶

Proton Beam Instrumentation PBI ▶

Proton Beam Optics PBO ▶

Resonators Res ▶

Vacuum Vac ▶

Water Cooling WtrC ▶ Control Valve CV ▶ Gate Valve GV

Pressure Safety Valve PSV ▶

Isolation Safety Valve ISV ▶

Manual Valves STn ▶

Limit Switch LSw ▶

In Device Naming Tool Select device type:

Specific Type

Discipline

Generic Type Device Identifier

Convention Name

In the Device Naming Tool

<Select><Select>

Accelerator ▶

Target Station ▶

Neutron Instruments ▶

Utilities ▶ Cryogenics Plant CrP ▶

Water Cooling Plant WCP ▶ Central Utilities Water Station CUWS

Compressed Air Plant CAP ▶ Low Beta Water Station LBWS

Medium Beta Water Station MBWS

High Beta Water Station HBWS

Target Water Station TWS

Neutron Instruments Water Station NIWS

HEBT Etcetera Water Station HEWS

External Customers Water Station ECWS

Compressed Air Water Station CAWS

Which part of the facility does the device provide service to?

Section

Subsection

Super Section

Convention nameConvention name

General rules for namesThe naming tools shall ensure the following rules to be fulfilled.1.Convention names for section, subsection,

discipline, generic device type and signal part of names shall be alphanumeric.

2.First character of convention names for section, T-type subsection, discipline, generic device type and signal part of names as well as quantifier for A-type devices shall be alphabetic.

3.Convention name for A-type subsection shall be numeric.

General rules for names (cont)4. Convention names for section, discipline, device

name and signal name shall be unique irrespective of1. Letter case2. Letters I, l and number 13. Letter O and number 04. Letters V and W5. Leading zeros, i.e., number 0 immediately following a non-

numerical character5. Convention names for subsection and generic

device type shall be unique according to rule number 4, however only within the same section and discipline, respectively.

6. Leading zeros shall be used to ensure that all numbers have the same number of digits.

”Those are my principles. If you don’t like them I have others.”

Groucho Marx

The End