Engineering Workbench

Concepts Guide

*B0850AU* *G*

B0850AU

Rev G
September 09, 2016
Invensys, Foxboro Evo, InFusion, Triconex, and TriStation are trademarks of Schneider Electric SE, its
subsidiaries, and affiliates.
All other brand names may be trademarks of their respective owners.

Copyright 2016 Invensys Systems, Inc.

All rights reserved.

Invensys is now part of Schneider Electric.

SOFTWARE LICENSE AND COPYRIGHT INFORMATION

Before using the Invensys Systems, Inc. supplied software supported by this documentation, you
should read and understand the following information concerning copyrighted software.
1. The license provisions in the software license for your system govern your obligations
and usage rights to the software described in this documentation. If any portion of
those license provisions is violated, Invensys Systems, Inc. will no longer provide you
with support services and assumes no further responsibilities for your system or its
operation.
2. All software issued by Invensys Systems, Inc. and copies of the software that you are
specifically permitted to make, are protected in accordance with Federal copyright
laws. It is illegal to make copies of any software media provided to you by
Invensys Systems, Inc. for any purpose other than those purposes mentioned in the
software license.
Contents
Preface................................................................................................................................... ix

1. Understanding Workbench Concepts................................................................................ 1

IPS Database ................................................................................................................... 1
Web Server ...................................................................................................................... 1
File Server ........................................................................................................................ 1
Plant Breakdown Structure (PBS) .................................................................................... 2
WorkSpace ...................................................................................................................... 3
Macro Loop ..................................................................................................................... 3
Instrument Index ............................................................................................................. 5
Field Wiring Index .......................................................................................................... 6
Project Information Database .......................................................................................... 6
WiringTypical ................................................................................................................. 7
CabinetProfile ................................................................................................................. 7
Inter System Communication List ................................................................................... 7
Device Template ............................................................................................................. 7
Macro Template .............................................................................................................. 8
MapSet .......................................................................................................................... 10
Workflow/Workgroups/Worklets .................................................................................. 10
Elements / Attributes /References .................................................................................. 11
TriStation 1131 ............................................................................................................. 12
Multi-ended Cable ........................................................................................................ 14
Additional Hardware Part .............................................................................................. 15

2. Working with Engineering Workbench........................................................................... 19

Checkout and Release Checkout .................................................................................... 19
Locks ............................................................................................................................. 19
Local Cache ................................................................................................................... 19
Commit / Save .............................................................................................................. 20
Change/Version Management ....................................................................................... 20
Data Views .................................................................................................................... 20

Index .................................................................................................................................... 21

iii
B0850AU Rev G Contents

iv
Figures
1-1. Network Configuration Diagram .................................................................................. 2
1-2. PBS Hierarchical Structure ............................................................................................ 2
1-3. An Example of Macro Loop .......................................................................................... 4
1-4. WiringTypical Diagram ................................................................................................ 7
1-5. An Example of a Macro Template for Control .............................................................. 9
1-6. An Example of a Macro Template for Safety ............................................................... 10
1-7. Relationship Diagram - Workflow, Workgroup, and Worklet ..................................... 11
1-8. Sheet Name ................................................................................................................. 12
1-9. Device Template Layout ............................................................................................. 13
1-10. Single Connector Cable in Control ............................................................................. 14
1-11. Single Connector Cable in Safety ................................................................................ 14
1-12. Multi-ended Cable in Control ..................................................................................... 15
1-13. Multi-ended Cable in Safety ........................................................................................ 15
1-14. Configuring an Additional Hardware Part in the Wiring Typical in Safety ................. 16
1-15. Configuring an Additional Hardware Part in the Wiring Typical in Control .............. 16
1-16. Configuring an Additional Hardware Part in Worklet 4.3.5 ....................................... 17

v
B0850AU Rev G Figures

vi
Tables
1-1. Signals for Loop Name .................................................................................................. 4
1-2. Macro Loop Name ........................................................................................................ 5
1-3. Mandatory Fields for Instrument Index ......................................................................... 5
1-4. Mandatory Fields For Field Wiring Index ..................................................................... 6

vii
B0850AU Rev G Tables

