1 2 3 4 5 6 7 8 9 10 11 Simatic: Manual

s
Preface, Contents
Quick Start 1
SIMATIC Project Setup 2
AS View 3
PCS 7/APACS+ OS DBA
Plant View 4
Batch
Users Guide for V6.1 PC Station View 5
Manual Adding Batch Types 6
Adding Batch Components to 7

the Plant View
Compiling the Project 8
Object Attributes 9
Advanced Topics 10
Configuring APACS+ for Use 11

with DBA
Edition 11/2005
A5E00595269-01
Safety Guidelines
This manual contains notices you have to observe in order to ensure your personal safety, as well as to
prevent damage to property. The notices referring to your personal safety are highlighted in the manual
by a safety alert symbol, notices referring to property damage only have no safety alert symbol. The
notices shown below are graded according to the degree of danger.
Danger
! indicates that death or severe personal injury will result if proper precautions are not taken.
Warning
! indicates that death or severe personal injury may result if proper precautions are not taken.
Caution
! with a safety alert symbol indicates that minor personal injury can result if proper precautions are not
taken.
Caution
without a safety alert symbol indicates that property damage can result if proper precautions are not
taken.
Notice
indicates that an unintended result or situation can occur if the corresponding notice is not taken into
account.
If more than one degree of danger is present, the warning notice representing the highest degree of
danger will be used. A notice warning of injury to persons with a safety alert symbol may also include a
warning relating to property damage.
Qualified Personnel
The device/system may only be set up and used in conjunction with this documentation. Commissioning
and operation of a device/system may only be performed by qualified personnel. Within the context of
the safety notices in this documentation qualified persons are defined as persons who are authorized to
commission, ground and label devices, systems and circuits in accordance with established safety
practices and standards.
Prescribed Usage
Note the following:
Warning
! This device and its components may only be used for the applications described in the catalog or the
technical description, and only in connection with devices or components from other manufacturers
which have been approved or recommended by Siemens.
Correct, reliable operation of the product requires proper transport, storage, positioning and assembly
as well as careful operation and maintenance.
Trademarks
All names identified by ® are registered trademarks of the Siemens AG.
The remaining trademarks in this publication may be trademarks whose use by third parties for their
own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and
software described. Since variance cannot be precluded entirely, we cannot guarantee full consistency.
However, the information in this publication is reviewed regularly and any necessary corrections are
included in subsequent editions.
Siemens AG Copyright © Siemens AG 2005

Automation and Drives A5E00595269-01
Postfach 4848
90437 NÜRNBERG Siemens AG 2005
GERMANY Technical data subject to change.
Preface
Purpose of the Manual

This manual provides information necessary use to migrate an APACS+ Batch HMI
to a PCS 7 OS using the Database Automation (DBA) utility V6.1.
Required Basic Knowledge

Readers are presumed to be expert in the use of APACS+ Batch HMI software.
Where is this Manual valid?

This manual is valid for the software package PCS 7/APACS+ OS Options V6.1.
Training Centers
Siemens Technical Training Center provides extensive training for all levels of plant
personnel to ensure optimal performance from APACS+ and PCS 7 control
systems. Classes include extensive hands-on activities using appropriate
equipment, making the training directly and immediately applicable.
On-line information is available: http://www.sea.siemens.com/sitrain
Siemens also offers a number of training courses to familiarize you with the
SIMATIC S7 automation system. Please contact your regional training center or
our central training center in D 90327 Nuremberg, Germany for details:
Telephone: +49 (911) 895-3200.
Internet: http://www.sitrain.com
PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

A5E00595269-01 i
Preface
A&D Technical Support

Worldwide, available 24 hours a day:
Nürnberg
Johnson City Beijing
United States: Johnson City, TN Worldwide: Nürnberg Asia / Australia: Beijing

Technical Support and Authorization Technical Support Technical Support and Authorization
Local time: Monday to Friday 24 hours a day, 365 days a year Local time: Monday to Friday
8:00 AM to 5:00 PM Phone:+49 (180) 5050-222 8:00 AM to 5:00 PM
Telephone:+1 (423) 262 2522 Fax:+49 (180) 5050-223 Phone:+86 10 64 75 75 75
or +1 (800) 333-7421 (USA only) E-Mail: ad.support@siemens.com Fax:+86 10 64 74 74 74
Fax:+1 (423) 262 2289 GMT:+1:00 Mail to:ad.support.asia@siemens.com
Mail to: techsupport.sea@siemens.com Authorization GMT:+8:00
GMT: -5:00 Local time: Monday to Friday
8:00 AM to 5:00 PM
Phone: +49 (180) 5050-222
Fax: +49 (180) 5050-223
Mail to: ad.support@siemens.com
GMT: +1:00
Automation and Drives Service and Support International
http://www.siemens.com/automation/service&support
The languages of the SIMATIC Hotlines and the authorization hotline are generally German and English.

ii A5E00595269-01
Contents
Preface i
Contents iii
1 Quick Start 1-1
1.1 Program Operation and Conventions ............................................................... 1-1
1.2 Quick Start Steps (Batch 6.1) ........................................................................... 1-4
2 Project Setup 2-1
2.1 Creating a New WinCC Project (6.1)................................................................ 2-1
2.2 Creating or Opening a DBA Project.................................................................. 2-1
2.3 Importing a Legacy 5.2 DBA Project ................................................................ 2-1
2.4 Importing a Legacy V6.0 DBA Project .............................................................. 2-3
2.5 Opening, Saving, and Closing a DBA Utility Project ........................................ 2-4
3 AS View 3-1
3.1 Adding APACS+ AS Batch Nodes to a 6.1 Project .......................................... 3-1
3.2 Adding OPC Server AS Nodes to a Project...................................................... 3-3
3.3 Loading (Updating) Controller Objects ............................................................. 3-8
3.4 Saving Loading (Updating) Details to a Log File ............................................ 3-10
3.5 Selecting an AS Node Refresh Rate .............................................................. 3-11
3.6 AS View Fields................................................................................................ 3-11
3.7 HMI Comment Injection (HMI Overlay File).................................................... 3-12
4 Plant View 4-1
4.1 Creating the Plant View .................................................................................... 4-1
4.2 Adding a Plant View Folder .............................................................................. 4-3
4.3 Assigning Controller Objects to the Plant View ................................................ 4-4
4.4 Auto-Assigning Resources to the Plant View ................................................... 4-6
4.5 Unassigning (Deleting) Plant View Objects ...................................................... 4-7
5 PC Station View 5-1
5.1 Adding a PC Station ......................................................................................... 5-1
5.2 Adding Applications to an APACS+ OS Batch Single Station Architecture ..... 5-1
5.3 Adding Applications to an APACS+ OS Batch Multiple Station Architecture ... 5-4
5.4 Editing Application Properties........................................................................... 5-9
5.5 Renaming or Deleting an OS from a PC Station ............................................ 5-10
5.6 Updating OS Cache........................................................................................ 5-10
6 Adding Batch Types 6-1
6.1 Adding a Phase Type ....................................................................................... 6-1
6.2 Adding a Parameter to a Phase Type .............................................................. 6-4
6.3 Adding an Equipment Property Type................................................................ 6-6
6.4 Adding Process Tag Types .............................................................................. 6-8
6.5 Adding a Unit of Measure ............................................................................... 6-10
6.6 Adding an Enumerated Data Type to the Batch Data Types ......................... 6-10
6.7 Importing and Exporting Batch Types ............................................................ 6-12
7 Adding Batch Components to the Plant View 7-1
7.1 Adding a Process Cell to the Plant View .......................................................... 7-1
7.2 Adding a Neutral Folder.................................................................................... 7-3

A5E00595269-01 iii
Contents
7.3 Adding Batch Units ........................................................................................... 7-5

7.4 Adding a Phase (6.1) ...................................................................................... 7-10
7.5 Adding an Equipment Module ........................................................................ 7-17
7.6 Adding Process Tag Instances....................................................................... 7-18
7.7 Updating All Instances of Unit Class, Phase Type, and Process Tag Type.. 7-22
7.8 Configuring WinCC Tags for Archiving........................................................... 7-22
8 Compiling the Project 8-1
8.1 Assigning an OS to a Plant View Folder........................................................... 8-1
8.2 Assigning a Batch Server to a Process Cell Folder.......................................... 8-2
8.3 Compiling (Start Compile)................................................................................. 8-2
8.4 Running the OS in Runtime .............................................................................. 8-5
9 Object Attributes 9-1
9.1 Attribute Details ................................................................................................ 9-1
9.2 Alarm Attributes ................................................................................................ 9-1
9.3 Graphic Attributes ............................................................................................. 9-4
9.4 Decimal Place Attributes................................................................................... 9-5
9.5 Object Attribute Editor....................................................................................... 9-6
9.6 Importing and Exporting Object Attributes........................................................ 9-8
10 Advanced Topics 10-1
10.1 Advanced Topics ............................................................................................ 10-1
10.2 Controller Objects ........................................................................................... 10-1
10.3 Batch Validation.............................................................................................. 10-2
10.4 Checking for Duplicate and Missing Symbols ................................................ 10-2
10.5 Ensuring Unique Object Names ..................................................................... 10-4
10.6 Importing and Exporting the Plant View ......................................................... 10-7
11 Configuring APACS+ for Use with DBA 11-1
11.1 DBA Utility Capabilities ................................................................................... 11-1
11.2 4-mation HMI Comments................................................................................ 11-2
11.3 Configuring 4-mation for Individual OS Variables .......................................... 11-4
11.4 Configuring 4-mation for Structured OS Variables ......................................... 11-7
11.5 Defined Type File Layout and Syntax............................................................. 11-7
11.6 Defined Type Variable Comment Syntax ..................................................... 11-10
11.7 Defined Type Message Comment Syntax .................................................... 11-10
11.8 Defined Type Extended Attribute Comment Syntax..................................... 11-13
11.9 Generating Alarms Outside the Controller.................................................... 11-15
11.10 Storing Alarm Acknowledgements and Alarm Lock Outside Controller ....... 11-16
11.11 Function in a Defined Type File.................................................................... 11-18
11.12 Built-In Defined Type File Functions............................................................. 11-19
11.13 User Defined Functions ................................................................................ 11-21
11.14 Variable Source Syntax ................................................................................ 11-22
11.15 Variable Attribute Syntax .............................................................................. 11-23
11.16 Variable Parameter Syntax........................................................................... 11-24
11.17 Defined Type File Editor ............................................................................... 11-25

iv A5E00595269-01
1 Quick Start
1.1 Program Operation and Conventions
Primary GUI Quadrants or Panes

The DBA utility opens to a graphical user interface (GUI) window that comprises
four distinct panes or quadrants:
Plant view: the upper panes of the window depict the plant view. The upper left
pane, sometimes called the technological view, provides the hierarchical plant
view, where objects are represented as folders that can be expanded to reveal
their contents or closed to show uncluttered hierarchical relationships. The
upper right pane typically shows details about objects selected in the left pane.
Tabs on the right pane switch between general characteristics of the selected
objects' attributes, some of which are subject to editing and selection.
Physical objects: the lower panes provide hierarchies and details associated with
the physical equipment that makes up the automation system (AS), such as
controllers and I/O modules, and the PCs that provide the data collection,
monitoring, operator interfaces, and data storage. When a controller has been
selected in the left pane, for example, the right pane displays the function
blocks that make up the controller.
Dragging and Dropping Objects: the program typically supports moving objects
from one quadrant to another by dragging and dropping.

A5E00595269-01 1-1
Quick Start
Menus and Toolbar

1-2 A5E00595269-01
Quick Start
Unique Naming
The DBA utility requires objects to have unique names. The name of an object is its
complete hierarchy name. The DBA utility enforces this requirement by adding a
suffix to a name that would otherwise not be unique.
If you create a folder, for example, its default name is Folder. If you create another,
its default name is Folder1, and so forth:
Renaming Objects
Objects can be renamed by right-clicking and selecting Rename from a context
menu.
Colors
Blue--a read-only value, object or attribute cannot be edited.
Green--an object has changed and will not be updated in the target OS until the
change has been compiled.
Unsaved Changes in a Project

An asterisk follows the project name on the title bar of a project that contains
unsaved changes:
Cautions
The DBA Utility Overwrites Edits Made with SIMATIC Picture Tree Manager

A5E00595269-01 1-3
Quick Start
The DBA utility overwrites manual edits made in SIMATIC Picture Tree Manager.
Do not use the Picture Tree Manager when using DBA to create the Picture Tree.
Instead, edit picture trees with the DBA utility.
Invalid Characters in Folder and Picture Names

Do not use the following character (vertical bar) in folder or picture names: |
Blank spaces are not allowed in pictures names. The filename of a picture-picture
tree file (.pdl) may begin with an amperstand (&), but if it does, the picture is not
available in a PCS 7 OS area's drop-down picture tree list.
In addition, folder and picture names must use characters that are valid in Microsoft
file names. The DBA utility prevents you from naming folders and pictures with the
following invalid characters:
\ / : * ? " < >
1.2 Quick Start Steps (Batch 6.1)
Using the DBA Utility

The quick-start procedures follow a general path for migrating an automation
system (AS) to a PCS 7 OS HMI. An AS consists of all controllers and PLCs with
their associated I/O. The purpose of the Quick Start procedures is to impart a
sense of the operations and considerations involved and to serve as an
introduction to the Advanced Topics.
The quick-start procedures do not address considerations related to preparing the
source AS application for migration. These are covered in the sections beginning
with the title DBA Utility Capabilities.
Steps
1. Creating a New WinCC Batch Project 6.1
2. Creating a DBA Project
3. Adding APACS+ AS Nodes to a Project
4. Adding an OS to a Project (PC station definition)
5. Adding Applications to an APACS+ OS Batch Single Station Architecture
Adding Applications to an APACS+ OS Batch Multiple Station Architecture
6. Creating the Plant View
7. Adding a Process Cell to the Plant View
8. Adding Batch Type
Adding a Phase Type
Adding a Parameter to a Phase Type
Adding an Equipment Property Type
Adding Process Tag Types
Adding a Unit of Measure
Adding an Enumerated Data Type

1-4 A5E00595269-01
Quick Start
9. Adding Batch Components to the Plant View

Adding a Neutral Folder
Adding Batch Units
Adding a Phase
Adding an Equipment Module
Adding Process Tag Instances
Updating All Instances of Unit Class, Phase Type, and Process Tag Type
10. Assigning an OS to a Plant View Folder
11. Compiling (Start Propagation)
12. Running the OS in Runtime

A5E00595269-01 1-5
2 Project Setup
2.1 Creating a New WinCC Project (6.1)

Use Simatic Manager to create and download all OS objects (WinCC Projects) to
be used with the APACS+ Batch option.
Instructions for creating a WinCC Project using Simatic Manager are found in the
publication APACS+ OS Setup Guide for V6.1 (A5E00595265). This
documentation is included with V6.1 software.
2.2 Creating or Opening a DBA Project

To create a new project:
1. Select Start > Simatic > DBA > PCS 7 DBA
The DBA Utility starts.
2. Select File > New Project
A blank project opens in four distinct windows. The caption bar indicates that
the project is new:
2.3 Importing a Legacy 5.2 DBA Project

You can import a DBA project created in a 5.2 version of the utility into the current
version. Doing so allows you to take advantage of new features without repeating
the engineering effort required for the original migration. The session is stored in a
file whose default name is 4-mationSession.xml. This file is created
automatically. You may have to search for it to locate it.
Importing recreates ASs, PC stations, the plant view, and associated pictures.
Siemens recommends that importing be performed on a fresh, newly created
project because importing a legacy project into a project already populated with
objects can have unpredictable results.
1. Right click the Plant View or PC Station View icon.
A context menu appears (the PC Station View appears below; the Plant View
context menu is similar):
2. Select Import Legacy APACS+ DBA Session File.

A Select APACS+ Legacy Session File window opens.

A5E00595269-01 2-1
Project Setup
3. Select the .xml file associated with the legacy project. The default name is 4-
mationSession.xml. Click the Open button.
A Command Status window opens and shows the progress of the import.
4. Ensure that the hierarchy settings in the project match the settings used in the
original DBA 4-mation session (in the topic Ensuring Unique Object Names see
Hierarchy Settings for details). Failure to match the original hierarchy results in
the creation of duplicate symbols in existing graphics.
5. For each root folder in the plant view, right click and select the Edit Folder
Properties feature to associate the folder with a PCS 7 OS server application
6. Associate the folder with the same OS Server application as in the legacy
application. Do this by checking the appropriate OS under Assigned
Components and clicking the OK button:
7. Repeat steps 5 and 6 for each root level folder in the plant view.

2-2 A5E00595269-01
Project Setup
8. Set the OS Area level setting in the Hierarchy Settings to level 2, as shown
below:
Replacing the Current Symbol Set with New, Smaller Symbols

In addition to the standard symbol set, a new, smaller symbol set is also provided.
If you would like to incorporate this new, smaller symbol set in your application,
follow the steps below
1. Delete the old symbols from the .pdl graphic files. They must be removed from
the .pdl graphic file before new ones can take their places.
2. In the DBA utility, edit the Symbol Name (SN) attributes of the objects for
which you wish to use new symbols. See the topic Graphics Attibutes.
Notice
If you do not first delete the existing symbols from the graphics, the new symbols
will not be placed.
3. If you have created custom graphics in your old project, add folders to the
picture tree having the same names as these graphics. If you do, when you
compile the project, the DBA utility automatically associates these .pdl files
with the folder names in the PCS 7 OS picture tree.
2.4 Importing a Legacy V6.0 DBA Project

The preparation required for importing a legacy V6.0 DBA project varies according
to the degree of customization performed on the legacy project.
If the project to be updated to V6.1 was developed using the APACS+ Basic
Application Library and the default defined type files, block icons and faceplates,
the steps to update a server or single-station project are simple:
1. Open the DBA utility program.
2. Perform an entire OS compile.
If the project consists of customized defined type files, block icons, and faceplates,
these components must be updated before opening DBA and performing a
compile.

A5E00595269-01 2-3
Project Setup
Defined Type Files

All defined type files have be updated in V6.1 to provide support for the following:
• Alarm subsystem that allows alarms to be generated in the HMI
• Storage of alarm acknowledgments for controller-generated alarms in the
controller or in the HMI
• Synchronization of alarm acknowledgments between redundant servers
• Persistence of alarm acknowledgments on a server or single-station RESTART
• Alarm lock
• Synchronization of tags between redundant servers
• Persistence of tags on a server or single-station restart
Block Icons
All block icons have be updated in V6.1 to provide support for the following:
• Name field back-lighting when there is navigation to a picture using loop-in-
alarm
• Alarm group display replacement to support alarm lock
• A new attribute to define where a faceplate opens
Faceplates
All faceplates for V6.1 have been updated to provide support for the following:
• Alarm group replacement to support alarm lock
• Alarm lock icon
• Buttons to increase or decrease controller output and setpoint
• Selection of one- or two-step faceplate operation (two-step operation provides
a confirmation dialog box)
• Pinable icons to keep faceplates open when a new picture is opened
2.5 Opening, Saving, and Closing a DBA Utility Project
Opening
The utility opens by default to the most recently closed project. No project is
displayed when the utility is first run.
To open another existing project from the DBA utility program:
Select File > Open Project
An Open dialog box appears.
Browse as necessary and select the project of interest (DBA Utility projects
have the file extension .dba)
To open a recently opened project from the DBA utility program:

2-4 A5E00595269-01
Project Setup
Select File, then select the description of a recently opened file, as shown
below:
To open an existing project from Windows Explorer

