Allottware RA add on for WinCC v1 1

Allottware RA add on for WinCC v1 1

CONTENTS

1 INTRODUCTION 3

1.1 RA V 1.1 O VERVIEW 3

1.2 S YSTEM R EQUIREMENTS 3

1.3 A DDITIONAL H ELP 3

2 GETTING STARTED 4

2.1 I NSTALLATION 4

2.2 P ROJECT C REATION 5

2.3 S TANDARD P ROJECT C ONFIGURATIONS 6

2.4 RA N AVIGATION B UILDER 8

2.5 P ROJECT A CTIVATION 10

2.6 W EB N AVIGATOR 11

3 RA NAVIGATION BUILDER 15

3.1 O VERVIEW 15

3.2 T EMPLATE S ELECTION 15

3.3 N AVIGATION C ONFIGURATION 16

3.4 B RANDING 19

3.5 B UILDING 19

4 RUNTIME FUNCTIONALITY 20

4.1 D EFAULT T EMPLATE 20

4.2 M AIN T OOL B UTTONS 20

4.3 D EFAULT M ENUS 21

4.4 N AVIGATOR 22

4.5 H ELP P AGE 23

4.6 L OOP - IN -A LARM 24

4.7 A UDIBLE A LARMS (H ORN ) 25

4.8 RA W IN CC T AG D EBUGGER 26

4.9 S PLIT -S CREEN C ONFIGURATIONS 27

4.10 H IERARCHICAL A LARM N AVIGATION 28

5 RA FACEPLATE BUILDER 29

6 RA RECIPE MANAGER 30

7 INCLUDED SCRIPT LIBRARY 31

8 WIZARDS 32

8.1 RA W IZARDS 32

8.2 H OW TO L OAD THE W IZARDS 33

8.3 H OW TO U SE THE W IZARDS 34

8.4 E XAMPLE U SAGE 35

9 CREATING YOUR OWN TEMPLATES 36

10 RA DEMO PROJECT 37

RA v1.1 is aimed primarily at small to medium sized systems implemented as an integrated Step7/WinCC project The Faceplate Builder is designed to work with structured tags generated automatically by the Step7 OS compilation of Function Blocks and instance Data Blocks (if you are using Siemens PLC and Siemens HMI, then this is how your project should already be structured)

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

1.2 System Requirements

The following software versions were used in testing Other versions may or may not work correctly:

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

OS you can ignore this step

2.3 Standard Project Configurations

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

2.3.1 Project Properties

When you create an OS project in Step7 it defaults to a multi-user project This can cause license errors if you are building a single-user system and do not have a Server authorization for WinCC

Right-click on the very first node in the tree (the name you gave to your OS) and change the project to a single-user system

OS-ProjectEditor add-on then you must install the Basic Process Control add-on from the WinCC install CD

You do not need to make any changes in the editor Simply click the OK button and it will generate

configuration The Basic Process Control pictures will also be applied, but these will be overwritten when the RA Template

is applied

On the “Branding” page you can select your own image files to be incorporated into the project, or you can leave the default images in place

On the “Build” page, select the option to delete the Basic Process Control picture files This will delete all the files starting with “@” from the GraCS folder If you do not do this the project will be activated with the BPC screen template

Click on “Build” to generate your project

Select the “raMain.pdl” file

If you want a split-screen configuration, select one

of the “raSplit_XxX” pictures

The WinCC project should now be activated with the RA Template

2.6 Web Navigator

Follow these steps to publish the project using the Web Navigator add-on:

1 Configure the Web Server

2 Publish the Pictures

2.6.1 Configure the Web Server

Open the Web Configurator from the context menu

Accept all the defaults to create a new Web You must have IIS installed

2.6.2 Publish the Pictures

Next open the Web Publishing Wizard

Select all of the pictures

Select all of the functions

Select all of the bitmap image files

Click “Finish” to create all the Web pictures

2.6.3 Configure Users

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

This is configured in the standard WinCC User Administrator application

Open the WinCC User Administrator

password you require

Select the Web Navigator

“raMain.pd_” start picture and the correct language

You will not be able to select the start page before you have published your pictures (see the previous section)

2.6.4 Logon using MS Internet Explorer

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

Open an Internet Explorer window and type in the address “http://<COMPUTERNAME>/”, where <COMPUTERNAME> is the computer name of 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/”

You will be prompted to login

Enter one of the usernames you configured in the previous step

The first time you logon you will be prompted to download and install the Web Navigator client software Follow the onscreen instructions to run the client installation

Once the client software has installed you will

be able to view the project (the WinCC Runtime must also

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)

3.3 Navigation Configuration

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

All your pictures are displayed at the bottom Drag and drop the pictures onto the containers

in the tree to add them to your menus