viii
Preface
Engineering Workbench (EW) is an integrated set of tools for building industrial automation
systems at the device loop level. Designed by project engineers, Workbench automates the key
tasks engineers perform to develop projects.
Workbench applies a set of rules to engineering standards and client-supplied data to produce
outputs according to a defined work process. Workbench provides the tools to:
Generate the control database for Foxboro Evo systems
Generate device logic for Triconex systems
Generate cabinet build data for control and safety
Integrate control and safety logic
Generate palette graphics for InTouch and FoxView

About this Guide

This guide provides detailed descriptions of the key concepts and terms used in the EW software
and documentation. This guide also describes common features and operations you'll use while
working in EW.

Audience
This document is particularly important for users who are new to EW. It is also an excellent
reference document for:
Administrators
Lead Engineers
Project Engineers

Acronyms
The following acronyms are used in this document:

CE Cause and Effect

CEE Cause and Effect Editor in Workbench

ETP External Termination Panel

EW Engineering Workbench

FBD Functional Block Diagram

FBM Field Bus Module

FET Field External Termination

ix
B0850AU Rev G Preface

GV Global Variables

IO or I/O Input Output or Input/Output

IPS Invensys Process Systems

P&ID Piping and Instrumentation Diagram

PBS Plant Breakdown Structure

PIDB Project Information Database

TA Terminal Assembly

XML Extensible Markup Language

Reference Documents
The following documents provide additional information:
Engineering Workbench Functional Guide (B0850AV)
Engineering Workbench Rules Reference Guide (B0850AW)
Engineering Workbench Field Guide (B0850BB)
Engineering Workbench Installation Guide (B0850AX)
Engineering Workbench Administrators Guide (B0850AY)
Engineering Workbench Report Add-in Guide (B0850BA)
Supported Parts List Control 4.0.0 and Supported Parts List Safety 4.0.0 (B0850BC)
For the latest revisions of the documents, visit the Global Customer Support (GCS) website at
https://support.ips.invensys.com.

Revision History
For this revision of this document, the following changes were made:
Global
Updated the Preface
Added Chapter 2 Working with Engineering Workbench and moved information
about working with Workbench into this chapter
Chapter 1 Understanding Workbench Concepts
Added Multi-ended Cable on page 14
Added Additional Hardware Part on page 15

x
1. Understanding Workbench
Concepts
This chapter describes key Engineering Workbench concepts.

IPS Database
The Invensys Process Systems (IPS) Database is a centralized database for a project and is located
in the database server. It hosts Microsoft SQL Server 2012 database instances. The administra-
tor creates one database per project. This database contains client data, templates, control and
safety databases, and rules for a particular project. A Commit operation done on the project by
anyone with the required privileges saves the data into this database. All data committed to this
database is versioned. These versions are accessible to other users in the project. View versions of
all data in the Data Views tab. See Data Views on page 20.

Web Server
The Web Server hosts the Web application and stores the default data uploaded by the adminis-
trator. For more information about the Web Server, see the Engineering Workbench Administrators
Guide (B0850AY).

File Server
The file server stores various files required by the system to generate configuration information. It
hosts services that
Generate the control and safety software xml when you execute the generate XML
worklet (Worklet 5.2.2 Generate Control data for Download in Control and Worklet
6.1.3 Generate XML file in Safety)
Transform the customer data and templates for both control and safety into a format
supported by Workbench
The File Server also acts as a repository for customer data that is imported through the Instrument
Index and Wiring Index. It serves as a centralized cache for all intermediate storage needs.
The equipment architecture diagram of the Web and File servers and the Invensys Process Systems
database (IPSDB) as shown in Figure 1-1.

1
B0850AU Rev G 1. Understanding Workbench Concepts

Figure 1-1. Network Configuration Diagram

Plant Breakdown Structure (PBS)

The Plant Breakdown Structure (PBS) describes the subdivision of the project into different
systems and sub-systems. This division allows multiple engineers to work on a project, based on
the WorkSpace assigned.
The Project is divided into Plants, Areas, Units, Equipment, and Loops. This division is done by
the client and is used for allocating WorkSpace to the engineers.
The PBS identifies, selects, and works with different collections of tags within Workbench. Tag
Name remains unique throughout the Plant. The PBS describes the subdivision of the project
into Plant, Area, Unit, and Equipment (Figure 1-2).

Figure 1-2. PBS Hierarchical Structure

