Handout Standardization Template - Basic Project NFPA, inch

EPLAN Engineering Standard

Document: [EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx
Author: EPLAN Professional Services - EES
Version: 01
Date 25.04.2022
EPLAN Engineering Standard
Document information

Content
1 Document information ........................................................................................................................ 3
1.1 History ........................................................................................................................................ 3
1.2 Reading notes............................................................................................................................ 3
2 What is a basic project ....................................................................................................................... 4
2.1 Relevant data and settings ........................................................................................................ 4
3 Use of a basic project ......................................................................................................................... 5
3.1 Option A: Without page content / Neutral basic project version ................................................ 5
3.2 Option B: With page content / Project-related basic project version ......................................... 5
4 Information about "[EES]_Basic_Project_NFPA_inch_2022" ............................................................ 6
4.1 Introduction ................................................................................................................................ 6
4.2 Naming convention .................................................................................................................... 6
4.3 Languages / Translation ............................................................................................................ 7
4.4 Project properties - Structure..................................................................................................... 8
4.5 Project settings .......................................................................................................................... 9
4.6 Structure identifier.................................................................................................................... 11
4.7 Default plot frame .................................................................................................................... 12
4.8 Reports (Reports templates) ................................................................................................... 13
4.9 Check run ................................................................................................................................ 14
4.10 Layers ...................................................................................................................................... 15
5 Additional information ....................................................................................................................... 16
5.1 File format ................................................................................................................................ 16
5.2 Store basic project in master data ........................................................................................... 16
5.2.1 Additional data stored in the project .................................................................................... 17
5.2.2 Tips and tricks ...................................................................................................................... 18
6 Basic project online help .................................................................................................................. 19
7 Glossary ........................................................................................................................................... 19

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 2/19

EPLAN Engineering Standard
Document information

1 Document information
1.1 History
Date Author Description
2022-04-25 EES-Team, TAL Checked, V01

1.2 Reading notes

Before you start reading, please note the following symbols and notations used in this document:

Attention
Texts introduced by this graphic are warnings. You should definitely read these notes
before you continue editing!

Note
Texts introduced by this graphic contain additional notes.

Tip
Behind this graphic you will find useful tips that will make it easier for you to use the
program.

Example
Examples are introduced by this graphic.

 Elements of the user interface are marked in blue and can thus be found immediately in the text.
 Bold highlighted texts show what is important and what you should definitely pay attention to.
 Function keys, keys of the keyboard as well as buttons within the program are shown in square
brackets (like [F1] for the function key "F1").
 To improve the reading flow, a so-called "command path" is often used (e.g. Tab Tools >
Command group Evaluations > Command Generate ). The commands and options listed in the
command path must be selected in the specified order to locate a particular program function.

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 3/19

EPLAN Engineering Standard
What is a basic project

2 What is a basic project

The term "basic project" means a template for new projects. In this project all relevant data for the
project creation are stored and transferred to a new project.

2.1 Relevant data and settings

(Definitions) of a basic project:
 All project settings
 Project settings are the settings under File > Settings > Projects > "Project
name XYZ". This includes e.g.: also all schemes for the page and resource
structure, PLC numbering schemes, etc.
 All project data
 Project structures
 Project properties
 Work breakdown structure identifiers
 Layer settings as well as property arrangements
 Color and textual representations deposited for the project
 Company-specified arrangements of labels on equipment or symbols
 All custom pages
 All pages that are in the basic project are taken over
 Master data
 Master data stored in the project, such as forms, standard sheets and symbols
 Stored third-party documents and image files
 Stored foreign documents and image files are data that have been copied
directly during linking
 Referenced data
 When the basic project is created, all referenced data is stored in the project.
Referenced data, is data that is linked to the project, e.g. via a hyperlink, but is
not contained in the project. This includes third-party documents,
accompanying documents as well as image files.

Note
The basic project serves as a template and evolves throughout the engineering cycle.

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 4/19

EPLAN Engineering Standard
Use of a basic project

3 Use of a basic project

3.1 Option A: Without page content / Neutral basic project version
Basically, it is recommended to create a basic project without page content.
The basic project without defined content contains all current and necessary basic settings, but no page
content. The pages and page contents are added project-specifically from the library and integrated into
the project.

3.2 Option B: With page content / Project-related basic project version

As described in option A, the basic project contains all current and necessary content. However, it can
also be advantageous to include various pages in the project.

Attention
When using multiple base templates with defined content, each basic project must be
maintained individually!

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 5/19

EPLAN Engineering Standard
Information about "[EES]_Basic_Project_NFPA_inch_2022"

4 Information about
"[EES]_Basic_Project_NFPA_inch_2022"
4.1 Introduction
The provided Basic project was created especially for engineering tasks to create circuit diagrams
according to the current NFPA standards. The unit of measurement "inch" is preset in this case.
Predefined Structure identifiers have also been added, based on the currently valid standards, which
can be used directly to structure the circuit diagram. In addition, you will receive a predefined selection
of reports when you generate project reports.
In the following points you will find further important details and information about the EPLAN
Engineering Standard Basic project for NFPA, inch.

4.2 Naming convention

The basic project was named using a predefined naming convention. The following syntax was used
and is recommended:
[<Company ID>]_<Description>_<EPLAN version number>.zw9
An e.g. version number can be added at the end if required.
[<Company ID>]_<Description>_<EPLAN version number>_<Version number>.zw9

Example
Without versioning: [EES]_Basic_Project_NFPA_inch_2022.elk
With versioning: [EES]_ Basic_Project_NFPA_inch_2022_V02.elk

Note
The basic project is version-related and therefore not downward compatible, e.g. to
EPLAN platform version 2.9.

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 6/19

EPLAN Engineering Standard
Information about "[EES]_Basic_Project_NFPA_inch_2022"

4.3 Languages / Translation

The prepared EPLAN Engineering Standard Basic project is set to multilingual for 18 languages. With
this setting you have the possibility to edit the project in the desired language, which are set in the
project.
Using the translation and display languages, you determine into which languages the project is
translated and which languages are visible.
Project texts that are already translated will not be translated again! Unless you uncheck the checkbox
at Change translated texts.
File > Settings > Project > "Project name YXZ" > Translation > General

Note
You have the option of exporting project texts that EPLAN was unable to translate as a
missing-word list. These project texts can then be retranslated into one or more
languages outside of EPLAN and imported again.

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 7/19

EPLAN Engineering Standard
Information about "[EES]_Basic_Project_NFPA_inch_2022"

4.4 Project properties - Structure

Here you will learn how the project structure is preset. These can be optimized if desired.
In EPLAN, "project structure" means the summary of all labeling structures for pages and devices used
in the project.
The project structuring is preset to:
 Pages: Location designation (+) and Document type (&).
 Operating equipment such as rail systems or mechanical components: Location designation (+)
 Interruption points: Sequential numbering
This structuring enables a "Location-oriented circuit diagram creation". Reports such as Bill of Materials
can be output filtered by location designation (+).
The scope and type of structuring can be customized to your needs.
File > Information > Project properties command group > Structure

Note
Project structures will accompany you throughout the engineering process. Therefore, this
should be thoroughly defined before the start.

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 8/19

EPLAN Engineering Standard
Information about "[EES]_Basic_Project_NFPA_inch_2022"

4.5 Project settings

The EPLAN Engineering Standard was applied accordingly here and contains a certain selection of
predefined settings such as the numbering of devices according to commonly used North American
practice of Page, Row and Device Identifier (see figure). This ensures that a device identification
structure as described in NFPA 79 Annex D is available for use in EPLAN.
All settings can be adjusted if desired and serve as a basis for further optimization.
File > Settings > Projects > "Project name XYZ"

Here are some examples of a piece of equipment, with corresponding application of this setting for the
device tag (DT).

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 9/19

EPLAN Engineering Standard
Information about "[EES]_Basic_Project_NFPA_inch_2022"

Note
The DT structure can be adjusted to reflect your preferred nomenclature, but this is at
your discretion!

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 10/19

EPLAN Engineering Standard
Information about "[EES]_Basic_Project_NFPA_inch_2022"

4.6 Structure identifier

The basic project provided already contains predefined structure identifiers such as the document type
based on the currently valid standard.
Tools tab > Management command group > Structure identifiers

Tip
Use the predefined structures when creating new pages.

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 11/19

EPLAN Engineering Standard
Information about "[EES]_Basic_Project_NFPA_inch_2022"

4.7 Default plot frame

There are three Plot Frames provided with the Basic Project, the default plot frame has no columns or
rows and is used for all reports, such as the Title Page and Table of Contents. The other Plot Frames
provided have one or two ladders with 20 numbered rows per ladder (the two ladder Plot Frame is
shown below). The provided plot frames have been extended with important information which serves
for better orientation in the circuit diagram and provides extended information.
File > Settings > Projects > "Project name XYZ" > Management > Pages > Standard plot frame

So-called help lines have been added to the standard sheet for better orientation. These are
used for optimized placement and alignment of devices and e.g. function texts in the circuit
diagram.

Note
The supplied plot frames can be adapted to your needs.

Tip
You can display the help lines with the [U] (Show / hide invisible elements) key on
your keyboard.

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 12/19

EPLAN Engineering Standard
Information about "[EES]_Basic_Project_NFPA_inch_2022"

4.8 Reports (Reports templates)

Here you get information which reports (report templates) are preset. These can be optimized if
desired.
A selection of reports has been made that meet a minimum requirement for additional documents.
These are:
 Title page /cover sheet, table of contents, structure identifier overview
 Summarized parts list, table of contents, terminal diagram, terminal-strip overview, cable
diagram, cable overview
Tools tab > Reports command group > Generate…

> Templates tab

Note
If the project does not contain the objects needed for the respective report, no reports
page will be generated.

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 13/19

EPLAN Engineering Standard
Information about "[EES]_Basic_Project_NFPA_inch_2022"

4.9 Check run

Here you can get information about which check runs are available to check your project.
You have the choice of 3 prepared check runs, which allow to increase the "projecting quality".

 Option 1, scheme: [EES] Basic (Check’s basics like DT syntax and function/devices for
completeness)
 Option 2, scheme: [EES] Advanced (fundamentals met, with increase in quality. Here,
connections, terminals, connectors and cables are carefully checked).
 Option 3, scheme: [EES] Expert (basics fulfilled, with extended quality and additional notes.
For this, the additional message text is supplemented to support the user in the creation of the
3D digital twin, as well as exchange of the PLC data).

Check project:
Tools tab > Review command group > Check
View check result (message management):
Tools tab > Review command group > Messages

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 14/19

EPLAN Engineering Standard
Information about "[EES]_Basic_Project_NFPA_inch_2022"

4.10 Layers
All elements are allocated to different layers in EPLAN. This affects simple graphical elements as well
as symbol graphics, autoconnecting lines, property placements, special text and other text elements. In
the layer management, settings can be made for each layer defining whether it is to be displayed and/or
printed, whether the text on this layer should be surrounded by a border, and whether the elements
assigned to this layer can be edited.
The EPLAN project has been extended with additional layers to control specific settings via layer
management.
These layers have been created under specifically "[EES]...". The naming convention was also
applied here, starting with the customer identifier.
If it is necessary to create your own layers in order to use them, this method of creating your own layers
is recommended. This way it is ensured that no EPLAN standard layers are mixed with user-defined
layers, see screenshot.
Tools tab > Management command group > Layers

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 15/19

EPLAN Engineering Standard
Additional information

5 Additional information
5.1 File format
The file format is a *.zw9. This file is an EPLAN Zip archive in which all necessary data for the basic
project are stored.

5.2 Store basic project in master data

The provided basic project is ideally stored in the respective master data directory:
...\Templates\<Customer ID>

Should you now create a new project, you will have direct access to all basic projects that exist in your
master data.
File tab > New...

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 16/19

EPLAN Engineering Standard
Additional information

5.2.1 Additional data stored in the project

Workflow
Useful data, filters or schemes have been stored directly in the project. The data are in
the EPLAN file directory, in the respective project folder, under the DOC directory. These
can be easily imported into the EPLAN Platform via navigators or similar and are thus
directly available.

Example: Filter for Connections navigator - prepared for EPLAN Pro Panel, routing
...\Projects\<customer identifier>\<project name xyz>.edb\DOC\EPLAN Engineering Standard\...

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 17/19

EPLAN Engineering Standard
Additional information

5.2.2 Tips and tricks

Workflow
If you update or modify this basic project, the last basic project can be moved to a backup
folder in the EPLAN file directory. This ensures that you always work with the current
version of the basic project.

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 18/19

EPLAN Engineering Standard
Basic project online help

6 Basic project online help

https://www.eplan.help (Direct link to the basic project topic)

7 Glossary

Basic project ............................................................ 4 Project-related basic project version........................ 5

Naming convention .................................................. 6 Store basic project in master data ......................... 15
Neutral basic project version ................................... 5

[EES]_Standardization_Template_Basic_project_NFPA_inch_Handout_EN.docx / 01 / 25.04.2022 19/19