You can also use drag and drop to move containers around in the tree When you build the template your menu structure will be compiled according to this tree

3.3.2 Context Menu

The functions of the context menu are as follows:

Menu Item Description

Add Container Add a new container to the tree (on the same level as the selected one)

Add Sub-Container Add a new container to the tree (as a child on the selected container)

Add Back Button Add a “Back” button In runtime this is a menu button that will return to the parent menu

Edit Container Edit the selected container

Delete Container Delete the selected container

Cut Cut the selected container from the tree for pasting

Paste Paste the cut container before the selected node

Paste Into Paste the cut container as a child of the selected node

Apply Access to All Apply the selected access level to the selected container and all of its children

Picture Name Display the picture name in the tree

Descriptions Display the picture names & titles in the tree

Titles Only Display only the picture titles in the tree

Save Menu Save the selected menu to a file

Load Menu Load a previously saved menu file into the selected menu

3.3.3 Editing Containers

There are four type of menu buttons you can create:

1 Standard Buttons either open a submenu or picture or are simply descriptive labels

2 “Back” buttons are buttons that return to the previous or parent menu

3 Copied objects are any graphic object copied from another picture

4 Script buttons are menu buttons that perform some C-Script action

Every menu button has a caption and an authorization The caption is simply the text to be displayed on the menu button

The authorization is the standard WinCC user authorization that is required to click on the button Click on the ellipses button (…) to open the WinCC user authorization selection dialog

3.3.3.1 Label/Button

If you select a picture on a standard button then that picture will be opened when the menu button is clicked If you specify a picture title it will be displayed in the main picture title bar If you do not specify a picture title, the picture name will be used

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

You can specify whether to place the object where the button would be placed (inline) or provide your own X and Y coordinates

This can be used for example to insert a logo image on the menu

3.3.6 C-Script

If you select C-Script you can enter a C-Script function to be executed in the Mouse Action event of the button

The “Compile” button will compile the script and inform you of any compilation errors in the script

You can paste any valid C-Script code from WinCC pictures in here

3.4 Branding

On the “Branding” page you can select your own image files to be incorporated into the project, or you can leave the default images in place

This allows you to brand the template differently for different projects without having

to create entirely separate templates just for different company logos

Click on “Replace” to select a new image file Click on “Original” to revert to the original image

3.5 Building

On the “Build” page, select the option to delete the Basic Process Control picture files This will delete all the files starting with “@” from the GraCS folder If you do not do this, the project will be activated with the BPC screen template

If you select “Create non-existent mimics” then any picture names found in the navigation tree that do not exist will be created for you

Click on “Build” to generate your project

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

4.2 Main Tool Buttons

Open the main mimic menu Log on

Open the alarms menu Silence horn (if configured)

Open the trends/reports menu Open system help page

Picture Title The name of the currently displayed picture is shown here

User Name The user name currently logged on

Navigation buttons and Current time

Alarms The latest active or unacknowledged alarms Click here to open the main alarm window

Menu Selection The four main menus are selected here:

Mimics, Alarms, Reports and System

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

Alarm Page Description

Incoming All currently unacknowledged alarms

Current All currently active alarms

Alarms High/Low Alarms & Warnings

Process Process control alarms

Operations Operator actions (manual device control, set point change, user logon)

System Control system alarms & messages (PLC & OS equipment & communications)

4.3.3 Trends & Reports

Report Page Description

Main Trends Opens a trend page that the user cannot edit in runtime

User Trends Opens a trend page that the user can edit in runtime

Floating Trends Opens a floating trend window that can be edited in runtime

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

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

Currently the builder does not correctly compile one of the functions, so if you add pictures to the project you must manually compile the function before this navigator drop- down will list all the pictures correctly

Open the C-Script function “raNavigator” from the WinCC Explorer

Compile the function by clicking on the “Compile” button

Save the function by clicking on the “Save” button

These three buttons control the automatic slide-show function From left to right:

Play – this starts the slide show Stop – this stops the slide show Close – this closes the navigator window

The pictures that are included in the automatic slide show are specified in the properties dialog of the RA Navigation Builder

When the slide show is started, the picture is automatically changed every 10 seconds

4.5 Help Page

Click the Help button to display the system help file:

The default help file is blank The intention is for you to replace it with your own help file for your project

The help file is stored in the following location:

<Your WinCC Project Folder> \ RA \ Help \ Index.html

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:

Loop-in-Alarm tool button

4.6.2 Configuration

In the alarm-logging editor select the message you want

to add this functionality to and open the properties dialog Enter the device name (tag name) as the parameter and select the function “raLoopInAlarm” This function is part

of the RA Script library and will open the faceplate for the supplied tag name

The faceplate for the device that triggered the alarm is opened up when the alarm

is selected in the alarm list and the loop-in-alarm button

is pressed