The PBS information is obtained from the clients Instrument Index.

2
1. Understanding Workbench Concepts B0850AU Rev G

Tag Name always remains unique in a Plant.

In PBS hierarchy, levels are defined as follows:
Plant
Can have many Areas
Area
Can have many Units
All tags in an area must belong to the same Plant
Unit
Can have many Equipment or Loops
All tags in a Unit must belong to the same Area and Plant
Equipment (Optional)
Can have many Loops
All tags in an Equipment must belong to the same Unit, Area, and Plant
Loops
Can have many tags
All tags in a Loop must belong to the same Equipment (optional) Unit, Area, and
Plant

NOTE
You can import only one PBS scope at a time.

WorkSpace
A WorkSpace is a subset of the Instrument Index that is assigned to a project engineer. An
engineers WorkSpace is assigned by the lead engineer based on plants, areas, or units. A
WorkSpace generates the software or hardware Architecture Data. An engineer can be assigned
single or multiple areas; single or multiple units from the same area or different areas. WorkSpaces
are very useful for large projects where the work can be divided among multiple engineers.
In the WorkSpace allocated to an engineer, the engineer can select a level for building the data-
base. For a system type selected, levels can be one of the following:
Application Engineering
Hardware Engineering
Wiring Engineering
When assigning WorkSpaces, you can define the areas/locations pertaining to the system (control
or Safety) that you have imported.

Macro Loop
A Macro Loop is a collection of Tags derived from the Loop ID information in the Instrument
Index, and this collection is either created by Workbench or imported into Workbench. Macro
Loop is a set of Tags that are functionally related and processed by a single type of template (for
example, all the signals to be processed in the controller by a Strategy or Device Template must be

3
B0850AU Rev G 1. Understanding Workbench Concepts

in the same Macro Loop). You can configure grouping of collection of Tags into a Macro Loop by
using rules.
The Instrument Index data that is received from the client contains an entry for each input and
output signal. In addition to a Tag Name, each signal has a loop name and some of these signals
have the same loop name if they are directly related.

Figure 1-3. An Example of Macro Loop

Table 1-1 represents the signals from the Piping and Instrumentation Diagram (P&ID) extract
from Figure 1-3.

Table 1-1. Signals for Loop Name

Tag Name Loop Name Signal Type

TT111 101-TT-111 AI
FT122 101-F-122 AI
FV122 101-F-122 AO

From the above example, it can be seen that TT111 is the only tag in loop 101-TT-111 but
FT122 and FV122 share a loop name, as they are both part of a regulatory control loop. These
two loops are related to TT111, which is the measured value for the master controller of a cascade
loop.
To build this cascade loop, we should relate the two loops, so that the entire loop can be built
from a cascade Controller Template. However, from the Instrument Index alone, you cannot tell
that the loops are related. Here we use the Macro Loop concept, where we assign a Macro Loop
name to all the signals in both the loops. In this example, to control temperature, base the Macro
Loop name on the master loop name as shown in Table 1-2.

4
1. Understanding Workbench Concepts B0850AU Rev G

Table 1-2. Macro Loop Name

Tag Name Loop Name Macro Loop Name Signal Type

TT111 101-TT-111 101-TIC-111 AI
FT122 101-F-122 101-TIC-111 AI
FV122 101-F-122 101-TIC-111 AO

The simplest Macro Loop represents a single loop and the simplest loop may contain a single tag.
Therefore the simplest Macro Loop may contain only a single tag.
In majority of the cases, the loop already defines the signals that are functionally related, so a
default rule within Workbench copies the loop name of each tag into its Macro Loop name field
and replace the illegal characters if any. A facility is then provided in one of the data views win-
dows to manually modify the Macro Loop name of associated loops. To determine which loops
are associated, you must work through your P&IDs and capture details of all related loops in
Workbench.

Instrument Index
The Instrument Index is the Input Output (IO) database that contains the information on tags
with their attributes and the division of these tags on the basis of areas, units, equipment, and
loops. It contains details of tags and their attributes such as Signal Type, Voltage Level, and Alarm
information. The Instrument Index is supplied by the client and is used to configure the software
application.
Workbench supports Instrument Index in the following formats:
Microsoft Excel format (XLS and XLSX)
Microsoft Access format (MDB and ACCDB)
CSV
When you have the file containing the client's Instrument Index, you must:
Import it to Workbench using the Select Client Data functionality and commit
the imported data
Map the fields to attributes of the Tag element in Workbench
Load the Instrument Index (or part of it) into Workbench
Compare it with any previous version so that you know what has changed
Run a set of validation rules on the tag data