Open the folder containing the project of interest (DBA Utility projects have the
file extension .dba). Select and double-click the project name or right-click and
select Open.
Saving
A project can be saved while underway by any of the following actions:
Select File > Save Project
or
Press the Ctrl + S keys
or
Click the save button from the toolbar:
A project must be saved before the first compile to an OS. The Save Project As
window appears if you attempt to compile a project that has not been saved.
Saving Project as
This function saves the current project under a different name at a specified
location.
Select File > Save Project As and select an appropriate location. Note that the
utility supplies the filename extension .dba.
Siemens recommends saving projects in the SIMATIC Manger Project folder to
simplify backups.
Closing
Select File > Close to close a project. If any changes were made since the project
was last opened, the utility gives you an opportunity to save your work before it
closes.
Exiting
Select File > Exit to leave the utility completely. If you try to exit from a project with
unsaved changes, the utility cautions you and gives you an opportunity to save
your changes before exiting.

A5E00595269-01 2-5
3 AS View
3.1 Adding APACS+ AS Batch Nodes to a 6.1 Project

For customers familiar with APACS+ systems, an automation system (AS) node is
an APACS+ controller configuration stored in an .mbr file.
1. Create and open a new DBA project. See Creating or Opening a DBA Project
and Opening, Saving, and Closing a DBA Utility Project.
2. From the menu bar of the DBA utility program, select Edit > Add AS Source
Node.... (or right-click in the AS View pane).
(If multiple AS options are installed, the Select an AS Type window opens. In
this case select the line containing the words APACS+ and APACS+
Controller.)
The APACS+ Configuration Controller dialog box opens (its fields are initially
empty)
3. Click the Generate I/O Tags checkbox to generate I/O tags automatically from
the I/O modules in the configuration without inserting HMI comments for each
of them.
4. Click the Generate Global Tags checkbox to generate global tags
automatically from the global variables except for those variables that are
ARRAY type or already exposed by other HMI comments.
5. Click the Write Alarm Acknowledgements and Alarm Lock Status to the
Controller check box to write alarm acknowledgements and alarm lock status
to the controller. Leaving this box unchecked is useful if controller security has
been turned on, or if you want to prohibit writes to the controller for any other
reason.
6. Select the System Path Browse button (or enter the resource names and
system paths and press the OK button). The system path is typically
x:\Program Files\ProcessSuite\4-mation.

A5E00595269-01 3-1
AS View
For information about the HMI Overlay File see HMI Comment Injection (HMI
Overlay File).
7. The APACS+ Browser window opens, showing all possible offline databases
stored in the folder. The illustration below shows a typical APACS+ resource
selected through the browser:
8. Select the AS node of interest and click the OK button.

The APACS+ Controller Configuration window returns with the selected AS
resource name and system path fields filled in:
9. Click the OK button.

The resource appears in the AS List:

3-2 A5E00595269-01
AS View
The default project name is New. An asterisk following the name indicates that the
project contains changes that have not been saved:
3.2 Adding OPC Server AS Nodes to a Project

The DBA OPC extension supports using a comma-separated variable (CSV) file to
define tags and messages from any OPC Server. For convenience, this extension
is called the CSV processor. The CSV processor creates a suggested WinCC tag
structure based on a set of hints you provide it about the source tag structure of
your application.
1. From the menu bar of the DBA utility program, select Edit > Add AS Source
Node.... (or right-click the AS View pane).
If multiple AS options are installed, the Select an AS Type window opens. In
this case select the OPC Server type):
The PCS 7 OPC Server AS Properties dialog box opens (its fields are initially
empty):

A5E00595269-01 3-3
AS View
2. On the General tab, click the Generate... (browse) button to select the CSV
file that contains the OPC Server configuration.
An AS Node Name field is automatically filled in, but can be edited as
necessary.
3. Click the Connection tab to configure the connection to the OPC Server as
follows:
The Connection Name defaults to OPC, but can be edited.

The OPC Server Machine defaults to <LOCAL> and should not be changed.
The OPC Server Name must be the PROG_ID of the OPC Server you wish to
connect to. You may select it from the pulldown list or type it in manually.
Consult your OPC Server’s user documentation for details about its PROG_ID.
4. Click the Advanced tab is to configure WinCC tags and suggested WinCC tag
structures. These settings provide the hints about the underlying WinCC tag
structures:
The Delimiter field, a string value, specifies the delimiter used to group
similarly named tags into objects. This only affects tags that are not already
grouped by the OBJECTINSTANCE column (described in TAGS Header
Format Recognized by the CSV Processor, below).

3-4 A5E00595269-01
AS View
For example:
The CSV file may include the following tags that are not yet grouped by the
OBJECTINSTANCE column:
PIC100_PV
PIC100_SP
PIC100_V
If the delimiter is set to “_”, the tags will be grouped into a tag structure called
PIC100 with individual elements named PV, SP, and V.
Values in the Min Tags Per Struct and Max Tags Per Struct fields provide
further hints. Tag structures with less than Min Tags Per Struct or more than
Max Tags Per Struct will not be created.
You can provide the Exclusions field string values of instance names to
exclude from processing (see the screen capture above for an example).
These are provided in a comma-separated list.
CSV file Syntax

The CSV header lines have the following requirements:
• The first character of the header line must be a colon (:) followed by the
column name (for example, :ADDRESS)
• Column order does not matter
• Column header case does not matter
• Rows that start with a semicolon (;) are considered comments and ignored
• Commas can be defined if the column is enclosed in double quotes
• If double quotes are needed within a column that is double quoted, use two
double quotes to represent one. For Example, the first column has a value of
"B3:0/1","",11
"""B3:0/1"","""",11",AL_1201A-AL,BIT
The CSV processor recognizes two types of header formats, one for tags, the other
for messages
TAGS Header Format Recognized by the CSV Processor
Element Description
ADDRESS Required column that specifies the address of the tag. This must be complete.
NAME Required column that specifies the name of the tag.
TYPE Required column that specifies the type of WinCC Tag to create (for example, . BIT,
DWORD, TEXT8, etc.)
DESCRIPTION Optional column that specifies a description of the tag. This is unused by default,
but can be referenced by the DBATypeSystem for #comment tags.

A5E00595269-01 3-5
AS View
OBJECTINSTANCE Optional column that is used to group multiple tags into an instance of an object of
the specified name. Note no checking is done to make sure all instances of objects
have the same number of tags or the same tags with the same name and type.
OBJECTTYPE Optional column that is used to specify the type name of the object. All objects
should specify the same value, but the consistency is not checked. If no type is
specified, then no WinCC tag structure will be created.
PATH Optional column that is used to define hierarchy to the Tags and Objects which can
be used by the picture tree wizard.
EXTERNAL Optional column that specifies if the tag is Internal or External. If "0", then Internal,
otherwise External.
HL Optional column that specifies the HI LIMIT of the tag.
LL Optional column that specifies the LO LIMIT of the tag.
INITVALUE Optional column that specifies the START VALUE of the tag.
PERSIST Optional column that specifies if the tag should be persisted. Default is false.
SYNC Optional column that specifies if the tag should be synchronized to the redundant
partner. Default is false.
MESSAGES Header Format Recognized by the CSV Processor
Element Description
MSGNAME Required column that specifies the name of the message. This is required by the
DBA but not used by WinCC.
REFERENCE Required column that specifies how the MSG should be attached to an object. The
following list defines the options:
empty: Attach to all tags with the NAME that matches the CMT attribute.
OBJECTTYPE name: Attach to all tags with the NAME that matches the CMT
attribute that is part of the objects of the specified TYPE.
OBJECTINSTANCE name - Attach to all tags with the NAME that matches the
CMT attribute that is part of the objects of the specified INSTANCE name.
other: Attach to all tags with the NAME that matches the reference string.
ENABLED Optional column that specifies if the message is enabled or not. Default is TRUE.
CLASS Required column that specifies the class of the message.
TYPE Required column that specifies the type of the message.
PRIORITY Optional column that specifies the priority of the message.
TEXT Required column that specifies the text of the message.
SUBSTITUTE Optional column that specifies the substitution string.
CTRTRIGGERTAG Required column that specifies the tag in the controller that triggers the message.
This must refer to an absolute tag name. This value will be monitored by the
EventStateCalc engine and when the condition is present, will set the condition in
the TRIGGERTAG.

3-6 A5E00595269-01
AS View
CTRTRIGGERBIT Optional column that specifies the bit of the CTRTRIGGERTAG that triggers the
message. Default is 0. This value can also contain complex comparison logic to be
described by the EventStateCalc engine design document.
TRIGGERTAG Optional column that specifies the tag that will trigger the message.
TRIGGERBIT Optional column that specifies the bit of the TRIGGERTAG that triggers the
message. Default is 0.
ACKTAG Optional column that specifies the tag that will maintain the ACK state of the
message.
ACKBIT Optional column that specifies the bit of the ACKTAG for this particular message.
DISABLETAG Optional column that specifies the tag that will maintain the DISABLED state of the
message
DISABLEBIT Optional column that specifies the bit of the DISABLETAG for this particular
message.
P1 to P10 Optional columns that specify the P1 - P10 attributes of the message.
F1 to F5 Optional columns that specify the F1 - F5 attributes of the message.
Notice
BOOLEAN TRUE columns can be specified as -1, 1, true, or t.
FALSE columns can be specified as 0, false, or f.
Example of a CSV File Consistent with the CSV Processor
Notice
The line numbers in the sample file provided below are included only for reference
(and to show where CRLFs actually occur), These line numbers do not appear in
the actual file. In the table below, to facilitate viewing, line breaks have been
inserted in the Line Content column. As a result, It would not be possible to extract
the Line Content lines with a simple copy-and-paste operation and process them
with the CSV Processor without first removing these line breaks.
Line number Line Content

01 :ADDRESS,NAME,TYPE,EXTERNAL,DESCRIPTION,PATH,OBJECTINSTANCE,OBJE
CTTYPE,
HL,LL,INITVALUE,,,,,,,,,,,
02 ,EventState,SDWORD,0,,Area1,AL_1201A,SingleBitTag,,,0,,,,,,,,,,,
03 """B3:0/1"","""",11",AL_1201A-AL,BIT,1,Receiving Elevator Leg
Bearing Temp
/ Belt Alignme,Area1,AL_1201A,SingleBitTag,1,0,0,,,,,,,,,,,
04 """B3:0/2"","""",11",AL_1201A-S,BIT,1,Receiving Elevator Leg
Bearing Temp
/ Belt Alignme,Area1,AL_1201A,SingleBitTag,,,,,,,,,,,,,,

A5E00595269-01 3-7
AS View
05 """B3:0/3"","""",11",AL_1201B-AL,BIT,1,Receiving Elevator Leg

Underspeed
Warning Alarm,Area2/Mike,AL_1201B,SingleBitTag,1,0,1,,,,,,,,,,,
06 """B3:0/4"","""",11",AL_1201B-S,BIT,1,Receiving Elevator Leg
Underspeed
Warning Status,Area2/Mike,AL_1201B,SingleBitTag,,,,,,,,,,,,,,
07 """B3:0/5"","""",11",AL_1201C-AL,BIT,1,Receiving Elevator Leg
Underspeed
Shutdown Alarm,,AL_1201C,,1,0,1,,,,,,,,,,,
08 """B3:0/0"","""",11",AL_1201C-S,BIT,1,Receiving Elevator Leg
Underspeed
Shutdown Status,,AL_1201C,,,,,,,,,,,,,,,
09 """B3:0/6"","""",11",AL_1206A_AL,BIT,1,Grinding Supply Elevator
Leg Bearing Temp / Belt A,,,,,,,,,,,,,,,,,
10 """B3:0/7"","""",11",AL_1206A_S,BIT,1,Grinding Supply Elevator
Leg Bearing Temp / Belt A,,,,,,,,,,,,,,,,,
3.3 Loading (Updating) Controller Objects

Loading and Updating refer to translating controller tags and other data structures
from AS nodes into the DBA environment. The first translation is loading;
subsequent iterations are updating. If the controller's objects change in any way
(this includes the addition or deletion of controller objects), use the procedure in the
topic to update the DBA Project.
After controller objects have been loaded or updated, they appear individually in a
list in the Controller Objects quadrant of the DBA Utility program's main window. If
the project contains more than one controller, the list displayed corresponds to the
selected controller.
The process is iterative, and the procedure for initial loading and subsequent
updating is the same.
When a change is made to a 4-Mation configuration, the AS node which references
that configuration is marked as (Changed). This serves as an indication that an
update of the controller objects is required, as described in the steps below. When
a Defined Type File has changed, it is also necessary to update controller objects,
although the AS Nodes that use the changed Define Type File are not marked as
changed. After changing a Defined Type File, always update controller objects for
all impacted AS nodes .
If you have changed the name OR type of an HMI comment in 4-Mation, the object
to which that HMI comment refers to will be shown in the AS Object view as a new
object with the new name and/or type and as a deleted object with the old name
and type. If the old object was previously assigned to a plant view folder and
compiled to an OS Server, it will be necessary to unassign the old object before
successfully compiling again.
The procedure requires that
• The project has been created.
• The AS node has been added.
1. Select and right-click an AS Node.
A pop-up menu appears.

3-8 A5E00595269-01
AS View
2. Select Update Controller Objects, as shown in the following
illustration
The DBA utility responds by displaying a Command Status window, which includes two
progress bars, one labeled Command, the other labeled Step. When the procedure
finishes, the Command portion indicates this with the notation Done. The illustration
below is typical, but can vary according to type of AS
node:
The Command Status Step section shows a progress bar at 100% when the
procedure finishes.
3. To see a log of the loading or updating process, click the Show Details button.
Loading controller object results in a detailed display of controller object
characteristics. This display appears in the lower-right quadrant of the DBA utility's
main window::

A5E00595269-01 3-9
AS View
The Show Details feature is especially useful to confirm that a small change to a
controller node is reflected in the project. The button also leads to a function that
archives the displayed details as a text file.
An alternative to step 2, above, is to select from the menu bar Run > Update
Controller Objects. Doing so updates all AS nodes marked as changed, not just
the selected nodes.
See the advanced topic, Controller Objects.
3.4 Saving Loading (Updating) Details to a Log File

1. Select the Show Details button during the load or update while the Command
Status window is still open.
The Command Status window extends:

3-10 A5E00595269-01
AS View
2. Select the Save button.

A Save AS window opens for entering a filename (the default filename
extension .log is provided).
Notice
If Close When Complete is enabled, the Command Status window
automatically closes, unless the Show Details box is checked or there are errors
or warnings.
3.5 Selecting an AS Node Refresh Rate

Changes made to the AS source database are automatically reflected in the AS
view within the refresh period. The default refresh period is 30 seconds. Change it
by selecting from the menu bar Tools >Option. A program options window
appears, which includes a field for setting or changing the refresh rate:
The default rate is 30 seconds. This should be changed if a different scanning

frequency is desired.
3.6 AS View Fields

Name: The name of the object in the OS. This is the name configured in HMI
comments in 4-mation.
Type: The type of the object in the AS. This is the type configured in the HMI
comment in 4-mation.
AS Address: The address of the object in the AS. This is the path to an object on a
sheet in 4-mation.
Status: This indicates the status of the object.
Add: object added to the AS since the last time controller objects were updated.
See Loading (Updating) Controller Objects.
Modified: object changed since the last time controller objects were updated.
Deleted: object deleted since the last time controller objects were updated.
blank: object unchanged since the last time controller objects were updated.
Assignment: plant view folder to which the object is currently assigned. If blank,
not assigned.
Description: a description of the object.

A5E00595269-01 3-11
AS View
Notice
If you change the name or type of an object, the original object appears in the list
as deleted. The new object's name and type appear with the status of Add.
3.7 HMI Comment Injection (HMI Overlay File)

The HMI Comment Injection feature supports customers who do not currently use
HMI comments in their controller configurations. The entry point to this feature is
the APACS+ Controller Configuration dialog box, which includes an edit box
labeled HMI Overlay File for specifying an overlay file. You can type a path and
filename directly into the edit box or use the Browse... button to find and select it:
By default the edit box is empty and no injection occurs. If the edit box points to a
properly formatted comma-separated variable (CSV) file, then the information from
that file is inserted into the 4-mation export file before it gets processed by DBA. As
a result, HMI comments of any type can be inserted into any part of the controller
configuration without modification to the existing controller configuration.
Format of an HMI Overlay CSVFile

• The first line must have the following two-column format:
Tagname,HMIComment
• The file supports lines with or without double-quote delimiters.

3-12 A5E00595269-01
AS View
• Lines beginning with a semicolon (;) are regarded as comments and ignored.
• The injection processor supports the EXCLUDEMBRCOMMENTS comment
command, which for the DBA utility, in effect removes existing HMI comments
from the MBR. This comment can be added to any line in the CSV injection file.
Tagname in an HMI Overlay File

Tagname is generally the string that defines where to inject the HMI comment. It
can be any of the following: (see Example HMI Comment Injection File below):
• Name of the Derived Network, assuming the name of the network is unique. If
multiple networks with the same name are found, then a warning is reported.
• Name of the Standard Function Block (SFB) instance, assuming the name of
the SFB instance is unique. If multiple SFB instances with the same name are
found, then a warning is reported.
• Complete address (not including the Resource Name) of the Derived Network
(use the Resource Name to address the Resource Sheet)
• Complete address (not including the Resource Name) of the Standard Function
Block
HMIComment in an HMI Overlay File

HMIComment is generally the string that defines the HMI comment to be injected at
the location specified by the Tagname. It can be any of the following: (see Example
HMI Comment Injection File below):
• Type Only string. When this is used, the HMI syntax will be created as follows,
where HMIComment is replaced with the text from the HMIComment column
and InstanceName is replaced with the name of the SFB Instance:
Derived Network Reference --> HMI:.:TYPE=HMIComment:REV=4.00
SFB Instance Reference -->

HMI:.InstanceName.:TYPE=HMIComment:REV=4.00
• Complete the HMI Comment as defined by the standard HMI Comment
specification.
Example HMI Comment Injection File

Tagname HMIComment
PIC_100 SINGLE_LOOP
VA_100 VALVE_A
PLANT_A HMI:|GLOBAL1|:TYPE=REAL
AA_100 HMI:START:TYPE=BOOL

A5E00595269-01 3-13
AS View
How DBA Interprets the Example HMI Injection File

Line beginning with
PIC_100: The line PIC_100 causes DBA to search the exported controller
configuration for the DFB/UDFB that matches PIC_100. If found, DBA injects an
HMI comment onto the sheet in the format HMI:.:TYPE=SINGLE_LOOP. From
the perspective of the DBA utility, this line is the equivalent of an HMI comment
in the controller. The appropriate tags as defined in the Defined Type file called
SINGLE_LOOP are created when DBA compiles to the OS.
VA_100: The line VA_100 causes DBA to search the exported controller
configuration for the DFB/UDFB that matches VA_100. If DBA does not find a
match, it searches for a SFB with this name. Once found, DBA injects an HMI
comment in the format HMI:.VA_100.:TYPE=VALVE_A.onto the sheet that
contains the SFB. From the perspective of the DBA utility, this line is the
equivalent of an HMI comment in the controller. The appropriate tags as
defined in the Defined Type file called VALVE_A are created when DBA
compiles to the OS.
If Tagname is not present, DBA logs a warning to identify the tagname that
could not be found. DBA also posts warnings/errors if the HMIComment TYPE=
Defined Type File either does not exist or has errors. These warnings and
errors include the associated tagname. If an HMI comment is currently in the
Controller Configuration, DBA posts a warning, identifying the tagname for
which a duplicate HMI comment exists. DBA then uses the comment found in
the controller configuration.
PLANT_A: The line PLANT_A (PLANT_A is the name of the Resource/ACM)
causes DBA to add the HMI comment HMI:|GLOBAL1|:TYPE=REAL to the
Resource Sheet. DBA creates a tag in the OS for this global variable. The
Resource Sheet in this example is called PLANT_A.
AA_100: The line AA_100 causes DBA to add the HMI comment
HMI:START:TYPE=BOOL to the sheet PLANT_A.AA_100 where PLANT_A is
the Resource Name and AA_100 is the Program Block instance name. The tag
START of type BOOL is created when DBA compiles to the OS.

