Professional Documents
Culture Documents
User Manual
Allottware CC
Reg No: 2004/028046/23
P.O. Box 12611, Vorna Valley, 1686, South Africa
Managing Members:
Reuben Allott
User Manual RA Add-On for WinCC v1.1
CONTENTS
1 INTRODUCTION....................................................................................................................................... 3
1.1 RA V1.1 OVERVIEW ............................................................................................................................. 3
1.2 SYSTEM REQUIREMENTS ...................................................................................................................... 3
1.3 ADDITIONAL HELP ............................................................................................................................... 3
2 GETTING STARTED ................................................................................................................................ 4
2.1 INSTALLATION...................................................................................................................................... 4
2.2 PROJECT CREATION .............................................................................................................................. 5
2.3 STANDARD PROJECT CONFIGURATIONS ............................................................................................... 6
2.4 RA NAVIGATION BUILDER ................................................................................................................... 8
2.5 PROJECT ACTIVATION ........................................................................................................................ 10
2.6 WEB NAVIGATOR ............................................................................................................................... 11
3 RA NAVIGATION BUILDER ................................................................................................................ 15
3.1 OVERVIEW ......................................................................................................................................... 15
3.2 TEMPLATE SELECTION ....................................................................................................................... 15
3.3 NAVIGATION CONFIGURATION ........................................................................................................... 16
3.4 BRANDING .......................................................................................................................................... 19
3.5 BUILDING ........................................................................................................................................... 19
4 RUNTIME FUNCTIONALITY............................................................................................................... 20
4.1 DEFAULT TEMPLATE .......................................................................................................................... 20
4.2 MAIN TOOL BUTTONS ........................................................................................................................ 20
4.3 DEFAULT MENUS ............................................................................................................................... 21
4.4 NAVIGATOR ....................................................................................................................................... 22
4.5 HELP PAGE ......................................................................................................................................... 23
4.6 LOOP-IN-ALARM ................................................................................................................................ 24
4.7 AUDIBLE ALARMS (HORN)................................................................................................................. 25
4.8 RA WINCC TAG DEBUGGER ............................................................................................................. 26
4.9 SPLIT-SCREEN CONFIGURATIONS ....................................................................................................... 27
4.10 HIERARCHICAL ALARM NAVIGATION ................................................................................................ 28
5 RA FACEPLATE BUILDER................................................................................................................... 29
6 RA RECIPE MANAGER......................................................................................................................... 30
7 INCLUDED SCRIPT LIBRARY ............................................................................................................ 31
8 WIZARDS ................................................................................................................................................. 32
8.1 RA WIZARDS ..................................................................................................................................... 32
8.2 HOW TO LOAD THE WIZARDS ............................................................................................................. 33
8.3 HOW TO USE THE WIZARDS ............................................................................................................... 34
8.4 EXAMPLE USAGE ............................................................................................................................... 35
9 CREATING YOUR OWN TEMPLATES .............................................................................................. 36
10 RA DEMO PROJECT.............................................................................................................................. 37
1 INTRODUCTION
1.1 RA v1.1 Overview
Allottware RA v1.1 is an attractive alternative to the Basic Process Control navigation system
that ships with SIMATIC WinCC v6.0.
The system builds menus and faceplates from a set of template files. You can edit the
standard template files or create your own templates altogether. The system supports split-
screen configurations and can be published correctly using the Web Navigator or Data
Monitor systems (unlike Basic Process Control).
You can also use the RA Faceplate Builder in a stand-alone WinCC system as long as you
use tag structures that mimic the structures created by Step7 function blocks. This is
described later.
NOTE: The RA Template builder generates a project using completely standard WinCC
graphics and scripts. You can copy the project to another computer that does not have RA
installed on it and the project will still work correctly, although you won’t be able to edit the
navigation menus.
The following software versions were used in testing. Other versions may or may not work
correctly:
You can find the latest online help at the official RA web site:
http://www.allottware.co.za/ra
2 GETTING STARTED
2.1 Installation
This getting started guide shows how to integrate a brand new WinCC project into an existing
Step7 project, apply the RA Template and publish it using the WinCC Web Navigator option.
It assumes that you already have Step7, WinCC, Web Navigator Server and corresponding
authorizations installed. Before installing Web Navigator you must have IIS installed. Please
refer to the Web Navigator/IIS documentation for this. When you install WinCC you must
select the Basic Process Control option.
RA v1.1 Add-On for WinCC is installed from the RA setup CD or from the setup.exe file
found in the RAv1.1.zip file downloaded from www.allottware.co.za. This is a standard
Windows installation:
You can accept the default installation path and just click next until the wizard has completed
the installation.
Right-click on your OS and select “Open Object” to open your OS project with WinCC. If
you have correctly installed the RA v1.1 Add-On then you should see it in the tree just above
Web Navigator:
Before using the RA Template Builder you must apply a few project settings.
The RA Template works with the standard alarm configurations generated by the Basic
Process Control editor. We don’t use the Basic Process Control navigation system though.
The first time you run the project you will have to
define the start picture.
Follow these steps to publish the project using the Web Navigator add-on:
NOTE:
If you have problems with the configuration make sure you have all the latest versions and
service packs of WinCC, Web Navigator, Windows and Internet Explorer. See section “1.2
System Requirements” for a list of tested software versions.
Before you can use the Web Navigator client you must create users that have Web Navigator
access enabled for them, and select a start page for that use.
You will not be able to select the start page before you have published your pictures (see the
previous section).
We will now access the WinCC Runtime via the Web Navigator system using Microsoft
Internet Explorer. Make sure the WinCC Runtime is activated on the WinCC machine.
If you are using Internet Explorer on the same computer as WinCC you can use the address
“http://localhost/”. If the WinCC computer name is “WinCC_1” then type in
“http://wincc_1/”.
3 RA NAVIGATION BUILDER
3.1 Overview
The main goal of the Navigation Builder is to apply the selected screen template to your
project and build the navigation menus for the pictures in your plant.
A library of scripts and pictures is also added to your project. Most of these scripts are used
by the navigation system to display pictures and faceplates.
You can also create your own templates that can be applied to new projects. This is useful for
OEM or System Integrators that implement many projects with their own branding and
special functionalities (you can download new templates from the RA website at
www.allottware.co.za/ra).
The first configuration is to select the main template to apply. Select the template from the
drop-down list.
3.3.1 Overview
In the navigation tree you build your menu
hierarchy by adding containers and sub-
containers. All operations are performed from
the right-click context menu.
3.3.3.1 Label/Button
If you select no picture then the menu item appears simply as a text
label.
Select this option to include this picture in the automatic slide show
(see the section on the Navigator window for more details).
Menu items can be linked to alarm status tags that are linked to alarm
groups configured in the WinCC Alarm Logging editor.
Please refer to the alarm logging help for more information on the
implementation of these status tags.
A back button has no setting other than the caption text. In runtime the button will replace the
current menu with the parent menu (return to previous menu).
3.3.6 C-Script
3.4 Branding
3.5 Building
4 RUNTIME FUNCTIONALITY
4.1 Default Template
The default template is described here. It is possible that you have a different template that
was created by someone else.
User Name
Picture Title The user name
The name of the currently logged on
currently displayed
picture is shown here
Navigation buttons
Menu Selection and Current time
The four main menus
are selected here:
Mimics, Alarms, Alarms
Reports and System The latest active or
unacknowledged alarms
Click here to open the
main alarm window
Main Menu
Select pictures Mimic Area
and sub-menus Pictures are
from here. displayed in this
main area
When you apply the template to your project for the first time the following default mimics
are added to your menu system.
4.3.1 Mimics
Mimic Description
Project Overview This is a blank mimic to be used as your main starting page
Help This is an HTML-based help system for your project
Legend This shows and explains the main symbols and colours used in your project
Test This is a blank page to be used for testing purposes
4.3.2 Alarms
4.3.4 System
Function Description
Global Script Diag This opens the Global Script diagnostics window, used primarily for debugging scripts
Tag Debugger This opens the WinCC Tag Debugger application, which is described later in the document
Shut Down This shuts down the WinCC runtime
Restart PC This shuts down the WinCC runtime and reboots the computer
Project Editor This opens the WinCC Explorer program
Graphics Editor This opens the WinCC Graphics Editor, with the currently displayed picture
C-Script Editor This opens the WinCC C-Script Editor
VB-Script Editor This opens the WinCC VB-Script Editor
User Admin This opens the WinCC User Administrator
Windows Explorer This opens a Windows Explorer window
Task Manager This opens the Windows Task Manager
Calculator This opens the Calculator program
It is possible to disable faceplates if there are scripts in your project which attempt to open non-
Fix Popups
existent faceplates. This button fixes that scenario.
4.4 Navigator
If you click on the main picture title bar in runtime you will
get a drop-down list of all the pictures in the project. Simply
select the picture to open it in the main window.
The pictures that are included in the automatic slide show are
specified in the properties dialog of the RA Navigation
Builder.
The default help file is blank. The intention is for you to replace it with your own help file for
your project.
This is a standard HTML text file. You can edit this file or replace it with your own file.
4.6 Loop-in-Alarm
4.6.1 Runtime
Loop-in-Alarm is a standard WinCC alarm logging function that allows you to open a picture
or faceplate for the selected alarm. Select the alarm in the alarm-logging list and click on the
loop-in-alarm button on the alarm control toolbar:
4.6.2 Configuration
WinCC V6.0 makes it very simple to configure audible alarms. When a certain alarm is
triggered the system will write a tag to the PLC to sound a physical horn, or the PC will play
a sound file through the computer speaker.
Some functionality has been included in the template project already to make this even
simpler.
First, you must decide which alarm classes or groups (as configured in the WinCC Alarm
Logging editor) will trigger an audible alarm.
Select the alarm message class that is to trigger an Select the “RA-HORN” tag again, and select the sound
audible alarm, and select the tag “RA-HORN” (this tag file to play when an alarm is triggered (*.wav – the
is created by the template builder and is already linked template builder copies several example files into the
to the template pictures). project for you).
In runtime when an alarm is triggered (of the class you selected in the Horn
editor) the selected sound file will be played until the tag “RA-HORN” is
switched off.
The “Horn” button flashes red. Click this button to turn off the “RA-HORN”
tag and thus silence the sound file.
NOTE:
If you want to trigger a tag in the PLC for a horn connected to the PLC, then substitute the
tag “RA-HORN” with your own PLC tag. You will have to edit the template picture shown
above to be able to switch off the tag from WinCC.
The WinCC Tag Debugger is a simple utility for reading and writing runtime tag values in
various formats. It is intended for testing purposes.
It is possible to use the template in split-screen configurations. You need to configure your
video system with a desktop stretched across multiple monitors.
The most common configuration is to have two screens side by side. The default template
size is 1024x768 pixels, for which we normally use the picture “raMain.pdl” as the main
picture. With two screens it is 2048x768, and we simply open two copies of “raMain.pdl”
side by side. Do to this you need another picture file that displays the “raMain.pdl” picture
twice on one picture.
There are a few pre-configured pictures in the default template that do this already. Simply
select the one you want as the start picture for the project.
Picture Usage
raMain Standard single-screen configuration
raSplit_1x2 Two screens, one next to the other
raSplit_2x1 Two screens, one above the other
raSplit_2x2 Four screens, two rows by two columns
5 RA FACEPLATE BUILDER
The RA Faceplate Builder simplifies the process of creating device-specific faceplates. Each
faceplate is associated with an FB in Step7 and the corresponding tag structure created in
WinCC by the OS Compilation of the Step7 data.
The Faceplate Builder is explained in more detail in the accompanying document “RA
Faceplate Builder v1.1”.
You can get the latest revision of this document from www.allottware.co.za.
6 RA RECIPE MANAGER
The RA Recipe Manager is a simple recipe system include with RA v1.1. It is explained in
more detail in the accompanying document “RA Recipe Manager v1.1”.
You can get the latest revision of this document from www.allottware.co.za.
There are many scripts included in the template project. Many of these scripts are used by the
template navigation and faceplate systems, and should not be edited or used directly in your
project.
There are several useful string manipulation functions and system functions that deal with the
registry, tag values and the operating system.
Please read the header blocks in the actual scripts for more detailed information.
Function Description
This is a blank function created by the template builder. Insert code in
ProjectStartup here that is to be executed at project startup. This function will
execute once only, and does not execute on WebNavigator clients.
This opens a picture in the main window. You must use this function to
raOpenPicture ensure compatibility with split-screen configurations and Web
Navigator.
raOpenPictureWithTagPrefix Open a picture. Apply a tag prefix to the entire picture.
raPopup Open a picture in a poup window.
Open a device faceplate. The faceplates are created with the RA
raPopupDevice
Faceplate Builder.
raLoopInAlarm Open a device faceplate from the alarm list (see Loop-in-Alarm section)
8 WIZARDS
Several Dynamic Wizards are available for the RA WinCC Template. These make certain
configurations in the graphics editor easier. When using the RA WinCC Template
framework, certain operations, like displaying a mimic or opening a popup faceplate, must be
done using the functions provided by the template. This ensures that the project remains fully
compatible with split-screen and Web Navigator configurations, as well as maintains
functionality such as the paging history.
Using Dynamic Wizards means that you do not need to know what functions or scripting to
use to perform these operations.
8.1 RA Wizards
• Open Picture - Use this to open a new mimic in the main mimic window. You can select
the .PDL filename to diplay, and optionally supply a title to display as the mimic caption
(if no title is specified, the mimic filename is used).
• Open Picture (Tag Prefix) – Use this to open a new mimic in the main window with a
tag prefix assigned to the entire mimic.
• Open Popup - Use this to open a new popup window. You can select the .PDL filename
to open in the popup window, and optionally supply a title and tag prefix to apply to the
windwo).
• Open Popup (Device) - Use this to open a new popup window for a structured-tag
device. The structured tag must be selected, which must conform to the PCS7-style
naming conventions (this includes text tags that indicate what .PDL file to use).
I haven't yet figured out how to automatically load the RA Wizards for you yet, so you'll have
to load them manually before you can use them.
First, you must copy the Dynamic Wizard files from the RA CD, in the following location:
Next, install the optional "Dynamic Wizard Editor" from the WinCC CD, and open it:
Click on the compile button as shown above, and the RA Wizards will become available.
The Wizards are accessed from the WinCC Graphics Editor. If the Dynamic Wizard window
is not visible, enable it from the "View"-> "Toolbars" menu option:
You must have a picture opened. Select an object, such as a button, and then double-click on
the Dynamic Wizard you wish to run. You will be prompted to fill in certain parameters, such
as tag names or picture names, and then the Wizard will fill in any scripting or dynamics
required.
Make sure the Dynamic Wizard toolbox is open and select a button in the WinCC Graphics
Editor. The following example shows how to use the wizard to open a device faceplate.
Now click on the button (…) to select the tag from the
WinCC tag selection dialog.
10 RA DEMO PROJECT
The RA Demo Project is an example implementation of the RA Template project using the
Navigation & Faceplate builder in an integrated Step7/WinCC environment.
The project includes examples of: Step7/WinCC integration, function blocks with
corresponding faceplates, process and system diagnostics, AS-triggered alarming and many
WinCC scripting examples.
More detailed help on the RA Demo Project will be included in the next release.
Demo project with faceplates, trending & alarming all published to the web