Table 1-3. Mandatory Fields for Instrument Index

Maps Project Data Columns Description

TagName Input/Output tag name
SignalType Supported signal types include AI, AO, DI, DO, Fieldbus,
FF, HARTAI, HARTAO, RTD, SI, TC, and Profibus
Plant Plant name. Used in PBS
Area Area within the plant. Used in PBS

5
B0850AU Rev G 1. Understanding Workbench Concepts

Table 1-3. Mandatory Fields for Instrument Index (Continued)

Maps Project Data Columns Description

Unit Unit within an area. Used in PBS
LoopName Loop name of I/O Tag

Field Wiring Index

The Field Wiring Index contains the wiring details of tags in the plant. Information such as the
cable color and signal type are provided in this Excel sheet. This data is also supplied by the client.

Table 1-4. Mandatory Fields For Field Wiring Index

Maps Project Data Columns Description

Plant Plant name. Used in PBS
Area Area within the plant. Used in PBS
Unit Unit within an area. Used in PBS
Landing Location Location of the Multicore cable plug
SignalType Supported signal types include AI, AO, DI, DO, Fieldbus,
FF, HARTAI, HARTAO, RTD, SI, TC, and Profibus
WireTag1 Input/Output tag name

Project Information Database

The Project Information Database (PIDB) architects the Network layer, Control layer, and Mar-
shalling layer.
Project Information Database consists of the following information:
Data from Buy Automation
Network Details
Engineers using Workbench provide the following details in PIDB:
Distance between locations
I/O counts
Third party system quantities
PIDB gives you a topographical view of control system, safety system, and other systems of the
plant. This feature allows you to create locations for safety and control systems in a project. You
can also create locations to integrate a third party system.
You have an option to assign properties to the locations created. These properties can be imported
to the locations added. Categories can be added to the components of the systems that are added
to a particular location. Categories include software packages/applications/licenses, software
media, and cabinet/enclosures.
PIDB gives you a quick overview of all the locations, systems, their properties, and the categories
added under each systems components of a project.

6
1. Understanding Workbench Concepts B0850AU Rev G

WiringTypical
A Wiring Typical is a template that defines the tag wiring connection from the Marshalling cabi-
net to the System cabinet across the hardware components associated with a tag. The WiringTyp-
ical defines the connections between the components using the wires inside the cabinets and
cables across the cabinets. Thus, it describes the wiring details of the different components in a
Marshalling cabinet. Each typical is defined based on the signatures like signal type and tag
match.
WiringTypical is a template that consists of the following information:
Wiring a particular type of I/O to the system
Components involved in wiring an I/O to the system
Interconnections between components such as Terminal Block, Termination Assem-
bly, Relay, and Barrier

Figure 1-4. WiringTypical Diagram

Figure 1-4 represents a WiringTypical diagram, where the wiring details of Field, Marshalling
Cabinet, System Cable, and System Cabinets are depicted.

CabinetProfile
A CabinetProfile is a template that defines the different components of a cabinet and their proper-
ties. These profiles instantiate cabinets in a project. Most of the profiles are predefined and cannot
be modified, but you can customize certain profiles. These profiles are stored in Extensible
Markup Language (XML) format.

Inter System Communication List

The Inter System Communication list is generated as a part of control and safety integration. This
list is used for communication between the safety Global Variables and the control blocks.
The Inter System communication list is generated in the safety workflow and contains the infor-
mation of the Global Variable groups and their Packing/Unpacking along with the point informa-
tion. It also contains Device Instance ID, Device Template name, AliasNumber, Global Variable
name, Global Variable Instance name, Alias Type, Alias Category, Data Type, Plant, Area, Unit,
and Location.

Device Template
A Device Template is a collection of Functional Block Diagram (FBD) elements (Function Block,
Function, Global Variable, Local Variable, Constant, and Comment) on a sheet. This sheet
defines a part of the safety application logic and is used as a template to build safety applications
in the FBD language. A Device Template is always bound by network dividers or sheet boundaries
that define the dimensions (in sheet units only) of a Device Template.