3-14 A5E00595269-01
4 Plant View
4.1 Creating the Plant View

Picture trees in PCS 7 OS are created automatically based on the plant view
created in the DBA Utility.
Defining a plant view with the DBA Utility is an interactive process, and the order of
steps required varies depending upon whether you are creating a new plant view
or modifying an existing one.
Consider using the automated tools to create a template, a proposed hierarchy.
You can rename and move picture-tree elements created with these tools to
expedite the process. See Auto-Assigning Resources to the Plant View.
You can also use right-click functions to delete plant-view elements and start over
without significant additional effort.
Considerations:
• Any folder in a plant view can be assigned an OS.
• After a folder is assigned to an OS, all subordinate folders are assigned to the
same OS.
• The structure created in the plant view is reflected in the creation of .pdl
graphics and the navigation scheme of active OS projects.
• Tags are automatically translated to the PCS 7 OS environment if they are
unique. If they are not unique, the tags cannot be created. The DBA utility
displays a validation error upon compilation. See Ensuring Unique Object
Names.
There are two ways to generate a plant view hierarchy, an automated method and
a manual method, which can be used together.
• An automated way to populate the plant view is to permit the DBA utility to
create one or more working templates in the plant view. See Auto-Assigning
Resources to the Plant View. An OS can be assigned to a working template or
you can drag and drop elements from the working template to objects within
the plant view. You are also free to rename and delete folders and objects.
Drag-and-drop functions make it easy to select among objects in the working
template, for example, and incorporate them into a folder that can be assigned
to an OS.
• A manual way to create subordinate structures (folders) in a folder is to select
it and use the right-click, create-folder functions to create a hierarchical picture
tree (at a maximum of 5 folders deep). The default name is Folder1. You can
rename these folders with a maximum of 24 characters (unless the permissible
size of folders is fewer than 24 characters. See Ensuring Unique Object
Names ). The system ensures that folders have unique names by incrementing
the number following the base folder name. You can return to this step any
time before compiling the database to create or modify the structures.

A5E00595269-01 4-1
Plant View
Notice
Every folder must have an OS assigned somewhere in its ancestry. See Assigning
an OS to a Plant View Folder.
Creating a Plant View

1. In the Plant View quadrant, right-click the root-node icon labeled New.
A context menu appears:
2. Click Add Folder.

