0% found this document useful (0 votes)
255 views618 pages

3BDS011224 - Eng - Function Designer PDF

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
255 views618 pages

3BDS011224 - Eng - Function Designer PDF

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 618

IndustrialIT

800xA - Engineering
System Version 4.1

Engineering Workplace
Function Designer
IndustrialIT
800xA - Engineering
System Version 4.1

Engineering Workplace
Function Designer
NOTICE
The information in this document is subject to change without notice and should not be
construed as a commitment by ABB. ABB assumes no responsibility for any errors that
may appear in this document.

In no event shall ABB be liable for direct, indirect, special, incidental or consequential
damages of any nature or kind arising from the use of this document, nor shall ABB be
liable for incidental or consequential damages arising from use of any software or hard-
ware described in this document.

This document and parts thereof must not be reproduced or copied without written per-
mission from ABB, and the contents thereof must not be imparted to a third party nor used
for any unauthorized purpose.

The software or hardware described in this document is furnished under a license and
may be used, copied, or disclosed only in accordance with the terms of such license.

This product meets the requirements specified in EMC Directive 89/336/EEC and in Low
Voltage Directive 72/23/EEC.

Copyright © 2003 - 2005 by ABB.


All rights reserved.

Release: June 2005


Document number: 3BDS011224R4101

TRADEMARKS
Registrations and trademarks used in this document include:

Windows Registered trademark of Microsoft Corporation.

Windows 2000 and Windows XP

Registered trademark of Microsoft Corporation.

ActiveX and Visual Basic Registered trademarks of Microsoft Corporation.

PostScript Registered trademark of Adobe Systems Inc.

Acrobat Reader Registered trademark of Adobe Systems Inc.

Industrial IT Trademark of ABB.

Aspect Object Trademark of ABB Ltd., Switzerland

Aspect Studio Trademark of ABB Ltd., Switzerland.

Aspect Express Trademark of ABB Ltd., Switzerland.

Process Portal Trademark of ABB Ltd., Switzerland.


TABLE OF CONTENTS

About This Book


General ............................................................................................................................17
Intended User...................................................................................................................18
Document Conventions ...................................................................................................18
Use of Warning, Caution, Information, and Tip Icons ....................................................19
Terminology.....................................................................................................................20
Related Documentation ...................................................................................................42

Section 1 - Introduction
Product Overview ............................................................................................................45
Product Scope.......................................................................................................45
What You Can Do with ... ....................................................................................46
What’s New in This Release ................................................................................47
Prerequisites and Requirements ......................................................................................47

Section 2 - Installation
..............................................................................................................................49

Section 3 - Configuration
Before You Start ..............................................................................................................51
System Creation ...................................................................................................51
Getting Started.................................................................................................................51
Application Start-up .............................................................................................51
User Interface .......................................................................................................55
Preference Settings...............................................................................................58
Object Type Definition and Usage ..................................................................................60

3BDS011224R4101 5
Table of Contents

Tutorial ............................................................................................................................ 62
Enhancing a User-Defined Object Type for Use in Function Designer............... 63
Use Case Description.......................................................................... 63
Tutorial Step by Step........................................................................... 63
Customizing a Function Component ................................................................... 67
Use Case Description.......................................................................... 67
Tutorial Step by Step........................................................................... 68
Valve Control with AC 800M .............................................................................. 74
Use Case Description.......................................................................... 74
Tutorial Step by Step........................................................................... 74
Nested Diagram ................................................................................................... 89
Diagram Types ................................................................................................... 115
Use Case Description........................................................................ 116
Tutorial Step by Step......................................................................... 116
Diagram Type Sample........................................................................................ 121
Enhanced Naming ......................................................................................................... 126
Aspect Properties/Parameters........................................................................................ 132
Aspect Properties/Parameters Dialog ................................................................ 133
Predefined Aspect Properties............................................................................. 140
Adding an Aspect Property................................................................................ 144
Removing an Aspect Property ........................................................................... 145
Aspect Property References............................................................................... 146
Aspect Property Reference ............................................................... 147
Bulk Data Manager Support and Bulk Operations ....................................................... 147
Copy Diagram(s) via Bulk Data Manager ........................................ 150
Copy and Rename Loop Diagram(s) via Bulk Data Manager.......... 153
Bulk Connect Diagram References................................................... 157
Bulk Allocate Diagrams.................................................................... 159
Bulk Generate Configuration Data ................................................... 163
Diagram Status in Bulk Data Manager and in System Status Viewer165
Bulk Documentation and Contents Chapter ..................................... 167
Create Diagram(s) via Bulk Data Manager ...................................... 175

6 3BDS011224R4101
Table of Contents

Function Components....................................................................................................179
Defining Function Components (Component View)..........................................179
Function Components with XML Type Description (Component View) ..........183
Libraries ....................................................................................187
Data Types ....................................................................................190
Aspect Objects and Symbol Objects ..................................................................191
Object Type Definition Create Info....................................................................193
Inherited Function Components .........................................................................195
Labels on Inherited Components ......................................................199
Overridden Components ....................................................................................199
Default Aspect....................................................................................................202
Instantiating Function Components in Diagram View .......................................203
Change Type.......................................................................................................203
Changing Type of Component Instances ..........................................203
Changing Number of Inputs..............................................................204
Show/Hide Ports................................................................................204
Connections/Networks .......................................................................................208
Connect by Keyboard .........................................................................................213
Connect by Mouse..............................................................................................214
Disconnect..........................................................................................................215
Inversion ...........................................................................................................216
Vertical Navigation.............................................................................................218
Horizontal Navigation ........................................................................................221
Diagram Variables .............................................................................223
Connect To Diagram Variable ...........................................................224
Disconnect From Diagram Variable..................................................226
Goto Reference..................................................................................226
Number of Diagram References........................................................227
Diagram Variables on Copy/Paste Diagram......................................228
System Functions ...............................................................................................228
Audit Trail ....................................................................................229
Permissions and user roles ................................................................230

3BDS011224R4101 7
Table of Contents

Authority .................................................................................... 230


User Log-Over .................................................................................. 231
Import/Export (AFW files) ............................................................... 231
AC 800 M Integration ................................................................................................... 235
Introduction and Requirements.......................................................................... 235
Definitions.......................................................................................................... 237
Workflow Overview........................................................................................... 241
Building up Functional Structure and Function Diagrams ................................ 241
Grouping Function Components into Allocatable Groups ................................ 243
Create a new allocatable group inside Function Designer................ 244
Grouping function components inside Function Designer ............... 248
Assigning Function Components of Different Function Diagrams to One
Task ............................................................................ 249
Grouping Nested Function Diagrams ............................................... 250
Copying Function Components and Allocatable Groups ................. 250
Defining Data Flow Order in Allocatable Groups ............................................. 252
Code Block Generation..................................................................... 254
Code Block Sorting........................................................................... 254
Showing Allocation Details ............................................................................... 257
Explicitly and Implicitly Defined Variables ...................................................... 258
Labelling Splitted Connections.......................................................................... 262
Building up Control Structure............................................................................ 264
Allocating Allocatable Groups .......................................................................... 266
.Allocating Nested Function Diagrams............................................. 269
Allocating I/O Signals ....................................................................................... 273
Generate Configuration Data ............................................................................. 276
Unallocation....................................................................................................... 277
Variable Creation ............................................................................................... 278
Connections between Blocks inside an Allocatable Group .............. 279
Connections across Diagrams (horizontal cross references) ............ 280
Connections within nested Diagrams (vertical navigation) .............. 281
Connections to I/O Channels ............................................................ 282

8 3BDS011224R4101
Table of Contents

Connections from I/O Channels........................................................282


Connections between Allocatable Groups inside same Application.283
Connection and Inversion Checks ......................................................................284
General ....................................................................................284
Checks for Connections ....................................................................284
Checks for Inversions ........................................................................284
Checking of constant literals .............................................................285
Visualization ....................................................................................285
Invocation of the Checks ...................................................................286
Implicit Casts .....................................................................................................288
Casted Data Types .............................................................................289
Structured Data Types .......................................................................290
Constant Connections, Literals .........................................................291
Connection Mapping ..........................................................................................292
Instance Specific Initial Values ..........................................................................295
Hints: ....................................................................................296
Consistency ........................................................................................................297
General ....................................................................................297
Diagram States and Transitions.........................................................297
Code Relevant Changes.....................................................................303
Consistency for Diagrams created from Control Module Types.......321
Consistency for Diagrams in Object Type Structure.........................322
Diagram Status Display.....................................................................322
Cross References ...............................................................................324
On-line Display ..................................................................................................327
General ....................................................................................327
Display Style ....................................................................................327
User Interface ....................................................................................333
Watch Window ...................................................................................................336
Adding Variables ...............................................................................338
Sending Variable Values....................................................................339
MMS Cross Communication..............................................................................340

3BDS011224R4101 9
Table of Contents

MMS Communication Overview...................................................... 340


Prerequisites .................................................................................... 343
How to start Generation of MMS Cross Communication ................ 345
Workflow of automatic MMS Cross Communication Generation ... 348
MMS Analysis .................................................................................. 349
The MMS Editor ............................................................................... 350
Create MMS .................................................................................... 354
Download and go Online .................................................................. 359
Aspect Verbs of CrossCommunication Aspect ................................. 361
Current Limitations of automatic Cross Communication Generation362
Outdated MMS Cross Communication Data .................................... 362
Some More Hints .............................................................................. 363
Fieldbus Builder P/H Integration .................................................................................. 364
Introduction and Requirements.......................................................................... 364
Objects Types of Fieldbus Builder..................................................................... 366
Building up Functional Structure....................................................................... 368
Allocation in Control Structure.......................................................................... 370

Section 4 - Graphic Editor Reference


Overview ....................................................................................................................... 371
Exploring the Windows User Interface ......................................................................... 371
Main Window Handling..................................................................................... 371
Diagram/Component View ................................................................................ 372
Diagram/Component Document Windows ........................................................ 374
Dockable Windows/Toolbars ............................................................................. 376
Changing the Location of Docked Windows/Toolbars ...................................... 379
Working with Menus..................................................................................................... 380
File Menu .......................................................................................................... 382
Edit Menu .......................................................................................................... 388
View Menu......................................................................................................... 391
Insert Menu ........................................................................................................ 398
Layout Menu...................................................................................................... 402
Allocation Menu ................................................................................................ 406

10 3BDS011224R4101
Table of Contents

Online Menu.......................................................................................................408
Window Menu ....................................................................................................411
Help Menu..........................................................................................................416
Context Menus ...................................................................................................417
Working with Toolbars ..................................................................................................432
Customize...........................................................................................................433
Toolbar Categories .............................................................................................438
Showing/Hiding Toolbars...................................................................................447
Creating a User-Defined Toolbars......................................................................448
Adding Tool Buttons to Toolbars .......................................................................448
Removing Tool Buttons from a Toolbar.............................................................450
Resetting the Composition of a Toolbar.............................................................450
Renaming a User-Defined Toolbar.....................................................................450
Deleting a User-Defined Toolbar .......................................................................451
Changing the Look of Toolbars..........................................................................451
Showing Tooltips................................................................................................451
General Accelerator Keys..............................................................................................452
New/Open Aspect..........................................................................................................455
Creating a New Function Aspect .......................................................................455
New Function Component .................................................................................456
New Function Diagram ......................................................................................457
Open Aspect .......................................................................................................462
Inserting/Creating Components.....................................................................................463
Inserting Graphic Primitives ..............................................................................466
Inserting Text Components ................................................................................471
Inserting Label Components ..............................................................................471
Inserting Ports ....................................................................................................473
Inserting Pictures/Images ...................................................................................474
Inserting ActiveX Controls ................................................................................475
Inserting Graphic Elements build with Graphics Builder ..................................476
Inserting Function Components .........................................................................477
Inserting Function Components from Object Type Structure ...........478

3BDS011224R4101 11
Table of Contents

Inserting Function Components from/into Other Structures ............ 482


Viewing Components .................................................................................................... 482
Zoom .......................................................................................................... 483
Pan .......................................................................................................... 485
Selecting Components................................................................................................... 486
Selecting Symbols.............................................................................................. 489
Selecting Single Symbols ................................................................. 489
Contiguous Rectangular Multiple Selection of Symbols.................. 490
Contiguous Linear Multiple Selection of Symbols........................... 492
Selecting Symbols via the Components Dialog................................ 493
Selecting Ports ................................................................................................... 493
Selecting Single Ports ....................................................................... 493
Contiguous rectangular multiple selection of Ports .......................... 494
Contiguous linear multiple selection of Ports................................... 496
Selecting Connections........................................................................................ 497
Selecting Single Connections ........................................................... 497
Contiguous Rectangular Multiple Selection of Connections............ 498
Contiguous Linear Multiple Selection of Connections..................... 500
Layout of Components .................................................................................................. 500
Grid .......................................................................................................... 500
Grid Properties .................................................................................. 500
Move .......................................................................................................... 502
Size .......................................................................................................... 504
Align .......................................................................................................... 505
Rotate .......................................................................................................... 509
Flip .......................................................................................................... 510
Order .......................................................................................................... 511
Group .......................................................................................................... 514
Cut/Copy/Paste/Delete Components ............................................................................. 515
Cut and Paste...................................................................................................... 515
Copy and Paste................................................................................................... 517
Paste Options ..................................................................................................... 521

12 3BDS011224R4101
Table of Contents

Delete ...........................................................................................................525
Defining Component Properties ....................................................................................527
Ambient Properties.............................................................................................527
Colors ....................................................................................529
ActiveX Controls...............................................................................532
Off Page Connector ...........................................................................533
Font ....................................................................................534
Component Properties ........................................................................................535
Setting Component Properties...........................................................535
Edit ....................................................................................537
Field ....................................................................................540
Fill ....................................................................................543
Font ....................................................................................544
General ....................................................................................546
Labels ....................................................................................547
Line ....................................................................................549
Position and Size ...............................................................................550
Show / Hide ....................................................................................551
Text ....................................................................................552
Color ....................................................................................555
Components ....................................................................................557
Setting Component Properties...........................................................558
Default Properties...............................................................................................559
Edit ....................................................................................561
Fill ....................................................................................561
Font ....................................................................................562
Labels ....................................................................................562
Line ....................................................................................563
Layers ............................................................................................................................564
Layer Properties .................................................................................................564
Pages ............................................................................................................................567
Measurements and Size......................................................................................568

3BDS011224R4101 13
Table of Contents

Drawing Scale................................................................................... 569


Page Size .................................................................................... 570
Print Size .................................................................................... 571
Page Setup.......................................................................................................... 572
Select Master Page Template ............................................................................. 573
Insert/Delete Page .............................................................................................. 575
Insert Page .................................................................................... 575
Delete Page .................................................................................... 575
Page Comments ................................................................................................. 575
Page Navigation ................................................................................................. 576
Printing .......................................................................................................................... 578
Contents .......................................................................................................... 578
Print .......................................................................................................... 580
Print Preview...................................................................................................... 583
Options .......................................................................................................................... 584
Print .......................................................................................................... 585
Paste .......................................................................................................... 586
Autorouting ........................................................................................................ 587
Naming .......................................................................................................... 588
Import/Export................................................................................................................ 590
File Export ......................................................................................................... 590
File Import ......................................................................................................... 591
Undo/Redo .................................................................................................................... 592
Undo .......................................................................................................... 592
Redo .......................................................................................................... 593
........................................................................................................................... 593

Section 5 - Maintenance
Product Verification....................................................................................................... 595
Error Messages.............................................................................................................. 597
Reporting Problems....................................................................................................... 599
Useful Hints .................................................................................................................. 599
Backup / Restore ........................................................................................................... 602

14 3BDS011224R4101
Table of Contents

INDEX

3BDS011224R4101 15
Table of Contents

16 3BDS011224R4101
About This Book

General
This book describes Function Designer, the configuration tool for system-wide
Function Diagrams. It serves as application and reference manual for Function
Designer provided with Engineering Workplace of IndustrialIT Extended
Automation System 800xA.
The book also describes the use of Function Designer as a diagnostic and
commissioning tool.
Section 1, Introduction introduces you to Function Designer.
Section 2, Installation references installation information.
Section 3, Configuration describes configuration and application procedures with
Function Designer.
Section 4, Graphic Editor Reference describes the user interface of the graphic
editor of Function Designer in detail.
Section 5, Maintenance holds and references information helpful in case of
maintenance issues.
For a quick start you can read What You Can Do with ... on page 46 and Getting
Started on page 51 and Tutorial on page 62 first.

3BDS011224R4101 17
Intended User About This Book

Intended User
The manual is meant for application engineers to get familiar with the functions and
commands of Function Designer. To get the most recent hints, recommendations
and settings please read the actual Release Notes which are delivered along with the
product.
The reader of this manual should have proper education about engineering in
general, the work flow usually used in engineering projects, and the concept of
Aspect ObjectsTM (see IndustrialIT 800xA – System, Engineering Workplace, Basic
Engineering Functions manual and IndustrialIT 800xA – System, Configuration
manual).
This book is not the only source of instruction for the Function Designer. ABB
offers training courses for those who are intended to use the Function Designer
The following subsections are a guide to the conventions and terminology used
throughout this book.

Document Conventions
The following conventions are used for the presentation of material:
• The words in names of screen elements (for example, the title in the title bar of
a window, the label for a field of a dialog box) are initially capitalized.
• Capital letters are used for the name of a keyboard key if it is labeled on the
keyboard. For example, press the ENTER key.
• Lowercase letters are used for the name of a keyboard key that is not labeled on
the keyboard. For example, the space bar, comma key, and so on.
• Press CTRL+C indicates that you must hold down the CTRL key while
pressing the C key (to copy a selected object in this case).
• Press ESC E C indicates that you press and release each key in sequence (to
copy a selected object in this case).
• The names of push and toggle buttons are boldfaced. For example, click OK.
• The names of menus and menu items are boldfaced. For example, the File
menu.

18 3BDS011224R4101
About This Book Use of Warning, Caution, Information, and Tip Icons

– The following convention is used for menu operations: MenuName >


MenuItem > CascadedMenuItem. For example: select File > New > Type.
– The Start menu name always refers to the Start menu on the Windows
Task Bar.
• System prompts/messages are shown in the Courier font, and user
responses/input are in the boldfaced Courier font. For example, if you enter a
value out of range, the following message is displayed:
Entered value is not valid. The value must be 0 to 30.
You may be told to enter the string TIC132 in a field. The string is shown as
follows in the procedure:
TIC132
Variables are shown using lowercase letters.
sequence name

Use of Warning, Caution, Information, and Tip Icons


This publication includes Warning, Caution, and Information where appropriate
to point out safety related or other important information. It also includes Tip to
point out useful hints to the reader. The corresponding symbols should be
interpreted as follows:
Warning icon indicates the presence of a hazard which could result in personal
injury.

Caution icon indicates important information or warning related to the concept


discussed in the text. It might indicate the presence of a hazard which could
result in corruption of software or damage to equipment/property.

Information icon alerts the reader to pertinent facts and conditions.

Tip icon indicates advice on, for example, how to design your project or how to
use a certain function

3BDS011224R4101 19
Terminology About This Book

Although Warning hazards are related to personal injury, and Caution hazards are
associated with equipment or property damage, it should be understood that
operation of damaged equipment could, under certain operational conditions, result
in degraded process performance leading to personal injury or death. Therefore,
comply fully with all Warning and Caution notices.

Terminology
The following is a list of terms associated with Function Designer that you should
be familiar with. The list contains terms and abbreviations that are unique to ABB or
have a usage or definition that is different from standard industry usage.

Table 1. Terminology

Term Description
Allocatable group Group of function component Aspect Objects and
symbol objects which will be allocated together in the
Control Structure, e.g. into a controller application.
Allocatable group Aspect that stores grouped function component and their
Aspect order, e.g. the data flow order of CBM functions and
CBM function blocks.
(to) allocate • To allocate an allocatable group within the Control
Structure, e.g. in a CBM application.
• To allocate an I/O Signal to a I/O board channel.
Anchor First selected graphic component of a multiple selection.
Annotation layer Contains review comments.
ARD The absolute reference designation is a hierarchical
concatenation of relative Aspect Object names like
Functional Designation or Location Designation within a
structure.
Aspect A representation of a facet of a real world entity, which
entity is represented as an Aspect Object. An aspect
defines a piece of information, and a set of functions to
create, access, and manipulate the information.

20 3BDS011224R4101
About This Book Terminology

Table 1. Terminology

Term Description
Aspect category A specialization of an aspect type. For example, the
aspect type Graphic Display includes the categories
Overview, Group, and Object Display.
Aspect Framework Platform functionality that supports integration of aspect
(Afw) systems and connectivity components, including
concepts, APIs, and tools.
System 800xA platform A collection of software that forms the basis for an IIT
system, and provides the development and execution
environment for IIT compliant applications. The System
800xA platform includes the Aspect Framework.
Aspect ObjectTM Aspect Objects are representations of real world entities
that a user interacts with, such as valves, reactors,
products, material, production orders, batches, customer
accounts, etc. Different facets of these real world entities
are modeled as aspects. An Aspect Object is not an
object in a strict sense, e.g. like a COM object, but rather
a container of references to implementations of its
aspects.
Aspect Object The Aspect Object Architecture defines the Aspect
Architecture Object concept, the System 800xA platform, the Aspect
Framework, the system topology, underlying
technologies, and concepts and rules for development of
Aspect Systems and for device integration.
Aspect Object structure An organization of Aspect Objects in a hierarchical
structure, based on some specific form of parent-child
relationships between the objects. Examples are
Functional Structure, where the relationships are defined
by functional containment, and Location Structure,
where the relationships are defined by physical
placement of the objects.

3BDS011224R4101 21
Terminology About This Book

Table 1. Terminology

Term Description
Aspect Object type An Aspect Object type defines certain characteristics
that are shared between several Aspect Object
instances, such as a basic set of common aspects. This
makes it possible to create and efficiently re-use
standardized solutions to frequently recurring problems.
For example, rather than building an Aspect Object from
scratch for every valve in a plant, you can define a set of
valve types, and then create all valve objects as
instances of these types.
Aspect property A data field on an aspect of an Aspect Object that can be
accessed through property reference mechanism,
Function Designer, Aspect Data Sheet, Single Aspect
Editor, and Bulk Data Manager.
Aspect Server A server that runs the central functions of the Aspect
Object architecture, such as Aspect Directory, Structure
and Name Server, Cross Referencing, File Set
Distribution, and so on.
The Aspect Server is normally used as the Windows
domain controller for the control and client/server
networks.
Aspect system A software system, which implements one or several
aspect types by providing one or several Aspect System
Objects.
Aspect system object A COM object through which an Aspect System provides
(part of) the functionality associated with an Aspect
Type. This COM object supports certain framework-
defined interfaces, through which the application can
initiate and participate in common operations on Aspect
Objects and Aspects.
Aspect type An aspect type represents the implementation of a
certain aspect. For example, the aspect system Process
Graphics implements the aspect types Graphic Display,
Faceplate, and Display Element.

22 3BDS011224R4101
About This Book Terminology

Table 1. Terminology

Term Description
Aspect view An aspect can typically present its information in several
different ways. These presentations are called aspect
views.
(to) assign To assign function components, e.g. controller functions,
function blocks or control modules to allocatable groups
Audit event An event that is recorded in the audit trail.
Audit trail An automatic record of all operator and engineering
actions, showing who made the action and when.
Actions include operator actions, such as opening a
valve, starting a manufacturing sequence, entering some
data, acknowledging an alarm, etc., as well as entries,
changes, moves or deletes of electronic records, system
configuration data, and security settings.
In the 800xA system, the audit trail is a subset of all
events, including those events that are classified as audit
events.
Authentification The process by which the system validates the user's
logon information. A user's name and password are
compared against an authorized list. If the system
detects a match, access is granted to the extent
specified in the permissions list for that user.
AutoArrange Function that recomputes the position of graphic
components. The criterias for the computed positions
may be individual for each application. If necessary, new
pages will be inserted or empty pages may be deleted.
AutoInsert Function that adds a graphic component, e.g. a Function
Component symbol without affecting the position of
existing components. If necessary, new pages will be
inserted.
Background layer Contains graphic components without any function
related aspect data.

3BDS011224R4101 23
Terminology About This Book

Table 1. Terminology

Term Description
Base library See Library.
CBM Control Builder M Professional (for AC 800M).
Client application Client applications are applications that utilize the
functionality provided by one or more Afw Services, for
example, to present some information to a user.
Client/Server network A client/server network is used for communication
between servers, and between workplaces and servers.
COM The Microsoft’s Component Object Model (COM) is a
software architecture that allows applications to be built
from binary software components.
Communication points During allocation of function diagrams into allocatable
groups, connections between function component
objects which are connected directly have to be split up if
they are placed in different allocatable groups during
controller configuration data generation: then a label (or
communication point) has to be created, attached to the
signal and automatically named; these labels could also
be created by the user inside the function diagram.
Component view View on function aspect to display or edit the interface of
a function component (inputs, outputs, type) and its
symbol representation.
Composite Aspect An Aspect Object instance that contains other object
Object instances. This containment is implemented by having
other objects as children in one or more structures
where the composite object is placed. The set of objects
placed under the composite object are the children of
the composite object. Usually the term "composite
object" means a composite object including all its
children.

24 3BDS011224R4101
About This Book Terminology

Table 1. Terminology

Term Description
Composite Aspect A composite Aspect Object type describes a set of
Object type Aspect Objects organized in a structure, with a parent
object and one or several child objects. The children in a
composite object type are called formal instances,
because they inherit from object types defined
elsewhere in the Object Type Structure, but they are not
actual instances. When a composite object is
instantiated actual instances are created for these child
objects.
Connection see Connection link and Connect string
Connection link Polyline between two connection ports or between a port
and a connection point. In general, connection links get
automatically routed. Manual routing is possible by
moving and freezing link vertices by mouse.
Connection network Set of 1:1, 1:N, M:N connections. A connection network
has 1..M sources and 1..N sinks, and is defined by its
unique network name, a connect string of type variable.
Connection networks are unique in a function diagram.
Connection port Defined start/end point of a symbol for a connection.
Connect string Defines the type of a connection:
- Connection to constant, e.g. “1”, “3.14”, “’ConstString’”
- Connection to variable/network, e.g. “link”, “abc”.
Connectivity component A connectivity component provides access to real time
data, historical data, and/or alarm and event data, from a
certain type of device.
Connectivity package Connectivity components, up-loader, supporting aspect
systems (for example, for configuration), and graphical
elements, faceplates, Aspect Object types, and so on,
bundled together to provide the integration of a certain
type of devices into the IIT system.

3BDS011224R4101 25
Terminology About This Book

Table 1. Terminology

Term Description
Connectivity Server A server that provides access to controllers and other
sources for real-time data, historical data, and alarm and
event data. A Connectivity Server runs services related
to OPC/DA, APC/AE, OPC/HAD, and SysMsg.
Context menu A menu that appears when you right-click on an Aspect
Object or an aspect. The context menu lists aspect
operations, actions, aspects, and global operations.
Contiguous linear The selected area on a diagram is determined by the
multiple selection graphical order of the graphic components.
Contiguous rectangular The selected area on a diagram is determined by a
multiple selection rectangle given from the coordinates of the selection-
startpoint and the selection-endpoint (diagonal of the
rectangle).
Diagram parameter See Off-diagram parameter.
Diagram view View on function aspect to display or edit a function
diagram.
Digital signature A digital code, that can be attached to electronically
stored or transmitted data record, and that uniquely
identifies the data and the individual that signed the
data. Like a written signature, the purpose of a digital
signature is to guarantee that the individual signing the
data record really is who he or she claims to be, and that
the data has not been altered since it was signed.
Document Aspect An aspect that stores documents like Excel workbooks
and Word documents. Book Title workbooks can be
stored at Aspect Objects as Document Aspects.
Document reference Reference various document property values like actual
page number, date, time
Document Manager Aspect System for the Document Aspect.

26 3BDS011224R4101
About This Book Terminology

Table 1. Terminology

Term Description
Double authentification The process of identifying two individuals, usually based
on usernames and passwords. Double authentication is
typically used to ensure that certain critical operations
are performed by an authorized individual and approved
by an additional individual, where the additional
individual has the authority to approve such operations.
Drawing page Page of a function diagram you see on the screen. The
drawing page size and thus the scroll range is defined
via Edit > Measurements and Size.
On contrast, the printer page is the paper in the printer.
The printer page size is defined via File > Page Setup.
Electronic signature A computer data compilation of any symbol or series of
symbols executed, adopted, or authorized by an
individual to be the legally binding equivalent of the
individual's handwritten signature.
EngineerIT The name for the suite of products for plant engineering
of an automated process.
Extension library See Library.
Faceplate A faceplate is an aspect that provides a graphical
representation of a certain Aspect Object, with
presentation of certain properties related to the object,
and mechanisms for operator interaction such as on/off,
increase/decrease, etc. Aspect Object types often
include several different faceplate aspects, providing
different presentation and interaction possibilities.
See also Object display.
Field code Defines dynamic text with a document reference or
aspect property reference (parameter reference).

3BDS011224R4101 27
Terminology About This Book

Table 1. Terminology

Term Description
Fieldbus A fieldbus is used to interconnect field devices, such as
I/O modules, smart sensors and actuators, variable
speed drives, PLCs, or small single loop devices, and to
connect these devices to the IIT system.
Fieldbus device Device connected through an IIT supported fieldbus.
Examples are remote I/O and smart sensors and
actuators, but also controllers, robots, variable speed
drives, etc., when these devices are connected through
a supported fieldbus.
Free graphics Graphic components, e.g. primitives on any layer without
any function related aspect data.
Function aspect Aspect of category Function that comprises both
function component and function diagram data viewed in
Component view and Diagram view, respectively.
Typically inherited from the function component (Aspect
Object) type.
Function component A symbol that has function-related aspect data to other
aspect systems, e.g.
- CBM: function, function block, control module
- Fieldbus Builder: field device, function block
- I/O Signal, Connector,...
According to its type definition, it can either be
a) NOT an Aspect Object, but a symbol object visible on
a function diagram only
b) an Aspect Object both visible in the Functional
Structure and on a function diagram
Function component Aspect Object with a function aspect visible both in
Aspect Object Functional Structure and as symbol on a function
diagram. Stored tree-persistent in the Functional
Structure.

28 3BDS011224R4101
About This Book Terminology

Table 1. Terminology

Term Description
Function component Function component visible as symbol on a function
symbol object diagram only. NOT an Aspect Object. Stored diagram-
persistent within a function diagram.
Function component Symbol serving as template for Function components
template with extensible/variable number of in/outputs. On
instantiation, a Function component symbol is
automatically created from the template, the XML type
definition, and the actual number of in/outputs.
Function component Aspect Object type defined in Object Type Structure with
type a function aspect. Defines the interface of a function
component (inputs, outputs, type) and its symbol
representation.
The creation info of the object type definition determines
if a function component instance is either an Aspect
Object or just a symbol object.
Function diagram A function diagram is made up of function component
symbols, connectors, connections, and free graphics,
with up to four layers. Can be nested and represented as
function component on the next higher level.
Function diagram Template for the master page layer of a Function
template diagram, e.g. A3/A4 portrait/landscape with
headers/footers. The template can be copied or
referenced in the diagram.
Function diagram type Aspect Object type defined in Object Type Structure with
a function aspect defining a Function diagram. Typically
a Control Module type created by Function Designer.
Function parameter Aspect of category Function Parameter that comprises
Aspect aspect properties, symbol properties, and connections.
Typically copied from the function component (Aspect
Object) type.

3BDS011224R4101 29
Terminology About This Book

Table 1. Terminology

Term Description
Graphic component Generic term for
• Graphic primitive (rect, line, ... text, port, picture)
• Group of graphic primitives
• ActiveX Control
• Graphic Element (made with Graphics Builder)
• Symbol
• Link
A Graphic Component has (Graphic) Component
Properties like line color, fill color etc. In general,
Graphic Components can be sized and rotated.
Graphic element Graphic element (ActiveX Control) made with Graphics
Builder.
Graphic primitive Generic term for an atomic graphic object:
line, polyline, polygon, rectangle, polycurve, closed
curve, ellipse, text, label, port, picture
Graphical order The graphic components displayed in the drawing area
are ordered by the top-left coordinates of their bounding
rectangle in the sense of top to bottom and left to right.
IndustrialIT ABB's vision for enterprise automation.
IndustrialIT application An application that integrates into the 800xA system and
provides a certain functionality in the form of aspects.
Bulk Data Manager can load and save data from/to
these applications. Examples are Parameter Manager,
Document Manager, etc.
IndustrialIT Enabled A concept and a set of criteria for verifying that a product
is Industrial IT conformant.
IndustrialIT installation An installation of Industrial IT products at a particular
site

30 3BDS011224R4101
About This Book Terminology

Table 1. Terminology

Term Description
IndustrialIT product A product that meets certain criteria for Industrial IT
conformance (see Industrial IT enabled).
IndustrialIT system An arrangement of Industrial IT products, which work
together as a system, implementing (part of) the
IndustrialIT vision.
IndustrialIT system A defined offering to the market of Industrial IT products
offering intended for a particular area of application or use. The
products that are included in an Industrial IT offering are
verified together, and the resulting system has a defined
behavior, capacity, and performance.
Label • Kind of text component that is associated to a
symbol or to a connection link. Can be moved
separately, or together with its owning symbol or
connection link.
• Used also during allocation to define connection
points
Layer Kind of namespace for graphic components. Only
graphic components of the active layer are accessible.
Library A collection of Aspect Object types that are kept together
from a distribution and life cycle management point of
view.
- A Base library contains Aspect Object types.
- An Extension library contains additional aspects that
extend the object types contained in a specific Base
library
Link See connection link

3BDS011224R4101 31
Terminology About This Book

Table 1. Terminology

Term Description
Log over Temporarily changing user, without first logging out the
current user and without breaking the current context.
This function is useful in cases were a certain operation
requires higher authority than that held by the current
user, in which case e.g. a supervisor may temporarily
assume the responsibility, allowing his or her authority to
be temporarily applied.
Logic layer Contains mainly function components, connectors, and
connections with function related aspect data. Also free
graphics can be drawn on the logic layer.
Master page layer Contains header and footer definitions for all pages and
defines the size of the drawing area. Can comprise
dynamic text with text field codes, e.g. the actual page
number.
MDI The Multi Document Interface allows the user to open
multiple document windows in one application frame.
Menu Menus are part of the menu bar. When you click with the
mouse on a menu bar entry, a menu which shows one or
several menu commands (items) or a submenu is
displayed. If you click on a menu item, the respective
command is executed.
Menu Bar The menu bar is a bar below the main window’s title bar.
It holds the menu entries.
Network See connection network.
NUMPAD Numeric keypad. If NUMPAD is used in this document,
for example, NUMPAD “-”, the meaning is that the NUM
key of the numeric keypad has to be active.

32 3BDS011224R4101
About This Book Terminology

Table 1. Terminology

Term Description
Object display An object display is an aspect that provides a graphical
representation of an Aspect Object, with a
comprehensive presentation of the object's properties.
Interaction mechanisms include support for tuning,
calibration, etc., in addition to operator related
interaction such as on/off, increase/decrease, etc. (see
Faceplate).
Off-diagram parameter Function component with labeled in/out symbol to
represent an input/output parameter of a nested diagram
on lower level.
Off-diagram reference Function component with labeled cross-reference
symbol to represent sink /source of a connection
between different function diagrams.
Off-page connector Labeled cross-reference symbol to represent sink /
source of a connection between different pages of a
function diagram.
On-page connector Labeled symbol to represent sink / source of a
connection on the same fixed page. This is an option
that can be used instead of connection poly-lines to
avoid too many crossings on a page.
OPC An application programming interface defined by the
OPC Foundation. The application of the OPC standard
interface makes possible inter operability between
automation/control applications, field systems/devices
and business/office applications.
OPC Item OPC items represent connections to data sources, i.e.
object properties. An OPC item is identified by a string
<object path>:<property name>. Associated with each
OPC item are Value, Quality and Time Stamp. Note that
OPC items are not identical with the data sources - they
represent connections to them.
See also Property.

3BDS011224R4101 33
Terminology About This Book

Table 1. Terminology

Term Description
Operation (Aspect The system defines a set of operations that can be
Object operation) performed on Aspect Objects, such as Edit, Lock,
Configure, Tune, View, etc.
An aspect system (actually an aspect type) can define
additional operations, as part of the registration done by
every aspect system.
Parameter reference See Property reference.
Permission A permission (or access mask) groups a set of
operations that require the same authority. For each
operation defined for an aspect, the aspect category
specifies the permission needed to use that operation.
Plant Explorer A configuration of the Internet Explorer for creating the
Aspect Object that you use to put together the plant. You
can also use it to browse and search the structures of
the plant.
Port see Connection port.
Preview area The area in the Plant Explorer window where the
properties of one selected aspect are presented in the
Aspect List Area. Also called Preview window.
Primitive See graphic primitive.
Product suite Products with similar functionality are kept together in a
suite. Suites names have a superscripted IT-suffix.
Examples: OperateIT, ControlIT, ProduceIT, and so on.
Project A Project collects all data of an engineering project.
They are administrated by the Configuration Wizard
application of the Aspect Object Framework. System is a
synonym for Project.

34 3BDS011224R4101
About This Book Terminology

Table 1. Terminology

Term Description
Property Aspect Objects can have properties. A property is a
(Object property) named data item that is related to an Aspect Object.
Properties are typically owned and managed by aspect
systems.
An aspect system supplies information through
framework-defined interfaces about the properties it
exposes. These properties become accessible through
Afw OPC/DA.A control aspect, for example, may expose
properties such as VALUE, SETPOINT, and OUTPUT
for a control function. The Name aspect provides the
properties NAME and DESCRIPTION.
See also OPC item.
Property reference References any Aspect property value stored in the
system. Defined by a string containing a path to a
property. Example: “.:Name.Name”
Re-authentification The process of re-identifying an individual previously
identified through authentication. Re-authentication
serves two purposes
1. It verifies that the individual trying to perform a certain
operation is identical with the user that is currently
logged on.
2. It means that the user electronically signs that he or
she is performing the operation.
Reference designation A reference designation designates an Aspect Object in
a structure unambiguously (not checked by the system)
with respect to its parent objects. Absolute reference
designations consists of a concatenation of all relative
reference designations.
SCM Single Control Module (CBM)

3BDS011224R4101 35
Terminology About This Book

Table 1. Terminology

Term Description
Security Security controls a user's authority to perform different
operations on Aspect Objects, depending on several
parameters:
- The user's credentials, as provided by Windows
- The node where the user is logged in. This makes it
possible to give a user different authority depending on
where he or she is located, e.g. close to the process
equipment, in a control room, or at home accessing the
system through Internet
- The operation the user wants to perform
- The Aspect Object that the user wants to perform the
operation on.
Security definition An aspect that holds one ore more security descriptors.
aspect
Security descriptor A security descriptor includes an access control list,
where each entry specifies a permission (access mask)
and the users and/or user groups that are granted (or
denied) access. The security descriptor also includes an
audit control list, specifying which operations shall be
logged for auditing purposes. See also relevant
documentation on Microsoft Windows security functions.
Server A node that runs one or several Afw Services.
Service A software component that provides a certain set of
functions in the system, typically for use by various client
applications. See also Afw Service.
Service provider A process that runs a service.

36 3BDS011224R4101
About This Book Terminology

Table 1. Terminology

Term Description
Solution A configuration of software and hardware components
that can be applied to a certain class of problems. The
design and functional scope of a solution should be
optimized to make it re-usable in a practical way. A
solution is built from other solutions and/or basic system
functions. It consists of simple and composite Aspect
Object types, with default parameter values and other
configuration data for the aspects, for example, control
logic, process graphics, alarm and event specifications,
reports, and so on.
Structure A hierarchical tree organization of Aspect Objects that
describes the dependencies between the real objects.
An Aspect Object can exist in multiple structures, for
example both in a Functional Structure and in a location
structure.
Symbol Generic term for a single or a group of graphic
component(s). A symbol graphically represents a
function component. It can have an arbitrary number of
connection ports with connections. It is created/edited in
Component view.
System A System collects all data of an engineering project.
They are administrated by the Configuration Wizard
application of the Aspect Object Framework. Project is
an synonym for System.

3BDS011224R4101 37
Terminology About This Book

Table 1. Terminology

Term Description
System application A software package that provides functionality in the IIT
system.
System applications cooperate according to rules
defined by the IIT architecture, using mechanisms
provided by the 800xA system. They are normally
bundled into System Products or System Product
Extensions.
System applications are implemented as client
applications or services.
To participate in Aspect Object operations, and thus be
an integrated part of an IIT system, a system application
must present itself as an aspect system (or possibly as
several aspect systems).
When there is no risk for confusion with user application,
the term “application” may be used instead of “system
application”.
System extension A system extension consists of one or more system
applications that are bundled as an extension to one or
several existing system products. A system extension
can only be installed if (one of) the corresponding
system product(s) has been installed previously.
System product A system product consists of applications bundled
together with relevant parts of the 800xA system.
Several System Products can be installed on the same
physical node.
System product A System Product Extension consists of one or more
extension applications that are bundled as an extension to one or
several existing System Product. A System Product
Extension can only be installed if (one of) the
corresponding System Product(s) has been installed
previously.

38 3BDS011224R4101
About This Book Terminology

Table 1. Terminology

Term Description
System version A system version defines the collection of specific
versions of Industrial IT products, as well as operating
system and similar components, which constitute a
system offering at a given point in time.
VBScript An easy to learn, Visual Basic like scripting language
from Microsoft.
View (see also Aspect View).
WDI Workbook Document Interface. Alternative to MDI with
documents accessed by tabs as e.g. in MS-Excel.
Workplace User interactive functions that are combined for a
particular use case, for example, Operator Workplace,
Engineering Workplace, and so on.
A node that runs one or several workplace applications.

3BDS011224R4101 39
Terminology About This Book

Figure 1. Naming of different components on a diagram

40 3BDS011224R4101
About This Book Terminology

Figure 2. Naming of different components on a diagram

3BDS011224R4101 41
Related Documentation About This Book

Related Documentation
The following is a listing of documentation related to Function Designer.

Table 2.

Category Title Description


Installation IndustrialIT 800xA - System Describes installation of System 800xA
Installation
System IndustrialIT 800xA - System Describes security setup and
Administration Administration and Security administration of System 800xA

Operation IndustrialIT 800xA - System Describes operation of System 800xA.


Extended Operation
Configuration IndustrialIT 800xA - System Gives an overview on configuration and
Configuration engineering of System 800xA from the
control system software perspective.
IndustrialIT 800xA - Engineering Describes the basic engineering
Engineering Workplace functionality of the Engineering
Workplace of System 800xA
Basic Engineering Functions
IndustrialIT 800xA - Engineering Describes configuration of process
Graphics graphics of the Process Portal A base of
System 800xA.
IndustrialIT 800xA - Control and I/O Describes control module and function
Basic Control Software block based engineering issues of
integrated Control Builder M
Introduction and Configuration
Professional of the Engineering
Workplace of System 800xA.
IndustrialIT 800xA - System Introduces to IEC 61131 languages
IEC 61131 Control Languages supported in Control Builder M
Professional of the Engineering
Introduction
Workplace of System 800xA.

42 3BDS011224R4101
About This Book Related Documentation

Table 2.

Category Title Description


IndustrialIT 800xA - Control and I/O Describes control module and function
Extended Control Software block object type design and application
programming strategy and design topics
Binary and Analog Handling
of Control Builder M Professional of the
Engineering Workplace of System
800xA
IndustrialIT 800xA - Control and I/O Describes installation and product
OPC Server for AC 800M configuration of the OPC Server for AC
800M of System 800xA .
Installation and Configuration
IndustrialIT 800xA - Device Management Describes the basic features of
PROFIBUS PROFIBUS device integration of System
800xA and how to configure the
Configuration
individual software components.
IndustrialIT 800xA - Device Management The document describes the basic
HART features of HART Device integration of
System 800xA and how to configure the
Configuration
individual software components.

3BDS011224R4101 43
Related Documentation About This Book

44 3BDS011224R4101
Section 1 Introduction

Product Overview
Function Designer is the engineering portal for plant oriented engineering with
Aspect Objects. It provides a graphical user interface, which makes complex control
strategies easy to engineer and even easier to maintain. Point and Click navigation
across diagrams following the signal flow or hierarchy is one of the build-in
features. Another powerful feature is to simplify complex system configuration
issues especially regarding connections where it hides the IEC61131 complexity
behind one connection line.
Function Designer provides a Component view and a Diagram view. The
Component view is used to design graphical symbols representing an Aspect Object
type where the Diagram view is using those graphical symbols when Aspect Objects
are arranged and ports of these objects get interconnected.

Product Scope
Function Designer is a component of Engineering Workplace of IndustrialIT
Extended Automation System 800xA.
Function Designer provides:
• Function oriented design rather than controller or task oriented design.
• Homogeneous graphical user interface for different Aspect Systems.
• Functional design combining different Aspect Systems.
• Function oriented view on plant wide configuration.
• Combination and connection of function component from different Aspect
Systems on one function diagram.
• Connection tracing from source to sink of function components or vice versa.

3BDS011224R4101 45
What You Can Do with ... Section 1 Introduction

• Horizontal navigation throughout a group of functions or the entire system.


• Vertical navigation - top down, bottom up - throughout the functional
hierarchy.
• Aspect System Integration, navigation to other aspect systems via context
menus.
• Display of on-line values from OPC server(s).
• Automatic MMS communication for connections across different applications.

What You Can Do with ...


Function Designer provides a Component view and a Diagram view on a Function
aspect.
Within Component view, graphical symbols are designed, which represent an
Aspect Object type or an Aspect Object. Function Designer is not only provided
with basic graphic components as for example line, box, text and circle. Enhanced
features as ports referencing to a configuration entity in the represented Aspect
Object and the capability to display current values of the Aspect Object within a text
field are elevating the efficiency. Most of the plant control related Aspect Object
types are already shipped with default graphical symbols.
Within Diagram view, Aspect Objects needed to implement a certain control
strategy are arranged on a diagram. The ports of the Aspect Objects can be
connected with an easy drag and drop operation. Interconnections between Aspect
Objects on different pages as those between different diagrams are shown as
connection symbols. The connection can be followed via point and click. Once a
function diagram Aspect Object gets inserted into Control Structure, the appropriate
code for the control system devices as AC 800M controller and I/O devices gets
created. Once the control logic is downloaded, Function Designer can show on-line
values from OPC server(s) at selected components, ports, and connection links.
Both views not only allow to place basic graphic components, they are enabled to
host bitmaps and controls (e.g. ActiveX and Graphic Elements made with Graphics
Builder).

46 3BDS011224R4101
Section 1 Introduction What’s New in This Release

What’s New in This Release


To get the news of this release please read the IndustrialIT 800xA – System,
Installation manual.

Prerequisites and Requirements


To get the actual requirements and recommendations please read the IndustrialIT
800xA – System, Installation manual.

3BDS011224R4101 47
Prerequisites and Requirements Section 1 Introduction

48 3BDS011224R4101
Section 2 Installation

Function Designer as a component of the Engineering Workplace of 800xA is


installed according to the instructions in the IndustrialIT 800xA – System,
Installation manual.

3BDS011224R4101 49
Section 2 Installation

50 3BDS011224R4101
Section 3 Configuration

Before You Start


System Creation
System creation is described in the IndustrialIT 800xA – System, Installation
manual.
During the system creation phase the Configuration Wizard will present a
System Extension dialog where you can check the system extensions or
components which you want to have in your system.
To get the Function Designer core functions in your system, check the check box
Function Designer.
To get additional Function Designer functions, e.g. for CBM / AC 800M
integration, or for Fieldbus Builder P/H integration, additionally check Function
Designer for AC800M or Function Designer for FB P/H, respectively.

Getting Started
Application Start-up
To start-up Function Designer, click right the My ePlant icon on your PC’s desktop
to open the context menu, then point to the appropriate system name (for example,
MySystem35) to open the next, cascaded context menu and then click on
Engineering Workplace. Engineering Workplace is the recommended workplace,
as it adds some useful engineering commands and functions to the Advanced

3BDS011224R4101 51
Application Start-up Section 3 Configuration

context menu of aspect objects, e.g. Bulk Data Manager and I/O Allocation.
However, Function Designer runs within Plant Explorer Workplace, too.

Figure 3. Start-up of Engineering Studio

The Engineering Workplace / Plant Explorer gets opened for your selected
system.
In Engineering Workplace or Plant Explorer Workplace select Functional Structure.
Create or open a Function Aspect of any Aspect Object, select Component view or
Diagram view, and Function Designer will start up.
Now the Function Designer is ready to be used to design function components and
function diagrams.

52 3BDS011224R4101
Section 3 Configuration Application Start-up

Aspect Area

Structure Browser

Preview Area

Figure 4. Engineering Workplace / Plant Explorer

If you click Engineering Workplace directly on the context menu, the Plant
Explorer gets opened for the last started system which is marked in the context
menu by an asterisk (e.g MySystem35*).
Choose Functional Structure from the drop down list in the upper left area of the
Engineering Workplace / Plant Explorer, and select the aspect object of interest

3BDS011224R4101 53
Application Start-up Section 3 Configuration

from the Functional Structure tree. The aspects of the selected aspect object are
displayed.

Figure 5. Aspects Objects in Engineering Workplace / Plant Explorer

Click on the Function aspect and Function Designer displays a function diagram in
Plant Explorer’s preview area (more exactly, the Function aspect’s Diagram view
gets displayed) (Figure 6).This preview offers full functionality for working with
function diagrams.
To open Function Designer in a separate window, that can be maximized to use the
complete screen (Figure 7), double-click the Function Aspect. Alternatively, right-
click the Function Aspect and choose Diagram from the context menu. Choosing
Component from the context menu, you also can directly open the Function
Aspect’s Component View.

54 3BDS011224R4101
Section 3 Configuration User Interface

User Interface
Function Designer runs inside Plant Explorer. Recommended workplace is the
Engineering Workplace, but you can also use the Plant Explorer Workplace.
User interface of Function Designer is either the preview window within the Plant
Explorer window or the separately opened Function popup window. Indicator in
any case is the :Function suffix in the drop down list on top of the window area,
respectively the corresponding window title.
Function Designer menus, toolbars, and windows are displayed within Plant
Explorers preview window as well as in any Plant Explorer overlap window.
Typically you will set the Function Designer user interface preferences in a manner
that inside preview window only a minimal set of menus, toolbars and windows is
displayed, whereas inside Plant Explorer popup windows all user interface controls
and windows are displayed.

3BDS011224R4101 55
User Interface Section 3 Configuration

Figure 6. Function Designer in Plant Explorer Preview Window

56 3BDS011224R4101
Section 3 Configuration User Interface

Figure 7. Function Designer in Plant Explorer Popup Window

Find a more detailed description of the user interface in chapters


• Exploring the Windows User Interface
• Working with Menus (menu reference)
• Working with Toolbars (toolbar reference)
• General Accelerator Keys (accelerator key reference).

3BDS011224R4101 57
Preference Settings Section 3 Configuration

Preference Settings
Function Designer stores recent settings and preferences according to their scope:
• Function Settings
System wide settings like visibility of port parameters, instantiation kind, and
rules are stored within the Function settings aspect, see Figure 8.
– The function settings DefaultIsVisible, InitvalIsVisible, NameIsVisible,
and DescriptionIsVisible show/hide corresponding port parameters on
instantiation of function blocks and control modules. The default settings
in Figure 8 automatically hide port parameters of control modules with
default or initial values (need not to be connected), and show ’Name’ and
’Description’ and other parameters which need to be connected.
– The function setting InstantiateComponents sets the instantiation kind.
According to that setting, new components in a function diagram are
either created as function component aspect object, visible in Functional
Structure, or as function component symbol object, visible on the diagram
only.
– The function setting DefaultName determine the name pattern used on
instantiation of variables, diagram references, diagram parameters, field
devices, IO signals, functions, function blocks and control modules.
$DiagramName_$ObjectTypeName generates a default name that takes

58 3BDS011224R4101
Section 3 Configuration Preference Settings

the diagram name as prefix, adds a ’_’, the object type name, and a unique
running number 1,2...N. E.g. TI1001_PidLoop1.

Figure 8. Function Settings

• Workspace in Function aspect


Recent function component / diagram settings like zoom factor, grid properties,
default component properties are stored in a workspace within Function aspect.
I.e. these settings are kept per function component / diagram.
• Windows registry
User interface preferences including maximized popup window, customized
toolbar settings and dockable windows are stored per user and per view in a
workspace in the Windows registry. The first time you run Function Designer,
all toolbars and dockable windows are visible by default. You can arrange

3BDS011224R4101 59
Object Type Definition and Usage Section 3 Configuration

windows and toolbars as you like. Next time you run Function Designer on the
same view, the window/toolbar workspace gets restored.
There are four separate workspaces:
– Plant Explorer preview window, Component view
– Plant Explorer preview window, Diagram view
– Plant Explorer popup window, Component view
– Plant Explorer popup window, Diagram view
If you had installed a previous version, some newly added toolbar buttons may
not be initially visible. To return to the default toolbars, and to make all toolbar
buttons visible, use the menu command View > Toolbar > Customize. Select
each toolbar and click Reset. Do this for the Component view and the Diagram
view, both in preview and in popup window of Plant Explorer.

If this doesn't help, for example, if some toolbar buttons are still not visible, open the
Windows 2000/XP registry (run regedit) and delete the following keys:
• HKEY_CURRENT_USER\Software\ABB Automation Products
GmbH\EngineerIT\FuDiagramDesigner
• HKEY_CURRENT_USER\Software\ABB Automation Products
GmbH\EngineerIT\FuComponentDesigner

Object Type Definition and Usage


The reason to build and to use object types is similar to why you would build typical
solutions. It makes it possible for you to get dedicated, specialized and tested
model- or pattern- objects to create true Aspect Objects out of them in your project.
Thus, Object Types decrease the engineering effort and increase the quality.
If you want to have Function aspects on your Object Types, there are three modes to
use Function aspects.
At creation of an Aspect Object out of your Object Type - which includes a Function
aspect

60 3BDS011224R4101
Section 3 Configuration Object Type Definition and Usage

• the Function aspect can be used as template or


• the Function aspect is copied or
• the Function aspect is inherited.
The used as template mode means, that at creation of an Aspect Object out of your
Object Type the Function aspect is not copied but if you create a Function aspect
sometime later, the one which was created on your Object Type will be used, i.e.
copied.
The copied mode means that at creation of the Aspect Object the Function aspect is
copied.
The inherited mode means that at creation of the Aspect Object the Function aspect
will not be copied but referenced.
For details about how to create object types please refer to IndustrialIT 800xA –
System, Configuration.

Function component instances typically comprise both inherited and copied data.
You might inherit e.g. the symbol and interface definition from an object type, but
store component properties including connections in a separate, copied aspect.
That’s why Function Designer uses two aspects:
• The Function aspect that is typically inherit.
• The Function Parameter aspect that is typically copied.
Function Designer automatically creates, copies and deletes the Function
Parameter aspect together with the Function Aspect. The Function Parameter
aspect is not intended to be created, copied, or deleted manually. If you do so, you
might get inconsistent data. Do not manually create, copy, or delete the Function
Parameter aspect.

3BDS011224R4101 61
Tutorial Section 3 Configuration

Figure 9. Example Object Type Definition with Function Aspect and Function
Parameters Aspect

Tutorial
This tutorial is intended to give beginners a first insight and overview on how to use
the Function Designer at the example of some use cases:

62 3BDS011224R4101
Section 3 Configuration Enhancing a User-Defined Object Type for Use in Function Designer

• Enhancing a User-Defined Object Type for Use in Function Designer


• Customizing a Function Component
• Valve Control with AC 800M
• Nested Diagram
• Diagram Types

Enhancing a User-Defined Object Type for Use in Function Designer


In this tutorial, you will learn what to do, to enhance an Aspect Object of any library
for using in Function Designer. Any library means not only Control Builder M
libraries, or Control Builder M application defined libraries, but also any other ones
like e.g. Fieldbus Builder libraries.

Use Case Description


An existing object type shall be prepared for usage in Function Designer. The
example uses the ValveUniM Aspect Object Type in the Process Extended Library
of the AC 800M Connect product.

Tutorial Step by Step


The tutorial consists of the following parts:
• Selecting an Aspect Object Type
• Adding a Function Aspect (Component View)

Selecting an Aspect Object Type


1. Open the Engineering Workplace or Plant Explorer Workplace.
2. Select Object Type Structure from the drop-down list in the structure browser
window.

3BDS011224R4101 63
Enhancing a User-Defined Object Type for Use in Function Designer Section 3 Configuration

3. Select the Aspect Object type ValveUniM located in Object Types\Control


System\AC 800 M Connect\Libraries\ProcessObjExtLib\Control Module
Types.:
The figures below might not reflect the newest CB library version installed on
your system. You can safely proceed with the newest available library version
instead.

Figure 10. Tutorial: Aspect Object types in the Object Type Structure

64 3BDS011224R4101
Section 3 Configuration Enhancing a User-Defined Object Type for Use in Function Designer

Adding a Function Aspect (Component View)


The following tutorial steps can be skipped if the Aspect Object type ValveUniM
already got its Function Aspect from an update of system extension Function
Designer for AC800M. To see how it works anyway, you can safely delete the
Function Aspect of ValveUniM and proceed with step 1 below.
1. Click right on the Aspect Object type ValveUniM and choose New Aspect
from the context menu. The New Aspect dialog appears.
2. In the New Aspect dialog, mark the option List presentation. In the aspect
system structure, all available aspect types are listed alphabetically.
3. Select Function from the list of aspects and click Create (Figure 11).
The new Function aspect automatically creates an XML type definition in its
Component view. The XML type definition is extracted from the corresponding
CBM library. Now, the Aspect Object type is enhanced to a function component
type and can be instantiated in a function diagram of the Function Designer.
If the Function aspect cannot be created because of a missing library in
Control Builder M, follow the instructions displayed in the error message box
(that means start Control Builder M, create/open a project, and insert the missing
library).

3BDS011224R4101 65
Enhancing a User-Defined Object Type for Use in Function Designer Section 3 Configuration

Figure 11. Tutorial: Creating a Function aspect

Component Views
If a Function aspect’s Component view only defines an XML type definition (see
Figure 11), that means neither a fixed graphical symbol nor a component template,
Function Designer searches for a component template on the parent object, then on
the grand parent and so on, to automatically create a symbol based on the template
and the XML type definition on instantiation. If no component template is found in

66 3BDS011224R4101
Section 3 Configuration Customizing a Function Component

the parent path, the default template is used: Aspect System Structure Function,
Aspect Category:

Figure 12. Default template for function components

Customizing a Function Component


In this tutorial, we will customize a function component type. We will change the
representation of the function component type ValveUniM located in the
ProcessObjExtLib (Process Object Extended Control) library of the aspect system
AC 800M Connect. Changing the function component type will automatically
update all instantiated function components with inherited (not overridden)
Function aspect.

Use Case Description


The Object Type exists and has a Function aspect. The view of the graphics, e.g. the
components symbol definition and or the ports are to be changed. The example uses
the ValveUniM Aspect Object Type in the Process Extended Library of the AC
800M Connect product.

3BDS011224R4101 67
Customizing a Function Component Section 3 Configuration

Tutorial Step by Step


The tutorial consists of the following steps:
• Creating a Complete Function Component Definition (Fixed Symbol)
• Customizing a Function Component
If you use Control Builder M (CBM) function blocks, control modules, and data
types in Function Designer, CBM must be running and a CBM project with the
corresponding library must be open.
Otherwise, if you try to insert such objects in a function diagram, you will get an
error message like the following:

Creating a Complete Function Component Definition (Fixed Symbol)


Function aspect (Component view) of control module type ValveUniM only defines
a XML type definition. To add a customized function component definition (fixed
symbol) for the representation in a function diagram, do as follows:
1. Select the Function aspect from the Aspects of ’ValveUniM’ list.
2. Choose Function Designer’s File > New menu command. The New dialog
appears (see also New Function Component, Figure 254).

68 3BDS011224R4101
Section 3 Configuration Customizing a Function Component

3. Choose Component and click OK. A new window is opened in Function


Designer to define the (fixed) graphical symbol.

Window for defining a


function component’s
fixed graphical symbol

Figure 13. Tutorial: Creating complete function component definition


(fixed symbol)

Customizing a Function Component


In Function Designer Component view, you can use menu and/or toolbar commands
(see Working with Menus/Working with Toolbars) to build up/modify the symbol
for representing the function component in function diagrams. Table 3 lists some

3BDS011224R4101 69
Customizing a Function Component Section 3 Configuration

toolbar buttons which can be used for creating/modifying a symbol. The finally
customized symbol is displayed in Figure 14.

Table 3. Tools for creating a symbol

Tool Description
To use for drawing the box (rectangle).

To use for adding line ports for connections to the symbol.

To use for adding a text component to a symbol.

Adding a text component

Adding a line port

Drawing a box

Figure 14. Customized Symbol for a ValveUniM Control Module Type

To customize the symbol, do as follows:


1. The Component view of the function component type should be still open. If
not, click right on the Function aspect in the Aspects of list of the Workplace
window and choose Component from the context menu.
2. Click and draw a box (rectangle) as body for the valve symbol.

70 3BDS011224R4101
Section 3 Configuration Customizing a Function Component

3. Click right on the box to open the context menu and choose Component
Properties. The Component Properties dialog appears.
4. Choose the Fill page in the Component Properties dialog and set the colors
according to the following figure.

Figure 15. Tutorial Valve Control: Setting symbol color.

5. Click and draw line ports for the input and output connections.
6. Click and insert text components for designating the ports according to
the parameter name of the corresponding control module, function, or function
block.
7. Set the references between the (line) ports and the parameters of the
corresponding control module, function, or function block by entering the

3BDS011224R4101 71
Customizing a Function Component Section 3 Configuration

parameter names (used also as port designation in the previous step) into the
Name field of the General page on the ports Component Properties dialog.

Figure 16. Setting the port name to the designation used in the symbol.

8. Click and add a text component (symbol name) with an aspect property
reference to ValveUniM’s Name Aspect. By that, changes in the instance name
will get automatically reflected in function diagrams. Do as follows and see
also Figure 17:
a. Open the Field page on the Component Properties dialog.
b. Choose Aspect Property Reference and click on . The Aspect
Property Reference window is opened, the ValveUniM control module
type is selected.
c. Choose the Name Aspect’s Name Property and as Reference Type
relative to same obj, then click OK.

72 3BDS011224R4101
Section 3 Configuration Customizing a Function Component

d. In the Component Properties dialog, click Add, then OK.

o
Figure 17. Setting a reference to the symbol name

3BDS011224R4101 73
Valve Control with AC 800M Section 3 Configuration

Line (circle) ports should be named exactly same as the parameters of the
associated control module, function or function block. By that, a reference is
created between the graphical port and the aspect property/parameter. The name
referencing is case insensitive. You see the exact name of ports in XML
description.

Valve Control with AC 800M


In the following tutorial, we will engineer a Valve Control with the Function
Designer. We will create a function diagram using the customized ValveUniM
control module type of the previous example and some standard Aspect Object
types provided by AC 800M Connect and by Function Designer.

Use Case Description


The Valve Control example is based on the following assumptions:
• The control will be implemented using standard object types shipped with the
AC 800M product.
• The function component of the ValveUniM control module type is customized
as in the use case above.
• The Valve Control block is called XV123, the measurements ZSO123 and
ZSC123, the output XS123. The aspect object hosting the solution is labeled
XV123s.

Tutorial Step by Step


The tutorial consists of the following steps:
• Creating Functional Structure
• Creating a Function Diagram
• Allocating the Allocatable Groups

Creating Functional Structure


For our example, we build up a hierarchical Functional Structure consisting of a
(plant) site, (plant) area and a mixing unit. For it, do as follows:

74 3BDS011224R4101
Section 3 Configuration Valve Control with AC 800M

1. Open the Workplace window.


2. Click in the background of the Functional Structure browser window and
choose New Object from the context menu. The New Object dialog appears.
3. In the New Object dialog, choose *Generic Type.
4. Enter Plant A into the Name field and click Create.

Figure 18. Tutorial Valve Control: New Object of type Site

5. Click right on the newly created Aspect Object Plant A of type Site and choose
again New Object from the context menu.
6. Select *Generic Type in the New Object dialog, enter Train A into the Name
field and click Create.
7. Click right on the newly created Aspect Object Train A and choose again New
Object from the context menu.
8. Select *Generic Type in the New Object dialog, enter Reactor 1 into the
Name field and click Create.
9. Click right on the newly created Aspect Object Reactor 1 and choose again
New Object from the context menu.

3BDS011224R4101 75
Valve Control with AC 800M Section 3 Configuration

10. In the New Object dialog, Select *Generic Type, enter XV123S into the
Name field and click Create.
Now, you should have a Functional Structure consisting of Aspect Objects as shown
in the following figure:

Figure 19. Tutorial Valve Control: Functional Structure

Creating a Function Diagram


The Aspect Object XV123S shall host the function diagram. To create the function
diagram, do as follows:
1. Click right on the newly created Aspect Object XV123S in the Functional
Structure and choose New Aspect from the context menu. The New Aspect
dialog appears.
2. In the New Aspect dialog, mark the Show all check box and unmark the List
presentation check box.

76 3BDS011224R4101
Section 3 Configuration Valve Control with AC 800M

3. Navigate through the Aspect tree via Aspect System Structure\Function


Designer\Function to Function and click Create. The Aspect Object XV123S
gets a Function aspect.

Figure 20. Tutorial Valve Control: New Function Aspect

4. Click right on the newly created Function aspect of the Control Valve Aspect
Object XV123S and choose Diagram from the context menu. The Function
Designer is opened.
5. Choose Function Designer’s File > New menu command. Select a predefined
diagram template (e.g. A3 Portrait) - or a blank one. A new function diagram

3BDS011224R4101 77
Valve Control with AC 800M Section 3 Configuration

with logic layer including chosen template is opened within the Function
Designer window.

Figure 21. Tutorial Valve Control: New function diagram

Filling the Function Diagram


1. In the Function Designer’s structure browser window, open the Object Type
Structure.

78 3BDS011224R4101
Section 3 Configuration Valve Control with AC 800M

2. Insert the objects listed in Table 4 into the function diagram via drag and drop
from the Object Type Structure to the function diagram.
Depending on the Object Type Definition Create Info and Function Settings an
instantiated (newly created) object will be placed only in the function diagram as
symbol object or additionally in the Functional Structure as an Aspect Object.
Depending on the Function Settings default names for field devices, IO signals,
function blocks and control modules are prefixed by the diagram name
$DiagramName - or not.
To get the same as results as shown in this tutorial, set
[Object Type Structure]Object Types/Functional Planning/Settings:
Function Settings.InstantiateComponents = AccordingTypeDefCreateInfo
Function Settings.DefaultName.FieldDevice = $ObjectTypeName
Function Settings.DefaultName.IO Signal = $ObjectTypeName
Function Settings.DefaultName.Function Block = $ObjectTypeName
Function Settings.DefaultName.Control Module = $ObjectTypeName.

The newly created (inserted) Aspect Objects will be located in the Functional
Structure below the corresponding parent object XV123S:

3BDS011224R4101 79
Valve Control with AC 800M Section 3 Configuration

Figure 22. Tutorial Valve Control: Functional Structure

Table 4. Tutorial Valve Control: Objects for the function diagram

Default Object
Object Type Path Object Type
Name Name
Object Types\Control System\AC600M/C
and(bool) and1 and1
Connect\System Functions\Functions

Object Types\Functional Planning\Generic Function


Input Input1, SC1_1,
Components\Connectors\Diagram Parameters
Parameter Input2 SC1_2
Object Types\Control System\AC 800M Connect\
CBM_DOS CBM_DOS1 XS123
CBM_Signals
CBM_DIS CBM_DIS1, ZSC123,
CBM_DIS2 ZSO123
Object Types\Control System\AC 800M
ValveUniM ValveUniM1 XV123
Connect\Libraries\ProcessObjExtLib\
Control Module Types

3. After instantiation of the function components from Table 4, right click on the
individual components in the function diagram and select their Name Aspect.
Rename their default name according to Table 4. Please observe that the
function components get automatically renamed on the function diagram, too.

80 3BDS011224R4101
Section 3 Configuration Valve Control with AC 800M

Figure 23. Tutorial Valve Control: Implemented function diagram

Within an AC 800M based system, libraries for control module types, function
block types, functions and fieldbus device types are prepared to be used in the
Function Designer.
4. Connect the connection ports according via drag and drop (see also
Connections/Networks).

Allocating the Allocatable Groups


When functional planning in Functional Structure has been finished, the prepared
solutions are allocated to corresponding objects in Control Structure. This allocation
is done via allocatable groups (see also Grouping Function Components into
Allocatable Groups). Each function diagram automatically has an allocatable group
aspect too.

3BDS011224R4101 81
Valve Control with AC 800M Section 3 Configuration

To allocate the Aspect Object XV123S in the Control Structure, that means to insert
its allocatable group below the control module group within the Control Structure,
do the following:
1. Select the Functional Structure from the structure browser window within the
Workplace window.
2. Select Allocatable Group Aspect.

Figure 24. Allocatable Group Preview Window

82 3BDS011224R4101
Section 3 Configuration Valve Control with AC 800M

3. Click on Allocate and choose Application 1.

Figure 25. Tutorial Valve Control: Allocation of allocatable groups (function


diagrams)

4. Choose Generate Configuration Data.

Creating I/O Modules


For the I/O signals we need respective hardware units (I/O modules). To create them
in Control Structure, do the following:
1. Select the Control Structure from the structure browser window within the
Workplace window.
2. In the Control Structure, navigate to Root, DomainControl Network, Control
Network\Plant_A, Control Project\Controllers, Controller
Group\Controller_1, AC 800M\Hardware, Controller Hardware Group\0,
PM860 / TP830\11, Module Bus.
3. Click right on 11, Module Bus and choose New Object from the context
menu. The New Object dialog appears.
4. In the New Object dialog, mark the check box List presentation and choose
the module DI810/DO810 from the list.

3BDS011224R4101 83
Valve Control with AC 800M Section 3 Configuration

5. Enter 1 into the Name field and click Create.


The Name you enter here is not the Name property of the Aspect Object’s Name
Aspect but the Name of the Hardware Unit Aspect. Both names can differ. By
default, on creating a new I/O module, both names are identically.

Name property of
Hardware Unit Aspect

Figure 26. Tutorial Valve Control: Creating a new I/O module

84 3BDS011224R4101
Section 3 Configuration Valve Control with AC 800M

Name property of
Name property of
Hardware Unit Aspect
Name Aspect

Figure 27. Tutorial Valve Control: Name Aspect of the newly created I/O module

Allocating I/O Signals


For each input signal, do the following:
1. Click right on the newly created I/O module 1, DI810 and choose Insert
Object from the context menu.
2. In the Insert Object browser window, choose Functional Structure from the
drop down list and select the CBM_DISn (n = 1, 2) input signal located below
Plant A\Train A\Reactor 1\XV123S.

3BDS011224R4101 85
Valve Control with AC 800M Section 3 Configuration

3. Click Insert.

Figure 28. Tutorial Valve Control: Insert I/O signal into Control Structure

1. Click right on the newly created I/O module 1, DO810 and choose Insert
Object from the context menu.
2. In the Insert Object browser window, choose Functional Structure from the
drop down list and select the CBM_DOS1 output signal located below Plant
A\Train A\Reactor 1\XV123S.

86 3BDS011224R4101
Section 3 Configuration Valve Control with AC 800M

3. Click Insert.

Figure 29. Tutorial Valve Control: Control Structure with allocated I/O signals

You can allocate the signals in the Control Structure also by Shift+Ctrl drag and
drop of signal component(s) from within the function diagram into Control
Structure.
4. Define Channel number of CBM Signals. In Control Structure select
CBM_DIS1. From context sensitive menu choose channel number.
A much more efficient method for allocation of multiple signals is provided by
the IO Allocation tool included in Engineering Studio.

3BDS011224R4101 87
Valve Control with AC 800M Section 3 Configuration

Control Structure and Control Builder M


The Function Designer automatically configures the Control Builder M. The
configuration parameter of the input and output devices will be copied into the
hardware units configuration. Global and External Variables for the I/O connection
will be created and the connections from the control modules to the hardware units
will be closed. The interconnection between the control modules will be closed via
local variables in the hosting single control module.

Figure 30. Tutorial Valve Control: Single Control Module

Figure 31. Tutorial Valve Control: Application Variables

Now, the application is implemented ready to be downloaded.

88 3BDS011224R4101
Section 3 Configuration Nested Diagram

Nested Diagram
The following tutorial shows you how to use nested diagrams in functional
planning. Scope of the example is also the import of project data, generating
configuration data for Control Builder M (CBM) and simulation of the solution.
The tutorial is divided into the following parts:
• Start Engineering Tools
• Import Functional Structure and Control Structure
• Allocate Diagram to Control Application
• Generate Configuration Data for CBM
• Allocate IO
• Establishing Task Connection in Control Builder M
• Simulation in Control Builder M
• Configure OPC Server
• Go Online in CBM
• Display Online Values in Function Designer
• Force Channel in CBM
• Set Interaction Values in CBM
• Values in CBM Online Editor

Start Engineering Tools


Prerequisites
PPA, CBM, Engineering Platform, etc. installed according release notes valid for
the actual release.
The following System Extensions are needed:

3BDS011224R4101 89
Nested Diagram Section 3 Configuration

Figure 32. System Extension for PidLoopProj

Be sure not to have an existing CBM project named PidLoopProj ! Otherwise


data could be corrupted or get lost!

1. Start the Engineering Workplace.

Import Functional Structure and Control Structure


2. Click the import icon in the workplace toolbar. The Afw Import/Export
tool gets started.
3. Choose File > Open. Open dialog gets displayed.
4. From the Open dialog, select the import files
– PidLoopExample.afw

90 3BDS011224R4101
Section 3 Configuration Nested Diagram

located in \manual import folder (see Table 5).

Table 5. Source of the delivered CBM demo project

Path(1)
Source C:\Program Files\ABB Industrial IT\Engineer IT\Engineering
Studio\Function Designer\AC 800M Integration\Function
Designer\manual import
(1) The source path depends on the installation of Function Designer

5. In the Import/Export window, choose the Actions > Import All menu
command. Answer Yes to all questions.
If the import was successfully, you will get the message: Import all completed
successfully. Then you will find the following function diagram in the

3BDS011224R4101 91
Nested Diagram Section 3 Configuration

Functional Structure. How to create/edit such nested diagrams is described in


detail on p. 218, Vertical Navigation.

Nested
Diagram

Figure 33. Tutorial: Function diagram Loop1 with nested Hysteresis diagram

92 3BDS011224R4101
Section 3 Configuration Nested Diagram

6. Set hysteresis parameters (aspect properties) to complete the function diagram:


a. Open the function diagram of the Loop1 Aspect Object in the Functional
Structure.
b. Click right on the function component Hysteresis and choose Aspect
Properties from the context menu. The Aspect Properties window is
opened.
c. Select the Ports property page.
d. Enter the values for the parameters X1, X2, Y1, Y2 into the Value column
as displayed in Figure 34.
e. Click OK.

Figure 34. Tutorial: Hysteresis parameters (aspect properties)

Please observe that the hysteresis parameters in the function diagram are
updated automatically. You can also change the corresponding connect strings
directly in the diagram. Use the Connect toolbar functions, or in-cell edit the
connect string at the ports.

3BDS011224R4101 93
Nested Diagram Section 3 Configuration

7. Open Control Builder project PidLoopProj by right click on the project aspect
of PidLoopProj.

Figure 35. Open Project

Allocate Diagram to Control Application


8. Allocate Object Loop1 into Application_1:
a. Open the Functional Structure Object Loop1.
b. Select Allocatable Group Aspect.

94 3BDS011224R4101
Section 3 Configuration Nested Diagram

c. Press Allocate Button and choose Application_1

Figure 36. Allocate Diagram to Control Application

3BDS011224R4101 95
Nested Diagram Section 3 Configuration

Generate Configuration Data for CBM


9. Press the Generate Configuration Data Button of the Allocatable Group
Aspect:

Figure 37. Generate Configuration Data in Allocatable Group Aspect

96 3BDS011224R4101
Section 3 Configuration Nested Diagram

10. Check the result in CBM.

Figure 38. Control Module LOOP1 in CBM

Allocate IO
11. Start IO allocation
a. Click right by mouse on Controller within Control Structure

3BDS011224R4101 97
Nested Diagram Section 3 Configuration

b. Choose in context sensitive menu Advanced > IO Allocation


Note: Advanced menu is available in Engineering Workplace, but not in
Plant Explorer Workplace.

Figure 39. IO-Allocation in Engineering Workplace

c. Change to Functional Structure.


d. Drag & Drop Loop1 into IO Allocation Workspace.

Figure 40. Signals in IO-Allocation Tool

98 3BDS011224R4101
Section 3 Configuration Nested Diagram

e. Move ExtSP1 with mouse below 1 AI820. ExtSP1 becomes channel 1

Figure 41. Place Signals in IO-Allocation Tool

f. Write Allocation into CBM by Edit > Write Allocation into CBM

Figure 42. Write Allocation into CBM in IO-Allocation Tool

3BDS011224R4101 99
Nested Diagram Section 3 Configuration

12. Check Allocation in CBM.


Open AI820 in CBM Editor and check variable. You can see them in TAB
Connections.

Figure 43. IO Allocation in CBM

Establishing Task Connection in Control Builder M


Control Builder M should run, and be the active window. The PidLoopProj project
should be open.
13. In Control Builder M, click right on Application_1 and choose Task
Connection from the context menu. The Task Connection dialog appears.
14. In the Task Connection dialog, choose Controller_1.Normal from the Task
drop-down list box.

100 3BDS011224R4101
Section 3 Configuration Nested Diagram

15. Click OK.

Figure 44. Tutorial: Task connection in Control Builder M

Simulation in Control Builder M


16. Start SoftController
In StartMenu>...>Control and IO>.. select SoftController. Click Start Button to
start SoftController.

Figure 45. Start SoftController

3BDS011224R4101 101
Nested Diagram Section 3 Configuration

17. Change System Identity of Controller in CBM to your local IP Address or use
127.0.0.1:2 instead. Note: add :2 to the IP address. In CBM select Controller
and choose System Identity from context sensitive menu.

Figure 46. Set System Identity for SoftController

102 3BDS011224R4101
Section 3 Configuration Nested Diagram

18. Choose Simulate Hardware from context sensitive menu

Figure 47. Simulate Hardware in CBM

Configure OPC Server


19. Start OPC Server:
In StartMenu>...>Control and IO>... select OPC Server for AC 800 M.
Select View > Available Controllers. Select IP Address of SoftController and
Drag & Drop to field Controller Identity. Choose Connect.

3BDS011224R4101 103
Nested Diagram Section 3 Configuration

After successful connection the OPC Server Configuration should look as


shown in Figure 48.

Figure 48. OPC Server Configuration

20. Establish OPC Connection within PPA


Adapt Basic Service Group:
Go to Service Structure.
Select Services > Alarm & Event >, Service > Basic, Service Group
Select Aspect Service Group Definition
Select Tab Special Configuration
Select Add
Choose from OPC Alarm Servers Dialog the entry
ABB.AC800MC.OpcAeServer.3
Choose Apply.

104 3BDS011224R4101
Section 3 Configuration Nested Diagram

The result is shown in Figure 49.

Figure 49. OPC Connection within PPA, Basic Service Group

21. OPC Data Source Definition

Go to Control Structure
Select Control Network
Select Aspect OPC Data Source Definition
Create new service group see Figure 50.

3BDS011224R4101 105
Nested Diagram Section 3 Configuration

Add service provider: choose your PC


Choose Apply

Figure 50. OPC Connection within PPA, Data Source Definition

106 3BDS011224R4101
Section 3 Configuration Nested Diagram

Go Online in CBM
22. Choose Tools > Download Project and Go Online.
Choose Continue in Simulate Analysis Dialog. Choose Continue in case of
messages.

Figure 51. Download and Go Online

Display Online Values in Function Designer


23. Go to Functional Structure
Select Loop1
Open Function Diagram
24. Select Port or Connection you like to display and choose Add to Display List,
see Figure 52.
25. Select Online > Subscribe for Live Data, see Figure 53.

3BDS011224R4101 107
Nested Diagram Section 3 Configuration

26. Use Online > Watch Window to display and set specific values, see Figure 54.

Figure 52. Function Designer Online, Add to Display List

108 3BDS011224R4101
Section 3 Configuration Nested Diagram

Figure 53. Function Designer Online, Subscribe for Live Data

3BDS011224R4101 109
Nested Diagram Section 3 Configuration

Figure 54. Function Designer Online, Use Watch Window

110 3BDS011224R4101
Section 3 Configuration Nested Diagram

Set Interaction Values in CBM


27. Click right on the PidSimpleReal1 object in the project explorer and choose
Interaction Window from the context menu. The PidSimple window is
opened.
28. Click in the PidSimple interaction window to start the automatic
controlling.
29. From the PidSimple interaction window, you can open other interaction
windows by clicking on the corresponding icon (see Figure 55).

3BDS011224R4101 111
Nested Diagram Section 3 Configuration

30. Set Values of PidSimple: Gain to 1.00, Ti(s) to 2.00.

Block Diagram Controller Parameters

History

Figure 55. Tutorial: Interaction windows for simulation of the functional logic

112 3BDS011224R4101
Section 3 Configuration Nested Diagram

Force Channel in CBM


31. Select Hardware Unit AI820 and open Editor. Force channel 1 to value 50.

Figure 56. Force Channel in CBM

Values in CBM Online Editor


To display the actual values of a single control module running in Simulate mode,
do as follows:
32. Select the wanted single control module (PidDemo1 / Hysteresis) in Control
Builder M’s project explorer.
33. Click right on the single control module and choose Online Editor from the
context menu (see Figure 57 and Figure 58).

3BDS011224R4101 113
Nested Diagram Section 3 Configuration

34. To get information or to set a value in the Function Designer generated code
(blocks) of single control module, click right on the terminal/port/connection
and choose Information or Set Value from the context menu (see Figure 57).

Figure 57. Tutorial: Function Designer generated code of single control module
PidDemo1

114 3BDS011224R4101
Section 3 Configuration Diagram Types

Figure 58. Tutorial: Function Designer generated code of nested single control
module Hysteresis

Diagram Types
In the following tutorial, you learn how to create a diagram type and how to
instantiate this diagram type in Functional Structure.

3BDS011224R4101 115
Diagram Types Section 3 Configuration

Diagram types are created as part of user defined libraries and are represented as
control module types in Control Builder. Instances of these predefined solutions are
created later in Functional Structure.
Restrictions of diagram types:
• Diagram references are used to inter-connect function diagrams in
Functional Structure. This does not make sense for types.
• Nested allocatable groups cannot be used.
• CBM Signals with signal information Application Global Variable cannot be
used.
• It is not possible to create an SFC code block in the Control Module Type.
(Create an additional Control Module within Control Builder M.)

Use Case Description


A user defined library is created including function diagram types. These predefined
solutions are later instantiated in Functional Structure.

Tutorial Step by Step


The tutorial consists of the following parts:
• Create User Defined Library
• Create Diagram Types
• Instantiate Diagram Types in Functional Structure
• Go online and test application
• Modifications of Diagram types

Create User Defined Library


If you do not have already a CBM project, create a new one.
1. Go to Control Structure
2. Create object Control Network of object type Control Network below object
Root.
3. Create object Project1 of object type Control Project below Control Network

116 3BDS011224R4101
Section 3 Configuration Diagram Types

In Control Builder create a new Library


1. In Control Builder M select Libraries
2. From context sensitive menu choose New Library
3. Type the name of the new library and choose OK.

Figure 59. New library in Control Builder M

Create Diagram Types


1. Select the new library in Object Type Structure.
2. Create new object Control Module Type below Control Module Types.
The object automatically get a formal instance list for the Control Structure see
Figure 60.

3BDS011224R4101 117
Diagram Types Section 3 Configuration

Figure 60. New Diagram Type in Object Type Structure

3. Create new aspect Function.


4. Select Diagram, see Figure 61

Figure 61. Open Diagram in Object Type Structure

5. Select File > New and choose Diagram Template e.g. A4 Portrait
An empty function diagram gets open.

118 3BDS011224R4101
Section 3 Configuration Diagram Types

6. Insert symbols by Insert > Symbol dialog or by drag & drop from Object Type
Structure.
The diagram type can include
– Function Block types from any CBM Library
– Control Module types from any CBM Library
These objects are visible below the formal instance list for the Control
Structure in Plant Explorer object type browser.
– Diagram Parameters
– CBM Signals
CBM Signals need to be set as local variable. Open
CBM_SignalInformation Aspect and choose ’Connect to Local Variable
on CM, FB’ see Figure 62. Signals with connection to application global
variables are not useful in diagram types.

Figure 62. CBM_SignalInformation

3BDS011224R4101 119
Diagram Types Section 3 Configuration

These objects are visible below the formal instance list for Functional
Structure, see Figure 63.

Figure 63. Diagram Type with Formal Instances in Control and Functional
Structure

– Variables
– Functions
These symbol objects are by default not visible in Object Type Structure.
On instantiation of a diagram type, the formal instances are instantiated in the
related structure. By default, control modules and function blocks are not
visible in Functional Structure, because their formal instances are placed in the
formal instance list for Control Structure only.
If control modules and function blocks shall be visible in Functional Structure
too, they can be additionally inserted into the formal instance list for Functional
Structure.
7. Choose File > Generate Configuration Data
A control module type including variables and connections get generated in
Control Builder M.
The diagram type’s state changes from modified to generated.

Instantiate Diagram Types in Functional Structure


Goto Functional Structure and instantiate the diagram type in an existing function
diagram. Drag & drop the diagram type into a function diagram.

120 3BDS011224R4101
Section 3 Configuration Diagram Type Sample

It is possible to navigate to the diagram type via context menu Goto Nested
Diagram. The diagram type instance is read-only, it can be modified only at the
type.
Allocate the diagram to an existing application and generate configuration data, see
Allocate Diagram to Control Application and Generate Configuration Data for
CBM.
Instances of diagram types become control modules in a CB application.

Go online and test application


Go online and test the diagram type, see Go Online in CBM and Configure OPC
Server. You can display online values within the diagram type by navigating to the
nested diagram.

Modifications of Diagram types


Diagram types, which are already instantiated in Functional Structure, can be
modified. This modification is visible in function diagrams in Functional Structure
after reopening of the diagram.
1. In Object Type Structure modify your diagram type and generate configuration
data.
2. In Functional Structure close an open function diagram and reopen it. In case
the interface of the diagram type has changed, the symbol of the diagram type
gets updated. Connections may be lost if names or data types of connections
have been changed.
3. Generate configuration data for your diagram.
It is not recommended to create diagram types as application local control module
types to work in Functional Structure.

Diagram Type Sample


This tutorial presents another more complex diagram type. In this sample we use
• Functions
• Function Blocks
• Control Modules

3BDS011224R4101 121
Diagram Type Sample Section 3 Configuration

• Signals
• Diagram Parameters
• Page References

Import Library
1. Start the workplace Engineering Studio
2. Start Control Builder M
3. Click the import icon in the workplace toolbar. The Afw Import/Export
window appears.
4. Choose File > Open. Open dialog appears.
5. From the Open dialog, select the import files
– EW_ExampleLib.afw
located in \manual import folder (see Table 6).

Table 6. Source of the demo library

Path(1)
Source C:\Program Files\ABB Industrial IT\Engineer IT\Engineering
Studio\Function Designer\AC 800M Integration\Function
Designer\manual import
(1) The source path depends on the installation of Function Designer

In the Import/Export window, choose the Actions > Import All menu
command. Answer Yes to all questions.
6. Check [Object Type Structure]Object Types/Control System/AC 800M
Connect/Libraries/EW_ExampleLib (see Figure 64).
By default, Control Modules and Function Blocks are located into the formal
instance list for Control Structure on instantiation in a diagram type. In addition
you may manually insert these objects into the formal instance list for Functional
Structure using the Insert Object function.
Other objects like IO signals are inserted into the formal instance list for
Functional Structure.

122 3BDS011224R4101
Section 3 Configuration Diagram Type Sample

Do not remove objects from the formal instance list for Control Structure.

The diagram parameters were moved below LC2_PidSCC1 in Functional


Structure.

Figure 64. Example Library in Object Type Structure

3BDS011224R4101 123
Diagram Type Sample Section 3 Configuration

7. Open diagram type EW_LC2 using Function Designer and check both pages
for this type, see Figure 65 and Figure 66.

Figure 65. Page 1 of Sample EW_LC2

124 3BDS011224R4101
Section 3 Configuration Diagram Type Sample

Figure 66. Page 2 of Sample EW_LC2

8. Create a new empty function diagram and insert control module EW_LC2. The
instance gets displayed as in Figure 67

Figure 67. Instance of control module type EW_LC2

3BDS011224R4101 125
Enhanced Naming Section 3 Configuration

By default you have to connect all parameters for a control module inside a
function diagram. For diagram parameters, which must not be connected in each
instance, you can define a default or initial value.
9. Open diagram type EW_LC2 with Function Designer. Click right on the
diagram background to open the Aspect Properties (select Ports property
page), see Figure 68.

Figure 68. Aspect Properties for Diagram Parameter

You can define a default or initial value for the diagram parameters as shown in
Figure 68.

Enhanced Naming
This section contains a description of the enhanced name handling functions in the
Engineering Workplace of System 800xA. They take care of names according to
KKS naming rules and parent-child name concatenation.

126 3BDS011224R4101
Section 3 Configuration Enhanced Naming

Dialog New Component Name


When you insert a new component into a diagram, a dialog prompts for its name and
description. How to insert new components, see Inserting Function Components.
The default name takes the diagram name as prefix, adds a ’_’, the object type name,
and a unique running number 1,2...N. E.g. 1ABC_UniM1. If you have already
existing components of the same type, the default name is the name of an existing
object with a unique running number. The name pattern used in this dialog is
defined in the Function Settings aspect, see Function Settings.

Figure 69. Dialog New Component Name

This dialog may be switched off for specific component types, see Options and
Naming.

3BDS011224R4101 127
Enhanced Naming Section 3 Configuration

Name Conversion
Each Aspect Object in the Plant Explorer has a Name aspect, which contains the
corresponding aspect object name and description. For control objects there is an
additional Control Builder Name (CBName) aspect, which gets synchronized with
the name in Project Explorer, and therefore always follows IEC 61131-3 naming
conventions, see also IndustrialIT 800xA - Control and I/O, Basic Control Software,
Introduction and Configuration. If the control object is created in Plant Explorer and
the name is in conflict with the IEC 61131-3 name restrictions, the aspect system
automatically converts the name so that it follows these rules.
If a name is entered in Plant Explorer that does not follow IEC 61131-3 naming
conventions, the Project Explorer name will be changed to fit the IEC 61131-3
naming conventions. If we, in Plant Explorer, name a tank object "12-1456%tank",
the Control Builder conversion would look like "x12_1456_tank". The automatic
name conversion function always adds an “x” to the beginning of the name and

128 3BDS011224R4101
Section 3 Configuration Enhanced Naming

replaces all non-alphanumeric characters with underscore. If the name is longer than
32 characters, it will be truncated.

Figure 70. Diagram with conflicts to IEC 61131-3 names

Figure 70 shows an example for components with names, which are in conflict with
the IEC 61131-3 name restrictions. The Control Module and the signals have an
additional CBName aspect. The name of the diagram variable and other local
variables have to fulfill IEC 61131-3 name restrictions. Figure 71 and Figure 72
show the Control Builder view for this example.

Figure 71. Objects in Control Builder

3BDS011224R4101 129
Enhanced Naming Section 3 Configuration

Figure 72. Generated Variables in Control Builder

Name Synchronization
For engineering efficiency, Function Designer synchronizes the Name aspect,
CBName aspect, Name parameter and Description parameter. The advantage of
having synchronized names is that objects always have the same name in Plant
Explorer and Project Explorer with the exception of IEC 61131-3 name restrictions,
see Name Conversion.
Many Function Blocks and Control Modules have a Name and Description
parameter, which are important for alarm handling. You connect these parameters to
a constant value or to some logic instead. If the parameters are connected to a
constant, the values are synchronized to the Name aspect.
When an aspect object is renamed, the related CBName aspect and the Name
parameter is updated. When an object description is modified, the related
Description parameter is updated.
Because of that name synchronization you do not need to run Name Uploader for
Function Designer engineered diagrams. In effect, if you do so, name
synchronization is switched off while Name Uploader is running.

Aspect Verb Synchronize Names


Name aspect, Control Builder Name aspect, name parameters and description
parameters are synchronized during engineering. If you right-click on the Function
aspect of a diagram, you may trigger the name synchronization for the diagram and
the related sub-tree manually.

130 3BDS011224R4101
Section 3 Configuration Enhanced Naming

Rename Substructure
When you rename a diagram, the names of the children are renamed too, if these
start with the same prefix. In the following example the diagram 1ABC is copied
with Bulk Data Manager to 1ABD and 1ABE, see Figure 73 and Figure 74.

Figure 73. Excel Sheet for Diagram Copy

Figure 74. Copy Result in Plant Explorer

3BDS011224R4101 131
Aspect Properties/Parameters Section 3 Configuration

When you copy the diagram 1ABC in Plant Explorer, you get a result according to
Figure 75, because Control Builder sets the default name for new objects according
to IEC 61131-3 name restrictions during copy.

Figure 75. Copy Diagram in Plant Explorer

If you use IEC 61131-3 names in a structure like shown in upper part of Figure 75
and use Plant Explorer to copy/paste the parent object, the copied objects have the
same object names as in the source. However, the Control Builder names are
renamed (extended by a number), because of name collisions in the unallocated
application.

Aspect Properties/Parameters
Aspect properties/parameters can be defined in Component view and in Diagram
view for the selected function component, function diagram or port. You can define
properties that get inherited from the object type, or properties that get copied on
object instantiation. Inherit ones are stored within the Function aspect, and copied
ones within the Function Parameter aspect.

132 3BDS011224R4101
Section 3 Configuration Aspect Properties/Parameters Dialog

Use the Aspect Properties dialog (Ports property page) dialog to create, edit, or
delete aspect properties. Their scope depends on the selection:

Table 7. Scope of Aspect Properties / Parameters

View Object Scope


Component view Selected port Aspect properties for the selected port
Any other selected Aspect properties for the whole
object component
Diagram view Selected port Aspect properties for the selected port
Selected function Aspect properties for the selected
component component
Any other selected Aspect properties for the whole diagram
object

Aspect Properties/Parameters Dialog


Access this dialog via the Edit > Aspect Properties menu command or via Aspect
Properties from the context menu.
The dialog has got the following buttons:
– OK
Click OK to save your settings and to close the dialog.
– Cancel
Click Cancel to quit the dialog without saving your setting modifications.
– Apply
Click Apply to save your settings and leave the dialog open.
Dependent on the selection it may contain up to 3 property pages:

3BDS011224R4101 133
Aspect Properties/Parameters Dialog Section 3 Configuration

• Component property page

Figure 76. Aspect Properties dialog (Component property page)

The Component property page shows up if called on a function component


only. Use it to edit or inspect the component’s
– Name
– Control Builder Name (for inspection only)
– Description
– Data Type (for Variables, Diagram Parameters and Diagram References
only)
– Number of Inputs (for certain components e.g. AND, ADD, OR... which
have got the possibilty to control the number of single ports or port
groups)
– Aspect Object property (for all function component except Diagram
References to switch between Aspect Object and Symbol Object)

134 3BDS011224R4101
Section 3 Configuration Aspect Properties/Parameters Dialog

– Attributes (for Variables, Diagram Parameters and Diagram References


only)
• Ports property page

Figure 77. Aspect Properties dialog (Ports property page)

The Ports property page shows up if called on a function component (for the
ports of the component) or on the diagram background (for the diagram
parameters). Use it to edit or inspect the following properties of the ports:
– Name (for inspection only)
– Description (for inspection only)
– Data Type (for inspection only)
– Direction (for inspection only)
– Value (the connection at the port; for ports of direction inout 2 Value
fields show up (the left one for the input, the right one for the output))
– Initial Value

3BDS011224R4101 135
Aspect Properties/Parameters Dialog Section 3 Configuration

– Inverted (for boolean input ports only)


– Visible (checked for visible ports, unchecked for hidden ports)
– Publish As (a name that should be used to access the value property from
the parent diagram; “-” or an empty string if the vaue property is not
published (for more details see Bulk Data Manager Support and Bulk
Operations); for ports of direction inout 2 Publish As fields show up (the
left one for the input, the right one for the output))
• All property page

Figure 78. Aspect Properties dialog (All property page)

The All property page shows up if called on a function component (for all
properties of the component) or on the diagram background (for all properties
of the diagram). Use it to edit or inspect the following properties of the ports:

136 3BDS011224R4101
Section 3 Configuration Aspect Properties/Parameters Dialog

– Name
Define the name of the aspect property/parameter. You can edit the name
directly in the Name cell. Copied and inherited properties share the same
name space. As dot ’.’ is used as separator for structured properties, do not
use a dot in the name.
– Description
Define the description of an aspect property. Enumerated data types use
this description internally “Internal, do not edit...”.
Port parameters selected in a diagram indicate their description in a
tooltip.
– Data Type
Define the data type of the aspect property. You can select the data type
from a drop-down list.
Do not take this datatype as the datatype of port parameters. Port parameters
define a set of properties
• <Parameter>
• <Parameter>.DataType
• <Parameter>.Direction
• ...
see Figure 10. E.g. ’Value = 3.14’, ’Value.DataType = real’. The port parameter
datatype is ’real’, wheras the datatype of the properties ’Value’ and
’Value.DataType’ is ’String’.
Besides the default data types
• Integer
• Real
• String
• Boolean
• two additional enumerations are listed:
• Port Direction (noDirection, in, out, inout, plug, socket)
• DataType (only used for compatibility with old diagrams)

3BDS011224R4101 137
Aspect Properties/Parameters Dialog Section 3 Configuration

The enumerations are defined on the Function Aspect category as


Function Enumeration aspect, see Figure 79.

Figure 79. Enumeration definition on Aspect Category

Port Direction defines the direction of a port parameter:


noDirection: general port parameter with no specific direction.
in: Input parameter in the sense of a IEC61131-3 Var_Input.
out: Output parameter in the sense of a IEC61131-3 Var_Output.
inout: In-Out parameter in the sense of a IEC61131-3 Var_InOut.
plug: snap port, reserved for future use in Function Designer.
socket: snap port, reserved for future use in Function Designer.
DataType is no longer used, but needed to upgrade function diagrams
created with former versions of Function Designer.
You can add additional enumeration data types by adding further Function
Enumerations aspects to the Function aspect category, i.e. to
[Aspect System Structure]Function Designer/Function/Function.

138 3BDS011224R4101
Section 3 Configuration Aspect Properties/Parameters Dialog

– Access Type
Define the access type for the aspect property. You can select the access
type from a drop-down list.
None: Property is neither readable nor writable from other aspect
systems or Bulk Data Manager. Used internally in Function Designer
only.
Read: Property is readable from other aspect systems and from Bulk
Data Manager, but not writable.
Write: Property is writable from other aspect systems and from Bulk
Data Manager, but not readable.
Read & Write: Property is readable and writable from other aspect
systems and from Bulk Data Manager.
Read permission and write permission of individual properties equals the
read/write permission of the owning Function aspect or Function
parameter aspect.
– Inherited
Define whether the property is inherited or not.
Inherited properties are stored within the Function aspect which is
typically inherited from an object type.
Copied ones are stored within the Function Parameter aspect which gets
typically copied from an object type.
– Value
Define the value of the parameter
– Publish as
This is an enhanced setting allowing to read/write component
properties/parameters via the parent diagram. It is mainly used when
copying diagrams or setting diagram parameters via Bulk Data Manager.
For more details see Bulk Data Manager Support and Bulk Operations.
Enter the name that should be used to access the property from the parent
diagram. Enter “-” or an empty string if the property should not be
published.

3BDS011224R4101 139
Predefined Aspect Properties Section 3 Configuration

Predefined Aspect Properties


The following aspect properties are predefined:

Table 8. Predefined Properties for Components

Property Name Description


ComponentSaveTime (String) Used internally to update open
ParameterSaveTime (String) component views and diagram views
with component instances. Always
ObjectTypeSaveTime (String)
disabled for modifications.
ObjectTypeSaveInst (String)
InterfaceSaveTime (String)
InterfaceSaveTypeSaveInst (String)
XMLTypeSaveTime (String)
AutoParametersSaveTime (String)
SymbolInstanceSaveTime (String)
ReferenceSaveTime (String)
AllocGroupsSaveTime (String)
DiagramReferenceType (String) Used internally to indicate the direction
VariableDataTypeIDs (String) of diagram references and to update
variable datatypes.
VariableDataTypeSaveTimeInst
(String)
InstantiatedByDesignerVersion (String) Function Designer version string that
instantiated the component. Always
disabled for modifications.
NumberOfInputs (Integer) Current number and datatype of inputs.
TypeOfInputs (String) Only available for components which
support a variable number of inputs,
e.g. AND(3).

140 3BDS011224R4101
Section 3 Configuration Predefined Aspect Properties

Table 8. Predefined Properties for Components

Property Name Description


VariableDataType (String) Datatype, type group (library or
VariableDataTypeGroup (String) application) and attributes for local
variables, diagram parameters, and
VariableAttributes (String)
diagram references.
The read-only VariableDataTypeGroup
property gets automatically updated on
library connection changes on open
diagram.
CrossCommunication (String) Used for input diagram references that
CrossCommunication.CycleTime need cross communication because of
(String) connections across different
applications. See MMS Communication
CrossCommunicationValid (String)
Overview.
ComponentHidden (Bool) If set to true, components are hidden
on a diagram. Used e.g. for signal
groups.
AspectObject (Bool) If set to true, component is an aspect
object and thus visible both in the
diagram and in the diagram.
If set to false, component is a symbol
object visible on the diagram only.
ObjectTypeName (String) These read-only properties equal the
ObjectTypeGroup (String) object type name and the object type
group (for library or application defined
types).
They get automatically updated on
• Change Type (symbol objects
only)
• Library connection changes
(aspect objects at once, symbol
objects on open diagram)

3BDS011224R4101 141
Predefined Aspect Properties Section 3 Configuration

Table 8. Predefined Properties for Components

Property Name Description


ObjectName (String) For aspect objects, these properties
ObjectDescription (String) equal Name.Name and
Name.Description.
For symbol objects, these properties
define name and description,
respectively.
ControlBuilderName (String) For aspect objects (CBM function
ControlBuilderDescription (String) blocks and control modules), these
properties equal Control Builder
Name.Name and Control Builder
Name.Description.
For symbol objects, these properties
define CB name and description,
respectively.
Position.Page (String) Page number and top-left position of a
Position.X (String) component, given in units of the
diagram’s measurements (0.01mm or
Position.Y (String)
0.001 inch). These properties are
Position.Unit (String) written on File > Save diagram. On
open diagram, the position and page
number of a component is
synchronized against these properties.
This is useful to bulk position
components by e.g. Bulk Data
Manager, see Create Diagram(s) via
Bulk Data Manager.

142 3BDS011224R4101
Section 3 Configuration Predefined Aspect Properties

Table 9. Predefined Properties for Diagrams

Property Name Description


DiagramSaveTime (String) Used internally to update open
ParameterSaveTime (String) Diagram views. Always disabled for
modifications.
ContentsSaveTime (String)
DelCompSymbolId (String)
DiagramIsBad (Boolean) Boolean value indicating that recent
diagram check has failed. Always
disabled for modifications.
InstantiatedByDesignerVersion (String) Function Designer version string that
instantiated/created the diagram.
Always disabled for modifications.
DiagramSize.Width (String) Diagram width and height, given in
DiagramSize.Height (String) units of the diagram’s measurements
(0.01mm or 0.001 inch). These
DiagramSize.Unit (String)
properties are written on File > Save
diagram.

Table 10. Predefined Properties for Port <Parameter>

Property Name Description


<Parameter> (String) Port parameter value. Holds connection
string, see Connections/Networks.
<Parameter>.In (String) Port parameter value for inout
parameters. Holds connection string,
see Connections/Networks.
<Parameter>.Out (String) Port parameter value for inout
parameters. Holds connection string,
see Connections/Networks.
<Parameter>.DataType (String) Port parameter datatype, e.g. “RealIO”.
<Parameter>.Direction (Port Direction) Port parameter direction, e.g. “in”.

3BDS011224R4101 143
Adding an Aspect Property Section 3 Configuration

Table 10. Predefined Properties for Port <Parameter>

Property Name Description


<Parameter>.Initval (String) Port parameter instance specific initial
value.
<Parameter>.InitvalOfObjectType Port parameter initial value defined at
(String) the object type.
<Parameter>.Inverted (Boolean) True if port is inverted. Only available
for invertable ports, see Inversion.
<Parameter>.Visible (Boolean) True if port is visible, false if port is
hidden, see Change Type.

Adding an Aspect Property


To add an aspect property, do the following:
1. Select the object to which you want to add an aspect property (for example a
symbol’s port).
2. Open the Aspect Properties dialog by one of the following methods:
– Right click to open the object’s context menu and choose Aspect
Properties.
– Choose the Edit > Aspect Properties menu command.
– Select the All property page (adding an Aspect Property is possible in the
All property page only)
3. Right click on the free background of the All property page. A context menu
appears.

144 3BDS011224R4101
Section 3 Configuration Removing an Aspect Property

4. Choose Add Property from the context menu. A new empty row is inserted.

Figure 80. Adding an aspect property

5. Enter the wanted values into the fields using the drop down lists offered for the
fields Access Type, Data Type and Value.
6. To define all necessary properties for a port you have to perform steps 3 - 5
three times (for <portname>, <portname>.Datatype and
<portname>.Direction).
7. Click OK/Apply.

Removing an Aspect Property


To remove an aspect property, do the following:
1. Select the object from which you want to remove an aspect property.

3BDS011224R4101 145
Aspect Property References Section 3 Configuration

2. Open the Aspect Properties dialog by one of the following methods:


– Right click to open the object’s context menu and choose Aspect
Properties.
– Choose the Edit > Aspect Properties menu command.
– Select the All property page (removing an Aspect Property is possible in
the All property page only)
3. Right click on the row containing the aspect property you want to delete.
4. Choose Remove Property from the context menu.
5. Click OK/Apply

Aspect Property References


Instead of setting static text into a text or label component, you can define
references to any aspect property / parameter. By that, the text or label subscribes to
and displays dynamic data, e.g. life data from an OPC data provider, a PID gain
factor, or some document field defined in a document aspect.
The text or label components on a function diagram are automatically updated when
the subscribed aspect property changes. So you always get consistent and up-to-date
function diagrams.
To set a property reference in a text or label component, do as follows:
1. Open the Component Properties dialog and click on the Field page.
2. Choose the Property Reference option in the Field Code group box.
3. Click on to open the Aspect Property Reference dialog.
4. Select Structure, Select Object, Aspect and Property from the corresponding
list box. The Reference String text box displays your selection.
5. Choose the Reference Type and click OK/Apply. The Aspect Property
Reference dialog will be closed.
6. Click the Add button to enter the selected parameter reference into the Field
text box.
7. Click OK.

146 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

Aspect Property Reference


Use the Property Reference dialog to define the Reference String for the wanted
aspect property.
Open this dialog from the Component Properties’ Field page by clicking the
button behind the Aspect Property Reference text box:

Figure 81. Aspect Property / Parameter Reference dialog

The syntax for aspect property references is described in detail in IndustrialIT 800xA
Engineering, Engineering Workplace, Basic Engineering Functions, Appendix B,
“Property References”.

Bulk Data Manager Support and Bulk Operations


Bulk Data Manager is described in detail in IndustrialIT 800xA Engineering,
Engineering Workplace, Basic Engineering Functions. This chapter addresses some

3BDS011224R4101 147
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

enhanced functionality useful when copying function diagrams or function


components, or when setting property values via Bulk Data Manager.
Function Designer publishes its internal properties via the Function aspect, the
Function Parameter aspect, and the Allocatable Group aspect. These include
• Internal properties like DiagramSaveTime, ComponentSaveTime,
ObjectTypeSaveTime that are used internally to subscribe to changes and to
update open diagrams.
• Diagram properties like DiagramIsBad and DiagramSize.
• Allocatable group (configuration data generation) properties like
FDVERSIONGEN, GENERATED, ALLOCATED, IOALLOCATED,
S_STATUS, S_DESCRIPTION, ModifiedBy, ModifiedTime. See Diagram
Status in Bulk Data Manager and in System Status Viewer.
• Component name properties like ObjectName, ObjectDescription,
ControlBuilderName, ControlBuilderDescription.
• Component properties like AspectObject and NumberOfInputs.
• Component positioning properties like Position.Page or Position.X. See Create
Diagram(s) via Bulk Data Manager.
• Port parameter properties like In1, In1.Direction, In1.DataType, In1.initVal,
In1.Inversion, and In1.Visible.
• Variable properties like VariableDataType and VariableAttributes.
All copied and inherited diagram properties are published via the diagram's
Function aspect. All copied and inherited component and port properties including
connect strings are published via the component's Function aspect - even if the data

148 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

is physically stored inside the Function Parameter aspect, see Table 11.Properties
get published via...

Table 11. Properties get published via...

Property ... gets published via


Copied diagram property • Diagram’s Function aspect
• Diagram’s Function Parameter aspect
Inherited diagram property • Diagram’s Function aspect
Copied component/port • Component’s Function aspect
property • Component’s Function Parameter aspect
Copied component/port • Parent diagram’s Function aspect
property marked as “Publish • Parent diagram’s Function Parameter aspect
as”
• Component’s Function aspect
• Component’s Function Parameter aspect
Inherited component/port • Component’s Function aspect
property
Inherited component/port • Parent Diagram’s Function aspect
property marked as “Publish • Component’s Function aspect
as”

The number and kind of published properties vary from Function aspect to Function
aspect. A simple CBM_AIS e.g. publishes Value, Value.DataType, Value.Direction,
while a control module publishes all its control module parameters.
Preparation of bulk data sheets to modify or copy complete Function diagrams can
be a time consuming task. It is necessary to add Function aspects from different
components, and to filter out relevant properties which should be modified during
copy, e.g. initial values for set points.
This is improved by the Publish via Parent Diagram setting, see Figure 76. All
component and port properties marked as “Publish as” are additionally published
via the parent diagram’s Function aspect. Thus you can quickly define the most
important properties/parameter of a diagram (template), add just the diagram’s

3BDS011224R4101 149
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

Function aspect to a bulk data sheet, and copy them via Bulk Data Manager while
setting individual properties/parameter, see also the following example:

Copy Diagram(s) via Bulk Data Manager


Assume you configure a simple diagram MyTank that measures some level and
indicates that as specific level has reached. The parameters Level and Start Delay
of function block LevelDetection1 are marked as Publish via Parent Diagram, see
Figure 82. These values shall be set individually while copying the diagram using
Bulk Data Manager (BDM).

Figure 82. Example diagram MyTank to be copied via Bulk Data Manager

150 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

1. Right click on any background inside Function diagram MyTank, and invoke
the Engineering Workplace command Advanced>Bulk Data Manager.
2. Use BDM options ’Subtree enabled’ and ’Transaction by object’ as in
Figure 86.
3. Drag&Drop the Function aspect of MyTank into an empty bulk data sheet.
4. BDM displays the Configure Properties dialog. As the LevelDetection1
parameter Level and StartDelay were marked as Publish via Parent
Diagram, they are listed as diagram properties LevelDetection1.Level and
LevelDetection1.StartDelay, see Figure 83. Check them in order to modify
them while copying diagram(s).They get displayed in bulk data sheet row 1.
5. Drag&Drop MyTank into the bulk data sheet. The current values are echoed in
bulk data sheet row 2.

3BDS011224R4101 151
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

6. In BDM copy row 2 into row 3(4,5...), set MyTank as source object, set
individual parameter values, and invoke BDM command Save (all Objects).

Figure 83. Bulk copy diagram(s) with properties published via parent diagram

152 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

Copy and Rename Loop Diagram(s) via Bulk Data Manager


Assume you need to bulk copy and rename a typical loop control, see Figure 84.
Mind that components and the ’Name’ parameter of control modules take the
diagram name ’Typ1’ as prefix.

Figure 84. Typical loop control

The BDM sheet in Figure 85 copies and renames the loops F001\LC1...LC5 and
F002\LC6...LC10 in a single row. F001 and F002 are two folder objects in
Functional Structure that are used later for allocation. The BDM sheet consists of
two columns only:
• Object Identification (F001\LC1…LC5 and F002\LC6...LC10)
• Source Object (Typ1)
The following BDM options are used, see Figure 86:

3BDS011224R4101 153
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

• Subtree enabled’ (Otherwise diagram components will not be copied)


• Transaction ’By Object’.
Make sure NOT to to use Transaction ’Data Area’. ’Data Area’ is actually not
supported by CB/Function Designer. If you do so, you might get inconsistencies
in your data in Functional Structure and in Control Structure.
In the copied loop diagrams ’LCx’ the components and the ’Name’ parameter of
control modules are automatically renamed, see Figure 87. Same holds for the
Control Builder Name used inside Control Builder, see Figure 88.

Figure 85. Bulk copy and rename loop diagram(s)

154 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

Figure 86. BDM options to copy diagram(s)

3BDS011224R4101 155
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

Figure 87. Copied loop diagram LC1

156 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

Figure 88. Copied Loop Diagram LC1 in Functional Structure and in Control Builder

Bulk Connect Diagram References


The diagrams copied in the bulk copy example above have open diagram references.
Diagram references are connected via a diagram variable that gets inserted in
Functional Structure as child object to the reference object.
In order to connect the input references LC1_In1...LC10_In1 to output references
Out1_Ref1, Out2_Ref1 in Figure 89, the diagram variables Out1_Var, Out2_Var get
inserted 10 times as child to the input references. This can be done by the bulk data
sheet in Figure 90.

3BDS011224R4101 157
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

The result is shown in Figure 90 and Figure 91.

Figure 89. Unconnected output diagram reference

Figure 90. Bulk connect diagram references

158 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

Figure 91. Connected diagram reference Out1_Ref1

Figure 92. Connected diagram LC1

Bulk Allocate Diagrams


The diagrams copied and connected in the bulk examples above are placed in
Control Structure in the Unallocated Application, see Figure 93. In order to allocate
them to different CB applications, they could be moved individually in Control
Structure.
Because we have located them in folders/groups F001, F002 in Functional
Structure, another approach is taken here: Allocate the folders/groups including the
child diagrams in a single step:

3BDS011224R4101 159
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

• F001 and its child diagrams LC1...LC5 shall be allocated to Application_1


• F002 and its child diagrams LC6...LC10 shall be allocated to Application_2.
The bulk data sheets in Figure 94 and Figure 96 first add a Function, an Allocatable
Group, and a Single Control Module aspect to the folders/groups F001 and F002. In
a 2nd step the folders/groups are moved to the corresponding applications.

Figure 93. Unallocated diagrams LC1...LC10

160 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

Figure 94. Bulk Allocate, step1: Create allocation aspects

After step1, the folders/groups F001, F002 are also placed in the unallocated
application.

Figure 95. Unallocated diagrams F001, F002, LC1...LC10 after step1

3BDS011224R4101 161
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

Figure 96. Bulk Allocate, step2: Move folders/groups to applications.

After step2, the folder/group F001 is allocated to Application_1, and F002 is


allocated to Application_2. The child diagrams LC1...LC10 are still located in the
unallocated application, they get moved to the correct application when generating

162 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

configuration data for the parent folders/groups F001, F002, see Bulk Generate
Configuration Data.

Figure 97. Allocated diagrams F001, F002 after step2

Bulk Generate Configuration Data


Configuration data for the diagrams in the bulk examples above can be bulk
generated by the bulk data sheet in Figure 98. Multiselect the folders/groups and
invoke allocatable group aspect command Generate Configuration Data.
Alternatively, aspect command Generate Configuration Data (Full Build) can be
invoked. Full build always generates all diagrams / groups including their children.
Without full build, only modified diagrams/groups get generated.

3BDS011224R4101 163
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

Of course, these aspect commands can also be invoked from the allocatable group
aspect in Plant Explorer. E.g. select FuD_Instances\F002.Allocatable Group
aspect and invoke command Generate Configuration Data (Full Build).

Figure 98. Bulk generate configuration data

In either case, a working dialog indicating the progress and a Cancel button is
displayed. For each generated diagram/group, errors and warnings are written to the
AES Error Context aspect. Successful configuration data generation can also be
verified by checking the diagram status, see Diagram Status in Bulk Data Manager
and in System Status Viewer.

164 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

During configuration data generation, the child diagrams LC1...LC10 and Out1,
Out2 are to the correct application, see Figure 99.

Figure 99. Allocated and generated diagrams

Diagram Status in Bulk Data Manager and in System Status Viewer


The diagram status can be checked
• by the traffic light status bar indication for each diagram, see Instance Specific
Initial Values.
• by the bulk data sheet in Figure 100. The allocatable group aspect properties
– GENERATED
– S_STATUS
– S_DESCRIPTION
indicate successful configuration data generation.
• in System Status Viewer, see Figure 101 and Instance Specific Initial Values.
Add a System Status Viewer aspect to a folder/group or to any parent object in

3BDS011224R4101 165
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

Functional Structure or in Control Structure. The System Status Viewer


displays the status of all child diagrams/groups.

Figure 100. Check diagram status in BDM

166 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

Figure 101. Check diagram status in System Status Viewer

Bulk Documentation and Contents Chapter


You can bulk print and create a contents diagram for each substructure in Functional
Structure. E.g. to print and create a contents chapter for all diagrams, add a Function
aspect to the Root object in Functional Structure and follow the steps below.
Following the bulk examples above, we print and create a contents chapter for the
diagrams in folder/group F001:
• Open the Function aspect of F001.
• Invoke command File > Create Contents to create a contents diagram.
• In the Create Contents dialog select a template and check complete or
overview contents, see Figure 102.
– Complete contents create detailed contents for each diagram and all its
pages including functional designation (if any), name, description, page
comment and page number. See Figure 103.
– Overview contents create contents for all diagrams according to the
selected number of levels. The overview includes functional designation,

3BDS011224R4101 167
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

name, description, and number of pages. Child diagrams are indented


according to their level in Functional Structure.
• On OK, the contents diagram gets created according to the selected template
and settings, see Figure 103. The diagrams get listed according to their level in
alphabetical order. In this example, the contents diagram lists the diagram
name, its description, and page numbers.
• You can modify and save the created contents diagram, e.g. add some binder
information and simple graphical components like lines and texts.
– File > Open Contents command opens an already created contents
diagram.
– File > Create Contents command overwrites an already created one.

Figure 102. Create Contents dialog

168 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

Figure 103. Complete contents diagram for folder/group F001

You can add individual page comments to the diagrams. E.g. open diagram
F001\LC1 and invoke the page comment button on the Page toolbar, or the
View > Pages > Page Comment command.
• In the Page Comment dialog enter a page comment and select a range of
pages to apply the comment to. See Figure 104.

3BDS011224R4101 169
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

• Recreate the F001 contents diagram with page comments by the File > Create
Contents command. See Figure 105.

Figure 104. Page comment dialog and page comment in diagram

170 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

Figure 105. Complete contents diagram with page comment

You can also modify the contents template and adapt them to your needs. E.g.
change fonts, distances, and references displayed. In [Object Type
Structure]Functional Planning\Diagram Templates\ContentsTemplates select a
corresponding contents template and open its Function Diagram Contents
Template aspect, see Figure 106. The templates installed by the Function Designer
system extension define the following aspect property and document references:
• Detailed contents:
– $.:Functional Designation:Name$
– $.:Name:Name$
– $.:Name:Description$
– $PgComment
– $Page/$LastPage

3BDS011224R4101 171
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

• Overview contents
– $.:Functional Designation:Name$
– $.:Name:Name$
– $.:Name:Description$
– $LastPage
Check the component properties of selected text elements in the contents
templates. Component names prefixed by DetailedContents... define the
complete/detailed contents, and component names prefixed by
OverviewContents... define the overview contents.

Figure 106. Contents templates in Object Type Structure

In order to bulk print diagrams or a complete substructure of diagrams in Functional


Structure, select the parent Function aspect.

172 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

• Invoke the File > Page Setup command and enter a suitable printer page size,
see Figure 107. Typically, this printer page equals the diagram page size
selected by the diagram template.
– Invoke the File > Template or Edit > Measurements and Size command
in order to check the diagram page size, see Figure 108.
– In cases that the diagram page size (e.g. A3 landscape) differs from the
printer page size (e.g. A4 landscape), select Fit to sheet(s) in Figure 108.

Figure 107. File > Page Setup dialog

3BDS011224R4101 173
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

Figure 108. Edit > Measurements and Size dialog

• Invoke the File > Print command in order to run the bulk print job.
– Check Contents to print the contents diagram
– Check Diagrams [Child Diagrams] to print diagrams including children.
– Check the Printer and Printer Page Settings to print the contents and
diagrams with individual printer and printer page settings, or you can
inherit and even save the settings from the parent Function aspect. In the
latter case you can verify or change these settings by pressing the Page
Setup button.
– Check the Print Components on Layers options to print the diagrams as
laid out on the screen, or in their original color. In the first case,

174 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

components on different layers get grayed or not printed at all according to


the layer properties.

Figure 109. File > Print dialog

• Press OK. The standard Windows Print dialog gets displayed, see Figure 344.
Confirm or change the selected printer driver, number of copies, and option
Print To File, and press OK again.
• A print working dialog indicating the current printed diagram gets displayed.
You can cancel the print job by pressing its Cancel button.
• The printed diagrams are printed according to their level in alphabetical order.
And they get listed in the output window of the parent Function aspect.

Create Diagram(s) via Bulk Data Manager


You can also bulk create diagrams via BDM from scratch. E.g. the bulk sheet in
Figure 110
• creates a diagram F010\D1 from a diagram template type Function Diagram
A4 portrait,
• adds components D1_PV1, D1_PVIn, D1_PID
• and positions them to the given positions and page numbers:

3BDS011224R4101 175
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

– Position.Page sets the page number


– Position.Y and Position.X set the top-left position of a component
- in 0.01 mm for metric (ISO) diagram templates like A4, A3, and
- in 0.001 inch for english (US) templates like letter, legal.
• These components get instantiated as aspect object. By setting the aspect
property Function Parameters.Aspect Object to ’false’ you can bulk convert
them into symbol objects, see Aspect Objects and Symbol Objects.

Figure 110. Bulk create diagrams from scratch

• You can also bulk connect components via BDM. E.g. bulk sheet Figure 111
– connects D1_PV1.Value with D1_PVIn.AnalogInput via link1

176 3BDS011224R4101
Section 3 Configuration Bulk Data Manager Support and Bulk Operations

– connects D1_PVIn.Out with D1_PID via link2.

Figure 111. Bulk connect components

3BDS011224R4101 177
Bulk Data Manager Support and Bulk Operations Section 3 Configuration

Figure 112. Diagram created from scratch with BDM

178 3BDS011224R4101
Section 3 Configuration Function Components

Function Components
Defining Function Components (Component View)
Function components are defined in Function Designer’s Component view.
To define a function component, do as follows:
1. Choose Object Type Structure from the structure browser of Engineering
Workplace or Plant Explorer Workplace.
2. Browse to the location where you want to locate your new function component.
3. Create a new object type via the New Object dialog which is opened via the
corresponding context menu command.
4. Create a Function aspect to the Object Type.
5. Select the Function aspect from the Aspects list.
6. Open Function Designer’s Component view.
7. Use the File > New command to define a new function component, see New
Function Component.
8. Design the symbol of the function component using the graphical facilities of
Function Designer.
9. Add aspect properties, if any. See Adding an Aspect Property.
10. For each (input/output) parameter of the function component, add at least the
following aspect properties:
– Parameter Name
– Parameter Direction (in, out, in-out, none)

3BDS011224R4101 179
Defining Function Components (Component View) Section 3 Configuration

– Parameter Data Type

Figure 113. Aspect Properties

180 3BDS011224R4101
Section 3 Configuration Defining Function Components (Component View)

11. To map a graphical port with such a parameter, open the port’s component
properties, Name page, and enter the name of the wanted parameter.

Figure 114. Port Name mapped to (out) Parameter

This approach of defining a complete function component including graphical


symbol, ports, and aspect properties is taken for
• CBM IO Signals, see Figure 115
• Diagram Parameters
• Diagram References

3BDS011224R4101 181
Defining Function Components (Component View) Section 3 Configuration

• HART devices

Figure 115. CBM_AIS component type

182 3BDS011224R4101
Section 3 Configuration Function Components with XML Type Description (Component View)

Function Components with XML Type Description (Component View)


The following object types use an alternative to the complete definition of a function
component including graphical symbol and aspect properties:
• CB system functions, see Figure 116
• CB system procedures
• CB function blocks, see Figure 117
• CB control modules, see Figure 118
• Variables
The Function aspect of these types store an XML type description with
• Type name
• Type description
• Interface description (parameters, datatype of parameters)
• Optional extensible parameters

Figure 116. XML type description of an add(real) function

3BDS011224R4101 183
Function Components with XML Type Description (Component View) Section 3 Configuration

Figure 117. XML type description of a CTU function block

184 3BDS011224R4101
Section 3 Configuration Function Components with XML Type Description (Component View)

Figure 118. XML type description of a MotorUniM control module

On instantiation, aspect properties get automatically created from that XML type
description, and a graphical symbol gets automatically calculated from a component
template.
The component template itself is also stored within a Function aspect. It can be
defined
1. at the type itself
2. at the parent type group
3. at any parent of the type
4. at the aspect category.
This also equals the search order for component templates. First a component
template is searched at the type, then at its parents, and then at the aspect category.
The component template definition includes the following graphical components,
see Figure 119:

3BDS011224R4101 185
Function Components with XML Type Description (Component View) Section 3 Configuration

• Label InstanceName
• Text TypeName
• Rect MainComponent
• Rect ShadowComponent (optional)
• Polygon HiddenPortsIndicator
• Text InputPortName
• Port InputPort
• Text OutputPortName
• Port OutputPort
• Text InoutPortName
• Port InoutInputPort
• Port InoutOutputPort

Figure 119. Component template for function block types

186 3BDS011224R4101
Section 3 Configuration Function Components with XML Type Description (Component View)

The XML type description for CB system functions and procedures is stored within
the functions and procedures Function aspect. The corresponding object type group
[Object Type Structure]Object Types\Control System\AC800 M/C
Connect\System Functions and a component template gets loaded by the system
extension Function Designer for AC800M.
The XML type description for CB function blocks and control modules is
automatically retrieved from the corresponding CB library if a Function aspect gets
created, see Enhancing a User-Defined Object Type for Use in Function Designer.

Libraries
For each base library loaded by an AC 800M system extension, Function Designer
system extensions add corresponding Function, Function Parameter, and Object
Type Definition Extension aspects. The latter is necessary in order to add aspects to
an already released library.
• AC800M Connect gets extended by Function Designer for AC800M system
extension
• AC800M SB2 Libraries get extended by Function Designer for AC800M
SB2 Libraries system extension
You can follow that approach for user-defined libraries with function blocks and
control modules:
• Open a CB project and connect the corresponding libraries
• For each function block and control module type add a Function aspect. Use
Bulk Data Manager to do this in a bulk operation.
• The Function Parameter aspect gets automatically created together with the
Function aspect.
• An Object Type Definition Extension aspect gets automatically created if the
library was already closed/released. If the library is still open, no Object Type
Definition Extension aspect is necessary.
• Optionally add function component templates to the types or to the parent type
group.
• For already closed/released libraries you can create AFW files holding the
additional aspects: Run the Import/Export tool and add the Function, Function

3BDS011224R4101 187
Function Components with XML Type Description (Component View) Section 3 Configuration

Parameter, and Object Type Definition Extension aspects without


dependencies. See e.g. Figure 120.

Figure 120. ProcessObjExt Library extensions added by Function Designer for


AC800M system extension

The XML type description stored in the Function aspect gets automatically updated
on interface changes. Instances get also automatically updated on interface changes.
Say you have
• a user-defined control module type MyCMT with two inputs and one output
parameter.
• two instances MyCM1, MyCM2.
The MyCMT.Function aspect holds a corresponding XML type description and
inherits an aspect property InterfaceSaveTime. Instances copy that property as
InterfaceSaveTimeInst. The instances MyCM1 and MyCM2 display an according
symbol.

188 3BDS011224R4101
Section 3 Configuration Function Components with XML Type Description (Component View)

If you change the type’s internals only (add some glue logic or some internal
variable), Function Designer detects that the interface is NOT changed. The
inherited property InterfaceSaveTime is not modified. The instances MyCM1 and
MyCM2 are not updated.
If you change the types interface (add/delete some parameter or change its
datatype), Function Designer detects that change and updates the inherited property
InterfaceSaveTime. On open diagram, the instances and their symbols MyCM1
and MyCM2 are updated due to the mismatch of the InterfaceSaveTime and
InterfaceSaveTimeInst properties. The diagram state gets modified due to the
changed interface, see Instance Specific Initial Values.
Similar holds for interface changes due to changes in connected libraries. In that
case, aspect object instances get updated due to an internal Change Type. Symbol
objects get updated on open diagram.

Figure 121. InterfaceSaveTime and InterfaceSaveTimeInst aspect properties

Do not delete and recreate the Function aspect in order to update a type. If you do
so, the InterfaceSaveTime property gets reset, and all diagrams will change their
state to modified, even if the type’s interface did not change.
You can force an update of the XML type description by the Function aspect verb
Update XML Type Description.

3BDS011224R4101 189
Function Components with XML Type Description (Component View) Section 3 Configuration

Data Types
Variables of library- or application defined (structured) datatype calculate their
graphical symbol on base of a variable component template and the selected
DataType aspect. Variable instances get automatically updated on open diagram in
case of
• changes in the data type definition
• changes due to connected libraries
This is done by the aspect properties VariableDataTypeSaveTimeInst and
VariableDataTypeIds. The latter points to the DataType aspect.

190 3BDS011224R4101
Section 3 Configuration Aspect Objects and Symbol Objects

Aspect Objects and Symbol Objects


Function components get either be instantiated as
• aspect object (visible in the diagram and in Functional Structure, optionally in
Control Structure)
• symbol object (stored and visible in the diagram only).
Symbol objects thus reduce the number of aspect objects. It is possible to switch the
kind of existing instances from aspect to symbol object or vice versa by
• component context menu Aspect Object. Can be applied to a single or multi-
selection of components in a function diagram.
• aspect property AspectObject, useful for bulk operations via BDM.
Table 12 lists objects that can be instantiated as symbol objects and as aspect object,
or as aspect objects only.

Table 12. Symbol objects and aspect objects

Symbol Objects and Aspect Objects Aspect Objects only


CB system functions CBM IO signals (significant data in
CB system procedures aspects like Signal Parameter)
CB function blocks HART devices (significant data in aspects
like Fieldbus and Device Management)
CB control modules
Diagram references and diagram
Variables
variables (latter are inserted into the
Diagram parameter Functional Structure to connect diagrams)

Both aspect objects and symbol objects support the aspect properties listed in
Table 13.

Table 13. Symbol object and aspect object properties

Aspect Property Description


ObjectName Equals .:Name.Name for aspect objects
ObjectDescription Equals .:Name.Description for aspect objects

3BDS011224R4101 191
Aspect Objects and Symbol Objects Section 3 Configuration

Table 13. Symbol object and aspect object properties

Aspect Property Description


ControlBuilderName Equals .:Control Builder Name.Name for aspect
objects
ControlBuilderDescription Equals .:Control Builder Name.Description for
aspect objects
AspectObject Set to true for aspect objects
Set to false for symbol objects.

The instantiation kind for new instances on a diagram is determined by the


Function Settings:InstantiateComponents property. It can take the values
described in Table 14.

Table 14. Function Settings:InstantiateComponents

InstantiateComponents Description
AccordingCB New default in SV40.
AccordingCBAlarmOwnerFlag Functions, procedures, variables and diagram
parameter get instantiated as symbol object.
Function blocks and control modules get
instantiated as in CB: If they hold the
AlarmOwner or the InstantiateAsAspectObject
flag, they get instantiated as aspect object.
E.g. an TOn gets instantiated as symbol object,
a MotorUniM as aspect object.
AccordingTypeDefCreateInfo Default in SV31. See Object Type Definition
Create Info.
Functions, procedures, and variables get
instantiated as symbol object.
Diagram parameter, function blocks and control
modules get instantiated as aspect object.
E.g. a TOn gets instantiated as aspect object.

192 3BDS011224R4101
Section 3 Configuration Object Type Definition Create Info

Table 14. Function Settings:InstantiateComponents

InstantiateComponents Description
AsAspectObject Instantiate all objects as aspect object.
AsSymbolObject Instantiate all objects as symbol objects.
Exceptions are listed in Table 12.

Objects created outside Function Designer are always instantiated as aspect object:
• Plant Explorer New Object dialog
• BDM
They can be changed into symbol objects by the Aspect Object context menu or the
AspectObject aspect property.

Object Type Definition Create Info


In case Function Settings:InstantiateComponents equals
AccordingTypeDefCreateInfo, the Create Info options in the Object Type
Definition aspect determine if an object gets instantiated as aspect object or as
symbol object:
1. Open Engineering Workplace or Plant Explorer Workplace.
2. Select the object type from the Object Type Structure.
3. Select the object type’s Aspect with category name Object Type Definition
(for example, CBM_AIS Type Definition).
4. Select page Create Info.
5. Check the options Can be created as root, Can be created outside
Structures and Can be created in all Structures of the Structure Info group
box and modify them in the following way:

3BDS011224R4101 193
Object Type Definition Create Info Section 3 Configuration

– To define instantiation kind aspect object, all Structure Info options must
be checked, and Explicit Object Type must be unchecked. See
Figure 122.

Figure 122. Create/Structure Info for instantiation kind Aspect Objects

– To define instantiation kind symbol object, uncheck the Structure Info


options and check Explicit Object Type. See Figure 123.

194 3BDS011224R4101
Section 3 Configuration Inherited Function Components

For glue logic like AND, OR and so on, the Create Info options are not set, that
means such functions are instantiated as symbol objects and created and stored on
function diagrams only.

Figure 123. Create/Structure Info for instantiation kind symbol object

Inherited Function Components


If a new function component is created in a function diagram, the settings of the
Object Type Definition aspect or Object Type Definition Extension aspect (for

3BDS011224R4101 195
Inherited Function Components Section 3 Configuration

example, CBM_AIS Type Definition) define how the instance gets updated if its
type changes

Figure 124. Aspect Control for components with inherited Function Aspect

• To inherit the component’s symbol definition from the object type to the
instance, the option Inherit to All Instances is set for the Function aspect.
Then, modifications of the symbol definition - and thus of the Function aspect -
will automatically result in an update of all existing object instances, that

196 3BDS011224R4101
Section 3 Configuration Inherited Function Components

means already existing components in function diagrams are automatically


drawn/printed using the updated symbol definition.
• To copy the component’s symbol definition set the option Copy to All
Instances. Then, the Function aspect will be copied on object instantiation.
Later modifications on the type will have no effect on already existing object
instances.
• The Function Parameter aspect holding copied aspect properties and connect
strings gets typically copied to all instances. However, formal instances of
diagram types inherit the Function Parameter aspect in order to prevent
modifications of the generated control module type.
To adjust/modify the Aspect Control properties, do as follows (see also Figure 124):
1. Open the Object Type Structure dialog by choosing the Show Type command
from the context menu of the component for which you want to change the
object type definition aspect control.
Alternatively, you can open the Object Type Structure in the Engineering
Workplace and select the object type.
2. Select Object Type Definition aspect.
3. Open the Aspect Control page and select the corresponding Aspect.
4. Set the Copy/Inherit options as needed.

3BDS011224R4101 197
Inherited Function Components Section 3 Configuration

The following figure displays indicators for an inherited component, i.e. a


component with an inherited Function aspect:

Double-Click

Read Only (READ) flag as


indicators for inherited
components

Figure 125. Indicators for inherited components

• Read Only hint in the Component Properties dialog


• READ indicator in status bar of Function Designer. Double click on that
indicator to get more detailed information, e.g. “This component is read-only
because its Function aspect is inherited”.

198 3BDS011224R4101
Section 3 Configuration Overridden Components

Labels on Inherited Components


Function Designer symbols (object types) can additionally use labels to define some
property references. Component instances display e.g. a component name at such
labels. As labels can be moved and modified at an instance, they are not inherited
like the graphical symbol itself.
The following label modifications done at the object type are reflected at the
instances on open diagram, if the label instances have not been modified manually:
• Fill properties
• Line properties
• Font properties
• Text field properties
• Text alignment

Overridden Components
You can override inheritance of individual components as follows:
1. Select the function component (symbol) from Functional Structure.
2. Right click right on the Function aspect from the Aspects list to open function
component’s context menu.

3BDS011224R4101 199
Overridden Components Section 3 Configuration

3. Choose Override.

Override inheritance
setting done in
Aspect Control of
function component.

Figure 126. Override inherited function component

As you override an aspect, the aspect gets copied from the object type to the
component instance. You can undo Override by the Delete Override command.
In that case, the copied aspect gets deleted, so that the inherited one is seen again
from the component instance.

200 3BDS011224R4101
Section 3 Configuration Overridden Components

4. Modify the symbol definition in Component View.

Figure 127. Diagram with overridden symbol

3BDS011224R4101 201
Default Aspect Section 3 Configuration

Default Aspect
You can define an aspect of an Aspect Object as default aspect. This default aspect
will appear as uppermost entry in the context menu.
To define an aspect as default aspect, do the following:
1. Select an aspect from an Aspect Object within the Plant Explorer.
2. Click right to open the aspect’s context menu and choose Properties.
3. Choose the Aspect Details tab in the Properties dialog.
4. Mark the Default aspect check box and click OK/Apply.

Figure 128. Defining an Default Aspect

202 3BDS011224R4101
Section 3 Configuration Instantiating Function Components in Diagram View

Instantiating Function Components in Diagram View


Function components are instantiated in Function Designer’s Diagram view. You
can do that via menu command or via drag-and-drop. For details, see
Inserting/Creating Components.

Change Type

Changing Type of Component Instances


The Change Type functionality is available for symbol objects only. I.e. you can
change an AND into an OR, but not a CBM_AIS into a CBM_DIS, because the
latter are aspect objects. Connections and aspect properties are preserved as far as
possible by keeping values for matching property names.
1. In Diagram View, right click on a component and select the Change Type …
command from the context menu. The menu command is disabled in case you
selected an aspect object.
2. Select the new object type from dialog Change Type:

Figure 129. Dialog Change Type

3BDS011224R4101 203
Change Type Section 3 Configuration

Changing Number of Inputs


Certain components e.g. AND, ADD, OR... define an aspect property
NumberOfInputs which controls the number of single ports (or port groups). The
value of this aspect property is explicitly set when creating an object instance in a
function diagram. When creating an object instance in Plant Explorer (or via Bulk
Data Manager, etc.) a default value for this parameter is used.
In order to change the number or inputs,
1. Right click on a component in Diagram View and select the Number Of
Inputs … command from the context menu. The menu command is disabled in
case you selected a component without modifiable number of input parameters.
2. Select the new value from dialog Number of Inputs:

Figure 130. Dialog Number of Inputs


Changing the value of the NumberOfInputs aspect property is also possible via the
Aspect Properties dialog (Component property page and All property page). It is
recommended to use the Aspect Properties dialog’s Component property page or
the Number Of Inputs … command from the context menu as in these cases the
symbol is updated. When changing the value of the NumberOfInputs aspect
property in the Aspect Properties dialog’s All property page or instead it might be
necessary to close and reopen the diagram to update the symbol.
As the values of other existing aspect properties remain untouched, port connections
are kept when increasing the value. When decreasing the value of
NumberOfInputs the superfluous dependent port related aspect properties (and
according connections) are removed.

Show/Hide Ports
By default, newly instantiated components display all port parameters. You hide
individual ports by the following steps:

204 3BDS011224R4101
Section 3 Configuration Change Type

1. In Diagram view, select the ports to be hidden, right click on a port, and invoke
command Hide Port(s) from the context menu.
2. Symbols with hidden ports are marked by a small triangle displayed in the
lower left corner, see Figure 131.

Figure 131. MotorUniM with hidden ports

You show hidden ports by the following steps:


1. In Diagram view, select a component with hidden ports, right click, and invoke
command Show Hidden Port(s) from the context menu.
2. Dialog Show Hidden Ports is opened, see Figure 132.

3BDS011224R4101 205
Change Type Section 3 Configuration

3. Select all or individual hidden ports and press OK.

Figure 132. Dialog Show Hidden Ports

206 3BDS011224R4101
Section 3 Configuration Change Type

4. Alternatively, you can set the .Visible properties of the port parameters in the
component’s Aspect Property dialog (Ports property page), see Figure 133, or
via Bulk Data Manager.

Figure 133. Port parameters of MotorUniM

3BDS011224R4101 207
Connections/Networks Section 3 Configuration

Connections/Networks
A port of a function component symbol references an aspect property/parameter by
its name, see Function Components.
This aspect property holds the connect string. A connect string can be of type
constant, e.g. 123, or ’def’, or of type variable, e.g. abc, or of type variable with
initial value, e.g. abc:=123. It can be edited
• in the drop-down combo box of the Connection toolbar
• in-cell in the connector symbol displayed at the port
• in the Aspect Properties dialog (Ports property page)
• in Bulk Data Manager
If there are two ports on a diagram connected to the same variable, e.g. abc, a
connection link is automatically created and routed. If the ports are located in
different pages, off-page connector symbols are automatically created on both
pages. CB project constants use the same syntax as variables. However, they
behave like constants and are not connected via links or off-page connectors.
Do not create a project constant in Control Builder M while a Function Diagram
is open. Otherwise, if a project constant is connected twice on different ports the
Function Designer is drawing a short circuit line. You have to close and re-open
the Function Diagram to get the proper connection displayed.
A network is a set of 1:1, 1:N, M:N connections between ports. A connection
network has 1...M sources and 1...N sinks, and is defined by its unique network
name, that equals the connect string of type variable. All network components, i.e.
all links and off-page connectors, share the variable/network name as component
name property. The variable/network name is also accessible by a label attached to
network links. Automatically created links get the default variable/network names
link, link1, link2...
Consider the following examples:
• Figure 134 shows symbol port S1:In1 connected to constant 123, and symbol
ports S2:In1 connected to variable abc and S2:In2 connected to string constant
’def’. The connect strings are reflected in the ports aspect property, and in Bulk
Data Manager. If you change the connect string in the aspect property dialog,
or in Bulk Data Manager, the diagram gets automatically updated.

208 3BDS011224R4101
Section 3 Configuration Connections/Networks

Figure 134. Connection to Constant and to Variable

3BDS011224R4101 209
Connections/Networks Section 3 Configuration

• In Figure 135, S1:Out was connected to variable abc. A 1 : 1 network with one
connection link gets automatically created, connecting S1:Out with S2:In1.
The link is labeled abc, and the links name property equals abc. This is also
reflected in the aspect properties, and in Bulk Data Manager. And vice versa,
you can automatically create networks with links by updating connect strings
in the aspect properties dialog, or in Bulk Data Manager, see also Create
Diagram(s) via Bulk Data Manager.

Figure 135. 1 : 1 Network

210 3BDS011224R4101
Section 3 Configuration Connections/Networks

• In Figure 136, S3:In1 was connected to variable abc. A 1 : N network, N = 2,


gets automatically created with two links named abc.

Figure 136. 1 : N Network (N = 2)

3BDS011224R4101 211
Connections/Networks Section 3 Configuration

• In Figure 137, S4:Out was connected to variable abc. A M : N network, M = 2,


N = 2, gets automatically created.

Figure 137. M : N Network (M = 2, N = 2)

• In Figure 138, S2 was moved from page 1 to page 2. Off-page connectors with
page references get automatically created. Page referencing is not reflected in
the aspect properties nor in Bulk Data Manager, i.e. S1:Out and S2:In still hold
the connect string abc. In other words, off-page connectors are also
automatically created when connecting symbols on different pages by updating
aspect properties, e.g. in Bulk Data Manager.
Behavior of page references:
• Page references to symbols without name (functions) display the name of
the connection instead.
• There may be multiple page references on a page to the same source or
sink.

212 3BDS011224R4101
Section 3 Configuration Connect by Keyboard

Figure 138. M : N Network with off-page connectors

Connect by Keyboard
To enter a connect string,
• select a port in the diagram, edit the connect string in the drop-down combo
box of the Connection toolbar, and press Return or the Enter button, see
Figure 139.
• or select a port in the diagram and select an already existing connect string
from the drop-down combo box of the Connection toolbar, see Figure 139.
• or select a connector symbol displayed left or right at a port in the diagram, in-
cell edit the connect string, and press Return.
• or select a function component symbol in the diagram and edits its connect
strings in the Aspect Properties dialog (Ports property page) or Aspect
Properties dialog (Component property page) dialog.

3BDS011224R4101 213
Connect by Mouse Section 3 Configuration

• or update connect strings in Bulk Data Manager

Figure 139. Connection toolbar

To connect two function component ports on the same or on different pages by


keyboard,
1. Navigate to the first port by using the cursor keys in Network traversal mode
and mark it by ’Numpad - ’see General Accelerator Keys,
2. Navigate to the second port by using the cursor keys in Network traversal
mode,
3. Press ALT + Numpad to connect the selected port to the marked one.
4. In case of connecting ports on different pages, off-page references are
automatically created.
5. Network link(s) get created with next free default variable/network name link,
link1, link2...and automatically routed.

Connect by Mouse
To connect function component ports using the mouse, you have two alternatives:

To create a new connection (alternative 1)


1. Press the left mouse button on source port.
2. Moves the mouse on sink port or already existing connection on the same page.
3. Release the mouse button.
4. The connection link gets automatically routed. It gets the next free default
variable/network name link, link1, link2...

214 3BDS011224R4101
Section 3 Configuration Disconnect

In that case, no modifier keys are used. There is no such thing as a ’connection
mode switch on the toolbar’ you have to enter before.

To create a new connection (alternative 2)


1. Click on source port. By that, this port is selected and marked.
2. Click ALT+left on sink port on the same or another page.
3. In case of connecting ports on different pages, off-page references are
automatically created.
4. Network link(s) get created with next free default variable/network name link,
link1, link2...and automatically routed.
If a connection (sink) is already existing, additionally to the new connection a new
vertex is created automatically.

Manual routing by inserting/freezing vertices on connection links


1. Select a connection link by clicking on it.
2. Click ALT+left on the connection link where you want to insert a new vertex.
3. Click CTRL + SHIFT + left on the new vertex to pin it, i.e. to freeze it for auto
routing. The pinned vertex is drawn in red color.
4. Unpin a freezed vertex by CTRL + SHIFT + left mouse click.
5. Delete a vertex by CTRL + left click.
In rare cases automatically routed connection lines are overlapping. Move related
symbols within diagram.
Connections are sometimes drawn with overlapping lines after a close and reopen
of a Function Diagram. Modification of distances between links and symbols in
Edit > Options > Autorouting helps to avoid this.

Disconnect
To disconnect a port or some port(s) from a network,
• select a port in the diagram, reset its connect string to an empty one in the
Connection toolbar.

3BDS011224R4101 215
Inversion Section 3 Configuration

• or select a port in the diagram, and press the ’Disconnect port only’ or
’Disconnect complete network’ button of the Connection toolbar.
• or select a connector symbol displayed left or right at a port in the diagram, and
delete it.
• or select a function component symbol in the diagram and reset its connect
strings in the Aspect Properties dialog (Ports property page) dialog.
• or reset connect strings in Bulk Data Manager.

Inversion
To invert an input port of datatype ’bool’,
• select a port in the diagram, and press the ’Invert’ button of the Connection
toolbar.
• or select a function component symbol in the diagram and edit the port’s
inversion properties in the Aspect Properties dialog (Ports property page)
dialog.
• or update inversion properties in Bulk Data Manager, see Figure 140.

216 3BDS011224R4101
Section 3 Configuration Inversion

Figure 140. Inversion of Boolean Inputs

3BDS011224R4101 217
Vertical Navigation Section 3 Configuration

Vertical Navigation
For a better overview on function diagrams, it is possible to built a hierarchical
Functional Structure with parent-child diagrams. Functions on a lower level can be
summarized in a separate diagram and displayed on an overview diagram on higher
level as a single function component with input and output ports / parameters.
Diagrams on lower level are also called nested diagrams. They can be opened from
an overview diagram by choosing View > Nested Diagram or Goto Nested
Diagram from the context menu. This is also called vertical navigation - top down,
bottom up, throughout the functional hierarchy.
Inputs and outputs of nested diagrams are function components of type
[Object Type Structure]Object Types/Functional Planning/Generic Function
Components/Connectors/Diagram Parameters/Input (Output, Inout) Parameter:

Figure 141. Diagram Parameters in Object Type Structure

You can apply diagram parameters to


• nested diagrams in Functional Structure, see Nested Diagram.
• diagram types in Object Type Structure, see Diagram Type Sample.

218 3BDS011224R4101
Section 3 Configuration Vertical Navigation

In Figure 142, we have an overview diagram D0 and two nested diagrams D1 and
D2. The diagram parameters D1:In1, D1:In2, D1:Out and D2:In, D2:Out
• are accessible as aspect properties in diagram D0.
• are visible as ports in overview diagram D0.
Thus they can be connected in the overview diagram as any other ports. Diagram
Parameter connections are visible in the overview diagram, not in the nested
diagrams.
If there is no component view defined for a nested diagram, a symbol is
automatically created on base of the default component template, see Figure 12.
However you can also define your own symbol for nested diagrams:
1. Create a Component view for the nested diagram to be customized.
2. Select File > New, and New Component.
3. Draw your customized symbol with corresponding ports.
4. Name the ports exactly as the diagram parameters.
In the sense of a structural programming language, diagram parameters
refer to in-out parameters of function calls.

On configuration data generation, the diagram parameter description is


copied to the corresponding control module / single control module
parameter.
You can apply any CB parameter keyword as IN, OUT, IN(OUT),
OUT(IN), NODE, or EDIT. CB expects that control module
• input parameter start with description ’IN’
• output parameter start with description ’OUT’
• inout parameter start with description ’IN(OUT)’ or ’OUT(IN)’ or
nothing.
The diagram parameter description gets displayed as tooltip at the
corresponding port of the nested diagram.

You can define initial values at the Value.InitVal aspect property of


the diagram parameter.

3BDS011224R4101 219
Vertical Navigation Section 3 Configuration

Figure 142. Nested Diagrams

220 3BDS011224R4101
Section 3 Configuration Horizontal Navigation

Horizontal Navigation
Another possibility to split function diagrams is the use of (off-) diagram
references. You can navigate through a group of function diagrams that are
connected via diagram references. This is also referred as horizontal navigation.
There is no restriction in connecting / referencing diagrams located anywhere in the
Functional Structure. You navigate from one diagram to another one by choosing
View > Referenced Diagram... or Goto Reference... from the context menu.
Inputs and outputs of referenced diagrams are function components of type
[Object Type Structure]Object Types/Functional Planning/Generic Function
Components/Connectors/Off Diagram Reference/Input (Output) Reference:

Figure 143. Diagram References in Object Type Structure

You can apply diagram references to diagrams in Functional Structure only. They
are not supported by diagram types in Object Type Structure. In Figure 144, we have
an overview diagram D0 and two diagrams D1 and D2 with (off-) diagram
references. D1:Out is connected to D2:In, and D2:Out is connected to D1:In1 and
D1:In2. This is indicated by automatically calculated cross-references in D1 and
D2. On contrast to nested diagrams with diagram parameters, diagram references
are not visible in the parent (overview) diagram D0. However, you can of course
combine diagram references and diagram parameters in one diagram.

3BDS011224R4101 221
Horizontal Navigation Section 3 Configuration

Figure 144. Referenced Diagrams

222 3BDS011224R4101
Section 3 Configuration Horizontal Navigation

Diagram Variables
In effect, diagram references consist of an input/output reference and a diagram
variable. A diagram variable is an aspect object with an aspect of category Function
Diagram Variable. This aspect’s config view displays
• a Definition tab to define the datatype, initial value, and variable attributes.
• and a cross-reference list, see Figure 145.
Diagram variables are inserted into the Functional Structure as children of the
input/output reference objects. Each insertion of a diagram variable indicates that
there exists a connection between the parent input/output reference objects. Thus,
diagram references can connected by basic Plant Explorer function ’Insert Object’,
or with Bulk Data Manager, see Bulk Connect Diagram References. You can also
engineer/prepare a pool of diagram variables anywhere in Functional Structure,
before using them to connect diagram references.

Figure 145. Diagram Variables

3BDS011224R4101 223
Horizontal Navigation Section 3 Configuration

In the sense of a structural programming language, diagram references


and diagram variables refer to global variables.
The global variable takes the name, description, data type, initial value
and attributes of the diagram variable.
The Function Diagram Variable aspect publishes properties that can be
bulk engineered by e.g. BDM:
• DataType
• InitVal
• Attributes.
If they get changed, the parent diagram references automatically update
their aspect properties Value.DataType and VariableAttributes.
If you change the parent diagram reference’s datatype or attributes,
Function Designer asks you to update these values to the diagram
variable, if any.

Connect To Diagram Variable


You interactively create (off-) diagram reference and connect to diagram variables
by the following steps:
1. In Diagram view, insert a function component of type
[Object Type Structure]Object Types/Functional Planning/Generic Function
Components/Connectors/Off Diagram Reference/Input (Output) Reference.
2. Right click on the diagram reference symbol and choose ’Connect to Diagram
Variable’ from the context menu.

224 3BDS011224R4101
Section 3 Configuration Horizontal Navigation

3. Dialog Connect to Diagram Variable is opened.

Figure 146. Dialog Connect to Diagram Variable

4. Enter a new diagram variable, or select an already existing one.


5. A new diagram variable gets created or an existing one gets inserted in
Functional Structure.
6. The diagram reference is connected to that diagram variable. Cross References
are automatically updated in the diagram.
You can also create and connect to a diagram variable by basic Plant Explorer
commands:
1. In Plant Explorer’s object browser, select an input/output (off-) diagram
reference object, and create a child aspect object of any type.
2. Add an aspect of category ’Function Diagram Variable’.
3. Insert this diagram variable aspect object as child of other input/output (off-)
diagram reference objects which shall be connected together.

3BDS011224R4101 225
Horizontal Navigation Section 3 Configuration

4. Cross References are automatically updated in corresponding function


diagrams.
If you drag&drop a port to the left border of a function diagram, a new
diagram reference gets automatically created with corresponding
datatype. The default name of the diagram reference equals <PortName>.
In addition, you can connect to an existing diagram variable or create a
new one. The default name of the diagram variable equals
<DiagramName>_<PortName>.
Same holds for output references that get automatically created on
drag&drop of a port to the right border of a diagram.

Disconnect From Diagram Variable


You interactively disconnect from a diagram variable by the following steps:
1. In Diagram view, right click on a diagram reference symbol and choose
’Disconnect from Diagram Variable’ from the context menu.
2. All references are disconnected, and corresponding function diagrams get
automatically updated.
You can also disconnect from a diagram variable by basic Plant Explorer
commands:
1. In Plant Explorer’s object browser, select a diagram variable object in
Functional Structure.
2. Delete it.
3. Cross References are automatically updated in corresponding function
diagrams.

Goto Reference
You navigate from one diagram to another one by the following steps:
1. In Diagram view, select a diagram reference symbol and choose View >
Referenced Diagram..., or right click on the diagram reference symbol and
choose Goto Reference...’ from the context menu.

226 3BDS011224R4101
Section 3 Configuration Horizontal Navigation

2. Dialog Goto Reference is opened.

Figure 147. Dialog Goto Reference

3. Select a reference to open the corresponding diagram. The corresponding


diagram reference symbol gets selected in the referenced diagram.

Number of Diagram References


By default, diagram reference symbols grow from top to bottom to display all
references. As the number of references displayed is limited by the actual page size,
you can define the maximum number that gets displayed in one column by the
following steps:
1. In Diagram view, select a diagram reference symbol, right click and choose
Goto Reference...’ from the context menu.

3BDS011224R4101 227
System Functions Section 3 Configuration

2. Dialog Number of Diagram References is opened.

Figure 148. Dialog Number of Diagram References

3. Define the maximum number of diagram references to be displayed in one


column. If the actual number of references exceeds this number, the diagram
reference symbol automatically adds additional columns and grows from left to
right.
Diagram References are sorted according to Diagram names, or, for equal
Diagram names according to Diagram Reference names.

Diagram Variables on Copy/Paste Diagram


Links on a single diagram define 1:1 or 1:N networks. Same can be considered for
diagram variables which define 1:1 or 1:N networks between diagrams.
If you copy/paste diagrams, diagram variables and their networks are copied,
renamed, or disconnected according to the following scheme:
• The copy of a 1:1 connected input reference gets deleted/disconnected from its
diagram variable if the corresponding output reference is not copied.
• The copy of a 1:1 connected output reference gets renamed together with its
diagram variable. This is to avoid duplicate diagram variables with same name.
• In case a complete network or sub-network of diagram variables gets copied
(e.g. think of a substructure with many diagrams), diagram references and
variables are copied as well but renamed. This is to avoid duplicate diagram
variables with same name.

System Functions
Function Designer is an aspect system in the 800xA system and supports therefore
all system functions like electronic signature, audit trail, user log-over,

228 3BDS011224R4101
Section 3 Configuration System Functions

backup/restore, export/import. Most functions are covered by the 800xA system,


however Function Designer provides some extensions as described below.

Audit Trail
Function Designer creates specific Audit Trail Events if the Audit Trail feature is
enabled within the current 800xA system:
• On File > Save, an Audit Trail event Save Information FuD is written. An
additional audit trail log message can be appended, see Dialog Audit Trail Log
Message.
• On any diagram state change, an audit trail event InfoChangeDiagramState is
written, see Diagram States and Transitions.

Figure 149. Dialog Audit Trail Log Message

3BDS011224R4101 229
System Functions Section 3 Configuration

Figure 150. Audit Trail Events written by Function Designer

Permissions and user roles


Users of Function Designer who want to modify and configure diagrams and
components need to hold the Application Engineer user role. An application
engineer has good knowledge about working with the Aspect Object Framework,
Engineering Workplace, Control Builder M, and FieldBus Builder.
Users of Function Designer who want to open or print diagrams and components
can be a system engineer, an operator, or a maintenance employee.

Authority
Function Designer supports the 800xA system’s authority concept by checking
• Permissions granted to a user and
• Roles connected with this user.
This is done against the permissions required for actions in Function Designer and
roles required for user interface availability.
To create, edit, or generate configuration data you need the application engineer
role. In case you do not hold that role, or in case a Security Definition Aspect
restricts configuration permissions for specific users, user groups, or locations, the
corresponding Function Diagram and Component views are is Read-only mode.
This is indicated by

230 3BDS011224R4101
Section 3 Configuration System Functions

• a Read indicator in the status bar. Double click on that indicator to get more
detailed information.
• a Read-Only indicator in the title of various dialogs, e.g. Aspect Properties
dialog and Component Properties dialog.

User Log-Over
You can use the Log-Over function within Function Designer. After log-over the
current Diagram View / Component View is closed, the next Diagram View /
Component View you open is then shown according to the new user rights.

Import/Export (AFW files)


Import/export for CB control projects, applications, libraries, etc. are described in
3BSE035980 Basic Control Software instruction, Section 10 Maintenance and
Trouble-Shooting.
Function Designer adds additional export dependencies to include e.g. objects in
Functional Structure like diagrams, allocatable groups, components, I/O Signals,
diagram references and diagram variables.
• Export control network with dependencies and with children:
Drag&drop the control network object from Control Structure into the
Import/Export tool and check Include Dependencies and check Include
Children.
You will get the entire control network including projects, applications,
controllers, and user defined libraries. Additionally you will get all diagrams
including diagram references in Functional Structure.
• Export control project with dependencies and with children:
Drag&drop the control project object from Control Structure into the
Import/Export tool and check Include Dependencies and check Include
Children.
You will get the entire control project including applications, controllers, and
user defined libraries. Additionally you will get all diagrams including diagram
references in Functional Structure.

3BDS011224R4101 231
System Functions Section 3 Configuration

• Export control application with dependencies and with children:


Drag&drop the control application object from Control Structure into the
Import/Export tool and check Include Dependencies and check Include
Children.
You will get the entire control application plus user defined libraries connected
to that application. Additionally you will get all diagrams allocated to that
application including diagram references in Functional Structure, and allocated
I/O signals in Control Structure (hardware tree).
• Export function diagram (SCM) with dependencies and with children:
Drag&drop the diagram object from Control Structure or from Functional
Structure into the Import/Export tool and check Include Dependencies and
Include Children.
The smallest unit that can be exported with dependencies is a Control
application.The reason is that Control Builder stores some data for SCMs in the
application aspect, e.g. Control Properties.
Thus you get the same result as exporting the complete control application. The
AFW file not only contains the diagram you intended to export, but all
diagrams allocated to that application including diagram references in
Functional Structure, and allocated I/O signals in Control Structure (hardware
tree).
Do not delete diagrams (SCMs) from such an AFW file, and do not import
just a single diagram. Otherwise you might get inconsistent data on
import. If you intent to merge diagrams created by several engineers into
one application, export a single (or some) diagrams without dependencies
both from Functional Structure and Control Structure, see Export
function diagram (SCM) without dependencies and with children:

232 3BDS011224R4101
Section 3 Configuration System Functions

• Export function diagram (SCM) without dependencies and with children:


Drag&drop the diagram object from Control Structure and from Functional
Structure into the Import/Export tool into the same AFW file, uncheck Include
Dependencies and check Include Children.
In case of a nested diagrams (or diagrams with multiple allocatable
groups) that are allocated to different applications, the substructure in
Functional Structure differs from the one in Control Structure.
Make sure that you add all children in Functional Structure, and all
diagrams / allocatable groups in Control Structure that correspond to the
allocation of the nested diagrams / allocatable groups.
Otherwise you might get inconsistent data on import.
You will get the diagram with its children in Control Structure and in
Functional Structure, including diagram references in Functional Structure.
On import, used types (application defined and library defined ones) must exist
in the system.
In import of a diagram with references to other diagrams, you will get a
query to replace existing diagram variables:
• Yes: Diagram references get connected to the diagram variable(s).
• No: Diagram references get unconnected.
• Export control library version with dependencies and with children:
Drag&drop the library version from library structure into the Import/Export
tool, check Include Dependencies and check Include Children.
You will get the entire library version including diagram types and connected
user defined libraries.
• Export control library version without dependencies and with children:
Drag&drop the library version from Object Type Structure and from library
structure into the Import/Export tool into the same AFW file, uncheck Include
Dependencies and check Include Children. Add the library key from the
admin structure.
You will get the entire library version including diagram types, but without
connected user defined libraries.

3BDS011224R4101 233
System Functions Section 3 Configuration

On import, connected libraries must exist in the system.


• Export function diagram type (CM type) with dependencies and with
children:
Drag&drop the diagram object type from Object Type Structure into the
Import/Export tool, check Include Dependencies and check Include
Children.
You will get the diagram type with its formal instances in Object Type
Structure, including the entire library.
• Export function diagram type (CM type) without dependencies and with
children:
Drag&drop the diagram object type from Object Type Structure into the into
the Import/Export tool, uncheck Include Dependencies and check Include
Children.
You will get the diagram type with its formal instances in Object Type
Structure.

234 3BDS011224R4101
Section 3 Configuration AC 800 M Integration

AC 800 M Integration
Introduction and Requirements
AC 800M integration of Function Designer describes the workflow of functional
planning, allocation of functions to an AC 800M controller within Control Structure
and generation of configuration data for Control Builder M.
For function component allocation and controller configuration, the system
extension Function Designer for AC800M is needed. This extension is dependent
on system extensions Function Designer, AC800M Connect, and AC800M Signal
Extensions. All tools have to be installed, all system extensions have to be loaded.
To load the system extension Function Designer for AC800M, use the
Configuration Wizard via System Administration > (System Name) > System
Extensions as displayed in Figure 151:

Figure 151. System Extension Function Designer for AC800M

3BDS011224R4101 235
Introduction and Requirements Section 3 Configuration

As Function Designer was not released for SB2, it is not recommended to


load system extensions AC800M SB2 Libraries and Function Designer
for AC800M SB2 Libraries. However, you need to load them in order to
upgrade function diagrams with instances of libraries
• BasicLib 1.0/0
• BatchLib 1.0/0
• COMLICommLib 1.0/0, CommunicationLib 1.0/0
• ControlAdvancedLib 1.0/0, ControlBasicLib 1.0/0,
ControlExtendedLib 1.0/0, ControlFuzzyLib 1.0/0, ControlSimpleLib
1.0/0, ControlStandardLib 1.0/0
• FFH1CommLib 1.0/0, FFHSECommLib 1.0/0
• FireGasLib 1.0/0
• GraphicTemplateLib 1.0/0
• GroupStartLib 1.0/0
• INSUMCommLib 1.0/0, MB300CommLib 1.0/0, MMSCommLib 1.0/0,
ModBusCommLib 1.0/0
• ProcessObjBasicLib 1.0/0 or 2.0/0, ProcessObjDriveLib 1.0/0,
ProcessObjExtLib 1.0/0 or 2.0/0, ProcessObjInsumLib 1.0/0
• SeqStartLib 1.0/0
• SerialCommLib 1.0/0, SerialLib 1.0/0
• SignalLib 1.0/0
• SupervisionLib 1.0/0
In that case it is strongly recommended to connect your CB project(s) and
CB application(s) to the actual versions of these libraries. By that,
function diagrams get automatically upgraded on open diagram.

With Function Designer you are able to


• Create diagrams including function components for Control Builder M. A
diagram in Functional Structure represents a Single Control Module, a diagram
in Object Type Structure represents a Control Module Type. A diagram
includes:
– Functions,
– Function block types
– Control module types

236 3BDS011224R4101
Section 3 Configuration Definitions

– I/O signal types


• Group function components into allocatable groups
• Define data flow order within the allocatable groups
• Allocate allocatable groups to applications in Control Structure
• Define variables for your control code
• Configure channels on I/O hardware units.
• Display on-line values in the diagram and in the Watch Table.
• Automatically configure MMS cross communication.

Definitions
The following definitions are essential for Control Builder M integration:
• Function Diagram
• Symbols
• Function Component
• Function Component Type
• Allocatable Group
• Mapping Aspect Objects

Function Diagram
A function diagram includes one or more function components and symbols. A
diagram is displayed in preview area or in an overlapped window.

Symbols
The function diagram’s logic layer can hold symbols, that means rectangular blocks
with icons, labels, and 0…n input and 0...n output ports.

3BDS011224R4101 237
Definitions Section 3 Configuration

Function Component
Function components are symbols which have function-related aspect data to other
aspect systems, for example, to
• Controller aspect system Control Builder M (CBM):
A function component may represent one of the following instances:
– System function
– System function block
– System control module
– User-defined function block
– User-defined control module
– I/O signal
• FF-, PROFIBUS-, HART-, LON-configuration aspect systems:
A function component may represent a fieldbus function block.
• HSI aspect system:
A function component may represent an HSI function.
• Function Designer aspect system:
A function component can represent/be a
– Nested function diagram on lower level (see also Vertical Navigation)
– Off-diagram reference:
A connection or cross-link to other function diagram documents (see also
Horizontal Navigation)
– On-page connector:
Label representing sink/source of connection on the same page to avoid
too many crossings.
– Off-page connector:
Page cross-reference with label representing sink/source of connection
between different pages (see also Off Page Connector)
– Explicitly declared local variable: See Explicitly and Implicitly Defined
Variables).

238 3BDS011224R4101
Section 3 Configuration Definitions

Function Component Type


Function components are instances of function component types defined in Object
Type Structure. The object type definition also defines if a function component is
instantiated as Aspect Object, or as symbol object in the function diagram only (see
also Object Type Definition Create Info).
According to this, function components can be
• Aspect Objects both visible in Functional Structure and in a function diagram.
• Symbol objects only visible in the function diagram.
Figure 152 shows an example.:

Figure 152. Function diagram with function component


Aspect Objects and symbol objects

Allocatable Group
Every bundle of function components, which will be assigned later on in the Control
Structure, is regarded as an allocatable group. An allocatable group describes a
group of components which are or will be allocated to the same Aspect Object. By
default, each object having a function diagram also has an allocatable group aspect.
If you want to split the logic of one function diagram, in order to distribute the
function components into different locations later on, it is possible to create
additional allocatable groups, which will lead to generic objects with an allocatable

3BDS011224R4101 239
Definitions Section 3 Configuration

group aspect. This allocatable group aspect will act as folder object. These folder
objects appear as children objects of function diagrams in the plant explorer’s
Functional Structure.
As mentioned above, function diagram logic can be assigned to one or splitted to
several allocatable groups:
• Assigning Complete Function Diagram Logic to One Allocatable Group
By default, an allocatable group aspect is automatically generated for each
diagram object (aspect object with Function aspect and non-empty Diagram
view). This allows you to allocate the whole function diagram to the Control
Structure later on. Then, all logic components belonging to that function
diagram can be allocated to one application / task on a controller.
• Splitting Function Diagram Logic to Several Allocatable Groups:
If you want to split the logic in order to allocate it to several tasks, controllers
or applications, you have the possibility to create allocatable groups for
assigning the different parts of the function diagram to different allocatable
groups.
Creation of allocatable groups means creation of generic objects having an
allocatable group aspect. These generic objects appear as child objects below
the object containing the function diagram and they act as folder objects.
Then you can assign function components of the function diagram to the
different allocatable groups.

Mapping Aspect Objects


Each allocatable group can belong to only one function diagram. It is not possible to
assign logic of different function diagrams into the same allocatable group. A
function diagram can have nested components with own function diagrams (and
own allocatable group aspects). If function component objects of different function
diagrams have to be located in the same task on the same controller, they are

240 3BDS011224R4101
Section 3 Configuration Workflow Overview

allocated each of them in an own allocatable group. It is possible to allocate several


allocatable groups to the same task.

Function Diagram 1 Allocatable Group 1


Task 1
Allocatable Group n
Controller 1
Function Diagram 2 Allocatable Group n+1
Task 2
Allocatable Group m

Figure 153. Mapping of allocatable groups

For AC 800M controllers, each allocatable group (also nested ones) will produce a
single control module (SCM) or an I/O signal.

Workflow Overview
The workflow consists of the following steps:
• Building up Functional Structure and Function Diagrams
• Grouping Function Components into Allocatable Groups
• Defining Data Flow Order in Allocatable Groups
• Labelling Splitted Connections
• Showing Allocation Details
• Building up Control Structure
• Allocating Allocatable Groups
• Variable Creation

Building up Functional Structure and Function Diagrams


Function Designer is used for function oriented engineering of an automation
system. Figure 154 shows an example of a function diagram, whose function

3BDS011224R4101 241
Building up Functional Structure and Function Diagrams Section 3 Configuration

component Flow Control represents a nested function diagram. The nested function
diagram is shown in Figure 155:

Figure 154. Function diagram.

242 3BDS011224R4101
Section 3 Configuration Grouping Function Components into Allocatable Groups

Figure 155. Nested function diagram

Grouping Function Components into Allocatable Groups


The function components in a diagram are assigned to one allocatable group by
default, or can be splitted into several allocatable groups:
• If a function diagram is to be assigned completely to one application, nothing
more is to do. By default, all function component are already assigned to the
allocatable group aspect of the diagram object. This allows you to simply
allocate the whole function diagram to the Control Structure later on: All
functions, function blocks, and control modules are allocated to the same
application/task on the same controller with minimum effort.

3BDS011224R4101 243
Grouping Function Components into Allocatable Groups Section 3 Configuration

• If the control logic of a function diagram is to be assigned (splitted) to several


allocatable groups in order to allocate the control logic parts to different tasks,
applications, or controllers, the following is to do:
1. Create a new allocatable group inside Function Designer
2. Grouping function components inside Function Designer

Create a new allocatable group inside Function Designer


1. Open the function diagram whose logic shall be splitted to several allocatable
groups.
2. Choose the menu command Allocation > New Allocatable Group, or the
corresponding button in the Allocation toolbar. The Create Allocatable
Group dialog is opened.
3. In the Create Allocatable Group dialog dialog, enter a name for the new
allocatable group in the Name field and a short name in the Short Name field.
Optionally, you can also choose a color for indicating all function components
assigned to this new allocatable group.
4. Click OK.
The created allocated object is located as child object below the function diagram
object in Functional Structure. It can be seen as folder object to separate parts of the
logic of a function diagram.

244 3BDS011224R4101
Section 3 Configuration Grouping Function Components into Allocatable Groups

Create Allocatable Group


Use the Create Allocatable Group dialog to create a new, additional allocatable
groups. Access this dialog via the Allocation > New Allocatable Group menu
command, or via the Allocation toolbar.

Figure 156. Create Allocatable Group dialog

• Name
Enter a name for the new allocatable group object. This name equals the aspect
objects Name aspect.
• Short Name
Enter a short name for the new allocatable group. If any, the short name gets
displayed in the Allocation toolbar, in the Data Flow Order dialog, and in the
diagram when showing allocation details via the document reference
$AllocGroup.
• Color
Click on the arrow down to open the color palette and choose the wanted color
by clicking on it.

3BDS011224R4101 245
Grouping Function Components into Allocatable Groups Section 3 Configuration

If there is not offered an appropriate color, click Other to open the Color
dialog offering the whole color palette of the system. The selected color gets
optionally displayed in the diagram when showing allocation details.
• Exclude from Configuration Data Generation
This allocatable group is to be excluded from configuration data generation.
• OK
Click OK to save your settings and to close the dialog.
• Cancel
Click Cancel to quit the dialog without saving your setting modifications.

246 3BDS011224R4101
Section 3 Configuration Grouping Function Components into Allocatable Groups

In Figure 157 you see the allocatable group aspect for a diagram inside Functional
Structure:

Figure 157. Allocatable group created in Functional Structure

If you invoke the allocatable group’s Allocate command and the Allocate dialog
does not display any Control Builder Application: Check if Control Builder is in
on-line mode. Switch Control Builder into off-line mode before invoking the
Allocate command.

3BDS011224R4101 247
Grouping Function Components into Allocatable Groups Section 3 Configuration

Grouping function components inside Function Designer


To assign function components to an(other) allocatable group inside Function
Designer, do the following:
1. Select one or more function component(s) inside the function diagram.
2. Choose main menu item Allocation > Allocation Grouping or the component
context menu Allocation Grouping.
3. The dialog Destination Group is opened. Select an allocatable group and press
OK.

Figure 158. Destination group dialog

4. Selected function component aspect objects get automatically moved in


Functional Structure and located as child objects of the corresponding
allocatable group, see Figure 157

248 3BDS011224R4101
Section 3 Configuration Grouping Function Components into Allocatable Groups

Figure 159. Grouping into allocatable groups by right mouse click

Assigning Function Components of Different Function Diagrams to One Task


An allocatable group belongs to one function diagram only. Therefore, it is not
possible to group function components belonging to different function diagrams
into the same allocatable group folder in order to assign them to the same task in the
same application.
If you want to get such a kind of allocation, you have to create separate allocatable
groups within all these function diagrams and allocate all of them later on to the

3BDS011224R4101 249
Grouping Function Components into Allocatable Groups Section 3 Configuration

same task. The following figures displays an example for wrong and correct
grouping of function components:

Function diagram 1 Function diagram 1 Task 1 Application 1


Function component 1.1 Allocatable group 1.1
Function component 1.2

Function diagram 2
Function component 2.1
Function component 2.2

Figure 160. Wrong grouping of function components

Function diagram 1 Function diagram 1 Task 1 Application 1


Function component 1.1 Allocatable group 1.1
Function component 1.2

Function diagram 2 Function diagram 2


Function component 2.1 Allocatable group 2.1
Function component 2.2

Figure 161. Correct grouping of function components

Grouping Nested Function Diagrams


See .Allocating Nested Function Diagrams.

Copying Function Components and Allocatable Groups


Note the following features on copying function components (Aspect Objects
and/or symbol objects):
• If you copy and paste a function component Aspect Object inside the
Functional Structure and the parent of the target object has a function diagram,
this function component is automatically inserted into this function diagram
• If you copy and paste a complete allocatable group, you will get a new
allocatable group with all child function components (Aspect Objects and

250 3BDS011224R4101
Section 3 Configuration Grouping Function Components into Allocatable Groups

symbol objects). These objects are automatically inserted into the


corresponding function diagram.
• If you copy and paste function components inside a function diagram (Diagram
view), the function components are assigned to the active allocatable group
(see Figure 162)

Figure 162. Copying inside the Function Designer

3BDS011224R4101 251
Defining Data Flow Order in Allocatable Groups Section 3 Configuration

Defining Data Flow Order in Allocatable Groups


When instantiating a new component a default "Data Flow Order" number is
determined. If the "Extended Name" dialog or the "Variable Properties" dialog pops
up during instantiation this default is used to select a certain entry in the new "Insert
Before" combo box of these dialogs.
After having assigned the logic components to allocatable groups, you can define
the data flow order of function components within an allocatable group deviating
from the default order. In effect, the data flow order is stored inside the allocatable
group aspect.
The definition of the data flow order is done in the Data Flow Order dialog dialog.
All components of an allocatable group can be moved up and down to get the
wanted data flow order.
The data flow order numbering is beginning with 1 in steps of 1.

To define the data flow order in an allocatable group


1. Open the function diagram where you want to modify the data flow order.
2. Choose the menu command Allocation > Define Data Flow Order or click
the icon of the Allocation toolbar. The Data Flow Order dialog is
opened.
3. In the Data Flow Order dialog dialog, choose the wanted allocatable group
from the Allocatable Group drop-down list box.
4. Select a function component from the Data Flow Order list and move it to the
wanted location:
– Click to move up the current selected function component.
– Click to move down the current selected function component.

Data Flow Order Dialog


Use the Data Flow Order in Allocatable Groups dialog, to define (modify) the
data flow order of function components within an allocatable group.

252 3BDS011224R4101
Section 3 Configuration Defining Data Flow Order in Allocatable Groups

Access this dialog by choosing the menu command Allocation > Define Data Flow
Order, or the corresponding button on the Allocation toolbar.

Figure 163. Data Flow Order dialog

• Allocatable Group
Use this drop down list box to choose the allocatable group for changing the
data flow order.
• Data Flow Order
Use the arrow up button to move the currently selected component one
level higher.
Use the arrow down button to move the currently selected component one
level lower.
• Apply
Click Apply to apply the modified data flow order to the currently selected
allocatable group.

3BDS011224R4101 253
Defining Data Flow Order in Allocatable Groups Section 3 Configuration

• Close
Click Close to close the dialog.

Code Block Generation


Function Designer generates at least one code block for one Function Diagram.
Exception are Control Modules: Every instance of a Control Module in a Function
Diagram which has glue logic connected generates a new code block and splits the
glue logic at the input and output into different code blocks. Function Designer
generates a new Aspect Property for every element which could generate a new
code block, the propery name is “NewCodeBlock”. But it only generates a new code
block if some glue logic is available, empty code blocks will not be generated.
If you want to insert a new code block starting at another element than a Control
Module, you have to insert a new property “NewCodeBlock” (string / read & write)
for this element using the Apect Property Editor in Function Designer (right mouse
click on the object).
In addition you can specify another than the default name (“FUD_CodeBlockn“) for
this code block by setting the value of the new attribute to the desired name. Please
note that a code block with the name “START” is only executed in the very first
cycle of a task.

Code Block Sorting


In comparison to function blocks it is not required (it is even not possible) to define
a data flow order for AC 800 M control modules inside Control Builder. Instead an
automatic code-sorting algorithm is used.
Based on the data flow direction (given by Function Designer) an optimized data
flow order is calculated by the Control Builder compiler automatically. But
whenever at least two variables are written and read by two control modules at the
same time, this algorithm detects a loop, which could not be resolved automatically,
of course. See Control Builder Online Help.

254 3BDS011224R4101
Section 3 Configuration Defining Data Flow Order in Allocatable Groups

In order to avoid such loops because of connections between AC 800 M Control


Modules, and in order to set the predefined data flow order, Function Designer splits
the generated single control module code into a number of code blocks:

Figure 164. Code Block Sorting

The data flow order defined in Function Designer should be A-Cma-B-G-F-CMb-E-


C-D.
Now the rule for code block splitting is: Start with first function block in data flow
order list and put it to a codeblock_a as long as you find a control module; then

3BDS011224R4101 255
Defining Data Flow Order in Allocatable Groups Section 3 Configuration

create a new code block and put the next function block in the data flow order to that
code block until you find a control module, etc.

Figure 165. Code Block Sorting and Data Flow Order

The Control Modules should be placed within the data flow order
according to the signal flow between Function Blocks and Control
Modules. This will avoid loops within the Control Builder detected later
during download to the controller: The glue logic before a Control Module
within the data flow order (connected to the inputs) and the glue logic
behind it (connected to the outputs) will become an own code block within
Control Builder.

256 3BDS011224R4101
Section 3 Configuration Showing Allocation Details

Figure 166. Logic assigned to several code blocks within CBM


The automatic code sorting algorithm of the Control Builder will sort the Control
Modules as well as single code blocks.

Showing Allocation Details


You can view and print allocation details like owning allocatable group and data
flow order directly in the function diagram.
Border color and short name of an allocatable group can be set via the Color and
Short Name property of the allocatable group aspect.
The owning allocatable group and data flow order of a function component
can be displayed by any text or label component using the field codes:
• $AllocDetails
• $AllocGroup
• $Order

To define allocation details


1. Open the function diagram whose allocation details shall be shown.

3BDS011224R4101 257
Explicitly and Implicitly Defined Variables Section 3 Configuration

2. Choose the menu command Allocation > Show Allocation Details or click
the icon of the Allocation toolbar. The allocation details are shown in the
function diagram.

Figure 167. Showing allocation details

Explicitly and Implicitly Defined Variables


Variables can be declared explicitly, or they get implicitly created whenever needed
during configuration data generation. Explicitly declared variables are
• Diagram Parameter, see Figure 141.
• Diagram References and global Diagram Variables, see Figure 143

258 3BDS011224R4101
Section 3 Configuration Explicitly and Implicitly Defined Variables

• Local variables, see Figure 168.

Figure 168. Explicitly created local variables

The dialog Variable Properties in Figure 169 is used to define properties for
diagram parameters, diagram references/diagram variables, and local variables. You
can set
• Name of variable/parameter/reference
• Description of variable/parameter/reference
• Data type of variable/parameter/reference. The combo box Data Type lists all
system-, library- and application defined data types.

3BDS011224R4101 259
Explicitly and Implicitly Defined Variables Section 3 Configuration

• Attributes of variable/reference. Disabled for parameters


Function Designer allows to use the state attribute for variables. For a variable
with “state” attribute the following is valid, if the variable is required in two
different code blocks:
• Read applies to the “old” value.
• Write applies to the current value.
• Data Flow Order of variable/parameter/reference. The combo box Data Flow
Order Insert Before lists all function components of the current allocatable
group. Select the function component before which the variable/parameter/
reference shall be located. Select at the end of the Allocatable Group if you
want the variable/parameter/ reference to be located at the end of the current
allocatable group. The combo box Data Flow Order Insert Before is visible
at creation time of the variable/parameter/reference only. If you want to change
the data flow order of the variable/parameter/reference later use the Data Flow
Order dialog.
The Data Flow Order of variable/parameter/reference influences the order of
execution of MOVE functions implicitly inserted into a Function Diagram and
generated into corresponding code blocks by Function Designer in cases as:
• Mapping of structured variables of different data types.
• Connection of variables to other variables (diagram references etc.).
• Connection to the "old" values in own code block, if using the state attribute.

260 3BDS011224R4101
Section 3 Configuration Explicitly and Implicitly Defined Variables

Figure 169. Dialog Variable Properties

If you modify data type or attributes of diagram references you get asked to
update the data type or attributes for connected diagram variable as well. In
case they differ, you will get corresponding warnings on File > Check and on
open diagram.
Local variables of structured datatype display ports to connect to sub-variables (use
the Show/Hide Ports command to show or hide individual sub-variables). Initial
values can be defined via the aspect property .Initval.

3BDS011224R4101 261
Labelling Splitted Connections Section 3 Configuration

Connection links implicitly create variables whenever needed. The variable name
for such a link can be displayed by the dialog in Figure 170. Select a link, right click
and select ’Variable Name ...’ in context menu.

Figure 170. Dialog Variable Name

Labelling Splitted Connections


If the logic of a function diagram is assigned to several allocatable groups, so that a
connection link between two or more function components is splitted, a
communication object is needed in Control Builder M to hold the connection. This
communication object will be a variable (output of the allocatable group)
corresponding to single control module parameters of Control Builder M. The
variable is created automatically on allocating the allocatable groups to the Control
Structure respectively to Control Builder M.
The name of the variable depends on whether the connection line in the function
diagram has a label or not:
• If you have given a unique label to the connection line (see To label a link
(connection line)), the variable will get the name of that label.
• If you have not given a label to the connection line a unique default label will
be created automatically by the Function Designer itself. Then, the name is
composed of: ”__”+“Out”+[ordered number] (for example, “__Out1”)
Figure 171 shows an example for splitting a connection line between two directly
connected function components grouped into two different allocatable groups.

262 3BDS011224R4101
Section 3 Configuration Labelling Splitted Connections

On allocating the allocatable groups Allocatable Group1/2, for the splitted


connection line Label1, a variable with the same name Label1 is created connecting
the single control module (SCM) parameters __Out1 and __In1:

Figure 171. Splitting of connected function components

3BDS011224R4101 263
Building up Control Structure Section 3 Configuration

Building up Control Structure


The Control Structure gets automatically updated, see Table 15.

Table 15. Changes in Control Structure

Change in function diagram or


Change in Control Structure
Functional Structure
Instantiate/copy/delete function or none (SCM gets updated on configuration data
procedure generation)
Instantiate/copy/delete function none (SCM gets updated on configuration data
block or control module as symbol generation)
object
Instantiate/copy function block or Function block or control module gets inserted
control module as aspect object below diagram / allocatable group (SCM)
Delete function block or control Function block or control module gets deleted
module aspect object in diagram from diagram / allocatable group (SCM)
Delete function block or control Function block or control module gets deleted
module aspect object in from diagram / allocatable group (SCM)
Engineering Workplace Advanved
Menu Delete from All Structures
Delete function block or control none. You need to manually remove the
module aspect object in Plant instance from the Control Structure.
Explorer object browser
Instantiate/copy/delete CBM IO none (SCM/application get updated on
signal configuration data generation)
Instantiate/copy/delete diagram none (SCM gets updated on configuration data
parameter generation)
Instantiate/copy/delete diagram none (SCM/application get updated on
reference and connect to diagram configuration data generation)
variable
Instantiate/copy/delete local none (SCM gets updated on configuration data
variable generation)

264 3BDS011224R4101
Section 3 Configuration Building up Control Structure

Table 15. Changes in Control Structure

Change in function diagram or


Change in Control Structure
Functional Structure
Allocate diagram / allocatable Diagram / allocatable group (SCM) gets moved
group from unallocated application to corresponding
CB application
Generate configuration data Nested (still unallocated) children get moved to
corresponding CB application
Unallocate diagram / allocatable Diagram / allocatable group (SCM) gets moved
group from CB application to unallocated application

3BDS011224R4101 265
Allocating Allocatable Groups Section 3 Configuration

Allocating Allocatable Groups


After having defined the data flow order within the allocatable groups, you can
allocate the function diagram logic to a specific application. The following
requirements must be fulfilled:
• Control Builder M (CBM) has to run
• The corresponding CBM project has to be opened
The insertion of allocatable groups from the Functional Structure into the Control
Structure can be done via the Allocate button in the Allocatable group’s aspect page,
see Figure 157. You can also use BDM, see Bulk Allocate Diagrams.
1. Open the Functional Structure and navigate to the allocatable group to be
allocated.
2. Open its allocatable group aspect.
3. Select the Allocate button.
4. The Allocate dialog is opened.

Figure 172. Allocate in Control Structure dialog

The allocation of the allocatable groups initiates the following actions:

266 3BDS011224R4101
Section 3 Configuration Allocating Allocatable Groups

• Control Structure aspect and Single Control Module aspect is added to the
allocatable group object.
• Control modules and function blocks are allocated, i.e. moved from the CBM
unallocated application to the selected application.
• Same holds for nested function diagrams.
Depending on the allocatable groups defined in the Functional Structure and
depending on the intended allocation within the Control Structure, one of the
following allocation variants is possible:
• Allocation of a Whole Function Diagram
• Allocation of Parts of a Function Diagram

Allocation of a Whole Function Diagram


If no extra allocatable groups have been created for a function diagram in the
Functional Structure, the allocatable group contains the whole function diagram.
The allocated diagram gets a single control module from Control Builder M’s point
of view.

Figure 173. Function Designer generated SCM in Control Structure

3BDS011224R4101 267
Allocating Allocatable Groups Section 3 Configuration

Allocation of Parts of a Function Diagram


If extra allocatable groups have been created for a function diagram in the
Functional Structure (each allocatable group contains a part of the function
diagram), you have two possibilities to allocate the allocatable groups to
applications
• You allocate the allocatable groups into different control applications. Then,
you will get a single control module for each allocatable group object (see
Figure 174, left).
• You allocate the top level object containing the function diagram to a control
application. You will get a single control module for the top level object and
additionally single control modules for each allocatable group object (see
Figure 174, right).

Figure 174. Several allocatable groups in Control Structure

268 3BDS011224R4101
Section 3 Configuration Allocating Allocatable Groups

.Allocating Nested Function Diagrams


It is possible to nest function diagrams within other function diagrams. Nesting
means that a function component of a function diagram contains an own (nested)
function diagram (see function components FC2 and FC6 in Figure 175).

Figure 175. Nested function diagrams

If the whole logic of a function diagram (inclusive the logic of all nested function
diagrams) is to be allocated to the same task, no allocatable group folder in addition
to the default allocatable group needs to be created. Only the function diagram on

3BDS011224R4101 269
Allocating Allocatable Groups Section 3 Configuration

the highest level is to be allocated (see MyFDD containing the function components
FC1, FC2, FC3 in Figure 176).

Figure 176. Nested function diagrams assigned to one allocatable


group (within Functional Structure)

Function diagrams can contain function blocks as well as control modules. Every
function component representing a nested function diagram will become a nested
single control modules within Control Builder M as long as it is not assigned to a
separate allocatable group.

270 3BDS011224R4101
Section 3 Configuration Allocating Allocatable Groups

Figure 177. Nested function diagrams assigned to one allocatable


group (within Control Builder M)

3BDS011224R4101 271
Allocating Allocatable Groups Section 3 Configuration

The structure example of Figure 176 results in the following Control Builder M
structure:

Figure 178. Nested function diagrams with different allocatable


groups (within Control Builder M)

272 3BDS011224R4101
Section 3 Configuration Allocating I/O Signals

Allocating I/O Signals


After having allocated the logic of the function diagrams to the Control Structure,
the I/O signals are to be allocated to hardware objects.
I/O parameters like Channel Settings and Scaling are configured in the
CBM_SignalParameter aspect. You do not need to configure the Connection
parameters Application, Variable, and Type. These parameters are automatically
updated by Function Designer.

Figure 179. I/O SignalParameter aspect

3BDS011224R4101 273
Allocating I/O Signals Section 3 Configuration

The I/O allocation type is configured in the CBM_SignalInformation aspect.


Typically, you will create and connect an I/O signal to an application global
variable. Examples and a description for the other options, e.g. create and connect to
local variable, or signal groups, are described in detail in Engineering
Studio\Engineering Platform\Allocation Samples.

Figure 180. I/O SignalInformation aspect

274 3BDS011224R4101
Section 3 Configuration Allocating I/O Signals

Allocation of I/O signals means insertion into the following Control Structure path
(see also Figure 181):
Control Network\CBM_project\Controllers\Controller_n\Hardware

Figure 181. I/O signal allocation in Control Structure

The channel number is configured by the I/O signal’s ChannelNumber aspect, see
Figure 182. Preferably use the I/O Allocation tool, see Allocating I/O Signals.

Figure 182. I/O Signal ChannelNumber aspect

3BDS011224R4101 275
Generate Configuration Data Section 3 Configuration

The graphical symbols for the CBM I/O signals installed by Function Designer for
AC800M system extension use text and label components with property references
in order to display
• I/O signal name
• Designation(location) in Control Structure
• FilterTime (AIS, AOS)
• SignalRange (AIS, AOS)
• Min, Max, Unit (AIS, AOS)
• On-line Values

Generate Configuration Data


After allocation of the diagrams / groups, you generate configuration data in order to
transfer or update Function Designer data into Control Builder M. In detail,
configuration data generation creates/updates
• SCM code blocks (FBD) with parameters, variables, external variables,
function blocks, functions, procedures
• Control modules and connections
• Control properties
• Application global and local variables
• Hardware connections (due to IO Allocation)
• OPC properties
You start configuration data generation by
• Function diagram, File > Generate Configuration Data (Full Build) or File >
Generate Configuration Data
• Allocatable Group aspect, buttons Generate Configuration Data (Full Build)
or Generate Configuration Data, see Figure 157.
• Allocatable Group aspect verbs Generate Configuration Data (Full Build) or
Generate Configuration Data. This is also useful on Bulk Generate
Configuration Data.

276 3BDS011224R4101
Section 3 Configuration Unallocation

Generate Configuration Data (Full Build) updates all selected


diagram(s)/group(s) and their children, independent of the diagram state, see
Instance Specific Initial Values.
Generate Configuration Data optimizes the build process and updates diagrams in
modified (red) state only. Diagrams in already generated (yellow) or loaded (green)
state are not changed.
Both functions display a working dialog indicating the progress and a Cancel
button. On cancel, the generation of the current diagram/group is finished before the
build process is aborted.,
Changes done in Function Designer after generating configuration data can
be handled in two different ways:
• File > Save or File > Save All just saves the changes within Functional
Structure, already generated SCMs inside Control Structure are not
updated.
• File > Generate Configuration Data and File > Generate Configuration
Data (Full Build) save the changes within Functional Structure and
updates already generated SCMs inside Control Structure.
You can safely choose File > Save or File > Save All many times to save
intermediate states before updating the SCMs by choosing File > Generate
Configuration Data or File > Generate Configuration Data (Full Build) once.

Unallocation
To unallocate an already allocated group, navigate to the allocatable group object in
Functional Structure, open its allocatable group aspect page, and press the
Unallocate button.
• Nested diagrams are unallocated as well, if any.
• Control modules and function blocks are unallocated, i.e. moved from the
CBM application to the unallocated application.
• Function Designer generated CBM configuration data is removed.

3BDS011224R4101 277
Variable Creation Section 3 Configuration

Variable Creation
In Control Builder M, variables are used for the following kinds of connection:
• Connections between Blocks inside an Allocatable Group
• Connections across Diagrams (horizontal cross references)
• Connections within nested Diagrams (vertical navigation)
• Connections to I/O Channels
• Connections from I/O Channels
• Connections between Allocatable Groups inside same Application
The following table contains the descriptions of abbreviations used in the tables of
this section:

Table 16. AC 800M Connect: Abbreviations

Action Abbreviation Action Description


AccessVar Create Access Variable
Appl: GlobVar Create global variable on application (editor) level
CM Control module
FB Function block
FUN Function
Parent SCM SCM one level above (within nested Allocatable Groups)
ReadCM Inserts control module for reading (e.g. MMSToCC)
ReadFB Inserts function block for reading (e.g. MMSRead)
SCM Single control module (= Allocatable group)
SCM: Var Creates variable on single control module (editor) level
SCM: Ext.Var Creates external variable on single control module (editor)
level
SCM: Par Creates Parameter on single control module (editor) level

278 3BDS011224R4101
Section 3 Configuration Variable Creation

Table 16. AC 800M Connect: Abbreviations

Action Abbreviation Action Description


TmpVar Creates direct logic connection
(= temporary variable in ST Code)
WriteCM Inserst control module for writing (e.g. CCToMMS)
WriteFB Inserts function block for writing (e.g. MMSWrite)

Connections between Blocks inside an Allocatable Group


If you have connections between blocks (functions, function blocks, control
modules) inside an allocatable group, the following variables will be created:

Table 17. Connections of blocks inside an allocatable group(1)

Target Ö
FB CM FUN
Source Ø
FB TmpVar SCM: Var TmpVar
CM SCM: Var SCM: Var SCM: Var
FUN TmpVar SCM: Var TmpVar
(1) The abbreviations are described in Table 16

The variable will be named according to the rule ’__+link+[unique number]’ if the
connections don’t have a label. If you have defined a labelled connection, the name
of the label is taken for the variable name (Var instead a TmpVar in the table above).

3BDS011224R4101 279
Variable Creation Section 3 Configuration

Connections across Diagrams (horizontal cross references)


If you have cross reference connections across diagrams, you use the diagram
reference objects and therefore the following variables will be used:

Table 18. Diagram References(1)

Target Ö
(outside AG)
Diagram Reference
Source Ø
Appl: GlobVar
FB
SCM: External Var
Appl: GlobVar
CM
SCM: External Var
Appl: GlobVar
FUN
SCM: External Var
(1) The abbreviations are described in Table 16

Table 19. Diagram References(1)

Target Ö FB CM FUN
(outside AG)

Source Ø
Appl: Appl: Appl:
GlobVar GlobVar GlobVar
Diagram
Reference SCM: SCM: SCM:
External External External
Var Var Var
(1) The abbreviations are described in Table 16

280 3BDS011224R4101
Section 3 Configuration Variable Creation

Connections within nested Diagrams (vertical navigation)


If you have connections across nested diagrams / nested allocatable groups, you use
the Diagram parameter objects and therefore the following variables will be used:

Table 20. Diagram Parameter(1)

Target Ö
(outside AG)
Diagram Parameter
Source Ø
Parent-SCM:Var
FB
SCM: Parameter
Parent-SCM:Var
CM
SCM: Parameter
Parent-SCM:Var
FUN
SCM: Parameter
(1) The abbreviations are described in Table 16

Table 21. Diagram Parameter(1)

Target Ö FB CM FUN
(outside AG)

Source Ø
Parent- Parent- Parent-
Diagram SCM:Var SCM:Var SCM:Var
Parameter SCM: SCM: SCM:
Parameter Parameter Parameter
(1) The abbreviations are described in Table 16

3BDS011224R4101 281
Variable Creation Section 3 Configuration

Connections to I/O Channels


If you have connections to I/O channels, the following variables will be used:

Table 22. Connections to I/O channels(1)

Target Ö
(outside AG) I/O: Out
Source Ø
Appl: GlobVar
FB
SCM: Ext.Var
Appl: GlobVar
CM
SCM: Ext.Var
Appl:
FUN GlobVarSCM:
Ext.Var
(1) The abbreviations are described in
Table 16

Connections from I/O Channels


If you have connections from I/O channels, the following variables will be used:

Table 23. Connections from I/O channels(1)

Target Ö FB CM FUN
(outside AG)

Source Ø
Appl: Appl: Appl:
GlobVar GlobVar GlobVar
I/O: In SCM:
SCM: SCM:
Ext.Var Ext.Var Ext.Var

(1) The abbreviations are described in Table 16

282 3BDS011224R4101
Section 3 Configuration Variable Creation

Annotation:
For all three kinds of connections (Diagram Parameter - Diagram References - I/Os)
’MOVE’ blocks are inserted.

Connections between Allocatable Groups inside same Application


Connections between allocatable groups always means we have to deal with two
single control modules, one for each allocatable group; on both single control
modules parameters have to be created: Parameter for source single control module
S_SCM and target T_SCM and connect these single control module parameters
with a global variable on application level.
If you have connections between allocatable groups, the following variables will be
used:

Table 24. Connections between allocatable groups inside same application(1)

Target Ö FB CM FUN
(outside AG)

Source Ø
Appl: GlobVar Appl: GlobVar Appl: GlobVar
FB S_SCM: ExtVar S_SCM: ExtVar S_SCM: ExtVar
T_SCM: ExtVar T_SCM: ExtVar T_SCM: ExtVar
Appl: GlobVar Appl: GlobVar Appl: GlobVar
CM S_SCM: ExtVar S_SCM: ExtVar S_SCM: ExtVar
T_SCM: ExtVar T_SCM: ExtVar T_SCM: ExtVar
Appl: GlobVar Appl: GlobVar Appl: GlobVar
FUN S_SCM: ExtVar S_SCM: ExtVar S_SCM: ExtVar
T_SCM: ExtVar T_SCM: ExtVar T_SCM: ExtVar
(1) If there are more than one action listed inside a cell, all of them are created.

3BDS011224R4101 283
Connection and Inversion Checks Section 3 Configuration

Connection and Inversion Checks

General
When two ports are connected to each other, or when one port is connected to an
existing network, variable or to a constant, plausibility checks are executed. The
same applies when a port is going to be inverted.
If the plausibility checks fail, the faulty connection or inversion is tolerated and
visualized by a red line or red circle, respectively. Corresponding warnings/errors
are written to the output window.

Checks for Connections


• For port-to-port, port-to-network, port-to-variable, and port-to-constant
connections the data types of the two objects have to be the same (exception:
there is no data type check if one of the related objects has got the data type
'any'). Certain combinations of unequal data types are accepted and lead to
implicit casts (see below).
• Input ports and inout ports must not be connected more than once.
• Output ports and inout ports must not be connected to direct constants or
variables with the flag 'constant'.
• Corresponding inout ports must not be connected to each other.
A connection between two InOut parameters is not allowed, but you can create
such a connection. You do not get a warning at engineering time, even the code
generation generates no error message.
More than one connection to InOut Port: Create Variable object and connect
Variable to InOutPort (right side); right side of Variable can be connected several
times to other symbols.

Checks for Inversions


• Output ports and inout ports cannot not be inverted.
• Only ports with data type 'boolean' (or 'generic' or 'any') can be inverted.

284 3BDS011224R4101
Section 3 Configuration Connection and Inversion Checks

Checking of constant literals


• Data Type REAL
A real constant is checked for the legal range
-3.402823466e+38 <= real <= 3.402823466e+38
• Data Type INT, DINT, UINT, WORD, DWORD
The constants are checked for legal range
-32768 <= int <= 32767
0 <= uint <= 65535 ( = word )
- 2,147,483,648 <= dint <= 2,147,483,647
0 <= dword <= 4294967295

Numbers to bases other than 10 are represented in base 2, 8 or 16


(prefix 2#, 8# or 16#),
• Data Type BOOL
Valid constants for BOOL are 0, 1, FALSE, TRUE ( case insensitive )
• Data Type TIME ( = duration )
Time literals are written in the form <n>d<n>h<n>m<n>s<n>ms where
d = days, h = hours, m = minutes, s = seconds, ms = milliseconds,
<n> = a positive integer.
An optional prefix T# or TIME# can be used.
• Data Type DATE_AND_TIME
This type is presented in ISO_Format (YYYY-MM-DD-hh:mi:ss.ttt)
Example: 2003-05-23-14:15:30.025.
The minimum date is 1979-12-31-00:00:00.000 .
An optional prefix DT# can be used.

Visualization
Faulty connections / inversions are indicated in red color. For faulty port-to-port
connections the link indicating the connection is drawn red. For faulty variable or
constant connections the connection string is drawn in red color. A red circle
indicates faulty inversions, see Figure 184.

3BDS011224R4101 285
Connection and Inversion Checks Section 3 Configuration

Invocation of the Checks


The connection checks are executed when a port is going to be connected / inverted.
If the checks fail a message box is popped up with an according error text. For
connections leading to implicit casts a warning is issued in interactive mode only.

Figure 183. Warning Implicit Casts

When opening a diagram the checks are performed for all connections / inversions
on the diagram. The error texts for failed checks are collected and displayed in the
output window. A possibility to navigate to the faulty connection by double-clicking
the error message in the output window is provided, see Figure 184.
Additionally, the checks run
• On Function Designer menu item File > Check. It provides the same
functionality as if the diagram is opened (see above). For diagrams with child
diagrams this function has an option to check the whole tree of diagrams.

286 3BDS011224R4101
Section 3 Configuration Connection and Inversion Checks

• Before allocating/generating configuration data for CBM. If the checks fail


with error, configuration data generation for CBM does NOT start.

Figure 184. Diagram with errors in connections and inversions

3BDS011224R4101 287
Implicit Casts Section 3 Configuration

Implicit Casts
Function Designer supports implicit casts of data types / connections. These
include:
• Insertion of upcast function in CBM (e.g. DINT_TO_REAL)
• Insertion of downcast function in CBM (e.g. REAL_TO_DINT) with warning
• Conversion of real constants to CBM format (2 -> 2.0)
• Selection of proper element of structured data type (e.g. Value of RealIO)

Figure 185. Example Function Diagram for Implicit Casts

Figure 186. Generated CBM code with Implicit Casts

288 3BDS011224R4101
Section 3 Configuration Implicit Casts

Casted Data Types


Table 35. Support Implicit Casts.

Table 25.

Destination
BOOL INT DINT UINT WORD DWORD REAL TIME STRING
BOOL + + + + + + - +
INT +w + +w +w +w + - +
DINT +w +w +w +w +w + + +
Source UINT +w +w + +w +w + - +
WORD +w + + + + - - +
DWORD +w +w + +w +w - - +
REAL +w +w +w +w - - + +
TIME - - + - - - + +
STRING +x +x +x +x +x +x +x +x

Legend :
Same data type (no action needed)
+ Conversion inserted
+w Conversion inserted, warning given (possible effects:
Truncation, change of sign)
+x String with wrong format sets the destination value to 0 / False
at runtime (see also CBM documentation)
- not supported

3BDS011224R4101 289
Implicit Casts Section 3 Configuration

The used conversion functions of CBM are named


<Source Data Type>_TO_<Destination Data Type>
e.g. INT_TO_REAL, TIME_TO_STRING.
There is only one cast function used (i.e. no cascading of implicit casts).
A conversion function (e.g. INT_TO_REAL) always belongs to the input that needs
a conversion, i.e. networks my need more than one conversion function. E.g. an
integer output gets connected to three real inputs will use three INT_TO_REAL
functions.
Ports with data type ANY (e.g. MOVE) are not checked.

Structured Data Types


If a simple data type (e.g. real) is connected to a structured one, the main element of
the structure is connected. (e.g. ’.Value’ of RealIO); see also table below.

Table 26. Used elements of structured data types

Type Name Usage Connected element


RealIO Connection to process IO RealIO.Value
BoolIO Connection to process IO BoolIO.Value
ControlConnection Two-way communication ControlConnection.
between control modules Forward.Value
HWStatus IO Diagnostics HWStatus.HwState
DwordIO Connection to process IO DwordIO.Value
DintIO Connection to process IO DintIO.Value

290 3BDS011224R4101
Section 3 Configuration Implicit Casts

Constant Connections, Literals


This sub chapter only describes additions that are done by the code generator for
CBM to produce valid and better readable code.
In contrast to that, Checking of constant literals describes connection checks
invoked while editing a diagram.
- Data Type REAL
- If the decimal separator is missing, '. 0' is added
(e.g. 4711 -> 4711.0)
- Data Type INT, DINT, UINT, WORD, DWORD
- Numbers to bases other than 10 are represented in base 2, 8 or 16
(prefix 2#, 8# or 16#)
- Data Type BOOL
- Valid constants for BOOL are 0, 1, FALSE, TRUE
- If written in lowercase, they are converted to upper case
- Data Type TIME
- If the prefix T# or TIME# is missing, it is added
(e.g. 39m1s -> T#39m1s)
- Data Type DATE_AND_TIME
- If the prefix DT# is missing, it is added
(e.g. 2003-12-31-21:35:07 -> DT#2003-12-31-21:35:07)

3BDS011224R4101 291
Connection Mapping Section 3 Configuration

Connection Mapping
Use the function Connection Mapping to connect ports of different structured
datatype. This function is implicitely invoked for connections that cannot be
automatically casted. You can also explicitly invoke the Connection Mapping
command from the context menu of a link or a variable component. In both cases,
you can select which substructures shall be interconnected. Necessary variables and
links get automatically created.
Suppose you want to connect a port of datatype ’TenRealIO’ to a port of datatype
’RealIO’, see. Figure 187. ’TenRealIO’ is a library-defined structured datatype and
consists of 10 record elements of type RealIO.
The connection checks display an error message indicating that there is no implicit
conversion possible. Now you can either
• insert a connection mapping. In that case, the Connection Mapping dialog
gets displayed where you define a mapping between individual sub-structures
or record elements of the source datatype and the sink datatype. On OK,
necessary variable(s) and links get automatically created. Use command
Show/Hide ports in order to connect the rest of the IO.
• ignore the error. This will result in an erroneous connection link drawn in red
color.
• cancel the connection.
In Figure 188, two variables and corresponding links get created to map the data
types ’TenRealIO’ (structured datatype with 10 record elements RealIO) and
’FiveRealIO’ (structured datatype with 5 record elements RealIO). The
automatically created variables are named <SourceComponent>_<SourcePort> and
<SinkComponent>_<SinkPort>.
In order to modify a connection mapping, select such a mapping variable and invoke
its Connection Mapping context menu.

292 3BDS011224R4101
Section 3 Configuration Connection Mapping

Figure 187. Connection Mapping TenRealIO to RealIO

3BDS011224R4101 293
Connection Mapping Section 3 Configuration

Figure 188. Connection Mapping TenRealIO to FiveRealIO

294 3BDS011224R4101
Section 3 Configuration Instance Specific Initial Values

Instance Specific Initial Values


Function Blocks and Control Modules provide the possibility to set instance specific
initial values for most of the unconnected ports. Then, independent of the object
type, the instance will get an instance specific initial value for that unconnected port,
if desired:

Figure 189. Aspect Properties of a PIDCC Control Module

Most of the ports of a function block or control module contain two aspect
properties regarding initial values. For example see Figure 189: Port ’PriorityCmd1’
has aspect properties
• PriorityCmd1.InitVal
• PriorityCmd1.InitValOfObjectType
If the PriorityCmd1.InitVal is set to ’true’ for example, then - after configuration
data generation - this value gets configured in the Control Properties aspect of that

3BDS011224R4101 295
Instance Specific Initial Values Section 3 Configuration

control module. During download into the controller this port gets an instance
specific initial value of value ’true’.

Figure 190. Control Properties after configuration data generation for the example
in Figure 189 above

Hints:
• For function blocks all unconnected ports can be configured, which provide an
’InitVal’ aspect property.
• For control modules, only unconnected ports which have an
’InitValOfObjectType’ of Value ’default’ can get an instance specific initial
value, because only these ports have a corresponding control property. If you
specify ’InitVal’ at other ports you will get a warning on configuration data
generation.
• Modifications of the ’InitVal’ property within the Control Properties aspect
directly are currently not reflected back to Function Designer.

296 3BDS011224R4101
Section 3 Configuration Consistency

Consistency

General
To address both authority/access control and consistency of Function Designer
generated configuration data, function diagrams follow a state model.
Consistency guaranties, that:
a. Code blocks that have been generated by Function Designer cannot be
modified in Control Builder (locking).
b. Any modifications of objects that are generated by Function Designer
(global variables, Object Names, …) which are not locked inside Control
Builder nor in Plant Explorer are correctly reflected in Function Designer.

In addition, diagram states answer the following questions:


a. Which diagrams are not yet been allocated to any application?
b. Which diagrams are actually loaded into the controller?
c. Which diagrams have been altered since loading them into the controller?

Diagram States and Transitions


The following figure shows the different states of a diagram that is based on a write-
able Function aspect in Functional Structure. Function Diagrams that are build in
Object Type Structure and Function Diagrams with an inherited Function aspect
follow different state models, which are described in Consistency for Diagrams
created from Control Module Types and in Consistency for Diagrams in Object
Type Structure.

Audit Trail
Specific Audit-Trail messages are written when the diagram state changes.

3BDS011224R4101 297
Consistency Section 3 Configuration

Figure 191. Diagram States


The diagram state is indicated in Function Designer’s status bar

Figure 192. Diagram Status

298 3BDS011224R4101
Section 3 Configuration Consistency

The status of all diagrams in a (sub) tree of a structure can also be checked using the
System Status Viewer.

Figure 193. System Status Viewer

3BDS011224R4101 299
Consistency Section 3 Configuration

Table 27. Diagram States

State Description
Unallocated The function has not been assigned to any application in the
Control Builder. Any Control Modules or Function Block that
are part of this function, are placed in the
’Unallocated_Inst_App’ folder of the Control Builder. The
Single Control Modules that will contain the code of this
function are either empty or do not yet exist. Modification of
the diagram will not cause a state change.
This is the initial state if a new function is created.
Modified Diagram has been altered (compared to what is in the Control
Builder).
There are two ways the user can get a ’Modified’ diagram:
• You can change data in the Function Designer, but
• Outdated MMS she/he does not generate new code for the Control
Cross Builder.
Communication Data • A change in Plant Explorer or in Control Builder has
updated the Function Diagram, but requires that the code
needs to be re-generated. Example: if a Function Block is
renamed, then the corresponding invocation in generated
code block needs to be updated as well.
Diagrams created by automatic MMS cross communication
can be outdated due to modified allocation or modified
diagram references/connections over application boundaries.
In that case, you need to rerun MMS cross communication
analysis and generation, see Outdated MMS Cross
Communication Data.

300 3BDS011224R4101
Section 3 Configuration Consistency

Table 27. Diagram States

State Description
Generated Configuration data for Control Builder was successfully
generated. The data in Control Builder corresponds to the data
in Function Designer.
Function Designer also invokes the IO Allocation tool for all
• IO not allocated IO signals on the diagram that are placed in Control Structure
under a Hardware Unit. By that, the IO signals are allocated
and the IO signal data in Control Builder corresponds to the
IO signal properties.
• Outdated MMS The diagram is now ready to be loaded into the controller.
Cross
Communication Data
Diagrams created by automatic MMS cross communication
can be outdated due to modified allocation or modified
diagram references/connections over application boundaries.
• IO not allocated, In that case, you need to rerun MMS cross communication
Outdated MMS analysis and generation, see Outdated MMS Cross
Cross Communication Data.
Communication Data

3BDS011224R4101 301
Consistency Section 3 Configuration

Table 27. Diagram States

State Description
Loaded The application that contains the Single Control Module of the
diagram is loaded into the Controller.
If a diagram is in this state, you can perform online operations
like display, force and tuning.
• IO not allocated

Diagrams created by automatic MMS cross communication


can be outdated due to modified allocation or modified
• Outdated MMS diagram references/connections over application boundaries.
Cross In that case, you need to rerun MMS cross communication
Communication Data analysis and generation, see Outdated MMS Cross
Communication Data.

• IO not allocated,
Outdated MMS
Cross
Communication Data

Unknown due to bad OPC The state cannot be determined, because no data is received
quality from OPC server.

302 3BDS011224R4101
Section 3 Configuration Consistency

Code Relevant Changes


Code relevant changes are modifications that affect the configuration data that
Function Designer generates. These changes are causing transitions between the
states.
You can make these kind of changes in:
• Function Designer (FD)
• Control Builder M (CBM)
• Plant Explorer (PE)
• Bulk Data Manager (BDM)
• or any other environment that modifies the Function Designer's Aspect
Objects).
Diagram State Modifications cannot be Undone. If you do code-relevant
modifications ’Generated’ or ’Loaded’ Function Designer displays a warning in
order to cancel the modification. If you ignore this warning, the diagram gets
’Modified’ state. ’Undo’ or ’File > Skip Modifications’ will restore the diagram
data, but not the diagram state. Regenerate configuration data and download the
diagram.
If you connect an Application object to a new version of a user defined library
containing data types with changed definition. The related function diagram with
instances (variables) of these data types should become ‘red’.The diagram state
remains ‘yellow’, however.
The following table lists the different code relevant changes and their consequence.

3BDS011224R4101 303
Consistency Section 3 Configuration

304 3BDS011224R4101
Section 3 Configuration Consistency

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
AO1§ You remove a Control Module or a PE F1: If the object ’MyPID’ has a parent object
Function Block that is a child of a in the Functional Structure, this object
Function Designer generated Single will undergo the same state change as the
Control Module from Control parent object in the Control Structure.
Structure. Any open Function Diagram is updated.
Note: if the object that has been removed
is a Control Module, this has no effect on
the code blocks or variable definitions of
the parent Single Control Module.
However, this is not treated in a different
way, because it is expected that the
parent object in the Control Structure is
also the parent object in the Functional
Structure in most cases.
AO2 You insert a Control Module or a PE F1: The parent propagates its own state
Function Block as a child of a Function change to all its child objects in the
Designer generated Single Control Control Structure.If the newly inserted
Module in the Control Structure. object is not placed the Functional
Structure, the parent object in the
Control Structure will also become the
parent object in the Functional
Structure.
Any open Function Diagram is updated.
Note: if the Function aspect is inherited,
the object cannot be in state ’Modified’.
If the object ’NewObj’ has a parent
object in the Functional Structure, this
object will undergo the same state
change as the parent object in the
Control Structure, but the state change
is not propagated to the child objects in
the Functional Structure.

3BDS011224R4101 305
Consistency Section 3 Configuration

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
AO3 You insert an object with a Function PE F1: The code generator automatically starts
aspect as a child of a Function Designer for object ’NewObj’ during the insertion
generated Single Control Module in the of the object into the Control Structure.
Control Structure. Note: ’NewObj’ is a If the code generator runs without error,
nested diagram. ’NewObj’ ends in state ’Generated’.
Any open Function Diagram is updated.

NewObj
:

AO4 You insert a Control Module or a PE F1: Any open Function Diagram is updated.
Function Block as a child of a Function FD
in the Functional Structure.

306 3BDS011224R4101
Section 3 Configuration Consistency

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
AO5 You move a Function Designer PE F1: Any open Function Diagram is updated.
generated Control Module or a Function Like in
Block to a new location in the Control AO1
Structure.
F2:
Like in
AO3

AO6 You remove a Function Block or a PE F1: Any open Function Diagram is updated.
Control Module from a Function in the FD
Functional Structure

AO7 You rename a Function Designer PE F1: The object (F1_2) detects the
generated Function Block or Control FD modification and notifies its parent in
Module Control Structure and the parent in
Functional Structure.
Any open Function Diagram is updated.

3BDS011224R4101 307
Consistency Section 3 Configuration

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
AO8 Copy & Paste in Functional Structure FD See AO4 for the receiving parent
PE diagram.
The source object or its parent is not
affected.
AO9 Copy & Paste in Control Structure PE See AO2 for the receiving diagram.
AO10 Cut & Paste in Control Structure PE See AO1 for the source object.
See AO2 for the sink.
AO11 Cut & Paste in Functional Structure FD See AO6 for the source.
PE See AO4 for the sink.
AO12 You insert a new Control Module or PE None This action is rejected by CBM.
Function Block as a child to an existing It is not possible to add a new child
Control Module in Control Structure object to an instance of a Control
Module type. This would be a type
change.

AO13 You insert a new Control Module or PE F3: The Function Diagram of ’F3’ is updated
Function Block as a child to an existing with the new object.
Control Module in the Functional Any open Function Diagram is updated.
Structure

AO14 You change the type of an object. The effected parent object in Functional
(Supported only for symbol objects). FD Structure (diagram or allocatable group)
change their state to ’Modified’.

308 3BDS011224R4101
Section 3 Configuration Consistency

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
AO15 You override an inherited Function PE F1:
aspect

CS1 You change the connect string of a PE F1: The object F1_2 detects the modification
Function Designer generated Control FD and notifies its parent in Control
Module. Structure and the parent in Functional
Structure.
If a diagram that shows the connection is
open, the diagram gets updated.
If you modify a connect string in
Function Designer, the changes are
written to the Control Properties of the
effected Control Module immediately.

3BDS011224R4101 309
Consistency Section 3 Configuration

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
CS2 You modify the initial value of an PE F1_1: If the modification in done using the
internal variable of a Function Designer FD Control Properties aspect, the change is
generated Single Control Module reflected in Diagram.

CS3 You modify the initial value of an PE The containing Single Control Module
internal variable of a Control Module (parent in the Control Structure) changes
that is part of a Function Diagram. its state to ’modified’. If such a Single
Control Module does not exist, the
containing application changes its state
to ’modified’.

310 3BDS011224R4101
Section 3 Configuration Consistency

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
SO1 You add an IEC 61131-3 function (a FD F1_1: The state of the diagram that contains the
none Aspect Object one) to a Function new IEC 61131-3 function is changed to
Diagram. ’modified’.

3BDS011224R4101 311
Consistency Section 3 Configuration

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
SO2 You remove a Function (a none Aspect FD F1: The state of the diagram that contains the
Object one) from a Function Diagram new IEC 61131-3 function is changed to
’modified’.

312 3BDS011224R4101
Section 3 Configuration Consistency

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
GV1 You delete a global variable that has CB F1_2, All Functions reading or writing the
been generated by the Function M F2: effected global variable are set to the
Designer. FD state ’Modified’.
PE

GV2 CB F5: The global variable ’VarOlle’ is


M generated by Function Designer to
connect the two Control Modules. The
two Control Modules are defined in two
FD
different allocatable groups.
If the modification is done in the Control
Builder, the change is not reflected in the
diagram. The variable is re-created the
next time we generate configuration
data.

3BDS011224R4101 313
Consistency Section 3 Configuration

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
GV3 You rename a global variable that has CB See GV1
been generated by the Function M
Designer.
FD
GV4 You change the initial value of a global CB All Functions using the effected global
variable. M variable are set to the state ’Modified’.
For any open Function Diagram the
FD display is updated.

PE
GV5 You change the attributes of a global CB Changes done in CBM are synchronized
variable. M to attributes stored in diagram variables
and diagram references. The state of
effected diagrams is not changed.
FD
Changes done directly in diagram
variables or diagram references set all
effected diagrams to state ’Modified’.
GV7 You add a diagram reference FD F5: Any open Function Diagram is updated.
PE

314 3BDS011224R4101
Section 3 Configuration Consistency

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
GV8 You connect a diagram variable to a FD F5: Any open Function Diagram is updated.
diagram reference. PE

IO1 You add a new IO signal as a child of an PE F5: Any open Function Diagram is updated.
object with a Function in the Functional FD
Structure.

IO2 You remove an IO signal from a PE F5: Any open Function Diagram is updated.
Function. FD

IO3 You rename an IO signal PE See AO7


FD

IO4 You change the allocation of an IO PE Any open Function Diagram is updated.
signal.

3BDS011224R4101 315
Consistency Section 3 Configuration

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
IO5 You move an unallocated IO signal to a PE F5: The IO signal object detects the structure
Hardware Unit. change. It notifies all its parent objects in
the Functional Structure.
You can now re-generate the
configuration data. This will result in the
correct assignment of the (global)
variable to the IO channels.

IO6 You remove an allocated IO signal from PE F5:


its Hardware Unit.

316 3BDS011224R4101
Section 3 Configuration Consistency

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
IO7 You move an IO signal from one PE F5: Any ’Loaded’ diagram that contains the
Hardware Unit to another one. signal is changed to the state ’Generated’
to indicate to the user that the diagram
data does not correspond to the running
application anymore.

3BDS011224R4101 317
Consistency Section 3 Configuration

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
IO8 You change one of the parameters of an PE None The diagram state is not modified on
IO signal signal parameter changes. No new
Function Designer configuration data
generation is necessary. However, in
order to update the signal parameter
values in Control Builder, you should
use the IO Allocation function Write
Allocation to CBM of Engineering
Workplace.

Be aware that change of signal name


(case IO3) does change the state, AO7
applies.

PA1 You add a diagram parameter FD F1_1: The Single Control Module that
PE represents the diagram changes its state
to ’Modified’. The containing diagram is
not affected.
Any open Function Diagram is updated.

318 3BDS011224R4101
Section 3 Configuration Consistency

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
PA2 You remove a diagram parameter FD F1_1: The Single Control Module that
PE represents the diagram changes its state
to ’Modified’.
The containing diagram also changes its
state to ’Modified’, because any
F1: connection to the removed parameter is
also deleted.
Any open Function Diagram is updated.

PA3 You rename a diagram parameter FD F1_1: The affected Single Control module
PE changes the state to ’Modified’.
The parent diagram (Functional
Structure) also changes its state to
’Modified’.
F1: Any open Function Diagram is updated.

AL1 You select ’Unallocate’ FD F1, The effected diagram and all its children
PE F1_1: in the Control Structure are changing
their state to ’Unallocated’.

AL2 You select ’Allocate’ FD The effected diagram and all unallocated
PE children in the Functional Structure are
allocated.
Their state is change to ’Modified’ or
’Generated’.
AL3 You allocate an IO signal using the IO See IO5
allocation tool.

3BDS011224R4101 319
Consistency Section 3 Configuration

Table 28. Modifications of Function Designer Generated Code

Case Sou State


Modification Description
Id rce Change
CB1 You try to alter the code block of a CB None The Function Designer has ’locked’ the
Function Designer generated Single M Single Control Module. CBM will reject
Control Module in the CBM. any modifications.
CB2 You add a new variable or a new CB None The Function Designer has ’locked’ the
Function Block to a Single Control M Single Control Module. CBM will reject
Module using the variable pane of the any modifications.
Control Builder.
FD1 You alter the data flow order FD The state of the diagram that contains the
elements changed to ’modified’.

320 3BDS011224R4101
Section 3 Configuration Consistency

Consistency for Diagrams created from Control Module Types


Instances of Control Modules are based on a Control Module type. You cannot
modify any content of the Control Module. Any changes of
• connections of the Control Module
• initial values of the Control Module
are regarded as being changes to the container of the Control Module. The following
objects can act as containers for Control Modules:
• Control Modules
• Single Control Modules
• Applications
For Control Modules, Function Designer does not generate any code. It just writes
the connections of the Control Module. So, there is no state ’Generated’.

Figure 194. State Model for Diagrams created from Diagram Types

3BDS011224R4101 321
Consistency Section 3 Configuration

Consistency for Diagrams in Object Type Structure


Function Diagrams that are created in Object Type structure to build Control
Module types follow a different state model. They are never ’Allocated’ (moved into
Control Structure) nor ’Loaded’.
Figure 195 shows the reduced state diagram for this type of Function Diagrams:

Figure 195. State Model for Diagram Types

Diagram Status Display


A diagram makes it status (Modified, Allocated...) available to the system via a
number of properties. This properties are read (for example) by the System Status
Viewer. The following table describes these properties.

Table 29. System Status Properties

Name Description
S_STATUS The status of the diagram as
integer value.
S_DESCRIPTION A textual description of the
diagram status.

322 3BDS011224R4101
Section 3 Configuration Consistency

Table 29. System Status Properties

Name Description
S_TIME Time stamp of the diagram.
S_FUD_STATUS Same as S_STATUS
S_FUD_DESCRIPTION Same as S_DESCRIPTION
S_FUD_TIME Same as S_TIME

For complex objects, the status of the Function Diagram may only represent a
fraction of object’s status. To get a combined status information, do the following:
1. Tell the Function Diagram, that it’s status is not the only status information for
this object. This is done in the “Allocatable Group” aspect:

Figure 196. Allocatable Group

This prevents the Function Designer from publishing the status properties
’S_STATUS’, ’S_DESCRIPTION’ and ’S_TIME’.

3BDS011224R4101 323
Consistency Section 3 Configuration

2. Setup an aspect of the category “Property Translation Extended”.

Figure 197. Property Translations

Cross References
Function Designer creates global variables in Control Builder to implement the data
exchange between diagrams. Function Designer informs the user about the usage of
these variables in form of a cross-reference list that is attached to the variable as
shown in the Figure 198.

Figure 198. Graphical Representation of Cross References

324 3BDS011224R4101
Section 3 Configuration Consistency

The global variables that the Function Designer creates in Control Builder can also
be used by parts of the application that are not generated by Function Designer.
Table 30 shows, how Function Designer shows the different usages of the variables
that are created by the Function Designer.

Table 30. Cross References

Variable Usage Display Description


Usage in a different Reference string in Functional This reference is
diagram Structure. always displayed.

IO Connection Reference string in Control Structure The reference is


plus IO channel name. displayed in diagram
states Allocated,
Modified, or Loaded.

Usage in a Control Reference string in Control Structure. The reference is


Module displayed in diagram
states Allocated,
Modified, or Loaded.

Usage in a Program Reference string in Control Structure. The reference is


displayed in diagram
states Allocated,
Modified, or Loaded.

Cross-references to other Function diagrams are updated when the reference gets
modified. Cross-references to I/O, into control modules or into programs are
updated when the Function diagram gets opened.

3BDS011224R4101 325
Consistency Section 3 Configuration

You can navigate to any cross-reference by the context menu command Goto
Reference. In case of cross-references to I/O, into control modules, or into programs
you can navigate directly into various Control Builder editors:

Figure 199. Goto Reference inside Control Builder

326 3BDS011224R4101
Section 3 Configuration On-line Display

On-line Display

General
Online display of values is possible for a diagram or a portion of a diagram that is in
state ’Loaded’.
Display of online values is also enabled for modified diagrams if they had been
generated at least once (i.e. allocatable group has a FDVersion property). A warning
is given that the modified diagram does not match the one running in the controller,
similar to the case that a regenerated diagram is not yet loaded.
On-line values cannot be modified directly in Function Diagram. Use Watch
Window instead, see Watch Window on page 336.

Display Style
Function Designer follows the 800xA system standard faceplate's style regarding
the use of colors and other graphical elements for value display. However, because
the faceplate do not have to distinguish between live data and configuration data,
Function Designer uses an additional graphical element to indicate that a value is a
’live’ value.

3BDS011224R4101 327
On-line Display Section 3 Configuration

Table 31. Display Style of On-line Values

Description Display Style


A configuration value (initial value).

Live values are indicated by a red frame


around the value.

328 3BDS011224R4101
Section 3 Configuration On-line Display

Table 31. Display Style of On-line Values

Description Display Style


If a property indicates a bad quality (from
the OPC server), the value is displayed in
red color with the strikeout font.

A forced value is indicated using a gray


background color.

3BDS011224R4101 329
On-line Display Section 3 Configuration

You can select to display the actual process value for a port, a connection link, or for
all ports of a component. On-line values are received from the OPC server. The
values are available for the following ports, connections, and components:

Table 32.

Item Description Example


Diagram Reference Diagram references are
implemented as global
variables. The symbol for the
diagram reference contains a
field to display the process
value.
Diagram Parameter Diagram parameter are
implemented as input- or
output variable of a (single)
control module. The symbol
for the diagram parameter
contains a field to display the
process value.
Port of Control All terminals of all Control
Module Modules are OPC readable.
Port of Function Block

Port of Nested All input and output ports of a


Function Diagram nested function are readable.

330 3BDS011224R4101
Section 3 Configuration On-line Display

Table 32.

Item Description Example


Port of Function Ports of Functions are not accessible through OPC.
• If the port of the Function is connected to an OPC readable variable, the
value of the variable is displayed.
• If the port is connected to a ’__link’ type variable, display of on-line
values depends on how configuration data was generated. In case of
’Online Optimized’ code, all ’__link’ variables are automatically
converted to ’internal_link’ variables that are OPC readable. Otherwise,
internal links between functions are not OPC readable. This is indicated
by a ’*’ or a ’?’.
IO Signal For an IO signal, Function
Designer generates a global
variable of the following type:
RealIO
BoolIO
Function Designer displays
the “Value” part of the
variable and the “Unit” string
(RealIO only). If the value is
forced, it is displayed in bold
with grey background color.
Networks Networks correspond to
variables. The variables are
OPC readable if:
a) You defined an explicit
network name.
b) You selected to generate
“Online Optimized” code.

Table 33. Display of On-line Values

3BDS011224R4101 331
On-line Display Section 3 Configuration

Function Designer is aware of some frequently used data type. Table 35 describes
these data types, and how the Function Designer displays them in on-line display.
Other structured data types with a ’Value’ record element display that value. Other
structured data types without ’Value’ are not displayable in the diagram directly.
This is indicated by a “?” or “*” display. However, their on-line values can be
displayed in the Watch Window.

Table 34.

Type Name Usage Online Display


RealIO Connection to process IO. RealIO.SignalPar.Unit. Example:
3.14 m/s
BoolIO Connection to process IO. BoolIO.Value
ControlConnection Two-way communication ControlConnection.Forward.Value
between control modules. ControlConnection.Forward.Range.Unit
Example: 100 %
SignalPar SignalPar.Min SignalPar.Unit <= X <= SignalPar.Max
SignalPar.Unit
Example: 10 m/s <= X <= 12.5 m/s
Range Value range. Range.Min Range.Unit<=X<= Range.Max Range.Unit
Example: 10 m/s <= X <= 12.5 m/s
HWStatus IO Diagnostics HWStatus.HwState
Example: 0xADD45000
DwordIO Connection to process IO DwordIO.Value
DintIO Connection to process IO DintIO.Value
Any other AnyType.Value
structured datatype
with a .Value
record element.

Table 35. Display of On-line Values for Some Common Data types

332 3BDS011224R4101
Section 3 Configuration On-line Display

User Interface
All online commands are available from the Online menu:
Online > Add to Display List
This command adds the selected object to the list of objects where you want to see
online value. Following objects are supported:
• a single port
• a multi-selection of ports
• a component symbol (all ports will be added)
• a network link
• an IO signal
It is also possible to add a combination of these objects. The command is using the
current selection in the diagram as source. The command is also available in the
context menu for the objects listed above.
• Online > Remove from Display List
This command reverses the action of the command Online > Add to Display
List.
• Online > Add all Links to Display List
This command adds all connection links on the current page to the display list.
• Online > Remove all Links from Display List
This command reverses the action of the command Online > Add all Links to
Display List.
• Online > Update OPC Properties
This command explicitly updates outdated OPC properties of function block /
control module symbol objects for diagrams in state ’generated’ or ’loaded’.
• Online > Subscribe for Live Data
This command starts/stops on-line display of life data. The recent OPC
timestamp and quality is displayed in Function Designer’s status bar, see
Figure 200.

3BDS011224R4101 333
On-line Display Section 3 Configuration

• Online > Show Last Value(s)Online > Show Last Value(s)


This command show/hides recent on-line values retrieved from the OPC server
if subscription for live data has stopped.
• Online > Watch Window
The command displays the watch window. The window shows a grid where
you can add the (OPC) name of variables you are interested in. See Watch
Window.

Figure 200. Diagram in loaded state displaying on-line values

334 3BDS011224R4101
Section 3 Configuration Watch Window

Watch Window
This section describes, how to use the Watch window of Function Designer. The
purpose of the Watch window is to display a user defined collection of on-line
values. This function is typically used during the commissioning phase of a
function.
To display the watch window, use command Online > Watch Window. Like the
structure browser and the output window, the Watch window can be
• docked inside Function Designer, Diagram View
• undocked as popup-window.

Figure 201. Watch window

The watch-window displays online values from:

3BDS011224R4101 335
Watch Window Section 3 Configuration

• The current function diagram that you are viewing


• Any other diagram
• Any other aspect, not belonging to a function diagram (a Control Builder
Application for example).

A variable is displayed in the following way:


[<Object Name>]::<Variable Name> (<Data Type>| "struct") = <Current Value>
[Status]
Example:
New_FD2::Nisse.Forward.Value(VT_R4) = 0
… is to be interpreted as:
Object Name = "New_FD2".
Variable Name = "Nisse.Forward.Value"
Data Type = "VT_R4" (real value, 4 byte)
Current Value = "0".

The object name is omitted for variables that belong to the current diagram you are
viewing. The OPC status is omitted if the data quality is good.
If a variable is of a structured data type, the watch window displays struct as data
type. You can click on such a structured variable to expand it and to view the
individual elements it consists of.
To active the value update, use command Online > Subscribe for Live Data.
Function Designer saves the content of the watch window. When opening the same
Function Diagram next time, the watch window will show the same configuration. If
any of the variables in the watch window does not exist anymore in you diagram, it
will be marked as invalid.

336 3BDS011224R4101
Section 3 Configuration Watch Window

Adding Variables
To add a new variable to the watch window, click the Add… button. Function
Designer displays the following dialog:

Figure 202. Add watch variable

Select one or more variables from the list in the right part of the window and click
Apply to add the selected variable to the watch window.
You can also type the name of a variable in the edit field.
To display a variable of a structured data type, type the name of the variable up to
the first dot into the edit field and press Apply. Example “CBM_Test”.
The Watch Table settings are not stored for a specific user but they are shared for
all users of this diagram.

3BDS011224R4101 337
Watch Window Section 3 Configuration

Sending Variable Values


You can also use the watch window to modify the value of a selected variable.

Figure 203. Send variable values

Select the variable you want to change in the watch window. Type the new value in
the edit field and press Send Change. This will write the value once.

338 3BDS011224R4101
Section 3 Configuration MMS Cross Communication

MMS Cross Communication


This section describes automatic generation of cross communication: If you want to
establish communication between different applications of an AC 800M controller,
than more than just a global variable is required: The most common way within
AC 800M is to use MMS cross communication. Access variables need to be created
and configured both on the sender side and on the receiver side with some logic
from the MMSCommLib library.
Function Designer supports this MMS Cross Communication by an automatic
creation of all required access variables and logic for sender and receiver diagrams
on request.
Automatic means that function designer will create all additional diagrams, data
types, variables, etc. in order to establish cross communication. It does not mean it
will be done completely automatic. The user has to start this generation explicitly, if
this support is desired.

MMS Communication Overview


Suppose there exist two diagrams which are connected by two diagram references
Variable1 and Variable2: SenderDiagram1 and ReceiverDiagram1..

Figure 204. SenderDiagram1

3BDS011224R4101 339
MMS Cross Communication Section 3 Configuration

Figure 205. ReceiverDiagram1

If these diagrams are allocated in different applications, there will exist a hint on the
receiver side that MMS Communication is required.

Figure 206. Allocation of sender and receiver diagram in different applications

340 3BDS011224R4101
Section 3 Configuration MMS Cross Communication

An additional field in blue is added to the diagram reference symbol and its
CrossCommunication aspect property is set to ’MMS’:

Figure 207. ReceiverDiagram1 with MMS diagram references and Valid port

In order to establish MMS communication some additional configuration is


required, see Control Builder manuals 3BSE035979Addendum.pdf and
3BSE035982ComMan.pdf:
• An access variable has to be created.
• Variables Variable1 and Variable2 need to be connected to this access variable
on the sender side.
• Variables Variable1 and Variable2 need to be read on the receiver side by the
function blocks ’MMSConnect and ’MMSReadCyc from the ’MMSCommLib
library.
On request, Function Designer can automatically create the required additional
access variables and function blocks by creating some additional diagrams, one
diagram for the sender of a cross communication and diagram(s) for the receivers of
this sender (one diagram for each application where receivers occur).
If you choose to do so, you can also take advantage of the boolean Valid port
displayed at the MMS diagram reference: Here you will get a validation flag
indicating that the corresponding MMSReadCyc function block was able to read the
required signal from the sender side. You can connect the Valid port to some glue
logic if you want to evaluate this condition within your loop.

3BDS011224R4101 341
MMS Cross Communication Section 3 Configuration

If you do not want to get automatic MMS cross communication for the variables
Variable1 and Variable2, you can set the CrossCommunication aspect property of
these diagram references to ’manual’. Then you have to care yourself for cross
communication.
How to start the automatic generation of MMS cross communication and what can
be influenced? This is explained in the following chapters:

Prerequisites
It makes sense to start generation of MMS cross communication at the very end of
your engineering phase of your project: All diagrams need to be allocated to
applications. Generation of configuration data need to be finished for all diagrams.
Applications need to be connected to controllers and to tasks. Reasons:
• The function block MMSReadCyc reads a variable from a sender; therefore the
IP address of the controller of the sender side has to be known.
• The function block MMSReadCyc has a cycle time for reading the variable. A
default for that cycle time is calculated according to the scheme:
– Take the interval time of the task of the sender diagram and take the
interval time of the task of the receiver diagram. Variables shall be read as
double as fast as the slowest interval time.

342 3BDS011224R4101
Section 3 Configuration MMS Cross Communication

– That default can be modified by The MMS Editor

Figure 208. Prerequisites for automatic cross communication done:


Applications connected to controllers and tasks; IP addresses configured.

Boundary condition: The length of a MMS cross communication message is limited


to 1024 bytes (see 3BSE035982ComMan.pdf manual). This message size is defined
by a ’MMSReadCyc function block. The length of this message is calculated by the
data types of the access variables of all input terminals of this MMSReadCyc block.
Function designer’s MMS CrossCommunication generator is considering this
message size: In a sender diagram, global variables are collected into one access
variable as long as the message size is not reached. If the message size is reached
(regarding some overhead message load), a new access variable is created and
following variables are collected into this new one. So one access variable,
composed of a lot of global variables, is limited by the maximum message size.

3BDS011224R4101 343
MMS Cross Communication Section 3 Configuration

Therefore only MMSReadCyc[1] function blocks with only one input parameter are
used.

How to start Generation of MMS Cross Communication


The MMS CrossCommunication Generator is started by an object verb on
• CB Project,
• Control Network or
• Control Structure Root level.

344 3BDS011224R4101
Section 3 Configuration MMS Cross Communication

In case you configure cross communication across several CBM projects or


networks, use the verb on Control Network or Root level. If you configure cross
communication within a single CB project, use the verb on project level.

Figure 209. Starting CrossCommunication by Object Verb

Run automatic cross communication by the context menu Advanced >


CrossCommunication.
Note: Advanced menu is available in Engineering Workplace, but not in Plant
Explorer Workplace.

3BDS011224R4101 345
MMS Cross Communication Section 3 Configuration

After starting cross communication by this object verb a generic object named
’CrossCommunication_<startingObjectName>’ gets created. It is placed
• inside Functional Structure on Root level
• inside Control Structure below the object where the object verb was started.
A CrossCommunication aspect is added.

Figure 210. New object with CrossCommunication aspect

346 3BDS011224R4101
Section 3 Configuration MMS Cross Communication

Workflow of automatic MMS Cross Communication Generation


The CrossCommunication aspect offers a main view and an editor where you can
start and influence the generation of MMS cross communication:

Figure 211. Main view of aspect ’CrossCommunication’

The automatic generation of MMS communication is based on the following


workflow:
• Analysis: first press Analyze button
– All diagrams below the object containing this CrossCommunication
aspect (e.g. of the whole CBM project or even of a whole system) are
examined for cross communication
– All global variables of diagram references found on diagrams belonging to
different applications are collected into access variables on the sender side
– They are read from these access variables on receiver side with an interval
time, calculated as mentioned above.
The analysis result is presented in different views for sender side, receiver side
or variables. See MMS Analysis.

3BDS011224R4101 347
MMS Cross Communication Section 3 Configuration

• Modifications: After analysis, optionally some modifications can be done


within the MMS editor:
– Rename access variables
– Move variables to other Access Variable.
– Change calculated cycle time.
– Etc.
See The MMS Editor.
• Creation of additional diagrams: After analysis and optional modification
has finished, additional diagrams for sender and receiver side of cross
communication are created by pressing the Create MMS button:
– All variables are collected into one ore more access variables of a new
structured datatype.
– This datatype gets created within the required applications.
See Create MMS.

MMS Analysis
The analysis phase is started by the ’Analyze’ button. All diagrams are searched for
necessary (non-manual) cross communication. The result gets presented in the
MMS editor. In case there are diagrams in state ’modified, red’ which need cross
communication, an error log is displayed.

Figure 212. Errors during analysis phase

348 3BDS011224R4101
Section 3 Configuration MMS Cross Communication

Only diagram references with CrossCommunication aspect property set to ’None’


or to ’MMS’ are regarded. Unallocated diagrams assigned to
’Unallocated_Inst_App’ application are not regarded at all.
If the analysis was done without errors you can check the data and create MMS
configuration data.

The MMS Editor


The “CrossCommunication aspect displays the MMS Editor in its main view. The
result of the analysis is presented by a tree view in three different views:
• Senders (Sender view, default)
• Receivers (Receiver view)
• Variables (Variable view).

Figure 213. MMS Editor displaying Sender View

The default sender view lists the applications which contain diagrams with output
diagram references (as senders of cross communication). An additional sender
diagram gets created and named as displayed in parenthesis:

3BDS011224R4101 349
MMS Cross Communication Section 3 Configuration

• Below this new sender diagram the created access variables are displayed
together with the collected global variables. The current message size of this
access variable that is based on the data types of the global variables gets
displayed, too. Later during creation of MMS diagrams the required data types
of these Access Variable are created inside the required applications as
application defined data types.
• Furthermore the MMS receiver applications belonging to a MMS sender are
listed. These are the applications which contain diagrams with input diagram
references (as receivers of cross communication data). An additional receiver
diagram gets created and named as displayed in parenthesis. Its children are the
global variables read by this receiver diagram and corresponding access
variable. The global variables read are sorted by the calculated default cycle
time (calculation depends on connected tasks of original sender and receiver
diagram, default can be changed, see below.
• Currently Function Designer does not support automatic MMS communication
for global variables of data type ControlConnection, or of structured data types
which have a substructure of type ControlConnection. Such variables are listed
below a folder called Unsupported Variables.
The other views for receivers and variables are displayed in a similar way, starting
with receiver diagrams or variables respectively.
It is recommended to work with the default sender view.

350 3BDS011224R4101
Section 3 Configuration MMS Cross Communication

Tool tips get displayed for applications or global variables:

Figure 214. Tool tip for a global variable

Inside the MMS editor the following modifications are supported:


• Rename
– MMS sender diagram(s)
– MMS receiver diagram(s)
– Access variable(s).
Press the F2 key or left click in the name field or right click on parent tree node.
• Change cycle time. Press the F2 key or left click on the Cycle Time tree node
field.

3BDS011224R4101 351
MMS Cross Communication Section 3 Configuration

• Add new access variable nodes by right mouse click on parent tree node.

Figure 215. Adding new access variable in MMS Editor

• Add new cycle time nodes by right mouse click on parent tree node.

352 3BDS011224R4101
Section 3 Configuration MMS Cross Communication

• Move variables between access variables or between cycle times. The new
message sizes are shown at the changed access variables.

Figure 216. Moving a variable from one access variable to another one

• Delete empty access variables or empty cycle times. Right click on tree node.
• Print the tree: The tree gets printed by pressing ’CRTL+F5’ keys.
• Expand the tree by selecting a node and pressing the ’CRTL+ right arrow’
keys.
• Copy the tree into the clipboard (as *.emf format): Press ’CRTL+F6’ keys.
(Advantage of the *.emf format: Text inside the picture can be edited.)
Save the modifications by pressing the Apply button.
Recommendation: Only an experienced user should do any modifications at all!

Create MMS
Creation of additional diagrams required for MMS communication and data types is
started by pressing the Create MMS button. Prerequisite: Analysis was done

3BDS011224R4101 353
MMS Cross Communication Section 3 Configuration

successfully. All required MMS sender and receiver diagrams are generated
including necessary data types of access variables and validation flags:

Figure 217. Control Structure and Functional Structure after MMS creation

The additional created diagrams are placed below the object which contains the
CrossCommunication aspect in the Functional Structure and below the
corresponding applications in Control Structure. The names of the created diagrams
are related to the names configured in the MMS editor after analysis and optional
modifications. For each access variable an application defined datatype is created

354 3BDS011224R4101
Section 3 Configuration MMS Cross Communication

with substructures composed of the data types of the global variables collected into
that access variable:

Figure 218. Created data type for new access variable

An access variable is read by a MMSReadCyc function block. This function block


contains a boolean Valid parameter indicating the result of the reading of that
variable (the same port exist at the MMSConnect function block).
These both boolean values are combined and sent to the Valid port of the input
diagram reference of the original receiver diagram. In order to do that, a structured
variable is created that collects all these valid flags in order to get only one global
variable per each receiver diagram. Thus this new variable of structured data type
collects all single boolean valid parameters of all MMSConnect and MMSReadCyc
function blocks (one per receiver diagram).

3BDS011224R4101 355
MMS Cross Communication Section 3 Configuration

This new datatype is also created within the required application:

Figure 219. New Structured Data Type Containing Valid Flags

In the example of ReceiverDiagram1 there exist only one MMSReadCyc function


block and one valid parameter which is collected into a structured data type and sent
to the two input diagram references Valid ports.

356 3BDS011224R4101
Section 3 Configuration MMS Cross Communication

Alarm and Events: Additionally the valid flags of the MMSConnect and
MMSReadCyc function blocks are send to an AlarmCond function block in order to
get communication errors in the Alarm and Event List.

Figure 220. Page 2 of a Generated Receiver Diagram Containing an AlarmCond

After the MMS creation the diagram reference symbol(s) on the original receiver
diagram ReceiverDiagram1 show the current cycle time, see Figure 221.
It is possible to interrupt the current creation process by pressing the Cancel button.
Then the current transaction is finished and MMS creation is stopped. Diagrams
already created are valid, but not all required ones are maybe available. Therefore a
complete rerun is required afterwards in order to have a complete MMS
communication generation.

3BDS011224R4101 357
MMS Cross Communication Section 3 Configuration

Download and go Online


After downloading the project data into the controller(s) you can check the Valid
ports at the MMS diagram references. Subscribe for live data and select the Valid
ports for display, see chapter On-line Display.

Figure 221. Diagram Reference shows 375 ms cycle time for MMS

358 3BDS011224R4101
Section 3 Configuration MMS Cross Communication

Within CBM you can check the access variables: Right click on a controller and
choose remote systems: Button Show MMS Variables displays all MMS access
variables within the selected controller:

Figure 222. MMS access variables of Controller_2

By adding an Alarm and Event List aspect to your Project and setting the filter to
the proper events you can also verify correct behavior of MMS communication. In

3BDS011224R4101 359
MMS Cross Communication Section 3 Configuration

case of communication failures alarms indicating the corresponding receiver and


sender gets generated.

Figure 223. Alarm and Event list in case of MMS communication failures

Aspect Verbs of CrossCommunication Aspect


The CrossCommunication aspect supports additional aspect verbs:

Figure 224. Aspect Verbs of CrossCommunication aspect

• Clear Generated Data: All diagrams, global variables and application defined
data types, created by the MMS Cross Communication generator, will be
cleaned. This will also be done automatically if you restart the generator for a
second run.

360 3BDS011224R4101
Section 3 Configuration MMS Cross Communication

• Generate Configuration Data: If you started creation by the Create MMS


button without checking Generate Configuration Data then the latter can be
started by this aspect verb for all generated MMS diagrams (This step is
necessary in order to transfer all configuration data into CBM for download).
• Show Log File: During the analysis or during the MMS creation step, you can
see what is actually going on inside the error logger list box. When the run is
finished, this list box shows the errors, but the content of this box is not saved.
If you want to see the errors again, you can open the XML log file for the
whole process and search for errors.

Current Limitations of automatic Cross Communication Generation


• Generation of MMS Cross Communication is supported only for diagram
references between diagrams. Connections between different allocatable
groups allocated to different applications on one diagram are not supported.
• Only MMS Communication is supported, other protocols have to be configured
manually.
• Only function blocks MMSDefAccVar, MMSConnect and MMSReadCycfrom
the MMSCommLib are actually supported.
• Automatic cross communication for variables of datatype ControlConnection
or structured data types which contain a ControlConnection are not supported.
They get listed below a folder called unsupported data types and have to be
configured manually.

Outdated MMS Cross Communication Data


• If you have finished MMS cross communication generation, and change
afterwards the original sender or receiver diagram with a MMS relevant
change, for example delete a diagram reference, then the generated MMS
diagrams are marked outdated, which can be seen within the system status

3BDS011224R4101 361
MMS Cross Communication Section 3 Configuration

viewer (for example added on CBM project level). The outdated diagram state
is also indicated in the diagram’s status bar, see Instance Specific Initial Values.
Remember: If you change some MMS relevant data within the hardware tree
after finishing the generation of MMS cross communication, for example,
connect application to another controller, change an interval time, change
connected tasks or IP addresses, then don’t forget to start the MMS Cross
Communication again! The system will not inform you that a rerun is required,
not even in system status viewer!

Figure 225. System status viewer after having changed original sender diagram by
deleting a diagram reference

Some More Hints


• It is possible to change the template settings (from e.g. A4 portrait to Letter
portrait) for the diagrams which will be generated for MMS Communication:
This can be done by opening the Function MMS Receiver Template aspect
of the MMS Receiver Diagram object in Object Type Structure (same for MMS
Sender Diagram Object), see Figure 226.
Warning: Other changes must not be done in the Function MMS Receiver
Template aspect and the Function MMS SenderTemplate aspect and will
harm your MMS Cross Communication Generator.

362 3BDS011224R4101
Section 3 Configuration Fieldbus Builder P/H Integration

Figure 226. MMS Templates in Object Type Structure

• MMS_Read/Write Function Blocks have an extensible number of inputs. If the


Function Block is created with the max. value (32), the symbol does not fit on
an A4 portrait page. Add a component template with smaller fonts and less port
distance to the MMS_Read/Write object types.
• MMS Communication: There is no message when control application
allocation is changed.
It is possible to download code even though the cross communication is not
consistent. Create cross communication once more after allocation changes.

Fieldbus Builder P/H Integration


Introduction and Requirements
Fieldbus Builder P/H Integration of Function Designer describes basic workflow of
functional planning with HART and PROFIBUS object types.

3BDS011224R4101 363
Introduction and Requirements Section 3 Configuration

The system extension Function Designer for FB P/H is based on the system
extensions Function Designer and on HART Device Integration Library and
Fieldbus Builder PROFIBUS/HART. All tools have to be installed, all system
extensions have to be loaded.
To load the system extension Function Designer for FB P/H, use the Configuration
Wizard via System Administration > (System Name) > System Extensions and
select first HART Device Integration Library followed by Fieldbus Builder
PROFIBUS/HART and Function Designer for FB P/H as displayed in the
following figure:

1.
3.
2.

Figure 227. System extension Function Designer Fieldbus Builder P/H

364 3BDS011224R4101
Section 3 Configuration Objects Types of Fieldbus Builder

Objects Types of Fieldbus Builder


Following object types are installed by Fieldbus Builder P/H for HART
configuration see figure Fieldbus Builder P/H, Generic HART Objects:
• DTM Templates
– Generic HART Actuator
– Generic HART Transmitter
• HART Actuators
Specific supported Actuators
• HART Transmitter
Specific supported Transmitters
System extension Function Designer for FB P/H adds the following aspects to all
these object types:
• Function
HART Actuators and HART Transmitter have one Function aspect for the
group of objects.
• Function Parameters

3BDS011224R4101 365
Objects Types of Fieldbus Builder Section 3 Configuration

• Object Name Hook

Figure 228. Fieldbus Builder P/H, Generic HART Objects

For use of specific HART DTMs prepare a copy the generic object e.g. Generic
HART Actuator or use a specific HART Actuator or Transmitter, see Fieldbus
Builder Users Guide. Check that the copied object types include the aspects
Function (generic objects only), Function Parameter and Object Name Hook. Adapt
the Object Name Hook.
Fieldbus Builder P/H does not install specific object types for PROFIBUS. Please
refer the Fieldbus Builder P/H Users Guide for PROFIBUS configuration. In effect,
PROFIBUS object types / devices can be used in Function Designer as the generic
HART devices by just adding a Function aspect with component view.

366 3BDS011224R4101
Section 3 Configuration Building up Functional Structure

Function Aspect
The symbol (graphical appearance) of an object in Function Designer is defined by
its Function aspect, Component View. Follow the hints in section “Defining
Function Components (Component View)” to modify that aspect and adapt to your
personal needs.

Object Name Hook Aspect


The Object Name Hook aspect defines a default instance name for an object type in
Functional Structure. Function Designer needs a default instance name e.g. when
instantiating object types in a function diagram by drag & drop from Object Type
Structure. You can adapt the Object Name Hook to your needs

Figure 229. Specific Instance Name

Building up Functional Structure


You can build up the Functional Structure by inserting Fieldbus Builder
HART/PROFIBUS object types in a function diagram of Function Designer. You
can connect them to CBM_AIS or CBM_AOS signal objects, which are in effect
CBM application global variables connected to an AIS/AOS channel.

3BDS011224R4101 367
Building up Functional Structure Section 3 Configuration

Figure 230. Fieldbus Builder Objects in Function Diagram

DTM, Fieldbus Management Aspects, and others aspects of Fieldbus Builder


Objects can be selected inside the function diagram by right mouse click.

368 3BDS011224R4101
Section 3 Configuration Allocation in Control Structure

Figure 231. Select Fieldbus Builder Aspect by right mouse

Allocation in Control Structure


You can allocate a HART device and the CBM signal in Control Structure
• by Shift+Ctrl drag & drop from the function diagram into Control Structure,
e.g. under an AI895 / AO895 module
• or by Plant Explorer’s Insert Object verb
Make sure that the channel number defined in the AI895/AO895 object’s fieldbus
management aspect matches the channel number of the CBM_AIS/AOS signal.

3BDS011224R4101 369
Allocation in Control Structure Section 3 Configuration

Figure 232. CBM_Signals and HART device channel numbers

370 3BDS011224R4101
Section 4 Graphic Editor Reference

Overview
Function Designer is integrated in the Plant Explorer of Engineering Workplace and
Plant Explorer Workplace. It is the tool for creating function components and
diagrams necessary for presenting complex Functional Structures. Function
Designer is opened by selecting the function aspect from an Aspect Object.

Exploring the Windows User Interface


Function Designer can be used with full functionality in a preview window as part
of the Plant Explorer window of the Engineering Workplace (Figure 6) or Plant
Explorer Workplace, or in a separate popup (overlap) window (Figure 7). You can
open several windows and order the windows cascading, tiled or as icons. It is also
possible to split a window horizontally and/or vertically.

Main Window Handling


On top, the main window displays a navigation toolbar containing useful commands
for navigating between aspects, views, and menus.

Figure 233. Navigation toolbar of the Function Designer’s main window

3BDS011224R4101 371
Diagram/Component View Section 4 Graphic Editor Reference

In detail, the following commands and controls are offered:

Table 36. Main window navigation toolbar commands

Icon Description
Goes back to previous Aspect in display
history

Goes forward to next Aspect in display history

Opens a context menu with object verbs of


the selected Aspect Object. The icon
displayed is the one of the selected Object.
Clicking on the pointer lists all Aspects in
display list.

Drop Target; only active if the window is


unpinned.

Pins/Unpins the current window


Opens a context menu for changing between
aspect views, e.g. between Diagram and the
Component view
Opens a context menu with aspect verbs of
the selected Aspect.

Diagram/Component View
Function Designer offers three different views on the Function aspect:
• Component view
• Diagram view
• Parent Diagram view.

372 3BDS011224R4101
Section 4 Graphic Editor Reference Diagram/Component View

Use Component view to create symbols or templates for function components. It


gets opened on the Function aspect of the selected component object in Functional
Structure.
Use Diagram view to create function diagrams and to insert function components. It
gets opened on the Function aspect of the selected diagram object in Functional
Structure.
Use Parent Diagram view as an alternative to Diagram view to quickly find and
navigate to a component. It gets opened on the Function aspect of the selected
component object in Functional Structure, and it displays and automatically
navigates to the component in its parent diagram.

On choosing an object from Functional Structure or Object Type Structure,


Function Designer recognizes whether a (parent) diagram and/or component data
is existing and automatically opens a corresponding default view.
The Component view is default if there exists component data, but no diagram nor
a parent diagram.
The Parent Diagram view is default if there exists component data and a parent
diagram, but no diagram data.
If both component data and diagram data are existing in a function aspect, the
Diagram view is opened.

Component View
To open Function Designer’s Component view, click the pointer on icon in
the navigation toolbar, and choose Component from the context menu.
Component view displays component document windows with optional split panes.

Diagram View
To open Function Designer’s Diagram view, click the pointer on icon in the
navigation toolbar, and choose Diagram from the context menu.
Diagram view displays a diagram document window with optional split panes.

3BDS011224R4101 373
Diagram/Component Document Windows Section 4 Graphic Editor Reference

Parent Diagram View


To open Function Designer’s Parent Diagram view, click the pointer on icon
in the navigation toolbar, and choose Parent Diagram from the context
menu.
Parent Diagram view displays the parent diagram in Functional Structure, opens a
diagram document window with optional split panes, and automatically navigates to
the diagram page and scrolls to the component selected in Plant Explorer.

Diagram/Component Document Windows

Open Diagram/Component Documents


Diagram/Component document windows can be opened in several ways:
• To create a new diagram / component document on a function aspect, choose
the File > New menu command.
• To open an existing Diagram / Component document, choose the File > Open
menu command and use the Open Aspect dialog.
• To open a nested diagram, containing a detailed diagram, choose the View >
Nested Diagram menu command or the Goto Nested Diagram context menu
command (Function Component Context Menu/Graphic Component
Context Menu).

Open New Windows


The Function Designer offers the possibility to open simultaneously several
diagram/component documents. Each diagram/component document is opened in a
separate window, so you can have several windows open at the same time.
The Function Designer also offers the possibility to open the same
diagram/component document in several windows. That can be useful, for example,
to display different parts or pages of a diagram/component simultaneously in
different windows.
To open a new window for an already diagram/component, choose the Window >
New Window menu command. Each window displaying the same

374 3BDS011224R4101
Section 4 Graphic Editor Reference Diagram/Component Document Windows

diagram/component document automatically gets a unique number as suffix in the


window’s title separated by a colon from the original title.

Arranging Windows
If you have opened simultaneously several diagram/component document windows
you can arrange them by one of the following methods:
• Cascade the windows via menu command Window > Cascade
• Tile the windows via menu command Window > Tile
• Arrange the windows as icons via menu command Window > Arrange Icons,
if you have minimized them before.
• Display the windows in Workbook Mode via menu command Window >
Workbook Mode.

Arranging windows as icons requires the windows being minimized.

Splitting Windows
It is possible to split a window either in horizontal or in vertical direction or in both.
These so-called splitter windows can be used to display different parts or pages of
the same diagram which normally could not be simultaneously displayed on the
screen.
To split a window, do as follows:
• To split the window horizontally, point to the corresponding area on top of the
vertical scroll bar, and drag and drop the split bar.
• To split the window vertically, point to the corresponding area on the left side
of the horizontal scroll bar, and drag and drop the split bar.

3BDS011224R4101 375
Dockable Windows/Toolbars Section 4 Graphic Editor Reference

The following figure illustrates the procedure respectively the result of splitting a
window horizontally and vertically.

point here for


horizontal splitting

point here for


vertical splitting

new border after


horizontal splitting

new border after


vertical splitting

Figure 234. Splitting windows

Dockable Windows/Toolbars
In Function Designer, the menu bar, tool bars, Structure Browsers, Output Window,
and Watch Window are dockable. That means, they can be
• docked on top of the main window
• docked on bottom of the main window

376 3BDS011224R4101
Section 4 Graphic Editor Reference Dockable Windows/Toolbars

• docked at the left border of the main window


• docked at the right border of the main window
• or undocked, i.e. floating as popup window independent of the main window.
Sensitive areas of dockable windows/tool bars are either the docking bar, the
borders or space between toolbar buttons. Dragging these sensitive areas will either
dock, undock, or move the window/toolbar.
On dragging a window/toolbar, you will see the outline. Shape and thickness of the
outline gives you information about the area active for docking. If the border lines
are thin, you are crossing an docking area of the main window (top, bottom, left,
right). If the border lines are thick, you are out of the main window’s docking areas
(see Section , Graphic Editor Reference). The shape indicates the position the
moved window / toolbar would take in relation to its main window if you drop it.

Showing/hiding dockable windows and toolbars


To show/hide a docked window and/or toolbar, do as follows:
1. Click right in the grey background of the menu bar/toolbar. An appropriate
context menu will appear (see Figure 251).
2. From the context menu, choose the window/toolbar to be shown/hidden by
clicking on it. The menu item is checked, if the window/toolbar is shown, it is
unchecked, if the window/toolbar is hidden.

Undocking windows and toolbars


To undock a dockable window/toolbar, double-click on its docking bar or
somewhere in the grey border. The window/toolbar will be displayed undocked, that
means, as separate window.
Alternatively, you can drag-and-drop the window/toolbar to the wanted location
outside the main window.

3BDS011224R4101 377
Dockable Windows/Toolbars Section 4 Graphic Editor Reference

Figure 235 displays an example with undocked windows/toolbars.

main window
undocked toolbar

undocked window

Figure 235. Undocked windows/toolbars

Docking windows and toolbars


To dock an undocked window/toolbar, double-click on its title bar. The
window/toolbar will be docked at the same location as before undocking.
Alternatively, you can drag-and-drop the undocked window/toolbar to the wanted
location within the main window.

378 3BDS011224R4101
Section 4 Graphic Editor Reference Changing the Location of Docked Windows/Toolbars

Figure 236 displays an example with docked windows/toolbars.

Function Designer main window

dockable windows:

Structure Browser 1

Structure Browser 2

Output Window

docking bar for undocking button for expanding/contracting button for hiding horizontal/vertical scroll bar of
docked window docked window docked window docked window

Figure 236. Docked windows/toolbars

Changing the Location of Docked Windows/Toolbars


You can dock a window/toolbar at the four border areas of the main window. To
dock a window/toolbar at another location, drag-and-drop it to the wanted location.

3BDS011224R4101 379
Working with Menus Section 4 Graphic Editor Reference

Figure 237 displays an example with different dock locations.

head bar

top area for toolbars

left-sided toolbar right-sided


toolbar

bottom area for toolbars

status bar toolbar as undocked window

Figure 237. Toolbar locations for docking

Working with Menus


Function Designer’s menu bar is switched according to
• the active view, Component View or (Parent) Diagram View
• the existence of component / diagram data.
The complete Menu bar contains the following menus:
• File Menu
• Edit Menu

380 3BDS011224R4101
Section 4 Graphic Editor Reference Working with Menus

• View Menu
• Insert Menu
• Layout Menu
• Allocation Menu
• Allocation Menu
• Online Menu
• Window Menu
• Help Menu

The entry in the D/C column of tables listing menu commands indicates in which
Function Designer view (Diagram/Component) the menu command is available.

3BDS011224R4101 381
File Menu Section 4 Graphic Editor Reference

File Menu
Table 37.

Menu Command Shortcut Description D/C Toolbar


File > New ALT > F > N CTRL+N Opens the New Function C Standard
Component dialog to create a
new component, component
template, or XML type definition.

File > New ALT > F > N CTRL+N Creates a new diagram. Opens D Standard
the Select Master Page Template
dialog to copy or reference a
template with header and footer
like A3, A4 portrait/landscape.

File > Open ALT > F > O CTRL+O Opens the Open Aspect dialog to D/C Standard
open any component/diagram
document, or any other aspect.

File > Save ALT > F > S CTRL+S Saves the current component/ D/C Standard
diagram document into the
function aspect.

File > Save All ALT > F > L Saves all open component/ D Standard
diagram documents.

File > Skip Modifications ALT > F > M Undoes all changes in current D/C
component/diagram document
since last saving.

File > Generate ALT > G Saves the diagram and D


Configuration Data (Full (re)generates configuration data,
Build) (Full Build) e.g. for AC 800M. This commands
builds all diagram.

File > Generate CTRL+SH Saves the diagram and D


Configuration Data IFT+G (re)generates configuration data,
e.g. for AC 800M.
This command builds only the
modified diagrams.

File > Import ALT > F > I Opens the File Import dialog to D/C
import component or background
graphics.

382 3BDS011224R4101
Section 4 Graphic Editor Reference File Menu

Table 37.

Menu Command Shortcut Description D/C Toolbar


File > Export ALT > F > E Opens the File Export dialog to D/C
export the current component/
diagram document into a different
file format.

File > Template ALT > T Opens the Select Master Page D
Template dialog to copy or
reference a drawing template with
header and footer like A3, A4
portrait/landscape.

File > Create Contents Creates or updates a contents


diagram for a function diagram or
a complete substructure, see
Contents.

File > Open Contents Opens already create contents


diagrams, see Contents.

File > Page Setup ALT > F > U Opens the Page Setup dialog to D/C
change page layout settings.

File > Print ALT > F > P CTRL+P Prints the active component/ D/C Standard
diagram document, and optionally
child diagrams.

File > Print Preview ALT > F > V Displays a print preview of the D/C
active document.

File > Check ALT > F > C Check diagram for valid identifiers D
and connections.

File > Replace ALT > F > R Remove constant connections that D
equal the initial value.

• File > New


In Component view, choose this menu command to create a new function
component, or to overwrite an existing one. In detail, the command opens the
New Function Component dialog
– to create or overwrite a complete function component definition including
fixed graphical symbol with ports, and a fixed parameter set.

3BDS011224R4101 383
File Menu Section 4 Graphic Editor Reference

– to create or overwrite function component template, i.e. a graphical


symbol template. On instantiation in a function diagram, a complete
graphical symbol and ports are automatically created on base of this
template and on the actual parameter set.
– to create or overwrite a XML based type definition including a fixed and
extensible set of parameters. On instantiation in a function diagram,
parameters are automatically created on base of this type definition.
Typically used together with a function component template to define
object types.
In Diagram view, choose this menu command to create a new function
diagram, or to overwrite an existing one. In detail, the command opens the
Select Master Page Template dialog
– to copy or reference a template for the master page layer with header and
footer like A3, A4 portrait/landscape.
– or to leave the initial diagram blank.
See also File > Template.
• File > Open
Choose this menu command to open an existing function component, function
diagram, or any other aspect.
• File > Save
Choose this menu command to save your current function component or
function diagram.
• File > Save All
Choose this menu command to save all open function diagrams.

384 3BDS011224R4101
Section 4 Graphic Editor Reference File Menu

• File > Skip Modifications


Choose this menu command to undo all changes done in the current function
component or function diagram since last save operation. You will get the
following warning:

Click Yes to confirm skipping the modification. Click No to cancel it, if you
want to continue working your function component or function diagram.
If in Diagram view, you did
• create / delete aspect objects
• modify aspect properties
• modify connections.
these modifications are not undone on File > Skip Modifications, or on Close
Diagram.
File > Skip Modifications restores graphics data stored in the Function aspect
only, but does not restore aspect objects nor aspect property values.
• File > Generate Configuration Data (Full Build)
Choose this menu command to your current function diagram and to
(re)generate configuration data for an already allocated solution in Control
Structure. In detail, code is regenerated for all allocatable groups belonging to
this function diagram, which have a Control Structure aspect. For AC 800M
objects this means that Function Designer generated single control modules are
generated again. The command generates the open diagram and all nested
diagrams, independent of their modification state.

3BDS011224R4101 385
File Menu Section 4 Graphic Editor Reference

• File > Generate Configuration Data


This command does the same as command File > Generate Configuration
Data (Full Build), but is generates only those diagrams which are in state
’modified’ (red traffic light indication in the status bar).
• File > Import
Opens the File Import dialog where you can select files to be imported.
See also Import/Export.
• File > Export
Opens the File Export dialog where you can define name, location and format
to export graphics data of
– a function component
– a single layer/page of a function diagram
– a complete function diagram.
See also Import/Export.
• File > Template
Opens the Select Master Page Template dialog where you can select a
predefined template with header/footers for the function diagram.
• File > Create Contents
Opens the Contents dialog to create a contents diagram
• File > Open Contents
Open already generated contents diagrams, see Contents.
• File > Page Setup
Choose this menu command to open the standard Page Setup dialog where you
can set page layout settings like printer paper format, page orientation, and
margins.
• File > Print
Choose this menu command to open the standard Print dialog. In case there
exist child diagrams on lower level, you can optionally print all sub-diagrams.

386 3BDS011224R4101
Section 4 Graphic Editor Reference File Menu

• File > Print Preview


Choose this menu command to open the Print Preview where you can check
how your component or diagram would be printed. Via the following buttons,
you can navigate through different pages of your function diagram, zoom the
previews, display two pages simultaneously and start printing:

Figure 238. Print Preview buttons

• File > Check


Choose this menu command to check the function diagram for valid identifiers
connections, and inversions. In case there exist child diagrams on lower level,
you can optionally check all sub-diagrams. The results of this command are
displayed
– in the function diagram itself: Invalid identifiers, connections, or
inversions are drawn in red.
– as warnings/errors in the output window in textual form. A double-click
on such a warning/error navigates to the corresponding symbol, label,
port, or connection link in the function diagram.
See also Connection and Inversion Checks.
• File > Replace
Choose this menu command to remove constant connections if they equal the
initial value. By that it is possible to tune the value after download without the
need to regenerate configuration data.
This command can be optionally applied to child diagrams as well. You can
invoke this command in order to bulk update diagrams created with SV31
where initial values of the type were connected as constants.

3BDS011224R4101 387
Edit Menu Section 4 Graphic Editor Reference

Edit Menu
Table 38.

Menu Command Shortcut Description D/C Toolbar


Edit > Undo ALT > E > U CTRL+Z Undoes the last action. D/C Standard

Edit > Redo ALT > E > R CTRL+Y Redoes the previously undone action. D/C Standard

Edit > Cut ALT > E > T CTRL+X Cuts the selection to the clipboard. D/C Standard

Edit > Copy ALT > E > C CTRL+C Copies the selection to the clipboard. D/C Standard

Edit > Paste ALT > E > P CTRL+V Inserts the clipboards contents. D/C Standard

Edit > Delete ALT > E > D DEL Deletes the selected item(s). D/C Standard

Edit > Select All ALT > E > L CTRL+A Selects all components of the active D
layer and active page.

Edit > Components ALT > E > E Opens the Components dialog to D/C
navigate to individual graphical
components.

Edit > Default Properties ALT > E > I Opens the Component Properties D/C Drawing
dialog to set graphical properties.

Edit > Aspect Properties ALT > E > A Opens the Aspect Properties dialog D
(Ports property page) dialog to view
and set Layers.

Edit > Ambient Properties ALT > E > M Opens the Ambient Properties D/C
dialog to set ambient properties valid
for the whole component/diagram.

Edit > Default Properties ALT > E > F Opens the Default Properties dialog D/C
to set default graphical properties for
new components.

388 3BDS011224R4101
Section 4 Graphic Editor Reference Edit Menu

Table 38.

Menu Command Shortcut Description D/C Toolbar


Edit > Measurements and Size ALT > E > S Opens the Measurements and Size D/C
dialog to set properties of the drawing
page,

Edit > Options ALT > E > O Opens the Options dialog D

• Edit > Undo


Choose this menu command to undo the last action. See also Undo.
• Edit > Redo
Choose this menu command to redo the last undone action. See also Redo.
• Edit > Cut
Choose this menu command to cut selected components to the clipboard.
• Edit > Copy
Choose this menu command to copy selected components to the clipboard
• Edit > Paste
Choose this menu commands to paste components (cut or copied via the Cut or
Copy command) from the clipboard into the component/diagram document.
• Edit > Delete
Choose this menu command to delete selected component(s) from the
component/diagram document.
• Edit > Select All
Choose this menu command to select all components of the active layer and
active page.
• Edit > Components
Choose this menu command to open the Components dialog
– to navigate to individual graphical components in the component/diagram
document

3BDS011224R4101 389
Edit Menu Section 4 Graphic Editor Reference

– to open the Component Properties dialog.


• Edit > Component Properties
Choose this menu command to open the Component Properties dialog to set
graphical properties of the selected graphic component(s) like line width, fill
color, font, etc.
• Edit > Aspect Properties
Choose this menu command to open the Aspect Properties dialog to view or set
Aspect Properties of the selected function diagram, function component, or
port.
• Edit > Ambient Properties
Choose this menu command to open the Ambient Properties dialog to set
ambient properties that are valid for the while component/diagram document
like background and selection colors.
• Edit > Default Properties
Choose this menu command to open the Default Properties dialog to set
default graphical properties valid for newly created/inserted graphic
components (primitives).
• Edit > Measurements and Size
Choose this menu command to open the Measurements and Size dialog to
adjust units of measure, drawing scale, module, and the drawing page size for
the active function component / function diagram.
• Edit > Options
Choose this menu command to open the Options dialog to set some options
concerning printing, pasting components, and auto routing.

390 3BDS011224R4101
Section 4 Graphic Editor Reference View Menu

View Menu
Table 39.

Menu Command Shortcut Short Description D/C Toolbar


View > Toolbar > Customize ALT > V > T > C Opens the Customize dialog. D/C

View > Status Bar ALT > V > S Turns on or off the display of the D/C
status bar

View > Grid ALT > V > G Shows or hides the grid. D/C Drawing

View > Snap to Grid ALT > V > N Snaps symbols to grid. D/C Drawing

View > Grid Properties ALT > V > D Opens the Grid Properties dialog. D/C

View > Printable Area ALT > V > R Check to outline printable area in D/C
print preview according to the
selected printer and print paper
size.

View > Zoom Normal ALT > V > Z Zooms the canvas display to the D/C
normal default size (100%)

View > Zoom Percent > 50% ALT > V > C > 5 Zooms the canvas display to 50% D/C
of the normal size.

View > Zoom Percent > 75% ALT > V > C > 7 Zooms the canvas display to 75% D/C
of the normal size.

View > Zoom Percent > 100% ALT > V > C > 1 Zooms the canvas display to the D/C
normal default size (100%)

View > Zoom Percent > 200% ALT > V > C > 2 Zooms the canvas display to 200% D/C
of the normal size.

View > Zoom Custom ALT > V > U Opens the Zoom dialog. D/C

View > Zoom to Fit ALT > V > F Zooms so that all components are D/C View
visible.

View > Layers > Properties ALT > V > L > P Sets Layer Properties. D View,
Drawing

3BDS011224R4101 391
View Menu Section 4 Graphic Editor Reference

Table 39.

Menu Command Shortcut Short Description D/C Toolbar


View > Layers > L1 Master Page Layer ALT > V > L > 1 Sets active layer to Master Page D
Layer.

View > Layers > L2 Background Layer ALT > V > L > 2 Sets active layer to Background D
Layer.

View > Layers > L3 Logic Layer ALT > V > L >3 Sets active layer to Logic Layer. D

View > Layers > L4 Annotation Layer ALT > V > L > 4 Sets active layer to Annotation D
Layer.

View > Pages > Insert New Page ALT > V > P > I Inserts a new page. D View

View > Pages > Delete Page ALT > V > P > D Deletes the active page. A page D View
must be empty before it can be
deleted.

View > Pages > First Page ALT > V > P > F Navigates to the first page. D View

View > Pages > Previous ALT > V > P > P Navigates to the previous page. D View

View > Pages > Next ALT > V > P > N Navigates to the next page. D View

View > Pages > Last ALT > V > P > L Navigates to the last page. D View

View > Pages > Goto Page ALT > V > P > G Opens the Goto page dialog. D

View > Pages > Page Comment ALT > V > P > C Opens the Page Comment dialog. D Page

View > Nested Diagram ALT > V > E Opens the nested diagram D
represented by the selected
symbol.

View > Referenced Diagram ALT > V > M Opens the referenced diagram D
represented by the selected off-
diagram symbol.

View > Subscribe for Life Data ALT > V > B Start/Stop display of life data (on- D
line values) in the function diagram
and/or in the Watch window.

392 3BDS011224R4101
Section 4 Graphic Editor Reference View Menu

Table 39.

Menu Command Shortcut Short Description D/C Toolbar


View > Show Last Value(s) ALT > V > V Show/Hide recent on-line values D
when subscription for life data has
stopped.

View > SVG/XML Source ALT > V > X Opens the SVG/XML Source D/C
window.

• View > Toolbar > Customize


Choose this menu command to open the Customize dialog to customize
toolbars.
• View > Status Bar
Choose this menu command to turn on or off the display of the Status Bar on
bottom of the Function Designer window.

Figure 239. Status bar

The Status Bar displays, for example,


– short menu and toolbar button help texts.
– OPC quality and time stamp while ’Online > Subscribe for Live Data’ is
active. See also On-line Display.
– indicator ’NUM’ and ’SCRL’ for Numlock or Scroll-lock, respectively.
– indicator ’Read’ for read-only components, diagrams, and layers.
Components and diagrams might be read-only due to access control
and/or inheritance of relevant aspects and/or if ActiveX Run Mode is
enabled.
– information about the currently displayed mode (view) of the Function
Designer, Diagram or Component.

3BDS011224R4101 393
View Menu Section 4 Graphic Editor Reference

– information about the diagram state, e.g. modified, generated, and loaded.
See Instance Specific Initial Values.
If the display is turned on, the menu item is checked by .
• View > Grid
Choose this menu command to turn on or off grid display in the current
component/diagram document.
• View > Snap to Grid
Choose this menu command to snap components to the current grid on create,
move, or copy.
• View > Grid Properties
Choose this menu command to open the Grid Properties dialog to adjust grid
size and color.
• View > Printable Area
Check this menu command to outline the printable area in print preview
according to the selected printer and print paper size.
• View > Zoom Normal
Choose this menu command to zoom the canvas display to default size (100%).
See also Zoom Normal.
• View > Zoom Percent > 50%
Choose this menu command to zoom the canvas display to 50% of normal size.
• View > Zoom Percent > 75%
Choose this menu command to zoom the canvas display to 75% of normal size.
• View > Zoom Percent > 100%
Choose this menu command to zoom the canvas display to normal size (100%).
This menu command is identical to View > Zoom Normal.
• View > Zoom Percent > 200%
Choose this menu command to zoom the canvas display to 200% of normal
size.

394 3BDS011224R4101
Section 4 Graphic Editor Reference View Menu

• View > Zoom Custom


Choose this menu command to open the Zoom dialog to zoom the canvas
display to the Magnification value selected. See also Zoom Custom.

Figure 240. Zoom dialog

• View > Zoom to Fit


Choose this menu command to zoom the canvas to a size in order to display all
all components of the active page without the need for scrolling.
• View > Layers > Properties
Choose this menu command to open the Layer Properties dialog to set
properties of the different layers.
• View > Layers > L1 Master Page Layer
Choose this menu command to make the Master Page Layer active.
• View > Layers > L2 Background Layer
Choose this menu command to make the Background Layer active.
• View > Layers > L3 Logic Layer
Choose this menu command to make the Logic Layer active.
• View > Layers > L4 Annotation Layer
Choose this menu command to make the Annotation Layer active.
• View > Pages > Insert New Page
Choose this menu command to insert a new page to the diagram.

3BDS011224R4101 395
View Menu Section 4 Graphic Editor Reference

• View > Pages > Delete Page


Choose this menu command to delete the current page of the diagram. A page
to be deleted must be empty, i.e. there are no components on any layer besides
the master page layer.
• View > Pages > First Page
Choose this menu command to navigate to the first page of the diagram.
• View > Pages > Previous
Choose this menu command to navigate to the previous page of the diagram.
• View > Pages > Next
Choose this menu command to navigate to the next page of the diagram.
• View > Pages > Last
Choose this menu command to navigate to the last page of the diagram.
• View > Pages > Goto Page
Choose this menu command to open the Goto Page dialog to enter the page
number of interest in order to navigate to.
(see also Navigation to a certain page).
• View > Pages > Page Comment
Choose this menu command to open the Page Comments dialog to enter a
comment for a single page or a set of pages.
• View > Nested Diagram
Choose this menu command to open the nested diagram that is represented in
the active diagram by the symbol selected.
This menu command is only accessible if a symbol representing a (nested)
diagram is selected.
• View > Referenced Diagram
Choose this menu command to open the referenced diagram that is represented
in the active diagram by the selected off-diagram reference symbol.

396 3BDS011224R4101
Section 4 Graphic Editor Reference View Menu

This menu command is only accessible if an off-diagram reference symbol is


selected.
• View > Subscribe for Life Data
Choose this toggle menu command to start/stop display of life data (on-line
values) in the function diagram or in the Watch window.
• View > Show Last Value(s)
Choose this toggle menu command to show/hide recent on-line values when
subscription for life data has stopped.
• View > SVG/XML Source
Choose this menu command to open the SVG/XML Source window
displaying the function component / function diagram represented as
SVG/XML source code.

Figure 241. SVG/XML Source Window

3BDS011224R4101 397
Insert Menu Section 4 Graphic Editor Reference

Insert Menu
Table 40.

Menu Command Shortcut Description D/C Toolbar


Insert > Symbol ALT > I > S Inserts a symbol (function component) D
into the diagram.

Insert > Circle Port ALT > I > C Inserts a circle port. C Drawing

Insert > Line Port ALT > I > P Inserts a line port. C Drawing

Insert > Text ALT > I > T Inserts text. D/C Drawing

Insert > Label ALT > I > L Inserts a label. D/C Drawing

Insert > Graphic > Lines ALT > I > G > L Draws a single line. D/C Drawing

Insert > Graphic > Polyline ALT > I > G > P Draws a multi-segmented line. D/C Drawing

Insert > Graphic > Rectangle ALT > I > G > R Draws a rectangle. D/C Drawing

Insert > Graphic > Polygon ALT > I > G > O Draws a polygon. D/C Drawing

Insert > Graphic > Poly Curve ALT > I > G > C Draws a series of connected curves. D/C Drawing

Insert > Graphic > Closed Curve ALT > I > G > U Draws a polycurve with connecting start D/C Drawing
and end points.

Insert > Graphic > Ellipse ALT > I > G > P Draws an ellipse. D/C Drawing

Insert > Picture ALT > I > I Inserts a picture. D/C Drawing

Insert > ActiveX ALT > I > A Inserts an ActiveX component. D/C Drawing

Insert > Page ALT > I > E Creates a Page. D Page

398 3BDS011224R4101
Section 4 Graphic Editor Reference Insert Menu

• Insert > Symbol


In Diagram view, choose this menu command to insert a symbol (function
component) into the active function diagram.
See Inserting/Creating Components.
• Insert > Circle Port
In Component view, choose this command to insert a circle port.
See also Inserting Ports.
• Insert > Line Port
In Component view, choose this command to insert a line port.
See also Inserting Ports.
• Insert > Text
Choose this menu command to insert a text component.
See Inserting Text Components.
• Insert > Label
Choose this menu command to insert a label.
See Inserting Label Components.
• Insert > Graphic > Lines
Choose this menu command to insert a single line.
See also Inserting a Line.
• Insert > Graphic > Polyline
Choose this menu command to insert a polyline.
See also Inserting a Polyline.
• Insert > Graphic > Rectangle
Choose this menu command to insert a rectangle.
See also Inserting a Rectangle.

3BDS011224R4101 399
Insert Menu Section 4 Graphic Editor Reference

• Insert > Graphic > Polygon


Choose this menu command to insert a polygon.
See also Inserting a Polygon.
• Insert > Graphic > Poly Curve
Choose this menu command to insert a polycurve.
See also Inserting a Polycurve.
• Insert > Graphic > Closed Curve
Choose this menu command to insert a closed curve.
See also Inserting a Closed Curve.
• Insert > Graphic > Ellipse
Choose this menu command to insert an ellipse.
See also Inserting an Ellipse.
• Insert > Picture
Choose this menu command to open a standard File Open dialog from which
you can select an image in either .bmp, .wmf or .dib format.
See also Inserting Pictures/Images.
• Insert > ActiveX
Choose this menu command to insert an ActiveX control, or a Graphic Element
built with Graphics Builder.
See also Inserting ActiveX Controls.
• Insert > Page
In Diagram view, choose this menu command to create a new page. The new
page normally will be inserted behind the active page.

400 3BDS011224R4101
Section 4 Graphic Editor Reference Insert Menu

If you choose this menu command when the 1st page is active, the system will
ask you where you want to insert the new page:

Figure 242. New Page

To insert the new page before the 1st page, click Yes.
To insert the new page behind the 1st page, click No.
See also Pages.

3BDS011224R4101 401
Layout Menu Section 4 Graphic Editor Reference

Layout Menu
Table 41.

Menu Command Shortcut Description D/C Toolbar


Layout > Align > Left ALT > L > A > L Aligns left. D/C Align

Layout > Align > Center ALT > L > A > C Aligns centered. D/C Align

Layout > Align > Right ALT > L > A > R Aligns right. D/C Align

Layout > Align > Top ALT > L > A > T Aligns top. D/C Align

Layout > Align > Middle ALT > L > A > M Aligns middle. D/C Align

Layout > Align > Bottom ALT > L > A > B Aligns bottom. D/C Align

Layout > Space Evenly > Across ALT > L > S > A Spaces components D/C Layout
horizontally.

Layout > Space Evenly > Down ALT > L > S > D Spaces components vertically. D/C Layout

Layout > Make Same Size > Width ALT > L > M > W Makes components in the D/C Layout
same width.

Layout > Make Same Size > Height ALT > L > M > H Makes components in the D/C Layout
same height.

Layout > Make Same Size > Both ALT > L > M > B Makes components in the D/C Layout
same size.

Layout > Rotate > Free ALT > L > R > F Rotates components. D/C Rotate

Layout > Rotate > Left ALT > L > R > L Rotates 90 degrees counter D/C Rotate
clockwise.

Layout > Rotate > Right ALT > L > R > R Rotates 90 degrees clockwise. D/C Rotate

Layout > Flip > Horizontal ALT > L > F > H Flips around the horizontal D/C Rotate
center.

Layout > Flip > Vertical ALT > L > F > V Flips around the vertical D/C Rotate
center.

402 3BDS011224R4101
Section 4 Graphic Editor Reference Layout Menu

Table 41.

Menu Command Shortcut Description D/C Toolbar


Layout > Order > Bring to Front ALT > L > O > T Brings to front. D/C Structure

Layout > Order > Send to Back ALT > L > O > K Sends to back. D/C Structure

Layout > Order > Bring Forward ALT > L > O > F Brings forward. D/C Structure

Layout > Order > Send Backward ALT > L > O > B Sends backward. D/C Structure

Layout > Group ALT > L > G Groups components. D/C Structure

Layout > Ungroup ALT > L > U Ungroups components. D/C Structure

• Layout > Align > Left


Choose this menu command to align vertically selected components to the left
edge of the anchor component.
• Layout > Align > Center
Choose this menu command to vertically align selected components to the
center of the anchor component.
• Layout > Align > Right
Choose this menu command to vertically align selected components to the right
edge of the anchor component.
• Layout > Align > Top
Choose this menu command to horizontally align selected components to the
top of the anchor component.
• Layout > Align > Middle
Choose this menu command to horizontally align selected components to the
center of the anchor component.

3BDS011224R4101 403
Layout Menu Section 4 Graphic Editor Reference

• Layout > Align > Bottom


Choose this menu command to horizontally align selected components to the
bottom of the anchor component.
• Layout > Space Evenly > Across
Choose this menu command to space selected components evenly between the
left-most and right-most components selected.
• Layout > Space Evenly > Down
Choose this menu command to space selected components evenly between the
top-most and bottom-most components selected.
• Layout > Make Same Size > Width
Choose this menu command to change the width of selected components to
match the width of the anchor component.
• Layout > Make Same Size > Height
Choose this menu command to change the height of selected components to
match the height of the anchor component.
• Layout > Make Same Size > Both
Choose this menu command to change the width and height of selected
components to match the size of the anchor component.
• Layout > Rotate > Free
Choose this menu command to set the canvas to rotate mode. Changes the
cursor to a circular arrow when it is over a component, and allows you to grab
a component and rotate it by mouse.
See also Rotate Free.
• Layout > Rotate > Left
Choose this menu command to rotate selected components by 90 degrees to the
left.
See also Rotate Left.

404 3BDS011224R4101
Section 4 Graphic Editor Reference Layout Menu

• Layout > Rotate > Right


Choose this menu command to rotate selected components by 90 degrees to the
right.
See also Rotate Right.
• Layout > Flip > Horizontal
Choose this menu command to flip selected components 180 degrees around
the X axis.
See also Flip Horizontal.
• Layout > Flip > Vertical
Choose this menu command to flip selected components 180 degrees around
the Y axis.
See also Flip Vertical.
• Layout > Order > Bring to Front
Choose this menu command to bring selected components to front so that they
are not hidden by other components.
See also Bring to Front.
• Layout > Order > Send to Back
Choose this menu command to send the selected components back so that they
can get hidden by other components in the foreground.
See also Send to Back.
• Layout > Order > Bring Forward
Choose this menu command to bring selected component(s) one level forward.
See also Bring Forward.
• Layout > Order > Send Backward
Choose this menu command to send selected component(s) one level
backward.
See also Send Backward.

3BDS011224R4101 405
Allocation Menu Section 4 Graphic Editor Reference

• Layout > Group


Choose this menu command to group selected components. All grouped
components can now be manipulated as one component.
• Layout > Ungroup
Choose this menu command to ungroup a group of components.

Allocation Menu
Table 42.

Menu Command Shortcut Description D/C Toolbar


Allocation > New Allocatable Group ALT > A > N Creates a new allocatable group. D Allocation

Allocation > Delete Allocatable Group ALT > A > D Deletes an allocatable group. D Allocation

Allocation > Show Allocation Details ALT > A > S Ctrl+L Shows allocation group details like D Allocation
name, short name, data flow
order, and color

Allocation > Define Data Flow Order ALT > A > E Opens a dialog to define the data D Allocation
flow order.

Allocation > Allocation Grouping ALT > A > G Move selected components into D
another allocatable group

• Allocation > New Allocatable Group


In Diagram view, choose this menu command to create a new allocatable
group, i.e. an Aspect Object with allocatable group aspect.
(See page 244, Create a new allocatable group inside Function Designer)
• Allocation > Delete Allocatable Group
In Diagram view, choose this menu command to delete the current allocatable
group. Components that belong to that allocatable group are moved to the
parent allocatable group, e.g. to the diagram itself.

406 3BDS011224R4101
Section 4 Graphic Editor Reference Allocation Menu

• Allocation > Show Allocation Details


In Diagram view, choose this menu command to display allocation details at
function components, e.g. data flow order, name, short name, and color of the
allocatable group.(See page 257, Showing Allocation Details)
• Allocation > Define Data Flow Order
In Diagram view, choose this menu command to open the Data Flow Order
dialog.
(See page 252, Defining Data Flow Order in Allocatable Groups)
• Allocation > Allocation Grouping
In Diagram view, choose this menu command to move selected function
components to another allocatable group.

3BDS011224R4101 407
Online Menu Section 4 Graphic Editor Reference

Online Menu
Table 43.

Menu Command Shortcut Description D/C Toolbar


Online > Add to Display List ALT > O > A F7 Add selected item (port, symbol, D
link) to display list.

Online > Remove from Display List ALT > O > Shift Remove selected item(s) (port, D
R +F7 symbol, link) from display list.

Online > Add all Links to Display List ALT > O > L Add all links on current page to D
display list.

Online > Remove all Links from ALT > O> M Remove all links on current page D
Display List from display list.

Online > Watch Window ALT > O> Display the Watch window to D
W check and set variable values.

Online > Update OPC Properties ALT > O>U Update outdated OPC properties D
for function block / control module
symbol objects.

Online > Subscribe for Live Data ALT > O> B Start/Stop display of on-line values D
(life data)

Online > Show Last Value(s) ALT > O> V Show/Hide recent on-line values D
when subscription for life data has
stopped.

• Online > Add to Display List


In Diagram view, choose this menu command to display on-line values from an
OPC server for the selected port(s), symbol(s), link(s). In effect, the selected
item(s) are added to the display list which collects all OPC items to be
displayed while Subscribe for Life Data is active.
The command can be used while Subscribe for Life Data is inactive or active:
– If inactive, no on-line values are retrieved from the OPC server, and added
items just display a “*” indicating that they are prepared to display on-line
values.
– If active, on-line values are retrieved from the OPC server. In that case,
added items display the on-line value retrieved.

408 3BDS011224R4101
Section 4 Graphic Editor Reference Online Menu

• Online > Remove from Display List


In Diagram view, choose this menu command to no longer display on-line
values for the selected port, symbol, or link. In effect, the selected item(s) are
removed from the display list.
• Online > Add all Links to Display List
In Diagram view, choose this menu command to display on-line values for all
links on the current page. In effect, all links on the current page are added to the
display list.
• Online > Remove all Links from Display List
In Diagram view, choose this menu command to no longer display on-line
values for all links on the current page.
• Online > Watch Window
In Diagram view, choose this menu command to open the Watch window in
order to
– display and set on-line values in textual form in a list box.
– display and set on-line values for variables of structured data type.
– display and set on-line values from another function diagram
– display and set on-line values from an arbitrary aspect exposing OPC
properties, e.g. a CBM application.
Set on-line value means that the OPC value is written once.
• Online > Update OPC Properties
Subscribe for live data retrieves on-line values from the OPC server via OPC
properties. These OPC properties stored on SCM/CM level are
generated/updated on configuration data generation.
In some cases, OPC properties for function block / control module symbol
objects can get outdated/deleted. By that thus such symbol objects no longer
display on-line values, but a ’*’. This happens e.g. if you change initial values
in the diagram SCM’s Control Properties.
The command Online > Subscribe for Live Data automatically detects outdated
OPC properties and asks you to update them. Use command Online > Update

3BDS011224R4101 409
Online Menu Section 4 Graphic Editor Reference

OPC Properties to explicitly update OPC properties for diagrams in state


’generated’ or ’loaded’.
• Online > Subscribe for Live Data
In Diagram view, choose this toggle menu command to start/stop display of on-
line values collected in the diagram’s display list and/or collected in the Watch
window.
– If checked, Subscribe for Life Data is active. I.e. on-line values are
retrieved from the OPC server and displayed in the diagram or in the
Watch window.
– If unchecked, Subscribe for Life Data is inactive. I.e. no on-line values are
retrieved from the OPC server. According to the setting ’Show Last
Value(s)’, the OPC items in the diagram display a ’*’ or the recent value
retrieved, and the OPC items in the Watch window display an empty value
or the recent value retrieved.
• Online > Show Last Value(s)
In Diagram view, choose this toggle menu command to show or hide recent on-
line values when subscription for life data has stopped.
– If checked, recent values retrieved from the OPC server are still displayed
in the diagram and/or in the Watch window.
– If unchecked, the OPC items in the diagram display a ’*’, and the OPC
items in the Watch window display an empty value.

410 3BDS011224R4101
Section 4 Graphic Editor Reference Window Menu

Window Menu
Table 44.

Menu Command Shortcut Description D/C Toolbar


Window > Workbook Mode ALT > W > W Turns on or off the workbook mode (display with D/C
tabs).

Window > New Window ALT > W > N Opens diagram in a new window. D/C

Window > Cascade ALT > W > C Arranges windows cascading. D/C

Window > Tile ALT > W > T Arranges windows tiled. D/C

Window > Arrange Icons ALT > W > A Arranges icons of minimized windows. D/C

Window > n Window Title ALT > W > n Bring selected window to front. D/C

• Window > Workbook Mode


Choose this menu command to display open windows in workbook mode. In
workbook mode, MS-Excel sheet-like tabs are displayed at the bottom of the

3BDS011224R4101 411
Window Menu Section 4 Graphic Editor Reference

main window in order to navigate to the component/diagram document of


interest by a single mouse click.

Figure 243. Windows arranged in Workbook Mode

• Window > New Window


Choose this menu command to open a new document window of an already
open function component or function diagram. The new window displays the
same document, but you can display different areas or different pages of a
diagram at the same time, for example.

412 3BDS011224R4101
Section 4 Graphic Editor Reference Window Menu

• Window > Cascade


Choose this menu command to cascade open windows as displayed in the
following figure:

Figure 244. Cascaded Windows

3BDS011224R4101 413
Window Menu Section 4 Graphic Editor Reference

• Window > Tile


Choose this menu command to tile open windows as displayed in the following
figure:

Figure 245. Tiled Windows

414 3BDS011224R4101
Section 4 Graphic Editor Reference Window Menu

• Window > Arrange Icons


Choose this menu command to arrange all minimized windows as displayed in
the following figure:

Figure 246. Windows arranged as icons

• Window > n Window Title


Choose this menu command to activate the window of interest.

3BDS011224R4101 415
Help Menu Section 4 Graphic Editor Reference

Help Menu
Table 45.

Menu Command Shortcut Description Toolbar


Help > Contents ALT > H >C Display on-line help contents, index, Standard
search page, and favorites.

Help > Reference ALT > H >U Display this Engineering Workplace Standard
Manual Function Designer Reference manual.

Help > About ALT > H >A Display program information, version Standard
number and copyright.

• Help > Contents


Choose this menu command to display the contents of Function Designer’s on-
line help.
• Help > Reference Manual
Choose this menu command to display this Engineering Workplace Function
Designer Reference manual via Adobe Acrobat Reader.
• Help > About
Choose this menu command to display product version and copyright
information of the currently installed Function Designer. Depending on the
view (Diagram/Component view), the corresponding About dialog is
displayed.

Figure 247. About Function Designer dialog (Diagram View)

416 3BDS011224R4101
Section 4 Graphic Editor Reference Context Menus

Context Menus
On right mouse click, context menus are opened according to the selected
object/area in Function Designer.
• The function component’s context menu (right-click on a component) not only
offers Function Designer menus like Cut, Copy, Paste, Order, and so on, but
also other aspects and verbs of the corresponding Aspect Object.
By that you can quickly navigate to other aspects of each component from
within the function diagram.
• The diagram’s context menu (right-click on the empty diagram background)
not only offers Function Designer menus like Paste, Grid, Zoom, and so on, but
also other aspects and verbs of the corresponding diagram Aspect Object. By
that you can quickly navigate to other aspects of the diagram.

Most context menus have some dynamic part, that means menu items are
displayed according to the selected Aspect Object.
You will find the following object-specific context menus:
• Function Aspect Context Menu
• Diagram/Component Document Context Menu
• Function Component Context Menu
• Graphic Component Context Menu
• Dockable Window Context Menu
• Horizontal Scrollbar Context Menu
• Output Window Context Menu
• Toolbar Context Menu
• Vertical Scrollbar Context Menu

Function Aspect Context Menu


The Function aspect supports three views, see Diagram/Component View:

3BDS011224R4101 417
Context Menus Section 4 Graphic Editor Reference

• Diagram
• Component
• Parent Diagram
The Function aspect supports the aspect verbs
• Generate Configuration Data, see Generate Configuration Data.
• Generate Configuration Data (Full Build), see Generate Configuration
Data.
• Synchronize Names, see Enhanced Naming.
• Upgrade XML Type Description (on object types only), see Function
Components with XML Type Description (Component View).
Click right on a function aspect to open the following context menu:

418 3BDS011224R4101
Section 4 Graphic Editor Reference Context Menus

The menu items are described in Table 46:

Table 46. Function Aspect Context Menu Commands

Menu Command Description


Diagram Opens a new overlap window and displays the Function Diagram view of
the current selected diagram aspect object, see Diagram/Component
View.

Component Opens a new overlap window and displays the Function Component view
of the current selected component aspect object, see
Diagram/Component View.

Parent Diagram Opens a new overlap window, displays the Function Diagram view of the
parent diagram of the current selected component aspect object, and
navigates to the selected component, see Diagram/Component View.

New Aspect Opens the dialog for creating a new Aspect Object (see Creating a New
Function Aspect).

Cut Cuts the selected aspect and places it on the clipboard.

Copy Copies the selected aspect to the clipboard.

Paste Pastes the cut/copied aspect to the aspect list.

Delete Deletes the selected aspect.

Rename Allows to rename the selected aspect.

Override If the aspect is inherited, this operation makes a local copy of the aspect,
(see Overridden Components).

Generate Generate the configuration data for the diagram and all nested diagrams.
Configuration Data The command generates only diagrams in modified state (red traffic light
indicator in the status bar). See Generate Configuration Data.

Generate Generate the configuration data for the diagram and all nested diagrams,
Configuration Data independent of the diagram state. See Generate Configuration Data.
(Full Build)

Synchronize Names Synchronizes/maps the .:Name.Name to


• .:Control Builder Name.Name.
• Name parameter of control modules
See Enhanced Naming.

References If the Aspect Object has cross-references, for example the Aspect Object
could be included in a graphic display, the display's name is shown when
you select this item

3BDS011224R4101 419
Context Menus Section 4 Graphic Editor Reference

Table 46. Function Aspect Context Menu Commands

Menu Command Description


Add To Aspect Add the selected aspect to Aspect Favorites.
Menu...

Properties Opens the function aspect’s Properties dialog.

Properties
Open the function aspect’s Properties dialog via the Properties menu command of
the Function Aspect Context Menu.
The dialog consists of the following pages:
• Identification
• Aspect Details
• User Role Mapping
• Permission
• Lock Status

420 3BDS011224R4101
Section 4 Graphic Editor Reference Context Menus

Diagram/Component Document Context Menu


In Component view or in Diagram view click right on any free area in a document
window to open the following context menu:

The menu items are described in Table 47:

Table 47. Diagram/Component Document Context Menu Commands

Menu Command (1) Description No


Default Aspect If this menu item appears as Default Aspect (disabled), it indicates 1
or that no Default Aspect is defined for the current selected Aspect
<Aspect> Object
If this menu item appears as <Aspect> (for example, Function,
Name, and so on), it navigates directly to the default <Aspect>-
specific view (see Default Aspect)

Cut Cuts the Diagram/Component document and copies to the Clipboard 2

Copy Copies the Diagram/Component document to the Clipboard. 3

Paste Equals menu command Edit > Paste. 4

3BDS011224R4101 421
Context Menus Section 4 Graphic Editor Reference

Table 47. Diagram/Component Document Context Menu Commands

Menu Command (1) Description No


Grid Equals menu command View > Grid. 5

Snap to Grid Equals menu command View > Snap to Grid. 6

Angle Snap 7

Grid Properties Equals menu command View > Grid Properties. 8

Zoom > 50% Equals menu command View > Zoom Percent > 50%. 9

Zoom > 75% Equals menu command View > Zoom Percent > 75%. 10

Zoom> 100% Equals menu command View > Zoom Percent > 100%. 11

Zoom > 200% Equals menu command View > Zoom Percent > 200%. 12

Zoom > Zoom to Fit Equals menu command View > Zoom to Fit. 14

Aspect Properties Equals menu command Edit > Aspect Properties. 14

Ambient Properties Equals menu command Edit > Ambient Properties. 15

Default Properties Equals menu command Edit > Default Properties. 16

Measurements and Size Equals menu command Edit > Measurements and Size. 17

Options Equals menu command Edit > Options. 18

Show Type Navigates to the object type in Object Type Structure. 19

<Aspect> Navigates to the corresponding <Aspect> of the current Aspect 20


Object.

References If the Aspect Object has cross-references, for example the Aspect 21
Object could be included in a graphic display, the display's name is
shown when you select this item

Advanced Engineering Workplace only: Open Engineering Workplace 22


Advanced menu with some useful commands for I/O Allocation, Bulk
Data Manager, Document Manager, and Structure operations.

Properties Opens the Properties dialog of the selected aspect object. 23

(1) The menu items >19 are part of the dynamic System 800xA Aspect Object menu.

422 3BDS011224R4101
Section 4 Graphic Editor Reference Context Menus

Function Component Context Menu


Click right on a function component to open the following context menu:

3BDS011224R4101 423
Context Menus Section 4 Graphic Editor Reference

The menu items are described in Table 48:

Table 48. Function component context menu commands

Menu Command Description No


Default Aspect If this menu item appears as Default Aspect (disabled), it 1
or indicates that no Default Aspect is defined for the current
<Aspect> selected Aspect Object
If this menu item appears as <Aspect> (for example,
Function, Name, and so on), it navigates directly to the
default <Aspect>-specific view (see Default Aspect)

Cut Equals menu command Edit > Cut. 2

Copy Equals menu command Edit > Copy. 3

Paste Equals menu command Edit > Paste. 4

Delete Equals menu command Edit > Delete. 5

Order > Bring Forward Equals menu command Layout > Order > Bring Forward. 6

Order > Bring to Front Equals menu command Layout > Order > Bring to Front. 7

Order > Send Backward Equals menu command Layout > Order > Send 8
Backward.

Order > Send to Back Equals menu command Layout > Order > Send to Back. 9

Grouping > Group Equals menu command Layout > Group. 10

Grouping > Ungroup Equals menu command Layout > Ungroup. 11

Add to Display List Equals menu command Online > Add to Display List. 12

Remove From Display List Equals menu command Online > Remove from Display 13
List.

Allocation Grouping Equals menu command Allocation > Allocation Grouping. 14

Aspect Properties Equals menu command Edit > Aspect Properties. 15

Component Properties Equals menu command Edit > Default Properties. 16

Aspect Object Toggles instance kind aspect object <-> symbol object, see 17
Aspect Objects and Symbol Objects.

Show Hidden Ports Displays the Dialog Show Hidden Ports in order to select 18
and show previously hidden ports. This menu item is
enabled only for components with hidden ports.

424 3BDS011224R4101
Section 4 Graphic Editor Reference Context Menus

Table 48. Function component context menu commands

Menu Command Description No


Number of Inputs Display the Dialog Number of Inputs in order to modify the 19
number of inputs of e.g. an AND or an OR function. This
menu item is enabled only for components with variable
(extensible) number of parameters,

Change Type Display the Dialog Change Type in order to change the type 20
of a symbol component object - without loosing
connections. E.g. change an AND into an OR. This menu
item is enabled only for symbol objects, not for aspect
objects.

Variable Properties Display the Dialog Variable Properties in order to rename a 21


variable, diagram reference, or diagram parameter, to
change its data type and variable attributes. This menu item
is enabled only for variables, diagram references, and
diagram parameters.

Connection Mapping Displays the Connection Mapping dialog in order to map 22


connections between different structured data types.

Goto Nested Diagram Equals menu command View > Nested Diagram. 23

Goto Reference Opens the Goto Reference dialog to select and navigate to 24
an off-diagram reference on another diagram.

Connect To Diagram Variable Opens the Connect To Diagram Variable dialog to define a 25
connection to an off-diagram reference on another diagram.

Disconnect from Diagram Variable Opens the Disconnect From Diagram Variable dialog to 26
remove a connection to an off-diagram reference on
another diagram.

Number of Diagram References Opens the Number of Diagram References dialog to define 27
the maximum number of diagram references displayed in
one column. This menu item is enabled only for diagram
references.

Show Type (1) Navigates to the object type in Object Type Structure 28

<Aspect> Opens the <Aspect> dialog for the current Aspect Object. 29

References If the Aspect Object has cross-references, for example the 30


Aspect Object could be included in a graphic display, the
display's name is shown when you select this item

3BDS011224R4101 425
Context Menus Section 4 Graphic Editor Reference

Table 48. Function component context menu commands

Menu Command Description No


Advanced Engineering Workplace only: Open Engineering Workplace 31
Advanced menu with some useful commands for I/O
Allocation, Bulk Data Manager, Document Manager, and
Structure operations.

Properties Opens the Properties dialog for the selected aspect object, 32
if any.

(1) All menu items from here on are part of the dynamic System 800xA Aspect Object menu.

Graphic Component Context Menu


Right mouse click on a graphic component (e.g. a primitive) to open the following
context menu:

The menu items are described in Table 49.

Link Component Context


Right mouse click on a link component that connects two symbol ports to open the
following context menu:

426 3BDS011224R4101
Section 4 Graphic Editor Reference Context Menus

The menu items are described in Table 49.

Symbol Port Context Menu


Right mouse click on a symbol port to open the following context menu:

The menu items are described in Table 49:

Table 49. Graphic Component, Link, Port Context Menu Commands

Menu Command Description No


Cut Equals menu command Edit > Cut. 1

Copy Equals menu command Edit > Copy. 2

Paste Equals menu command Edit > Paste. 3

Delete Equals menu command Edit > Delete. 4

Order > Bring Forward Equals menu command Layout > Order > Bring Forward. 5

Order > Bring to Front Equals menu command Layout > Order > Bring to Front. 6

Order > Send Backward Equals menu command Layout > Order > Send Backward. 7

Order > Send to Back Equals menu command Layout > Order > Send to Back. 8

Grouping > Group Equals menu command Layout > Group. 9

Grouping > Ungroup Equals menu command Layout > Ungroup. 10

Add To Display List Equals menu command Online > Add to Display List. (Links and ports 11
only).

Remove from Display Equals menu command Online > Remove from Display List. (Links 12
List and ports only).

3BDS011224R4101 427
Context Menus Section 4 Graphic Editor Reference

Table 49. Graphic Component, Link, Port Context Menu Commands

Menu Command Description No


Variable Name Opens the Dialog Variable Name in order to check the mapped and 13
generated variable name (Links only).

Connection Mapping Opens the Connection Mapping dialog in order to map connections 14
between structured data types.

Aspect Properties Equals menu command Edit > Aspect Properties (Ports only). 15

Component Properties Equals menu command Edit > Default Properties. 16

Hide Port(s) Hides the selected port(s), see Show/Hide Ports (Ports only) 17

Toolbar Context Menu


Click right in the Menu/Toolbar area to open the following context menu:

428 3BDS011224R4101
Section 4 Graphic Editor Reference Context Menus

The menu items are described in Table 50:

Table 50. Toolbar Context Menu Commands

Menu Command Description No


Output Window Show/Hide the Output Window either as docked window or as floating 1
popup window. The Output Window lists results from the File > Check and
File > Generate Configuration Data (Full Build) commands.

Structure Browser 1 Show/Hide the Structure Browser 1 Window either as docked window or 2
as floating popup window. The Structure Browser Window can be used as
an alternative to Plant Explorer’s object browser window.

Structure Browser 2 Show/Hide the Structure Browser 2 Window either as docked window or 3
as floating popup window. The Structure Browser Window can be used as
an alternative to Plant Explorer’s object browser window.

Watch Window Show/Hide the Watch Window either as docked window or as floating 4
popup window. The Watch Window displays and sets on-line values from
any OPC server, see On-line Display.

Standard Show/Hide the Standard toolbar with commands New, Open, Save, 5
Print...

Drawing Show/Hide the Drawing toolbar with commands Select, Line, Rectangle, 6
Port, Text, Label...

View Show/Hide the View toolbar with commands Layer, Zoom, Pan, Grid. 7

Page Show/Hide the Page toolbar with commands New Page, Delete Page, 8
Goto Page.

Align Show/Hide the Align toolbar with commands Align Top, Middle, Left,,, 9

Nudge Show/Hide the Nudge toolbar with commands Nudge Up, Down, Left, 10
Right.

Rotate Show/Hide the Rotate toolbar with commands Rotate and Flip. 11

Structure Show/Hide the Structure toolbar with commands Group, Ungroup, Bring 12
to Front, Send to Back.

Layout Show/Hide the Layout toolbar with commands Space Across, Same 13
Width...

Selection Show/Hide the Selection toolbar with commands for multi selection and 14
network/symbol traversal.

3BDS011224R4101 429
Context Menus Section 4 Graphic Editor Reference

Table 50. Toolbar Context Menu Commands

Menu Command Description No


Allocation Show/Hide the Allocation toolbar. with commands Select/Create/Delete 15
Allocatable Group, Define Data Flow Order.

Connection Show/Hide the Connection toolbar with commands Connect, 16


Disconnect, Invert.

Vertical Scrollbar Context Menu


Right click on a horizontal scroll bar to open the following context menu:

The menu items are described in Table 51.

Table 51. Vertical Scrollbar Context Menu Commands

Menu Command Description No


Scroll Here Moves the scroll bar to the current cursor location. 1

Top Moves the scroll bar to the top. 2

Bottom Moves the scroll bar to the bottom. 3

Page Up Moves the scroll bar one page division up. Same as click above the scroll 4
bar.

Page Down Moves the scroll bar one page division down. Same as click below of 5
scroll bar.

Scroll Up Moves the scroll bar one division up. Same as click on up arrow. 6

Scroll Down Moves the scroll bar one division down. Same as click on down arrow. 7

430 3BDS011224R4101
Section 4 Graphic Editor Reference Context Menus

Horizontal Scrollbar Context Menu


Right click right on a horizontal scroll bar to open the following context menu:

The menu items are described in Table 52.

Table 52. Horizontal Scrollbar Context Menu Commands

Menu Command Description No


Scroll Here Moves the scroll bar to the current cursor location. 1

Left Edge Moves the scroll bar to the left edge. 2

Right Edge Moves the scroll bar to the right edge. 3

Page Left Moves the scroll bar one page division left. Same as click left of scroll bar. 4

Page Right Moves the scroll bar one page division right. Same as click right of scroll 5
bar.

Scroll Left Moves the scroll bar one division left. Same as click on left arrow. 6

Scroll Right Moves the scroll bar one division right. Same as click on right arrow. 7

Output Window Context Menu


Right click on the Output Window’s Output or Build page to open the following
context menu:

3BDS011224R4101 431
Working with Toolbars Section 4 Graphic Editor Reference

The menu items are described in Table 53.

Table 53. Output Window Context Menu Commands

Menu Command Description No


Undo Equals menu command Edit > Undo. 1

Cut Equals menu command Edit > Cut. 2

Copy Equals menu command Edit > Copy. 3

Paste Equals menu command Edit > Paste. 4

Delete Equals menu command Edit > Delete. 5

Select All Equals menu command Edit > Select All. 6

Dockable Window Context Menu


Click right on a Structure Browser’s or Output Window’s border/tab to open the
following context menu:

The menu items are described in Table 54:

Table 54. Dockable Window Context Menu Commands

Menu Command Description No


Allow Docking Allows docking of the window/toolbar within the main window. 1

Hide Hides the window/toolbar, 2

Clear Window Clear the window contents (only available for some dockable 3
windows, for example the Output window)

Working with Toolbars


Via Toolbar Categories, you get access to different useful commands by clicking on
the appropriate button you need at the moment. These commands are mostly

432 3BDS011224R4101
Section 4 Graphic Editor Reference Customize

accessible via an appropriate menu command, too. Use the Customize to turn on or
off the display of toolbars, or to create own toolbars.
You can have different toolbar settings in the Diagram view and the Component
view, in the preview window and overlap (separate) window.

Customize
Use the Customize dialog for:
• Showing/Hiding Toolbars
• Creating a User-Defined Toolbars
• Adding Tool Buttons to Toolbars
• Deleting a User-Defined Toolbar
• Changing the Look of Toolbars
• Showing Tooltips
Open this dialog via the menu command View > Toolbar > Customize. The dialog
contains the following two pages:
• Toolbars
• Toolbar Commands
The Customize dialog contains the following buttons common for all of its pages:
• OK
Click OK to save your settings and to close the dialog.
• Cancel
Click Cancel to quit the dialog without saving your setting modifications..

3BDS011224R4101 433
Customize Section 4 Graphic Editor Reference

Toolbars
Click on the Toolbars tab of the Customize dialog to display the Toolbars page.

Figure 248. Customize dialog: Toolbars page

The Toolbars page of the Customize dialog contains the following fields, buttons,
and other items:
• Toolbars (tab)
Click the Toolbars tab to display the Toolbars page with all available toolbars.
See also Working with Toolbars
• Toolbars
In the Toolbars list box, all available toolbars are listed. You can select
multiple toolbars to display them in the application’s main window.

434 3BDS011224R4101
Section 4 Graphic Editor Reference Customize

Mark or un-mark the appropriate check boxes (except the Menu bar which is
protected against un-marking) to turn on or off the display.
See also Toolbar Categories
See also Showing/Hiding Toolbars
• Toolbar name
The Toolbar name field displays the name of the toolbar selected in the
Toolbars list box. If a user-defined toolbar is selected, the name can be
changed here.
See also Renaming a User-Defined Toolbar
• Show Tooltips
Mark or unmark this check box to turn on or off the display of the tooltips. The
tooltips are short context-sensitive description texts displayed in small popup
boxes with a yellow background if you point to a button of a toolbar.
See also Showing Tooltips.
• Cool Look
Mark or unmark this check box to turn on or off the display of the tool buttons
in the Cool Look manner.
See also Changing the Look of Toolbars.
• Large Buttons
Mark or unmark this check box to turn on or off the display of large buttons.
See also Changing the Look of Toolbars.

3BDS011224R4101 435
Customize Section 4 Graphic Editor Reference

• New
Click this button to open the New Toolbar dialog for creating a new user-
defined toolbar.

Figure 249. New Toolbar dialog

See also Creating a User-Defined Toolbars.


• Reset
Click this button to reset the layout of the current selected system toolbar to the
original state.
See also Adding Tool Buttons to Toolbars.
• Delete
Click this button to delete the current selected user-defined toolbar.
See also Deleting a User-Defined Toolbar.

436 3BDS011224R4101
Section 4 Graphic Editor Reference Customize

Toolbar Commands
Click on the Toolbar Commands tab of the Customize dialog to display the
Toolbar Commands page.

Figure 250. Customize dialog, Toolbar Commands page

The Toolbar Commands property sheet of the Customize contains the following
fields, buttons, and other items:
• Toolbar Commands
Click this tab to display the Toolbar Commands page for getting access to the
tool buttons (commands) in the Buttons area. From here, you can copy tool
buttons to each existing toolbar.
See also Adding Tool Buttons to Toolbars.

3BDS011224R4101 437
Toolbar Categories Section 4 Graphic Editor Reference

• Categories
Displays all available Toolbar Categories delivered with the Function
Designer. Select the wanted toolbar to display the buttons belonging to it.
See also Adding Tool Buttons to Toolbars.
• Buttons
Displays the tool buttons of the currently selected toolbar.
• Description
Displays the description of the currently selected tool button.

Toolbar Categories
The Function Designer offers the following toolbars (toolbar categories):
• Standard
The Standard toolbar contains commands for handling the whole diagram like
saving and printing, and it contains commands for handling components like
copying and saving. You will find the most commands also as menu commands
of the File and Edit menu.
• Drawing
The Drawing toolbar contains commands for inserting graphic objects
(primitives, symbols, and so on) and their handling within the diagram (e.g
snapping to grid).
You will find the most commands also as menu commands of the Insert and
View menu.
• View
The View toolbar contains commands for the layer handling and for zooming
the diagram’s/component’s display. You will find the most commands also as
menu commands of the View menu.
• Page
The Page toolbar contains commands for creating pages and for navigation
between pages. You will find the command for creating a page also as menu
command in the Insert menu.

438 3BDS011224R4101
Section 4 Graphic Editor Reference Toolbar Categories

• Align
The Align toolbar contains commands for aligning components within the
diagram. You will find the commands also as menu commands of the Layout
menu.
• Nudge
The Nugde toolbar contains commands for nudging components within the
diagram You will not find the commands also as menu commands.
• Rotate
The Rotate toolbar contains commands for rotating and flipping components.
You will find the commands also as menu commands of the Layout menu.
• Structure
The Structure toolbar contains commands for moving components to back or to
front, and to group components. You will find the commands also as menu
commands of the Layout menu.
• Layout
The Layout toolbar contains commands for spacing and sizing components.
You will find the commands also as menu commands of the Layout menu.
• Selection
The Selection toolbar contains commands for choosing the selection mode of
components. You will not find the commands as menu commands but it is
possible to execute these commands via keys.
• Allocation
The Allocation toolbar contains commands for allocating function components
and defining their data flow order. You will find the commands also as menu
commands of the Allocation menu.
• Connection
The Connection toolbar contains commands for connecting, disconnecting, and
inverting ports.

3BDS011224R4101 439
Toolbar Categories Section 4 Graphic Editor Reference

Standard
The Standard toolbar of the Toolbar Categories contains the following tool
buttons:

Opens the New Function Component dialog to create a new


component, component template, or XML type definition.
Opens the Open Aspect dialog to open any
component/diagram document, or any other aspect.
Saves the current component/ diagram document into the
function aspect.
Saves all open component/ diagram documents.
Cuts the selection to the clipboard.
Copies the selection to the clipboard.
Inserts the clipboards contents.
Deletes the selected item(s).
Undoes the last action.
Redoes the previously undone action.
Prints the active component/ diagram document, and
optionally child diagrams.
Display program information, version number and copyright.
Display help for clicked on buttons, menus and windows.

440 3BDS011224R4101
Section 4 Graphic Editor Reference Toolbar Categories

Drawing
The Drawing toolbar of the Toolbar Categories contains the following tool
buttons:

Select or move components.


Edit individual link vertices.
Opens the Component Properties dialog to set graphical properties.
Draws a single line.
Draws a multi-segmented line.
Draws a polygon.
Draws a rectangle.
Draws a series of connected curves.
Draws a polycurve with connecting start and end points.
Draws an ellipse.
Inserts text.
Inserts a label.
Inserts a picture.
Inserts an ActiveX component.

Inserts a circle port.


Inserts a line port.

3BDS011224R4101 441
Toolbar Categories Section 4 Graphic Editor Reference

View
The View toolbar of the Toolbar Categories contains the following tool buttons:

Enables/Disables “ActiveX Run


Mode”
Enables/Disables “Snap To Grid”
Shows/Hides grid
Pan canvas.
Zoom so that all components of
the current selection are visible.
Zooms so that all components
are visible.
Zoom in or out.
Sets active layer to Master Page
Layer.
Sets active layer to Background
Layer.
Sets active layer to Logic Layer.
Sets active layer to Annotation
Layer.
Sets Layer Properties.

442 3BDS011224R4101
Section 4 Graphic Editor Reference Toolbar Categories

Page
The Page toolbar of the Toolbar Categories contains the following tool buttons:

Page Comments.
Delete Page.
Creates a Page.
Go to last page.
Go to next page.
Go to selected page.
Go to previous page.
Go to first page.

Align
The Align toolbar of the Toolbar Categories contains the following tool buttons:

Aligns top.
Aligns middle.
Aligns bottom.
Aligns left.
Aligns centered.
Aligns right.

3BDS011224R4101 443
Toolbar Categories Section 4 Graphic Editor Reference

Nugde
The Nudge toolbar of the Toolbar Categories contains the following tool buttons:

Nudges up.
Nudges down.
Nudges left.
Nudges right.

Rotate
The Rotate toolbar of the Toolbar Categories contains the following tool buttons:

Rotates components.
Rotates 90 degrees counter clockwise.
Rotates 90 degrees clockwise.
Flips around the vertical center.
Flips around the horizontal center.

Structure
The Structure toolbar of the Toolbar Categories contains the following tool
buttons:

Groups components.
Ungroups components.
Brings to front.
Sends to back.
Brings forward.
Sends backward.

444 3BDS011224R4101
Section 4 Graphic Editor Reference Toolbar Categories

Layout
The Layout toolbar of the Toolbar Categories contains the following tool buttons:

Spaces components horizontally.


Spaces components vertically.
Makes components in the same width.
Makes components in the same height.
Makes components in the same size.

Selection
The Selection toolbar of the Toolbar Categories contains the following tool
buttons:

Toggle contiguous rectangular/linear multiple selection.


Toggle network/symbol traversal.

3BDS011224R4101 445
Toolbar Categories Section 4 Graphic Editor Reference

Allocation
The Allocation toolbar of the Toolbar Categories contains the following tool
buttons:

Define Data Flow Order.


Show Allocation Details.
Delete allocatable group.
Create allocatable group.
Active allocatable group.

Connection
The Connection toolbar of the Toolbar Categories contains the following tool
buttons:

Disconnect complete network.


Disconnected selected port only.
Invert selected port.
Cancel connect string.
Enter connect string
Connect string combo box.

446 3BDS011224R4101
Section 4 Graphic Editor Reference Showing/Hiding Toolbars

Showing/Hiding Toolbars
To display the wanted toolbars in the main window, do as follows:
1. Open the Customize dialog.
2. Mark or un-mark the wanted toolbars for display:
– To turn on the display of a toolbar, mark the appropriate check box.
– To turn off the display of a toolbar, un-mark the appropriate check box.
3. Click OK.
Alternatively, to show or hide a toolbar, do as follows:
1. Right-click into the free grey area anywhere of the menu bar or toolbar area. A
pop-up menu will appear, displaying all available toolbars.
2. To turn on or off the display of a toolbar, click on it. All marked toolbars will
be displayed.

Figure 251. Context menu for dockable toolbar/window selection

3BDS011224R4101 447
Creating a User-Defined Toolbars Section 4 Graphic Editor Reference

Creating a User-Defined Toolbars


To create a new, user-defined toolbar, do as follows:
1. Open the Customize dialog.
2. Click New on the Toolbar tab. The New Toolbar dialog appears.
3. Enter the name for the new toolbar in the Toolbar name field.
4. Click OK.

The new (yet empty) toolbar is created as separate window on the application’s
main window with the toolbar name as window title. For adding tools (buttons)
to the toolbar, see Section , Graphic Editor Reference.

Adding Tool Buttons to Toolbars


To add tool buttons to a toolbar, do as follows:
1. Open the Customize dialog.
2. Click on the Toolbar Commands tab.
3. Select the toolbar with the wanted tool button from the Categories list box.
4. Drag-and-drop the wanted tool button from the Buttons group box to the target
toolbar out of the Customize dialog.
5. Click OK.

448 3BDS011224R4101
Section 4 Graphic Editor Reference Adding Tool Buttons to Toolbars

Newly created toolbar Customized toolbar (1)


1 2

Customized toolbar (2)

Drag-and-drop

1
Adding Tool Buttons

2
Removing Tool Buttons

Figure 252. Collating a toolbar (adding/removing tool buttons)

3BDS011224R4101 449
Removing Tool Buttons from a Toolbar Section 4 Graphic Editor Reference

Removing Tool Buttons from a Toolbar


To remove tool buttons from a toolbar, do as follows:
1. Open the Customize dialog.
2. Point to the tool button within the toolbar from where it shall be removed,
drag-and-drop it out of the toolbar
3. Click OK to close Customize dialog.

Removing tool buttons from a toolbar is only possible if the Customize dialog is
open.

Resetting the Composition of a Toolbar


To reset a system (not user-defined) toolbar to its original composition, do as
follows:
1. Open the Customize dialog.
2. Click on the Toolbar Commands tab.
3. From the Categories list box, select the (system) toolbar to be resetted.
4. Click Reset.
5. Click OK.

Resetting is only possible for system toolbars not for user-defined toolbars.

Renaming a User-Defined Toolbar


To rename a user-defined toolbar, do as follows:
1. Open the Customize dialog.
2. Select the wanted toolbar from the Toolbars list box on the Toolbars page.
3. Rename the toolbar in the Toolbar name field.
4. Click OK.

450 3BDS011224R4101
Section 4 Graphic Editor Reference Deleting a User-Defined Toolbar

Deleting a User-Defined Toolbar


To delete a user-defined toolbar, do as follows:
1. Open the Customize dialog.
2. Select the wanted toolbar from the Toolbars list box on the Toolbars page.
3. Click Delete.
4. Click OK.

Changing the Look of Toolbars


You can display the toolbar buttons in a Cool Look manner. Then, the buttons looks
like as follows:

Toolbar with Cool Look

Toolbar without Cool Look

To change the look of the toolbars, do as follows:


1. Open the Customize dialog.
2. Depending on the wanted look, mark or un-mark the Cool Look check box:
– To turn on the Cool Look display, mark the check box.
– To turn off the Cool Look display, un-mark the check box.
3. Click OK.

Showing Tooltips
Tooltips are short context-sensitive descriptions of the toolbar buttons. A tooltip is
displayed on pointing to the appropriate toolbar button.

tooltip

3BDS011224R4101 451
General Accelerator Keys Section 4 Graphic Editor Reference

To turn on or off the display of the tooltips, do as follows:


1. Open the Customize dialog.
2. Mark or un-mark the Show Tooltips check box:
– To turn on showing tooltips, mark the check box.
– To turn off showing tooltips, un-mark the check box.
3. Click OK.

General Accelerator Keys


The following table lists the general accelerator keys for having quick access to
certain functions.

Table 55.

Key Context Description


Cursor key (up, down, on symbols Symbol traversal: Selects prev/next symbol
right left) according to graphical order

on ports Network traversal: Selects prev/next port or


connection link according to graphical order
on connection links Network traversal: Selects prev/next port or
connection link according to graphical order
SHIFT + left click on symbols Contiguous multiple selection
on ports Contiguous multiple selection
SHIFT + cursor key on symbols Contiguous multiple selection
(up, down, right, left)
on ports Contiguous multiple selection
SHIFT + left drag on symbols Moves selected symbols only in x/y direction
on symbol Sizes selected symbols and keep aspect ratio
selection handle
on empty area Selects (only) symbols in the selection rectangle
(selection rectangle)

452 3BDS011224R4101
Section 4 Graphic Editor Reference General Accelerator Keys

Table 55.

Key Context Description


CTRL + left click on symbols Disjoint multi selection
on ports Disjoint multi selection
on connection links Multi selection
on link vertex Removes link vertex
CTRL + cursor on symbols Disjoint multi selection
on ports Disjoint multi selection
on connection links Disjoint multi selection
CTRL + left drag on symbols Copies selected symbols
on symbol Sizes selected symbols and keep center
selection handle
on empty area Selects only connections in the selection
(selection rectangle) rectangle
Shift + Ctrl + left click on link vertex freeze / unfreeze link vertex
Shift + Ctrl + left drag on function Insert function component(s) from/into another
component(s) structure
ALT + left click on port Connects marked port to this port
on selected Inserts link vertex
connection link
ALT + left drag on symbols Moves selected symbols, ignore grid setting
on symbol Sizes selected symbols, ignore grid setting
selection handle
on empty area Selects only ports in the selection rectangle
(selection rectangle)
Space + cursor on selected objects Moves selected objects by cursor keys 1/10 of
the module (Nudge)
N + cursor

3BDS011224R4101 453
General Accelerator Keys Section 4 Graphic Editor Reference

Table 55.

Key Context Description


Space + SHIFT + cursor on selected objects Moves selected objects by cursor keys 1/2 of the
module (Nudge)
N + SHIFT + cursor
P + left drag - Pan diagram by mouse
P + cursor Pan diagram by cursor keys 1/10 of the module
P + SHIFT + cursor Pan diagram by cursor keys 1/2 of the module
NUMPAD “5” on symbols Toggles cursor key navigation context from
symbol traversal to network traversal
on ports/connection Toggles cursor key navigation context from
links network traversal to symbol traversal
NUMPAD “-” on ports Marks this port for connection
ALT + NUMPAD “-” on ports Connects this port to marked port by keyboard
DEL on symbols Deletes selected symbol(s)
on ports Deletes selected port(s)
on connection links Deletes selected connection(s) (disconnect)
F2 The MMS Editor Rename sender/receiver diagrams and access
variables
Change cycle time
CTRL+F5 The MMS Editor Print the tree with MMS configuration data.
CTRL+F6 The MMS Editor Copy the tree contents with MMS configuration
data onto the clipboard.
CTRL+right arrow The MMS Editor Expand the selected tree node.

454 3BDS011224R4101
Section 4 Graphic Editor Reference New/Open Aspect

New/Open Aspect
Creating a New Function Aspect
Function Designer creates and handles Aspect Objects (components and diagrams)
in Functional Structure and in Object Type Structure. So make sure to select one of
these structures in Plant Explorer’ object browser.
To create a new function aspect, do one of the following methods:
• Right click on an Aspect Object in Plant Explorer to open its context menu and
choose New Aspect... (see Figure 253).
• Right click on the background of an Aspect Objects Aspect list and choose
New Aspect... from the context menu (see Figure 253)..

aspects background
context menu

object’s context menu

Figure 253. New Aspect context menu command

3BDS011224R4101 455
New Function Component Section 4 Graphic Editor Reference

New Function Component


Select a function aspect from the Plant Explorer’s Aspect list, and open its
Component view. In general, a newly created function aspect has an empty
Component view.
In Function Designer, use File > New menu command to create a new function
component or to overwrite data from an already existing one.
The New dialog is opened. It offers the following options (see Figure 254):
• Select Component to create or overwrite a complete function component
definition including fixed graphical symbol with ports, and a fixed parameter
set.
• Select Component Template to create or overwrite a function component
template, i.e. a graphical symbol template. On instantiation in a function
diagram, a complete graphical symbol and ports are automatically created on
base of this template and on the actual parameter set.
• Select XML Type Definition to create or overwrite an XML based type
definition including a fixed and extensible set of parameters. On instantiation in
a function diagram, parameters are automatically created on base of this type
definition. Typically used together with a function component template to
define object types.

Figure 254. New (function component) dialog

456 3BDS011224R4101
Section 4 Graphic Editor Reference New Function Diagram

New Function Diagram


Select the function aspect from the Plant Explorer’s Aspect list, and open its
Diagram view. In general, newly created function aspects have an empty Diagram
view.
In Function Designer, use File > New menu command to create new function
diagrams or to overwrite already existing ones. The Select Master Page Template
dialog is opened. It offers the following options (see Figure 255):
• Copy or reference a predefined template for the master page layer with header
and footer like A3, A4 portrait / landscape.
• Or select a blank diagram.

Figure 255. Templates dialog

3BDS011224R4101 457
New Function Diagram Section 4 Graphic Editor Reference

You can add additional templates or customize installed ones in Object Type
Structure under Object Types\Functional Planning\Diagram Templates, see also
Name.Description of that object type group and Figure 256.

Figure 256. Diagram Templates in Object Type Structure

If you reference a template, the diagram’s master page layer is read-only.That means
• header/footer entries like author, document number, cannot be edited inside the
diagram, but are referenced as aspect properties from a Function Diagram
Document aspect, see Figure 257.
• diagram instances with referenced templates get automatically updated when
the template changes.
If you copy a template, the diagram’s master page layer is writable. That means
• header/footer entries like author, document number, can be edited directly
inside the diagram, but can also be referenced as aspect properties from another
aspect.
• diagram instances with copied templates do NOT get automatically updated
when the template changes.

458 3BDS011224R4101
Section 4 Graphic Editor Reference New Function Diagram

Figure 257. Footer Texts with References to Function Diagram Document Aspect

3BDS011224R4101 459
New Function Diagram Section 4 Graphic Editor Reference

The predefined templates in Figure 255 and Figure 256 reference a Function
Diagram Document aspect. If this aspect is missing, you will get unresolved
references in the footer, see Figure 258.

Figure 258. Unresolved references in diagram footer

In that case, create a Function Diagram Document Aspect, see Figure 259.

Figure 259. New Function Diagram Document Aspect

460 3BDS011224R4101
Section 4 Graphic Editor Reference New Function Diagram

You can also create new Function diagrams from predefined diagram types based on
diagram templates, see Figure 260. In that case, the Function Diagram Document
Aspect is created automatically, i.e. copied from the predefined object type.

Figure 260. Predefined diagram types based on diagram templates

3BDS011224R4101 461
Open Aspect Section 4 Graphic Editor Reference

Open Aspect
Use the Open Aspect dialog to open an aspect of any Aspect Object. Open the
dialog by choosing Function Designer’s File > Open menu command:

Figure 261. Open Aspect dialog

The Open Aspect dialog is similar to the common File Open dialog. Instead of
selecting a file, you select an aspect to open.
You do this by browsing through structures and Aspect Object hierarchies as you do
it in the common File Open dialog when browsing through directories. Aspect
Objects display a folder icon, and Aspects display their aspect icon.
• On top level, the Look in drop-down box offers all 800xA system structures.
• You select a structure to display all Aspect Objects on root level of the selected
structure
• You select an Aspect Object to display all its aspects and child Aspect Objects.

462 3BDS011224R4101
Section 4 Graphic Editor Reference Inserting/Creating Components

Inserting/Creating Components
There are different workflows while inserting/creating components:
• In Component view,
– you insert/create graphic components (e.g. primitives) to define a function
component symbol respectively the type of it.
• In Diagram view,
– you create new function component Aspect Objects in Functional
Structure. Typically, you drag & drop an object type with a function aspect
from Object Type Structure into the logic layer of a function diagram.
– you insert an existing function component Aspect Object from another
structure. Typically, you Shift+Ctrl drag & drop the Aspect Object from
e.g. Control Structure into a function diagram.
– you insert/create graphic components, e.g. primitives, on the master page,
logic, background, or annotation layer.
• From Diagram view,
– you insert an existing function component Aspect Object into another
structure. Typically, you Shift+Ctrl drag & drop the Aspect Object from
the function diagram e.g. into Control Structure.
– you can even insert function component Aspect Objects into Bulk Data
Manager. Typically, you drag & drop the Aspect Objects from the function
diagram into a MS Excel sheet with activated Bulk Data Manager.

General Procedure for Inserting/Creating a Graphic Component in


Component/Diagram View
To insert/create a graphic component, do as follows:
1. Select a graphic component to be inserted in a diagram by toolbar or menu
command.
2. Press the left mouse button on the diagram where you want to insert the graphic
component. This point will be the graphic components’s upper left corner.
3. Move the mouse to define the graphic components’s size/length/direction.

3BDS011224R4101 463
Inserting/Creating Components Section 4 Graphic Editor Reference

4. Release the mouse button.

The graphic component(s) is (are) sized according to the modifier key(s). In


general,
– SHIFT locks the aspect ratio (sizes equally in both x and y direction)
– CTRL draws component centered on point where you started
– ALT ignores grid setting.

Table 56. Modifier Keys for inserting/creating graphic components

Key Description
None Size
SHIFT Size and keep aspect ratio
CTRL Size and center to starting point
SHIFT+CTRL Size, keep aspect ratio, and center to starting point
ALT Size and ignore grid setting
ALT+SHIFT Size, keep aspect ratio, and ignore grid setting
ALT+CTRL Size, center to starting point, and ignore grid setting
ALT+SHIFT+CTRL Size, keep aspect ratio, center to starting point, and ignore
grid setting

You can insert the following graphic components:


• Inserting Graphic Primitives (Component View and Diagram View)
• Inserting Text Components (Component View and Diagram View)
• Inserting Label Components (Component View and Diagram View)
• Inserting Ports (Component View only)
• Inserting Pictures/Images (Component View and Diagram View)
• Inserting ActiveX Controls (Component View and Diagram View)

464 3BDS011224R4101
Section 4 Graphic Editor Reference Inserting/Creating Components

• Inserting Graphic Elements build with Graphics Builder (Component View and
Diagram View)

General Procedure for Inserting a Function Component in Diagram View


To create a new function component Aspect Object, do as follows:
1. Select an object type with function aspect from Object Type Structure.
2. Drag & Drop it into the function diagram.
3. A new Aspect Object gets created in Functional Structure.
4. Its symbol gets displayed on the function diagram.

To insert an existing function component Aspect Object into a function diagram, do


as follows:
1. Select an Aspect Object with function aspect from any structure, except Object
Type Structure and Functional Structure (because insert of a function
component in two function diagrams is not supported).
2. Hold down the Shift+Ctrl keys while dragging and dropping it into the function
diagram. These are the same modifier keys as used in Plant Explorer to insert
Aspect Objects.
3. The Aspect Object gets inserted into Functional Structure.
4. Its symbol gets displayed on the function diagram.

To insert an existing function component Aspect Object from the function diagram
into another structure, e.g. Control Structure, do as follows:
1. Select a function component on the function diagram.
2. Hold down the Shift+Ctrl keys while dragging and dropping it from the
function diagram into another structure. These are the same modifier keys as
used in Plant Explorer to insert Aspect Objects.

3BDS011224R4101 465
Inserting Graphic Primitives Section 4 Graphic Editor Reference

3. The Aspect Object gets inserted into the other structure.

Table 57. Modifier Keys for inserting/creating function components

Key Description
None Create function component from Object Type
Structure.
Move function component into other structure, or
into other diagram
CTRL Copy function component
SHIFT+CTRL Insert function component into/from another
structure

It can happen unintentionally that a component gets removed from the diagram
and from Functional Structure by just moving the component outside the diagram
frame. In effect, the component gets moved from the diagram to some structure
that is selected in the structure browser. An according warning is given in this
case

Inserting Graphic Primitives


If you insert graphic primitives in Component view or in the Diagram view, the
cursor appearance will give you information about the allowed drop location. In that
case, the cursor will change its appearance from an arrow to a plus sign. After
insertion has finished, the cursor’s appearance is reset to an arrow. The inserted
graphic primitive is displayed with its vertices.
Inserting a graphic primitive means one of the following items:
• Inserting a Line
• Inserting a Polyline
• Inserting a Polygon
• Inserting a Rectangle
• Inserting a Polycurve
• Inserting a Closed Curve

466 3BDS011224R4101
Section 4 Graphic Editor Reference Inserting Graphic Primitives

• Inserting an Ellipse

Inserting a Line
To insert a line, do as follows:
1. Choose the menu command Insert > Graphic > Lines or click the appropriate
toolbar button.
2. Move the cursor to the source point on the diagram.
3. Press the mouse button on the source point of the line, drag it to the target point
and then release it. The line is displayed with its vertices.

Figure 262. Line

Inserting a Polyline
To insert a polyline, do as follows:
1. Choose the menu command Insert > Graphic > Polyline or click the
appropriate toolbar button.
2. Move the cursor to the source point on the diagram.
3. Click on the source point, move the mouse to the next wanted vertices of the
polyline, click there and so on until to the target point.

3BDS011224R4101 467
Inserting Graphic Primitives Section 4 Graphic Editor Reference

4. Click once more on the target point to indicate the end of the polyline. The
polyline is displayed with its vertices.

Figure 263. Polyline

Inserting a Polygon
To insert a polygon, do as follows:
1. Choose the menu command Insert > Graphic > Polygon or click the
appropriate toolbar button.
2. Move the cursor to the source point on the diagram.
3. Click on the source point, move the mouse to the next wanted vertices of the
polygon, click there and so on until to the target point.
On drawing the polygon, you always see a preview of the current state.
4. Click once more on the target point to indicate the end of the polygon.

Figure 264. Polyline preview/finished

Inserting a Rectangle
To insert a rectangle, do as follows:

468 3BDS011224R4101
Section 4 Graphic Editor Reference Inserting Graphic Primitives

1. Choose the menu command Insert > Graphic > Rectangle or click the
appropriate toolbar button.
2. Move the cursor to the source point on the diagram.
3. Press the mouse button on the source point of the line, drag it to the target point
and then release it.
On dragging the mouse, you see a preview of the rectangle.

Figure 265. Rectangle

Inserting a Polycurve
To insert a polycurve, do as follows:
1. Choose the menu command Insert > Graphic > Poly Curve or click the
appropriate toolbar button.
2. Move the cursor to the source point on the diagram.
3. Click on the source point, move the mouse to the next wanted vertices of the
polyline, click there and so on until to the target point.

3BDS011224R4101 469
Inserting Graphic Primitives Section 4 Graphic Editor Reference

4. Click once more on the target point to indicate the end of the polycurve. The
polyline is displayed with its vertices.

Figure 266. Polycurve preview/finished

Inserting a Closed Curve


To insert a closed curve, do as follows:
1. Choose the menu command Insert > Graphic > Closed Curve or click the
appropriate toolbar button.
2. Move the cursor to the source point on the diagram.
3. Click on the source point, move the mouse to the next wanted vertices of the
curve, click there and so on until to the target point which must be identical to
the source point.
4. Click once more on the target point to indicate closing of the curve.

Figure 267. Closed Curve preview/finished

470 3BDS011224R4101
Section 4 Graphic Editor Reference Inserting Text Components

Inserting an Ellipse
To insert a ellipse, do as follows:
1. Choose the menu command Insert > Graphic > Ellipse or click the
appropriate toolbar button.
2. Move the cursor to the source point on the diagram.
3. Press the mouse button on the source point of the ellipse, drag it to the target
point and then release it. On dragging the mouse, you see a preview of the
ellipse.

Figure 268. Ellipse

Inserting Text Components


To insert a text component, do as follows:
1. Choose the menu command Insert > Text or click the appropriate toolbar
button.
2. Click on the place in the diagram where the text component shall be inserted.
3. In-cell edit the text string inside the text component.
4. Modify the text component properties to define fonts, alignment, multiple lines
with word wrapping etc.

Inserting Label Components


Labels are special text components which are associated with an owner component,
a symbol or a (connection) link. Labels get positioned in relation to their owner.

3BDS011224R4101 471
Inserting Label Components Section 4 Graphic Editor Reference

When you move a symbol or a link, its label(s) are also moved. However, labels can
be selected, moved, and modified independently of their owner.
The label’s orientation property tells the label to position itself at one of nine
orientation points around the owner symbol or owner link. You can also define how
much distance there should be between a label and its owner.

To label a symbol
1. Choose menu command Insert > Label or click in the Drawing toolbar.
The cursor changes to .
2. In Diagram view, click inside a symbol where you want to associate and
position the label. A label component gets created.
In Component view, click on any place in the symbol definition where the label
shall be inserted. A label component gets created.

To label a link (connection line)


1. Choose menu command Insert > Label or click in the Drawing toolbar.
The cursor changes to .
2. Click on the link where you want to associate and position the label. A label
component with default name gets created.
3. To modify the default link name,
– double-click the label and modify the name directly, or
– right click on the link to open its context menu, choose Component
Properties and modify the name in the Name field on the General page
of the Component Properties dialog.

472 3BDS011224R4101
Section 4 Graphic Editor Reference Inserting Ports

The link will now have the name of the label as displayed in the following figure:

Label = Link name

Link

Figure 269. Labeled link

Inserting Ports
A port defines a location on a symbol at which other symbol ports can be connected
to. A port always belongs to exactly one symbol, and can be visible or invisible.
Ports can be used to create connections between any two symbols.
Ports can only be defined in Component view.
1. Open the Function Designer’s Component View.
2. Click the appropriate toolbar button from the Drawing toolbar or choose the
corresponding menu command Insert > Circle Port or Insert > Line Port.
3. A circle port consists of just a circle ’hot spot’ to connect to. To insert a circle
port, simply click on the place in the symbol definition, where you want to
insert the port.
4. A line port consists of a line and a circle ’hot spot’ to connect to. To insert a
line port, press and hold the mouse button on the place in the symbol definition
where you want to start the line port, drag the mouse and release the button

3BDS011224R4101 473
Inserting Pictures/Images Section 4 Graphic Editor Reference

where the line port’s circle ’hot spot’ shall end.


Thus to insert an ’input’ line port at the left side of a symbol definition, drag
the mouse from right to left, and to insert an ’output’ port at the right side of a
symbol definition, drag the mouse from left to right.

Inserting Pictures/Images
To insert a picture/image, do as follows:
1. Click the Image button from the Drawing toolbar or choose the Insert >
Picture menu command.
2. From the displayed standard File Open dialog, select the wanted picture/image
in either .bmp, .wmf or .dib format.
3. Click Open. The dialog is closed and the mouse pointer changes to .
4. Click on the place in the diagram where you want to insert the image.

Open
Use this standard dialog to open a file such as a picture/image for inserting it into a
symbol definition or into a diagram.

474 3BDS011224R4101
Section 4 Graphic Editor Reference Inserting ActiveX Controls

Access this dialog via the menu commands Insert > Picture or via the appropriate
toolbar button.

Figure 270. Open dialog

• Open
Click Open to confirm the image selection for inserting the file (for example,
an image file) into the active diagram.
• Cancel
Click Cancel to quit the dialog without inserting an image.

Inserting ActiveX Controls


To insert an ActiveX Control, do as follows:

3BDS011224R4101 475
Inserting Graphic Elements build with Graphics Builder Section 4 Graphic Editor Reference

1. Click the ActiveX button from the Drawing toolbar or choose the Insert >
ActiveX menu command. The Insert ActiveX Control dialog appears:

Figure 271. Insert ActiveX Control

2. Select the wanted ActiveX Control from the list.


3. Click OK. The dialog is closed and the mouse pointer changes to .
4. Click on the place in the diagram where you want to insert the ActiveX
Control.

Inserting Graphic Elements build with Graphics Builder


To insert a graphic element built with Graphics Builder, do as follows:
1. Click the ActiveX button from the Drawing toolbar or choose the Insert >
ActiveX menu command. The Insert ActiveX Control dialog appears.

476 3BDS011224R4101
Section 4 Graphic Editor Reference Inserting Function Components

2. Select the page Graphic Elements:

Figure 272. Insert Graphic Elements

3. Select the wanted graphic element from the list.


4. Click OK. The dialog is closed and the mouse pointer changes to .
5. Click on the place in the diagram where you want to insert the graphic element.

Inserting Function Components


Function components can be inserted into a function diagram by creating new
instances from an object type in Object Type Structure, or by inserting existing
Aspect Objects from other structures (for example, from Control Structure).

3BDS011224R4101 477
Inserting Function Components Section 4 Graphic Editor Reference

Inserting Function Components from Object Type Structure


To insert new function components from Object Type Structure into a function
diagram, choose one of the following methods:
• Inserting via drag & drop
• Inserting via menu command

Inserting via drag & drop


1. Select Object Type Structure from any Structure Browser of Function Designer
or from the object browser of Plant Explorer.
2. Choose the wanted object type from Object Type Structure.
3. Drag the object type to the wanted location in the diagram and drop it.

478 3BDS011224R4101
Section 4 Graphic Editor Reference Inserting Function Components

4. An optional New Component Name dialog gets displayed in order to accept or


change the proposed default name and to define the data flow order of the new
function component, see Figure 351.

Drag & Drop


Object Type

Figure 273. Drag & Drop from Object Type Structure to function diagram

After having dropped the object type in the diagram, a new function component
object is created (instantiated) in the function diagram. According to the object
type’s Create Info definition, an Aspect Object is created (instantiated) as child of

3BDS011224R4101 479
Inserting Function Components Section 4 Graphic Editor Reference

the diagram object in Functional Structure. For more details refer to Object Type
Definition Create Info.

Automatically Updated
Functional Structure

Figure 274. Automatically updated Functional Structure

Inserting via menu command


1. Choose menu command Insert > Symbol. The Insert Objects dialog appears.
2. On the Object Type page, select the wanted structure (for example, Functional
Structure, Object Type Structure) from the drop-down list.
3. Select the wanted object type with a function aspect from the list.
4. An optional New Component Name dialog gets displayed in order to accept or
change the proposed default name and to define the data flow order of the new
function component, see Figure 351.

480 3BDS011224R4101
Section 4 Graphic Editor Reference Inserting Function Components

5. A new function component object is created (instantiated) and automatically


placed in the function diagram at the next free location. If necessary, a new
page is created. According to the object type’s create info definition, a new
Aspect Object is created (instantiated) as child of the diagram object in
Functional Structure. For more details refer to Object Type Definition Create
Info.
6. If you want to apply several function components, click Apply and continue
with step 3.
If you want to apply only one function component, click OK.

Insert Objects
Use this dialog to insert function components by selecting them from the
appropriate structure browser on the dialog’s Object Types page.
Open this dialog via the menu command Insert > Symbol.

Figure 275. Insert Objects dialog

3BDS011224R4101 481
Viewing Components Section 4 Graphic Editor Reference

• OK
Click OK to apply the selected object to the active diagram and close the
dialog.
• Cancel
Click Cancel to quit the dialog without applying the selected object.
• Apply
Click Apply to apply (auto-insert) the selected object to the active diagram and
leave the dialog open.
• Help
Click Help to get dialog-specific help.

Inserting Function Components from/into Other Structures

Inserting into other structures


It is often useful to place function component Aspect Objects also in other structures
than in Functional Structure, for example, to allocate I/O signals in Control
Structure.
To insert Aspect Objects from a diagram into another structure, use drag-and-drop
with SHIFT+CTRL.

Inserting from other structures


To insert existing Aspect Objects from other structures, for example, already
allocated I/O signals from Control Structure into a function diagram, and thus into
Functional Structure, use drag-and-drop with SHIFT+CTRL.

Viewing Components
If you have complex function component definitions or complex diagrams, it is very
important to have a possibility to find and display that part of the diagram you are
just interested in. Function Designer offers comfortable Zoom and Pan functionality.

482 3BDS011224R4101
Section 4 Graphic Editor Reference Zoom

Using them, you will always have an optimal view and good overview on your
diagrams.

Zoom
Zooming means to scale up or down the display of an arbitrary area in Function
Designer’s Diagram/Component. Zooming is supported by several menu and
toolbar commands described in the following.

Zoom Normal
Choose the View > Zoom Normal menu command to zoom to set (reset) the default
size of components (100%). All other zoom values refer to that size.

Zoom Percent
Function Designer offers some predefined values for zooming accessible via menu
commands or from a context menu:

Zoom Percent via menu commands


Choose one of the following Zoom Percent menu commands to zoom to the
corresponding size:
• View > Zoom Percent > 50%
• View > Zoom Percent > 75%
• View > Zoom Percent > 100% (Normal)
• View > Zoom Percent > 200%

Zoom Percent via context menu


Right-click in an empty area (not on a component) and choose one of the following
commands from the context menu:
• Zoom > 50%
• Zoom > 75%
• Zoom > 100%

3BDS011224R4101 483
Zoom Section 4 Graphic Editor Reference

• Zoom > 200%

Zoom Custom
You can adjust an arbitrary value for zooming the display of components. For it,
open the Zoom dialog by choosing the View > Zoom Custom menu command and
enter the wanted value in the Magnification % field or choose one of the
predefined values from the drop-down list box.

Zoom to Fit
Zoom to fit means to display all available components of the function aspect’s
Diagram view/Component view. You get this overview by doing one of the
following alternatives:
• Choose the menu command View > Zoom to Fit
• Choose Zoom > Zoom to Fit from the context menu
• Choose the Zoom to Fit toolbar command.

Zoom to Fit

Figure 276. View: Zoom to Fit

484 3BDS011224R4101
Section 4 Graphic Editor Reference Pan

Zoom to Selection
Zoom to selection means to display all selected components maximum sized in the
current window. Choose this command to display the wanted selection in the
optimal (maximum) size.

Zoom to Selection

Figure 277. View: Zoom to Selection

Zoom in steps via Mouse


It is possible to zoom via mouse. Do this as follows:
1. Click the Zoom button from the View toolbar. The cursor in the
Diagram/Component view changes to .
2. Zoom by mouse-clicks as follows:
– To zoom increasing, click left onto the area you want to have centered
after zooming.
– To zoom decreasing, click right onto the area you want to have centered
after zooming.

Pan
Using the Pan functionality means to move the whole content of the
diagram/component document within the corresponding window.

3BDS011224R4101 485
Selecting Components Section 4 Graphic Editor Reference

It can be easier to use the Pan functionality than to configure the wanted area via the
horizontal and vertical scroll bars.
To use the Pan functionality, do as follows:
1. Click the Pan button from the View toolbar. The cursor in the
Diagram/Component view changes to .
2. Move the cursor to the center of the area you want to move.
3. Press the left mouse button and move the diagram/component document to the
wanted location.
4. Release the mouse button.

Selecting Components
You can select or unselect one or multiple components by mouse or by keyboard in
the drawing area of the active layer in the active view. The selection can include
components on one page or on multiple pages. Selected components are highlighted
and define the context for commands like move, delete, cut, copy, and so on.
The components displayed in the drawing area are ordered by the top-left
coordinates of their surrounding rectangle in the sense of top to bottom and left to
right. Assuming the coordinates (x, y)=(0, 0) at the top-left corner and x growing to
the right and y growing to the bottom, a component precedes another one
• if it is located above (lower y value)
• if it is located to the left (lower x value)
This order is called graphical order. Independent from that, there might exist some
logical order, for example, the insertion or data flow order of symbols.

Selection always follows the graphical order, not the logical order.

Multiple Selection
Multiple selection (multi-selection) includes only components of the same type.
Following type-specific selections are possible:

486 3BDS011224R4101
Section 4 Graphic Editor Reference Selecting Components

• Selecting Symbols
• Selecting Ports
• Selecting Connections
Symbols, ports and connections are selected according to the modifier key(s). In
general,
– None (without pressing any key) selects all symbols, ports and
connections lying completely inside the selection rectangle
– SHIFT filters and selects symbols only
– CTRL filters and selects connections only
– ALT filters and selects ports only

Table 58. Modifier keys for selecting by dragging a selection rectangle

Key Description
None Select all objects inside selection rectangle
SHIFT Select symbols only
CTRL Select connections only
SHIFT+CTRL Select symbols and connections only
ALT Select ports only
ALT+SHIFT Select ports and symbols only
ALT+CTRL Select ports and connections only
ALT+SHIFT+CTR Select all (As None)
L

When switching between different layers or splitter views (windows), the


selection data is kept per layer and view.

3BDS011224R4101 487
Selecting Components Section 4 Graphic Editor Reference

Anchor and Focus


Selected components are highlighted by their selection handles. One of the selected
components will be the anchor, one will have the (input) focus. The component
having the focus is indicated by a focus rectangle as shown in the following figure:

focus rectangle
selection handle
(vertex)

Figure 278. Selection handles and focus rectangle

• On multiple selection via mouse,


– the anchor will be the upper left selected component and
– the lower right component will have the focus.
• On multiple selection via keyboard,
– the anchor will be the first selected component and
– the last selected component will have the focus.

Contiguous Multiple Selection


For selecting several contiguous components, you have the following methods:
• Contiguous rectangular multiple selection:
This kind of multiple selection is rectangle oriented. The selected area on a
diagram is determined by a rectangle given from the coordinates of the
selection start point (anchor) and the selection endpoint (focus, diagonal of the
rectangle).
• Contiguous linear multiple selection:
This kind of multiple selection is row oriented (as selecting text in MS Word or
any other word processing system). The selected area on a diagram is
determined by the graphical order of the components. All objects between
(according to graphical order) the anchor and the component having the focus

488 3BDS011224R4101
Section 4 Graphic Editor Reference Selecting Symbols

will be selected.

The behavior for contiguous multiple selection can be set via of the toolbar:
• Button pressed means contiguous multiple linear selection
• Button not pressed means contiguous multiple rectangle selection.

The behavior for network/symbol traversal with cursor keys can be set via
of the toolbar or by selecting a port/symbol:
• Button pressed means network traversal (ports and connection links)
• Button not pressed means symbol traversal.

Disjoint selection
Using mouse and keyboard modifiers, it is also possible to disjointedly select
components (see also General Accelerator Keys).

Selecting Symbols
For selecting symbols, you have the following possibilities:
• Selecting Single Symbols
• Contiguous Rectangular Multiple Selection of Symbols
• Contiguous Linear Multiple Selection of Symbols
• Selecting Symbols via the Components Dialog

Selecting Single Symbols


To select single symbols (not in graphical order) from the Function Designer
window, choose one of the following methods:
• To select only one symbol, simply click it.

3BDS011224R4101 489
Selecting Symbols Section 4 Graphic Editor Reference

• To select several symbols, click the first symbols, press and hold the CTRL
key, and then click the other wanted symbols.

Figure 279. Selection of single symbols

Contiguous Rectangular Multiple Selection of Symbols


To select contiguous symbols within a rectangular diagram area, you have two
methods:
• Selecting symbols by defining a rectangle selection via mouse
• Selecting symbols by defining a rectangle selection via keyboard

All relevant symbols must be located totally in the selection rectangle

Selecting symbols by defining a rectangle selection via mouse


1. Press left mouse button on some background in the drawing area.
2. Move the mouse and drag a selection rectangle as needed

490 3BDS011224R4101
Section 4 Graphic Editor Reference Selecting Symbols

3. Release the mouse button.

Anchor

Selection
Rectangle
Focus

Figure 280. Contiguous rectangular multiple selection

Selecting symbols by defining a rectangle selection via keyboard


1. Select the anchor symbol by clicking on it.
2. Switch to the Contiguous Rectangular Multiple Selection mode by clicking
of the Selection toolbar (button/icon must be released)
3. Press SHIFT and select the symbol defining the other (diagonal) end of the
selection rectangle. You can do this via mouse or using the cursor keys. This
symbol automatically gets the focus.

3BDS011224R4101 491
Selecting Symbols Section 4 Graphic Editor Reference

Contiguous Linear Multiple Selection of Symbols


To select all symbols, located in the horizontal (diagram) stripe between two
symbols, the anchor symbol and the symbols having (getting) the focus, do as
follows:
1. Select the anchor symbol by clicking on it.
2. Switch to the Contiguous Linear Multiple Selection mode by clicking of
the Selection toolbar (button/icon must be pressed)
3. Press SHIFT and select the symbols defining the other end of the selection
stripe. This symbol automatically gets the focus.

Anchor

Focus

Figure 281. Contiguous linear multiple selection of symbols

492 3BDS011224R4101
Section 4 Graphic Editor Reference Selecting Ports

Selecting Symbols via the Components Dialog


To select symbols from the Components dialog’s list box, do as follows:
• To select only one symbol (component) from the list, simply click it.
• To select several series listed symbols, click the first symbol of the series, then
press and hold the Shift key, and then click the last symbol of the series. All
symbols of the series will be highlighted.
• To select several symbols not listed in series. Press and hold the CTRL key,
then click the wanted symbols.

This kind of selection doesn’t mark the selected symbols with vertices inside the
diagram.

Selecting Ports
For selecting ports, you have the following possibilities:
• Selecting Single Ports
• Contiguous rectangular multiple selection of Ports
• Contiguous linear multiple selection of Ports

Selecting Single Ports


To select single ports (not in graphical order) from the Function Designer window,
choose one of the following methods:
• To select only one port, simply click it.

3BDS011224R4101 493
Selecting Ports Section 4 Graphic Editor Reference

• To select several ports, click the first port, then press and hold the CTRL key,
and click the other wanted ports.

Figure 282. Selection of single ports

Contiguous rectangular multiple selection of Ports


To select the contiguous ports within a rectangular diagram area, you have two
methods:
• Selecting symbols by defining a rectangle selection via mouse
• Selecting symbols by defining a rectangle selection via keyboard

All relevant ports must be located totally in the selection rectangle.

Selecting ports by defining a rectangle selection via mouse


1. Press left mouse button on some background in the drawing area.

494 3BDS011224R4101
Section 4 Graphic Editor Reference Selecting Ports

2. Press ALT, move the mouse and drag a selection rectangle as needed
3. Release the mouse button and ALT key.

Selection
Rectangle

Figure 283. Contiguous rectangular multiple selection of ports via mouse

Selecting ports by defining a rectangle selection via keyboard


1. Select the anchor port by clicking on it.
2. Switch to the Contiguous Rectangular Multiple Selection mode by clicking
of the Selection toolbar (button/icon must be released)

3BDS011224R4101 495
Selecting Ports Section 4 Graphic Editor Reference

3. Press SHIFT and select the port defining the other (diagonal) end of the
selection rectangle. You can do this via mouse or using the cursor keys.

Anchor

Focus

Figure 284. Contiguous rectangular multiple selection of ports via keyboard

Contiguous linear multiple selection of Ports


To select all ports, located in the horizontal (diagram) stripe between two ports, the
anchor port and the port having (getting) the focus, do as follows:
1. Select the anchor port by clicking on it.
2. Switch to the Contiguous Linear Multiple Selection mode by clicking of
the Selection toolbar (button/icon must be pressed)

496 3BDS011224R4101
Section 4 Graphic Editor Reference Selecting Connections

3. Press SHIFT and select the port defining the other end of the selection stripe.
This port automatically gets the focus.

Anchor

Focus

Figure 285. Contiguous linear multiple selection of ports

Selecting Connections
For selecting connections, you have the following possibilities:
• Selecting Single Connections
• Contiguous Rectangular Multiple Selection of Connections
• Contiguous linear multiple selection of Ports

Selecting Single Connections


To select single connections (not in graphical order) from the Function Designer
window, choose one of the following methods:
• To select only one connection, simply click it.

3BDS011224R4101 497
Selecting Connections Section 4 Graphic Editor Reference

• To select several connections, click the first connection, then press and hold the
CTRL key, and click the other wanted connections.

Figure 286. Selection of single connections

Contiguous Rectangular Multiple Selection of Connections


To select the contiguous connections within a rectangular diagram area, you have
two methods:
• Selecting symbols by defining a rectangle selection via mouse
• Selecting symbols by defining a rectangle selection via keyboard

All relevant connections must be located totally in the selection rectangle

Selecting connections by defining a rectangle selection via mouse


1. Press left mouse button on some background in the drawing area.

498 3BDS011224R4101
Section 4 Graphic Editor Reference Selecting Connections

2. Press CTRL, move the mouse and drag a selection rectangle as needed
3. Release the mouse button and CTRL key.

Selection
Rectangle

Figure 287. Contiguous rectangular multiple selection of connections via mouse

Selecting connections by defining a rectangle selection via keyboard


1. Select the anchor connection by clicking on it.
2. Switch to the Contiguous Rectangular Multiple Selection mode by clicking
of the Selection toolbar (button/icon must be released)
3. Press SHIFT and select the connection defining the other (diagonal) end of the
selection rectangle. You can do this via mouse (click on the target connection)
or using the cursor keys.

3BDS011224R4101 499
Layout of Components Section 4 Graphic Editor Reference

Contiguous Linear Multiple Selection of Connections


To select all connections, located in the horizontal (diagram) stripe between two
connections, the anchor connection and the connection having (getting) the focus,
do as follows:
1. Select the anchor connection by clicking on it.
2. Switch to the Contiguous Linear Multiple Selection mode by clicking of
the Selection toolbar (button/icon must be pressed)
3. Press SHIFT and select the connection defining the other end of the selection
stripe. This connection automatically gets the focus.

Layout of Components
For manipulating the layout of components, Function Designer offers the following
methods:
• Grid
• Move
• Size
• Align
• Rotate
• Flip
• Order
• Group

Grid
Working with a grid is useful for positioning components on same levels
(horizontally or vertically). To enable and adjusting a grid, use the Grid Properties
dialog.

Grid Properties
The Grid Properties dialog allows you to set

500 3BDS011224R4101
Section 4 Graphic Editor Reference Grid

Access this dialog via the View > Grid Properties menu command.

Figure 288. Grid Properties dialog

• OK
Click OK to save your settings and to close the dialog..
• Cancel
Click Cancel to quit the dialog without saving your setting modifications.
• Grid Visible
Mark this check box to make the grid visible. Otherwise unmark it.
• Snap to Grid
Mark this check box to snap to the grid on creating, moving, or copying
components. Otherwise unmark it.
• Angle Snap
Mark this check box to snap to the grid on rotating components.
• Grid Color
Click on the drop-down list box to open the Color dialog for selecting the grid
color.

3BDS011224R4101 501
Move Section 4 Graphic Editor Reference

• Grid Spacing
Groups the fields for entering the grid spacing values.
• Horizontal
Enter the value for horizontal grid spacing. The unit is adjusted in the Printing
dialog.
• Vertical
Enter the value for vertical grid spacing. The unit is adjusted in the Printing
dialog.

Move
For moving components, choose one of the following methods:
• To move components via drag-and-drop with left mouse
• To move components via drag-and-drop with right mouse

If components are moved between different diagrams, the Functional Structure is


updated automatically.
See also:
• To cut and paste components inside function diagram via context menu.
• To cut and paste components inside function diagram via menu command.

To move components via drag-and-drop with left mouse


1. Select the wanted components (see page 486, Selecting Components)
2. Press the left mouse button on one of the selected components.
3. Moves the mouse.
4. Release the mouse button.
The selected component(s) are moved according to the modifier key(s):
– SHIFT moves only in x/y direction relative to center

502 3BDS011224R4101
Section 4 Graphic Editor Reference Move

– ALT ignores grid setting.

Table 59. Modifier keys for moving components via left mouse

Key Description
None Move
SHIFT Move only in x/y direction relative to
center
ALT Move, ignore grid setting
ALT+SHIFT Move only in x/y direction relative to
center, ignore grid setting

To move components via drag-and-drop with right mouse


1. Select the wanted components (see page 486, Selecting Components)
2. Press the right mouse button on one of the selected components.
3. Move the mouse to drag the selected component(s).
4. Release the mouse button. A context menu is displayed.
5. Choose Move Here from the context menu.

Table 60. Modifier keys for right mouse handling

Key Description
None Displays context menu:
Move Here
Copy Here
Cancel
SHIFT Moves only in x/y direction relative to center.
Displays context menu:
Move Here
Copy Here
Cancel

3BDS011224R4101 503
Size Section 4 Graphic Editor Reference

Table 60. Modifier keys for right mouse handling

Key Description
CTRL As None
SHIFT+CTRL As CTRL, ignore SHIFT
ALT Ignores grid setting.
Display context menu:
Move Here
Copy Here
Cancel.
ALT+SHIFT Ignore grid setting and move only in x/y direction
relative to center.
Display context menu:
Move Here
Copy Here
Cancel.
ALT+CTRL As None
ALT+SHIFT+CTR As ALT+CTRL, ignore SHIFT
L

Size
To change the size of components, do as follows:
1. Press the left mouse button on a selection handle (vertex) of selected
component(s)
2. Moves the mouse.
3. Release the mouse button.

The component(s) is (are) sized according to the used modifier key(s):


– SHIFT locks the aspect ratio (sizes equally in both x and y direction)
– CTRL sizes keeping the component(s) center

504 3BDS011224R4101
Section 4 Graphic Editor Reference Align

– ALT ignores grid setting

Table 61. Modifier Keys for sizing components

Key Description
None Size
SHIFT Size and keep aspect ratio
CTRL Size and keep center
SHIFT+CTRL Size and keep aspect ratio and keep center
ALT Size, ignore grid setting
ALT+SHIFT Size and keep aspect ratio, ignore grid setting
ALT+CTRL Size and keep center, ignore grid setting
ALT+SHIFT+CTR Size and keep aspect ratio and keep center, ignore
L grid setting

Align
To align selected components, Function Designer offers you the following methods:
For vertically aligning:
• Align Left
• Align Center
• Align Right
For horizontally aligning:
• Align Top
• Align Middle
• Align Bottom

3BDS011224R4101 505
Align Section 4 Graphic Editor Reference

One of the selected components is the anchor component. A dashed border


indicates the anchor component. All other components will be aligned with the
anchor component.

Align Left
To align selected components vertically with the left side of the anchor component,
choose the menu command Layout > Align > Left.

anchor
component

align left

Figure 289. Aligning components left

506 3BDS011224R4101
Section 4 Graphic Editor Reference Align

Align Center
To align selected components vertically with the center of the anchor component,
choose the menu command Layout > Align > Center.

anchor
component

align center

Figure 290. Aligning components center

Align Right
To align selected components vertically with the right side of the anchor component,
choose the menu command Layout > Align > Right.

anchor
component

align right

Figure 291. Aligning components right

3BDS011224R4101 507
Align Section 4 Graphic Editor Reference

Align Top
To align selected components horizontally with the top side of the anchor
component, choose the menu command Layout > Align > Top.

anchor
component align top

Figure 292. Aligning components top

Align Middle
Choose this menu command to align horizontally the selected components with the
center of the anchor component.To align selected components horizontally with the
middle of the anchor component, choose the menu command Layout > Align >
Middle.

anchor align middle


component

Figure 293. Aligning components middle

508 3BDS011224R4101
Section 4 Graphic Editor Reference Rotate

Align Bottom
To align selected components horizontally with the bottom side of the anchor
component, choose the menu command Layout > Align > Bottom.

anchor align bottom


component

Figure 294. Aligning components middle

Rotate
Function Designer provides menu and toolbar commands for rotating components:
• Rotate Free
• Rotate Right
• Rotate Left

Rotate Free
To rotate a component freely, do as follows:
1. Choose the Layout > Rotate > Free menu command or the command
from the Rotate toolbar.
2. Point on a component (single, selection, group). The cursor changes to .
3. Press the left mouse key and move the mouse until the component’s preview is
displayed with the wanted rotating angle.

3BDS011224R4101 509
Flip Section 4 Graphic Editor Reference

4. Leave the mouse button.

Component’s Preview

Figure 295. Component rotating free

Rotate Left
To rotate the selected components by 90 degrees to the left, choose the Layout >
Rotate > Left menu command or the command from the Rotate toolbar.

Rotate Right
To rotate the selected components by 90 degrees to the right, choose the Layout >
Rotate > Right menu command or the command from the Rotate toolbar.

Flip
Function Designer provides menu and toolbar commands for flipping components:
• Flip Horizontal
• Flip Vertical

510 3BDS011224R4101
Section 4 Graphic Editor Reference Order

Flip Horizontal
To flip the selected components horizontally, choose the Layout > Flip >
Horizontal menu command or the command from the Rotate toolbar.

Figure 296. Flip Horizontal

Flip Vertical
To flip the selected components vertically, choose the Layout > Flip > Vertical
menu command or the command from the Rotate toolbar.

Figure 297. Flip Vertical

Order
Function Designer provides menu and toolbar commands for ordering components
within the diagram/component document:
• Bring to Front means to move a component in the foreground of the
diagram/component document so that no other component could overlap
(cover) it.
• Send to Back means to move a component in the background of the
diagram/component document so that all other components would overlap
(cover) it.

3BDS011224R4101 511
Order Section 4 Graphic Editor Reference

• Bring Forward means to move a component one level higher (forward) within
the internal component order of the diagram/component document.
• Send Backward means to move a component one level lower (backward)
within the internal component order of the diagram/component document.

Because moving a component forward/backward regards all components of a


diagram/component document, it can be that nothing seems to happen on
executing the Bring Forward/Send Backward command. This is the case if the
order of non-overlapping components is changed.

Bring to Front
To bring a component to front (to the highest level), select a component and choose
one of the following methods:
• Choose the Layout > Order > Bring to Front menu command.
• Click the Structure toolbar button .
• Choose the Order > Bring to Front command of the Graphic Component
Context Menu/Function Component Context Menu context menu.

Bring green rectangle to front

Send green rectangle to back

Figure 298. Component structure order: Bring to front / send to back

512 3BDS011224R4101
Section 4 Graphic Editor Reference Order

Send to Back
To send a component to back (to the lowest level), select it and choose one of the
following methods:
• Choose the Layout > Order > Send to Back menu command.
• Click the Structure toolbar button .
• Choose the Order > Send to Back command of the Graphic Component
Context Menu/Function Component Context Menu context menu (see
Figure 298).

Bring Forward
To bring a component forward (to the next higher level), select it and choose one of
the following methods:
• Choose the Layout > Order > Bring Forward menu command.
• Click the Structure toolbar button .
• Choose the Order > Bring Forward command of the Graphic Component
Context Menu/Function Component Context Menu context menu.

Bring green rectangle forward

Send green rectangle backward

Figure 299. Component structure order: Bring forward / send backward

3BDS011224R4101 513
Group Section 4 Graphic Editor Reference

Send Backward
To bring a component backward (to the next lower level), select it and choose one of
the following methods:
• Choose the Layout > Order > Send Backward menu command.
• Click the Structure toolbar button .
• Choose the Order > Send Backward command of the Graphic Component
Context Menu/Function Component Context Menu context menu (see
Figure 299).

Group
Several selected components can be grouped or ungrouped:
• Group several components to handle them as one component.
• Ungroup a component group to handle each component separated.

Group
To group several components, select them and choose one of the following methods:
• Choose the Layout > Group menu command.
• Click the Structure toolbar button .
• Choose the Grouping > Group command of the Graphic Component
Context Menu/Function Component Context Menu context menu.

Ungroup
To ungroup a component group, select the group and choose one of the following
methods:
• Choose the Layout > Ungroup menu command.
• Click the Structure toolbar button .
• Choose the Grouping > Ungroup command of the Graphic Component
Context Menu/Function Component Context Menu context menu.

514 3BDS011224R4101
Section 4 Graphic Editor Reference Cut/Copy/Paste/Delete Components

Cut/Copy/Paste/Delete Components
There are different workflows while cutting/copying/pasting/deleting components:
• In Component view,
– you cut/copy/paste/delete graphic components (primitives) to define a
function component symbol or symbol template.
• In Diagram view,
– you cut/copy/paste/delete function components within the diagram.
Functional Structure gets automatically updated for function component
Aspect Objects.
– you paste function components copied from another diagram or from
Functional Structure. Functional Structure gets automatically updated for
function component Aspect Objects.
– you cut/copy/paste/delete graphic components on the master page, logic,
background, or annotation layer.
• From Diagram view,
– you cut/copy function components, to paste them into another function
diagram or into the Functional Structure. Functional Structure gets
automatically updated for function component Aspect Objects.
In each case, the following actions are possible:
• Cut and Paste
• Copy and Paste
• Delete

The behavior on pasting symbols respectively connection links depends on the


settings done in the Options dialog (see Paste).

Cut and Paste


To cut and paste components via menu commands, use one of the following
methods:

3BDS011224R4101 515
Cut and Paste Section 4 Graphic Editor Reference

• To cut and paste components inside function diagram via context menu
• To cut and paste components inside function diagram via menu command
You can also move components via drag & drop. For it, see also:
• To move components via drag-and-drop with left mouse
• To move components via drag-and-drop with right mouse

To cut and paste components inside function diagram via context menu
1. Select the wanted components (see page 486, Selecting Components)
2. Click right over the selected components and choose Cut from the Graphic
Component Context Menu.
3. Click right on the wanted target location.
4. Choose Paste from the Graphic Component Context Menu.

To cut and paste components inside function diagram via menu command
1. Select the wanted components (see page 486, Selecting Components)
2. Choose the menu command Edit > Cut. The selected components are removed
from the diagram/component document window and copied to the Clipboard.
3. Click on the wanted target location.
4. Choose the menu command Edit > Paste. The selected components are pasted
from the Clipboard.

If step 3 is left, the pasted components are located into the upper left corner of the
diagram/component window.
Cut/Paste Function Blocks and Control Modules in Function Diagram:
On contrast to Delete, Cut in the diagram does NOT delete the Control Structure
aspect, only the Functional Structure aspect. A Paste will create a "copy" of the
Function Block / Control Module.

516 3BDS011224R4101
Section 4 Graphic Editor Reference Copy and Paste

Copy and Paste


To copy and paste components inside a function diagram, use one of the following
methods:
• To copy components inside function diagram via left mouse drag and drop
• To copy components inside function diagram via right mouse drag-and-drop
• To copy components inside function diagram via context menu
• To copy components inside function diagram via menu command

The Functional Structure is updated automatically for function component


Aspect Objects. See more detailed, Object Type Definition Create Info
To copy and paste function component Aspect Objects inside Functional Structure,
use one of the following methods:
• To copy a function component Aspect Object inside Functional Structure via
drag and drop
• To copy a function component Aspect Object inside Functional Structure via
context menu

To copy components inside function diagram via left mouse drag and drop
1. Select the wanted components (see page 486, Selecting Components)
2. Press the left mouse button on one of the selected components.
3. Press CTRL and moves the mouse to the wanted location.
4. Release CTRL key and mouse button.
The selected component(s) are copied according to the modifier key(s):

3BDS011224R4101 517
Copy and Paste Section 4 Graphic Editor Reference

– ALT ignores grid setting.

Table 62. Modifier keys for copying components via left mouse

Key Description
CTRL Copy
SHIFT+CTRL As CTRL, ignore SHIFT
ALT+CTRL Copy, ignore grid setting
ALT+SHIFT+CTRL As ALT+CTRL, ignore SHIFT

To copy components inside function diagram via right mouse drag-and-drop


1. Select the wanted components (see page 486, Selecting Components)
2. Press the right mouse button on one of the selected components.
3. Move the mouse to drag the selected component(s).
4. Release the mouse button. A context menu is displayed.
5. Choose Copy Here from the context menu.

Table 63. Modifier keys for moving via right mouse key

Key Description
None Displays context menu:
Move Here
Copy Here
Cancel
SHIFT Moves only in x/y direction relative to center.
Displays context menu:
Move Here
Copy Here
Cancel
CTRL As None

518 3BDS011224R4101
Section 4 Graphic Editor Reference Copy and Paste

Table 63. Modifier keys for moving via right mouse key

Key Description
SHIFT+CTRL As CTRL, ignore SHIFT
ALT Ignores grid setting.
Display context menu:
Move Here
Copy Here
Cancel.
ALT+SHIFT Ignore grid setting and move only in x/y direction
relative to center.
Display context menu:
Move Here
Copy Here
Cancel.
ALT+CTRL As None
ALT+SHIFT+CTR As ALT+CTRL, ignore SHIFT
L

To copy components inside function diagram via context menu


1. Select the wanted components (see page 486, Selecting Components)
2. Click right over the selected components and choose Copy from the Graphic
Component Context Menu.
3. Click right on the wanted target location.
4. Choose Paste from the Graphic Component Context Menu.

To copy components inside function diagram via menu command


1. Select the wanted components (see page 486, Selecting Components)
2. Choose the menu command Edit > Copy. The selected components are copied
to the Clipboard.

3BDS011224R4101 519
Copy and Paste Section 4 Graphic Editor Reference

3. Click on the wanted target location.


4. Choose the menu command Edit > Paste. The selected components are pasted
from the Clipboard.

If step 3 is left, the pasted components are located moved a little bit right down
from the components’ source location to make the copied components
conspicuously.

To copy a function component Aspect Object inside Functional Structure via


drag and drop
1. Open the Functional Structure in the Engineering Studio Workplace.
2. Select the wanted object (component).
3. Drag the object and drop it on the wanted target location in the Functional
Structure.

The copied function component is automatically inserted in the function diagram.

To copy a function component Aspect Object inside Functional Structure via


context menu
1. Open the Functional Structure in the Engineering Studio Workplace.
2. Select the wanted object (component).
3. Click right and choose Copy from the context menu.
4. Select the target location (object with function aspect) in the Functional
Structure.
5. Click right and choose Paste from the context menu.

The copied function component is automatically inserted in the function diagram.

520 3BDS011224R4101
Section 4 Graphic Editor Reference Paste Options

Paste Options
If you copy (or cut and paste) a selected range of function components, you can
define which links (connections) from, to, or within the selection shall be copied
together with the function components. The following variants (or combinations of
them) are possible:
• Copying Function Components without Links
• Copying Function Components including Internal Links
• Copying function components including External Input Links
• Copying function components including External Output Links

Copying Function Components without Links


To copy a selected range of function components without any links, unmark all
check boxes as displayed in the following figure:

3BDS011224R4101 521
Paste Options Section 4 Graphic Editor Reference

Figure 301 displays the result of copying a selected range of components (copy of
Symbol2+3 to Symbol5+6):

Copied Range

Without Pasted Range


Links

Figure 300. Paste Option for Internal Links

522 3BDS011224R4101
Section 4 Graphic Editor Reference Paste Options

Copying Function Components including Internal Links


To copy a selected range of function components including internal links, mark the
Internal Links in the Copied/Pasted Range check box of the paste options. The
following figure displays an example for it (copy of Symbol2+3 to Symbol5+6):

Internal
Links
Copied Range

Pasted Range

Figure 301. Paste Option for Internal Links, Example

3BDS011224R4101 523
Paste Options Section 4 Graphic Editor Reference

Copying function components including External Input Links


To copy a selected range of function components including internal links, mark the
Internal Links in the Copied/Pasted Range check box of the paste options. The
following figure displays an example for it (copy of Symbol2+3 to Symbol5+6):

Copied Range

External
Input Links

Pasted Range

Figure 302. Paste Option for External Input Links

524 3BDS011224R4101
Section 4 Graphic Editor Reference Delete

Copying function components including External Output Links


To copy a selected range of function components including internal links, mark the
Internal Links in the Copied/Pasted Range check box of the paste options. The
following figure displays an example for it (copy of Symbol2+3 to Symbol5+6):

Copied Range

External
Input Links

Pasted Range

Figure 303. Paste Option for External Output Links

Delete
To delete components, choose one of the following methods:
• To delete components from a function diagram
• To delete function components from the Functional Structure
• To delete components via Components dialog

3BDS011224R4101 525
Delete Section 4 Graphic Editor Reference

you can do it directly from the diagram, or you can use the Component Properties
dialog:

To delete components from a function diagram


1. Select the wanted component(s). See page 486, Selecting Components.
2. Click the DEL key, or choose Edit > Delete.
The object is automatically removed from the Functional Structure.

To delete function components from the Functional Structure


1. Open the Functional Structure in the Engineering Studio Workplace
2. Choose the component to be deleted.
3. Click right and choose Delete from the object-specific context menu.
The object is automatically removed from the function diagram.

To delete components via Components dialog


1. Open the Components dialog.
2. Select the wanted component(s) from the list box.
(See also page 493, Selecting Symbols via the Components Dialog.
3. Click Delete.

526 3BDS011224R4101
Section 4 Graphic Editor Reference Defining Component Properties

4. Click OK.
Delete Function Block or Control Module: Function Blocks and Control Modules
get inserted in Control Structure, too. If you delete them in Plant Explorer from
Functional Structure, they still exist in Control Structure and inside Control
Builder.
As a consequence,
• you cannot create further instances with the same name and
• on copy diagram in Functional Structure, the still existing instance gets
inserted into the copied diagram.
Delete Function Blocks and Control Modules either
• within Function Designer (this will remove them from both structures),
• within Plant Explorer from both structures each or
• within Plant Explorer with object context menu, item Advanced > Delete from
all Structures

Defining Component Properties


Each component of a function diagram is described by its properties. These
properties can be adjusted in appropriates dialogs.
• Ambient properties valid for the whole diagram document can be adjusted in
the Ambient Properties dialog.
• Default graphical properties common for newly created graphical components
(primitives) can be adjusted in the Default Properties dialog.
• Graphic properties for a single selected component or for multiple selected
components can be adjusted in the Component Properties dialog.
• Aspect properties / parameters for the function diagram, for a single selected
function component, or for a single selected port or can be adjusted in the
Aspect Properties/Parameters Dialog dialog.

Ambient Properties
In this dialog, you set ambient properties which are valid for the whole diagram.
E.g. background color for the diagram, selection handle colors, foreground and

3BDS011224R4101 527
Ambient Properties Section 4 Graphic Editor Reference

background color for ActiveX Controls and so on. The appropriate menu command
is only accessible in Function Designer’s Diagram view.
To access the Ambient Properties dialog, verify that Function Designer’s Diagram
view is active, then choose menu command Edit > Ambient Properties. The dialog
displays the following property pages:
• Colors
• ActiveX Controls
• Off Page Connector

Figure 304. Ambient Properties dialog

The Ambient Properties dialog contains the following buttons common for all
dialog pages:
• Colors
Click on the Colors tab to access the ambient properties on the Colors page.

528 3BDS011224R4101
Section 4 Graphic Editor Reference Ambient Properties

• ActiveX Controls
Click on the ActiveX Controls tab to access the ambient properties on the
ActiveX Controls page.
• Off Page Connector
Click on the Off Page Connector tab to access the ambient properties on the
Off Page Connector page.
• OK
Click OK to save your settings and to close the dialog.
• Cancel
Click Cancel to quit the dialog without saving your setting modifications.
• Apply
Click Apply to save your settings and leave the dialog open.

Colors
On the Colors page of the Ambient Properties dialog, you have access to the
properties for setting the colors for background, selection handles and ports.

Figure 305. Ambient Properties dialog: Colors page

This page contains the following property items:

3BDS011224R4101 529
Ambient Properties Section 4 Graphic Editor Reference

Background Color
Groups the controls for setting the background color.
• Use Windows Background Color
Set this option, if the diagram shall have the same background color as the
operating system windows.
• Use Custom Color
Set this option to get access to the drop-down color table from where you can
choose the wanted background color for the diagrams.

Selection Color
Groups the controls for setting the color of the selection handles.
• Use Windows Selection Color
Set this option, if the diagram shall have the same selection color as the
operating system windows.
• Use Custom Color
Set this option to get access to the drop-down color table from where you can
choose the wanted selection (handle) color for the diagrams.

530 3BDS011224R4101
Section 4 Graphic Editor Reference Ambient Properties

Color of Marked Port


• Color of Marked Port
Set this option to get access to the drop-down color table from where you can
choose the wanted color of marked ports.

Background
Color

Color of
marked Port
Color of Selection Handle

Figure 306. Ambient Properties, modified colors (example)

For more colors than the offered ones, click on Other to open the Color dialog.

Figure 307. Drop-down color table

3BDS011224R4101 531
Ambient Properties Section 4 Graphic Editor Reference

ActiveX Controls
On the ActiveX Controls page of the Ambient Properties dialog, you have access
to properties defining the foreground and background color for ActiveX Controls.

Figure 308. Ambient Properties dialog: ActiveX Controls page

This page contains the following property items:


• Back Color
Choose the background color for ActiveX Controls from the drop-down color
table by clicking on the down pointer and selecting a color by clicking on it.
For more colors, click on Other to open the Color dialog.

Figure 309. Drop-down color table

532 3BDS011224R4101
Section 4 Graphic Editor Reference Ambient Properties

• Fore Color
Choose the foreground color for ActiveX Controls from the drop-down color
table by clicking on the down pointer and selecting a color by clicking on it.
See Figure 309. For more colors, click on Other to open the Color dialog.
• Font
Click on the font button. The Font dialog will appear where you can set font
option such as type, style, size, and so on.
• ActiveX Run Mode
Set this option to enable “ActiveX Run Mode”. If enabled you can operate
ActiveX Controls (e.g. press buttons, edit text fields, etc.). If disabled you can
select ActiveX Controls and perform graphic operations (e.g. Copy, Move,
Size, etc.).
If “ActiveX Run Mode” is enabled the diagram is set read-only.

Off Page Connector


On the Off Page Connector page of the Ambient Properties dialog, you have
access to the source and sink of the Off-Page Connectors.

Figure 310. Ambient Properties dialog: Off Page Connector page

This page contains the following property items:

3BDS011224R4101 533
Ambient Properties Section 4 Graphic Editor Reference

Off-Page Connector Source


• Align to Master Page Client Area
Set this option to align off-page connectors at the left side of the master page
client area.
• Align to Port
Select this option to align off-page connectors near the connected port.
• Distance
Specify the distance between port and off-page connector.

Off-Page Connector Sink


• Align to Master Page Client Area
Set this option to align off-page connector sink to the right side of the master
page client area.
• Align to Port
Select this option to align off-page connectors near the connected port.
• Distance
Specify the distance between port and off-page connector.

Font
Use this standard dialog to set the font type, style, size, color and some other effects
such as strikeout or underline. The font options are valid for the current selected
object.

534 3BDS011224R4101
Section 4 Graphic Editor Reference Component Properties

This dialog will be opened from other Function Designer dialogs, for example, by
clicking a Font button (see Figure 308).

Figure 311. Font dialog

Component Properties
Graphic Components are defined by a number of graphical properties. To determine
which properties are associated with such a component, you need to open the
Component Properties dialog:

Setting Component Properties


To access the Component Properties dialog, select one or more components, and
choose one of the following methods:
• Choose the Edit > Default Properties menu command.
• Right-click on a component, and choose Properties from the context menu.
• Click the corresponding toolbar button from the Drawing toolbar.

3BDS011224R4101 535
Component Properties Section 4 Graphic Editor Reference

• Click the Properties button from the Components dialog.

Figure 312. Component Properties dialog: General page

If the dialog is open from the Components dialog, the dialog’s title will be
Properties instead of Component Properties.
Depending on the selected component(s), the appropriate pages are displayed.
The Component Properties dialog contains the following tabs (pages) and buttons
accessible from all dialog pages:
• Edit
Click on the Edit tab to access the properties on the Edit page.
• Field
Click on the Field tab to access the properties on the Field page.

536 3BDS011224R4101
Section 4 Graphic Editor Reference Component Properties

• Fill
Click on the Fill tab to access the properties on the Fill page.
• Font
Click on the Font tab to access the properties on the Font page.
• General
Click on the General tab to access the properties on the General page.
• Labels
Click on the Labels tab to access the properties on the Labels page.
• Line
Click on the Line tab to access the properties on the Line page.
• Position and Size
Click on the Position and Size tab to access the properties on the Position and
Size page.
• Text
Click on the Text tab to access the properties on the Text page.
• OK
Click OK to save your settings and to close the dialog.
• Cancel
Click Cancel to quit the dialog without saving your setting modifications.
• Apply
Click Apply to save your settings and leave the dialog open.

Edit
On the Edit page of the Component Properties dialog, you have access to
properties defining which editing actions you can perform on a component. For
instance, you can prevent stretching a component.

3BDS011224R4101 537
Component Properties Section 4 Graphic Editor Reference

This page is identical with the Edit page of the Default Properties dialog.

Figure 313. Component Properties dialog: Edit page

The page contains the following property items:


• Read Only
Check this option to lock the component for any editing actions. Then, it is no
longer possible to change the position, appearance, or any other graphical
properties of the component. All editing options, except Allow Selection, will
be disabled.
• Allow Selection
Check this option to allow selection of the component using the mouse.

If this option is not set, the component can only be selected via the Components
dialog. For it, see Section , Graphic Editor Reference.
• Allow Move
Check this option to allow moving the component within function diagrams.
• Allow Rotation
Check this option to allow rotating the component.

538 3BDS011224R4101
Section 4 Graphic Editor Reference Component Properties

• Allow Vertex Editing


Check this option to allow editing (adding, moving, deleting) the component’s
vertices.
• Allow Scaling
Check this option to allow changing the component’s size. This option is
corresponding to the option Allow Stretch:
– If the option Allow Stretch is set, on changing the component’s size,
height and width can be changed separately.
– If the option Allow Stretch is not set, on changing the size of the
component, the relationship between height and width is kept.

If this option is turned off, the option Allow Stretch is not accessible.

• Allow Stretch
Check this option to allow changing the component’s height and width
separately. This option is only active if the option Allow Scaling is set.
• Allow Containment
Check this option to allow that on moving the selected component, all other
components overlapped by (contained in) the selected one will automatically
moved, too.

Figure 314. Component Property: Allow Containment

3BDS011224R4101 539
Component Properties Section 4 Graphic Editor Reference

Figure 314 displays an example for moving a rectangle overlapping


(containing) a circle. Both components are moved, although only the rectangle
is selected and the components are not grouped.

Field
On the Field page of the Component Properties dialog, you define document and
aspect property references.

Figure 315. Component Properties dialog: Field page

This page contains the following property items:


• Field
This field contains the Field Code defined as Document Reference or Aspect
Property Reference (see Aspect Property References). You can edit this field
code definition and mix fixed texts with references,
e.g. ’This is page $Page of $LastPage’. You can also enter multiline field codes
by pressing the ’Return’ key as line separator. In that case make sure to also
check Multiple Lines Component Properties dialog: Text page.
• Subscribe for Live Data
Check Subscribe for Live Data if the Field Code contains references to
properties retrieved from an OPC server, i.e. on-line values. This setting just

540 3BDS011224R4101
Section 4 Graphic Editor Reference Component Properties

prepares the field for display of on-line values. To activate/start on-line display
for all such prepared fields, use command Online > Subscribe for Live Data.
• Show Last Value
Check Show Last Value in order to display the recent on-line value after
Online > Subscribe for Live Data has stopped. Uncheck in order to display an
empty string instead.
• Current Value
This field displays the current value of the Field Code entered in Field.
• Field Code
Groups the fields for setting the Document Reference or Aspect Property
Reference.
• Document Reference
Choose a predefined document reference from the drop-down list box. The
following document references can be used:

Table 64. Document References as Field Parameters

Document
Description
Reference
$? Optional prefix to be displayed if evaluation fails.
E.g. $?*$OPCValue displays a * if no OPC value
can be retrieved.
$AllocDetails Allocation details as defined in the Allocation >
Show Allocation Details command. E.g. data
flow order, allocatable group name and color.
$AllocGroup Name of assigned Allocatable Group
Aspect Object
$Date Current date
$GroupName Group name
$LastPage Last page number of the current document

3BDS011224R4101 541
Component Properties Section 4 Graphic Editor Reference

Table 64. Document References as Field Parameters

Document
Description
Reference
$Name Name property of the component
$NextPage Page number following to the current page
$OPCForced Online > Subscribe for Live Data: On-line
indication of a forced signal.
$OPCIOStatus Online > Subscribe for Live Data: On-line
indication of the IO status.
$OPCIOValue Online > Subscribe for Live Data: On-line IO
value of associated IO signal.
$OPCValue Online > Subscribe for Live Data: On-line value
of associated port, link, or signal from OPC
server.
$Order Data Flow Order
$Page Current page number
$PgComment Current page comment.
$RefPage Off-Page Connector:
Referenced page number
$RefPort Off-Page Connector:
Referenced port
$RefSymbol Off-Page Connector:
Referenced symbol (function component)
$SymbolName Symbol name
$Time Current time

• Aspect Property Reference


Edit an aspect property reference, e.g. ’$.:Name:Name$’. Or press ’...’ to open
the Aspect Property Reference dialog, see Aspect Property References.

542 3BDS011224R4101
Section 4 Graphic Editor Reference Component Properties

• Add
Click this button to add the selected Document/Aspect Property Reference to
the Field field.

Fill
On the Fill page of the Component Properties dialog, you have access to
properties defining how a component is filled. The most commonly used fill is a
solid fill, which is a foreground color with no hatching. You can also choose a
hatched fill pattern with a background color.

Figure 316. Component Properties dialog: Fill page

This page which is identical with the Fill page of the Default Properties
dialog.contains the following property items:
• Foreground Color
From the Foreground Color drop down list, select the component’s
foreground (hatch) color.
• Transparent Fill
Mark this option, to make the component transparent, that is to deactivate all
fill settings. Neither the background nor the hatch will be displayed.

3BDS011224R4101 543
Component Properties Section 4 Graphic Editor Reference

• Background Color
From the Background Color drop down list, select the component’s
background color.
• Transparent Background
Mark this option, to make the background transparent. Only the hatch will be
visible.
• Hatch
From the Hatch list box, select the hatch displayed as foreground in the
component.

Font
On the Font page of the Component Properties dialog, you have access to
properties defining how the text appears in a component. You can choose any True
Type font and then apply any typographical effects such as italic or underline.

Figure 317. Component Properties dialog: Font page

This page which is identical with the Font page of the Default Properties dialog
and nearly identical with the Font standard dialog contains the following property
items:

544 3BDS011224R4101
Section 4 Graphic Editor Reference Component Properties

• <Font Family>
Select the font wanted for the selected text from the list by clicking on it.
• <Font Style>
Select the font angle/weight wanted for the selected text from the list by
clicking on it.
• <Font Size>
Select the font size wanted for the text from the list by clicking on it.
• Underline
Mark this option to underline the selected text.
• Strike-Out
Mark this option to strike-out (strike through) the selected text.
• Text Color
Click on the down pointer and select a color by clicking on it.
For more colors, click on Other to open the Color dialog.

Figure 318. Color drop-down table

3BDS011224R4101 545
Component Properties Section 4 Graphic Editor Reference

• Sample

General
On the General page of the Component Properties dialog, you have access to
properties such as the name and type of the component. The properties displayed
here depend on the type of the component:

Figure 319. Component Properties dialog: General page

This page contains the following property items:


• Name
Displays the graphical name of the selected component. If only one component
is selected, the name can be changed.
• Type
Displays the graphical type of the selected component. If you have selected
several components, the field displays the entry <Multiple Types
Selected>.

546 3BDS011224R4101
Section 4 Graphic Editor Reference Component Properties

Labels
On the Labels page of the Component Properties dialog, you have access
properties defining the orientation of the label component.

Figure 320. Default Properties dialog: Labels page

This page which is identical with the Labels page of the Default Properties
dialog.contains the following property items:
• Enable Orientation
Check to enable the following label orientation options.
• Label Orientation
Groups the options for label orientation.
• Top-Left
Check this option to place the label on top-left of the selected component.
• Center-Left
Check this option to place the label on center-left of the selected component.
• Bottom-Left
Check this option to place the label on bottom-left of the selected component.

3BDS011224R4101 547
Component Properties Section 4 Graphic Editor Reference

• Top-Center
Check this option to place the label on top-center of the selected component.
• Center-Center
Check this option to place the label on center-center of the selected component.
• Bottom-Center
Check this option to place the label on bottom-center of the selected
component.
• Top-Right
Check this option to place the label on top-right of the selected component.
• Center-Right
Check this option to place the label on center-right of the selected component.
• Bottom-Right
Check this option to place the label on bottom-right of the selected component.
• Orientation Offset
Groups the properties for setting the orientation offset. Orientation offset
means moving the label orientation in x and y direction.
• X
Enter the value (in the selected measurement unit, e.g. ’mm’) for moving the
orientation offset in x direction. Positive value result in moving to right, a
negative values result in moving to the left.
• Y
Enter the value (in the selected measurement unit, e.g. ’mm’) for moving the
orientation offset in y direction. Positive values result in moving down,
negative values result in moving up.
• <Orientation Preview>
Displays the meaning of the label orientation offset in x (horizontal) and y
(vertical) direction.

548 3BDS011224R4101
Section 4 Graphic Editor Reference Component Properties

Line
On the Line page of the Component Properties dialog, you have access to
properties defining how the lines appear in the component. You can set color, style
and width.

Figure 321. Component Properties dialog: Line page

This page which is identical with the Line page of the Default Properties dialog.
contains the following property items:
• Color
Use this drop down list for selecting the line color for the component’s border.
• Transparent
Check this option to make the component’s border transparent, that is to turn
off the display.
• Style
From the Style list box, select the line style for the component’s border.
• Width
From the Width list box, select the line width for the component’s border.

3BDS011224R4101 549
Component Properties Section 4 Graphic Editor Reference

Position and Size


On the Position and Size page of the Component Properties dialog, you have
access to properties giving information about the position and size of the
component. It is only shown when a single component is selected. The position and
size is shown using the current measurement unit.

Figure 322. Component Properties dialog: Position and Size page

You can also edit the displayed position and size to manually adjust or align
components.
This page contains the following property items:
• Left
Displays the component’s position from the left border in the unit defined in
Printing dialog.
• Top
Displays the component’s position from the top border in the unit defined in
Printing dialog.
• Width
Displays the component’s width in the unit defined in Printing dialog.
• Height
Displays the component’s height in the unit defined in Printing dialog.

550 3BDS011224R4101
Section 4 Graphic Editor Reference Component Properties

Show / Hide
The Show/Hide page is similar to the Field page of the Component Properties
dialog. You define document and aspect property references in order to show or hide
the selected graphic component or primitive.

Figure 323. Component Properties dialog: Show/Hide page

This page contains the following property items:


• Show
Check this option to always show the graphic component.
• Hide
Check this option to always hide the graphic component.
• Hide if Condition is False(0), Show Otherwise
Check this option to show or hide the graphic component based on a condition.
You can enter a Visual Basic script enclosed into <vbs> and </vbs>. And you
can combine that script with any document or aspect property reference, see
Field.
• Current Value
This field displays the current value of the Condition.

3BDS011224R4101 551
Component Properties Section 4 Graphic Editor Reference

• Subscribe for Live Data


Check Subscribe for Live Data if the Condition contains references to
properties retrieved from an OPC server, i.e. on-line values. This setting just
prepares the field for display of on-line values. To activate/start on-line display
for all such prepared fields, use command Online > Subscribe for Live Data.
• Field Code
Groups the fields for setting the Document Reference or Aspect Property
Reference.
• Document Reference
Choose a predefined document reference from the drop-down list box, see
Document References as Field Parameters.
• Aspect Property Reference
Edit an aspect property reference, e.g. ’$.:Name:Name$’. Or press ’...’ to open
the Aspect Property Reference dialog, see Aspect Property References.
• Add
Click this button to add the selected Document/Aspect Property Reference to
the Condition field.

Text
On the Text page of the Component Properties dialog, you have access to
properties allowing the user to enter a string value and set properties that determine
how the text is displayed and edited. You can use a check box to toggle between
single line and multiple line text. If multi-line text is enabled, the Word Break
check box allows you to toggle automatic word break on and off. Horizontal

552 3BDS011224R4101
Section 4 Graphic Editor Reference Component Properties

alignment can be set to left, center, or right. Vertical alignment can be set to top,
center, or bottom.

Figure 324. Component Properties dialog: Text page

This page contains the following property items:

• Text
In the Text field, enter the text, displayed within the component.
• Multiple Lines
Check this option to prepare the text location for multiple lines. If this option is
set, you can skip to the next line by pressing the ENTER key.
• Word Break
Check this option to retain the component’s width on writing text of any length.
New text is automatically written in a new line, if the right border is reached.
Unmark this option, if text shall only be written in a new line after pressing the
ENTER key.

3BDS011224R4101 553
Component Properties Section 4 Graphic Editor Reference

• Left
Check this option of the Horizontal Alignment group box to align the
component’s text left.
• Center (horizontal)
Check this option of the Horizontal Alignment group box to align the
component’s text horizontally centered.
• Right
Check this option of the Horizontal Alignment group box to align the
component’s text right.
• Top
Check this option of the Vertical Alignment group box to align the
component’s text vertically on top.

This option is only accessible and can be set if the Multiple Lines option is not
set.
• Center (vertical)
Check this option of the Vertical Alignment group box to align the
component’s text vertically centered.

This option is only accessible and can be set if the Multiple Lines option is not
set.

• Bottom
Check this option of the Vertical Alignment group box to align the
component’s text vertically on bottom.

This option is only accessible and can be set if the Multiple Lines option is not
set

554 3BDS011224R4101
Section 4 Graphic Editor Reference Component Properties

• Auto grow to text size


Check this option for automatically adjusting the component’s width to the
length of the entered text.
• Auto shrink to text size
Check this option for automatically shrinking the component’s width to the
length of the entered text.

Color
Use the Color dialog to define a color for the previously selected component(s).
Access this dialog, for example, from the Font page of the Component Properties
dialog by clicking on the Other button of the Text Color drop-down list box. Such
color drop-down lists are also offered in some other dialogs.

Figure 325. Color dialog

The Color dialog contains the following property items:

3BDS011224R4101 555
Component Properties Section 4 Graphic Editor Reference

• Basic Colors
Displays the basic colors available. You can choose the wanted color by
clicking on it.
• Custom Colors
User defined colors added from the color matrix. You can choose the wanted
color by clicking on it.
• Define Custom Colors
Not active.
• Color | Solid
Displays a preview of the color selected from the color matrix.
• Hue
Specifies the hue of the color selected from the color matrix.
• Sat
Specifies the saturation of the color selected from the color matrix.
• Lum
Specifies the luminosity of the color selected from the color matrix.
• Red
Specifies the Red value in the sense of a RGB color value.
• Green
Specifies the Green value in the sense of a RGB color value.
• Blue
Specifies the Blue value in the sense of a RGB color value.
• Add to Custom Colors
Click this button to add the color selected from the color matrix to the Custom
colors.

556 3BDS011224R4101
Section 4 Graphic Editor Reference Component Properties

• OK
Click OK to save your settings and to close the dialog.
• Cancel
Click Cancel to quit the dialog without saving your setting modifications.

Components
Use the Components dialog to navigate to components, to delete components, or to
get access to the properties of components.
Open the Components dialog via the Edit > Components menu command.

Figure 326. Components dialog

• OK
Click this button to close the window.
• Go To
Click this button to navigate to the selected component(s)

The navigation will result in displaying the selected component in the center of
the document window. If you have selected one component, it will be selected in
the document window. If you have selected several components, the focus of the
window will be the center of the area built by the selected components.

3BDS011224R4101 557
Component Properties Section 4 Graphic Editor Reference

• Properties
Click this button to open the Component Properties dialog.
• Delete
Click this button to delete the component from the diagram.

Setting Component Properties


To set the properties of one or more components, do as follows:
1. Select the wanted component(s) as described in page 486, Selecting
Components.
2. Open the Component Properties dialog by choosing one of the following
methods:
– Click right into the area of the selected components on the Function
Designer window.
– Choose the menu command Edit > Component Properties.
– Click the appropriate toolbar button.
3. Click on the appropriate tab, to open the page containing the wanted properties.
4. Set the properties according to your wishes.
5. Click OK.
Alternatively, you can open the Properties dialog for getting access to the selected
components’ properties, do as follows:
1. Open the Components dialog.
2. Select the wanted component(s) from the list box.
See Section , Graphic Editor Reference.
3. Click Properties.
See Component Properties.
4. Click OK in the Components dialog after having finished the work in the
Properties dialog.

558 3BDS011224R4101
Section 4 Graphic Editor Reference Default Properties

Default Properties
In this dialog, you can define default properties for graphic components. The default
properties are automatically used by Function Designer for newly created
components. Default properties are not component-specific.
You can define
• default edit properties, e.g. allow scale
• default label properties, e.g. enable orientation
• default line properties, e.g. line width
• default fill properties, e.g. fill color
• default font properties, e.g. font size.
To access the Default Properties dialog, choose the Edit > Default Properties
menu command.

Figure 327. Default Properties dialog

This dialog contains the following tabs and buttons common for all dialog pages:

3BDS011224R4101 559
Default Properties Section 4 Graphic Editor Reference

• Edit
Click on the Edit tab to access the properties on the Edit page.
• Fill
Click on the Fill tab to access the properties on the Fill page.
• Font
Click on the Font tab to access the properties on the Font page.
• Labels
Click on the Labels tab to access the properties on the Labels page.
• Line
Click on the Line tab to access the properties on the Line page.
• OK
Click OK to save your settings and to close the dialog.
• Cancel
Click Cancel to quit the dialog without saving your setting modifications.
• Apply
Click Apply to save your settings and leave the dialog open.

560 3BDS011224R4101
Section 4 Graphic Editor Reference Default Properties

Edit
This page is identical with the Edit page of the Component Properties dialog.

Figure 328. Default Properties dialog: Edit page

Fill
This page is identical with the Fill page of the Component Properties dialog.

Figure 329. Default Properties dialog: Fill page

3BDS011224R4101 561
Default Properties Section 4 Graphic Editor Reference

Font
This page is identical with the Font page of the Component Properties dialog.

Figure 330. Default Properties dialog: Font page

Labels
This page is identical with the Labels page of the Component Properties dialog.

Figure 331. Default Properties dialog: Labels page

562 3BDS011224R4101
Section 4 Graphic Editor Reference Default Properties

Line
This page is identical with the Line page of the Component Properties dialog.

Figure 332. Default Properties dialog: Line page

3BDS011224R4101 563
Layers Section 4 Graphic Editor Reference

Layers
The Function Designer, Diagram view, allows you to design your diagram
distributed on in several layers:
• Logic Layer
• Master Page Layer
• Background Layer
• Annotation Layer
For each layer, you can set properties defining the display of the layer in the
diagram, if the layer is active or inactive. Use the Layer Properties dialog to set the
properties for each layer.

Layer Properties
The Layer Properties dialog allows you to set the properties for each layer of the
Function Designer.
Access this dialog via the View > Layers > Properties menu command.

Figure 333. Layer Properties dialog

564 3BDS011224R4101
Section 4 Graphic Editor Reference Layer Properties

• OK
Click OK to save your settings and to close the dialog.
• Cancel
Click Cancel to quit the dialog without saving your setting modifications.
• Apply
Click Apply to save your settings and leave the dialog open.
• Master Page Layer
Click this tab to access properties for the Master Page Layer.
• Background Layer
Click this tab to access properties for the Background Layer.
• Logic Layer
Click this tab to access properties for the Logic Layer.
• Annotation Layer
Click this tab to access properties for the Annotation Layer.
• If Layer is Active
Groups the properties defining the display of the active layer.
• Components are drawn in their original color
Check this option in group If Layer is Active to draw the layer’s components
in their original color - if the layer is active.
Check this option in group If Layer is Inactive to draw the layer’s components
in their original color - if the layer is inactive.
• Components are drawn in
Check this option to draw the layer’s components in a user-defined color - if
the layer is active.
Select a user-defined color from the color drop-down list box. For more colors,
click the Color button to open the Color dialog.

3BDS011224R4101 565
Layer Properties Section 4 Graphic Editor Reference

• Bring Components to Front


Check this check box to bring components of the active layer to front.
• If Layer is inactive
Groups the properties defining the layer’s display - if it is inactive, that is
another layer is active.
• Components are drawn in grey color
Check this option to draw the layer’s components in grey color - if the layer is
inactive.
• Components are Not Drawn at All
Check this option to prevent drawing of the layer’s components - if the layer is
inactive.
• Allow Components to be Moved
Check this option to allow moving components on the layer.
• Allow Components to be Edited
Check this option to allow editing components on the layer. If unchecked, the
layer is read-only.

566 3BDS011224R4101
Section 4 Graphic Editor Reference Pages

Pages
In Diagram view, a diagram consists of several drawing pages of fixed page size. If
a page is full, a new page can be inserted. Then, connections between components
on different pages are automatically referenced via off-page-connectors. Size and
orientation of a drawing page are defined via Edit > Measurements and Size dialog,
whereas size and orientation of the printer page is defined via Page Setup dialog.
In Component view, a component or component template definition consists of one
page only.
Keep in mind:
• The page you see on the screen is called the drawing page.
• You print the drawing on the printed page, which is the paper in the printer.
Typically the size and orientation of the printer page equals the drawing page.
However, they can differ in the following cases:
• Your function diagram is drawn on a drawing page A4 portrait (21.0 * 29.7
cm), but you print it on A3 landscape (42.0 * 29.7 cm) or Legal (8.5 * 11 inch)
paper. If the printer paper size is less than the drawing page size, the drawing
gets clipped.
• Your function diagram is drawn on a drawing page A3 landscape (42.0 * 29.7
cm ), but you print it on A4 landscape (29.7 * 21 cm). You can zoom each page
of the diagram to fit to the printer page size, either by a percentage value or on
a Fit to number of printer sheets basis, see Edit > Measurements and Size.
• Your function diagram is scaled, e.g. uses a predefined or user-defined drawing
scale like 1 : 2 or 5 : 1. In that case, the drawing units differ from the page units.
Thus you can print a A3 drawing also on A4 paper. Or you can insert more
function component symbols on a page. Assume your symbols are drawn in 1 :
1 scale. Using 1 : 2 drawing scale, you can insert four times the number of
symbols on a single diagram page. The drawing units are defined together with
the drawing page size by Edit > Measurements and Size.
In any case you can check the print results before actually printing via File > Print
Preview. It is recommended to check menu command View > Printable Area to
outline the printable area in print preview, i.e. the printer paper size reduced by print
margins.

3BDS011224R4101 567
Measurements and Size Section 4 Graphic Editor Reference

Measurements and Size


The Measurements and Size dialog allows you to change the units of measure
(drawing units), the drawing scale, and the drawing page size.
The dialog is accessible via the Edit > Measurements and Size menu command.

Figure 334. Measurement and Size dialog

The dialog contains the following pages and buttons accessible from all pages:
• Drawing Scale
Click this tab to get access to the properties of the Drawing Scale page.
• Page Size
Click this tab to get access to the properties of the Page Size page.
• Print Size
Click this tab to get access to the properties of the Print Size page.
• OK
Click OK to save your settings and to close the dialog.

568 3BDS011224R4101
Section 4 Graphic Editor Reference Measurements and Size

• Cancel
Click Cancel to quit the dialog without saving your setting modifications.

Drawing Scale
The Drawing Scale page allows you to specify what a given real-world size on the
drawing represents. It also influences how measurements are presented to you.
Suppose you defined symbols (object types) with default scale 1 : 1. Lets say, the
symbol’s size equals 2 * 8 cm in real-world coordinates. Instantiate the symbol on a
diagram...
• with drawing scale 1 : 1. The drawing on the screen, the rulers, and the symbols
component properties, position and size, will display a symbol of size 2 * 8 cm.
Print the diagram. On the printer you will get a symbol of size 2 * 8 cm.
• with drawing scale 1 : 2. The drawing on the screen, the rulers, and the symbols
component properties, position and size, will still display a symbol of size 2 * 8
cm. Print the diagram. On the printer you will get a symbol of size 1 * 4 cm.
• with drawing scale 2 : 1. The drawing on the screen, the rulers, and the symbols
component properties, position and size, will still display a symbol of size 2 * 8
cm. Print the diagram. On the printer you will get a symbol of size 4 * 16 cm.
The default drawing scale is 1 : 1.

• Unit of Measure
Select the value of the drawing units from the drop-down list box. If you
change the value, no measurement is changed at all. The chosen value just
influences the measurement unit(s) displayed in
– Rulers
– View > Grid Properties: Grid spacing.
– Edit > Default Properties: Position and size, Font Size, Line Width,
Label Orientation Offset.
– Edit > Ambient Properties: Off-Page Connector and Snap port distance.
– Edit > Options > Autorouting

3BDS011224R4101 569
Measurements and Size Section 4 Graphic Editor Reference

• Drawing Scale
Select No Scale (1 : 1), a predefined drawing scale, or define a drawing scale
by yourself.
• Module
Defines a base unit for font size increments, nudge by keyboard, and pan by
keyboard. It is recommended to always set the following measurements in
multiples of the module (default 1 mm):
– font size, e.g. 1mm, 2mm, 3mm...
– 10 * line width, e.g. 0.1mm, 0.2mm, 0.3mm...
– grid spacing, e.g. 1mm, 2mm, 3mm...
– auto routing settings, e.g. 1mm, 2mm, 3mm...

Page Size
On the Page Size page, you define the size of the drawing page.

Figure 335. Measurement and Size dialog: Page Size page

570 3BDS011224R4101
Section 4 Graphic Editor Reference Measurements and Size

• Predefined
The predefined drawing page sizes offered are filtered by the Metric(ISO) and
English(US) setting. Select Metric(ISO) or English(US) and a drawing page
size from the drop-down list.
If you choose Metric(ISO), all internal coordinates are based on 0.01 mm. If
you choose English(US), all internal coordinates are based in 0.001 inch.
• Orientation
Select portrait or landscape.
• User Defined
Enter any size of the drawing page in the selected Units of Measure.

Print Size
Use this Print Size page if the diagram drawing page size does not fit the printer
page size. E.g. your diagram page size equals A3 landscape, and you want to print
on A4 landscape.

Figure 336. Measurement and Size dialog: Print Size page

3BDS011224R4101 571
Page Setup Section 4 Graphic Editor Reference

• Adjust to
Reduces or enlarges a drawing page to a specified percentage. For example, to
reduce a A3 drawing to A4, type 70.
• Fit to
Fits each drawing page on the number of sheets you specify across and down.
Depending on the number of sheets you specify, the drawing is enlarged or
reduced.
If the pages across and down are not proportional to the drawing's dimensions,
only those sheets needed to maintain the drawing's proportions are used.
Fit to 1 sheet(s) across and 1 sheet(s) down guarantees that each diagram page
fits on one sheet.

Page Setup
(Printer) page setup determine how the diagram / component is printed. The
standard Windows Page Setup dialog allows you to select paper size, page
orientation, margins for a specific printer. These settings are saved with your
diagram, and the default printer is used to initialize the page setup for a new
diagram.
Access the dialog via the File > Page Setup menu command to:
• Choose the Paper Size (A4, and so on) from drop-down list.
• Choose the Paper Source from the drop-down list.
• Choose either the Portrait or Landscape orientation.

572 3BDS011224R4101
Section 4 Graphic Editor Reference Select Master Page Template

• Choose the Left, Right, Top, and Bottom Margins.

Figure 337. Page Setup dialog

Select Master Page Template


The Select Master Page Template dialog lists predefined templates for diagrams.
In effect, the selected master page template is referenced or copied into the active

3BDS011224R4101 573
Select Master Page Template Section 4 Graphic Editor Reference

diagram. The dialog is displayed when creating a new diagram, see also New
Function Diagram, or by invoking the File > Template command.

Figure 338. Select Master Page Template dialog

• Template List
Select a predefined diagram template. You can add additional templates or
customize installed ones in Object Type Structure under Object
Types\Functional Planning\Diagram Templates, see also Figure 256.
• Reference Template
Select this option to reference the selected template in the active diagram. The
diagram’s master page layer gets read-only, but automatically updated when
the template changes. Header/footer entries like author, document number,
cannot be edited inside the diagram, but are referenced as aspect properties
from a Function Diagram Document aspect of type Document.
• Copy Template
Select this option to copy the selected template into the active diagram. The
diagram’s master page layer gets writable, but not updated when the template
changes. Header/footer entries like author, document number, can be edited

574 3BDS011224R4101
Section 4 Graphic Editor Reference Insert/Delete Page

inside the diagram, but also referenced as aspect properties from a Function
Diagram Document aspect of type Document.

Insert/Delete Page

Insert Page
To insert a page in a function diagram, choose one of the following methods:
• Click the Page toolbar button .
• Choose the Insert > Page menu command.
• Choose the View > Pages > Insert New Page menu command.
• Optionally enter a page comment, see Figure 339.

Figure 339. Dialog Enter Page Comment

Delete Page
To delete a page from a function diagram, select the page to be deleted, and choose
one of the following methods:
• Click the Page toolbar button .
• Choose the View > Pages > Delete Page menu command
This function is enabled only if the according page is empty.

Page Comments
You can enter a page comment on Insert Page in the Enter Page Comment dialog,
see Figure 339. In addition, the Page comment command from the Page
toolbar or menu command View > Pages > Page Comment support

3BDS011224R4101 575
Page Navigation Section 4 Graphic Editor Reference

• modify/delete page comment


• copy page comment to different pages.
See Figure 340.

Figure 340. Page comment dialog

The page comment gets displayed


• on the lower-right corner of the page template, see Figure 340.
• in the complete (detailed) contents diagram, see Figure 105.

Page Navigation

To navigate to the wanted page, you have the following possibilities:


• Navigation to the first page
• Navigation to the last page
• Navigation to the next page
• Navigation to the previous page
• Navigation to a certain page

576 3BDS011224R4101
Section 4 Graphic Editor Reference Page Navigation

Navigation to the first page


To navigate to the first page, do one of the following:
• Click of the Page toolbar
• Choose the View > Pages > First Page menu command.

Navigation to the last page


To navigate to the last page, do one of the following:
• Click of the Page toolbar
• Choose the View > Pages > Last menu command.

Navigation to the next page


To navigate to the last page, do one of the following:
• Click of the Page toolbar
• Choose the View > Pages > Next menu command.

Navigation to the previous page


To navigate to the last page, do one of the following:
• Click of the Page toolbar
• Choose the View > Pages > Previous menu command.

Navigation to a certain page


To navigate to the last page, do one of the following:
• Select page number from combo box in the Page toolbar.

3BDS011224R4101 577
Printing Section 4 Graphic Editor Reference

• Choose the View > Pages > Goto Page menu command, enter the wanted page
number (see Figure 341) and click OK.

Figure 341. Goto Page Dialog

• Click directly in the wanted page if it is displayed in the diagram.

Printing
You can bulk print and create a contents diagram for each substructure by creating a
dummy Function aspect at any level in Functional Structure. E.g. in order print and
create a contents chapter for all diagrams in Functional Structure,
• create an empty Function aspect at the root object in Functional Structure
• open the (empty) Diagram view
• invoke the File > Create Contents command
• invoke the File > Print command.
The diagrams are listed and printed according to their level in alphabetical order.

Contents
You can create a contents diagram for
• a single diagram in Diagram view
• multiple diagrams in Diagram view (bulk printing).
You invoke creation or update of a contents diagram by the File > Create Contents
command, see Figure 342, and you open an already existing contents diagram by the
File > Open Contents command.

578 3BDS011224R4101
Section 4 Graphic Editor Reference Contents

Figure 342. Create Contents dialog

• Complete Contents
Select Complete contents to create detailed contents for each diagram and all
its pages including functional designation (if any), name, description, page
comment and page number.
• Overview Contents
Select Overview contents to create contents for all diagrams according to the
selected number of levels. The overview includes functional designation, name,
description, and number of pages. Child diagrams are indented according to
their level in Functional Structure.
• Contents Template
Select a contents template for the contents diagram. The contents diagram page
size must not necessarily fit the diagram size. E.g. you can print the contents on
A4 portrait, while your diagrams are printed on A4 landscape paper.
See Bulk Documentation and Contents Chapter for an example.

3BDS011224R4101 579
Print Section 4 Graphic Editor Reference

Print
You can print
• a single component in Component view
• a single diagram in Diagram view
• multiple diagrams in Diagram view (bulk printing).
You invoke printing by the File > Print command or by the corresponding toolbar
button. In case there exist a contents diagram and/or sub- (child-) diagrams in
Functional Structure, the dialog Figure 343 gets displayed. Select the options for
your bulk print job.

Figure 343. Bulk print dialog

• Contents
Check in order to print a contents diagram.
• Diagrams
Check in order to print diagram(s).
• Child Diagrams
Check in order to print child diagram(s).

580 3BDS011224R4101
Section 4 Graphic Editor Reference Print

• Printer and Printer Page Settings


Select an option
– to print the contents/diagrams with the same printer and printer page
settings defined by this starting diagram (starting parent Function aspect).
You can check and modify these settings by pressing the Page Setup
button.
– to print and to update and save the contents/diagrams with the same
printer and printer page settings defined by this starting diagram (starting
parent Function aspect).You can check and modify these settings by
pressing the Page Setup button.
– to print the contents/diagrams with individual printer and printer page
settings, as setup and saved in each contents/diagram.
• Print Components on Layers
Select an option
– print the diagrams as laid out on the screen. In this case, components on
different layers get grayed or not printed at all according to the Layer
Properties.
– print the diagrams in their original color.

On OK, the standard Print dialog Figure 344 lets you set further printer parameters:
• Select the Printer Name from a drop-down list.
• Access the printer-specific Properties dialog.
• Define the Print range by choosing one of the following options:
– To print all pages, choose the All option.
– To print a range of pages, define from which page to which page you want
to print.
– To print only the selected components, choose the Selection option.

3BDS011224R4101 581
Print Section 4 Graphic Editor Reference

• Define the Number of copies to be printed.

Figure 344. Print dialog

The settings in Figure 344 are valid for all diagrams printed in one job.

On OK, a print working dialog indicating the current printed diagram gets
displayed. You can cancel the print job by pressing its Cancel button.
The printed diagrams are printed according to their level in alphabetical order.
They get listed in the output window of the starting parent Function aspect.

582 3BDS011224R4101
Section 4 Graphic Editor Reference Print Preview

Print Preview
Use this preview to display the current diagram as it will be printed. Open the
preview via the File > Print Preview menu command.

Figure 345. Print Preview

• Print
Click this button to open the Print dialog.
• Next Page
Click this button to navigate to the next page of the diagram.
• Prev Page
Click this button to navigate to the previous page of the diagram.

3BDS011224R4101 583
Options Section 4 Graphic Editor Reference

• Two Page
Click this button to display two pages side by side.
• Zoom In
Click this button to zoom in the selected area, that means to display this area
enlarged.
• Zoom Out
Click this button to zoom out the selected area, that means to display this area
reduced.
• Close
Click this button to close the preview.

Options
The Options dialog allows you to set various Function Designer options
Access this dialog via the Edit > Options the menu command.

Figure 346. Options dialog

584 3BDS011224R4101
Section 4 Graphic Editor Reference Print

The dialog contains the following pages and buttons accessible from all pages:
• OK
Click OK to save your settings and to close the dialog.
• Cancel
Click Cancel to quit the dialog without saving your setting modifications.
• Apply
Click Apply to save your settings and leave the dialog open.
• Print
Click this tab to access the options of the Print page.
• Paste
Click this tab to access the options of the Paste page.
• Autorouting
Click this tab to access the options of the Autorouting page.
• Naming
Click this tab to access the options of the Naming page.

Print
The Print page of the Options dialog offers two options for printing components on
layers:
• As Laid out on Screen
Check this option to print components as displayed on the screen. In that case
layer properties Figure 333 are taken into account, e.g. components on
background layer are drawn greyed.

3BDS011224R4101 585
Paste Section 4 Graphic Editor Reference

• In Original Color
Check this option to print all components on all layers in their original color.

Figure 347. Options dialog: Print page

Paste
The Paste page of the Options dialog allows you to define the behavior on pasting
copied components, see also Paste Options:

Figure 348. Options dialog: Paste page

586 3BDS011224R4101
Section 4 Graphic Editor Reference Autorouting

• Internal Links in the Copied/Pasted Range


Check to paste links (connections) between copied/pasted symbols. By default,
this setting is checked, see Copying Function Components including Internal
Links, Figure 300 and Figure 301.
Uncheck to disconnect links (connections) between copied/pasted symbols.
• Inputs
Check to paste links (connections) between input ports of copied/pasted
symbols and symbols outside the copied/pasted range (external inputs), see
Copying function components including External Input Links, Figure 302.
Uncheck to disconnect them.
• Outputs
Check to paste links (connections) between output ports of copied/pasted
symbols and symbols outside the copied/pasted range (external outputs), see
Copying function components including External Output Links, Figure 303.
Uncheck to disconnect them.

Autorouting
The Autorouting page of the Options dialog offers the possibility to set the
following options:
• Distance between Links
• Distance Link to Symbol

3BDS011224R4101 587
Naming Section 4 Graphic Editor Reference

For both options, you can set the horizontal and vertical value based on the unit
defined in the Printing dialog.

Figure 349. Options dialog: Autorouting page

Naming
The Naming page of the Options dialog defines if the optional New Component
Name prompt gets displayed on Inserting Function Components, see Figure 351.
Check/uncheck the various component types in order to show/hide the New
Component Name prompt. The settings get stored in the registry per user.

588 3BDS011224R4101
Section 4 Graphic Editor Reference Naming

Figure 350. Options dialog: Naming page

Figure 351. Dialog New Component Name

• Name
Accept or modify the default name proposed for the new instance. The default
name itself can be configured in the Function Settings. For aspect objects, the
entered name equals the .:Name.Name and the .:Function
Parameters.ObjectName aspect properties. For symbol objects, the entered
name equals .:Function Parameters.ObjectName.

3BDS011224R4101 589
Import/Export Section 4 Graphic Editor Reference

• Description
Enter any description for the new instance. For aspect objects, the entered
description equals the .:Name.Description and the .:Function
Parameters.ObjectDescription aspect properties. For symbol objects, the
entered name equals .:Function Parameters.ObjectDescription.
• Data Flow Order Insert Before
The combo box Data Flow Order Insert Before lists all function components
of the current allocatable group. Select the function component before which
the new instance shall be located. Select at the end of the Allocatable Group
if you want the new instance to be located at the end of the current allocatable
group. If you want to change the data flow order of the instance later use the
Data Flow Order dialog.

Import/Export
In addition to the Import/Export (AFW files) supported by the 800xA system,
Function Designer supports export of diagrams and components into
• XML
• SVG (Scalable Vector Graphics)
• Bitmap
• Enhanced Metafile.
See File Export.
and import of components from
• SVG (Scalable Vector Graphics).
See File Import.
Follow the Import/Export (AFW files) description to import/export function
diagrams and function components including dependencies as AFW files.

File Export
This dialog lets you export:

590 3BDS011224R4101
Section 4 Graphic Editor Reference File Import

• The complete diagram with all pages and all layers as a set of XML and SVG
files (*.xml, *.svg). The exported files contain graphics data only, but no other
aspects nor aspect properties. To export the complete diagram with all its
dependencies and substructure use System 800xA Import Export tool.
• The active layer as SVG file (*.svg). The exported SVG file contains graphics
data only, but no other aspects nor aspect properties.
• The active page (canvas) as bitmap (*.bmp, *.dib)
• The active page (canvas) as enhanced metafile (*.emf)´
This dialog appears when you choose the File > Export menu command.

Figure 352. File Export dialog

File Import
This dialog lets you import SVG files
• exported via the File Export dialog.
• exported via commercial graphic tools supporting SVG, e.g. Adobe Illustrator.

3BDS011224R4101 591
Undo/Redo Section 4 Graphic Editor Reference

This dialog appears when you choose the File > Import menu command.

Figure 353. File Import dialog

Undo/Redo
With the Undo and Redo command you can restore the state of a
diagram/component diagram before doing the last Function Designer command.
It is also possible to undo/redo several commands step by step. The undo/redo stack
is only limited by the computer’s RAM.

Undo
Use the Edit > Undo menu command to undo the previous command. Alternatively,
you can use the shortcut CTRL+Z. The following commands cannot be undone:
• File > New
• File > Save, File > Save All, File > Skip Modifications
• File > Generate Configuration Data (Full Build)
• Allocation > Show Allocation Details
• Changing Type of Component Instances
• Changing Number of Inputs

592 3BDS011224R4101
Section 4 Graphic Editor Reference Redo

• Instantiation and deletion of Control Builder M function blocks and control


modules, that get inserted as aspect objects in Control Structure and in
Functional Structure:
– Insert > Symbol (drag&drop from Object Type Structure)
– Edit > Delete
– Edit > Cut
– Edit > Paste (Ctrl drag&drop).
• Any modifications done outside Function Designer diagram view or
component view. E.g. Plant Explorer create/delete/move/cut/paste aspect
objects cannot be undone, nor Bulk Data Manager modifications.
• Any code-relevant changes modifying the state (e.g. generated or loaded)
cannot be undone. See Diagram States and Transitions.

Redo
If you have undone the last Function Designer command, you can restore the state
before undoing. For it, choose the Edit > Redo menu command or alternatively, the
shortcut CTRL+Y.

3BDS011224R4101 593
Section 4 Graphic Editor Reference

594 3BDS011224R4101
Section 5 Maintenance

Product Verification
After installation you can verify the product version via the Control Panel entry
Add/Remove Programs. Within this list select the Function Designer entry and
press the support information button.
The following figure is an example of a support information:

Figure 354. Function Designer Support Information Example

The product version specification of the Function Designer appears on the right
side from the key word Version of Figure 354. But only the first two digits e.g.
4.0 are the official product version specification. The third and fourth digits are
internal build numbers. Refer also to the Readme information.

3BDS011224R4101 595
Product Verification Section 5 Maintenance

You can also verify the product version from Plant Explorer’s About IndustrialIT
dialog, see Figure 355.

Figure 355. About IndustrialIT Dialog

Finally you can verify the product version inside Function Designer itself: Start-up
the application as described in Application Start-up on page 51 and choose the Help

596 3BDS011224R4101
Section 5 Maintenance Error Messages

> About menu command from the Diagram view/Component view to display an
About dialog as in the following picture:

Figure 356. About Function Designer Dialog Example

Error Messages
If any errors occur, error messages are displayed. There are basically two kind of
errors:
• Errors occurring when handling Aspect Objects from within the Plant Explorer.
These errors are displayed in the Plant Explorer’s Message window (for an
example see Figure 357) and sometimes detailed in a special error window
displayed by Function Designer (see Figure 358).

3BDS011224R4101 597
Error Messages Section 5 Maintenance

• Errors occurring when working in the Function Designer itself, that is, in
Component view or Diagram view of a function aspect. These errors are
displayed in dialog boxes similar to Figure 358.

Figure 357. Error Message in Plant Explorer’s Message Window

Figure 358. Function Designer Error Message

598 3BDS011224R4101
Section 5 Maintenance Reporting Problems

Reporting Problems
The support information (see Figure 354) contains the URL
http://www.abb.com/service.
Via this URL you can report problems by E-mail to the responsible ABB service
organization and you can retrieve the corresponding phone and fax number.
Make sure to report problems with the relevant information, such as the product
version designation and build number displayed in the support information (see
Figure 354), the description of the problem scenario, and the detailed description of
the error messages you got.

Useful Hints

Table 65. Useful Hints

No Case Hint
1 In rare cases Engineering Restart Engineering Workplace and
Workplace crashes after open diagram again.
opening Function Designer
diagram.
2 There are exceptions for For Procedures inouts are shown red,
Red Coloring of "must be even if one side is connected. The other
connected" ports. side is red, but must not be connected
anymore!
For Function Blocks inouts are not
shown red at all, even if they have to be
connected.

3BDS011224R4101 599
Useful Hints Section 5 Maintenance

Table 65. Useful Hints

No Case Hint
3 Function Parameter Aspect You synchronize a diagram with
missing after System components of composite object type,
Synchronize. i.e. components which have formal
instances in Control Structure or
Functional Structure.
For example BiM Control Module of
ProcessObjExtLib has two formal
instances GroupStartObjectConnection
in Control Structure. Both the BiM and
its two GroupStartObjectConnection
children have a Function Parameter
aspect which gets copied to all
instances. After Synchronize, the
Function Parameter aspect of the
GroupStartObjectConnection children is
missing.
As Function Designer does not store
relevant diagram data in that case in the
GroupStartObjectConnection children’s
Function Parameter aspect like position
or connection strings, the missing
Function Parameter aspect can be
ignored.
However, you can also overcome this
problem by running a 2nd Synchronize.

600 3BDS011224R4101
Section 5 Maintenance Useful Hints

Table 65. Useful Hints

No Case Hint
4 Nested diagram types build Nested diagram types build with
with Function Designer Function Designer 3.1.0/0 are missing
3.1.0/0 cannot be an aspect property
instantiated. “AutoParametersSaveTime”. To add this
property and by that to successfully
instantiate such a diagram type in
another one, open the diagram type in
Function Designer 3.1.0/0 Rollup1,
create a dummy Diagram Parameter
and remove it. Check the existence of
the “AutoParametersSaveTime”
property by the Edit > Aspect Properties
command on diagram level.
5 It is not possible to connect Either cast data type or create move
a signal data type having , blocks in between.
e.g. the data type BoolIO to
a diagram reference with
e.g. the data type bool.
signal.
6 Upgrade Function Control Builder 4.0 made changes in its
Diagrams from SV3.1 to "base" libraries 1.0/0, 1.0/1, 1.1/0...
SV4.0 will change diagram although these were already released in
state to ’red’. SV3.1. Most of these changes add new
parameters (e.g. for SIL) to FBs and
CMs. Function Designer detects this as
an interface change and changes the
diagram state of already existing
instances to "red".

3BDS011224R4101 601
Backup / Restore Section 5 Maintenance

Backup / Restore
Backup and Restore as well as Export and Import of data is described in the
IndustrialIT800xA - System, Administration and Security manual.

602 3BDS011224R4101
INDEX

Symbols A
$? 541 absolute reference designation 20
$AllocDetails 257, 541 AC 800M/C controller 235
$AllocGroup 245, 257, 541 AC800M Connect 235
$Date 541 AC800M SB2 Libraries 236
$DiagramName 58 AC800M Signal Extensions 235
$GroupName 541 accelerator keys 452
$LastPage 541 access variables 340
$Name 542 AccordingCB 192
$NextPage 542 AccordingCBAlarmOwnerFlag 192
$ObjectTypeName 58 AccordingTypeDefCreateInfo 192 to 193
$OPCForced 542 ActiveX Control 532
$OPCIOStatus 542 ActiveX Run Mode 393, 442, 533
$OPCIOValue 542 add
$OPCValue 542 aspect property 144
$Order 257, 542 AES Error Context aspect 164
$Page 542 Afw 21
$PGComment 542 AlarmOwner 192
$RefPage 542 align 403, 429
$RefPort 542 components 505, 508, 550, 554
$RefSymbol 542 Allocatable Group
$SymbolName 542 Color 245
$Time 542 Exclude from Configuration Data
.DataType 143 Generation 246
.Direction 143 Short Name 245
.In 143 Show Allocation Details 258
.Initval 144 Allocatable group 20
.InitvalOfObjectType 144 allocatable group 239, 243, 385, 407, 541
.Inverted 144 Allocatable group Aspect 20
.Out 143 allocate
.Visible 144, 207 CBM signal 370
diagram to AC800M/C 266
Numerics HART device 370
800xA - System 38 I/O Signals 273
allocated 341

3BDS011224R4101 603
Index

allocation Aspect Server 22


details 257, 406 Aspect System 22
in Control Structure 370 Aspect system 22
nested diagrams 269 Aspect System Object 22
of diagram 268 Aspect system object 22
toolbar 430 Aspect type 22
Alt key 464, 487 Aspect Verb Synchronize Names 130
left click 453 Aspect view 23
left drag 453 AspectObject 141
Alt+Ctrl key 464, 487 assign
Alt+Shift key 464, 487 components to task 249
Alt+Shift+Ctrl key 464, 487 AsSymbolObject 193
ambient properties 422, 527 Audit event 23
Anchor 20 Audit Trail 229
anchor component 488 Audit trail 23
Annotation layer 20 Authentification 23
Application Engineer User Role 230 Authority 230
ARD 20 AutoArrange 23
Arranging Windows 375 AutoInsert 23
AsAspectObject 193 Autorouting page 587 to 588
Aspect 20
aspect B
default 202 Background layer 23
parameters 132 Backup/restore 229
properties 132 Base library 24
Aspect category 21 BDM option Subtree enabled 154
aspect command Generate Configuration Data 163 BDM option Transaction ’By Object’ 154
aspect command Generate Configuration Data (Full BDM option Transaction ’Data Area’ 154
Build) 163 BDM options 153
Aspect Control 197 BoolIO 290, 331 to 332
Aspect Framework 21 Bulk Data Manager 147
Aspect Integrator Platform 38 Bulk Data Manager Allocate Diagrams 159
Aspect Object 21 Bulk Data Manager Connect Diagram
Aspect Object Architecture 21 References 157
Aspect Object Mapping 240 Bulk Data Manager Copy Diagram(s) 150, 153
Aspect Object structure 21 Bulk Data Manager Diagram Status 165
Aspect Object type 22 Bulk Data Manager Generate Configuration
Aspect Property 22, 140, 144, 208, 390, 422 Data 163
Aspect Property Reference 72, 147, 540, 542, 552 Bulk Data Manager Generate Diagram(s) 175
aspect ratio 464 Bulk Documentation 167

604 3BDS011224R4101
Index

bulk print 578, 580 view 372


Component Properties 527, 546, 558
C Component Properties dialog 543
Casted Data Types 289 Component View 368
Casts 288 Context Menu 421
CBM 24 Component view 24, 373
Change Type 203 ComponentHidden 141
Checks Components Dialog 493, 557
Connections 284 Composite Aspect Object 24
Constants 285 Composite Aspect Object type 25
Inversions 284 connect
Checks for Connections 284 by keyboard 213
Checks for Inversions 284 by mouse 214
circle port 473 string 208, 446
Code Block Sorting 254 to diagram variable 224, 425
Color Connect string 25
Background 530, 544 Connection 25
Foreground 543 connection
Marked Port 531 across diagrams 280
Selection 530 between allocatable groups 283
Transparent Background 544 between blocks 279
color from I/O channels 282
dialog 555 to I/O channels 282
page 529 within nested Diagrams 281
user-defined 565 Connection link 25
COM 24 Connection network 25
command Connection port 25
group 406 Consistency 295
ungroup 406 Contents Chapter 167
Complete Contents 579 contents diagram 167, 578
Complete contents 167 Contents Template 579
component contents template 171
context menu 54 Context menu 26
document 374 to 375, 421 context menu 417
graphic 390, 463 dockable window 432
group 439 Engineering Studio 53
moving 439 Object Aspect 372
pages 374 output window 431
properties 390 toolbar 428
types 239 Control Builder Name 128

3BDS011224R4101 605
Index

control module Customize dialog for toolbars 433


user-defined 238 cut
Control Properties 295 components 516
ControlBuilderDescription 142 document 421
ControlBuilderName 142 cut and paste components 515
ControlConnection 290, 332
copy D
aspect 419 Data Flow Order 252
components 250, 466, 517, 524 data flow order 256, 406
document 421 DataType 138
properties 197 default aspect 202, 421, 424
range 521 default connection 126
reference 384 default properties 422, 559
template 384, 574 default properties dialog 547
tool buttons 437 DefaultIsVisible 58
via context menu 519 DefaultName 58
via drag-and-drop 518 define
via menu command 519 component properties 527
copy and paste components 517 data flow order 252
Copy Diagram(s) via Bulk Data Manager 150, 153 function components 179
Copy to All Instances 197 delete 424
create active page 392
allocatable group 245, 446 allocatable group 406, 446
component 463 aspect 419
connections 473 Aspect Property 146
graphic component 463 components 525, 557
new aspect 455 connections 454
new component 456 page 395 to 396, 443, 575
toolbar 448 ports 454
variables 278 symbols 454
Create Contents dialog 167 toolbar 436
Create Info options 193 user-defined toolbar 451
CrossCommunication 141 Delete from All Structures 264
CrossCommunication aspect 347, 350 DescriptionIsVisible 58
CrossCommunication.CycleTime 141 Detailed contents 171
CrossCommunicationValid 141 Device Integration 365
Ctrl key 464, 487 diagram
cursor 453 context menu 417
left click 453 document 374, 421
left drag 453 function 54

606 3BDS011224R4101
Index

nested 277, 392, 396 port 215, 446


pages 374 Display List 333
reference 223, 225 Display of On-line Values 328, 331
referenced 396 dockable
variable 223, 225 toolbars 377
view 372 windows 376 to 377
diagram page size 173 dockable windows 376
Diagram Parameter 218, 258 Dockable Windows Contect Menu 432
Diagram parameter 26 Document Aspect 26
diagram parameters 126 document aspect 26
Diagram Reference 221, 258 Document Manager 26, 30
Diagram reference 157 Document Reference 541, 552
diagram reference 340 Document reference 26
Diagram States 297 Documentation 167
Generated 301 Double authentification 27
Loaded 302 Download 107
Modified 300 drag and drop 53, 55, 203, 368, 372, 375, 377 to
Unallocated 300 379, 448, 450, 463, 465, 478, 482, 502, 516 to
Unknown 302 517, 520
Diagram Templates 458 drawing
Diagram Types 115, 322 page size 390
Diagram Variable 223, 258 scale 390, 570
diagram variable 157 Drawing page 27
Diagram view 26, 373 Drawing Scale 570
Diagram View Context Menu 421 DTM 369
DiagramIsBad 143 DwordIO 290, 332
DiagramSize.Height 143
DiagramSize.Unit 143 E
DiagramSize.Width 143 Edit > Measurements and Size 173
dialog Edit page 537, 561
color 555 Electronic signature 27, 228
Component Properties 536 Engineering Studio 371
components 557 context menu 53
page 559 window 53
Digital signature 26 Engineering Studio Workplace 371, 520
DintIO 290, 332 Engineering Workplace 51
disconnect EngineerIT 27
Diagram Variable 425 Explicit Object Type 194
from diagram variable 226 Export control library version 233
network 446 Export control network 231

3BDS011224R4101 607
Index

Export control project 231 vertical 405, 511


export file 590 focus component 488
Export function diagram type 234 Font page 544, 555, 562
Extension library 27 font properties 559
External Links Function aspect 28
Input 524 function block
Output 525 user-defined 238
Function Component 23, 29
F context menu 423
Faceplate 27 Function component 28
FF 238 Function component Aspect Object 28
Field Code 540, 552 Function component symbol object 29
Field code 27 Function component template 29
Field page 540, 551 Function component type 29
Fieldbus 28 Function Designer for AC800M 235
Fieldbus Builder 365 Function Designer for AC800M SB2 Libraries 236
Fieldbus device 28 Function diagram 29
Fieldbus Management 369 function diagram 29
file Function Diagram Contents Template aspect 171
check 387 Function Diagram Document aspect 460
create contents 386 Function diagram template 29
export 386, 591 Function diagram type 29
import 386, 591 Function Diagram Variable 223
open contents 386 Function parameter Aspect 29
template 386 Function Settings 58
File > Generate Configuration Data 382
File > Generate Configuration Data (Full G
Build) 382 General Accelerator Keys 452
File > Open Contents 168 General page 536, 546
File > Page Setup 173 Graphic component 30
File > Print 174 graphic component 390, 535, 559
File > Template 173 context menu 426
File Menu 382 Graphic element 30
Fill page 543, 561 graphic element 476
fit to sheet(s) 173 Graphic primitive 30
flip Graphical order 30
around the horizontal 402 grid 391, 422, 438
around the vertical 402 properties 422, 500
components 510 group
horizontal 405, 511 box 554

608 3BDS011224R4101
Index

components 249, 514 graphic objects 438


graphic primitive 466
H image 474
HART 238, 364, 368 label 399
Hook aspect 368 label components 471
HSI 238 line port 399
HWStatus 290, 332 page 395, 400, 575
picture 400, 474
I polycurve 400, 469
IEC 61131-3 naming conventions 128 polygon 400, 468
Import Export polyline 399, 467
Dependencies 231 ports 473
import file 591 rectangle 399, 468
Include Children 231 single line 399
Include Dependencies 231 symbol 399, 481
indicator ’Read’ 393 text 399
IndustrialIT 30 text component 471
IndustrialIT application 30 via drag and drop 478
IndustrialIT product 31 via menu command 480
IndustrialIT system 31 InstantiateAsAspectObject 192
inherit InstantiateComponents 58, 192 to 193
properties 196 InstantiatedByDesignerVersion 143
Inherit to All Instances 196 integration AC 800M/C 235
initial value 219, 223 Internal Links 523
Initial values 261 Inversion 216
InitVal 295 IO allocation 97
InitvalIsVisible 58 IO Allocation tool 87
InitValOfObjectType 295
input reference 157 L
insert label 31, 548
ActiveX 400 insert 399
ActiveX Control 475 to 476 orientation 547
circle port 399 page 547
closed curve 400, 470 properties 559
component 453, 463, 465, 478 layer 31, 438
ellipse 400, 471 annotation 564
Fieldbus Builder 368 Annotation Layer 395
function component 373 background 564
graphic component 390, 463 logic 564
graphic element 400, 476 master page 384, 395, 564, 574

3BDS011224R4101 609
Index

properties 395, 564 Context 417


set 392 Edit 388
Layout File 382
Align Bottom 404 Help 416
Align Center 403 Insert 398
Align Left 403 Layout 402, 439
Align Middle 403 Online 408
Align Right 403 View 391
Align Top 403 Window 411
Flip 405 Menu Bar 32
Group 406 menu bar 380
Make Same Site 404 message size 344
of components 500 MMS cross communication 340
Order 405 MMS CrossCommunication Genearator 345
Rotate 404 MMS Editor 350
Space Evenly 404 MMSCommLib 342
Library 31 MMSConnect 342
Line page 549, 563 MMSReadCyc 342, 344
line port 473 Module 570
Link 31 move
link 25 components 502
Local variables 259 object 453
Log over 32 symbols 453
Logic layer 32 via drag and drop 502
LON 238 multiple selection 452, 486, 488, 498, 527

M N
master page 392 Name Synchronization 130
layer 574 Name Uploader 130
template 573 NameIsVisible 58
Master Page Client Area 534 naming rules 58
Master page layer 32 navigate 387
Master Page Template 573 Goto page 396
MDI 32 page 392, 576
measurement unit 569 to page 396
Measurements 390, 422, 569 to 570 navigation
Measurements and Size 568 horizontal 221
Menu 32 vertical 218
Allocation 406, 408 navigation toolbar 371
bar 376 Nested Diagram 218

610 3BDS011224R4101
Index

Network 32, 208, 211, 213 aspect dialog 462


network 25 context menu 51
network traversal 454 Open Diagram/Component Documents 374
New Component Name 127, 588 Open New Windows 374
Nudge 454 Options dialog 584
Number of Diagram References 228 order components 511
NumberOfInputs 140, 204 outdated 362
outdated diagram state 363
O Outdated MMS Cross Communication Data 300
Object Type Definition Aspect 193 output reference 157
Object Type Definition aspect 195 output window 286
Object Type Definition Extension aspect 195 Override 200
object types override components 419
define 384 Overview 21, 45
of Fieldbus Builder 366 tutorial 62
ObjectDescription 142, 590 workflow 241
ObjectName 142, 589 Overview Contents 579
ObjectTypeGroup 141 Overview contents 167, 172
ObjectTypeName 141
Off-diagram parameter 33 P
Off-diagram reference 33 page
Off-page connector 33 ActiveX Controls 532
OffPageConnector 533 Autorouting 587 to 588
Online colors 529
Add to Display List 333 drawing 567
Remove from Display List 333 Drawing Scale 568
Watch Window 335 edit 537
Online > Remove all Links from Display List 333 field 540, 551
Online > Subscribe for Live Data 333 fill 543
On-line Display 327 font 544, 555, 562
Online Menu 408 general 546
Online Optimized 331 label 562
Online Values 107 labels 547
OPC 33, 146 line 549, 563
bad quality 329 navigation 438, 576
Forced value 329 Off Page Connector 533
Modify value 339 paste 586
Server 103 Position and Size 550
OPC Item 33 print 585
open setup 386, 572

3BDS011224R4101 611
Index

text 552 page 585


page comments 169 preview 387
Pan Print Components on Layers 581
diagram 454 Printer and Printer Page Settings 581
functionality 485 printer page size 173
Parameter reference 34 Product
Parent Diagram view 373 overview 45
paste scope 45
components 250, 516 to 517 verification 49
dokument 421 PROFIBUS 238, 364, 368
links 587 Project 34
page 586 project
Permission 34 data 89
Permissions 230 engineering 34
place Control Module 256 explorer 113
Plant Explorer 34 Project constants 208
Plant Explorer Workplace 52 properties 71, 73, 93, 390, 428
Port 34 ambient 388, 390
port 25 component 537
disconnect 215 components 535
input 237 default 390, 559
invert 216 font 559
multiple selection 494 graphical 388
output 237 label 559
Port Direction 138 Property (Object property) 35
Position and Size page 550 Property reference 35
Position.Page 142 property reference 146
Position.Unit 142 Property Reference dialog 147
Position.X 142 Property References 146
Position.Y 142 Publish via Parent Diagram 149
Preview
window 371 R
Preview Area 34 Read indicator 231, 393
Preview window 34, 371 Read Only 538
preview window 54 RealIO 290, 331 to 332
Primitive 34 Re-authentification 35
print redo command 388, 592
allocation details 257 reference
Component 387 Goto 226 to 227
Diagram 387 template 574

612 3BDS011224R4101
Index

Reference designation 35 left drag 453


remove aspect property 145 show / hide 551
Rename Substructure 131 show allocation details 257
rotate components 509 Show Hidden Ports 205
Show/Hide Ports 204
S Signal Information 119
SCM 35 signature 26 to 27
Scope 45 size
scrollbar component 464, 483, 504, 539, 550
horizontal 431 font 545, 559, 570
vertical 430 grid 394
Security 36 page 550, 567 to 568, 570
Security Definition Aspect 230 paper 391, 394, 572
Security definition aspect 36 properties 537
Security descriptor 36 symbols 452
select text 555
all connections 500 SoftController 101
components 486 Space key
connections 487, 497 cursor 453
contiguous components 488 splitt connection 262
contiguous connections 498 Splitting Windows 375
multiple pages 486 Structure 37
ports 487, 493 to 494, 496 Structured Data Types 290
single connections 497 Subscribe for Life Data 397
single ports 493 Subscribe for Live Data 552
single symbols 489 support
symbols 487, 489, 491, 493 Bulk Data Manager 150
text 488 SVG 591
toolbar 491 Symbol 37
set symbol object 195
properties 558 symbol traversal 454
setup page 572 Synchronize Names 130
SHIFT System 37
left click 452 System 800xA 30, 38
Shift key 464, 487 System 800xA platform 21
cursor key 452 system extension 38, 51, 65, 235
left click 452 System Status Viewer aspect 165
left drag 452 System version 39
Shift+Ctrl key 464, 487
left click 453

3BDS011224R4101 613
Index

T U
Task Connection 100 Unallocated Application 159
Template 573 undo command 388, 592
Template dialog 573 Undo/Redo 592
Text page 552 undock
tool buttons 437 toolbar 377
toolbar window 377
add tool buttons 448 ungroup
align 439, 443 command 406
allocation 244 to 245, 439, 446 components 514
area 428 User Log-Over 231
categories 438 User Roles 230
conection 439
connection 208, 213, 215, 446 V
create user-defined 448 Valid port 342
delete 451 Value.InitVal 219
drawing 476, 535 variable attributes 223
hide 377, 447 VariableAttributes 141
layout 439, 445 VariableDataType 141
list box 434 VariableDataTypeGroup 141
look of 435 VBScript 39
name 435 View 39
nudge 439, 444 allocation details 257
page 434, 438, 443 Component and Diagram 372
remove tool buttons 450 Diagram 373 to 374
rename user-defined 450 grid 394
rotate 439, 509 to 511 grid properties 394
selection 439, 492, 496, 499 layers 395
show 377, 447 pages 396
standard 440 Printable Area 394
structure 444 Snap to Grid 394
user-defined 436 Status Bar 393
view 442, 485 to 486 zoom 394
working with toolbar 433
Toolbar Commands 437 W
toolbars Watch Window 336
name 435 Watch window 110, 336
TypeOfInputs 140 WDI 39
window
arrange icons 415

614 3BDS011224R4101
Index

cascade 413
Component document 373
new window 412
overlap 433
preview 433
Windows registry 59
Workbook Mode 375
Workplace 39
Workspace 59

Z
zoom 422, 442, 483, 485, 584
zooming 391, 485

3BDS011224R4101 615
Index

616 3BDS011224R4101
BackCover.fm Page 19 Wednesday, October 20, 2004 10:27 AM
3BDS011224R4101. Printed in Sweden June 2005
Copyright © 2003-2005 by ABB. All Rights Reserved
® Registered Trademark of ABB.
™ Trademark of ABB.

http://www.abb.com

Automation Technology Products Automation Technology Products Automation Technology Products


Wickliffe, Ohio, USA Västerås, Sweden Mannheim, Germany
www.abb.com/controlsystems www.abb.com/controlsystems www.abb.de/controlsystems

You might also like