7
B0850AU Rev G 1. Understanding Workbench Concepts

A Device Template is always defined by the following:

The template should not contain any duplicated tags or constants (all the tags and the
constants names should be unique).
TriStation 1131 FBD logic defined on a sheet.
There will only be one template per sheet.
If the template is smaller than the sheet then use network dividers to set the template
boundary.
If the template is the width or height of a sheet then the sheet boundary will be used
as the template boundary.
Bounded by network dividers or sheet boundaries.
Sheet title always shows a Device Template name.
All the Comments in a Device Template that are enclosed inside '[]' square brackets
will be configured by rules.
All the Comments in a Device Template that have text enclosed inside '[[]]' double
square brackets, will be ignored by rules, and is not part of generated TS1131 data.
All the Comments in a Device Template that have text not enclosed inside '[]' square
brackets or '[[]]' double square brackets, will be ignored by rules.
Every Device Template should have one comment with the text
[INSTANCE_COMMENT] configured by rules to identify the Device Template
when instantiated.
Every Device Template should start (anchor position) from sheet (0,0) co-ordinates
(top left corner).
All user-defined Function Blocks, Functions, and Data Types that are used in the
Device Template must be defined in a user-created library in the TriStation 1131
software.
All unreferenced Global Variables (tagnames) should be deleted from the TriStation
1131 project that you use to create the XML file.

Macro Template
A Macro Template processes collections of signals called a macro loop. See Macro Loop on
page 3. Workbench uses Macro Templates as the basis for building the functionality required to
process signals and loops.
The smaller templates that make up Macro Templates are the building blocks for the automati-
cally generated data for safety and control systems. They are:
Basic Strategy Templates (a collection of blocks) for Foxboro Evo Control Editors
Basic Device Templates (a single FBD network) for the TriStation 1131 software
To provide the functionality to process a simple loop, only one basic template may be necessary
for the Macro Template. To provide the necessary functionality to process complex loops several
basic templates will be required. Macro Templates provide the mechanism to combine several
basic templates into one complex template, so that we can support the complex loops.
The simplest Macro Template contains only one basic template.

8
1. Understanding Workbench Concepts B0850AU Rev G

Control
A Macro Template for control is defined in Control Editors as a Control Editors Strategy. This
Macro Template strategy can contain basic templates such as the I/O processing templates, motor
control templates, and valve templates. Figure 1-5 represents a Macro Template diagram for con-
trol system.

Figure 1-5. An Example of a Macro Template for Control

In the example in Figure 1-5, TT111 is the only tag in loop 101-TT-111, but FT122 and FV122
share a loop name since they are both part of a regulatory control loop. These two loops are
related to TT111, which is the measured value for the master controller of a cascade loop.

Safety
A Macro Template for safety is defined as a logical collection of one or more Device Templates
(FBD networks). Examples are basic templates such as analog input logic, valve logic, and voting
blocks as shown in Figure 1-6.

9
B0850AU Rev G 1. Understanding Workbench Concepts

Figure 1-6. An Example of a Macro Template for Safety

NOTE
For Safety, the most common Workbench configuration has a Macro Template con-
taining only one basic template (Device Template).

MapSet
The MapSet is a list of matched column names of the client supplied Instrument Index and Field
Wiring Index with the corresponding Project Data column/property/attribute. MapSets allow you
to import data from Instrument or Field Wiring Indexes with varied data columns. You can use a
system mapset to map different systems.
MapSets are created and stored in Workbench for re-use during subsequent imports of data. A
project can create multiple MapSets and set a default MapSet when the project receives data with
similar column names.

Workflow/Workgroups/Worklets
The workflow is the prime Automation function of Workbench. It enables you to standardize and
automate parts of the engineering build process.
In Workbench, the workflow requires the following external data inputs to generate control strat-
egies and/or safety logic:
Instrument Index data in the specified format
Field Wiring Index data in the specified format as for Instrument Index
Templates

10
1. Understanding Workbench Concepts B0850AU Rev G