An icon representing a folder appears (Folder is the default name of the first folder
created in this way; Foldern is the default name for subsequent folders. You can
select a folder and right-click to change its name (subject to some restrictions; see
Ensuring Unique Object Names). Repeat for each folder you wish to create. In the
following illustration, three folders have been created:
You can combine the automated and manual methods, renaming as necessary.
The illustrations below show, on the left, a plant view with three unpopulated
folders: Folder, Folder1, and Folder2. Below the folders are three templates
created with the auto-assign function: Templates, Templates1, and Templates2.
The illustration on the right shows the result of dragging the contents of the
templates into the folders, leaving the templates empty.

4-2 A5E00595269-01
Plant View
The illustration below shows the same plant view after the empty templates have
been deleted.
A folder can be assigned to an actual OS by right clicking on the folder and

selecting Edit Folder Properties. See Assigning an OS to a Plant View Folder for
more information.
The DBA utility program creates a picture for each folder. This picture cannot be
deleted, but it can be renamed.
By default the picture name will be the same as the folder name. In the above
illustration, for example, Folder is used for both the folder and the picture. If you
have existing pictures (.pdl files) from another source you can assign them to the
picture tree by renaming the picture tree name in the picture tree to the name of an
existing .pdl file. For example, you can rename the Folder picture by selecting it,
right-clicking, and renaming.
If the Create/Update Block Icons options is set in the Compile dialog box, the
DBA utility will create a new picture if the picture does not exist.
4.2 Adding a Plant View Folder

Please be familiar with the automated capabilities of the utility, described in Auto-
Assigning Resources to the Plant View, before performing the following manual
procedure.
The plant view is organized into folders. During compilation, a .pdl graphics file is
created for every folder in the plant view. Every controller object that is assigned
to a folder is automatically added to the .pdl file which corresponds to that folder,
greatly simplifying the process of creating process graphics.
The organization of folders in the picture tree defines the navigation scheme for an
OS.
1. Select a folder in the plant view.
2. Select Edit > Add Folder (or right-click a folder and select Add Folder)
A new folder appears in the plant view.
A folder's default name Folder is editable immediately after it has been added. To
change the name later, select the folder, right-click, and select Rename. If the
entered name is not unique, the change is rejected and the old name is restored.
You can add folders five deep:

A5E00595269-01 4-3
Plant View
4.3 Assigning Controller Objects to the Plant View

Please be familiar with the information in Auto-Assigning Resources to the Plant
View before completing the following procedure.
1. Create a DBA project.
See Related topics
Assigning an OS to a Plant View Folder
Adding APACS+ AS Batch Nodes to a 6.1 Project
Creating or Opening a DBA Project
2. From the AS view, select the AS of interest, right-click, and select Update
Controller Objects. See Loading (Updating) Controller Objects
3. Select a controller object in the AS Objects pane.
4. Drag and drop the controller object onto a folder in the plant view. The cursor
becomes a "not" icon, as shown in the following illustration, if it hovers over a
picture tree object that is not a folder. The drop operation is permitted only on a
folder.
When the cursor hovers above a folder, the cursor becomes a plus (+) sign,

4-4 A5E00595269-01
Plant View
indicating that the drop operation is permitted:
It is possible to drag and drop multiple controller objects in a single operation.

Windows list-selection techniques apply in the list of controller objects (shift-click to
select contiguous objects, control-click to add objects). In addition, if the cursor is in
the list of controller objects, the conventional select-all key code (Ctrl+ A pressed
simultaneously) selects the entire list.
You can also assign all controller objects to a folder by drag-and-dropping an AS
node. This displays a percent-complete dialog box and an option to halt the
operation.
Finally, in addition to dragging items to the plant view directly, it is possible to
select a folder in the plant view and drag an item to the Objects tab to the right of
the Plant View as shown below. This has the same effect as dragging the object or
objects directly to the plant view folder.
There are some restrictions to drag and drop operations regarding batch projects.
Phase (PHASE_AFB), Unit (UNIT_AFB) and batch parameter (for example,
INBOOL_AFB) block types can not be dragged to ordinary plant view folders.
These are special blocks used for linking to components in a process cell. Refer to
the appropriate topics under the title Adding Batch Components to a Process Cell
for details concerning the use of these blocks.

A5E00595269-01 4-5
Plant View
If you attempt to drag a batch block to a an ordinary plant view folder, the following
message is displayed:
This similar message is also displayed if you attempt to drag multiple controller
objects (including an entire AS node) and at least one of the controller objects is a
batch block:
Lifebeat Monitor
Notice
For the PCS 7 Lifebeat Monitoring System to operate correctly, the
RESOURCE_STATUS_AFB block for each controller must be mapped to the PCS
7 OS.
4.4 Auto-Assigning Resources to the Plant View

The DBA Utility can examine the structure of your AS database and create a
proposed plant view hierarchy based upon the names of controller objects and
their apparent relationships to one another.
Plant view elements created in this way can be renamed as necessary and moved
among hierarchies created automatically or manually.
In the plant view, a "working template" is created which contains a provisional plant
view and a set of object assignments. After the auto-assignment is complete, you
can make whatever manual changes you require, including moving folders from the
working template to other folders in the plant view.
When you use the auto-assign feature, the hierarchy created in the working
template is based on the hierarchy specified for the resource in 4-mation.
1. In the AS view, select an AS from the AS list.
2. Right-click and from the shortcut menu select Auto-Assign Resources to the
Plant View:

4-6 A5E00595269-01
Plant View
The DBA utility offers an opportunity to ensure uniqueness in object names.

See Ensuring Unique Object Names.
Auto-assignment is useful if the working template is to be a starting point for the
plant view configuration, but does not match exactly the desired final form of the
plant view. Alternatively, the entire working template can be dragged to another
folder in the plant view to create an entire plant view in one drag-and-drop
operation.
The illustration below on the left shows a plant view with four folders. The auto-
assign utility created Templates and Templates1. The folders Area1 and Area2
were created with the right-click, add-folder function. The illustration on the right
shows the plant view after the content of the templates folders were dragged-and-
dropped onto the AreaN folders and the template folders were deleted:
If you have a valid Simatic APACS+ DBA Batch license installed and have created
a process cell, objects will be auto-assigned to the process cell. In addition to
assigning the objects, the program creates unit classes and instances
corresponding to each UNIT_AFB block in the 4-mation Configuration. It also
creates phase types and phase Instances corresponding to each PHASE_AFB
block in the 4-mation configuration. Refer to the discussion of Process Cell
Attributes in Adding a Process Cell to the Plant View for details regarding the
strategy the DBA utility uses in creating phase types.
4.5 Unassigning (Deleting) Plant View Objects

There are several ways to remove objects from the plant view. (Removing a
controller object from the plant view does not remove it from the list of controller
objects in the AS view, only from the plant view.)

A5E00595269-01 4-7
Plant View
Right-click the object and select Unassign:
• Select the object and press the keyboard Delete key (one object at a time).
• Select the object and press the keyboard Delete key (when done from plant
view detail list view, this technique allows multi-deletion).
• Drag a symbol from the plant view and drop it on an AS list view (one object at
a time).
Notice
The folder name and the picture name as displayed in DBA should be kept the
same to avoid confusion for those maintaining the system.

4-8 A5E00595269-01
5 PC Station View
5.1 Adding a PC Station

1. Start the DBA Utility and open an existing DBA project or create and open a
new project.
See Creating or Opening a DBA Project and Opening, Saving, and Closing a
DBA Utility Project.
2. Select the PC Station View tab in the bottom pane.
A node named New appears in the window:
3. Right Click the New node and select Add PC Station:
The bottom right pane provides a Value column for entering the PC station
name, Node_052 in the example below:
4. If your system architecture includes more than one PC station, you can add
and name them now or return to this step later.
After a PC station is added, you can add an application to it.
See Adding Applications to an APACS+ OS Batch Single Station Architecture and
Adding Applications to an APACS+ OS Batch Multiple Station Architecture.
5.2 Adding Applications to an APACS+ OS Batch Single

Station Architecture
Within the context of the DBA utility program, to add an application to a PC station
is to specify or determine its function within a system architecture.

A5E00595269-01 5-1
PC Station View
The illustration below shows a typical single station architecture. Node_065 is an

optional engineering station (ES) that is included in most single station
architectures. It is possible to use the batch single station for ES functions, but
most organizations prefer to keep engineering functions on a separate PC. For
purposes of illustration, the DBA utility is running on this engineering workstation.
1. Using the procedure in Adding a PC Station, add a PC station whose

Computer Name corresponds to the network name of the PC:
2. Right-click the PC station and select Add Application from the context menu:
The Select an Application Type window appears:

5-2 A5E00595269-01
PC Station View
3. Select PCS 7 OS (Server/Single Station) and click the OK button.

A properties window opens:
4. In the Offline MCP File value field, use the browse button to find the name
of the current DBA project. This DBA project resides on the system performing
engineering functions. In the architectural drawing above, this is Node_065.
5. In the Online MCP File value field, browse to or enter the network address of
the online or target .MCP file. In the architectural drawing above, this file
resides in Node_077:
6. Right-click on PC station again and select Add Application,

The Select an Application Type window re-appears, but with fewer options.
7. Select Simatic Batch (Server) and click the OK button.
The batch server application is added to the PC station and a properties
window opens.
8. Select the Alarm OS attribute, and from the pulldown menu select an alarm
server for the batch OS. Note: Select an OS server assigned to the process
cell in the plant view folder. If no OS has been created (step 3, above), there
will be nothing to select in the pulldown menu
9. Right-click the PC station again to add Simatic Batch (Client) if one is

required. There are no properties to set for a batch client.

A5E00595269-01 5-3
PC Station View
Note: It is not necessary to add an PCS 7 OS client application.

For an alternate method of adding or editing application properties, see Editing
Application Properties.
5.3 Adding Applications to an APACS+ OS Batch Multiple

Station Architecture
Within the context of the DBA utility program, to add an application to a PC station
is to specify or determine its function within a system architecture.
The illustration below shows a typical multiple station architecture. Node_065 is an
optional engineering station (ES) that is included in most architectures. Most
organizations prefer to keep engineering functions on a PC that is not used for
control. For purposes of illustration, the DBA utility is running on this engineering
workstation.
Adding a PCS 7 Server and Standby Server
Adding a Batch Server and Standby Server
Adding a Batch Client
1. Using the procedure in Adding a PC Station, add PC stations for each PC in

the system architecture. Ensure that the Computer Name fields correspond to
the network names of the PCs
The result is a PC station view similar to the following, which shows the
Computer Name field for the selected station filled in:

5-4 A5E00595269-01
PC Station View
1. Right-click the PC station that is destined to be the OS server and select Add
Application from the context menu:
2. Select PCS 7 OS (Server/Single Station) and click the OK button.

A properties window opens:
3. In the Offline MCP File value field, use the browse button to find the name
of the current DBA project. This DBA project resides on the system performing

A5E00595269-01 5-5
PC Station View
engineering functions. In the architectural drawing above, this is Node_065.

This project must exist (there must be a file with the project name followed by
the .MCP filename extension). The DBA utility will not accept an entry is this
field for a file that does not exist.
Note: Before specifying the MCP file for a standby OS server, you must first
create a dummy or placeholder OS project so that the MCP file exists.
4. In the Online MCP File value field, browse to or enter the network address of
the offline or target .MCP file. In the architectural drawing above, this file
resides in Node_079.
Note: If this field is not filled in correctly before a Simatic batch compile with
the Download selected, the DBA utility displays a warning. The WinCC Project
Duplicator creates the Online MPC file automatically when it deploys the
Offline MCP file. When first setting up the system, it is preferable to perform as
OS compile only, then deploy the project to the online target using the WinCC
Project duplicator. It is also possible to create a dummy or placeholder project
on the online node, which is replaced when the WinCC Project Duplicator
deploys the offline project.
5. If the OS server is redundant it is necessary to define a standby OS server. In

the case of the typical architectural drawing provided at the beginning of this
topic, the redundant OS server is Node_078. To add a standby OS server,
select Node_078 and repeat steps 2 through 5, adding a PCS 7 OS (Standby)
application:

5-6 A5E00595269-01
PC Station View
6. If a redundant (standby) OS has been defined, the Standby OS attribute for

the OS server field will have a drop-down menu with the standby OS available
as a selection. Any time after it has been defined, you can return to this
server's Standby OS attribute field to specify it. You can also use an alternate
method to specify it. See Editing Application Properties:
7. Repeat these steps for every OS sever or OS server pair in your system.
Note: It is not necessary to configure OS client applications.
Adding a Batch Server and Standby Server

1. Right-click the PC station that is destined to be the OS server (Node_067 in
the illustration at the beginning of the topic and select Add Application from
the context menu.

A5E00595269-01 5-7
PC Station View
2. Select Simatic Batch (Server).

The server is added to the node, and a properties window opens in the lower-
right pane.
3. Select the Alarm OS attribute, and from the pulldown menu select an alarm
server for the batch OS. Note: be sure to select an OS server that is being
assigned to the process cell in the plant view folder.
4. If the batch server is redundant, right-click the PC station that is destined to be

the batch standby server (Node_067 in the illustration at the beginning of the
topic) and select Add Application from the context menu.
The Select an Application Type window appears

5-8 A5E00595269-01
PC Station View
5. Select Simatic Batch (standby) and click the OK button.

6. If the batch server is also a batch client, follow the procedure below titled
Adding a Batch Client.
Adding a Batch Client

You can install a batch client application on a standalone PC (Node_052 in the
illustration at the beginning of the topic) or on a server.
1. Right-click the PC station destined to be a batch client and select Add
Application.
The Select an Application Type window opens:
2. Select Simatic Batch (Client) and click the OK button.

The client application appears in the hierarchy below the PC Station, either by
itself or in conjunction with another application:
3. Repeat for each batch client in your system.
5.4 Editing Application Properties

After an application has been assigned to a PC station, it is possible to change any
of its attributes through this procedure:
1. Expand the PC station hierarchy containing the application.
The assigned application or applications are listed (for example, OS and
OSStandby).
2. Right-click the application of interest.
A context menu appears.
3. Select Edit Object Properties... from the context menu.
A window opens containing fields for the configurable attributes. The following
window is for an OS application:

A5E00595269-01 5-9
PC Station View
4. Use the browse button if it is available or enter information directly. Check the
OK button to register any changes.
Notice
Multiple OS nodes can not be assigned to the same .mcp file.
5.5 Renaming or Deleting an OS from a PC Station

Please be familiar with the automated capabilities of the utility, described in Auto-
Assigning Resources to the Plant View, before performing the following manual
procedure:
1. Select the OS in the PC Station View
2. Right-click and select Rename or Delete from the menu:
If you press Rename, the OS name becomes selected, editable text. Type the
desired name and press the Enter key or move the cursor off the edit box and
click.
5.6 Updating OS Cache

To simplify the browsing for information stored in the WinCC database, DBA
provides a caching feature.
This cache stores all of the alarm types and classes that have been configured in
the WinCC project (using the OS Project Editor).

5-10 A5E00595269-01
PC Station View
• All of the archive tags available in the WinCC project. This cached information
is useful for browsing archive tags in Batch Phase and Process Tag
parameters. Note that the archive tags are configured in the WinCC Project
using WinCC Explorer and the Tag Logging editor. See Configuring WinCC
Tags for Archiving.
• All of the alarm types and classes that have been configured in the WinCC
project (using the OS Project Editor).
A cache is maintained for each OS in the DBA project, and it is updated by DBA
automatically every time an OS is compiled. It is also possible to update this cache
manually. To update the cache manually:
1. Locate the PC station containing the OS of interest.
2. Right-click the OS application.
3. Select the Refresh OS Cache option.

A5E00595269-01 5-11
6 Adding Batch Types
6.1 Adding a Phase Type

The process cell must exist before you can create a new phase type.
For further information, see these topics
• Adding a Process Cell to the Plant View.
• Adding Parameters to a Phase Type.
• Updating All Instances of a Unit Class or Phase Type
There are two ways to add a phase type to a process cell:
• Manually Creating a Phase Type
• Dragging and Dropping an Existing Phase to a Phase Type Folder
Manually Creating a Phase Type

1. Expand the process cell.
The available batch types appear in a level subordinate the process cell.
2. Right-click the Phase Types folder.

A5E00595269-01 6-1
Adding Batch Types
3. Select Add Phase Type.

A phase type with the default name of PHASETYPE appears in the list.
4. To rename a phase type, right-click and select Rename:
Editing Phase Type Attributes

1. Select the phase type and click the Attributes tab:

6-2 A5E00595269-01
Adding Batch Types
2. Change the contents attribute Value fields:

Author: A free-form text field for identifying the engineering entity that created the
phase type.
Comment: Free-form text field to annotate the phase type in any way.
Description: A free-form text description of the phase type.
Dragging and Dropping an Existing Phase Type to a Phase Type Folder

The DBA utility program supports dragging and dropping of an existing phase type
onto the process cell phase types list to create a new phase folder as an available
batch type. This operation assumes that a controller with a suitable phase function
block is available from the AS view.
1. In the upper left pane, expand the process cell hierarchy as necessary to
display the Phase Types folder. See the illustration below step 4.
2. In the lower-left pane, click the AS View if necessary and select the controller
containing the phase function block of interest.
3. In the lower-right pane, click and hold the left mouse button to select the row
containing the phase function block.
4. Drag and drop the function block onto the Phase Types
folder:
The phase type is added to the available phase types:

5. Expand the new phase type (CHARGE2 in the illustration below) to ensure that
it includes the required parameters. Check the attributes of the phase
parameters by clicking them in turn in the process cell hierarchy. The attributes
appear in the right pane.

A5E00595269-01 6-3 2
Adding Batch Types
Refer to the discussion of process cell attributes in Adding a Process Cell to the
Plant View for information on how the DBA utility creates phase types as a result of
a drag-and-drop operation.
Drag-and-Drop Tip
It is possible to create a phase type and instance with a single drag-and-drop by
dragging the phase onto a unit or equipment folder. This action creates a phase
type in the folder and an instance of the phase type in the process cell folder.
6.2 Adding a Parameter to a Phase Type

1. Right-click the phase type.
2. Select Add Parameter.

A parameter with the default name PARAMETERn appears in the hierarchy
below the phase type:

6-4 A5E00595269-01
Adding Batch Types
3. To rename a phase type parameter, right-click and select Rename:
4. Click the parameter in the phase and select the Attributes tab:
5. Change the contents of the attribute Value fields as described below:
Editing Parameter Type Attributes

Actual: An option field for entry of an integer identifier that an external program
using the Simatic Batch API can use to identify the parameter.
Archive: Indicates whether the parameter will be archived during the running of
batches which use this type. Select yes or no from the drop-down list. If yes is
selected, a WinCC Archive attributes is available in the parameter instance of
all parameters created from the phase or process tag type. See the subtopic
Assigning a WinCC Archive Tag in the topic Adding a Phase.
Data Type: The data type of the parameter. To choose a data type, select from the
drop-down list, which shows all standard data types as well as enumerated data
types that are available in the project. See Enumerated Data Type:

A5E00595269-01 6-5
Adding Batch Types
Engineering Units: Engineering units type for the parameter. To choose

engineering units, select from the drop-down list, which shows all standard
Engineering units as well as any custom units of measure available in the
project. See Adding a Unit of Measure. Note that this attribute is only present
for parameters that represent numeric quantities (integer, float, input material or
output material).
Lower Limit/Upper Limit: These attributes indicate the default lower and upper
limits of the parameter. These limits are used as the default for all parameter
instances created from this parameter type. Note that these attributes are only
present for parameters that represent numeric quantities (integer, float, input
material or output material).
The limits of an instance of a phase type can be modified to reflect the actual
limits of the phase parameter.
Description: A free-form text description of the parameter.
Setpoint ID: An optional field for entry of an integer identifier that an external
program using the Simatic Batch API can use to identify the parameter.
To update all instance of the unit class, refer to Updating All Instances of Unit
Class, Phase Type, and Process Tag Type.
6.3 Adding an Equipment Property Type

Equipment properties can be added to any unit in a process cell. For example, a
unit can be assigned an equipment property of Type, which could be a choice of
Reactor or Tank. For equipment designated as Tank, there could be an additional
equipment property of Capacity. Given these equipment properties, a recipe could
include a specific phase that allocates a Unit with a Type of Tank with a Capacity of
5000 liters.
Before an equipment property can be assigned to a unit, it must be established as
a batch type.
Prerequisites for Creating Equipment Property Types

• If the attributes of the envisioned equipment property include engineering units
that do not yet exist, they must be added before the equipment property type is
created.
See Adding a Unit of Measure.

• If the attributes of the envisioned equipment property include enumeration data
types that do not yet exist, they must be added before the equipment property
type is created.
For example, an equipment property type TankStyle needs to have three

possible values: Ceramic, StainlessSteel and Teflon. An enumeration data
type Styles could be created in the Data Types folder, with Styles consisting of
three enumeration values:
0 = StainlessSteel
1 = Ceramic
2 = Teflon.

6-6 A5E00595269-01
Adding Batch Types
See Adding an Enumerated Data Type.
Manually Creating a New Equipment Property Type

1. Expand the process cell.
The available batch types appear in a level subordinate to the process cell.
2. Right-click the Equipment Properties folder.
3. Select Add Equipment Property Type

The utility adds an equipment property type to the list, adjusting the suffix of
the name as necessary to ensure uniqueness:
4. To rename a unit class, right-click and select Rename:

The current name becomes an editable field.

A5E00595269-01 6-7
Adding Batch Types
Editing Equipment Property Type Attributes

1. Select the equipment property and click the Attributes tab:
2. Change the contents of attribute Value fields as necessary:

DataType A drop-down list box contains the available data types
Description: A free-form text description of the unit class.
Engineering Unit: A drop-down list box contains the available engineering units:
6.4 Adding Process Tag Types

Process Tag types represent data that are needed by Simatic Batch but not automatically
acquired by the batch manager. Process tags are required for these functions:
• To configure tags for archiving

• As arguments in a transition inside a SIMATIC BATCH recipe procedure

6-8 A5E00595269-01
Adding Batch Types
Procedure
1. Expand the process cell to display the Process Tag Type. Right-click the
Process Tag Type folder. A Context Menu appears:
2. Select Add Process Tag Type.

Another context menu appears.
3. To rename the process tag type, right click and select Rename:
4. Select Add Parameter.
A parameter appears in the process cell hierarchy.

5. Right-click the parameter and select the Attributes tab:

A5E00595269-01 6-9
Adding Batch Types
Attributes are described in the topic Adding a Parameter to a Phase_Type.

To update all instances of a process tag type, see Updating All Instances of Unit
Class, Phase Type, and Process Tag Type.
6.5 Adding a Unit of Measure

1. In the plant view, expand the process cell icon to reveal the batch type units of
measure.
2. Right-click the Units of Measure folder.
3. Select Add Unit of Measure.

A new unit of measure appears in the list, with a default name of EUn. You can
rename this unit of measure.
4. In the right pane, you can change the default placeholder value Engineering
Units with a unit designation that is meaningful to your process:
6.6 Adding an Enumerated Data Type to the Batch Data

Types
An enumerated data type is a custom data structure typically used to represent
states of a individual process, such as Start, Run, Hold, Shutdown, etc. After they
are created, they become available data types for batch parameters.
To create an enumerated data type.

1. Create a process cell. Expand the process cell hierarchy to display the Batch
Types and Data Types.

6-10 A5E00595269-01
Adding Batch Types
2. Right-click the Data Types icon.

3. Select Add Enumerated Datatype.

A new data type labeled ENUM appears in the list of available data types.
4. If you wish to rename an enumerated data type, right-click it and select

Rename from the context menu.
5. To add a value to the enumerated data type structure, right-click it and select
Add Enumeration Value. The following illustration shows this on an
enumerated value that has been renamed to Plant State:
The first enumerated value created in this way is labeled by default

A5E00595269-01 6-11
Adding Batch Types
EnumValue. Subsequent values are given a suffix to ensure uniqueness:
6. Right-click each enumerated value in turn and rename them.
7. After renaming the enumerated values, select them in turn and assign them
values. The following illustration shows the enumerated data type Plant State
with an enumerated value Hold given the value 3:
Having been defined and assigned values, the enumerated data types are
available as data types in parameters.
6.7 Importing and Exporting Batch Types

The DBA utility has provisions for exporting and importing batch types. The
purpose of these features is to simplify the creation of new projects that are
identical or similar to an existing project. The utility is flexible in that it supports the
export and import of selected batch types. If you have an elaborate, custom
enumerated data type, for example, and use it repeatedly, you can select it for
export and reuse.
By default these functions write to and read from the directory x:\Program
Files\Siemens\WINCC\WinCC Projects.
Exporting
1. Expand the process cell to reveal the batch types folder.

6-12 A5E00595269-01
Adding Batch Types
2. Right-click the batch types folder.

3. Select Export Batch Types.

The Batch Type Export Wizard window appears. On the left is a list of batch
types available for export. On the right is a list of types selected for export. The
list of selected types is initially empty
Note: Standard data types, such as integer, are automatically included for all batch
projects and therefore are not available for import/export.

A5E00595269-01 6-13
Adding Batch Types
4. Use the selection button to move batch types between the lists:
5. If you only wanted to export the enumerated data type Plant State, for
example, the Selected Batch Types list would look like the following:
6. Press the Start button to begin exporting

A Save AS window appears.
7. Enter a filename and click the OK button.
Importing
If an imported batch type has the same name as an existing batch type, the
program renames the type it is importing rather than overwriting the existing object.
In the topic Program Operations and Conventions see the subtopic Unique Names.
1. Expand to process cell to reveal the batch types folder.
2. Right-click the batch types folder.
3. Select Import Batch Types.

An Open window appears.
4. Select the file of interest (typically with the extension .xml) and click the Open
button
The Batch Type Import Wizard opens.
5. From the list of available batch types, select the type of interest. In the
following illustration, the phase type HEATCOOL is selected.

6-14 A5E00595269-01
Adding Batch Types
The object is imported into the batch type list:
Note: Standard data types, such as integer, are automatically included for all batch
projects and therefore are not available for import/export.

A5E00595269-01 6-15
7 Adding Batch Components to the Plant
View
7.1 Adding a Process Cell to the Plant View

Before adding batch types, it is necessary to add a process cell to the project.
1. In the Plant View, right-click the New icon.
2. Select Add Process Cell from the context menu.

A process cell is created. It contains a folder called Batch Types that is
populated with default batch types:
3. You can rename the process cell by right-clicking a selecting Rename:

A5E00595269-01 7-1
Adding Batch Components to the Plant View
Process Cell Attributes

To edit the attributes of the process cell, select the cell and select the Attributes
tab:
process cell.
Comment: Free-form text field to annotate the process cell in any way.
Description: A free-form text description of the process cell.
The attributes Reuse Existing Type and Reuse Existing Type with Same Name
determine the strategy that the DBA utility uses automatically to create unit
classes and phase types. This strategy applies during
• automatic assignment of an AS node to the plant view
• dragging and dropping an AS unit or phase block to the process cell or
batch type folder.
Reuse Existing Type: This attribute determines the strategy for DBA to use when
it detects that a potentially new unit class or phase type exists that matches an
existing unit class or phase type (all parameters are identical to those of an
existing type, but the type name of the new type is different from the existing
type). You select the reuse strategy by selecting the drop-down list of attribute
values:
• Prompt: The DBA utility never automatically creates a new types. When it
detects a type match, it prompts you, asking whether to reuse the existing
type or to create a new one.
• Yes: The DBA utility always reuses existing types when it detects a type
match.
• No: The DBA utility never reuses existing types when it detects a type
match.

7-2 A5E00595269-01
Reuse Existing Type with Same Name: This attribute determines the strategy for
DBA to use when it detects that a potentially new unit class or phase type exists
that matches an existing unit class or phase type (all parameters are identical to
those of an existing type AND the type name of the new type is the same as the
name for an existing type). You select the reuse strategy by selecting the
drop-down list of attribute values:
• Prompt: In this case, DBA will never automatically create a new type.
When it detects that a new type matches an existing type, you will be
prompted as to whether to reuse the existing type or to create a new type.
If you respond yes, the existing type is reused. If you select no, a new type
is created. The type name is the same as the existing name, with a number
attached to make it unique.
• Yes:In this case, DBA always reuses existing types when it detects a type
match.
• No: In this case, DBA always creates a new type, even if it detects an
existing type with identical parameters.
7.2 Adding a Neutral Folder

Neutral folders are custom divisions of a process cell that reflect the subdivisions of
the process. Neutral folders are initially labeled Foldern, where n indicates the
order of their creation This name is only a placeholder. Folders are typically
renamed to reflect the structure of the process cell.
Folders can be subdivision of process cells, units, or other folders:
The illustration below shows the folders as subdivision of process cells and of other
folders:

A5E00595269-01 7-3
1. Right-click a batch component and select Add Neutral Folder. Folders are
created by a context menu selection available in batch components that
support folders. The following illustration, for example, shows the context menu
for the process cell:
2. To rename a neutral folder, right-click and select Rename:
Editing Neutral Folder Attributes

1. Select the folder and click the attributes tab:
2. Edit the attribute Value field.

folder.

7-4 A5E00595269-01
Comment: Free-form text field to annotate the neutral folder in any way.
Description: A free-form text description of the folder.
7.3 Adding Batch Units

Units can be added to the process cell or to neutral folders.
See Adding a Neutral Folder.
There are two ways to add batch units to a process cell
• Using drag-and-drop techniques
• Manually
Dragging and Dropping Batch Units

You can drag and drop batch units after you have added an AS source node and
updated its controller objects:
• Adding APACS+ AS Batch Nodes to a 6.1 Project
• Loading (Updating) Controller Objects
1. Select the unit from the list of AS objects.
2. Drag and drop the unit onto the process cell or other folder:

A5E00595269-01 7-5
This action adds a new unit class to the process cell and adds an instance of
the unit to the folder where it was dropped:
Note that while in some cases the DBA utility allows objects to be dragged to the
Objects tab for a particular plant view folder, in addition to allowing objects to be
dragged to a plant view folder. However, batch unit blocks must always be
dragged directly to the plant view. If you try to drag a batch unit to the Objects tab
to the right of the plant view, the following message is displayed:
Simply drag the unit directly to the Plant View instead.

Refer to the discussion of process cell attributes in Adding a Process Cell to the
Plant View for information on how the DBA utility creates unit classes as a result of
a drag-and-drop operation.

7-6 A5E00595269-01
Manually Creating a Batch Unit

1. Right-click on the process cell or a neutral folder.
A context menu appears, such as the following:
2. Select Add Unit.

3. To delete a unit instance, right-click the instance and select the Delete Unit
button:

A5E00595269-01 7-7
Editing Unit Instance Attributes

1. Select the unit instance and click the Attributes tab:
2. Edit the attribute Value field.

unit..
Comment: Free-form text field to annotate the unit in any way.
Description: A free-form text description of the unit.
1. To set the runtime name, select the browse button ( ).

The DBA Tag Browser opens:
2. Select the appropriate UNIT_AFB block from the AS configuration and click the
OK button.
The runtime name appears in the Value field:
Unit Class:The class of the unit. You must select a unit class when you create a
unit manually (step 2 in Manually Creating a Batch Unit, above). To change,
click the drop-down button in the Value field ( ) and select among the

7-8 A5E00595269-01
available unit classes:
Adding a Equipment Property to a Unit

An equipment property must exist before it can be added to a unit. See Adding an
Equipment Property Type.
1. Right-click the unit of interest.
2. Select Add Equipment Property.

A Select Option Window
appears:
3. Select the equipment property to be added to the unit and click the OK button.

A5E00595269-01 7-9
7.4 Adding a Phase (6.1)

A phase can be added to an equipment module or to a unit. You can add a phase
using drop-and-drag techniques or manually.
After a phase is added, it is possible to edit its attributes and assign them a WinCC
archive tag:
Dragging and Dropping a Phase

You can drag and drop phases after you have added an AS source node and
updated its controller objects See Adding APACS+ AS Batch Nodes to a 6.1
Project and Loading (Updating) Controller Objects
In the illustration that follows, a unit class has been added to the batch types, and a
new unit, with the default name UNIT1, has been created.
Select a charge function block from the AS components. Drag and drop it onto the
destination object.
Note that dragging and dropping may create a new phase type CHARGE as well
as an instance of the phase in UNIT1. Refer to the discussion of process cell
attributes in Adding a Process Cell to the Plant View for details regarding how
phases types are created when an instance is dragged and dropped.

7-10 A5E00595269-01
Note that while in some cases the DBA utility allows objects to be dragged directly
to the Objects tab, in addition to allowing object to be dragged to a plant view
folder. However, batch phase blocks must always be dragged directly to the plant
view. If you try to drag a batch phase block to the Objects tab to the right of the
plant view, the following message is displayed:
Simply drag the phase directly to the plant view instead.
Manually Adding a Phase

1. Expand the process cell to reveal the unit to which you wish to add a phase
instance.

A5E00595269-01 7-11
2. Right-click the unit.

3. Select Add Phase Instance.

A Select Option window opens, listing previously defined phase types.
4. Select the appropriate phase type and click the OK button.

A folder labeled PHASEINSTANCEn appears (the default name can be
changed). Beneath it is list of the parameters previously defined when the
phase type was created.
5. To rename a phase, right-click in the plant view window and select Rename.
The phase instance name becomes an editable field. In the following
illustration the default name PHASEINSTANCE has been changed to

7-12 A5E00595269-01
Charging:
6. Select each parameter in turn and enter its attributes in the right pane under
the Attributes tab.
Editing Phase Attributes

The following attributes are available for a phase instance:
Description: A free-form text field for a description of this instance of the phase.
Phase Name: To support recipe migration, it is possible to edit the phase name
that is sent to the batch project by the .EQM file. If the Phase Name parameter
is left blank, the instance name sent to the batch project is the same as the
name in DBA hierarchy. In WinCC, each phase must have a unique name. In
Batch Manager, multiple phases can have the same name.
Phase Type: Selected from a drop-down list of previously created phase types.
Runtime Name: This is a linkage to the Phase_AFB function block in the
controller.
1. Select the browse button ( )for the Runtime Name attribute.

The DBA Tag Browser window opens. Expanding the Application Station
Nodes object lists the available objects:

A5E00595269-01 7-13
2. Select the tag to be linked to the Phase:

The runtime name appears in the attribute list:

7-14 A5E00595269-01
Editing Phase Parameter Attributes

Data Type: The data type of the parameter. This can not be changed in the
instance of the parameter. To change this, you must change the data type in
the corresponding parameter type and update all instances of the type.
Runtime Name: This is a linkage to the controller parameter block (for example,
InReal, InBool, etc.)

2. Select the tag to be linked to the parameter:

A5E00595269-01 7-15

Setpoint: The default setpoint for the value. Note that the entry in this field must be
consistent with the data type of the parameter. For Booleans and enumeration,
a drop-down list is used to change the setpoint:
limits of the parameter instance for the data types float and integer.
Assigning a WinCC Archive Tag

Important: To browse the WinCC Archive, the OS in which the WinCC Tag
Logging archive has been configured (see Configuring WinCC Tags for
Archiving) must be assigned to a folder in the ancestry of the Phase or Process
Tag instance. In addition, either that OS must have been compiled from DBA
once since the tags were configured in the WinCC Archive, or the OS Cache
was manually updated (see Compiling (Start Compile) and Updating OS
Cache).
1. In the WinCCArchive attribute Value field, click the browse button ( )

The OS Tag Archive Browser window opens.
2. Select the appropriate tag and click the OK button.

The tag is registered in the WinCCArchive Value field.
Note in the illustration above the OS>>, Archive>>, and Type>> buttons are
available to aid your selection by filtering or limiting the number of tags
displayed. In addition, clicking column title bars, for example Tag Name,
toggles the column sorting between ascending and descending values for tag

7-16 A5E00595269-01
name. The Columns>> button leads to a checklist that determines which tag
characteristics are listed in columns.
7.5 Adding an Equipment Module

Equipment modules are subdivisions of a unit. Multiple equipment modules can be
defined in a unit. Phases such as heating, cooling, ventilating, emptying can be
created for the equipment modules.
1. Right-click a unit or neutral folder.
2. Select Add Equipment Module.

The module is created and inserted into the plant view.
3. To rename an equipment module, right-click and select Rename:
Editing Equipment Module Attributes

Select the equipment module in the plant view and click the Attributes tab:

A5E00595269-01 7-17
equipment module.
Comment: Free-form text field to annotate the equipment module in any way.
Description: A free-form text description of the equipment module.
7.6 Adding Process Tag Instances
Prerequisites
• The process tag type must exist before you can add an instance of it. See
Adding Process Tag Types.
• If the process tag is to be used for archiving, tags to be archived must have
been previously configured using the WinCC Tag Logging Archives function.
See Configuring WinCC Tags for Archiving.
Procedure
1. Create a process tag type instance if necessary in the process cell hierarchy.
Select and right-click the unit.
A context menu appears.
2. Select Add Tag Collection.

A Select Option window appears:

7-18 A5E00595269-01
3. Select a TagCollection Type and click the OK button.

The tag appear in the plant view
4. To rename the tag, right-click and select Rename:
5. Select each parameter in turn and enter its attributes in the right pane under
the Attributes tab.
Editing Process Tag Attributes

Phase Type: Selected from a drop-down list of previously created phase types.
Runtime Association Type: Choices here are Block or Tag:
Selecting Block specifies parameter-addressing based on a block in the controller,

for example, the InReal or InBool block. Selecting Tag specifies that the parameter
address can reference any tag in any controller.
Process Tag Attribute Parameters for Block Runtime Associations

Data Type: The data type of the parameter. This can not be changed in the
instance of the parameter. To change this, you must change the data type in
the corresponding parameter type and update all instances of the type.

A5E00595269-01 7-19
Runtime Name: This is a linkage to the controller parameter block (for example,
InReal, InBool, etc.)

2. Select the tag to be linked to the parameter.


7-20 A5E00595269-01
Setpoint: The default setpoint for the value. Note that the entry in this field must
be consistent with the data type of the parameter. For Booleans and
enumeration, a drop-down list is used to change the setpoint:
limits of the parameter instance for the data types float and integer.
WinCCArchive: This attribute is only present if the parameter type indicates
Archive = yes. If this attribute is not present and is required, you must change
the Archive attribute in the corresponding parameter type and update all
instances of the type.
Process Tag Attribute Parameters for Tag Runtime Associations

When Tag Runtime Association is set to Tag, a browse button is available to
open the DBA Tag Browser window, giving you an opportunity to select any tag in
any controller. After you have selected a tag, you must also pick its member name.
In the following illustration, the selected tag is AI_2320_22 and the selected
member is PV:

A5E00595269-01 7-21
7.7 Updating All Instances of Unit Class, Phase Type, and

Process Tag Type
Changes made to template structures such as unit class, phase type, or process
tag type, can be propagated to all instances based upon these templates. Typical
changes are adding or changing a parameter or data type.
1. In the plant view, expand the process cell icon to reveal the unit class, phase
type, or process tag type. Classes or types previously created appear in the
hierarchy.
2. Right-click the unit or type of interest,
A context menu appears (the context menu for unit class is below; the menu
for other templates is similar):
3. Select Update Instances.

All the units or phases based on the unit class or phase type template are
updated to conform to its current state.
7.8 Configuring WinCC Tags for Archiving
Prerequisites
Determine which OS Server is to be used for a tag logger. If this server has not
been configured in the DBA utility program, configure it before proceeding. See
• Adding Applications to an APACS+ OS Batch Single Station Architecture
• Adding Applications to an APACS+ OS Batch Multiple Station Architecture
• The tags to configure in the WinCC archive are created by the DBA utility when
the project is compiled. Compile the OS containing the WinCC Tags to be
archived before completing the following procedure.
1. It is necessary to run WinCC Tag Logging so that it runs concurrently with the
DBA utility. Select Start > Simatic > WinCC > Windows Control Center 6.0.
The Control Center opens. If the Control Center does not open to the current
project, close the displayed project and open the current project.
2. Select Tag Logging from the icons available in the left pane.
The Tag Logging window opens.

7-22 A5E00595269-01
3. Using the Archives icon in the top left pane, create an archive and add WinCC
Tags to the archive. Use the Archive Wizard to automate this process. Refer
to WinCCc on-line help for details.
4. Return to the DBA utility program and refresh the OS cache by right-clicking
the OS node and choosing Refresh OS Cache in the context menu. Refer to
Updating OS Cache.
Add the tags you wish to archive. In the topic Adding a Phase see the subtopic
Assigning a WinCC Archive Tag.

A5E00595269-01 7-23
8 Compiling the Project
8.1 Assigning an OS to a Plant View Folder

Notice
The assignment of OS servers to plant view folders is highly dependent on the
hierarchy options that you have configured in DBA. The number of plant view
folders that need to be assigned to OSs depends on the number of OS Servers
that are configured in your system and how you have partitioned them (as reflected
in the hierarchy options in DBA). In the section titled Ensuring Unique Object
Names see the subtopic Hierarchy Settings for more details.
The procedure below describes how to make a single assignment of an OS to a

plant view folder.
1. Right-click the plant view folder of interest.
2. Select Edit Folder Properties... from the context menu
3. Use a checkbox to select an OS from the Folder Properties window

A5E00595269-01 8-1
Compiling the Project
8.2 Assigning a Batch Server to a Process Cell Folder

1. Right-click the process cell folder.
2. Select Edit Folder Properties...

The Folder Properites window appears:
3. Click the checkbox next to the batch server and click the OK button.
8.3 Compiling (Start Compile)

Compiling is translating a selected DBA project to a WinCC database. A design
goal of the DBA Utility is to make incremental compiling as simple as possible, so
that a small change to an AS can be readily accommodated in a WinCC project.
Successful compiling requires the following:
• A WinCC project
• A specified AS source
• An OS and at least one folder to which the OS is assigned
• AS controller objects assigned to the OS
Notice
changes made to an .HMI file are not compiled unless the changes are registered
by the Loading (Updating) Controller Objects function.
Related topics

8-2 A5E00595269-01
Assigning an OS to a Plant View Folder

Adding a PC Station
Assigning Controller Objects to the Plant View
Creating or Opening a DBA Project
Procedures
Notice
If you are compiling a DBA project that includes a single OS Server, be sure that
the WinCC runtime is not active. If you are compiling a DBA project that includes
multiple OS Servers, be sure that the WinCC Explorer is either closed, or, if
running, does not contain an opened WinCC Project.
To compile all OSs in the DBA Utility Project, do any of the following:
• Select Start Compilation
• Press the F5 key
• Click the compile button:
OS Compile Options
Entire OS: Compiles the entire OS project. This is the only option available the first
time an OS is compiled. It is also the only option available the first time an OS
is compiled after upgrading the DBA utility program. When Entire OS is
selected, all tags, alarms, structures and elements created by the DBA utility
are deleted and replaced with new objects during the compilation.

A5E00595269-01 8-3
Changes: This is the default option for a previously compiled project. Only
changes made since the last compile are compiled.
The following options are ordinarily checked:
Tags and Messages: If this box is checked, all tags and messages are created. In
most cases this should be checked.
Create/Update Block Icons: If this box is checked, .pdl files are updated as part of
the compile process.
Picture Tree: If this box is checked, the picture tree or trees of the PCS & OS
Server are updated.
When the selection of options is satisfactory, click the Compile button.
An error related to duplicate or missing symbols produces a Command
Status... error message. See Checking for Duplicate and Missing Symbols.
The result of a compilation is written to a log, which can be stored as a text file on a
hard disk drive or other secondary memory. The log is visible by clicking the Show
Details checkbox.
The Save button saves the timestamp, message, and level information displayed
when the Show Details button is clicked. A Save As dialog box opens for saving
this information in a .LOG file.
If an OS requires recompiling, the new or changed objects are rendered in green.
In the illustration below, Area1 has changed because new objects have been
added beneath it. Note that only folders that have added or deleted items will be
marked as changed (colored green). Folders that contain an item that was modified
will not be marked as changed since only the item changed, not its parent folder.
In addition, the top level folder that is assigned to an OS will be marked as
changed if any of its subfolders or items are changed.

8-4 A5E00595269-01
Recompiling this OS results in a message in the log like the one shown in the
following fragment from a log file:
4/9/2004 10:54:31 AM 2 Querying Project Database...
4/9/2004 10:54:31 AM 1 Compiling 'OS' PCS 7 OS

(Server/Single Station)...
4/9/2004 10:54:31 AM 2 Opening Target...
4/9/2004 10:54:31 AM 3 Compile Scope: Changes
4/9/2004 10:54:31 AM 3 Compile Options:
4/9/2004 10:54:31 AM 3 Tags and Messages - Yes
4/9/2004 10:54:31 AM 3 Picture Tree - Yes
4/9/2004 10:54:31 AM 3 Create/Update Block Icons

- Yes
4/9/2004 10:55:58 AM 1 Compiling...Completed
The object highlighted in green returns to normal after the recompiling.
8.4 Running the OS in Runtime

1. Select Start > Simatic > WinCC > Windows Control Center.
The explorer opens the most recently opened project. If this is not the project
you wish to run, close it and open the project of interest.
2. Click the Activate button in the menu bar:

The project HMI opens.

A5E00595269-01 8-5
9 Object Attributes
9.1 Attribute Details

After you have finished organizing the graphical structure of the picture tree for
controller objects, you can assign, examine, and modify some object attributes.
The attributes available for this kind of change vary with the object and with the AS
system from which they are derived.
When the object is highlighted in the OS View pane, its attributes appear in the
Detail pane to the right. Any editable attribute is highlighted when the cursor sits on
the row containing the object's attributes.
By convention, a field that can be edited or changed is highlighted in beige. In the
illustration below, a unit class can be selected from a drop-down list of available
classes.
Object attributes listed in the right pane can be sorted in ascending or descending
alphanumeric order (a toggle) by clicking column headers. For example, to sort by
value, click the column header cell labeled Value. To switch between ascending
and descending order, click the header cell again.
See also:
Importing and Exporting Object Attributes
Object Attribute Editor
Alarm Attributes
Graphics Attributes
9.2 Alarm Attributes

These attributes determine how alarms are handled in PCS 7 OS.
Alarm Priority
There is an alarm priority attribute for every alarm that can be generated for an
object.

A5E00595269-01 9-1
Object Attributes
Each alarm that can be generated for the object can be assigned a unique priority,
from 0 to 16 (where 16 is the highest priority and 0 the lowest).
To change the alarm priority, click on an alarm priority object from the Detail pane
of the OS view and enter a value from 0 to 16
The WinCC Alarm Logging feature determines the Alarm Classes and Alarm
Types that are available for an object. See the on-line help file linked to this topic
for more information: Start > Simatic > WinCC > Window Control Center 6.0 >
Alarm Logging
Message Class
An alarm class setting determines the message class for every message that can
be generated by an object. A pulldown list shows all defined message classes in
the WinCC alarm logging function.
Message Type
A message type setting determines the message type (within a selected message
class) for every message that can be generated for an object. A pulldown list
shows by number all of the message types defined for the selected class. The DBA
utility program reads this type number but cannot read the words or phrases
associated with the number. To determine these, you must examine them from the
WinCC Explorer:
1. Select Start > Simatic > WinCC > Window Control Center 6.0 > Alarm
Logging.

9-2 A5E00595269-01
Object Attributes
A list of message classes appears in the upper right pane of the display
(Alarm, Warning, Tolerance, etc):
2. Select and right-click the message class of interest (Alarm, Warning,

Tolerance, etc). and select Properties from the context menu. The window
displayed below shows the message types for the Tolerance class.
3. Select the Message Type of interest (such as Tolerance High) and click the
Properties button.
A Type window opens and reveals the type number.
Returning to the DBA utility, a Type attribute contains a pulldown menu that allows
selection by number of a type supported by a message class. In the illustration
below, the class is Warning and the available types are Type1, Type2 and Type3.
Use the procedure listed above to determine the meaning of these types.

A5E00595269-01 9-3
Object Attributes
Note: The alarm and class pull-down menus are only available for controller
objects that meet these conditions:
• The objects have been assigned to a folder.
• The folder has been assigned to an OS.
• The OS has been assigned to an OS server.
• The OS server has been compiled at least once.
OR
• The Updating OS Cache function has been enabled for the OS server.
9.3 Graphic Attributes

Every object has associated with it a Symbol File (SF) and Symbol Name (SN)
attributes. When DBA creates .pdl files during compilation, it creates a picture
corresponding to each Picture Tree folder. For each object in the folder, a symbol
is inserted into the folder. The symbol file and symbol name graphics attributes
determine which symbols DBA will insert into each .pdl. The content of a .pdl file
that begins with a amperstand (&) character is not be available in the OS area
drop-down selection box.
When objects are inserted by DBA, a suitable default value for symbol file and
symbol name are set, based on the type of object. However, if you would like to
customize particular instances of objects to appear differently within the .pdl file,
you can change the symbol file and/or symbol name attributes associated with
alarm attributes.
Symbol File (SF)

A symbol file represents a file which contains a set of symbols which are used to
generate .pdl files automatically from DBA. Using this attribute, it is possible to
maintain multiple sets of symbols that are used in different circumstances. For
example, one file might contain a set of large symbols. A second file may contain
symbols with exactly the same names, but with smaller symbols.
Symbol Name (SN)

A symbol name represents the name of a symbol within Symbol File which will be
inserted by DBA when creating a picture using that object. For example, if the file
referenced in Symbol File contains the symbols SingleLoop/1 and SingleLoop/2,
you may wish to use Symbol Name of SingleLoop/1 for some objects, and
SingleLoop/2 for other objects.

9-4 A5E00595269-01
Object Attributes
9.4 Decimal Place Attributes

The number of decimal points displayed on symbols and faceplates is configurable
on a tag-by-tag basis in DBA.
The following table shows which decimal point tags affect which HMI tags.
Block Decimal Places Tag Affected Tags

SINGLE_LOOP DecimalPlacesPV .PV, .SP, All Alarm Limits, All Alarm Deadbands,
Setpoint Limits, Ramp Target, Ramp Rate
.DecimalPlacesOUT .OUT, Output Limits
ANALOG_ALARM .DecimalPlacesPV .PV, All Alarm Limits, All Alarm Deadbands
DISCRETE_ALARM N/A N/A
BLK_VALVE_1OUT N/A N/A
BLK_VALVE_2OUT N/A N/A
VALVE_A N/A N/A
VALVE_A_ALM N/A N/A
MOTOR_1OUT N/A N/A
MOTOR_2OUT N/A N/A
MOTOR_A N/A N/A
MOTOR_A_ALM N/A N/A
SINGLE_LOOP_SS .DecimalPlacesPV .PV, .SP, All Alarm Limits, All Alarm Deadbands,
EXT_SET .DecimalPlacesPV .PV, .SP, .ESP, All Alarm Limits, All Alarm
Deadbands, Setpoint Limits, Ramp Target, Ramp
Rate
RATIO_SET .DecimalPlacesPV .PV, .SP, .ESP, .RAT_INP, All Alarm Limits, All
Alarm Deadbands, Setpoint Limits, Ramp Target,
Ramp Rate

A5E00595269-01 9-5
Object Attributes

.DecimalPlacesRATIO .RAT_ACT, .RAT_DES
PRIMARY .DecimalPlacesPV .PV, .SP, All Alarm Limits, All Alarm Deadbands,
SECONDARY .DecimalPlacesPV .PV, .SP, .ESP, All Alarm Limits, All Alarm
Deadbands, Setpoint Limits, Ramp Target, Ramp
Rate
CASCADE .DecimalPlacesP_PV .P_PV, .P_SP, All Primary Alarm Limits, All
Primary Alarm Deadbands, Primary Setpoint
Limits, Primary Ramp Target, Primary Ramp Rate
.DecimalPlacesS_PV .S_PV, .S_SP, .ESP, All Secondary Alarm Limits,
All Secondary Alarm Deadbands, Secondary
Setpoint Limits, Secondary Ramp Target,
Secondary Ramp Rate
RESOURCE_STATUS N/A N/A
9.5 Object Attribute Editor

The Object Attribute Editor allows bulk editing of object attributes. Its chief use is
for editing alarm priorities, but it lends itself to editing other attributes as well. A
filtering, or limiting, mechanism makes it possible to isolate the attributes that need
editing, such as alarm priority, while hiding others.
It is also possible to export object attributes to a .csv file and bulk edit them with an
external program, such as Microsoft Excel or Microsoft Word, then import them
back into the DBA utility. See Importing and Exporting Object Attributes for more
information.
Select the folder of interest. Right-click and select Edit Attributes.... from the
context menu.
The DBA Attribute Editor window opens. The title bar indicates whether any
attributes are hidden (filtered). Initially, all attributes are visible.
You can reduce the information displayed by unchecking the Show... buttons. You
can begin editing immediately by clicking the Value cell for the object of interest
and replacing the current value with a new value. You may, however, wish to filter
and sort the objects first.

9-6 A5E00595269-01
Object Attributes
The Category << and Name>> buttons filter (hide) an object's attributes object to
make it easier to focus on the attributes of interest.
Click the Category<< button to uncheck (hide) attribute types. If you were
interested only in alarm priority, for example, uncheck the other types. Click the
Category<< button again to register your choice.
Any action that reduces the number of objects displayed is recorded in the title bar
(see 1, below). Note, too, that you can sort the displayed objects by column value
by clicking the column heading. To sort by name for example, click the heading
labeled Name (see 2, below). Clicking a column once provides an ascending sort;
clicking again toggles to a descending sort. This feature is especially useful if you
want to see alarms sorted by priority value.
The Name<< button provides additional filtering. To display only the L - Priority,
for example, click the Name<< button and uncheck all but the L - Priority box.
Then click Name<< again to apply the filter.

A5E00595269-01 9-7
Object Attributes
9.6 Importing and Exporting Object Attributes

The controller-object attributes available for import and export vary with the AS.
The DBA Utility supports disk-based import and export of controller object
attributes.
• The export feature stores attributes from a selected picture tree object (and all
subordinate objects) to a .CSV (comma separated variable) file that can be
opened and edited with word-processing or spreadsheet tools.
• The import feature replaces all attributes in a selected object and all of its
subordinate objects with any corresponding attributes in the selected file. The
imported .CSV file can be a file produced by exporting or a file edited or even
created independently of the DBA Utility program. Alarms are matched by the
path of the object, the alarm type, and the alarm description.
Invoke the export or import functions by right-clicking a controller object in the
picture tree (limited to root node, OS, and folders). If the object supports attribute
import and export, a menu indicates this, as is shown in the following illustration:
Clicking Export or Import opens a dialog box for entering a file name. The default
directory for exports and imports is the directory used as a source for the controller
objects.
Format of the .CSV file

An exported attribute file takes the form shown below. It can be edited with simple
text editing tools or with advanced spreadsheet tools that read from and write to
.CSV files. The first line in the listing is the column headers.
Keep in mind that edits made to an imported file can change the object attributes in
any object displayed in the picture tree, overwriting the value already there,
regardless of the object selected when the import is executed.
"ASTagName","ASTagPath","OSTagName","Category","Name","Description","Value"
"RMSC_532","""RMSC_532"","""",0","RMSC_532","Alarm Priority","Alarm
Disabled","Alarm Disabled","0"

9-8 A5E00595269-01
Object Attributes
"RMSC_532","""RMSC_532"","""",0","RMSC_532","Alarm Priority","Bad
Quality","Bad Quality","0"
"RMSC_532","""RMSC_532"","""",0","RMSC_532","Graphics","SF","Symbol
File","@Bailey Symbols.pdl"
"RMSC_532","""RMSC_532"","""",0","RMSC_532","Graphics","SN","Symbol
Name","@BAILEY_RMSC/1"
"RMSC_533","""RMSC_533"","""",0","RMSC_533","Alarm Priority","Alarm
Disabled","Alarm Disabled","0"
Required columns
If a file is created or edited and then used to import object attributes, the required
columns are
ASTagName: the name of the AS object whose attribute is being defined (for
example, SINGLE_LOOP). This name corresponds to the string found in the
Name column of the AS View tab's AS Objects List View (on the right). This
is a required field for AS object changes, and should be left blank for non-AS
object changes.
ASTagPath: the address of the AS object whose attribute is being defined (for
example, LC.LC_PUR.X2320.SINGLE_LOOP). This name corresponds to the
string found in the AS Address column of the AS View tab's AS Objects List
View (on the right). This is a required field for AS object changes, and should
be left blank for non-AS object changes.
OSTagName: the OS tag that is created by the DBA and is used only to reference
objects that are non-AS objects such as batch objects (for example,
Process$Cell/X2320/SINGLE_LOOP). This is a required field for non-AS
object changes.
Category:This column is the category of the attribute being defined (for example,
Graphics) and is related to the Category column of the attribute editor tab
(top right). This is a required field. Case must be correct.
Name: This column is the name of the attribute being defined (for example,
DecimalPlacesPV) and is related to the Name column of the attribute editor
tab (top right). This is a required field. Case must be correct.
Description: the description of the attribute being defined (for example, PV
Decimal Places To Display) and is related to the Description column of
the attribute editor tab (top right). This is an optional field, but allows the user to
customize the descriptions of attributes which are unchangeable through the
DBA interface.
Value: the value of the attribute being defined (for example, 2) and is related to the
Value column of the attribute editor tab (top right). This is a required field.
In summary
ASTagName, ASTagPath, and OSTagName columns locate the object to be
changed.
Category and Name columns locate the specific attribute on the selected object to
be changed.
Description and Value columns define the new values to be written into the DBA
database.

A5E00595269-01 9-9
Object Attributes
Other columns are ignored during imports.
Log Files
If you want to retain a log file recording the results of an import, select the Details
button while the import is in progress and the percent-complete window is
displayed. Save the results when the import is complete.

9-10 A5E00595269-01
10 Advanced Topics
10.1 Advanced Topics

The DBA utility integrates AS configurations and control schemes into the PCS 7
OS. The utility maps tags to a PCS 7 OS environment and creates a hierarchical
graphical structure depicting control systems in a PCS 7 OS HMI. The utility offers
wide flexibility, and with this comes complexity. While it is possible to devise a step-
by-step procedure to provide a quick-start introduction to the utility and its features,
no set procedure can accommodate the complexity of customers' applications. The
advanced topics provide insight into the features and requirements of the DBA
utility.
An essential feature of the PCS 7 OS picture-tree is that it is a flat file space where
objects are distinguished by unique names. This differs from many AS
environments where objects may be distinguished by the resource with which they
are associated and where tags and resources may not have unique names. The
DBA utility helps reconcile tag naming conventions by providing the following:
• Automated folder naming mechanisms to allow PCS 7 OS tags derived from
AS resources to have unique names.
• Functions that flag tags that PCS 7 OS would regard as duplicates. This gives
you a chance to rename the tags as necessary to ensure that they are
accounted for in the PCS 7 OS environment.
The DBA utility also enables you to create virtual hierarchies consisting of operator
stations and subordinate structures (folders and subfolders to a maximum of eight
deep) to which you can assign AS objects. These hierarchies are automatically
reflected in PCS 7 OS picture trees, graphic design program, and in the
navigational scheme of activated PCS 7 OSs. The utility translates APACS+ HMI
comments and tags to PCS 7 OS tags.
The choices and hierarchies created in a DBA project can be saved to disk in .dba
files for subsequent implementation or modifications. This enables you, for
example, to make a slight modification to a controller configuration, recall the DBA
session, load controller objects, and readily determine the changes that need to be
made to the picture tree to accommodate the change.
10.2 Controller Objects

See Loading (Updating) Controller Objects.
Controller Object Filters

The purpose of the Include All Resources and Include Assigned checkboxes is
to provide listings that make it easy to list, sort, and find controller objects and
corresponding OS tags. These listings appear under the headings that vary
according to the AS. To sort, click the column heading of the characteristic of

A5E00595269-01 10-1
Advanced Topics
interest. Click the heading again to toggle between ascending and descending
sorts.
• Include All Resources - list all controller objects loaded. To list objects for a
specific controller, ensure that the checkbox is unchecked, and select the
controller in the Controller objects list.
• Include Assigned - can be used in conjunction with Include All Resources,
lists all controller objects for the selected resource, even if they have been
assigned to the picture tree (if they have been assigned to the picture tree,
they won't normally show up in the list unless this box is checked).
• Include Only Changes - list all controller objects that have changed (been
added or modified) since the most recent update-controller-objects operation. If
you Update Controller Objects then check this box and Update Controller
Objects again, the list of controller objects is empty.
Notice
These checkboxes control how the program runs and are independent of individual
projects. If you make changes to these checkboxes and exit the project, the
changes remain in force when you reopen the project or open a different project.
This is true even if you exit a project and elect not to save changes.
10.3 Batch Validation

Batch validation checks the validity of the equipment model with respect to the S88
standard. Batch validation is checked whenever the project is compiled, and it can
be run independently of compilation:
Batch parameter names that exceed 16 characters will cause a validation failure. In
the current (V6.1) version of the DBA utility program, a restriction is in force that
prevents new parameters names from exceeding this length. This restriction may
not have been in force for existing projects, which may have been created in an
environment that permitted 32-character batch parameter names.
An independent validation of a batch process cell does not create an .EQM file for
importing into Simatic Batch. To perform an independent validation of the batch
equipment model.
10.4 Checking for Duplicate and Missing Symbols

The AS View Validation Results tab leads to a Validate function that identifies
tags that are duplicate, missing or both (from the perspective of a PCS 7 OS). The
function works on the current state of the symbols.
The Compile function also checks for valid symbols and fails if it identifies symbols
that are missing or duplicates. See Invalid Symbols Detected during Compile,
below.
To validate symbols:

10-2 A5E00595269-01
Advanced Topics
Click the Validation Results tab.

An empty window opens.
Click the Validate All button at the bottom of the window.
The validate function runs and, if there are errors, reports them. The following are
typical error messages generated when the function detects duplicate objects or
missing objects.
Clicking an error in the Validation Results window opens the plant view hierarchy
as necessary to locate and display the tag that failed validation.
Correcting Duplicate Object Errors
The usual remedy for duplicate objects is to apply the techniques described in
Ensuring Unique Object Names. Then click the Validation Results tab and click
the Validate button again to ensure that the remedy worked.
Correcting Missing Tags Errors
The validate function also checks for missing tags, which are marked as objects
not found in the controller. This includes changes to tag names, physical paths, or
types. A missing-tag error can also be caused by selecting a different source option
than the one used to create the current picture tree.
Note that a tag can be both missing and duplicate. This can happen if an object
has been removed from a controller and its name conflicts with another object's
name. Missing tags are rendered in blue. Duplicated tags are rendered in red and
must be resolved or the propagation fails.
Invalid Symbols Detected during Compile
In the case of a compile error, a Command Status... error message appears.
When you close Command Status... error message, the window associated with
Invalid Symbols is visible in place of the AS View:

A5E00595269-01 10-3
Advanced Topics
The Validate Results button does not validate the batch equipment module, a
function performed elsewhere. See Batch Validation.
10.5 Ensuring Unique Object Names

PCS 7 OS plant view exists in a flat file system. The hierarchical structure of the
plant view is a virtual hierarchy that relies on objects having unique names so they
can be distinguished from one another and placed in hierarchical folders. The
source AS system may not have this requirement and may be designed with a
symmetrical naming convention that, while reasonable in the source OS, can lead
to ambiguity in a flat file system. In these cases, uniqueness must be imposed on
the AS structures. Sometimes the structures of the AS configurations are named in
a way that requires no special efforts to ensure uniqueness.
If you know at the outset that because of local naming conventions objects in the
source AS environment would appear as duplicates in the PCS 7 OS environment,
you can make systematic name changes in advance on a controller object-by-
controller-object basis to conform to PCS 7 OS requirements. The Auto-Assigning
Resources to the Plant View step includes a function for adding unique characters
to AS objects.
If controller objects contain identical structures and function blocks, usually a few
characters of uniqueness text make it possible for PCS 7 OS to distinguish among
them. When you right-click an AS resource and select the function Auto Assign
Resources to the Plant View, the DBA Utility provides an opportunity to apply a
prefix or suffix to the folder and picture names as they are created in the working
template. Applying a prefix or suffix does not by itself create unique OS tag names.

10-4 A5E00595269-01
Advanced Topics
Having created opportunities of uniqueness, it is possible to apply folder names to

controller objects using hierarchy settings.
Hierarchy Settings
The functions for controlling hierarchy settings are found by selecting File >
Properties and the Hierarchy tab. The Hierarchy window opens. Functions
invoked through this window create unique OS tag names.
Here are descriptions of significant elements of the function.

• Max Level radio buttons determine the depth to which folders can be created.
• Max Characters field determines the number of characters permitted in folder
names for folders created manually or renamed.
But note that existing folder names are not truncated automatically if their
name exceeds the Max Characters limit. Note also that the Max Level and
Max Characters limitation do not apply to hierarchies created with the Auto
Assign Resources to the Plant View button.

A5E00595269-01 10-5
Advanced Topics
• Include in Name checkbox determines whether the folder name in the plant
view is added to the OS tagname.
• With Separator A backslash character is an optional separator. A backslash
is always inserted before the original tagname. When With Separator is
checked, a backslash is inserted between folder names as well.
• OS Area determines a level in the hierarchy that is the root of the picture trees.
This is derived from the plant hierarchy. In the illustration below, the OS Area
checkbox selects Level 1. Level 1 corresponds in the plant view as Process
Cell and Plant. The resulting PCS 7 OS shows Process Cell and Plant at the
top of the hierarchy.
In the illustration below, the OS Area checkbox selects Level 2. Level 2

corresponds in the plant view as React, Unit5, and PS_Batch, all of which sit at
the second level below Process Cell and Plant. The resulting PCS 7 OS shows
React, Unit5, and PS_Batch at the top of the hierarchy.

10-6 A5E00595269-01
Advanced Topics
10.6 Importing and Exporting the Plant View

The plant hierarchy in the Plant View can be exported to a CSV file or imported
from a CSV file using the context menu as shown below:

A5E00595269-01 10-7
11 Configuring APACS+ for Use with DBA
11.1 DBA Utility Capabilities

The DBA utility propagates offline APACS+ controller configuration information into
PCS 7 OS target offline databases. The propagation automatically exports the
APACS+ controller configurations using 4 mation and automatically imports the
changes into the PCS 7 OS target configurations. No manual steps are required.
The following figure illustrates the flow of information from APACS+ to PCS 7 OS:
The propagation supports the creation of the following OS object types:

• Single Tags (both Internal and External)
• Structured Tag Definitions
• Structured Tag Instances
• Alarms / Messages
• Graphics
• Symbols
• Plant View
The configuration of the DBA utility involves the following 5 steps:
1. Add HMI Comments to the APACS+ controller configuration using 4-mation.
2. Create Defined Type Files for any custom structured types using the DTF
Editor utility.
3. Create a DBA project and add the appropriate APACS+ controller
configurations as sources using the DBA utility.
4. Create a Plant View and assign the controller objects (marked by 4-mation HMI
Comments) to the appropriate Plant View Folder.
5. Define the PCS 7 OS targets to be modified and assign them to plant view
folders.

A5E00595269-01 11-1
Configuring APACS+ for Use with DBA
This section describes the first two steps in this process, defining an HMI Comment
in 4-mation and building a Defined Type File.
The following table defines terms used within this section:
Term Definition
4-mation HMI Comment A standard 4-mation comment with a very specific format. It can
be entered on any 4 mation configuration sheet type except
structured text. There are two categories of 4-mation HMI
Comment:
Individual Variable HMI Comment
Structured Variable HMI Comment
Individual Variable HMI Comment A 4-mation HMI Comment or Defined Type Variable Comment
that defines an Individual OS Variable to be created in the OS.
Not all attributes are supported when used as a 4-mation HMI
Comment.
Structured Variable HMI Comment A 4-mation HMI Comment that defines a Structured OS
Variable to be created in the OS. The TYPE attribute must be
defined and reference a valid Defined Type File.
Defined Type File A formatted ASCII file that defines a Structured OS Variable
Type and associated Messages. The file consists of the
following formatted lines:
Defined Type Instruction Comment
Defined Type Variable Comment
Defined Type Message Comment
Defined Type Instruction Comment A line in a Defined Type File that provides instructions other
than variables and messages to the DBA utility during the
propagation process (e.g. @INCLUDE lines to include other
Defined Type Files).
Defined Type Variable Comment A line in a Defined Type File that specifies an attribute of an OS
structure. Every instance of the structured OS tag creates a
single OS tag with the following name:
StructuredTagName.AttributeName
where the StructuredTagName is the name of the structured
tag and AttributeName is the name of the attribute created
by the Defined Type Variable Comment.
Defined Type Message Comment A line in a Defined Type File that specifies a message in the
OS. Every instance of the structured OS tag creates a message
associated with that particular instance.
Individual OS Variable A single tag in the OS created in response to Individual
Variable HMI Comments either as 4-mation HMI Comments or
as Defined Type Variable Comments.
Structured OS Variable A structured tag in the OS created in response to Structured
Variable HMI Comments.
Structured OS Variable Type A structured tag definition in the OS. One structured OS tag
definition is created in response to multiple Structured Variable
HMI Comments that have the same TYPE attribute.
11.2 4-mation HMI Comments

An HMI Comment is a standard 4 mation comment with a specific format. An HMI
comment can be entered on any 4-mation configuration sheet type except

11-2 A5E00595269-01
structured text. HMI Comments make reference to either individual variables or

defined-type variables.
HMI comments are entered in the cells of the sheet by bracketing the comment text
with asterisk characters and parentheses (*and*). Comments appear in the cell
as follows, with no space after the opening asterisk and no space before the
closing asterisk:
(*comment text*)
The HMI comment text general syntax is as follows:
HMI:source{{:attribute=parameter}...}
where the information in braces is optional and the colon (:) separated fields
consist of the following:
• The first field contains the characters HMI and is required.
• The second field contains the source of the OS variable and is also required.
• Optional additional fields contain attribute information for the variable.
Notice
1. The ionub characters "[" and "]" and the user-defined global variable
characters "|" and "|" are not required for communications. However, they
should be used in the HMI comments to aid in identifying the type of
variable since they are used and seen when referencing the variables in
the 4-mation software. The iochan "%", the embedded global variable
character "#", and the array element characters "[" and "]" are required for
communications and must be used. See Variable Source Syntax.
2. Note that only the comment text appears in the edit field above the cells in
4-mation in the form of attribute=parameter. The comment delimiters are
not visible.
Except for I/O channel or global variables, the HMI comment should refer only to
variables or standard function blocks on the sheet containing the HMI comment.
Although it is possible to refer to variables on other sheets if their path is started at
the program level, using this syntax should be avoided for two reasons:
• The variable type cannot be determined, which could possibly produce an
incorrect reference to the variable.
• The HMI comments become very long and difficult to read
The following image shows an example of a Structured Variable HMI Comment in
4-mation for the SINGLE_LOOP function block:

A5E00595269-01 11-3
11.3 Configuring 4-mation for Individual OS Variables

Individual OS Variables typically reference the following:
• local variables
• user-defined or embedded global variables
• standard or derived function block I/O nubs
• standard function block softlist parameters
• I/O channel variables
• I/O channel softlist parameters
These variables require the manual entry of an Individual Variable HMI Comment
in 4-mation.
An Individual Variable HMI Comment requires the source and TYPE attribute. The
TYPE value can be any APACS+ data type name (e.g., BOOL, REAL, LONG,
SINT, USINT, INT, etc.) or any IO Channel type name (e.g., SDIC, ADIC, SDOC,
SAIC, etc.). Other attributes can be added based upon the value of the TYPE
attribute. See the Variable Attribute Syntax section for a listing and description of
the valid attributes.
Notice
In the HMI comment, BOOL can be replaced by DISCRETE to create a structured
WinCC variable instead of individual WinCC variables. This can be useful, for
example, if you want to apply security restrictions to the variable, since security can
only be enforced on variables that are part of a structure. Similarly, for any analog
types (e.g., REAL, LONG, INT, etc.), the type in the HMI comment can be replaced
with ANALOG to create a structured WinCC analog variable instead of an
individual WinCC analog variable. Finally, for any of the string types (STRING_8,
STRING_16, STRING_32, STRING_64, STRING_128), the type in the HMI
comment can be replaced with STRING to create a structured WinCC string
variable instead of an individual WinCC string variable.

11-4 A5E00595269-01
Example 1: Configure an Analog Tag

This example illustrates how to configure 4-mation to create an Individual OS
Variable that references a controller analog IO Variable with the following
attributes:
Single OS tag created with the name PI_1000 and some engineering range
Two (2) Internal tags created as follows:
• PI_1000#comment references the text table entry with the descriptor string
• PI_1000#unit references the text table entry with the units string.
There are several ways to configure 4-mation so that the DBA utility creates the
required single OS tag.
Solution 1:
The first solution is to configure a single 4-mation HMI Comment that contains all
the required attributes as follows:
(*HMI:%PI_1000:TYPE=REAL:DESC=Flow pressure:
ENGH=>%PI_1000.MaxScale:ENGL=>%PI_1000.MinScale:
UNITS=>%PI_1000.EngUnits*)
Notices
• This comment is a single line within 4-mation.
• The OS tag name is PI_1000 since the TAG / ALIAS attribute was not specified.
• The I/O channel description entered in the 4-mation Configuration software is not
available as a softlist parameter and therefore cannot be referenced using the ">"
syntax for the DESC attribute. However, the ENGH, ENGL, and UNITS are
obtained from the IO channel softlist values.
Solution 2:
The second solution is to configure several 4-mation HMI Comments with the same
source field value as follows:
(*HMI:%PI_1000:TYPE=REAL:DESC=Flow pressure*)
(*HMI:%PI_1000:ENGH=>%PI_1000.MaxScale*)
(*HMI:%PI_1000:ENGL=>%PI_1000.MinScale*)
(*HMI:%PI_1000:UNITS=>%PI_1000.EngUnits*)
When multiple HMI comments are written, the source field in each case must be
identical.
Solution 3:
The third solution is to configure a single 4-mation HMI Comment of the TYPE
"SAIC" and is as follows:
*HMI:%PI_1000:TYPE=SAIC:DESC=Flow pressure*)
The I/O channel type codes can be obtained from the [CHAN_TYPE_DEFS]
section of the APACS MODULE.INI file.

A5E00595269-01 11-5
Notice
Note PCS 7 OS Option DBA automatically configures the ENGH, ENGL, and
UNITS when this method is used.
Solution 4:
The fourth solution works only for I/O Channels and does not require any 4-mation
HMI Comments. In the 2 – Define Picture Tree DBA configuration step, check the
Auto-Generate I/O Tags checkbox and then press the Load Controller Objects
button. This button processes the APACS+ controller configuration and builds the
list of controller objects that is displayed in the Controller Objects list box. All the
IO Variables are included in the list, allowing any one or more IO variables to be
assigned to the picture tree. This solution automatically configures the DESC,
ENGH, ENGL, and UNITS from the appropriate IO Channel softlist values.
Example 2: Configure a Discrete Tag

This example illustrates how to configure 4-mation to create an Individual OS
Variable that references a controller discrete variable with the following attributes:
Single OS tag created with the name Loop100_OOS
Two (2) Internal tags created as follows:
• - Loop100_OOS#comment references the text table entry with the descriptor
string.
• - Loop100_OOS#unit references the text table entry with the units string.
• - Loop100_OOS#string_0 references the text table entry with the descriptor
string for the off state.
• - Loop100_OOS#string_1 references the text table entry with the descriptor
string for the on state.
Solution:
The first solution is to configure a single 4-mation HMI Comment that contains all
the required information:
(*HMI:.OOS:TAG=Loop100_OOS:TYPE=BOOL:DESC=Motor100 Out of
Service:OFF=Out Of Service:ON=In Service*)
Notice
This comment is a single line within 4-mation and placed on a sheet that has a
discrete local variable called OOS
Other examples of Individual Variable HMI Comments

(*HMI:LAST_COUNT:TYPE=INT:ENGH=500:ENGL=0*)
(*HMI:#SystemOK:TYPE=BOOL:ALIAS=AREA1_CONTROLLER_OK*)

11-6 A5E00595269-01
11.4 Configuring 4-mation for Structured OS Variables

Structured Variable HMI Comments define a Structured OS Variable. The APACS+
application library blocks and optional function block library blocks make extensive
use of this type of comment. Since the application library blocks include the
Structured Variable HMI Comment, manual entry is not required. The Structured
Variable HMI Comment typically specifies the sheet as the source and the derived
function block type as the variable type. For example:
(*HMI:.:TYPE=SINGLE_LOOP:REV=4.00*)
If the derived function block instance name containing the Structured Variable HMI
Comment is TC_1000, the tag name for the .[PV] variable is TC_1000-PV. The
engineering scale values, descriptor, and units for TC_1000-PV are obtained from
the specified standard function block softlist parameters. The other variables are
named and initialized as specified in the remaining HMI comments.
The TYPE specified in the Structured Variable HMI Comment in 4-mation does not
have to match the actual function block type name, such as would be the case for
derived function block types that are duplicated, as long as the actual Defined Type
Variable Comment remains the same. For example, if the SINGLE_LOOP derived
function block is copied for multiple uses, each with its own new function block
type, the Structured Variable HMI Comment does not have to be modified. If,
however, the derived function block is copied and modified such that the Defined
Type Variable Comments are different, the sheet HMI comment TYPE= attribute
must be edited to reflect the new function block type. In this case, the original
defined-type file can also be copied to a new defined-type file corresponding to the
new function block type and the variable list modified as necessary.
11.5 Defined Type File Layout and Syntax

A Defined Type File is an ASCII file that defines a Structured OS Variable Type
and associated Messages. The file consists of instruction comments, variable
comments, and message comments. The following listing is from the
SINGLE_LOOP.HMI Defined Type File and creates an OS structured tag type
called SINGLE_LOOP_AFB:
Line Code
01 ;DEFINEDTYPE:SINGLE_LOOP
02 ;SCHEMAVERSION:1.0.0
03 [4.00 - 6.0 PCS 7]
04 HMI:TAG_STRUCTURE=SINGLE_LOOP_AFB
05
06 HMI:"SINGLE_LOOP_AFB":TAG=#blocktype:TYPE=TEXTREF
07 HMI::TAG=#areaname:TYPE=TEXTREF
08 HMI:@StripEnclosingApostrophes(VALUE;.DESC.VALUE):TAG
=#comment:TYPE=TEXTREF
09 HMI::TAG=#graphic:TYPE=TEXTREF
10 ; Include common controller information
11
12 HMI:@INCLUDE(CONTROLLER_COMMON[4.00 - 6.0 PCS 7])
13 ; Include alarm mapping information

A5E00595269-01 11-7
14
15
16 HMI:@INCLUDE(ALARM_MAP[4.00 - 6.0 PCS 7])
Notice
The line numbers in the code sample provided above are included only for
reference and do not appear in the actual Defined Type File
Defined Type Files can be viewed and changed using any standard ASCII file
editor or the Defined Type File Editor. The Defined Type File Editor can be started
by selecting Start > Programs > Simatic > DBA >Defined Type Editor. See
Defined Type File Editor.
Defined Type Name Directive

The Defined Type Name directive is a specially formatted comment line that is
required by the DBA utility. It must be of the following syntax (no spaces are
allowed):
;DEFINEDTYPE:SomeName
where SomeName is replaced with the string that represents the name of the
Defined Type File. This is the string that is defined in the TYPE attribute of the
Structured Variable HMI Comment. This string value MUST match the name of the
Defined Type File as follows:
SomeName.HMI
Schema Version Directive

The Schema Version directive is for internal use only and must follow the Defined
Type Name directive and must be of the following syntax (no spaces are allowed):
;SCHEMAVERSION:1.0.0
Structure Definition Product and Version

A Defined Type File can define structures for multiple products and versions. This
allows a single Defined Type File to generate different OS structures based on the
source function block version (e.g. Revision 3.00 should be different from Revision
4.00 of the application libraries). The 6.0 release of the APACS+ PCS 7 OS Option
DBA utility requires that the product string be 6.0 PCS 7 as shown in line 03 of
the example.
Structured Tag Type Name Directive

The name of the OS structured tag type is declared using the Structured Tag Type
Name directive as follows:
HMI:TAG_STRUCTURE=SomeName

11-8 A5E00595269-01
where SomeName is replaced with the string that represents the name of the OS
structured tag type. This value can be different than the Defined Type Name
directive as shown in the example. No spaces are allowed in this line and
SomeName must be a valid OS structured tag type name.
Comment Directive
Any line that starts with a semicolon (;) is considered a comment and is ignored by
the DBA utility. The only exclusions to this rule are the special Defined Type Name
and Schema Version directives.
Include Directive
Any line that starts with HMI:@INCLUDE is an include directive. The include
directive is used to create modular defined type files. Every include directive line in
a defined type file line is replaced with the contents of the specified section of the
specified defined type file. The include directive includes the specification of the
specific product and version of the section to include and uses the following syntax:
HMI:@INCLUDE (FileName [ProductVersion - Product])
where FileName is the name of the defined type file to insert (without extension)
and Product and ProductVersion define the section to use.
The included file can also contain include directives. The DBA utility supports
nesting of include directives to a maximum of five levels deep. The HMI file for a
single-loop controller, for example, includes by reference two other HMI files as
shown by lines 12 and 16.
The included Defined Type File needs to exist in the same directory as the
including file, normally in the C:\Program
Files\Siemens\Obj\APACS+\Templates directory.
Declaring a Templates Folder for Custom Defined Types

To declare a templates folder to store custom Defined Type Files:
1. In the plant view, select the root folder.
The Project Template Folders attribute appears:

A5E00595269-01 11-9
2. Enter the desired folder name into the Value column.

If a folder is specified for Defined Type Files, the DBA utility program looks for
templates in this folder before looking into the basic templates folder in
\DBA\APACS\Templates.
11.6 Defined Type Variable Comment Syntax

Attribute variables of a Defined Type File are defined using the same syntax as
Individual Variable HMI Comments. The Defined Type Variable Comment syntax is
as follows:
where the information in braces is optional and the colon (:) separated fields
consist of the following:
• The first field contains the characters HMI and is required.
• The second field contains the source of the OS variable and is also required.
• Optional additional fields contain attribute information for the variable.
The Defined Type Variable Comment must be contained on a single line in the
Defined Type file. There is no line continuation support. The source and parameter
fields can be functions and use the Defined Type File Function syntax of
@FunctionName. This is described in the Built-in Functions and User Defined
Functions sections.
11.7 Defined Type Message Comment Syntax

PCS 7 OS Alarms / Messages are defined in a Defined Type File using the
Message Comment using the following syntax:
MSG:message:attribute=parameter:...
where multiple attribute / parameter pairs are separated by a colon (:) and consist
of the following:
• The first field contains the characters MSG and is required.
• The second field contains the string value of the Message and is also required.
• Additional fields contain attribute information for the message some of which
are required.
The following table lists the attributes supported for PCS 7 OS messages:
Attributes for All Variables

AlarmType= the type of alarm the message is describing. This field does not limit
the other attribute values and is only provided to help the user when configuring
Defined Type Files.
Class= the class of the message. The value of this attribute depends on the class
of the message that you would like to use. The following are the default
classes provided when the OS Project Editor is used during the creation of your
WinCC Project. (Refer to Creating a New WinCC Project for details.) Refer to

11-10 A5E00595269-01
the table below for the class that you would like to use. Once you have selected
a class, formulate the "Class=" entry in the defined type file by entering the
description specified in the table. For example, if you would like to use class 3,
Tolerance, specify Class="Tolerance". [Note: The possible classes are
ultimately dependent on the Alarm Logging configuration of your WinCC
Project. If you have changed the list of available classes, use the Alarm
Logging configuration tool in WinCC Explorer to determine which classes are
available
Class Description
1 Alarm
2 Warning
3 Tolerance
4 PLC Process Control Messages
5 OS Process Control Message System
6 Preventive Maintenance
7 Process Message
8 Operating Message
9 Request for Operator Input
10 Operator Input Message
16 Status Message
17 System, must be acknowledged
18 System, need not be acknowledged
Type= the type of the message. The value of this attribute depends on the class of
the message and the type within the class that you would like to use. The
following are the default types, along with their associated classes, provided
when the OS Project Editor is used during the creation of your WinCC Project.
(Refer to Creating a New WinCC Project for details.) Refer to the table below
for the type that you would like to use. Once you have selected a type, the
"Type=" entry in the defined type file is constructed as follows: add the
"Message Type" number from the table entry to the word "Type". For example,
if you would like to use as "Tolerance High" the type, select
Class="Tolerance" and Type="Type37" (note that there are no spaces
between the word "Type" and the Message Type number (in this example, 37).
Note: The possible types that are available for each class are ultimately
dependent on the Alarm Logging configuration of your WinCC Project. If you
have changed the list of available types for one or more classes, use the Alarm
Logging configuration tool in WinCC Explorer to determine which types are
available for each class.
Class Message Type Description

1 1 Alarm High
1 2 Alarm Low
2 19 Warning High
2 20 Warning Low
3 37 Tolerance High
3 38 Tolerance Low
4 55 System
4 56 Error
5 71 System

A5E00595269-01 11-11
5 72 Error
6 89 Maintenance
7 106 Process Message
8 122 Process Message
9 139 Request for Operator Input
10 156 Operator Input Message
16 253 Status PLC
16 254 Status OS
17 257 Process control system
17 258 System messages
18 273 Process control system
18 274 Operator input message
MessageTag= the data manager tag name that defines the runtime state of the
message. Usually set to an internal DWORD tag called EventRaw#1. The tag
defined in CalcMsgTag is used as the source tag to drive the value of
EventRaw#1. If an external tag is used directly, the Alarm Lock feature will
not work.
CalcMsgTag= the message source tag used to generate messages outside of the
controller. See the section titled Generating Alarms Outside of the Controller for
more details and an example.
CalcMsgBit= the bit position or specific condition of the CalcMsgTag that will
trigger a message. See the section titled Generating Alarms Outside of the
Controller for more details and an example.
MessageBit= the bit of the MessageTag value that triggers the message.
AckTag= the data manager tag name that is used at runtime to acknowledge the
message. Usually set to an internal DWORD tag called EventAck#1. The tag
defined in CalcAckTag attribute is the target tag driven by the value of
EventAck#1
AckBit= the bit of the AckTag that is set when acknowledged.
CalcAckTag= the message acknowledgement target tag used optionally to
acknowledge messages outside of the controller. See the section titled Storing
Alarm Acknowledgements and Alarm Lock Outside of the Controller for more
details and an example.
CalAckBit= the bit position or specific condition of the CalcAckTag that will
acknowledge the message. See the section titled Storing Alarm
Acknowledgements and Alarm Lock Outside of the Controller for more details
and an example
DisableTag= internal tag that's used to suppress a message. Usually set to an
internal DWORD tag called EventDisable#1. This attribute must be provided
if CalcMsgTag and/or CalcAckTag attributes are used, even if this tag is not
used in the HMI to suppress the message. The high word of this tag causes the
Alarm Lock status to be persisted and synchronized. If the Alarm Lock feature
is used, this attribute must be provided as well.
DisableBit= the bit of the DisableTag value that suppresses the message.
Invert= any non-zero value inverts the message triggered when the message bit
defined by MessageTag and MessageBit attributes is 0 instead of 1. If this

11-12 A5E00595269-01
attribute is not provided, by default, the message will be triggered when the
message bit is 1.
message field or EventText= the text of the message. Displayed as the
Event column in the Alarm Logging tool in PCS 7 OS. This can include
replacement strings.
ChargeName= this optional field is displayed as the Batch Name column in the
Alarm Logging tool in PCS 7 OS.
Operation= this optional field is displayed as the Operation column in the Alarm
Logging tool in PCS 7 OS.
Freen= this optional field is displayed as the Freen column in the Alarm Logging
tool in PCS 7 OS where n is replaced with 1-5.
ProcessValuen= this optional field is displayed as the ProcessValuen column in
the Alarm Logging tool in PCS 7 OS where n is replaced with 1-10.
The area text of the message is automatically defined by the value of the
#areaname structured variable HMI comment. This value cannot be changed
manually.
11.8 Defined Type Extended Attribute Comment Syntax

An Extended Attribute is an attribute of a variable that is exposed to the user so the
user can change the value through DBA’s graphical user interface.
Extended Attributes are defined in a Defined Type File using the Extended
Attribute Comment using the following syntax:
EXA:description:attribute=value:...
where multiple attribute / value pairs are separated by a colon (:) and consist of the
following:
• The first field contains the characters EXA and is required.
• The second field contains description of the Extended Attribute.
• Additional fields contain attribute information for the Extended Attribute some of
which are required.
The following table lists the supported Extended Attributes:
AttributeName= name of the extended attribute. Required.
DisplayName= the alias of the extended attribute that will actually display in the
DBA’s GUI. AttributeName value is used if not provided.
Category= category to group different kinds of extended attributes. Required.
Type= type of the extended attribute value. Required .The following types and
APACS+ standard data types can be used as the value:
Type Description
Integer nteger type
Int Same as Integer
Boolean Boolean type
Bool Same as Boolean

A5E00595269-01 11-13
String String type

Str Same as String
Float Floating point type
Enumeration Enumeration type
Value= the initial value of the extended attribute. Required.

Permission= RO for read only. RW for read and write. Assumed RO if not
provided.
Visible= the value -1 makes the extended attribute visible in the GUI. The
value 0 makes it invisible. Assumed visible if not provided.
MinInclusive= used only when Type is Integer or Float. Minimum possible
value of the extended attribute.
MaxInclusive= used only when Type is Integer or Float. Maximum possible
value of the extended attribute.
Values= used only when Type is Enumeration. List of enumerators separated
by commas. Value has to be one of these enumerators. Required when
Type is Enumeration.
Enumeration= optionally used only when Type is Enumeration. Actual
enumerator values are separated by commas when the enumerators in Values
are used as place holders for display purpose.
For example:Values=Man,Auto,Com:Enumeration=0,6,8:
If Auto is selected as the value, it will be replaced with 6 during the compile.
The number of enumerators must be the same as the number of Values
attributes. The Enumeration attributes in the above example make clear the
connection between Man,Auto,Com and 0,6,8.
VariableLink= name of the tag whose start value will be replaced by the value
of Value attribute during the compile.
Example
The following EXA Comment, extracted from SINGLE_LOOP.HMI, adds the
DecimalPlacesPV attribute to the DBA. This addition makes it possible to assign
the start value of DecimalPlacesPV tag:
EXA:"PV Decimal Places To

Display":Category="Graphics":AttributeName=DecimalPlacesPV:Value
=2:Type=Integer:MinInclusive=0:MaxInclusive=6:Permission=RW:Visi
ble=-1:VariableLink=DecimalPlacesPV:

11-14 A5E00595269-01
11.9 Generating Alarms Outside the Controller

Analog and discrete alarms can be generated by using an internal tag as the
MessageTag and mirroring this internal tag with a source tag and condition of the
source tag using the CalcMsgTag and CalcMsgBit attributes respectively.
Example
If the following attributes and values are used, a PV tag value greater than 50
triggers the analog alarm:
MessageTag=EventRaw#1:MessageBit=12:CalcMsgTag=PV:CalcMsgBit=ANA
LOG;GT;50:
CalcMsgTag can be any analog or discrete tag. CalcMsgBit has the following
formats depending on the type of the alarm condition:
Bit Type – Bit Alarm Condition Type:

CalcMsgBit=<bit position starting from 0>;<optional bit value – default is 1>
Examples:
CalcMsgBit=3;0 when the 4th bit of CalcMsgTag value is 0
CalcMsgBit=0 when the 1st bit of CalcMsgTag value is 1
Boolean Type – Boolean Alarm Condition Type:

CalcMsgBit=BOOL;<boolean value – 0 or 1>
Examples:
CalcMsgBit=BOOL;0 when CalcMsgTag value is 0
CalcMsgBit=BOOL;1 when CalcMsgTag value is 1
Integer Type – Integer Alarm Condition Type:

CalcMsgBit=INT;<comparator>;<integer value or tag name (.tagname if the tag is a
member variable of the structured tag)>;Mask=<optional mask>
Supported Comparators:
LT - Less Than Value.
LE - Less Than or Equal Value.
GT - Greater Than Value.
GE - Greater Than or Equal Value.
EQ - Equal Value.

A5E00595269-01 11-15
NE - Not Equal Value.

VLT - Less Than Variable Tag Value.
VLE - Less Than or Equal Variable Tag Value.
VGT - Greater Than Variable Tag Value.
VGE - Greater Than or Equal Variable Tag Value.
VEQ - Equal Variable Tag Value.
VNE - Not Equal Variable Tag Value.
Examples:
CalcMsgBit=INT;LT;90 when CalcMsgTag value is less than 90
CalcMsgBit=INT;VEQ;.CompareTag;Mask=15 when first four-bits masked
value of CalcMsgTag is equal to the value of CompareTag tag.
The start value of this comparing tag can be user configurable using an extended
attribute as described in the section titled Defined Type Extended Attribute
Comment Syntax.
Analog Type - Analog Alarm Condition Type:

CalcMsgBit=ANALOG;<comparator>;<floating point value or tag name (.tagname
if the tag is a member variable of the structured tag)>;Deadband=<optional
deadband>;Deviation=<required if the comparator is a Deviation type (AD, HD, LD,
VAD, VHD, VLD)>
Supported Comparators:
Same as the comparators of integer (INT) type except for the following additions:
AD Absolute Deviation from Value.
HD High Deviation from Value.
LD Low Deviation from Value.
VAD Absolute Deviation from Tag Value.
VHD High Deviation from Tag Value.
VLD Low Deviation from Tag Value.
See the section titled Storing Alarm Acknowledgements and Alarm Lock Outside of
the Controller.
11.10 Storing Alarm Acknowledgements and Alarm Lock

Outside Controller
To store alarm acknowledgements and alarm status outside the controller:
1. On the APACS+ Controller Configuration dialog box, clear the checkbox
labeled Write Alarm Acknowledgements and Alarm Lock Status to the

11-16 A5E00595269-01
Controller:
2. Execute Update Controller Objects whenever this option is changed. This

option can be changed on a per-controller basis.
After this box in cleared, all defined type files of the standard blocks that store the
alarm acknowledgement and alarm lock status in the controller are configured to
store this information outside the controller.
The following subsections describe how to make a custom Defined Type File to
take advantage of this feature.
Conditionally Writing an Alarm Acknowledgement to a Controller:

1. Create an internal alarm acknowledgement tag. Ensure that it is synchronized
and persisted:
HMI::TAG=EventAck#1:TYPE=DWORD:VarProperty=2:Persist="RSTA=Event
Calculator":Sync="RSTA=EventCalculator":
2. Use the internal tag as the AckTag and assign the actual controller
acknowledgement tag to the CalcAckTag attribute.
3. Use CalcAckBit attribute to determine the controller acknowledgement tag
when the alarm is acknowledged. In the following example, attributes in the
message comment make the alarm acknowledgement write 0 to the NAK1 tag:
AckTag=EventAck#1:AckBit=0:CalcAckTag=NAK1:CalcAckBit=BOOL;0:
The format of CalcAckBit attribute is the same as CalcMsgBit attribute but only
Bit and Boolean types are supported for CalcAckBit.
When the Write Alarm Acknowledgements and Alarm Lock Status to the
Controller check box is not checked, CalcAckTag and CalcAckBit attributes
are ignored and the alarm acknowledgement is stored only in the internal alarm
acknowledgement tag.
Conditionally Writing Alarm Lock status to the Controller:

Special hidden Extended Attributes called EventLockTag1 and EventLockTag2
specify the tags the Alarm Lock status gets written to. Either EventLockTag1
or EventLockTag2 or both can be used to specify the controller tag or tags that

A5E00595269-01 11-17
the Alarm Lock status is written to. The following example shows the format of
these Extended Attributes:
EXA:"Controller Event Lock Tag
1":Category="ControllerEventLockTag":AttributeName=EventLockT
ag1:Value=P_OOS:Type=String:Visible=0:
EXA:"Controller Event Lock Tag
2":Category="ControllerEventLockTag":AttributeName=EventLockTag2:
Value=S_OOS:Type=String:Visible=0:
The Alarm Lock status is written to P_OOS and S_OOS tags in this example.
When the Write Alarm Acknowledgements and Alarm Lock Status to the
Controller check box is cleared, Extended Attributes of category
ControllerEventLockTag are ignored, and the Alarm Lock status will be
available only to the OS. The high words of the alarm disable tags declared by
DisableTag and DisableBit attributes in the message comments are actually
used to persist and synchronize the Alarm Lock status. For this reason, the alarm
disable tag always has to be DWORD type and synchronized and persisted.
DisableTag and DisableBit attributes are required in each message comment
if CalcMsgTag and/or CalcAckTag attributes are used or the Alarm Lock feature
is used.
11.11 Function in a Defined Type File

Defined Type File comment lines can call functions to determine the source and
parameter values. The syntax used to execute a function is as follows:
@FunctionName({parameter,...})
where FunctionName is the name of the function and parameter is one or more
parameters. A function can be one of the built-in Defined Type File Functions or a
User Defined Function. All functions return a value that is used for that field or
parameter. The function logic is defined in the VBScript language and must be
XML compliant.
Parameters to a function can be passed as described in the following table:
Parameter Type Description

CONSTANT The text following the semicolon is passed as a string and is not
interpreted.
VALUE The text following the semicolon is used to find a value from the AS
configuration relative to the source field of the Defined Type File.
ADDRESS The text following the semicolon is used to construct the APACS+
Communications System Tag Name.
A parameter type is specified by prefixing the parameter with one of the parameter
types followed by a semicolon (;). For example, the first parameter of the following
function call is passed to the function as a constant and is not to be interpreted as
anything else:
SelectCase4(CONSTANT;HIGH_HIGH,VALUE;.ALARM.ALARM1_TYPE,
ADDRESS;.ALARM.ALARM1_LIMIT)

11-18 A5E00595269-01
The second parameter of the example is converted to the specific value of the AS
controller object before calling the function. In this case, the value of the
ALARM1_TYPE softlist value of the ALARM block on the current sheet is passed.
The third parameter of the example is converted to the APACS+ Communication
System Tag Name before calling the function. For example, if the current sheet is
ACM1.Sheet1.Sheet2,
then the third parameter would be
ACM1.Sheet1.Sheet2.ALARM.ALARM1_LIMIT
The first parameter to any function is hidden and provides a reference to the Node
that is being processed. This is commonly referred to as the this pointer or
reference.
The DBA utility converts the Defined Type File into an XSL file before applying it to
any 4 mation HMI Comment. This process of converting the Defined Type File into
XSL is called compiling. The Defined Type File only needs to be compiled once no
matter how many 4 mation HMI Comments reference it. Applying the compiled
Defined Type File to an instance of a 4-mation HMI Comment involves the XML
transformation of the XML node within the exported AS configuration. The functions
of the Defined Type File make use of the XML node and its relatives. An
understanding of the 4 mation XML export format is required to write significant
custom functions and is not described in this document.
11.12 Built-In Defined Type File Functions

There are several built-in functions that are used by the Defined Type Files for the
Standard Function Block Libraries, but can be used by any Defined Type File. The
list of Built-In Defined Type File functions follows:
Function Syntax Description

GetResourceName Returns the resource name of the passed address
(sExpression ) string.
IfExistsThenElse ( Evaluates the sTestExpression as a valid XPath
sTestExpression, expression relative to the current node and returns
sStatement, sStatement if available, or sElseStatement if not
available.
sElseStatement)
IfThenElse4 Compares the sTestExpression against the given
(sTestExpression, expressions (sExpression1-4) and returns
sExpression1, sStatement if any match is found, otherwise returns
sExpression2, sElseStatement.
sExpression3,
sExpression4,
sStatement,
sElseStatement)

A5E00595269-01 11-19
SelectCase4 Compares the sTestExpression against the given

(sTestExpression, expressions (sExpression1-4) and returns
sExpression1, sStatement1 if matching sExpression1,
sExpression2, sStatement2 if matching sExpression2, and so on.
If none matches, then the function returns
sExpression3,
sElseStatement.
sExpression4,
sStatement1,
sStatement2,
sStatement3,
sStatement4,
sElseStatement)
CalcEventTrans Returns the #EventTrans value based on the given
(sExpression1, expressions based on APACS+ ALARM function block
sExpression2, alarm types. The possible values include: HIGH, LOW,
HIGH_DEV, LOW_DEV, ABSOLUTE_DEV,
sExpression3,
OUT_OF_RANGE, QUALITY_NOT_GOOD,
sExpression4) HIGH_HIGH, LOW_LOW, INC_ROC, DEC_ROC, and
ABS_ROC.
ForceEventTrans ( Returns the #EventTrans value required for the given
sExpression1, PCS 7 OS message type. The possible values include:
HIGH_ALARM, LOW_ALARM, HIGH_WARNING,
sExpression2,
LOW_WARNING, HIGH_TOLERANCE,
sExpression3, LOW_TOLERANCE, SYSTEM, FAILURE, and
sExpression4) PROCESS.
CalcURL ( Returns the Upper Range Limit based on the given
sLowLimit, parameters. The computation is as follows: sLowLimit
+ ((ABS(sHighLimit - sLowLimit)) *
sHighLimit,
sMultiplier)
sMultiplier)
CalcLRL ( Returns the Lower Range Limit based on the given
sLowLimit, parameters. The computation is as follows: sLowLimit
- ((ABS(sHighLimit - sLowLimit)) *
sHighLimit,
sMultiplier)
sMultiplier)
CalcSpan ( Returns the span based on the given parameters. The
sLowLimit, computation is as follows: ((ABS(sHighLimit -
sLowLimit)) * sMultiplier
sHighLimit,
sMultiplier)
StripEnclosingApostrophes Returns the passed value without the enclosing
(sExpression) apostrophes. This is useful because all strings in 4
mation include enclosing apostrophes.
For examples of how these functions are used, please see the Defined Type Files
for the Standard Function Block Library.
11.13 User Defined Functions

A User Defined function can be added to the Defined Type File in the Script
Section. The script section is marked by the [SCRIPT:VBScript] ...
[/SCRIPT] syntax and illustrated in the following example:
Line Code
01 [SCRIPT:VBScript]

11-20 A5E00595269-01
02 Function GetCurrentDate(oThis)
03 ‘ Return the current date as a string.
04 GetCurrentDate = CStr(Now())
05 End Function
06 Function CalcVolume(oThis, sLength, sWidth, sHeight)
07 CalcVolume = sLength * sWidth * sHeight
08 End Function
09
10 [/SCRIPT]
In this example, line 01 and 10 indicate the start and end lines of the script block.
There can only be one (1) script block per Defined Type File. The function names
must be unique among all script functions defined in all included files. The text in
the script block must be VBScript. The first parameter must be oThis. This is a
reference to the CBOTEXT XML node that is being propagated, however it does
not have to be used. The example GetCurrentDate() function uses the
VBScript function Now() to return the current time. The CalcVolume() function
takes three (3) dimensions and calculates the volume. The script could even
access an external COM object using the VBScript CreateObject() function
including the ActiveX Data Object (ADO) object to read a database.
Using a namespace, a script in an HMI file can be run within its own scope, so
scripts on different included HMI files will not conflict. For example, the following
text can be added to the end of an HMI file to define functions to be executed
during the Update Controller Objects call:
[SCRIPT:VBScript:SM]
function FixUpAddress(nodelist,sPathToBlock,sAddress)
FixUpAddress = "$XXXXXXX$." & sAddress
end function
[/SCRIPT]
The functions can be invoked during the resolution of the APACS address for each
HMI lines as follows:
HMI:@SM.FixUpAddress(.,.EffectStat):TAG=E_ST65_128:TYPE=RAW:
Notice that the script block defined the script namespace as SM. Therefore it is
required to specify the namespace in the function call. Also notice that the first
parameter is implicit in the function specification to be the 'this' pointer back to the
HMI Comment.
11.14 Variable Source Syntax

The source field of the HMI Comment syntax
HMI:source{{:attribute=parameter}...} specifies the reference as one
of the following:
• Local variable

A5E00595269-01 11-21
• User-defined or embedded global variable

• Standard or derived function block I/O nub
• Standard function block softlist parameter
• I/O channel variable
• I/O channel softlist parameter
• Standard or derived function block as the source of a Structured Variable HMI
Comment
The following table lists the syntax required to reference the desired controller
object:
Variable Description
.localvar Individual local variable on current sheet
Default alias: localvar
.localvar[element] Individual local variable array element on
current sheet
Default alias: localvar_index1{{_index2}...}
|globalvar| Individual user-defined global variable
Default alias: globalvar
|globalvar|[element] Individual user-defined global variable array
element
Default alias: globalvar_index1{{_index2}...}
#globalvar Individual embedded global variable
Default alias: globalvar
Requires TYPE= attribute
.[ionub] Individual I/O nub on current sheet.
Default alias: ionub
.[ionub][element] Individual I/O nub array element on current
sheet
Default alias: ionub_index1{{_index2}...}
.fbinst.param Individual softlist parameter of function block
on current sheet
Default alias: fbinst.param
.fbinst.[ionub] Individual I/O nub of function block on
current sheet
Default alias: fbinst.[ionub]
.fbinst.[ionub][element] Individual I/O nub array element of function
block on current sheet
Default alias:
fbinst.[ionub]index1{{_index2}…}
%iochan Individual I/O channel variable
Default alias: iochan
%iochan.param Individual I/O channel softlist
Default alias: iochan.param
Requires TYPE= attributeparameter
.fbinst. References a standard or derived function
block on the current sheet as a defined-type.
(trailing period required)
Default alias: fbinst

11-22 A5E00595269-01
. (period) References the current sheet as a defined-

type with the default alias as the sheet
instance name
Default alias: fbinst
If used in a defined-type file, it is treated as a
reference to the individual variable indicated
by the sheet HMI comment.
Default alias: passed defined-type variable
ALIAS
* (asterisk) References the current sheet as a defined-
type with the exception that the default alias
is the resource name instead of the current
sheet instance name.
Default alias: ResourceName
11.15 Variable Attribute Syntax

The attribute field of the HMI Comment syntax
specifies an attribute of the OS variable.

For individual variable comments, an attribute can define the following aspects of
the OS variable:
Name
• Comment
• Engineering high and low values (only for Analog Variables)
• Engineering units (only for Analog Variables)
• Discrete State Descriptors (only for Discrete Variables)
• Maximum String Length (only for String Variables)
For defined type comments, an attribute can define the following aspects of the OS
variable:
• Name
• Structured Type Name
The following tables list the attributes supported for various types of variables:
Attributes for All Variables
Attribute Descriptions
TYPE= Individual variable APACS+ data type or defined-type variable
standard or derived function block type or I/O channel type.
TAG or ALIAS= The name to be used as the HMI database tagname. If not specified,
the default ALIAS as described in the Variable Source Syntax section
is used.
DESC= Variable description or comment (only for Individual Variable HMI
Comments)

A5E00595269-01 11-23
REV= Revision string used to select a specific version from a Defined Type
File. A single Defined Type File can define multiple versions of the
structure based on this attribute. (only for Structured Variable HMI
Comments)
Var Property= Any value other than 4 creates an internal tag in the PCS 7 OS.
Omitting this attribute or setting the value to 4 creates an external
tag.
INTERNAL Same as VarProperty= <any value other than 4>
EXTERNAL Same as VarProperty=4.
Sync= Any non-zero value for this attribute synchronizes the value of the
internal tag with the redundant OS server.
Sync="RSTA=EventCalculator" This special value synchronize the value of an internal tag used as an
alarm acknowledgement tag.
Sync="RAW" Special internal tag used as an alarm trigger tag.
Persist= Any non-zero value for his attribute ensures that the value of the
internal tag persists when the OS server restarts.
Persist="RSTA=EventCalculator This special value ensures that the value of an internal tag used as an
alarm acknowledgement tag persists when the OS server restarts
Persist="RAW" Special internal tag used as an alarm trigger tag.
Attributes for Analog Variables
HL or ENGH= Engineering high value (default is variable data type specific)
LL or ENGL= Engineering low value (default is variable data type specific)
UNITS= Engineering units text
Attributes for Discrete Variables (TYPE=BOOL)
ON= ON state message text (default = ON if no OFF message)
OFF= OFF state message text (default = OFF if no ON message)
Attributes for String Variables (TYPE=STRING)
LEN= Maximum string length value
11.16 Variable Parameter Syntax

The parameter choices are as follows:
Parameter Description
value Use the specified value (must not start with ".")
Text or " " Use the specified text

11-24 A5E00595269-01
^ or ^text Current sheet instance when used on a sheet. For the ALIAS, DESC, and
UNITS attributes in a defined-type file, the carat is replaced with the
appropriate parameter value passed down from the associated defined-
type HMI variable and the optional specified text is added.
>.localvar Get local variable localvar initial value
>.param In defined-type file, get the associated standard function block or I/O
channel softlist parameter param initial value
11.17 Defined Type File Editor
Notice
changes made to an .HMI file are not compiled unless the changes are registered
by the Loading (Updating) Controller Objects function
The Defined Type File Editor creates, edits, and displays ASCII files that define
structured OS variable types and associated messages.
The advantage to using the Defined Type File Editor instead of an ASCII text
edited program is that the Defined Type File Editor parses ASCII text that makes
up defined types so that syntax, properties, and values are easily identified and
edited.
The editor is designed for staff with advanced skills and familiarity with Windows-
based programs. It supports copy-and-paste, for example, but has no menu
commands for functions that select, select all, copy, and paste. It is assumed that
the person using the program is familiar with the keystrokes that invoke these
functions.
The editor supports the following Windows file-handling functions:
It is assumed that the person using the program is familiar with these commands,
too.
Opening an Existing File with the Defined Type Editor (General Tab)
The Defined Type File Editor can be started by selecting Start > Simatic > DBA >
Defined Type Editor.
Open an .HMI file by selecting File > Open and moving if necessary to the
directory containing the .HMI file of interest, typically C:\Program
Files\SIEMENS\DBA\APACS\Templates. Select and open the file.

A5E00595269-01 11-25
The file opens in the "General" view, where the file is parsed so that its structure is
revealed. The left pane of a typical file is shown below (this has been derived from
the code provided for the single-loop defined type file in the section titled Defined
Type File Layout and Syntax).
The right pane contains two columns, labeled Property and Value corresponding to
the object selected in the left pane. If the object #blocktype <variable> were
selected in the left pane shown above, the right panel would be as follows:
Elements in the Value column can be changed by clicking and editing them. There
is no syntax or value checking, just as a plain ASCII editor would not check syntax
and value for source code. Edits are reflected in the objects in the left pane.
HMI Format Tab

Toggling between the General and HMI format tab switches the display between
HMI file objects (general) and ASCII text (HMI format). The following illustration
shows the example file in ASCII display:
;DEFINEDTYPE:SINGLE_LOOP
;SCHEMAVERSION:1.0.0
[4.00 - 6.0 PCS 7]
HMI:TAG_STRUCTURE=SINGLE_LOOP_AFB
HMI:"SINGLE_LOOP_AFB":TAG=#blocktype:TYPE=TEXTREF:
HMI::TAG=#areaname:TYPE=TEXTREF:
HMI:@StripEnclosingApostrophes(VALUE;.DESC.VALUE):TAG=#comment:TYPE
=TEXTREF:
HMI::TAG=DecimalPlacesPV:TYPE=DWORD:VarProperty=0:

11-26 A5E00595269-01
HMI::TAG=DecimalPlacesOUT:TYPE=DWORD:VarProperty=0:
; Include common controller information
HMI:@INCLUDE(CONTROLLER_COMMON[4.00 - 6.0 PCS 7])
; Include alarm mapping information
HMI:@INCLUDE(ALARM_MAP[4.00 - 6.0 PCS 7])
EXA::Category="Graphics":AttributeName=DecimalPlacesPV:Value=2:Type
=Integer:MinInclusive=0:MaxInclusive=6:Permission=RW:Vis
EXA::Category="Graphics":AttributeName=DecimalPlacesOUT:Valu
e=2:Type=Integer:MinInclusive=0:MaxInclusive=6:Permission=RW
:Vi
The EXA: lines shown above have been broken for purposes of illustration. In the
editor each is rendered properly as a single, continuous line terminated by a single
ASCII carriage-return code.
This ASCII rendition can be edited, and any edits are reflected in objects when the
display is toggled to the General mode. It may be necessary to click the menu
selections View > Refresh to update the display.
In the HMI format mode, it is possible to paste one or more lines of HMI defined
type file ASCII text into a file, then switch to the General mode to edit specific
values.
Advanced Options
The advanced options (View > Advanced options) of Defined Type Editor are
reserved for use by Siemens staff or by customers troubleshooting applications
under close supervision of Siemens staff.

A5E00595269-01 11-27

1 2 3 4 5 6 7 8 9 10 11 Simatic: Manual

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

1 2 3 4 5 6 7 8 9 10 11 Simatic: Manual

Uploaded by

Copyright:

Available Formats

s

SIMATIC Project Setup 2

Manual Adding Batch Types 6

Adding Batch Components to 7

Compiling the Project 8

Configuring APACS+ for Use 11

Siemens AG Copyright © Siemens AG 2005

Purpose of the Manual

Required Basic Knowledge

Where is this Manual valid?

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

A&D Technical Support

Johnson City Beijing

United States: Johnson City, TN Worldwide: Nürnberg Asia / Australia: Beijing

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

7.3 Adding Batch Units ........................................................................................... 7-5

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

1.1 Program Operation and Conventions

Primary GUI Quadrants or Panes

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

Menus and Toolbar

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

Unsaved Changes in a Project

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

Invalid Characters in Folder and Picture Names

1.2 Quick Start Steps (Batch 6.1)

Using the DBA Utility

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

9. Adding Batch Components to the Plant View

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

2.1 Creating a New WinCC Project (6.1)

2.2 Creating or Opening a DBA Project

2.3 Importing a Legacy 5.2 DBA Project

2. Select Import Legacy APACS+ DBA Session File.

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

Replacing the Current Symbol Set with New, Smaller Symbols

2.4 Importing a Legacy V6.0 DBA Project

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

Defined Type Files

2.5 Opening, Saving, and Closing a DBA Utility Project

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

To open an existing project from Windows Explorer

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

3.1 Adding APACS+ AS Batch Nodes to a 6.1 Project

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

8. Select the AS node of interest and click the OK button.

9. Click the OK button.

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

3.2 Adding OPC Server AS Nodes to a Project

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

The Connection Name defaults to OPC, but can be edited.

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

CSV file Syntax

TAGS Header Format Recognized by the CSV Processor

PCS 7/APACS+ OS DBA Batch Users Guide for V6.1

HL Optional column that specifies the HI LIMIT of the tag.

LL Optional column that specifies the LO LIMIT of the tag.

MESSAGES Header Format Recognized by the CSV Processor

CLASS Required column that specifies the class of the message.

TYPE Required column that specifies the type of the message.

PRIORITY Optional column that specifies the priority of the message.