Control and safety have separate workflows. Each workflow contains a fixed set of workgroups
and each workgroup contains a fixed set of worklets. Each of the worklets has specific, predefined
rules designed to generate the data needed for the final output file.
To perform the required actions each worklet has a corresponding sets of rules that are executed
when the worklet is started. These rules govern the flow of execution for the worklet and generate
the required data. These rules can be modified to address project-specific requirements as defined
by the customer.
Figure 1-7 describes the relationship that exists between workflows, workgroups, and worklets.

Figure 1-7. Relationship Diagram - Workflow, Workgroup, and Worklet

In Workbench, a worklet is a small, self-contained, complete process that handles one task. A
worklet is a part of a larger, composite workgroup process. A sequence of workgroups form a
workflow. Workflow may be seen as the work process normally performed by an engineer. This
process is segregated into workgroups. Workgroups are then split into worklets.

Elements / Attributes /References

Rules govern the execution of workflows. Elements, Attributes, and References are components of
rules that contribute to the process of building safety or control devices. Each element in the rules
has attributes that you can modify and customize based on the project requirements.
Elements are meaningful entities that are accessed/referenced, associated, or created during build-
ing of control or safety devices.
1. Examples of elements in control are Tag, Loops, Strategy Templates, Blocks, Com-
pounds, Controllers, and Field Bus Modules (FBMs).
2. Examples of elements in safety are Tag, Loops, Macro Templates, Device instances,
Program application, global variables (GV), and safety Elements.
Attributes are the properties of the elements. For example, attributes of Tag element are Tag-
Name, ScaleHigh, Scalelow, AlarmH, and so forth.

11
B0850AU Rev G 1. Understanding Workbench Concepts

References are the elements that can be referred from the current element. For example, to access
the ControllerName of a Current Compound, rule could be written as this.Compound.Cur-
rent.Controller.ControllerName.
See the Engineering Workbench Rules Reference Guide (B0850AW).

TriStation 1131
TriStation 1131 is a software application for developing and downloading user-written applica-
tions and for performing maintenance and diagnostics, for Triconex controllers.

TriStation 1131 Device Templates

Workbench uses a cloning technique to build the device logic. For each instance of a Macro
Template, Workbench clones Device Templates and replaces the generic information with client
data specific to the instance to be created. Device Templates are a generic representation of how
the logic will appear in the final TriStation 1131 project.
Device Templates are created in TriStation 1131 and then imported into Workbench via the
TriStation 1131 Import Export Utility.
Restrictions
When creating Device Templates in TriStation 1131 FBD, the following must be adhered to for
Workbench to operate correctly:
All templates are built in TriStation 1131 using the Function Block Diagram
language.
Each template must be on a separate TriStation 1131 FBD Sheet to allow Workbench
to correctly identify a template.
Each template Sheet title must be unique as shown in Figure 1-8.

Figure 1-8. Sheet Name

Place each template in the top left corner of the Sheet and border it by network
dividers on the right side and bottom to allow Workbench to correctly determine the
sheet area of the template.
There should be 2 network dividers on every sheet. Ensure that an additional 3rd
(horizontal) network divider does not create a fourth network on the sheet.

12
1. Understanding Workbench Concepts B0850AU Rev G

Each template must be a Single Network only. Facilities to combine networks into
larger templates are provided in Workbench.
Lay out all items in a template as they will appear in the final instantiation, as shown
in Figure 1-9.

Figure 1-9. Device Template Layout

The template network must contain a comment with the text

[INSTANCE_COMMENT]. This [INSTANCE_COMMENT] will be replaced in
the final instance with text. You must not alter this text.
All FBD template items require unique names to enable Workbench to identify each
item.
Delete all unreferenced Global Variables (tagnames) from the TriStation 1131 project
from which you create the XML file.
Ensure all function blocks are in a library in the TriStation 1131 project from which
you create the XML file.

NOTE
The examples demonstrate only a single function block but there is no restriction
on the number of functions and function blocks in a Device Template.

13
B0850AU Rev G 1. Understanding Workbench Concepts

Multi-ended Cable
A multi-ended cable connects two hardware parts, such as an External Termination Panel (ETP)
to an IO Module or a Terminal Assembly (TA) to an FBM, if the total channel count is the same
on both the parts. You can configure this cable for both Control and Safety.
A single multi-ended cable can connect to multiple connectors on the two hardware parts. It
replaces the many single connector cables that you would have to use to connect hardware parts
with more than one connector. You can use the single connector and multi-ended cables as fol-
lows:
Use the single connector cable for hardware parts that have only one connector.
For example, in Figure 1-10, the TA and FBM each have a single connector that sup-
ports 1 to 16 channels. Therefore, you can connect this TA to the FBM with a single
connector cable.

Figure 1-10. Single Connector Cable in Control

Similarly, in Figure 1-11, you can connect the ETP and IO Module with a single con-
nector cable because each of them have a single connector that supports 1 to 16 chan-
nels.

Figure 1-11. Single Connector Cable in Safety

Use the multi-ended cable for hardware parts that have multiple connectors.
For example, in Figure 1-12, the TA has a single connector that supports 1 to 32
channels. The FBM has two connectors that support 16 channels each (1 to 16 and
17 to 32). Therefore, you can connect this TA's single connector to the FBM's two
connectors using a multi-ended connector cable.

14
1. Understanding Workbench Concepts B0850AU Rev G

Figure 1-12. Multi-ended Cable in Control

Similarly, in Figure 1-13, you can connect the ETP's single connector to the IO Mod-
ule's two connectors using a multi-ended connector cable when their total channel
count is the same.

Figure 1-13. Multi-ended Cable in Safety

Additional Hardware Part

An additional hardware part is a hardware part, such as a Field External Termination (FET) or
Redundant Adapter, that nests with in another hardware part. Additional hardware parts are used
in both single connector cable and multi-ended cable configurations.
Workbench supports only two levels of nested hardware configurations. For configurations that
use more than two levels of nested hardware, you must use the additional hardware part properties
provided for the hardware part in the wiring typical.
For example, in Safety, the FET is an additional hardware part between the chassis and the IO
Module. Typically, it requires three levels of nesting configuration in the wiring typical. However,
three level nesting configurations are not supported in the current EW version. Therefore, FET is
configured using the AdditionalHardwarePart properties of the IO Module in the wiring typ-
ical. See Figure 1-14.

15
B0850AU Rev G 1. Understanding Workbench Concepts

Figure 1-14. Configuring an Additional Hardware Part in the Wiring Typical in Safety

Similar to Safety, you can configure additional hardware parts, such as an FET, between a base-
plate and an FBM by configuring in the wiring typical in Control. See Figure 1-15. The addi-
tional hardware parts are created when you assign these wiring typicals to tags and run the
Worklet 4.3.1 Instantiate Wiring Typicals and Build Cabinets.

Figure 1-15. Configuring an Additional Hardware Part in the Wiring Typical in Control

16
1. Understanding Workbench Concepts B0850AU Rev G

You can configure any hardware part as an additional hardware part if:
It is required for only quantification and reporting purposes, such as in the BOM,
Cabinet loading, and Cabinet weight reports
It has no role in signal association and segregation scenarios
You can also configure the cables used to connect the chassis and IO Bus extender modules in a
daisy chain as additional hardware parts in the worklet 4.3.5 Interconnect System Components. To
configure additional hardware parts in this worklet, select the chassis and update the following
properties in the Component Properties grid as shown in Figure 1-16:
AdditionalHardwarePartNumber
AdditionalHardwarePartQty
AdditionalHardwarePartType
AdditionalHardwarePartDesc

Figure 1-16. Configuring an Additional Hardware Part in Worklet 4.3.5

17
B0850AU Rev G 1. Understanding Workbench Concepts

18
2. Working with Engineering
Workbench
This chapter describes key features and operations that you will use repeatedly in Engineering
Workbench.

Checkout and Release Checkout

Checkout is the permission obtained by the engineer to save and modify the client data, tem-
plates, Wiring Typicals, Project Information Database (PIDB), Cause and Effect Editor (CEE)
files or rules to the IPS Database. Checkout and Release checkout can be done by the engineers
who are assigned with this role. This prevents multiple engineers from writing the same data to
the IPS Database at the same time. Therefore, when a checkout is obtained for writing client data
by an engineer, it prevents all other engineers from checking-out (and writing to) the client data.
When an engineer is working on a particular scope of the system, such as client data, checkout
option allows other engineers to still checkout templates and/or rules. After the activity is com-
pleted, the engineer can release the checkout, allowing other engineers to update the client data.
Checkout: Eliminates the possibility of more than one engineer working on the same
scope of the system at the same time.
Release Checkout: Releases the checked out version. You must release your checkout to
allow other users to work on that particular data. The lead engineer assigned to a project
can release a checkout put in place by a project engineer.

Locks
Locks prevent data that is generated by the Workbench from being overwritten without the con-
sent of the engineer. The two kinds of locks are:
Associate locks - These are created when the child elements are locked. If a parent ele-
ment has an association lock, the engineer can add child elements to this element.
Complete locks - These denote that all the parameters of the element are locked.
When an element is completely locked, then the engineer cannot update the attri-
butes of the element or add child elements to these elements.
In either control or Safety, the elements that exist below a component in the hierarchy are
called child elements. For example, in control configuration the hierarchy can be written as
Controller > Compound > Macro Loop > Loop > Block. Therefore, for a Compound, all
Loops, Subloops, and Blocks are child elements and the Controller is named as parent element.

Local Cache
Local cache is a project directory that temporarily stores project-specific information. The local
cache is located on the engineer's workstation (local computer). The local cache helps in saving
the intermediate data, a copy of templates, rules, and client database, chosen by the engineer dur-
ing the creation of control and safety logics. This enhances the performance of the Workbench
and reduces server loading, as it nullifies the requirement of being connected to the database serv-
ers constantly and also enables the engineer to verify the data before permanently committing

19
B0850AU Rev G 2. Working with Engineering Workbench

data. A separate local cache is created on the users machine for each project the engineer is work-
ing on. This local cache can be manually cleared during any step of the workflow execution.
If you opt to delete cache using the Delete Cache button, it deletes everything in the local cache,
including templates, rules, scope information, workflow generated data. After you delete local
cache, you can still download the committed data from the server and continue.
The default directory of the local cache on your workstation is C:\Documents and Settings\All
Users\Application Data\Workbench Cache.

Commit / Save
The commit operation is performed whenever the data has to be stored permanently in the IPS
Database. Commit stores data permanently for use by other users in the project. The Save opera-
tion is performed whenever you want to save data on to the local machine cache.
Every commit operation will save a new version data to the project database. You should perform
Commit only if there is a change in the data or if there is a new set of data. If you commit the
same set of data, more than one time, the Workbench will save existing data to the project data-
base with new version numbers.

Change/Version Management
Each successful commit operation performed by you saves a new version in Version Management.
While Change Management saves a new version only if the data is different from the existing ver-
sion of data.
The base version in the system starts at 1.0.
Change/Version Management helps to view the:
Available versions
Data for the selected version
Differences between any two versions
Change Management applies for control client data, safety client data, Strategy (Control) Tem-
plates, Project Information Database, Instrument Index, Wiring Index, Cabinet Data, Communi-
cation List, and so on.
Version Management is available for control and safety client data, across all input data, that
includes control and safety rules, control database and Instance database, Device and Macro Tem-
plates, and so on.

Data Views
This feature enables you to view, analyze, modify, and save the modified data. This feature pro-
vides the comparison between different versions of data available in the project database.
See the Engineering Workbench Functional Guide (B0850AV).

20
Index
A R
additional hardware part release checkout 19
description 15
properties in wiring typical 17 S
associate locks 19 single connector cable 14

C T
cable TriStation 1131 Device Templates 12
multi-ended 14
single connector 14 V
Change Management 20 Version Management 20
checkout 19
commit 20 W
complete locks 19 Wiring Typical 7
workflow, workgroup, and worklet 10
D
Device Templates
defined 7
for TriStation 1131 12
restrictions 12

I
Instrument Index
defined 5
mandatory fields 5

L
local cache 19
lock, associate and complete 19

M
Macro Loop 3
Macro Template 8
MapSet 10
multi-ended cable 14

N
nested hardware. See additional hardware part

P
Plant Breakdown Structure
defined 2
hierarchy 3
Project Information Database 6

21
Invensys Systems, Inc.
38 Neponset Avenue
Foxborough, MA 02035-2037
United States of America
www.schneider-electric.com

Global Customer Support

Inside U.S.: 1-866-746-6477
Outside U.S.: 1-508-549-2424
Website: https://support.ips.invensys.com