You are on page 1of 376

Manual Version 1.

Vijeo Designer Training Manual


Version 5.1

Schneider-Electric Pty Ltd 245 route des Lucioles BP147 Sophia Antipolis Cedex 06903 FRANCE

DISCLAIMER Schneider Electric Inc. makes no representations or warranties with respect to this manual and, to the maximum extent permitted by law, expressly limits its liability for breach of any warranty that may be implied to the replacement of this manual with another. Furthermore, Schneider Electric Inc. reserves the right to revise this publication at any time without incurring an obligation to notify any person of the revision. Schneider Electric Inc. (Schneider) Vijeo Designer Configuration Training Manual INTRODUCTION AND LEGAL NOTICE Your purchase of this official Vijeo Designer Configuration Training Manual entitles you to undertake the Vijeo Designer Configuration training course. The number allocated to you on purchase of this manual is your key to complete the course evaluation. Satisfactory completion of this evaluation is mandatory for you to obtain a Schneider Electric Inc. certificate of completion of the training course. The contents of this manual are proprietary to Schneider Electric Inc. and all rights, including copyright, are reserved by Schneider Electric Inc.. You must not copy any part of the manual in hard or electronic form or make any adaptation or other commercial use of it without Schneider's prior written consent. Schneider Electric Inc. will not accept any liability for action taken in reliance on this training manual.

COPYRIGHT Copyright Schneider Electric Inc. All rights reserved.

TRADEMARKS Schneider Electric Inc. has made every effort to supply trademark information about company names, products and services mentioned in this manual. Trademarks shown below were derived from various sources. Windows, Windows NT, Windows 2000, Windows XP, MSSQL Server and Excel are trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Novell and NetWare are registered trademarks of Novell Inc. dBASE is a trademark of Borland Inc. General Notice: Some product names used in this manual are used for identification purposes only and may be trademarks of their respective companies. About Us Members of Schneiders team of Instructional Designers have tertiary qualifications in Education, Educational Course Development and are also experienced trainers in their own right; some are also published authors. Currently, the team is supporting a range of over 70 courses in multiple languages and multiple software environments. Authors

September 2010 Edition for Version 5.1 Manual Version 1.1 Written, Printed and bound in Australia

ii

Version 5.1

September 2010

Contents
CHAPTER 1: INTRODUCTION TO VIJEO DESIGNER .................................................... 1-1

Overview .................................................................................................................... 1-1 Before You Begin....................................................................................................... 1-2 Course Overview ........................................................................................................ 1-3 Conventions Used in this Manual............................................................................... 1-5 CHAPTER 2: VIJEO DESIGNER AT A GLANCE ............................................................ 2-1

Overview .................................................................................................................... 2-1 System Requirements ................................................................................................. 2-2 The Vijeo Designer Interface ..................................................................................... 2-4 CHAPTER 3: PROJECT MANAGEMENT ....................................................................... 3-1

Overview .................................................................................................................... 3-1 The Navigator ............................................................................................................. 3-2 The Vijeo Manager..................................................................................................... 3-3 Project Manager.......................................................................................................... 3-4 New Projects............................................................................................................... 3-5 Select the Target Model.............................................................................................. 3-7 Save a Project ............................................................................................................. 3-8 Backup a Project....................................................................................................... 3-15 Delete Projects.......................................................................................................... 3-17 Restore a Project....................................................................................................... 3-19 Project Validation..................................................................................................... 3-21 Project Simulation .................................................................................................... 3-24 CHAPTER 4: VIJEO DESIGNER VARIABLES ................................................................ 4-1

Overview .................................................................................................................... 4-1 Variables..................................................................................................................... 4-2 Variable Editor ........................................................................................................... 4-5 Variable Addressing ................................................................................................... 4-9 Variable Logging Groups ......................................................................................... 4-11 Variable Properties - Input Range ............................................................................ 4-12 Block Variables ........................................................................................................ 4-13 Variable Folders ....................................................................................................... 4-14 System Variables ...................................................................................................... 4-15 Variable Arrays ........................................................................................................ 4-16 Reference Variables.................................................................................................. 4-18 Reference Variable Solution..................................................................................... 4-21 Scan Groups.............................................................................................................. 4-22 Importing PLC Variables (Linking) ......................................................................... 4-24 Updating a Variable Link ......................................................................................... 4-26 XML Support for Variables...................................................................................... 4-27 Vijeo Designer Manual Version 1.1 iii

CHAPTER 5:

GRAPHICS .............................................................................................. 5-1

Overview .................................................................................................................... 5-1 Graphic Panels............................................................................................................ 5-2 Graphical Editor ......................................................................................................... 5-5 The Property Inspector ............................................................................................... 5-6 Graphical Objects Toolbar ......................................................................................... 5-9 Draw Basic Objects .................................................................................................. 5-11 Time and Date Display ............................................................................................. 5-13 Color Picker Tool ..................................................................................................... 5-18 Base Panels............................................................................................................... 5-19 Panel Text................................................................................................................. 5-24 Navigation Introduction............................................................................................ 5-27 Panel Navigation ...................................................................................................... 5-28 Add Clipart to a Panel .............................................................................................. 5-36 Rectangles, Squares, Ellipses and Circles ................................................................ 5-41 Lines, Polylines and Polygons.................................................................................. 5-43 CHAPTER 6: ANIMATION AND CONTROLS ................................................................. 6-1

Overview .................................................................................................................... 6-1 Animation ................................................................................................................... 6-2 Expression Editor ....................................................................................................... 6-3 Numeric Displays ....................................................................................................... 6-4 Custom Shape Animation......................................................................................... 6-14 Color Resources........................................................................................................ 6-17 Bar Graphs................................................................................................................ 6-22 Lamps ....................................................................................................................... 6-29 CHAPTER 7: POPUP PANELS AND METERS ................................................................ 7-1

Overview .................................................................................................................... 7-1 Popup Panels .............................................................................................................. 7-2 Popup Windows, Groups and Panels.......................................................................... 7-3 Creating a Popup Panel .............................................................................................. 7-6 Meters ......................................................................................................................... 7-8 Launching a Popup Panel ......................................................................................... 7-13 CHAPTER 8: TRENDS .................................................................................................. 8-1

Overview .................................................................................................................... 8-1 Trend Introduction...................................................................................................... 8-2 Realtime Trend Charts................................................................................................ 8-3 Historical Trend Charts .............................................................................................. 8-5 Block & Plot Trends................................................................................................... 8-7 Data Logging ............................................................................................................ 8-11 Data Logging Groups ............................................................................................... 8-12 Data Logging Group - Variable Setting ................................................................... 8-16 Data Logging Group Buffer ..................................................................................... 8-19

iv

Version 5.1

September 2010

CHAPTER 9:

ALARMS AND EVENTS ............................................................................ 9-1

Overview - Alarms and Events................................................................................... 9-1 Alarming Introduction ................................................................................................ 9-2 Alarm Groups ............................................................................................................. 9-3 Alarm Sounds ............................................................................................................. 9-8 Alarm Variables........................................................................................................ 9-10 Alarm Banners.......................................................................................................... 9-17 Alarm Summary ....................................................................................................... 9-22 Alarm Categories...................................................................................................... 9-30 Output Alarms to File ............................................................................................... 9-32 Alarm Printing .......................................................................................................... 9-37 Real-Time Alarm Printing ........................................................................................ 9-41 Event Monitoring...................................................................................................... 9-42 Exercise - Event Monitoring .................................................................................... 9-45 CHAPTER 10: FORMS & EMAIL .................................................................................. 10-1

Overview .................................................................................................................. 10-1 Forms ........................................................................................................................ 10-2 Form Editor .............................................................................................................. 10-3 Email......................................................................................................................... 10-7 Configuring Email .................................................................................................... 10-9 Triggering Email .................................................................................................... 10-10 CHAPTER 11: SCRIPTING ............................................................................................ 11-1

Overview .................................................................................................................. 11-1 Scripting Introduction............................................................................................... 11-2 Script Types and Scope ............................................................................................ 11-3 Variables and Scripting ............................................................................................ 11-4 Scripting Basics ........................................................................................................ 11-5 Variable Read/Write Methods .................................................................................. 11-6 Creating an Action Script ......................................................................................... 11-7 Script Editor.............................................................................................................. 11-9 Panel and Object Level Scripts............................................................................... 11-11 CHAPTER 12: PROJECT SECURITY ............................................................................. 12-1

Overview .................................................................................................................. 12-1 Security Introduction ................................................................................................ 12-2 Project Security ........................................................................................................ 12-3 Target Security ......................................................................................................... 12-4 Other Security........................................................................................................... 12-5 Security Groups ........................................................................................................ 12-6 Security Levels ......................................................................................................... 12-7 Target Operation....................................................................................................... 12-8 User Login .............................................................................................................. 12-10 Security on Switches .............................................................................................. 12-11

Vijeo Designer

Manual Version 1.1

CHAPTER 13:

RECIPES ............................................................................................... 13-1

Overview .................................................................................................................. 13-1 Introduction to Vijeo Recipes................................................................................... 13-2 Recipe Terminology ................................................................................................. 13-4 Relationship of Parts................................................................................................. 13-5 Recipe Variables....................................................................................................... 13-6 Recipe Groups .......................................................................................................... 13-7 Recipes and Ingredients............................................................................................ 13-8 Recipe Manager........................................................................................................ 13-9 Recipe Security....................................................................................................... 13-10 Recipe Access Rights ............................................................................................. 13-11 CHAPTER 14: DATA SHARING .................................................................................... 14-1

Overview .................................................................................................................. 14-1 Data Sharing Introduction ........................................................................................ 14-2 Exclusive Input ......................................................................................................... 14-3 Input Synchronization .............................................................................................. 14-4 Variable Sharing Example........................................................................................ 14-5 CHAPTER 15: WEB SERVER AND WEB GATE ............................................................ 15-1

Overview .................................................................................................................. 15-1 What is the Web Server? .......................................................................................... 15-2 What is Web Gate? ................................................................................................... 15-3 Web Gate Basics....................................................................................................... 15-4 Web Gate Features/Restrictions ............................................................................... 15-5 Types of Web Gate Connections .............................................................................. 15-6 Web Gate Configuration........................................................................................... 15-7 Web Gate Security.................................................................................................... 15-9 CHAPTER 16: INTELLIGENT DATA SERVICE (IDS) ................................................... 16-1

Overview .................................................................................................................. 16-1 IDS Functionality ..................................................................................................... 16-2 IDS Basics ................................................................................................................ 16-3 IDS Topology ........................................................................................................... 16-4 IDS Configuration Introduction ............................................................................... 16-5 IDS Manager ............................................................................................................ 16-6 Database Type .......................................................................................................... 16-8 Variables Tab............................................................................................................ 16-9 Monitoring/Actions Tab ......................................................................................... 16-10 Create Data Tables ................................................................................................. 16-11 Exercise - IDS Manager ......................................................................................... 16-12 IDS Explorer........................................................................................................... 16-20 Datasources Manager ............................................................................................. 16-21 Menu....................................................................................................................... 16-22 Create a Panel ......................................................................................................... 16-23

vi

Version 5.1

September 2010

CHAPTER 17:

INITIALISE A MAGELIS TERMINAL ..................................................... 17-1

Overview .................................................................................................................. 17-1 Vijeo Designer Runtime System .............................................................................. 17-2 Set the Initial IP Address.......................................................................................... 17-3 Access the System Area ........................................................................................... 17-4 Adjust the Terminal .................................................................................................. 17-5 Offline Configuration Screens.................................................................................. 17-6 System Configuration Screens ................................................................................. 17-7 System Diagnostic Screens....................................................................................... 17-8 APPENDIX A: MULTIMEDIA FEATURES ...................................................................... A-1

Overview - Multimedia Features............................................................................... A-1 Multimedia Features.................................................................................................. A-2 ScreenSnapshot.......................................................................................................... A-3 Screen Snapshot Configuration ................................................................................. A-5 ScreenSnapshot Save Tab.......................................................................................... A-6 ScreenSnapshot Print Tab.......................................................................................... A-7 ScreenSnapshot and Web Gate.................................................................................. A-8 Multimedia - Video ................................................................................................... A-9 Video Record Configuration ................................................................................... A-10 Video Recording - Playback Snapshot Configuration............................................. A-11 Live Snapshot Configuration................................................................................... A-12 Video Snapshot Variables ....................................................................................... A-13 Video Display Options ............................................................................................ A-14 Video Control Variables.......................................................................................... A-15 Exercise - Multimedia ............................................................................................. A-16

Vijeo Designer

Manual Version 1.1

vii

Chapter 1: Overview
Introduction

Introduction to Vijeo Designer

Vijeo Designer is a Windows based configuration and programming software dedicated to programming Magelis HMI hardware. Vijeo Designer HMI software handles design from the smallest applications for 3.8 terminals to the most demanding HMI applications of 15 industrial PCs. Its open architecture adapts to all Magelis platforms, as well as to Magelis Smart & Compact iPCs.

This Chapter Covers These Topics: Before You Begin ..................................................................1-2 Course Overview ...................................................................1-3 Conventions Used in this Manual..........................................1-5

Before You Begin


Your Instructor Please write the name of your Instructor here

____________________

Your Instructor will be spending the next four days with you, and will guide you through this training course. Your Instructor is an experienced Vijeo Designer user so please feel free to ask questions. Defining the Scope of this Training Manual This training manual is a supplement to the authorised training. In order to make full use of the software you should also refer to the Online Help and Vijeo Designer Knowledge Base. The graphics displaying screen shots have been taken using the Windows XP operating system using Classic mode display properties. If you are running a different version of Windows then your screens may differ slightly from the ones shown in the training manual. Some screen shots may have been taken from beta versions of the software and may vary slightly from release screen shots.

1-2

Version 5.1

September 2010

Course Overview
Course Objectives By the completion of this training course you will: Be able to use Vijeo Designer to create a HMI application Configure communications between a Magelis target and a PLC Initialize a Magelis terminal for first time use Create a new Vijeo Designer application from the ground up Create user panels for an application using Vijeo Designer Create Vijeo Designer variables manually as well as importing variables from a PLC project Create and use variable arrays Create and use Popup panels Create, Configure and use real time and historical trend charts Create, configure and display alarms Configure and use the email feature Create and use simple scripts Implement project security Create, configure and use the recipe feature Create, configure and use Webgate Implement data sharing between two Magelis terminals Configure and use the Intelligent Data Service Understand the Multimedia feature options Target Audience The Vijeo Designer Configuration training course is an integral part of the complete Schneider Electric curriculum. This course is designed for: Users who are new to Vijeo Designer Users who will create Vijeo Designer based solutions People who will support Vijeo Designer users such as help desk people, Field Service engineers, PAEs, SAEs, Schneider Electric parters and technical sales personnel End users including OEMs and System Integrators

Vijeo Designer

Manual Version 1.1

1-3

Course Overview (cont.)


Course Program The training course will take four days to complete. outlines the topics that will be covered on each day: The following program

Day 1

Topics
Introduction to Vijeo Designer Vijeo Designer at a glance Project Management Setting up PLC Communications Introduction to Vijeo Designer Start a Schneider Soup Project

Import PLC Variables Into a Project Create and Configure a Popup panel Create Realtime and Historical Trend Charts Configure and Test Alarming Configure and Test the Email Feature

Create some Simple Scripts Create and Configure Security Configure and use Recipes Configure and test Webgate Implement Data Sharing between Magelis targets Create and configure Intelligent Data Service Initializing a Magelis

Support

If you require support during training or would like additional information about any concepts or products in the course, please ask your Instructor.

1-4

Version 5.1

September 2010

Conventions Used in this Manual


Objectives These are the skills you will achieve by the end of each chapter. An overview providing a brief synopsis of the topic begins each section. Often, examples are given to illustrate the conceptual overview.

Example The Vijeo Designer configuration environment consists of several toolbars, browser windows and programming editors. This chapter introduces the user to the configuration environment using an example project with pre-defined elements.

Exercises

After a concept is explained you will be given exercises that practise the skills you just learned. These exercises begin by explaining the general concept of each exercise and then step-by-step procedures are listed to guide you through each procedure. Whenever you are required to type information into a field or dialog box it will be written in this font

User Input

Example KETTLE_TEMP/25

Vijeo Designer

Manual Version 1.1

1-5

Conventions Used in this Manual (cont.)


Hints and Tips This heading will provide you with useful or helpful information

Example Hints & Tips To go to the next field, use the mouse cursor or press the TAB key.

Note

A note will refer to a feature which may not be obvious at first glance but something that you should always keep in mind

Example Note:

Any events named GLOBAL are enabled automatically when events are enabled.

Menus and Menu Options

Text separated by the double arrow symbol indicates that you are to select a menu

Example File New

Open a menu File then select the menu option New

Horizontal and Vertical Tabs

Text written this way indicates the Horizontal then the (Vertical) tab you are to select.

Example Appearance (General)

1-6

Version 5.1

September 2010

Conventions Used in this Manual (cont.)


See Also Text written in this way indicates further references about the current topic.

Example See Also:

For further information about Templates, see Vijeo Designer Help - Using Page Templates. Further Training This heading describes topics that are covered in more advanced courses.

Example Further Training:

Trend Table Maths is a topic in the Vijeo Designer Customisation and Design Course. Warning This heading describes situations where the user needs to be careful.

Example WARNING CRITICAL DATA LOSS

Only use communications port for non-critical data transfers.

Vijeo Designer

Manual Version 1.1

1-7

Chapter 2: Overview
Introduction

Vijeo Designer at a Glance

The Vijeo Designer configuration environment consists of several toolbars, browser windows and programming editors. This chapter introduces the user to the configuration environment using an example project with pre-defined elements.

This Chapter Covers These Topics: System Requirements ............................................................2-2 The Vijeo Designer Interface.................................................2-4 Exercise - Examine the User Interface ..................................2-6

System Requirements
Before You Start Before installing Vijeo Designer the computer that will be used as the Vijeo Designer Server needs to be configured. Vijeo Designer has been designed for machines with the following specifications:

Hardware Requirements

The computer equipment may need to be upgraded to run Version 5.1, as the minimum hardware requirements have changed:

Description
Platform Processor Processor Speed Random Access Memory (RAM) Available Disk Space Operating System

Minimum Specification or Higher


PC Intel Pentium 4 2 GHz or faster recommended 1 GB minimum 80GB, or 160GB if running a Web Server Microsoft Windows XP Professional (Service Pack 2 or greater) Microsoft Windows Vista Business edition 32 bits (Service Pack 1 or greater) Microsoft Windows 7 32 Bits

Web Browser

Microsoft Internet Explorer 6.0 (Version 7 or higher recommended)

2-2

Version 5.1

September 2010

System Requirements (cont.)


Forget the Hardware while Developing Create generic program modules regardless of the PLC hardware configuration: Use a set of generic instructions. Module or I/O configuration is not required. Use a generic data structure to map I/O. Vijeo Designer is a single software for three specialised platforms Simulations Vijeo Designer is able to simulate the operation of the selected PLC so that it is possible to run preliminary tests on programs without the need to be connected to a PLC. In addition this simulation allows users to test fault conditions without the need to make the devices fail.

Vijeo Designer

Manual Version 1.1

2-3

The Vijeo Designer Interface


Graphical User Interface

Vijeo Designer uses the Windows interface with its multi-window display. As with all other Schneider software applications, it features:

Menu bar and Toolbar Status bar Navigator Graphic editor Feedback zone

Provides access all the menus and tools use to develop the HMI application Advises users about the status of the software, such as the current zoom and the position of the selected window Used to create and access all the elements in the application such as panels, Java scripts, alarms and popup windows Used to create the application Indicates any faults that occur during the validation or build process of the application

The following windows may also be used:


Toolchest Property Inspector Graphics List Variables Window
Collection of predefined graphic objects Used to configure the selected object Provides an exhaustive list of the objects that feature in the active window Used to enter the variables in the application

Hints & Tips Any of these windows can be closed, resized or moved. Many of the objects in Vijeo Designer have right click menus (quick way to access settings).

2-4

Version 5.1

September 2010

The Vijeo Designer Interface (cont.)


How to Start Vijeo Designer

To start Vijeo Designer:


Select the Vijeo Designer item from the Windows start menu:
Start Programs Schneider Electric Vijeo Designer Vijeo Designer

Vijeo Designer

Manual Version 1.1

2-5

Exercise - Examine the User Interface


1 Open Vijeo Designer. i. ii. Select Start Programs Schneider Electric Vijeo Designer Vijeo Designer. When Vijeo Designer opens the Welcome Screen is displayed. Select the option Open existing Project then click Next > to continue.

iii.

When the Open Existing Project dialog appears select the project Vijeo-Designer_Sample_640x480 from the list. Click Open to continue. changes) (exact name of projects changes as product version

2-6

Version 5.1

September 2010

Exercise - Examine the User Interface (cont.)


iv. The Vijeo-Frame warning will appear warning the user that existing projects will be updated to the current version. Click Yes to continue.

v.

When Vijeo Designer opens use the Navigator on the left side of the screen to open the different example panels.

vi.

Examine the different screens in the project then close the project.

Vijeo Designer

Manual Version 1.1

2-7

Chapter 3: Overview
Introduction

Project Management

This chapter describes the steps required in order to create a new Vijeo Designer project.

This Chapter Covers These Topics: The Navigator ........................................................................3-2 The Vijeo Manager ................................................................3-3 Project Manager.....................................................................3-4 New Projects ..........................................................................3-5 Select the Target Model.........................................................3-7 Save a Project.........................................................................3-8 Exercise - Create a New Project ..........................................3-10 Backup a Project ..................................................................3-15 Exercise - Export a Project ..................................................3-16 Delete Projects .....................................................................3-17 Exercise - Delete a Project...................................................3-18 Restore a Project ..................................................................3-19 Exercise - Import a Project ..................................................3-20 Project Validation ................................................................3-21 Exercise - Validate the Project.............................................3-23 Project Simulation................................................................3-24 Exercise - Start the Simulation ............................................3-25

The Navigator
Navigator The Navigator allows the contents of a Vijeo Designer project to be displayed. The project can be displayed in two different ways: Vijeo-Manager Project

3-2

Version 5.1

September 2010

The Vijeo Manager


Project Management The Vijeo-Manager has several different uses. It may be used to: Start a new project Select an existing project for editing Backup an existing project project must be closed first project must be closed first Export a project

Vijeo Designer

Manual Version 1.1

3-3

Project Manager
Project Tree View The Project Manager is used to gain access all the components that make up the HMI application. It gives: The name of the project and application. A project can have several applications, including several Magelis terminals. The list of graphic panels The popup windows and panels Environment - external data files, security configuration and languages The alarm groups and categories The resource library for new objects (message display, meter, bargraph and selector) Alarm group configuration The recipe group configuration Data logging group configuration Variable creation or importing The I/O manager configuration

3-4

Version 5.1

September 2010

New Projects
First Step in the Configuration The first step when configuring Vijeo Designer is to create a new project. The project is where all information is stored. Whenever a project is created, the default name Project is generated. If the default is kept but a previous project exists with the same name, a confirmation message will allow the user to replace the previous project with the new one. Alternatively, the new project may be given a new name when it is created. When naming the project, its name must be unique within Vijeo-Manager.

Note:
The project name is restricted to 32 characters, and may contain any alpha-numeric characters and underscores [ _ ]. The underscore character may not be the initial character and spaces may not be used. How to Create a New Project

To create a new project:


Open Vijeo Designer then click the New Project or Right click the Vijeo-Manager icon in the Navigator and select New Project or Select the menu File New Project button.

Vijeo Designer

Manual Version 1.1

3-5

New Projects (cont.)


How to Name the Project

To name a Vijeo Designer project:


Open the Create New Project dialog then add a name to the Project Name field. Then identify the Type of project Single target Multiple target

Note: Multiple Target Multiple configurations may be filed under a single project

name. Each target (XBTGX) is configured independently.

3-6

Version 5.1

September 2010

Select the Target Model


Target Model

Target Model - From this screen, you must name the target and identify the model

of the XBTGT/GK/GTW or iPC to be programmed.

Note:

The model selected simply sets the working area of the Graphic Editor and can be changed easily at a later stage if needed.

Vijeo Designer

Manual Version 1.1

3-7

Save a Project
Default Location Vijeo Designer projects are saved in the default location
C:\documents and settings\All Users\Documents\Vijeo Designer\

This location is defined during the product installation and may be changed during the installation process. All saved projects are visible in the Vijeo-Manager tab.

3-8

Version 5.1

September 2010

Save a Project (cont.)


How to Save a Project

To save a Vijeo Designer project:


Click the Save button on the main toolbar or Select File Save Project from the main menu or Click the Save button on the Navigator toolbar in the Project tab or Right click the Project Name in the Project tab and select Save from the menu.

Vijeo Designer

Manual Version 1.1

3-9

Exercise - Create a New Project


1 Create a New Project. i. Create a new folder on the computer named C:\Class. Your instructor will give you files to copy into this folder. These files will be used at various points in the course. Launch Vijeo Designer. Right click the Vijeo Manager. icon inside the Select New Project.

ii.

iii.

Name the project Schneider Soup. Leave the rest of the fields with the default settings then click Next to continue.

3-10

Version 5.1

September 2010

Exercise - Create a New Project (cont.)


iv. Select XBTGT model 6340 and name the target Factory. Click Next to continue.

v.

This dialog sets the target IP Address. The first part of this course will run the project in simulation mode. Therefore, change nothing on this screen and click Next to continue.

Vijeo Designer

Manual Version 1.1

3-11

Exercise - Create a New Project (cont.)


vi. Click the Add button to open the New Driver dialog. Select a Schneider Electric Modbus TCPIP Communications driver and Modbus Equipment for the PLC. The IP address will be added at the end of this exercise. Click OK.

vii.

The final screen displays the driver and the equipment that has been added in the list. Click Finish to close the Create New Project wizard.

3-12

Version 5.1

September 2010

Exercise - Create a New Project (cont.)


viii. When the wizard closes examine the Navigator. The project Schneider Soup will be visible in the Vijeo-Manager tab and the contents of the project will be visible in the Project tab.

Configure the PLC Connection. i. Expand the project in the Navigator until the communications driver is visible under the IO Manager node. Select ModbusEquipment01 in the Navigator and change the name to PLC200 in the Inspector.

ii.

Double click the PLC200 connection to open the Equipment Configuration dialog.

Vijeo Designer

Manual Version 1.1

3-13

Exercise - Create a New Project (cont.)


iii. There are two different configurations depending on the PLC type. Identify whether the PLC is Premium or Quantum based and enter the settings below.

Field
IP Address IEC 61131 Syntax Addressing Mode Double Word word order

Premium
192.168.1.200

Quantum
192.168.1.200

0-based (Default) High word first

1-based (Unity Quantum) Low word first

Save the project. i. Vijeo Designer projects are saved in the default location My Documents All Users Vijeo Designer. All saved projects are visible in the Vijeo Manager tab in the Navigator.

3-14

Version 5.1

September 2010

Backup a Project
Export Projects Vijeo Designer projects may be backed up by exporting them as compressed files (VDZ file). Exporting projects is useful for writing to removable media such as a flash drive, for sending by email, or copying to another computer over the network

Note:

Before an export can take place, the project must first be closed

How to Export a Project

To export a Vijeo Designer project:


Select the project in the Vijeo-Manager then: Select File Import/Export Export Project... from the main menu or Right click the project in the Vijeo-Manager and select Export Project... from the menu

Vijeo Designer

Manual Version 1.1

3-15

Exercise - Export a Project


1 Export the Schneider Soup project. i. ii. iii. Return to the Schneider Soup project and Save the project. Select File Close Project from the main menu. Right click the Schneider Soup project in the Vijeo-Manager and select Export Project... from the menu.

iv.

The default location for exported projects is:

C:\Program Files\Schneider Electric\Vijeo-Designer\Vijeo-Frame\Backup Save the Schneider Soup project in this location.
v. When the project export is successful this dialog will be displayed. Click OK.

3-16

Version 5.1

September 2010

Delete Projects
How to Delete a Project

To delete a project:
Select Edit Delete from the main menu or Click the Delete button on the main toolbar or Right click the Project in the Vijeo-Manager and select Delete... from the menu.

Note:

Before a project can be deleted, the project must first be closed

Vijeo Designer

Manual Version 1.1

3-17

Exercise - Delete a Project


1 Delete the Schneider Soup project. i. ii. Ensure that the project is closed as projects may not be deleted if they are the active project. Right click the project in the Vijeo-Manager and select Delete... from the menu.

This warning message will appear. Click Yes.

3-18

Version 5.1

September 2010

Restore a Project
How to Import a Project Exported projects may be restored by importing the compressed project files in VDZ format.

To restore a previously backed up project:


Right click the level in the Vijeo-Manager where the project will be restored, then: Select File Import/Export Import Project... from the main menu or Right click the project in the Vijeo-Manager and select Import Project... from the menu The example shows a project that will be restored to the root directory.

Vijeo Designer

Manual Version 1.1

3-19

Exercise - Import a Project


1 Import the previously exported Schneider Soup project. i. Right click the Vijeo-Manager icon in the Vijeo-Manager tab. Select Import Project... from the menu.

ii. iii.

Select the Schneider Soup.vdz file from the backup folder. This message will appear when the import is successful. Click OK.

Double click the Schneider Soup icon in the Vijeo-Manager to reopen the project.

3-20

Version 5.1

September 2010

Project Validation
Validation Validation checks the project for errors. Validation automatically takes place when a project is downloaded to the target or download to the simulator. It is quicker to validate as a separate operation, rather then as part of a download. In either case any errors that are detected must be fixed and have a red background. Yellow errors should be fixed but are not fatal.

How to Validate a Project

To Validate a project:
Select the target then select Build Validate Target from the main menu or Select the target and click the Validate Target or Right click the target and select Validate... from the menu button on the Navigator toolbar

Vijeo Designer

Manual Version 1.1

3-21

Project Validation (cont.)


Feedback Zone The Feedback Zone displays system generated messages when the project is Validated, Downloaded or Simulated. Red Errors must be fixed Double-click errors to navigate to the problem

3-22

Version 5.1

September 2010

Exercise - Validate the Project


1 Validate the Schneider Soup project. i. Right click the target Factory and select Validate... from the menu.

ii.

Examine the Feedback Zone. Some warnings will be displayed in yellow because the default panel has no objects. Objects will be added to this panel in a later exercise.

Save the project.

Vijeo Designer

Manual Version 1.1

3-23

Project Simulation
Simulation There are two choices for simulation.
Start Simulation Option (first option) - Vijeo Designer can connect to the configured PLC if it is reachable by the configuring computer. This can be a real PLC or a PLC program running in the Unity Pro or Concept simulators. This in effect allows you to connect Vijeo Designer to a virtual soft PLC. To do this, select the first start simulation option. Start Device Simulation option - This option connects the application to a

simulator that generates random numbers and drives the animated graphics. This allows developers to see how the graphics will appear but is not interactive like the first option. How to Start the Simulation

To start the simulation:


Select the target then select Build Simulation from the main menu or Select the target then click the Simulate or Right click the target and select Start Simulation (Build) from the menu button on the Navigator toolbar

3-24

Version 5.1

September 2010

Exercise - Start the Simulation


1 Start the simulation i. Right click the target Factory and select Start Simulation (Build) from the menu.

ii. iii. 2

The Vijeo Designer Runtime screen will start and display a black screen as this is the default Panel that is created with a new project. Click the Close button on the runtime window.

Save the project.

Vijeo Designer

Manual Version 1.1

3-25

Chapter 4: Overview
Introduction

Vijeo Designer Variables

Variables are symbolic names for Magelis memory locations. Variables are also often called "tags." Vijeo Designer has both Internal and External variables Internal Variables inside the Magelis only. address A name only, no physical

External Variables connected to an external device (i.e., PLC). In Vijeo Designer, a great deal of configuration is done at the variable level. Some examples of this are: Assign variables to a logging group Input Limits - limit operator inputs Alarm definitions, variable scaling and persistence

This Chapter Covers These Topics: Variables ................................................................................4-2 Variable Editor .......................................................................4-5 Variable Addressing...............................................................4-9 Variable Logging Groups.....................................................4-11 Variable Properties - Input Range........................................4-12 Block Variables....................................................................4-13 Variable Folders ...................................................................4-14 System Variables..................................................................4-15 Variable Arrays ....................................................................4-16 Reference Variables .............................................................4-18 Reference Variable Solution ................................................4-21 Scan Groups .........................................................................4-22 Importing PLC Variables (Linking).....................................4-24 Updating a Variable Link.....................................................4-26 XML Support for Variables .................................................4-27 Exercise - Import PLC Variables .........................................4-29

Variables
What is a Variable? Variables exist in most, if not all, programming languages. A variable is a symbol or a name that represents a value. Consider this algebraic expression: z=x+y The letters x, y and z are variables. The right side of the equation is evaluated and then assigned to the left side. Substitute these values, x=3 y=5 when the values are substituted the expression can be evaluated so that z=8 Variables in programming work the same way. Variables are names given to represent the data.

4-2

Version 5.1

September 2010

Variables (cont.)
Variable Names Each Variable is defined with a unique name, a data type, an address and are associated with an I/O Device. Variable Tags convert complicated I/O Device registers into names that are easier for we poor humans to understand. Data coming in from field devices is stored in the I/O Device in registers. The way this works is similar to the way books are stored in a bookshelf.

However, the I/O Device registers are like the Dewey Decimal system used in libraries. They use addresses that are not very user friendly.

Address
%MW10 %MW14 %M2 %M3

Data
25.4 705.6 0 1

In a library it is made easier because books have titles that are easier for us to understand and remember. Vijeo Designer is able to take those addresses and give them nice easy names. It works the same way that Internet addresses such as 203.19.132.2 that are hard to remember can be converted to domain names such as www.schneider-electric.com.

Tag Name
Water_Temp Water_Level Water_Valve Water_Pump

Address
%MW10 %MW14 %M2 %M3

Data
25.4 705.6 0 1

Vijeo Designer

Manual Version 1.1

4-3

Variables (cont.)
Data Types Variables are also given a Data Type. When variables are created some memory space is reserved for those variables. The variables sit together in memory like those books on the library bookshelf. Unless enough memory space is reserved when the variable is created, there may not be enough room to place the value into the variable when it is assigned. This would be like trying to fit a book that is too big into a small gap between the other books. The data types commonly used in Vijeo Designer are listed in the table below.

Type
BOOL INT DINT UINT UDINT REAL STRING

Designation
Boolean Integer Double integer Unsigned integer Unsigned double integer Real String

Format (bits)
8 16 32 16 32

2 to 100 characters

See Also:

For further information about Variable Data Types, see Vijeo Designer Help Setting Up Variables.

4-4

Version 5.1

September 2010

Variable Editor
Variable Editor The Variable Editor displays variables in a spreadsheet format, displaying the variables name, data type, data source, scan group, device address, alarm group, and logging group. Information may be updated directly in the spreadsheet.

Vijeo Designer

Manual Version 1.1

4-5

Variable Editor (cont.)


How to Create Variables Manually

To create a variable in a project manually:


Right click Variables in the Navigator. Select New Variable then the Variable Type from the menu.

Select from these types:

Type
Discrete Integer Float String Folder Block Variables

Description
Digital, ON/OFF Numbers without decimals points Real numbers Text data Folders store multiple variables of different data types A block of external variables of type Integer, UINT, DINT, REAL. Used mainly by recipes

4-6

Version 5.1

September 2010

Variable Editor (cont.)


How to Create Variables Manually (cont.) or Double click Variables in the Navigator to open the Variable Editor then click the
New Variable

button. The New Variable dialog will then open.

Vijeo Designer

Manual Version 1.1

4-7

Variable Editor (cont.)


How to Create Variables Manually (cont.) or Click the down arrow on the New Variable select the Variable Type from the menu. button to open the menu then

The new variable will be displayed in the Variable Editor.

4-8

Version 5.1

September 2010

Variable Addressing
How to Set Direct Addressing If equipment is to communicate with a target machine, it is necessary to set up a device driver and specify device addresses. Follow the steps below to set up device addresses in the target machine.

To set up a variable with direct addressing:


Select or create a new variable in the Variable Editor.

The variable may be edited by using the Variable Properties dialog or the
Property Inspector.

Set the source to External then click the Ellipsis Address field and set the address.

button in the Device

i.

Modicon uses an offset (3)

1. 6 digit addresses are changed to 5 digit addresses by Vijeo Designer


ii.

IEC addressing (4) for all Schneider Electric platforms

Vijeo Designer

Manual Version 1.1

4-9

Variable Addressing (cont.)


Indirect Addressing When the application uses any device address within a consecutive range, you can use indirect addresses. Using indirect addresses lets you change the device address associated with a variable, at runtime, by simply changing the value of the offset. Indirect addresses comprise a base variable and an offset variable
Base Variable: A base variable is an external I/O variableits device address

defines the base address, or start point. To set up an indirect address for the base variable, select the Indirect Address checkbox. You will then need to select an offset variable.
Offset Variable: An offset variable is an internal or external integer variable. Its value defines the offset from the base variable. The offset variable determines the number of units to shift and locates the actual device address. You cannot use another base variable as the offset variable. The offset cannot be a negative value. Do not set an offset value that's so large that is forces device addresses out of range

Example Uses a starting address and an offset pointer 40001 is the start address and the value in the variable named in the indirect address field (myoffsetvar) is the offset If the value in myoffservar = 5, then the variable is connected to 40001 + 5 or 40006 if Device Address = %MW1 then variable is connected to %MW1 + 5 or
%MW6

Works the same way with IEC addressing -

Data Formats

The Variable's Data Format may be selected. Select: BIN binary BCD binary coded decimal Signed or unsigned data

4-10

Version 5.1

September 2010

Variable Logging Groups


Logging Groups Logging groups control when data is logged, where it is logged and how long to keep historical data. A maximum of 80 different logging groups. Once a logging group has been created, variables are assigned to the group and data logging is started. Multiple variables are assigned to a single group
Historical data may be viewed with a historical trend chart or may be retrieved using the data manager

Historical data is managed using a circular filing system When last file is filled, oldest file is overwritten

See Also:

For further information about Logging Groups, see the topic Data Logging (page 8-11).

Vijeo Designer

Manual Version 1.1

4-11

Variable Properties - Input Range


Input Range When the Input Range is enabled it limits the value an operator may enter into a variable. Input Range is available for variable types Integer or Float

DataScaling

DataScaling defines how PLC data is converted between a Raw PLC value and a Scaled HMI displayed result. Scaling from the HMI to the PLC is not possible this

way.

4-12

Version 5.1

September 2010

Block Variables
Block Variables
Block Variables are a special type of variable that enables faster communication

with blocks of contiguous device addresses. Block variables are mainly used in recipes, which write values to multiple device addresses in a single step. Although a block variable has access to multiple device addresses, it appears in the Variable List as a single variable and counts as 1 towards the variable count.

When working with a block variable, the variable is associated with a block of devices addresses, defined by the Start Address and number of Block Elements. Use the block address for when it is necessary to update multiple contiguous device addresses. In the following example, the target machine is set up to change the values in addresses 40101 to 40104.

Vijeo Designer

Manual Version 1.1

4-13

Variable Folders
Variable Folders
Variable Folders are used to store multiple variables. Variables may be of any data type. The use of Variable Folders improves the management of variables by creating a structure in the tag database and organising variables by machine, plant area, or other user defined categories.

Up to 200 variables may be added to a folder. However, it is not possible to create nested folders (folder inside a folder).

4-14

Version 5.1

September 2010

System Variables
System Variables System variables are special variables that provide information about the target machine or system that the user application runs on. System variables begin with the underscore character (_). For example, _Day is a system variable that holds the current date of the target machine's system clock. Some of the other system variables provide status information on an application as it runs, such as _CurPanelID, an integer variable that stores the panel ID of the currently displayed graphical panel. The Name, Source, and DataType properties of system variables are read-only. When a target is added to the project, the target's system variables are added to the Variable List. It is not possible to delete, change the name or copy system variables.

See Also:

For a complete list of System Variables, see Vijeo Designer Help - System Variables.

Vijeo Designer

Manual Version 1.1

4-15

Variable Arrays
Variable Arrays An Array is a collection of variables with the same data type and the same data source. Each variable in an array is called an element. The total number of elements in an array cannot exceed 2048. Arrays are created by adding a number in the Array Dimension field.

A five element array of type INT is created from the configured information. The variables are named MyInteger[0] MyInteger[4].

4-16

Version 5.1

September 2010

Variable Arrays (cont.)


Array Solution In this solution, one day is divided into 24 array elements, with each element representing an hour. At the end of each hour, the amount of product the manufacturer created in that hour is stored in the element. Using this array, the manufacturer can record how much product was created during each hour of the day over many days.

Arrays like this solution are highly useful because instead of making 24 individual variables to represent the hours of the day, you only need one array with 24 elements in it to represent the hours of the day.

Vijeo Designer

Manual Version 1.1

4-17

Reference Variables
Introduction The Reference variable feature allows the creation of variables that reference other variables for their value. The variable that is being referenced may be changed during run time. It is also possible to change the variable that an object is referencing at run time. This feature is particularly useful in a system where there is multiple equipment with several sets of similar data, for example, multiple compressors in one application. The panel operator can use the reference variable feature to dictate which set of data is to be controlled or viewed using an assembly of Vijeo Designer objects. With reference variables, it is not necessary to create multiple panels with similar objects for each set of data.

Source (1) data source that is copied to the target variable Target (2) receives data from one source Control (3) variable that determines which source is copied to the target

4-18

Version 5.1

September 2010

Reference Variables (cont.)


Terminology Reference Variable (Name): dynamic variable that can be used in place of a regular variable in an object, part, or action. During runtime, the reference variable can access data from multiple variables, one at a time. Reference String: defines the variables that determine the reference variable's value during run time. The reference string is determined by the format and the values of the parameter variables at runtime. The reference string becomes the name of the variable that the reference variable will use for its value. Parameter Variables: variables whose value is part of the reference string. At runtime, the parameter variable's value can be changed by the panel operator in order to access a set of variables. A reference variable can have one parameter variable one or multiple parameter variables. You can have up to three parameter variables for each reference variable.

Vijeo Designer

Manual Version 1.1

4-19

Reference Variables (cont.)


Reference String The reference string is where the name of the variable that will be referenced at runtime is built.

Enter a Unicode string that follows the syntax rules, where %s, %d, %nd, and %0nd are placeholders: %s - inserts the parameter as a string %d - inserts the parameter as a decimal number %nd or %0nd - inserts "n" (a number from 1-9) digits of a decimal number. %nd - where "n" is a constant number, for example: Temp%3d would be Temp31, Temp32, Temp33 %0nd - where "n" is an integer indicating the number of leading zeros, for example: Temp%03d would be Temp001, Temp002, Temp003, and so on.

Example In the example above, there is a reference string, VAR%dMach%s. Parameter 1 has a variable P1 and Parameter 2 has a variable S1. If P1 had a value of 2 and S1 had a value of 'A' then the reference variable would be connected to
VAR2MachA

4-20

Version 5.1

September 2010

Reference Variable Solution


Solution

i. ii.

Create an internal variable called MachineNumber. This variable will be used in a similar manner as the offset for indirect variables. Create 2 internal variables: RefProd and RefHours and enable Reference in the properties. These will be your reference variables.

1. In the properties for RefProd, you define the Reference String and the Parameters. 2. The Reference String allows you to define how you want to select variables. In this example, it is set to production%d. The value of %d is the Parameter, which in this case, is MachineNumber. So, if MachineNumber = 2, then the Reference String becomes production2.
iii. The same process is done for RefHours

1. Reference String is hours%d.

iv. v.

On a Panel, create numeric displays for MachineNumber, RefProd, and RefHours. Enable input for Machine Number When the project is run, you can change MachineNumber between 1 5. This will show the Production Rate and Running Time for the corresponding machine.

There can be a maximum of 3 parameters for a single reference string, allowing many different combinations

Vijeo Designer

Manual Version 1.1

4-21

Scan Groups
Group of External Variables A scan group is a group of external variables from a single piece of equipment that are scanned at the same rate. There are four different scan rates offered: Fast, Medium, Slow, and User-Defined. Scan groups organise communication with equipment. Variables with equipment values that are scanned at the same rate should belong to the same scan group. When a PLC and a PLC driver is added to a project, a Scan Group associated with that driver is created automatically. The figure below shows a Modbus TCPIP driver and a Scan Group named ModbusEquipment01.

4-22

Version 5.1

September 2010

Scan Groups (cont.)


Additional Scan Groups Once the equipment (PLC) has been added, additional scan groups may be added to that equipment.

Each scan group may have its own individual ScanRate (Polling Rate) that controls how often the Magelis requests an update for configured variables attached to the PLCs scan group.

The developer is then able to select from two different configured scan groups when defining the properties of the Variable.

Vijeo Designer

Manual Version 1.1

4-23

Importing PLC Variables (Linking)


How to Link Variables Vijeo Designer has the ability to link variables and variable addresses directly to a PLC file. This feature saves time not only when the system is first implemented, but also during maintenance. Whenever a change is made to the equipment configuration, Vijeo Designer can be updated with the same information.

To Link Variables to an external file:


Right click Variables and select Link Variables... from the menu

Browse for the PLC program files. Unity Export the variables in .XVM format Concept export the variables out of Concept as a .CCN file. Just change the extension from the default .TXT to .CNN

Vijeo Designer supports Unity direct addresses (%IXX, %QXX). It is possible to create a variable in a scan group and link it to Q4.1.2

4-24

Version 5.1

September 2010

Linking Variables (cont.)


How to Link Variables (cont.) Select the Variables to be linked and the Scan Group where the variables will be added.

Click Add to add the Variables to the selected Scan Group in Vijeo Designer

Vijeo Designer

Manual Version 1.1

4-25

Updating a Variable Link


How to Update a Variable Link If variables have been added to a PLC program and there is a Vijeo Designer link to the PLC program file or an exported file of PLC Variables it is possible to add new variables by updating the link.

To Update a Variable Link:


Right click the Variables node and select Update Link... from the menu. Select the Link to update - it is possible to have multiple links to different files. Click Update then click Yes to confirm the Update.

4-26

Version 5.1

September 2010

XML Support for Variables


File Types Vijeo Designer variables can be imported and exported from external files. The XML format allows all of the properties of the variables to be imported and exported.

When exporting, there are five possible file type formats:

File Type
Unicode XML (*.XML) ANSI CSV Files (*.csv) Unicode CSV Files (*.csv) ANSI TXT Files (any delimiter) (*.txt)

Description
Saves the file as an Unicode XML file Saves the file as an ANSI CSV commaseparated or semi-colon value file Saves the file as an Unicode CSV commaseparated or semi-colon value file Saves the file as an ANSI TXT file. Specify the file's field delimiter from the Field Delimiter drop-down list Saves the file as an Unicode TXT file. Specify the file's field delimiter from the Field Delimiter drop-down list

Unicode TXT Files (any delimiter) (*.txt)

Vijeo Designer

Manual Version 1.1

4-27

XML Support for Variables (cont.)


How to Export Variables

To export variables from Vijeo Designer:


Right click the Variables node in the Navigator. and select Export Variables... from the menu.

Select the desired file type in the Files of Type field and name the file.

How to Import Variables

To import variables into Vijeo Designer:


Right click the Variables node in the Navigator and select Import Variables... from the menu.

Select the File Type and browse for the exported file.

4-28

Version 5.1

September 2010

Exercise - Import PLC Variables


1 Import Variables for the project. i. Right click the Variables item and select Import Variables. You will be importing a XML file from your C:\Class folder containing most of the variables used in this project.

ii.

Change the Files of Type filter option to .XML and browse to the C:\Class folder. Select the XML file SchneiderSoup.XML.

iii.

Click Open to continue. The feedback zone will indicate the success of the import.

iv.

The variables are imported into the default Scan Group.

v.

Change the folder name to External as shown.

Save and validate the project.

Vijeo Designer

Manual Version 1.1

4-29

4-30

Version 5.1

September 2010

Chapter 5: Overview
Introduction

Graphics

The graphical panels are one of the principle components of a Vijeo Designer project. They are the interface for plant operators, and can be designed to display data as well as to accept operator input. Graphical panels are comprised of a master panel, the objects drawn on the page, as well as properties specific to the page.

This Chapter Covers These Topics: Graphic Panels .......................................................................5-2 Graphical Editor.....................................................................5-5 The Property Inspector...........................................................5-6 Exercise - Create a Master Panel ...........................................5-7 Graphical Objects Toolbar.....................................................5-9 Draw Basic Objects .............................................................5-11 Exercise - Add an Image to the Master Panel......................5-12 Time and Date Display ........................................................5-13 Exercise - Add Time and Date Objects ...............................5-15 Color Picker Tool.................................................................5-18 Base Panels ..........................................................................5-19 Exercise - Create Base Panels..............................................5-20 Panel Text ............................................................................5-24 Exercise - Add Text Objects to a Panel ...............................5-25 Navigation Introduction.......................................................5-27 Panel Navigation..................................................................5-28 Exercise - Add Switches to a Panel .....................................5-30 Add Clipart to a Panel..........................................................5-36 Exercise - Add Clipart to the Process Panel ........................5-39 Rectangles, Squares, Ellipses and Circles ...........................5-41 Lines, Polylines and Polygons .............................................5-43 Exercise - Add Circles and Lines to the Process Panel .......5-46

Graphic Panels
Panel Types

The Graphical Panels node in the Navigator window provides the following types of panels:
Base Panels
When a project is created, Vijeo Designer automatically creates a panel in the Base Panels folder under the Graphical Panels node in the Navigator window. A panel is the canvas the developer uses to draw objects and place Toolchest parts. Switches and lamps can be placed, or other objects can be drawn on a base panel. The panel that is created becomes the display screen on terminals Master panels are panel templates that can be applied to any base panel in the project. On a master panel, developers can draw objects and place Toolchest parts, to create a panel of common objects that can be used for all base panels in a project. Popup windows are used frequently to provide detailed information about something being shown on the main panel. At Runtime, operators can open the popup window panel over the current panel using a variety of methods.

Master Panels

Popup Window Panels

Thumbnail View

The thumbnail view toolbar allows developers to: Display the current path in the base panel folder. Change the thumbnail size to large or small. Move up one folder level, if you have a folder structure.

5-2

Version 5.1

September 2010

Graphic Panels (cont.)


Master Panels
Master Panels are panel templates that can be applied to any Base Panel in the

project. On a Master Panel, developers can draw objects or place Toolchest parts, to create a panel of common objects that can be used for all base panels in a project. Master panels also store information about the common objects, such as font styles and background design. All objects on a Master Panel are displayed on the Base Panels that use the Master Panel.

Master panels are like templates Create template objects (Master Panel) that may be added to a Base Panel Not a complete panel by itself

Changes made on the Master Panel are applied to all Base Panels that use the Master Panel.

Vijeo Designer

Manual Version 1.1

5-3

Graphic Panels (cont.)


Master Panel Layers It is possible to add together multiple Master Panel objects on a single base panel as long as objects on each do not physically overlap. This concept is called Master Panel Layers and it is possible to use up to eight master panels layers. Master panels may be organised in a folder structure. It is recommended that a master panel folder be created to organise a group of master panels.

Panel Folders

How to Move a Master Panel

To move a Master panel:


You can use the cut/paste or drag/drop method to move a master panel under the Base Panel node or into a base panel folder, or from one Master Panels folder to another. When you move a master panel under the base panel node or into a base panel folder, the master panel becomes a base panel.

5-4

Version 5.1

September 2010

Graphical Editor
Graphical Editor The Graphical Editor allows developers to: Develop or edit graphical panels Develop or edit Popup panels Windows may be resized as desired List of current project panels appears in list under heading Graphical Panels in the Navigator

Once a panel has been created, it can be edited by double clicking the panel in the Navigator. The Graphical Editor is the working area that contains the panel being created or edited.

Vijeo Designer

Manual Version 1.1

5-5

The Property Inspector


Property Inspector The Property Inspector - When a screen object is selected, the Property Inspector displays all the properties of the selected object in the Property Inspector window.

The Property Inspector: Displays the name of the selected object Displays the size of the object Displays the properties of the selected object in the Graphics Editor Properties for the object are edited here May be positioned, opened or closed as needed

5-6

Version 5.1

September 2010

Exercise - Create a Master Panel


1 Create a new Master Panel. i. From the Navigator, right click Master Panel and select New Panel. A new panel will open in the Graphical Editor.

ii.

Go to the Property Inspector and click the black rectangle in the Back Color property.

Vijeo Designer

Manual Version 1.1

5-7

Exercise - Create a Master Panel (cont.)


iii. A standard color palette tool will open. property to white. Change the Back Color

Note:

The background colour of a Master Panel does not matter since it will become an "overlay" of the Base Panel that uses it.

Save the project.

5-8

Version 5.1

September 2010

Graphical Objects Toolbar


Graphic Objects (Left) The Graphical Objects toolbar contains the tools necessary to draw or select objects. These are the Select Object Tool and the Standard Drawing objects.

Icon

Name
Select Object Dot Line

Functionality
Selects an object on the panel Draws dots in sizes of 1,2,3 and 5 Normal Line Start Direction Line End Direction Line Bi-Direction Line Draws a straight line (without arrows) Adds an arrowhead to the end of the line Adds an arrowhead to the end of the line Adds an arrowhead to the beginning and end of the line Draws a series of connected line segments (without arrows Adds an arrowhead to the beginning of the Polyline Adds an arrowhead to the end of the Polyline Adds an arrowhead to the beginning and the end of the Polyline

Polyline

Normal Polyline Start Direction Polyline End Direction Polyline Bi-Directional Polyline

Polygon Bezier Curve Rectangle

Draws a Polygon Draws a Bezier curve Rectangle Round Rectangle Cut Cornered Rectangle Draws a rectangle or a square Draws a rectangle or a square with rounded edges Draws a rectangle with cut corners

Ellipse Arc Pie Symmetric Polygon

Draws a circle or an oval Draws an arc Draws a pie shape Symmetric Polygon Star Symmetric Polygon Draws a symmetric polygon Draws a star-shaped symmetric polygon

Vijeo Designer

Manual Version 1.1

5-9

Graphical Objects Toolbar (cont.)


Graphic Objects (Right) This side of the Graphical Objects Toolbar contains the Scale, Text, Image and animated tools

Icon

Name
Scale

Functionality
Vertical Scale Horizontal Scale Circular Scale Draws a vertical scale of horizontal lines Draws a horizontal scale of vertical lines Draws a scale in circular form

Text Image Switch Radio Lamp N-State Lamp Data Display

Inserts a text string Inserts an image file Draws a switch Draws a radio switch Draws a lamp Draws an N-State Lamp Numeric Display String Display Date Display Time Display Draws a numeric display that shows the variable value Draws a string display that shows the variable value Draws a date display that shows the date stored in the internal clock Draws a time display that shows the time stored in the internal clock Draws an object that displays a text string based on a variable value Draws an object that displays an image based on a variable value

Message

Message List Image List

Meter Bar Graph

Draws a circular graph Vertical Bar Graph Horizontal Bar Graph Draws a graph that shows data growing up or down Draws a graph that shows data growing right or left

5-10

Version 5.1

September 2010

Draw Basic Objects


How to Add an Image

To add an image to a panel:


Click the Image change to the Image button on the Graphical Objects Toolbar. The cursor will cursor.

Position the cross on the Image cursor over the top left point on the Panel where the image will be placed and click. Position the cursor over the point where the bottom right of the image will be placed and click a second time to define the area of the image.

Use the Browser to select a graphical image.

Hints & Tips To cancel any of the object cursors click the Select Object Graphics toolbar or press the ESC key. button on the

Vijeo Designer

Manual Version 1.1

5-11

Exercise - Add an Image to the Master Panel


1 Add an Image to the Master panel. i. Return to the Master Panel MasterPanel1 created in Exercise Create a Master Panel (page 5-7). Click the Image button on the Graphical Objects Toolbar.

ii. iii.

Position the cross on the Image cursor over the top left point on the Panel where the image will be placed and click. Position the cursor over the point where the bottom right of the image will be placed and click a second time to define the area of the image. When the browser opens select the image factory.jpg from your C:\class folder to that panel as shown. Position the image approximately as shown below.

iv.

Save the project.

5-12

Version 5.1

September 2010

Time and Date Display


Time and Date Display The Date and Time Display Tools allow developers to add Date and Time information to any panel. Once the object has been placed on the page it is possible to customise the display format and display attributes.

Vijeo Designer

Manual Version 1.1

5-13

Time and Date Display (cont.)


How to Add a Numeric Display Object

To add a Numeric Display object to a panel:


Click the down arrow on the Numeric Display button to open the menu then select the type of Numeric Display object to be placed on the page.

The cursor will change to one of these cursors: Numeric Display String Display Date Display Time Display Position the cross on the cursor over the top left point on the Panel where the object will be placed and click. Position the cursor over the point where the bottom right of the object will be placed and click a second time to define the area of the object.

5-14

Version 5.1

September 2010

Exercise - Add Time and Date Objects


1 Add a Date Display object to the Master panel. i. Return to the Master Panel MasterPanel1 created in Exercise Create a Master Panel (page 5-7). Click the arrow next to the Numeric Object button on the Graphical Objects Toolbar. Select Date Display from the menu.

ii.

iii.

Position the cross on the Date Display cursor over the top left point on the Panel where the object will be placed and click. Position the cursor over the point where the bottom right of the object will be placed and click a second time to define the area of the object. Position the object above the top left corner of the Factory.jpg image.

Vijeo Designer

Manual Version 1.1

5-15

Exercise - Add Time and Date Objects (cont.)


2 Configure the settings of the Date Display object. i. When the area of the object is outlined the Date Display Settings dialog will open.

ii.

Change the Format to dd/mm/yyyy and the Style to 000000.

5-16

Version 5.1

September 2010

Exercise - Add Time and Date Objects (cont.)


iii. Select the Color tab. Click the white rectangle under Text to open the color palette and change the font colour to Black. Click OK.

Add a Time Display object to the Master panel. i. Repeat the steps above to add a Time Display object above the top right corner of the Factory.jpg image.

Hints & Tips To Show and Hide the grid right click anywhere on the background of the panel and select Show Grid Line or Show Grid Dot.

Save the project.

Vijeo Designer

Manual Version 1.1

5-17

Color Picker Tool


Select a Colour from an Image Most of the time it is possible to find colours using the Standard Color Palette.

However, if a colour cannot be found in the Standard Color Palette a colour may be created by selecting a colour from an image. The Color Picker image. tool allows the user to select a colour from an existing

5-18

Version 5.1

September 2010

Base Panels
How to Create a New Base Panel The panels in a project may be created in the beginning of the development phase or created as they are needed. Master panel(s) may be used as a template when creating a new base panel.

To create a new Base Panel:


Select the Base Panels node and click the Insert New Panel Navigator toolbar or Select the Base Panels node and press the Insert key on the keyboard or Right click the Base Panels node and select New Panel or New Panel with Master... from the menu button on the

Vijeo Designer

Manual Version 1.1

5-19

Exercise - Create Base Panels


1 Create a new Base Panel. i. ii. Go to the Navigator and right click the Base Panels node. Select New Panel with Master... from the menu.

iii.

When the Style Browser opens select MasterPanel1.

5-20

Version 5.1

September 2010

Exercise - Create Base Panels (cont.)


2 Adjust the colour of the background. i. Click the black rectangle of the Back Color property in the Property Inspector to open the color palette.

ii.

Click the Color Picker.

The cursor will change to the Color Picker

tool. Click the edge of the Factory.jpg image then click OK. 3 Change the name of the base panel. i. In the Property Inspector change the name of the panel from Panel2 to Navigate.

Vijeo Designer

Manual Version 1.1

5-21

Exercise - Create Base Panels (cont.)


4 Add the Master Panel to an existing panel. i. When the project was created a panel named Panel1 was included by default. Select this Panel1 in the Navigator.

ii.

Go to the Property Inspector and click the white rectangle in the Master Panel property to open the Panel List.

iii.

Select MasterPanel1 and click OK.

iv.

Change the name of the panel to Main.

5-22

Version 5.1

September 2010

Exercise - Create Base Panels (cont.)


5 Create the panels for the project. i. Create four additional new panels but do not use the master panel for these four panels. Name these panels as shown.

Save the project.

Vijeo Designer

Manual Version 1.1

5-23

Panel Text
How to Add Text Labels Text may be added to any panel and may be either static text or animated.

To add text to a panel:


Click the Text change to the Text button on the Graphical Objects Toolbar. The cursor will cursor.

Click the top left and bottom right corners of the text box area. Type the text into the blank area then select the font and font style.

How to Add 3D Text

To add 3D Text to a panel:


Select 3D from Font Style in the Text Editor then go to the Property Inspector. Select the Text Color and the 3D Color.

5-24

Version 5.1

September 2010

Exercise - Add Text Objects to a Panel


1 Add Text Objects to the Main panel. i. Open the Main panel. This panel will be the Splash Screen for the project. Click the Text button. Add a Text object above the Date and Time Objects. When the area is defined the Text Editor will open.

ii.

iii.

Change these settings then click OK:

Property
Font Font Style Text
iv.

Value
Vijeo Modern 28x50 3D The MAIN Panel

Go to the Property Inspector and change these properties:

Property
Text Color 3D Color

Value
Blue Black

Vijeo Designer

Manual Version 1.1

5-25

Exercise - Add Text Objects to a Panel (cont.)


v. Add another Text object below the Factory.jpg image that reads Schneider Soup. Use the same property settings as above. The panel should look similar to this:

Save the project.

5-26

Version 5.1

September 2010

Navigation Introduction
Panel Navigation Basics The developer must create the navigation between all panels during the development process. When testing the application, it is possible to designate the top level panel in the configuration, i.e. the first panel that is seen upon a startup. After that, the developer is responsible for creating the rest of the navigation.

Navigation between panels must be created by the programmer Navigation between panels may be done using: A native switch Custom animation on any object (older method) Scripting

Native switches are the most common method It is good practice to create a plan for the panels, including the required navigation. In the example above, the Top level panel is shown on the left. It leads to a Navigation panel that has four navigation switches. The top switch opens a "Process" panel (shown). Other switches include an Alarm panel, a Trending panel and a path to the System Area.

Vijeo Designer

Manual Version 1.1

5-27

Panel Navigation
How to Add a Switch

To add a Switch to a panel:


Click the Switch change to the Switch button on the Graphical Objects toolbar. The cursor will cursor.

Click the cursor on the top left and bottom right corners of the area for the Switch. When this is completed the Switch Settings dialog will open.

5-28

Version 5.1

September 2010

Panel Navigation (cont.)


How to a Switch for Navigation

To create switch navigation:


When the Switch Settings dialog is open select the When Touch operation Panel. The System operation navigates to the System Area.

Browse for the target panel then click the Add > button to add the selection to the list of operations.

Vijeo Designer

Manual Version 1.1

5-29

Exercise - Add Switches to a Panel


1 Add a switch to the Main panel. i. ii. Open the main panel. Draw a Switch under the heading The MAIN Panel. Click the Switch button on the Graphical Objects toolbar. change to the Switch iii. cursor. The cursor will

Click the cursor on the top left and bottom right corners to define the size of the Switch. This will open the Switch Settings dialog.

5-30

Version 5.1

September 2010

Exercise - Add Switches to a Panel (cont.)


iv. Select the Panel option in the Operation field of the When Touch tab.

v.

button to open the Panel List. Select the Click the Ellipsis Navigate panel then click OK. Click the Add > button to add the operation to the list.

Vijeo Designer

Manual Version 1.1

5-31

Exercise - Add Switches to a Panel (cont.)


vi. Open the Color tab. Change the Fore Color to light grey.

vii.

Open the Label tab. Change the Label Type to Static. Add the text Enter into the text field.

viii.

Return to the Color tab and change the Text Color to Black. Click OK to close the dialog.

5-32

Version 5.1

September 2010

Exercise - Add Switches to a Panel (cont.)


2 Add Text and Switches to the Navigate panel. i. At the completion of this exercise the Navigate panel will look like this:

ii.

Open the page Navigate and add the page title Factory Navigation.

Vijeo Designer

Manual Version 1.1

5-33

Exercise - Add Switches to a Panel (cont.)


iii. Use the following settings for the switches:

Switch
Cookhouse Alarms Process History System Settings

Panel
Process Alarms History System Configuration (details below)

5-34

Version 5.1

September 2010

Exercise - Add Switches to a Panel (cont.)


3 Validate and test the project. i. ii. Save the project. Right click the target Factory and select Validate... from the menu.

iii.

Fix any errors that might appear in the Feedback Zone

iv.

Right click the target Factory and select Start Simulation (Build) from the menu. The project will compile, and start in a window.

v.

Test the navigation between all panels to ensure that everything functions`` correctly. Fix anything that does not work correctly.

Vijeo Designer

Manual Version 1.1

5-35

Add Clipart to a Panel


The Toolchest The Toolchest contains groups of predefined tools to be used in panel development. Whenever possible, use the native tools previously described. The toolchest also contains a large library of clipart filed under the heading
Image Library

The Tool Chest, contains a list of all tools by function (1) Expanding the list (1) displays available choices for the category selected (2) Custom tools may also be created and reused How to Open the Toolchest

To open the Toolchest:


Click the Toolchest become visible, button on the Tools toolbar. The Toolchest pane will

5-36

Version 5.1

September 2010

Add Clipart to a Panel (cont.)


How to Add Clipart

To add clipart to a panel:


Click the Toolchest button to open the Toolchest pane.

Select Image Library. Images are filed by category such as tanks and valves. Available images appear when the category is selected.
Drag and drop the image to add it to the panel then Resize image as needed

Vijeo Designer

Manual Version 1.1

5-37

Add Clipart to a Panel (cont.)


Process Panel At the end of this chapter, the Process Panel will appear as shown.

5-38

Version 5.1

September 2010

Exercise - Add Clipart to the Process Panel


1 Start the Process Panel. i. Click the Toolchest button. Right click the Favorites folder and select Import Folder... from the menu.

ii.

Navigate to the C:\Class folder and import the file Training.ztc. This will create a custom folder in the Toolchest that contains the pipes used in the Process screen. Drag and drop the pipes from the folder onto the Process panel.

iii. iv.

Add the following items to the Process Panel.

Object
Tank Water Hopper Stock Hopper ING Hopper Adjuncts Hopper Steam Valve Pump Pipes

Library
Image Library/Tanks Image Library/Food

Symbol
Tank5 Stainless Steel Hopper

Image Library/Valves Image Library/Pumps Image Library/Pipes

3-D Valve Vertical pump (down) 90 curve 3 Short pipe horizontal

Mixer

Image Library/Mixers

Mixer blade

Vijeo Designer

Manual Version 1.1

5-39

Exercise - Add Clipart to Process Panel (cont.)


2 Add text and switches to the panel. i. ii. Add text labels above the four hoppers using the same method in Exercise - Add Text Objects to a Panel (page 5-25). Add a switch above the hoppers that will return the operator to the

Navigate panel. Use the same method demonstrated in Exercise Add Switches to a Panel (page 5-30).

Hints & Tips An alternative method is to copy the Enter switch from the Main panel and paste onto the Process panel then change the attributes to suit this instance of the object.
iii. The panel should look similar to this.

Save the project.

5-40

Version 5.1

September 2010

Rectangles, Squares, Ellipses and Circles


The Rectangle Tool The Rectangle tool is used to draw rectangles and squares. These objects can be moved, resized, reshaped, brought to the front and so on, and their properties edited just like other types of objects.

To draw a rectangle:
Click the Rectangle tool.

Move the cursor to where the rectangle will start then click the mouse button. Move the cursor to the opposite corner of the rectangle then click the mouse button again.

To draw a square:
Click the Rectangle tool.

Press (and hold) the Ctrl key. Move the cursor to where the square will start then click the mouse button. Move the cursor to the opposite corner of the square then click the mouse button again.

Vijeo Designer

Manual Version 1.1

5-41

Rectangles, Squares, Ellipses and Circles (cont.)


The Ellipse Tool The Ellipse tool is used to draw ellipses, circles, arcs, and pie-slices. Like the Rectangle tool the Ellipse tool can be moved, resized, reshaped, brought to the front and so on, and their properties edited just like other types of objects.

To draw an ellipse:
Click the Ellipse tool.

Move the cursor to a corner of the bounding rectangle (marquee) and click the mouse button. Move the cursor to the opposite corner of the bounding rectangle then click the mouse button again.

To draw a circle:
Click the Ellipse tool.

Press (and hold) the Ctrl key. Move the cursor to a corner of the bounding rectangle (marquee) and click the mouse button. Move the cursor to the opposite corner of the bounding rectangle then click the mouse button again.

5-42

Version 5.1

September 2010

Lines, Polylines and Polygons


The Line Tool The Line is one of the simplest objects to draw. The method to draw as line is the same as most graphic programs.

To draw a line:
Click the Line button. The cursor will change to the Line cursor.

Click the panel background and move the cursor to the location of the desired end point then click again.

Lines with different arrow heads may be chosen from the Line Button menu.

The properties of the Line may be changed in the Property Inspector.

Vijeo Designer

Manual Version 1.1

5-43

Lines, Polylines and Polygons (cont.)


The Polyline Tool

To draw a polyline:
Click the Polyline cursor. button. The cursor will change to the Polyline

Click the panel background and move the cursor to the location of the desired nodes and click for each node. To terminate the polyline click the right mouse button

The Polygon Tool

To draw a polygon:
Click the Polygon button. The cursor will change to the Polygon cursor.

Click the panel background and move the cursor to the location of the desired nodes and click for each node. To terminate the polygon click the right mouse button.

Unlike the polyline, where the shape is complete at the point of the final node, a polygon will close the shape by drawing a line between the final node and the first node.

5-44

Version 5.1

September 2010

Lines, Polylines and Polygons (cont.)


Node Editing Nodes may be moved and edited after the shape has been completed.

To edit nodes:
Select the shape by clicking once then click again to enter edit mode. When the cursor hovers over one of the nodes it will change shape to a Crosshair cursor.

When a node is selected a context sensitive menu is available when the right mouse button is clicked. This allows the user to Add and Delete nodes as well as add properties to the entire shape.

Vijeo Designer

Manual Version 1.1

5-45

Exercise - Add Circles and Lines to the Process Panel


1 Add a circles to the Process Panel. i. Add circles to the Hoppers to represent the Hopper Valves.

ii.

Add circles to the Pump and Mixer to represent their status. runtime properties will be added in a later exercise.

5-46

Version 5.1

September 2010

Exercise - Add Circles and Lines to the Process Panel (cont.)


2 Add a polyline and a polygon to the panel. i. Add a polygon to the Tank to create a cutout.

Hints & Tips Use the Arrange menu to adjust the layers of the objects so that the cutout is behind the Mixer and Mixer Status objects.
ii. Add a thick polyline to the panel to represent the Steam Pipe.

Save the project.

Vijeo Designer

Manual Version 1.1

5-47

Chapter 6: Overview
Introduction

Animation and Controls

Animations and Controls allow operators to interact with the Vijeo Designer runtime system. Animations provide the operator with feedback regarding the status of the system. Controls allow operators to input command data.

This Chapter Covers These Topics: Animation ..............................................................................6-2 Expression Editor...................................................................6-3 Numeric Displays ..................................................................6-4 Exercise - Numeric Input/Output Displays..........................6-11 Custom Shape Animation ....................................................6-14 Exercise - Animate Objects .................................................6-16 Color Resources...................................................................6-17 Exercise - Use a Color Resource .........................................6-19 Bar Graphs ...........................................................................6-22 Exercise - Add a Bar Graph.................................................6-28 Lamps...................................................................................6-29 Exercise - Add Control Switches.........................................6-30 Exercise - Add a Lamp ........................................................6-32

Animation
Runtime When the objects were placed on the Process page, they were drawn so that at runtime they would appear the same as the original image. This is fine if the objects are intended only as a static graphical representation of the plant. However, at runtime it is possible to receive dynamic information about the plant from the graphical display - this can be achieved by setting the properties of the objects and by drawing some additional objects. The following diagram shows the next stage in drawing the Process page:

6-2

Version 5.1

September 2010

Expression Editor
Link Variables to Objects The Expression Editor may be used to add variables or expressions to an object.

To use the Expression Editor:


Click the Expression Editor Expression Editor Pad. button in the Variable field to open the

Double click a variable in the window. When the variable has been selected the full address will appear in the Expression field.

Vijeo Designer

Manual Version 1.1

6-3

Numeric Displays
Output Displays The value of any variable may be displayed as a number. When the value of the variable changes, the number on the panel is updated automatically.

6-4

Version 5.1

September 2010

Numeric Displays (cont.)


How to Add a Numeric Display Output Numeric Displays simply display the value contained in the linked variable. To add a numeric display to a panel:

To add a numeric display:


Click the Numeric Display button from the Graphical Tools Toolbar.

Add the Variable to be displayed into the Variable field. Select the desired font and font attributes.

Vijeo Designer

Manual Version 1.1

6-5

Exercise - Numeric Output Displays


1 Add numeric display to the Water Hopper. i. Click the Numeric Display button and draw the outline area for the Numeric Display area over the Water Hopper.

ii.

The Numeric Display Settings dialog will open automatically.

6-6

Version 5.1

September 2010

Exercise - Numeric Output Displays (cont.)


2 Add a variable using the Expression Editor. i. Click the Expression Editor the Expression Editor Pad. button in the Variable field to open

ii.

Double click the variable Tank_H20 in the window. When the variable has been selected the full address Internal.Tank_H20 will appear in the Expression field. Click OK to continue.

Vijeo Designer

Manual Version 1.1

6-7

Exercise - Numeric Output Displays (cont.)


iii. Change the value in the Display Digits field to 4 digits.

iv. v.

Open the Color tab and change the Text colour to Black. Click OK to close the dialog. Add three more Numeric Displays for the other hoppers using these settings.

Object
Stock Hopper ING Hopper Adjuncts Hopper
vi.

Variable
External.Tank_STK External.Tank_ING External.Tank_ADJ

Display Digits
4 4 4

The Hoppers with their Numeric Displays should look like this:

6-8

Version 5.1

September 2010

Exercise - Numeric Output Displays (cont.)


3 Add numeric displays around the Tank. i. Add three additional Numeric Displays:

Object
Temp Time Tank Level
ii.

Variable
External.TMP_act External.TL External.Batch_Total

Display Digits
2 2 4

Add the text labels to the TEMP and TIME displays:

Save the project.

Vijeo Designer

Manual Version 1.1

6-9

Numeric Displays (cont.)


Input/Output Displays If a display is to have input capability, the Input Mode tab must be configured also. Enable the Input mode and the Popup Keypad to provide for operator input It is possible to specify minimum/maximum input limits that are different than the limits created on the variable linked to this object at this level

6-10

Version 5.1

September 2010

Exercise - Numeric Input/Output Displays


1

Add Input/Ouptut displays to the panel.


i. Add six Numeric Displays to the right of the Tank with associated Text Labels.

Numeric Object
Water Stock ING Adjuncts Cook Temp Cook Time
ii.

Variable
External.SP_H2O External.SP_STOCK External.SP_ING External.SP_ADJ External.SP_TEMP External.SP_TIME

Display Digits
3 3 3 3 3 3

Text Label
Water Stock ING Adjuncts Cook Temp Cook Time

Open each of the Numeric Display objects and select the Input Mode tab. Activate the fields Enable Input Mode and Display Popup Keypad. This will allow the operator to input the Setpoint for each of these tags from the Panel during runtime.

Vijeo Designer

Manual Version 1.1

6-11

Exercise - Numeric Input/Output Displays (cont.)


2 Limit the Operator Input. i. Open the Variable Editor and double click the grey box to the left of the variable SP_H20 to open the Variable Properties dialog.

ii.

Select the Data Details tab and enable the Input Range.

iii.

Add these limits for each of the variables.

Variable
External.SP_H2O External.SP_STOCK External.SP_ING External.SP_ADJ External.SP_TEMP External.SP_TIME

Min
100 10 5 20 10 5

Max
200 80 15 100 50 10

6-12

Version 5.1

September 2010

Exercise - Numeric Input/Output Displays (cont.)


3 Test the project. i. ii. iii.

Save, Validate and correct any problems.


Run the project (simulation mode) as it should be functional at this point. Open the Process panel and click one of the Input Displays. Numeric Keypad will open. The

iv.

Enter values into each of the fields. Test to see if it is possible to enter values outside the varialbe limits. Shutdown the project.

Vijeo Designer

Manual Version 1.1

6-13

Custom Shape Animation


Color Change Any closed shape may be animated to change colour based on the value of a variable. This is useful when displaying the status of a boolean tag and could represent a pump, motor valve or the ON/OFF status of any two state device. Exercise - Add Circles and Lines to the Process Panel (page 5-46) uses circles overlayed on a pipe to represent the ON/OFF status of a valve.

The Animation Properties of the object may be configured to display the status of the valve based on the value of a variable.

6-14

Version 5.1

September 2010

Custom Shape Animation (cont.)


How to Animate an Object

To Animate an object to change colour:


Draw and object then double click the object and open the Color tab. Link the object to a variable. In the example below, the shape was linked to an Integer variable and this allows the object to have multiple color changes, based on the value contained in the variable

Vijeo Designer

Manual Version 1.1

6-15

Exercise - Animate Objects


1 Add colour animations to the valves. i. ii. iii. iv. v. Double click the circle below the Water Hopper that represents the

Water Valve.
Change the value in the Mode: field to Free Form. Activate the Enable Fore Color Animation option. Add the variable External.H20_ACT. Use the default colours OFF = RED, ON = GREEN then click OK.

vi.

Use the same animation settings for the other Hopper Valves and add these variables:

Valve
Stock Valve ING Valve Adjuncts Valve

Variable
External.STK_ATV External.ING_ATV External.ADJ_ATV

Save and Validate the project.

6-16

Version 5.1

September 2010

Color Resources
Color Attributes Color resources may be used to identify a set of color attributes that may be applied to various animation objects A color attribute has a name and stores the attributes that are identified for the color resource.
ColorResource001 has been set up to identify attributes for all possible animation

objects.

After the Color Resource has been created the Graphical Editor will display the available programmable attributes for the selected items.

Vijeo Designer

Manual Version 1.1

6-17

Color Resources (cont.)


How to Create a Color Resource

To create a Color Resource:


Select the Color node in the Resource Library and press Insert on the keyboard or Right click the Color node and select New Resource... from the menu.

After the Color Resource has been created it may be applied to an Animation object.

6-18

Version 5.1

September 2010

Exercise - Use a Color Resource


1 Create a Color Resource. i. Expand the Resource Library node in the Navigator. Right click the Color node and select New Resource... from the menu.

ii.

Name the new Color Resource Process. Change the No. of States field to 2 and select only the Color Animation option. Click OK.

iii.

When the Color resource is selected in the Navigator the Graphical Editor displays all the configured Color Resources. Change the OFF color to Red and the ON color to Green.

Vijeo Designer

Manual Version 1.1

6-19

Exercise - Use a Color Resource (cont.)


2 Use the Color Resource in an object. i. ii. iii. Return to the process page and double click the Steam Pipe (thick line) to open the object properties dialog. Activate the Enable Color Animation field and use the variable External.HEAT. Use the drop down list in the Color Resource field to select the

Process Color Resource.

6-20

Version 5.1

September 2010

Exercise - Use a Color Resource (cont.)


iv. Animate the circles that represent the Pump and the Mixer status:

Object
Pump Circle Mixer Circle

Variable
External.PMP External.MIXR

Save and validate the project.

Vijeo Designer

Manual Version 1.1

6-21

Bar Graphs
Bar Graph A Bar Graph is a rectangular scale with fill animation. A Bar Graph links to a variable or an expression. When the value of the variable or expression increases or decreases, the size of the Indicator increases or decreases along with the changing value. The Bar Graph's scale and labels enable the user to measure the length of the Indicator and identify the current value of the variable or the expression that is linked to the Bar Graph. Bar Graphs are vertical or horizontal:
Bar Graphs may be added to a panel several different ways. They may come from the Native Toolbar, the Toolchest or a custom Bar Graph may be created using

drawn objects.

6-22

Version 5.1

September 2010

Bar Graphs (cont.)


Bar Graph Color The Bar Graph Color Tab is used to set plate style attributes as well as colors for this Bar Graph. A Color Resource may also be used if one has been created previously.

Hints & Tips For further information on this tab and any dialog in Vijeo Designer click the Help button to go to the relevant Help article.

Vijeo Designer

Manual Version 1.1

6-23

Bar Graphs (cont.)


How to Add a Bar Graph Native Tools

To add a Bar Graph using Native Tools:


Click the down arrow on the Bar Graph button to open the menu then select the type of Bar Graph object to be placed on the page.

The cursor will change to one of these cursors: Vertical Bar Graph Horizontal Bar Graph

6-24

Version 5.1

September 2010

Bar Graphs (cont.)


How to Add a Bar Graph Native Tools Position the cross on the cursor over the top left point on the Panel where the object will be placed and click. Position the cursor over the point where the bottom right of the object will be placed and click a second time to define the area of the object.

Add attributes to the Bar Graph Settings.

Vijeo Designer

Manual Version 1.1

6-25

Bar Graphs (cont.)


How to Add a Bar Graph Toolchest

To add a Bar Graph from the Toolchest:


Click the Toolchest button to open the Toolchest pane.

Select Graph. Graphs are filed by category such as BarGraph and TrendGraph. Available graphs appear when the category is selected.

Drag and drop the Bar Graph to add it to the panel then Resize image as needed.

6-26

Version 5.1

September 2010

Bar Graphs (cont.)


How to Add a Bar Graph Custom Any closed shape can be animated into a Bar Graph.

To animate a shape as a Bar Graph:


Draw a shape then double click the shape to open the Animation Properties dialog. Open the Fill tab and activate the one or both of the Enable Fill Animation fields. Add a variable and scaling properties.

Vijeo Designer

Manual Version 1.1

6-27

Exercise - Add a Bar Graph


1 Animate the tank Bar Graph. i. ii. Double click the Tank cutout to open the Animation Properties. Open the Fill tab. Add these values:

Property
Enable Vertical Fill Animation Variable Value Range

Value
External.Batch_Total From: To: 0 200

Back Area Color

Black

Save and validate the project.

6-28

Version 5.1

September 2010

Lamps
Lamps There are two types of lamps available in Vijeo Designer. Regular and N-State lamps. Regular lamps are used to display the status of a boolean variable. NState lamps have many more options, including multiple colors and multiple control possibilities.

See Also:

For further information about Lamps, see Vijeo Designer Help - Creating Lamps. How to Add a Lamp

To add a lamp to a panel:


Click the Lamp button on the Graphical toolbar or Click the down arrow next to the Lamp button and select from the Lamp menu

Draw the lamp on the panel and add the Settings.

Vijeo Designer

Manual Version 1.1

6-29

Exercise - Add Control Switches


1 Add Switches to Control the Process. i. ii. iii. Add a switch below the Cook Time text label. The PLC program is looking for a low to high transition on all the switches from the HMI. Change the Operation to Momentary ON. Add the variable External.Start in the Destination field then click the

Add > button.

iv. v.

Open the Label tab. Change the Label Type to Static then enter the text Start in the Label window. Click OK. Open the Color tab and change the Text Color to Black and the Fore Color to Grey.

6-30

Version 5.1

September 2010

Exercise - Add Control Switches (cont.)


vi. Add another two switches below the Start switch. settings: Use these

Operation
Momentary ON Momentary ON

Destination
External.stop External.reset

Text Color Fore Color Label


Black Black Grey White Stop Reset

Run the program. i. ii. Save, Validate and fix any problems.

Run the project (simulation mode) as it should be functional at this point.

Note:

Values must be entered in all input fields or the PLC program will not allow the program to start

Vijeo Designer

Manual Version 1.1

6-31

Exercise - Add a Lamp


1 Add a Lamp to the Process Panel. i. Click the Lamp button on the Graphical toolbar and draw a Lamp on the page above the Water Numeric Object.

ii.

Add these properties to the Lamp Settings.

Property
Variable Category Style

Value
External.Running Bitmap 10054

6-32

Version 5.1

September 2010

Chapter 7: Overview
Introduction

Popup Panels and Meters

This chapter discuses the configuration and operation of popup panels and analog meters

This Chapter Covers These Topics: Popup Panels..........................................................................7-2 Popup Windows, Groups and Panels.....................................7-3 Exercise - Create a Popup Panel ............................................7-5 Creating a Popup Panel..........................................................7-6 Meters ....................................................................................7-8 Exercise - Popup Panels and Meters....................................7-12 Launching a Popup Panel ....................................................7-13 Exercise - Launch a Popup Panel ........................................7-14

Popup Panels
Popup Panels A popup panel opens over the current panel. If a popup panel is used for keypad input, it can be opened when necessary and closed when the input is complete. Popup panel can be opened or closed by using a switch, Touch animation, or script.
Popup Panels are:

A reduced size panel Used to provide details about a portion of the project Configured in the same manner as a full size panel Popup panels are filed in a different location

7-2

Version 5.1

September 2010

Popup Windows, Groups and Panels


Popup Details When a project is created, a popup window folder is generated automatically. Designers can create multiple popup window groups and popup window panels in the folder. A window is a "frame" that holds the popup panel. It is possible to vary the panel displayed in a single window via programming or using switches
Popup windows are composed of three components: Folders, groups, and panels.

Component
Popup Window Folder

Description
This node is automatically generated when a project is created. Popup window groups and popup window panels can be created in this folder. This folder cannot be copied, deleted, or renamed.

Popup Window Group

Multiple popup window panels can be added to a group. When the popup window is opened the panel can be changed as long as the panel belongs to the same group. Specify popup window properties, such as window size and display mode, in this node

The popup window group is displayed in the format Group number:

Group name, for example, 1: Window1.


Popup Window Panel Create one or more popup window panels within a group. The display of specific popup window panels can be defined within that group.

The popup window panel is displayed in the format Panel Number:

Panel Name, for example, 10001: Panel4.

Vijeo Designer

Manual Version 1.1

7-3

Popup Windows, Groups and Panels (cont.)


How to Create a Popup Panel

To create a Popup Window:


Select the Popup Windows node in the Navigator and press Insert on the keyboard or Right click the Popup Windows node in the Navigator and select New Popup Window from the menu.

To create a Popup Panel:


Select a Popup Window and press Insert on the keyboard or Right click the Popup Window and select New Panel from the menu

7-4

Version 5.1

September 2010

Exercise - Create a Popup Panel


1 Create a Popup Window. i. Right click the Popup Windows node in the Navigator and select New Popup Window.

ii.

A new Panel is created automatically. Right click the panel and select Rename Panel from the menu. Name the Panel Pop1.

Vijeo Designer

Manual Version 1.1

7-5

Creating a Popup Panel


Designing a Popup The Graphical Editor is used to design the Popup Panel.

The Inspector is used to set the different parameters. Some of these are set in the Properties of the Window and some are set in the Properties of the Panel.

Example The size of the Panel is set in the selected Window.

Other attributes such as the Color are set in the selected Panel.

7-6

Version 5.1

September 2010

Creating a Popup Panel (cont.)


Mode There are two Modes of Operation that are set in the Mode parameter: Panel Only used for one specific display only. Does not remain open if the operator changes panels.

Persistent If the operator changes panels whilst the popup is open, it remains open.Popup Panels have two Display Modes.

Lockout Base Panel

Select Enabled to deactivate the rest of the panel when a popup window displays. This feature provides security from accidental touches on the base panel. The rest of the panel is locked out until the popup window closes. If a system keypad is enabled for the popup window, the keypad will display on top of the popup window until the input operation is completed. Select Disabled to keep the rest of the screen active when a popup window displays in Runtime.

Vijeo Designer

Manual Version 1.1

7-7

Meters
How to Add a Meter to a Panel

To add a Meter to a panel:


Click the Meter
Meter

button on the Graphical toolbar. The cursor will change to the

cursor.

Click the cursor on the top left and bottom right corners of the area for the Meter. When this is completed the Meter Settings dialog will open. The General tab allow the designer to set specific attributes such as: The degrees or rotation for the meter's needle Link the variable Configure the scaling

7-8

Version 5.1

September 2010

Meters (cont.)
How to Set Color Attributes

To select the attributes of the meter:


Select the Indicator Style to determine the shape of the needle. Indicator colors can be set manually or by using a color resource. Different colors for the Thresholds may be set in this window

Vijeo Designer

Manual Version 1.1

7-9

Meters (cont.)
How to Configure the Meter Label

To configure the Label Tab options:


This tab is used to configure the Scale on the meter.

Number of labels - 6 vs 3 shown. The right meter has 6 labels

7-10

Version 5.1

September 2010

Meters (cont.)
Numeric Display The Numeric Display tab (1) creates a digital output field below the needle on a meter.

Vijeo Designer

Manual Version 1.1

7-11

Exercise - Popup Panels and Meters


1 Add two Native analog meters and a native switch to this popup panel. iii. Click the Meter button on the Graphical toolbar and draw two meters on the page.

iv.

The left meter is linked to the variable External.SP_TEMP and the right meter is linked to External.TMP_act. Scale both meters as shown.

Save and validate the project.

7-12

Version 5.1

September 2010

Launching a Popup Panel


How to Launch a Popup Panel

To launch a popup panel using a switch:


Add a Switch to the Base Panel Select Popup for the Operation and Open Popup for the command. Close Popup is another possible operation for a switch placed on the Popup itself to close the Popup. Select the Panel Name to be opened The Location parameter is used to define the position of the Popup when it opens. The At Position defines the offset in Pixels from upper left corner of the screen where the popup opens. Centered positions the Popup in the middle of the screen.

Vijeo Designer

Manual Version 1.1

7-13

Exercise - Launch a Popup Panel


1 Add an invisible switch to the process panel. i. Open the process panel and add a switch. Define the area of the switch so that it covers the cook tank. and set its property to invisible.

ii.

Add these properties to the switch:

Style
000000

Operation
Popup

Command
Open Popup

Panel Name
10001:Pop1

X
400

Y
50

7-14

Version 5.1

September 2010

Note:

The Location in this example is (400,50). When the Popup panel is tested this position may need to be adjusted.

Vijeo Designer

Manual Version 1.1

7-15

Exercise - Launch a Popup Panel (cont.)


2 Add a Close switch to the Popup panel. i. ii. Draw a new switch underneath the two meters. Add these properties to the switch:

Style
00004
iii. iv.

Operation
Close Popup

Text Color
Black

Fore Color
Gray

Label
Close

Save and close the popup panel. Save, validate and test the popup by running a batch. Specify a
temperature of 45-50 degrees (remember the scaling on the meters) Once the batch starts cooking, click the tank to open the popup and observe the meters in operation.

7-16

Version 5.1

September 2010

Chapter 8: Overview
Introduction

Trends

A visual representation of past and current activity improves understanding of the plants performance. With a trend graph, the values of a variable (or process) may be displayed in a graphical format. As these values change over time, the graph moves across the page so that the latest values are always displayed. It is possible to scroll back through historical data to display past values of the variable (or process). Historical data collection continues even when the display is not active. Switching between panels will not affect trend graphs.

This Chapter Covers These Topics: Trend Introduction .................................................................8-2 Realtime Trend Charts ...........................................................8-3 Historical Trend Charts..........................................................8-5 Block & Plot Trends ..............................................................8-7 Exercise - Build a Trend Chart Panel ....................................8-9 Data Logging .......................................................................8-11 Data Logging Groups...........................................................8-12 Data Logging Group - Variable Setting...............................8-16 Data Logging Group Buffer.................................................8-19 Exercise - Logging Groups ..................................................8-20

Trend Introduction
Trend Types It is possible to create different types of trend graphs in Vijeo Designer to graph changes in variable values. The available types are: Real-time Historical Plot Block A data sample is the value and data quality of a variable at a specific date and time and is represented on the trend graph as a data point. If there are no changes in the variable values or the values cannot be retrieved, the trend graph will not display a data point for the data sample. Trend Graphs Trend graphs take data samples from defined variables and plot them on a time graph. Each variable plotted on a graph is called a channel. A maximum of eight channels may be used on each Trend Graph.
Realtime Trend Graphs are created by using the Trend

button on the

Graphical Objects toolbar.

Historical, Plot, or Block Trend Graphs are created by using a Toolchest part in the Trend folder in the Toolchest window. For Toolchest Trend Graph parts, not

all properties will be updated dynamically in the Editor. Historical records may be saved in a file on CF or in external database.

8-2

Version 5.1

September 2010

Realtime Trend Charts


Realtime Trend Graphs The Trend Graph function is used to create a line graph that shows the current values of one or more specified variables. Trend graphs are updated at a regular interval when new data samples from the variable are added. When the data area on the graph fills up, the graph scrolls by the number of intervals that has been specified to make room for new data samples. the Interval can be configured to 1 second or more.

See Also:

For further information about Real-Time Trend Graphs, see Vijeo Designer Help Creating Real-Time Trend Graphs. How to Create a Trend Graph

To Add a Trend Graph to a Panel:


Click the Trend
Trend

button on the Graphical toolbar. The cursor will change to the

cursor.

Click the cursor on the top left and bottom right corners of the area for the Trend Graph. When this is completed a default Trend Graph will appear on the screen with the default settings in the Property Inspector.

Vijeo Designer

Manual Version 1.1

8-3

Realtime Trend Charts (cont.)


Axis Configuration The Axis Configuration settings in the Property Inspector allow developers to define limits for the data display within the graph. These include: Attributes for Axis scales Graph grid lines control Channel configuration Channel color settings Line style Line width Background color Disable unused channels Data from variable values is converted using the defined Value Range and Display Range. If values are truncated, they are rounded to the nearest decimal place.

Property
Value Range ValueRangeFrom

Description
Defines the minimum value of data stored in the variable that is assigned to the channel. If the variable data is smaller than the ValueRangeFrom value, the data will be considered equal to the ValueRangeFrom value. ValueRangeTo Defines the maximum value of data stored in the variable assigned to the channel. If the variable data is larger than the ValueRangeTo value, the data will be considered equal to the ValueRangeTo value.

DisplayRange

DisplayRangeMin DisplayRangeMax

Defines the minimum value displayed by the graph. Defines the maximum value displayed by the graph.

8-4

Version 5.1

September 2010

Historical Trend Charts


Historical Trend Graph
Historical Trend Graphs are added from the Toolchest. There are three different

Historical Trend graphs available in the Toolchest and all are configured the same way. Historical Trend Graphs are able to display a maximum of eight channels.

See Also:

For further information about Historical Trend Graphs, see Vijeo Designer Help Creating Historical Trend Graphs. How to Create a Historical Trend Graph

To add a Historical Trend Graph to a panel:


button then in the Toolchest pane open the folders Graph TrendGraph Historical Trend. Drag and drop one of the available Trend Graphs onto the panel. This is a running 3D Trend Chart. Access to historical data is via the calendar at the upper left of the graph Click the Toolchest

Vijeo Designer

Manual Version 1.1

8-5

Historical Trend Charts (cont.)


Configuration General configuration information for a Historical Trend Graph is shown on the top of the inspector. This includes Minimum and Maximum scaling for the chart. The values for all of the channels must fall within the range specified.

When configuring channels it is necessary to specify the number of channels in the NumOfChannels property. When this value is defined a corresponding number of Channel Variables will be available in the Property Inspectory. It is possible to configure each of these channels individually.

8-6

Version 5.1

September 2010

Block & Plot Trends


Block Trend A block trend graph is typically used to display high-speed data captured by the PLC. With a block trend graph, it is possible to display data for multiple data samples, collected around a point in time. A block trend graph can display up to 1024 data samples from each block variable. A maximum of eight block variables may be configured. Block trend graphs have two styles:

See Also:

For further information about Block Trend Graphs, see Vijeo Designer Help Creating Block Trend Graphs.

Vijeo Designer

Manual Version 1.1

8-7

Block & Plot Trends (cont.)


Plot Trend The Plot Trend Graph part in the Toolchest displays the data samples collected using the trigger data collection method. Each point on the plot trend graph represents a data sample collected for variables. The data samples are collected at different times and may span a wide range of time intervals.
During Runtime, the plot trend graph displays data samples collected using the

trigger data collection method. When new data samples become available, the plot trend graph automatically scrolls to show the most current samples on the graph. Older samples scroll off the left side of the graph as they are replaced with the new data samples.

See Also:

For further information about Plot Trend Graphs, see Vijeo Designer Help Creating Plot Trend Graphs.

8-8

Version 5.1

September 2010

Exercise - Build a Trend Chart Panel


1 Create a Realtime Trend Graph. i. ii. iii. Open the History panel and click the Trend button.

Draw a Trend graph on the panel so that it fills the panel. Configure the graph with these settings:

Property
Range Settings ValueRangeFrom ValueRangeTo DisplayRangeMin DisplayRangeMax Channel1 Channel2 Variable Variable

Value
0 50 0 50 External.SP_TIME External.TL

When the Variable is entered into the Variable field this message will appear.

This is because variables that are logged must be assigned to a Logging Group. This subject will be discussed in the next part of the chapter. iv. Configure any properties. colours for the

PlateColor

and

BorderPanel

Vijeo Designer

Manual Version 1.1

8-9

Exercise - Build a Trend Chart Panel (cont.)


2 Create a Historical Trend Graph. i. ii. Click the Toolchest button to open the Toolchest pane. Navigate to the folder Graph TrendGraph Historical Trend. Add the chart Trend3D_01 to the panel below the realtime trend. Set these properties:

Property
ValueMin (Value) ValueNax (Value NumOfChannels Channel1Variable Channel2Variable Channel3Variable Channel4Variable

Value
0 1000 4 External.Tank_H2O External.Tank_STK External.Tank_ING External.Tank_ADJ

No changes will be visible on this graph until the project is in Runtime. 3 Save the project.

8-10

Version 5.1

September 2010

Data Logging
Store Historical Data Data logging provides the ability to collect and store variable values. With data logging it is possible to specify which variables will be logged, to determine the frequency of data sampling, and specify where the data will be stored. Data logging supports BOOL, REAL, Integer types, and STRING variables. The number of variables that may be logged in one project depends on the target machine. Variable data is used by the Trend Graph function. The recommended maximum number of variables used in one data logging group should not be exceeded.

See Also:

For further information about Recommended numbers of variables, see Vijeo Designer Help - Appendix 4, Run-Time Specifications. Data logging enables production managers and supervisors to keep a history of particular elements in a production process, which can be used, for example, to analyse, audit, and track performance. The logged data can be displayed in graphs and saved to file.

Vijeo Designer

Manual Version 1.1

8-11

Data Logging Groups


Logging Groups Data collection for trend charts is controlled by Data Logging Groups. These groups are created at the Project level. When a new project is created a default Logging Group exists in the Data Logging node in the Navigator.

Two types of Logging Groups are available: Periodic - collected on a time interval

Triggered - snapshot of data when a trigger condition changes state

A maximum of 80 different Logging Groups are allowed per target. All logged variables are attached to Logging Groups. recommended number of logged variables is: 80 100 - XBTGT1000 - XBTGT2000 and higher The maximum

8-12

Version 5.1

September 2010

Data Logging Groups (cont.)


How to Create a Logging Group

To create a new Logging Group:


Select the Data Logging node in the Navigator and press the Insert key or Right click the Data Logging node and select New Logging Group from the menu

See Also:

For further information about Data Logging Groups, see Vijeo Designer Help About Data Logging.

Vijeo Designer

Manual Version 1.1

8-13

Data Logging Groups (cont.)


How to Configure Periodic Logging The type of Logging, whether Periodic or Triggered, is specified at the level of the Logging Group. Periodic Logging determines the data sampling rate.

To configure a Periodic Logging Group:


Double click the Logging Group in the Navigator, then set the: Sampling interval, specify time units Name - Name of current logging group Type - Periodic a time based sampling Units Units for the digits created by the slider

See Also:

For further information about Data Logging Group Settings, see Vijeo Designer Help - Creating a Data Logging Group.

8-14

Version 5.1

September 2010

Data Logging Groups (cont.)


How to Configure Triggered Logging When a group is configured for Triggered Logging, data is collected when a specified Trigger Condition changes state.

To configure the triggering for the logging group:


Select the Type: Trigger. Select the Trigger Condition. This can be one of these types: When True When False On data change Then specify the Trigger Variable variable linked to trigger the event

See Also:

For further information about Trigger Group Settings, see Vijeo Designer Help Creating a Data Logging Group.

Vijeo Designer

Manual Version 1.1

8-15

Data Logging Group - Variable Setting


Variable Storage The amount of variable data that is being stored and where the data will be stored can be managed by using one of these storage options: DRAM DRAM SRAM system's SRAM - preserves the most recent data samples in the system's - preserves a specified number of data samples in the

- uses the SRAM until its capacity is reached, in which SRAM and File case, the data is written to file. A summary for all data logging groups may be obtained by viewing the Property Inspector when the Data Logging node is selected. The summary displays the estimated space used in DRAM and SRAM, the estimated File size, and the estimated number of days to reach the file size limit.

8-16

Version 5.1

September 2010

Data Logging Group - Variable Setting (cont.)


Variable Storage (cont.) Configuration details for variables using this groups historical data collection Type DRAM only the most recent data SRAM saves a specified number of data records SRAM & file after SRAM limit is reached, data sent to file

Records in Ram - ## of records stored in Ram before filed


DRAM 10 to 1000 records SRAM 10 300 records

File Limit how much data to be stored Ram Usage/File Size(1) calculates the memory usage for your configuration

Vijeo Designer

Manual Version 1.1

8-17

Data Logging Group - Variable Setting (cont.)


How to Configure Variable Storage The settings for Variable Storage are located in the Variable Storage tab of the Logging Group properties.

To configure the Variable Storage:


Double click the Logging Group in the Navigator then open the Variable Settings tab.

See Also:

For further information about Variable Storage Settings, see Vijeo Designer Help - Creating a Data Logging Group.

8-18

Version 5.1

September 2010

Data Logging Group Buffer


Data Buffering The data collection buffer is configurable. When the buffer becomes full, variable records are moved from the buffer to permanent storage. The buffer then starts filling again with new variable records.

If data does not change often, then historical data may remain in the buffer and will not be logged to a permanent location. To make the data available for dataprocessing, it should then be flushed to permanent storage. It may be advisable to run flushToStorage (script method): At defined intervals (Application Script: Periodic) When changing panels (Panel Script: On Close) When exiting the Vijeo-Designer Runtime user application (Application Script: on Shutdown)

Vijeo Designer

Manual Version 1.1

8-19

Exercise - Logging Groups


1 Configure the default Logging Group i. ii. Double click the default Logging Group, LoggingGroup01, from the

Navigator.
Set the sampling rate to 3 seconds. This will control the scroll rate on the chart as well as the data collection rate. Click OK.

iii. iv.

Return to the the Navigator and double click the Variables node to open the Variable Editor. Double click the grey rectangle next to

External.Tank_H2O and open the Data Details tab. Logging Group field to LoggingGroup01.

the variable Change the

8-20

Version 5.1

September 2010

Exercise - Logging Groups (cont.)


v. Repeat this process for the other four variables that have been assigned to the Channels in Exercise - Build a Trend Chart Panel (page 8-9). Each variable that is linked to a chart must be added to a Logging Group. External.TL External.Tank_STK External.Tank_ING External.Tank_ADJ vi. Add a Return switch to the top of the page to navigate back to the Navigate panel. The completed page should look similar to this:

Vijeo Designer

Manual Version 1.1

8-21

Exercise - Logging Groups (cont.)


2 Test the project. i.

Save and validate the project then test panels operation by running several batches in a row. After sufficient data has been collected, navigate to the History Panel and observe the charts operation. Request some historical data be displayed from the historical trend chart.

8-22

Version 5.1

September 2010

Chapter 9:

Alarms and Events

Overview - Alarms and Events


Introduction This chapter covers the alarm and event monitoring features available in Vijeo Designer

This Chapter Covers These Topics: Alarming Introduction ...........................................................9-2 Alarm Groups ........................................................................9-3 Exercise - Alarm Groups .......................................................9-7 Alarm Sounds ........................................................................9-8 Exercise - Create a Sound File...............................................9-9 Alarm Variables...................................................................9-10 Exercise - Configure an Alarm Variable .............................9-15 Alarm Banners .....................................................................9-17 Exercise - Create a Global Alarm Banner ...........................9-21 Alarm Summary...................................................................9-22 Exercise - Create Alarm Summaries....................................9-28 Alarm Categories .................................................................9-30 Output Alarms to File ..........................................................9-32 Alarm Printing .....................................................................9-37 Real-Time Alarm Printing ...................................................9-41 Event Monitoring.................................................................9-42 Exercise - Event Monitoring................................................9-45

Alarming Introduction
Introduction When an error or event occurs, a list of alarms can be displayed on the target machine by using the Alarm Summary. The Alarm Summary displays not only the alarm message, but various other information about the alarm, such as the date and time when the alarm was activated or restored. To display an alarm message: Configure alarm condition(s) Create alarm groups Configure the alarm summary to display the alarms
Basic alarm information

Alarm configuration is part of the variables definition Alarm groups are a way of organizing alarms and assigning attributes Saving options, behavior (ack, no ack), message text Organize by machine, area, process, severity Alarm Summary operates in either an active or historical modes
Active - appear when variable data enters the alarm range Acknowledged active alarms that have been confirmed by the user Returned to normal the variable has exited the alarm range

The Alarm Summary control simply displays the alarm information There are three alarm states

Alarm Banners are possible

Alarm banners can be either local (panel) or global (project)

9-2

Version 5.1

September 2010

Alarm Groups
Default Alarm Group An Alarm Group sets collection and storage parameters. Variables that are to generate an alarm are attached to an Alarm Group. When a new project is created a default Alarm Group exists in the Alarms & Events node in the Navigator.

How to Create an Alarm Group

To create a new Alarm Group:


Select the Alarms & Events node in the Navigator and press the Insert key or Right click the Alarms & Events node and select New Alarm Group from the menu

Vijeo Designer

Manual Version 1.1

9-3

Alarm Groups (cont.)


How to Add Alarm Group Settings

To open the Alarm Group Settings:


Double click the Alarm Group in the Navigator or Right click the Alarm Group and select Settings... from the menu

See Also:

For further information about Alarm Group Settings, see Vijeo Designer Help Alarm Group Settings.

9-4

Version 5.1

September 2010

Alarm Groups (cont.)


Counters Tab Variables may be designated to hold the active count of various alarm group status information.

Vijeo Designer

Manual Version 1.1

9-5

Alarm Groups (cont.)


Messages
Type Messages and State Messages may be set for alarm state headers. These

may also be set fro use in different languages.

Each field has default message text. For example, the HiHi field has the default text HiHi. When the customised text, HOT, is substituted into these fields it will be displayed in the Alarm Banner during runtime.

9-6

Version 5.1

September 2010

Exercise - Alarm Groups


1 Rename the default Alarm Group. i. Locate the default Alarm Group, AlarmGroup1, in the Navigator.

ii.

Right click AlarmGroup1 and select Rename Group from the menu.

iii.

Rename the group Ingredients_Low.

Save the project.

Vijeo Designer

Manual Version 1.1

9-7

Alarm Sounds
Sound Files This feature allows users to associate .wav sounds with Touch animation, scripts, and alarms. Sound files may then be used to generate alarms or give feedback to the user.

How to Add a Sound File

To Add a sound file to the project:


Select the Sound node from Environment Data Files in the Navigator.

When the Sound node is selected the Sound File Editor opens in the main editing area. This allows the user to create an alias and associate a wav file that will play when triggered by an event.

9-8

Version 5.1

September 2010

Exercise - Create a Sound File


1 Open the Sound File Editor. i. Select the Sound node from Environment Data Files in the

Navigator.

ii.

When the Sound node is selected the Sound File Editor opens in the main editing area.

Create an alias named alarm. i. ii. Type alarm in the Alias field. Click the Add button and browse for the alarm.wav file in the C:\Class folder.

This wave file is now available to be played when an alarm is triggered. 3 Save the project.

Vijeo Designer

Manual Version 1.1

9-9

Alarm Variables
Boolean Alarms The configuration of an Alarm is part of the Variable Definition. A Boolean Alarm depends on a change of state in a Boolean Variable. The Alarm can be configured using the Variable Properties form or in the Property Inspector.

Example Boolean Alarm in the Variable Properties form.

9-10

Version 5.1

September 2010

Alarm Variables (cont.)


Boolean Alarms (cont.)

Example Boolean Alarm in the Property Inspector.

See Also:

For further information about Boolean Alarms, see Vijeo Designer Help - Setting Up BOOL Variables.

Vijeo Designer

Manual Version 1.1

9-11

Alarm Variables (cont.)


Word Alarms Vijeo Designer can monitor word addresses (integer or REAL variables) as well as bit addresses (BOOL variables). When monitoring word addresses, an alarm triggers when word address values change beyond one or more specified limits. Each alarm may be configured using the following types:
Limit Alarms - activated when the variable value extends beyond a defined point that indicates a cautionary limit. Two limits can be set for values at either end of the normal value range.

Hi and HiHi alarms - where the value reaches an atypical high Lo and LoLo alarms - where the value reaches an atypical low
Deviation Alarms (%) - activated when the variable value deviates from the

specified target value. One or two measurements of deviation (defined as a percentage) can be set for the target value Minor deviation activates a warning alarm Major deviation activates a critical alarm
Deviation Alarms (Fixed) - activated when the variable value deviates from the specified target value. One or two measurements of deviation (defined as a constant value) can be set for the target value

Minor deviation activates a warning alarm Major deviation activates a critical alarm

9-12

Version 5.1

September 2010

Alarm Variables (cont.)


Word Alarms (cont.) The Alarm can be configured using the Variable Properties form or in the Property Inspector.

Example Limit Alarm configured with Lo and LoLo Alarm Thresholds in the Variable Properties form.

If a Deadband that equals 10 was configured for this alarm a Lo alarm is triggered when the variable value falls below 900. Due to the Deadband the alarm will remain active while the value hovers between 900 and 910, and will not deactivate until the value rises above 910 (Hi value + Deadband value).

Vijeo Designer

Manual Version 1.1

9-13

Alarm Variables (cont.)


Word Alarms (cont.)

Example Deviation (Fixed) Alarm in the Property Inspector.

See Also:

For further information about Word Alarms, see Vijeo Designer Help - Word Alarms.

9-14

Version 5.1

September 2010

Exercise - Configure an Alarm Variable


1 Create an alarm when the Water Tank level is too low. i. ii. iii. Double click the Variables node in the Navigator. Double click the Tank_H20 variable to open the Variable Properties then click the Alarm tab. Click the Alarm tickbox to activate the fields.

iv.

Activate the tickboxes LoLo and Lo. Add the values 800 to the LoLo field and 900 to the Lo field.

Vijeo Designer

Manual Version 1.1

9-15

Exercise - Configure an Alarm Variable (cont.)


2 Add a sound file that will play when the alarm is triggered. i. Click the Sound tickbox then click the Configuration button. Since the alarm alias is the only one that has been configured it is the only choice in the Sound File drop down list. If other aliases are configured the designer will have a choice of sound files in this field. When the variable reaches the designated levels the alarm will occur and the sound will play. Click OK.

Save the project.

9-16

Version 5.1

September 2010

Alarm Banners
Display an Active Alarm An Alarm Banner is a line of scrolling text that becomes visible when there is an active alarm. Single line alarm banner messages scroll from the right side of the panel to the left side of the panel. Double line alarm banner messages remain fixed on the screen without scrolling.

There are two types of Alarm Banners Local and Global.

Vijeo Designer

Manual Version 1.1

9-17

Alarm Banners (cont.)


Local Alarm Banners
Local Alarm Banners are only displayed on a specific panel where the banner has been configured. The Local Alarm Banner is an item in the Diagnostics folder in the Toolchest that may be placed anywhere on a panel in the same way as any other Toolchest item.

Once the banner has been placed on the page the attributes are available in the
Property Inspector. This is where can be added to an Alarm Group and other attributes such as the Display Message and Scroll Rate are configured.

See Also:

For further information about Local Alarm Banners, see Vijeo Designer Help Local Alarm Banner.

9-18

Version 5.1

September 2010

Alarm Banners (cont.)


Global Banners
Global Alarm Banners can be configured to display alarm messages that scroll across every panel even in the middle of a change panel operation. Therefore, only one Global Alarm Banner may be configured in each project.

Vijeo Designer

Manual Version 1.1

9-19

Alarm Banners (cont.)


How to Create Global Banners

To Create a Global Banner:


Select the Target in the Navigator. When the Target is selected the Property Inspector will display the Alarm Banner settings. Set the Alarm Banner to Enabled.

Global Alarm banners can be set up to display in one of three positions: Top, Middle, or Bottom. When there are no alarm banner messages, the panel operates normally. An alarm category can be used to display messages from multiple alarm groups. The global banner display changes the height automatically according to the font size. However, the width cannot change, because it is the same size as the panel width. If the Global Alarm Banner and the Active Event Viewer display at the same time, the Global Alarm Banner is appended to the bottom of the Active Event Viewer. For banner messages, it is not possible to use the Touch Action and Severity settings.

9-20

Version 5.1

September 2010

Exercise - Create a Global Alarm Banner


1 Add a Global Alarm Banner to the project. i. ii. Select the target Factory in the Navigator. Set the Alarm Banner to Enable. The default position of the Alarm Banner is the bottom of the panel so this setting can remain with the default.

iii.

Add the Display Message, Ingredients Low and select any other attributes.

Save and validate the project.

Vijeo Designer

Manual Version 1.1

9-21

Alarm Summary
Display a List of Alarms When an error or event occurs, it is possible to display a list of alarms and events on the target machine by using the Alarm Summary and Event Summary. The Alarm Summary displays not only the alarm message, but various other information about the alarm, such as the date and time when the alarm was activated or restored. The Event Summary displays event messages, which include user actions, system error events, and system events.

For targets with a panel screen size of 200x80, each alarm or event message is displayed individually in the summary instead of in a list. The summary will also display the date and time of the alarm or event, the alarm state, the alarm or event number, and the number of alarms or events. Use the NEXT and PREV buttons to go to the next or previous alarm or event message, the ACK button to acknowledge the alarm, and the Exit button to exit the summary and return to the previous panel.

9-22

Version 5.1

September 2010

Alarm Summary (cont.)


How to Add a Summary

To add an Alarm Summary to a Panel:


Click the Alarm Summary change to the Alarm Summary button on the Graphical Toolbar. The cursor will cursor.

Position the cross on the Alarm Summary cursor over the top left point on the Panel where the Alarm Summary will be placed and click. Position the cursor over the point where the bottom right of the Alarm Summary will be placed and click a second time to define the area of the Alarm Summary.

Vijeo Designer

Manual Version 1.1

9-23

Alarm Summary (cont.)


General Tab The General tab defines display and operation attributes for the summary.

See Also:

For further information about Alarm Summary Settings, see Vijeo Designer Help - Setting Up an Alarm and Event Summary - General Tab.

9-24

Version 5.1

September 2010

Alarm Summary (cont.)


Messages Tab The language, font, and font size for messages is defined in the Messages tab. For example, it is possible to define the text and back colors for alarm messages in the four states (Active, ACK, RTN, and UNACK), or define the colors for event messages by their severity .

See Also:

For further information about Alarm Summary Settings, see Vijeo Designer Help - Setting Up an Alarm and Event Summary - Messages Tab.

Vijeo Designer

Manual Version 1.1

9-25

Alarm Summary (cont.)


Column Display The Columns tab allows the user to select which column items to display, the order of columns, the column titles for each language, the column width, and the font and font size for the specified language.

See Also:

For further information about Alarm Summary Settings, see Vijeo Designer Help - Setting Up an Alarm and Event Summary - Columns Tab.

9-26

Version 5.1

September 2010

Alarm Summary (cont.)


Buttons The Buttons that are displayed on the Alarm Summary are also configurable. Select the Enable Buttons tick box to define and position operation buttons on the summary. Select the operations that are to be added to the summary from the Available Buttons list and add them to the desired location on the Summary using the four Add buttons. During Runtime, the Summary displays and positions the operation buttons that are defined in the Buttons tab

See Also:

For further information about Alarm Summary Settings, see Vijeo Designer Help - Setting Up an Alarm and Event Summary - Buttons Tab.

Vijeo Designer

Manual Version 1.1

9-27

Exercise - Create Alarm Summaries


1 Create th Alarms and AlarmH panels. i. Open the Alarms panel and add an Alarm Summary. Click the

Alarm Summary
panel. ii. iii. iv. v.

button and draw an Alarm Summary on the

Add a navigation button from the Alarms panel to the AlarmH Panel and another button to return to the Navigate panel. Add a navigation button from the AlarmH panel back to the Alarm panel. Add an Alarm Summary to the AlarmH panel. Open the General tab and set the Alarm & Event List field to History. This will allow the Summary to display the alarms in Historical mode.

9-28

Version 5.1

September 2010

Exercise - Create Alarm Summaries (cont.)


2 Test the project. i. ii. iii. iv. v. vi. vii.

Save and Validate the project.


Run the application through several cycles until an alarm(s) are shown in the Global Alarm Banner. Open the Alarms panel and acknowledge the alarms.

Stop the batch and reset the application Return to the Alarm panel, the alarms should be gone
Go to the AlarmH panel, it should show all the historic alarm actions.

Experiment with the viewer(s) settings.

Vijeo Designer

Manual Version 1.1

9-29

Alarm Categories
Display Multiple Alarm Groups Alarm Categories may be used to display multiple alarm groups and multiple diagnostic alarm groups in the same alarm summary object. In the following example, variable alarms are allocated to alarm groups AlarmGroup1 and AlarmGroup2. DiagAlarmGroup1 is associated with Modbus (RTU) equipment and DiagAlarmGroup2 is associated with Uni-Telway equipment.

9-30

Version 5.1

September 2010

Alarm Categories (cont.)


How to Create a New Alarm Category

To create a new Alarm Category:


Right click the Alarms & Events node in the Navigator and select New Alarm & Event Category from the menu

Move the desired groups from the Available Groups pane into the Selected
Groups pane using the Add buttons.

The Filter button, added using the Button tab in the Alarm Summary Settings, allows operators to sort the Alarm Group(s) to be displayed

Vijeo Designer

Manual Version 1.1

9-31

Output Alarms to File


Save to File Alarms and Events can be sent to a Runtime Data Location as a .csv file, which can be processed using Microsoft Excel or other programs. The following diagram shows an example of alarms that output to the CF Card as a .csv file from the target machine, and the alarm .csv file being copied to a folder on the editor PC.

9-32

Version 5.1

September 2010

Output Alarms to File (cont.)


Save to File (cont.) Control Variable - an integer variable that controls when to output alarms to a file, and in what format Status Variable - an integer variable to give you the status of the file output operation Error Variable an integer variable that store an error code File Name - Specify an integer or float variable and specify a value between 0 and 999999 as the number used for the .csv file name. File name will be AAxxx, AHxxx, ALxxx (active, history, log type alarms By Date - D + date format selected + 1 numerical digit + .csv Save to - Select the saved files destination folder from the Save To list. Using the name defined in the Save To field, creates a folder to the CF card's:

public/bin/projects/TargetName/Data/Alarm

Vijeo Designer

Manual Version 1.1

9-33

Output Alarms to File (cont.)


How to Enable Save to File

To enable Save to File in an Alarm Group:


Select the Alarm Group in the Navigator. When the Alarm Group is selected the Property Inspector will display the Save to File settings. Set Save to File to Enabled.

9-34

Version 5.1

September 2010

Output Alarms to File (cont.)


Save To File Control Tab When Save To File is Enabled the Save To File dialog will open. The Control Variable, Status Variable, and the Error Variable need to be defined in the Control tab

See Also:

For further information about Save To File Settings, see Vijeo Designer Help Outputting Alarms and Events to a .CSV File - Control Tab.

Vijeo Designer

Manual Version 1.1

9-35

Output Alarms to File (cont.)


Save to File Format Tab The Format tab defines the format of the information that is sent to the CSV file. The default columns are shown in the Columns to Save pane. Additional information may be added to the file by selecting columns from the Columns Available pane and adding them to the Columns to Save pane.

See Also:

For further information about Save To File Settings, see Vijeo Designer Help Outputting Alarms and Events to a .CSV File - FormatTab.

9-36

Version 5.1

September 2010

Alarm Printing
Print Alarm and Event Messages Vijeo Designer can print alarm messages as they occur in real-time or print alarm and event messages in batches. It is also possible to perform real-time and batch printing at the same time. Batch printing prints alarm and event messages when signalled by the Print Control Variable. Batch printing can print alarm messages in the Active, Log, or History format, and event messages in the Log or History format.

How to Enable Batch Printing

To enable Batch Printing:


Select the Alarm Group in the Navigator. When the Alarm Group is selected the Property Inspector will display the Batch Printing settings. Set the Batch Printing to Enabled.

Vijeo Designer

Manual Version 1.1

9-37

Alarm Printing (cont.)


Control Tab When the Batch Printing is Enabled the Batch Printing dialog will open. The Control tab sets up the Print Control Variable, Status Variable, and Error Variable.

9-38

Version 5.1

September 2010

Alarm Printing (cont.)


Format Tab The Format tab is used to format the columns that will appear when the alarms are printed. The Columns that will be printed are configured using the Add and Delete buttons

The Title is built using select buttons and format specifiers.

Vijeo Designer

Manual Version 1.1

9-39

Alarm Printing (cont.)


Triggered Batch Alarm Printing The maximum number of alarms that can be printed using Batch printing is defined in the Property Inspector for the Alarm Group in the Num of History Alarms property and Num of Log Alarms property.

When there are more alarms than the set maximum, the target machine removes the oldest alarms to make room for the newest alarm information. When printing an alarm category with multiple alarm groups, do not use the same variable for the Print Control Variable, the Status Variable, and the Error Variable. The same variables are set up, the Alarm Category and the Alarm Groups will print out duplicate copies. Alarm groups or alarm categories using the same Print Control Variables, the Status Variables, and the Error Variables, print in their creation order. For example, alarmgroup1 was created before alarmcategory2, so alarmgroup1 will print first.

9-40

Version 5.1

September 2010

Real-Time Alarm Printing


Real-Time Alarm Printing
Real-Time Printing prints an alarm message each time the alarm state changes between active, acknowledge (ACK), and return to normal (RTN). Batch Printing prints all alarm messages at one time.

How to Enable Real-time Printing

To enable Real-time Printing:


Select the Alarm & Events Node in the Navigator. When the Alarm & Events Node is selected the Property Inspector will display the Real-time Printing settings. Set the Real-time Printing to Enabled.

See Also:

For further information about Real-time Printing Settings, see Vijeo Designer Help - Configuring Real-Time Printing.

Vijeo Designer

Manual Version 1.1

9-41

Event Monitoring
Event Monitoring In Vijeo-Designer, you can display event information to the user with the following display formats and features: Event Summary Display You can display a list of events (user actions, system error events, and system events) on a panel by using the event summary. Events only have one state in the event log and in the event display. You can print these event messages or save them to a .csv file. Actions You can set up an event message operation to display predefined event messages. At runtime, an event message would display when an operator touches a switch or sets off an action trigger.

How to Configure Events

To configure Events:
Add a new Event Group to the project. Right click Alarms & Events then select New Event Group Event Group from the menu. Configure the Event group for permanent message storage if desired by select selection the recording options desired

9-42

Version 5.1

September 2010

Event Monitoring (cont.)


Open a text resource to create the text for the event message

i.

Add an Event Message Operation to your switch. Link it to your Event Group and select the Message Text (index number) from the Text Resource you created. When the switch is activated, the message selected will be logged and(or) displayed

Vijeo Designer

Manual Version 1.1

9-43

Event Monitoring (cont.)


ii. Add an Event Summary and double click it. Attach the summary to your Event Group

iii.

When the switch is activated, the event configured creates a log message and displays the message on the Event Summary.

9-44

Version 5.1

September 2010

Exercise - Event Monitoring


1 Start the Event Monitoring Configuration i. Create a new panel named Events and add a navigation button on the Navigation page to get there and a return button on the Events page that takes you back to the Navigation page From the Alarms and Events Task, add a new System Event Group

ii.

iii.

Accept the defaults for the System Event Group

Vijeo Designer

Manual Version 1.1

9-45

Exercise - Event Monitoring (cont)


iv. From the Variables area, open the External. SP_H2O variable and select Log User Operations on the Data Details Tab

v.

Repeat this process for the following variables:

1. SP_ADJ, SP_ING, SP_STOCK, SP_TEMP, SP_TIME


vi. Add an Event Summary on the new page you just created. Size it so that its almost as wide as the panel

Configure the Event Summary i. Double click on the Event Summary and configure as shown

9-46

Version 5.1

September 2010

Exercise - Event Monitoring (cont.)


ii. With the Event Summary still open for editing, Open the Columns

Tab and configure as shown

iii.

Save and test the operation. With your application running, enter some new setpoints and run a batch. Open your Events panel and observe that the operator actions have been logged. The running Event SUmmary will look similar to the image below

Vijeo Designer

Manual Version 1.1

9-47

Chapter 11: Overview


Introduction

Scripting

This chapter discusses Vijeo Designer's scripting language and how to work with it.

This Chapter Covers These Topics: Scripting Introduction ..........................................................11-2 Script Types and Scope........................................................11-3 Variables and Scripting........................................................11-4 Scripting Basics ...................................................................11-5 Variable Read/Write Methods .............................................11-6 Creating an Action Script ....................................................11-7 Script Editor.........................................................................11-9 Panel and Object Level Scripts..........................................11-11 Exercise - Scripting............................................................11-12

Scripting Introduction
Introduction

Scripts are coded instructions that tell the target how to react to real-time events A touch, a panel change, a change in value can all trigger a script's execution You cannot use Java keywords as object or script names

The Vijeo Designer scripting language is based on Java. Scripts are used when you cannot accomplish your objective any other way using built-in tools

11-2

Version 5.1

September 2010

Script Types and Scope


Script Types There are four types of scripts: Project Actions (Scripts) can run anytime Periodic, scheduled, conditional, or event Periodic, conditional or event Panel Scripts can only run when the associated panel is open Touch Animation Scripts only run when the associated touch animated object is pressed\ When touch, while touch, when release Alarm Action Scripts run once when an alarm is triggered or when an alarm message is selected in an Alarm summary Hi, HiHi = 2 triggers

Scope

Scope Scope is defined as the degree of visibility. Each different type of script has a different level of scope Panel and Touch Only works with objects on the current panel. Lowest scope. Alarm Actions Only works with objects on current panel (except alarm summary

objects)
Actions event based or run on a time interval, a schedule or based on defined

events. Doesn't matter what panel is open. Highest scope.

Vijeo Designer

Manual Version 1.1

11-3

Variables and Scripting


Variables Two types - Script Vars, Outside Vars Script = local variables used inside script only Outside = declared in variables section. May be local to Vijeo Designer or PLC vars

Case Sensitive - Vijeo-Designer variable names, method calls, keywords, are case sensitive. Var1 is not the same as var1. Initialization of Variables - Local script variables must be initialized before they're used in the script, especially when used in a comparison. Even if a variable is assumed to be 0, it must be assigned a 0 value before it can be used, otherwise building of the user application fails. For example: integer a, b=0; if ( a==0 ) if ( b==0 ) // a is not initialized // cannot compile // build successful because b was initialized

Decimal Values - Floating point values are expressed with a 0 to the left of the decimal point. For example: .234 (invalid), 0.234 (correct)

Variables created in Vijeo-Designer (outside variables) should not be used directly in script expressions. To use a Vijeo-Designer variable in a script, use the variable's get value method and assign the result to a local script variable. You can then use the script variable in script control statements, mathematical operations, and other script

11-4

Version 5.1

September 2010

Scripting Basics
Script Basics Descriptions - slashes ( // ) are supported for comments Operators - these are some of the Java operators that are available: arithmetic, comparison, conditional and logical, bitwise, and assignment. Flow Control - these flow control keywords are supported: if-else statement - if condition is TRUE then do something, else do

something else
do-while - Repeats a set of statements while the conditional expression remains true. Statements run at least once. for - Repeats a set of statements while the conditional expression remains true. Shorthand for a common loop, where variables are initialized before the loop and variables are updated during each iteration of the loop. switch-case-default - Performs set of case statements that match the defined switch condition. Performs default statements when the switch condition does not match any of the case statements break - Exits the current loop or case statement. return - Exits the script

Semi-colons mark the end of statements (1) Enclose expressions in parentheses (condition), statements to be executed in braces (2) Called a Block IF statement

Vijeo Designer

Manual Version 1.1

11-5

Variable Read/Write Methods


Read/Write Methods
Variables are referenced as follows:

int itemp; itemp = IntVar.getIntValue();


// **************************

// get variable IntVars value, assign to itemp

int itemp; itemp = 123; IntVar.write(itemp);


// ************************ Read/Write Methods:

// assign value of itemp to Vijeo-Designer variable IntVar

XXX.write(itemp + 500); // a direct write to variable XXX You must define a variable before you assign a value to it External variables MUST be copied to local variables End of statement is marked by the semicolon Other Methods are getFloatValue(), getStringValue() Write method is the same for all data types (last example) Scripting Examples

11-6

Version 5.1

September 2010

Creating an Action Script


How to Create an Action Script

To create an Action Script:


Right click the Actions node in the Navigator and select New Action. Select the Trigger Type for the Action. This script has the highest scope since it's created on the project level.

Vijeo Designer

Manual Version 1.1

11-7

Creating an Action Script (cont.)


How to Create an Action Script (cont.) On the next screen select Script as the Action then click the New Script button to open the Script Editor. Once the script has been created click Finish.

11-8

Version 5.1

September 2010

Script Editor
Introduction All scripts share the same editor. A Right click menu is available to generate script and it should be used as much as possible. This will help reduce errors. It is also advisable to Validate to check the script for errors.

The Insert Tool

The Insert tool helps developers to generate script code by adding Variables, Methods, or Operators.

To use the Insert tool:


Right Click to use the Insert tool to add Variables, Methods, or Operators (1) After variable is selected, type in a "." The system displays a list of available Methods for variables (2). Using the Insert tool insures correct syntax and eliminates typing errors

Vijeo Designer

Manual Version 1.1

11-9

Script Editor (cont.)


Validate

Validate often! Right click the script and select Validate (1) Correct any scripting errors before leaving script editor Help screens have much more information as well as scripting examples

11-10

Version 5.1

September 2010

Panel and Object Level Scripts


How to Write Panel and Object Scripts

To write a script on the panel level:

i. ii. iii. iv.

Right click panel (1) Select New Action (1) Create the scheduling of the action (not shown) Create new script for the action (bottom image)

To create an Object Level Script (below)

v. vi. vii.

Add object to panel (switch shown) Configure object to execute a script


The reset is the same as with other level scripts

Vijeo Designer

Manual Version 1.1

11-11

Exercise - Scripting
1 Add new switches to panel. i.

Add switches (switch07) that look like "Spin Buttons" (arrows) from the Native Switches to the Process Panel as shown

ii.

Double click the top switch and add a script under the While Touch tab

iii.

Create the script as shown.

Hints & Tips Use the right click insert function to help you generate the code. Validate your script when finished.

11-12

Version 5.1

September 2010

Exercise - Scripting (cont.)


iv.

Add the script below to the bottom spin button under the while pressed tab. Validate your script when finished

v. vi.

This script uses a different method to manipulate the water setpoint variable. When all scripts validate, test the operation of your scripts. When you select and hold down one of the switches that you just created, the water setpoint will either increment or decrement, depending on which one is selected

Vijeo Designer

Manual Version 1.1

11-13

Chapter 12: Overview


Introduction

Project Security

This chapter covers various project security options available in Vijeo Designer

This Chapter Covers These Topics: Security Introduction ...........................................................12-2 Project Security....................................................................12-3 Target Security.....................................................................12-4 Other Security ......................................................................12-5 Security Groups ...................................................................12-6 Security Levels ....................................................................12-7 Target Operation ..................................................................12-8 User Login .........................................................................12-10 Security on Switches..........................................................12-11 Exercise - Project Security.................................................12-12

Security Introduction
Introduction Vijeo Designer's security features protect projects, panels, parts, Data Manager, and other areas from access by unauthorised users. Users must log in with the proper user name and/or password to access secured areas. Users can access different areas, depending on their security level.

Vijeo Designer has multiple security options available. Security groups and users are possible Different permissions may be assigned for different users Timed inactivity logout Controls Data Manager permissions

Security can control upload/download permissions Controls Webgate permissions Control navigation to secure panels Control access to secure controls Creation of secure controls Security is a built in feature Recipe security is provided for (separate topic) Recipe security is covered in the recipe module

12-2

Version 5.1

September 2010

Project Security
Project Security Security can be added to the projects so that unauthorised users cannot open or overwrite protected protects. Project Security is created at the Project level. How to set up Project Security Select the Project node in the Navigator . The Security properties wll become visible in the Property inspector.

Password hint to help you remember your password After a project is downloaded with a password is downloaded, the password is in effect You can secure the Vijeo Designer editor in order to limit access to your projects and prevent a project from being opened or overwritten by an unauthorized user. Such protection can be defined when creating the project or via the project properties. You can also enter a password prompt to remind you of your project password

Vijeo Designer

Manual Version 1.1

12-3

Target Security
Target Security

Targets may be Unprotected or Secure from unauthorized access How to set up Target Security With Security selected in Navigator (1) Window (2) appears in Inspector

Select Use Security


Inactivity logout timed logout Unsecured panel unsecured panel displayed when timeout occurs when on a unsecure panel Secured panel same but when on a secured panel Secured Object Behavior How secured objects appear

You can add security to your target machines so that only authorized users can download projects to target machines and access data on target machines. You can create up to 100 users in a maximum of 20 security groups.
Permissions are set at the security group, user login level

12-4

Version 5.1

September 2010

Other Security
Other Security

Download Security - stops unauthorized users from downloading projects to secured targets. Enable first, then create security groups with download option Data Manager Security - Prevents an unauthorized user from using the Command Line or the Data Manager to transfer run-time data to and from the target machine Web Gate Connection Security - Prevents an unauthorized user from using Web

Gate to access a target machine

Vijeo Designer

Manual Version 1.1

12-5

Security Groups
Security Groups

Security Groups:

A security group is a collection of security users. Each user is assigned the security settings that are defined in the security group. For example, if SecurityGroup01 has Web Gate access then each security user in SecurityGroup01 will have Web Gate access. Each target supports a maximum of 20 security groups. Each security group supports a maximum of 100 users in it How to set up Security Groups To create a Security Group:
i. ii. Right click Security and select Create Group (1) Set Group permissions (2)

1. 20 different groups are allowed


Security Groups control:

Download to target(s) Data Manager permissions Web Gate permissions

12-6

Version 5.1

September 2010

Security Levels
Security Levels

Security Levels:

Switches, panels, and popup windows can be assigned a security level so only authorized security groups can access them Click Two types of security Levels Minimum & Bitmask Level Based - security group must have a security level that is equal to or greater than the security level assigned object Bitmask (1) - performs a bitwise AND operation with the binary value of the security group's security level and the binary value of the secured object's security level. If result it True then access is granted How to Create User(s) Object has security setting of 2 (010) Admin = 7, Operator = 2 Anded results shown (2) Both the Administrator & Operator have access
Maintenance does not

To Create a User:
i.

Create USER under Security (1)

1. 100 different users are possible


ii. iii.

Assign username and password (2) Assign user to a group (2)

Vijeo Designer

Manual Version 1.1

12-7

Target Operation
Automatic Logout Targets may be set to logout the current user if a configured inactivity period expires (1)

To configure automatic use logout: With the Environment/Security selected in the Navigator, select "Use Target Security"
Security Mode select level based or bitmask (1) Logout Behavior:

Inactivity Time-Out - Set the inactivity time-out period in minutes Unsecured Panel - Specifies the panel that displays when inactivity time out occurs on an unsecured panel Secured Panel - Specifies the panel that displays when inactivity time occurs on a secured panel

Secure Object Behavior

There are different ways that secure items may be displayed at runtime. Secure items may be: Display a small lock icon Grayed out Be invisible

12-8

Version 5.1

September 2010

Target Operation (cont.)


How to Configure Secure Objects Select the way you wish secure items to be displayed (2) When Touch - Specifies the panel the system will display when an unauthorized user touches the secured object

Vijeo Designer

Manual Version 1.1

12-9

User Login
User Login
User Login: - The Login tool is used to login users to the target at runtime. This

tool is found int he Security floder in the Toolchest (1)

How to add a Login tool to a Panel

To create a custom User Logon panel, you must add a Logon control from the
toolchest
i. ii. iii. Select Security from the toolchest (1)

Drag Login to the panel


At runtime, login tool allows you to enter the user name and password (3)

System Login Tool

System Login Tool Like a popup.window. Can use a predefined logon popup

panel

User Manager

Allows you to create users and passwords at runtime Users are assigned to a User Group too

12-10

Version 5.1

September 2010

Security on Switches
Switch Security

Switch Security

Security can be added to any type of switch (1) Security is supported by any native part How to Add Security to a Switch Add a switch to the panel Double click the switch and open the Advanced Tab Select the Security level the user must have to operate the switch (1)

Vijeo Designer

Manual Version 1.1

12-11

Exercise - Project Security


1 Create a new login panel i.

Create a new panel named "Secure" and number it 999.

ii.

Select the Security option from the Navigator

iii.

Make the adjustments shown below in the Inspector

1. When you test security, the application will navigate back to panel 999 when the inactivity period expires. It will not matter if you are on a secure or not secure panel when the time expires.
iv. With Security still selected in the Navigator, create two new security groups. Name the first group admin and the second group maint

1. admin = security level 1 2. maint = security level 9

12-12

Version 5.1

September 2010

Exercise - Project Security (cont.)


v. Create two new users by right clicking on the User field. Using upper case letters, name the users BOSS and BUBBA. Make the passwords BOSS and BUBBA (upper case)

1. Assign the BOSS to the admin group and BUBBA to the maint group as shown
2 Add Login tool to secure panel i.

Open the Secure panel and add a Login control. This is located in the Toolchest, under security

Adjust to colors of the tool to what ever you like

Add two switches labeled Admin and Bubba as shown

Vijeo Designer

Manual Version 1.1

12-13

Exercise - Project Security (cont.)


ii.

Configure the Admin switch as follows:

1. From the Advanced tab, assign switch to the admin security level

iii.

Configure the Bubba switch as follows:

iv.

Under the Advanced tab, assign it to the maintenance group

Under the Visibility tab, enter the expression shown below

_UserLevel is a system tag that holds the security level of the current logged in user. The expression will make the switch visible if the current user is maint (e.g., BUBBA). It will not be visible when the BOSS logs in

12-14

Version 5.1

September 2010

Exercise - Project Security (cont.)


v.

Open the Navigate panel and select the Cook House switch

Under the advanced tab, set the security level to maint. When the BOSS logs in, he will be able to go to the Navigate panel but does not have permission to go to the Process panel.
vi. From the Navigator, with your target selected, set the initial panel to 999:Secure

This will force the user to login when the project first starts.
vii.

Save, Validate and test your project.

1. Login as BOSS and observe that you are locked out of the process panel. 2. Do not touch the simulator for 1 minute, you should cancel back to the secure panel and be logged out. 3. Log in as BUBBA and notice that the BUBBA button appears. You should be able to navigate to the process panel 4. Feel free to experiment with other options

Vijeo Designer

Manual Version 1.1

12-15

Chapter 13: Overview


Introduction

Recipes

This chapter discusses the various recipe options available in Vijeo Designer

This Chapter Covers These Topics: Introduction to Vijeo Recipes ..............................................13-2 Recipe Terminology ............................................................13-4 Relationship of Parts............................................................13-5 Recipe Variables ..................................................................13-6 Recipe Groups......................................................................13-7 Recipes and Ingredients .......................................................13-8 Recipe Manager ...................................................................13-9 Recipe Security ..................................................................13-10 Recipe Access Rights.........................................................13-11

Introduction to Vijeo Recipes


Recipe Basics

Recipe is a feature that allows you to work with specified recipe values of multiple device addresses at the same time. By creating a simple user interface, you can maintain a consistent production process just by defining the production parameters. Now, when the workflow changes or needs changing, the operator will no longer have to go through a complex process.

With a recipe, you can: Write values of one recipe (with the Send operation) from the target machine to your equipment. Snapshot Feature

Values from the PLC can be uploaded into the Magelis via a process called snapshot. You can then upload and backup these values in the Editor to make the values permanent.

13-2

Version 5.1

September 2010

Introduction to Vijeo Recipes (cont.)


Sending a Recipe

Select a different recipe and use the Send operation to send and overwrite the recipe values currently in your equipment

Vijeo Designer

Manual Version 1.1

13-3

Recipe Terminology
Terminology Ingredient individual elements in a recipe An ingredient comprises a language specific label, the associated variable, and a minimum/maximum value. Each recipe usually uses several ingredients. flour, water, yeast, olive oil, and salt make pizza crust Different amounts of each make different types of crust Each different combination is a different recipe Each recipe group has a unique ID number (ranging from 1 to 65535) and a name Users are assigned an access level that specifies whether they can or cannot view and edit the recipe group You can create a maximum of 32 recipe groups per target. Recipe Group Number Variable Recipe Number Variable Operation Trigger Variable Operations Lock Variable Status Variable Error Variable Access Right Variable

Recipe a collection of variables and values -

Recipe Group a collection of recipes.

Recipe Controls a set of control variables used with recipe groups

Ingredient individual elements in a recipe. An ingredient comprises a language specific label, the associated variable, and a minimum/maximum value. Each recipe usually uses several ingredients. Recipe a collection of variables and values. For example, Great Pizza Works has a Dough recipe group with this list of ingredients: flour, water, yeast, olive oil, and salt. The recipe would specify values for each ingredient. Then, using those ingredients, you can make recipes for thin crust dough, thick crust dough, or pan crust dough. You can create a maximum of 64 recipes in each recipe group. Recipe Group a collection of recipes. Each recipe group is uniquely identified

with an ID number (ranging from 1 to 65535) and given a name that describes the recipe group. Users are assigned an access level that specifies whether they can or cannot view and edit the recipe group. You can create a maximum of 32 recipe
groups per target. Recipe Controls a set of control variables used with recipe groups. A Recipe Control includes the Recipe Group Number Variable, Recipe Number Variable, Operation Trigger Variable, Operations Lock Variable, Status Variable, Error Variable, and Access Right Variable.

13-4

Version 5.1

September 2010

Relationship of Parts
Relationship of Parts

Recipe Components:

Recipe Groups contain recipes, Recipes contain ingredients Ingredients are linked to variables
Recipe Group

Recipe Group can be best understood using the pizza example. Great Pizza Works creates and controls three different recipe groups: Dough, Sauce, and Toppings. Each recipe group contains similar recipes. In this case, the Sauce recipe group contains a Spicy sauce recipe, a Medium sauce recipe, and a Mild sauce recipe (recipe numbers 1, 2, and 3). All recipes in a recipe group use the same ingredients.
Recipe

The recipes in each recipe group contain the same ingredients, which vary from recipe to recipe. In the Sauce recipe group, the Spicy, Medium, and Mild recipes contain the same ingredientscrushed tomatoes, olive oil, and chili powderbut the chili powder ingredient is not actually used in the Mild recipe. In the Editor, you can set up the recipes, recipe ingredient values, and other values associated with each ingredient.

Vijeo Designer

Manual Version 1.1

13-5

Recipe Variables
System Variables

Recipe Control variables (1) - Run recipe operations such as selecting recipes and sending recipe values. Also store error and status values that result from recipe operations Ingredient variables (2): Represent ingredients in a recipe. Each ingredient variable stores the value for its associated ingredient How to Creatie Recipe Variables Created by the system when you configure a recipe

Create the variables to be controlled by the recipe in the normal manner Manually, imported, linked ... Not necessary if variables already exist

13-6

Version 5.1

September 2010

Recipe Groups
Recipe Groups

How to Create a Recipe Group

i. ii.

Right click Recipes in the Navigtator Select New Recipe Group

A Recipe Group is a collection of recipes

Vijeo Designer

Manual Version 1.1

13-7

Recipes and Ingredients


Recipes and Ingredients

The areas that need to be configured are: Displayed Recipe Name Name of Recipe (1) Recipe variable (browse for) (2)
Label name of ingredient displayed by recipe control (3) Editable yes or no, user can modify ingredient (4) Set Min/Max values if Editable (5)

Set recipe variable value (6) Add additional variables to recipe as needed

Displayed Recipe name in control is entered under Language 1 (1)

13-8

Version 5.1

September 2010

Recipe Manager
Recipe Manager The Recipe Manager tool is a toolchest tool (1) that may be used to: Send recipes to a PLC Take a Snapshot of the value of the current PLC recipe variables Save modified recipe variables thus making them permanent Delete a recipe (s)

This control is available in two different forms (3) though both operate the same In addition, a custom recipe control may be constructed from the individual parts contained in the Recipe folder (1) This allows the developer to add only the controls he wishes the operator(s) to have access to

How to Add a Recipe Manager

To use the custom Recipe Manager Control:


i. ii. iii. Add a Recipe Manager from the toolchest (1) Two different appearing Recipe Managers are available(2)

Texterror tool was added as an additional feature(3)

1. Displays error if recipe could not be sent Custom Managers may also be built from separate parts. There are several Recipe Manager tools available. The texterror tool is useful in reporting errors associated with the manager.

Vijeo Designer

Manual Version 1.1

13-9

Recipe Security
Recipe Security

May be set in the properties section of the Control Group level (1) User must have Access right 3 to edit this recipe group Recipe access rights are not linked to user levels Set by RecipeControlDefault.AccessRight variable (2)

13-10

Version 5.1

September 2010

Recipe Access Rights


Access Rights

Access rights for individual recipe access are displayed In the example above, a user would have to have an access right of 3 access the Tomato recipe. Anybody could access the Chicken or Vegetable recipes
Several security combinations are possible:

Access Right = 0 means no security Security on individual recipes or on the whole recipe group If you put an access right on the recipe group (higher level) and a 0 here, then any user that satisfies the Recipe Group's setting, has access to all recipes in the group

Vijeo Designer

Manual Version 1.1

13-11

Exercise - Recipes
1 Create Recipe Group i. From the Navigator, locate the Recipe option, right click and create a new Recipe group

Name your Recipe group SchneiderSoup


ii. There will be three recipes, Tomato, Chicken and Vegetable soup. Right click the default recipe and create two new recipes (three total). Rename the recipes to Tomato, Chicken and Vegetable.

The finished recipes appear as shown below

13-12

Version 5.1

September 2010

Exercise - Recipes (cont.)


Next the ingredient variables for the recipe are selected. Each recipe uses the same variables, but will have different quantities, depending on the product being produced.

iii. iv. v.

Collapse the Recipe fields (left side of editor) back to their original
size

Browse for the variables from the variable field by double clicking in the variable field
The finished ingredient values should appear as shown below

vi.

Create a new popup panel named Recipe and adjuct the panel's color to anything that you like.

Vijeo Designer

Manual Version 1.1

13-13

Exercise - Recipes (cont.)


vii. Add a Small Recipe Manager from the toolchest to the panel

1. Add a switch to the panel that takes you back to the previous panel. Use the Previous option in the switchs animation 2. Add a Text Error Object to the panel (Toolchest) (labeled no error in the picture) and position it below the recipe manager. This is an optional recipe tool that is located with the other recipe objects You can use a complete object (above) or you can build your own recipe control from individual parts
viii. Add a switch to the process panel labeled Recipe as shown. Configure the switch to open the Recipe popup panel

ix.

Save, Validate and test the recipe's operation. Since all student groups are sharing a single PLC, the ingredient values will change every time someone sends a new value to the PLC
Add Recipe Security

i.

Open your recipes and add the access levels shown. These levels
have NOTHING TO DO WITH the security levels you set up before

A user with an access right of 7 can run all the recipes. A user with access level 2 could run the Chicken recipe. An access level of 0 means that there is no security.

13-14

Version 5.1

September 2010

Exercise - Recipes (cont.)


ii.

Open up the Secure panel and double click on the Admin switch.

Add the command Word/Set as shown. This line writes the value 2 into the variable RecipeControlDefault._AccessRight This variable controls the access rights for recipes. Add the Change Panel(2) command shown. Make sure that

the access rights are set before you navigate away from the secure panel (e.g., its first)
Repeat the same procedure for the Bubba switch only write a value of 7 into the RecipeControlDefault._AccessRight variable
iii. Since the access rights will not change until you change it, you can insure that the access rights are reset to 0 when the logged in user is logged out by the system. This can be done by adding a one line script

iv.

Add a panel level script to the Secure panel. Script1.

Name the script,

v.

Set the script to execute on the "ON Open" event of the panel

Vijeo Designer

Manual Version 1.1

13-15

Exercise - Recipes (cont.)


vi.

Create the script shown below

This script sets the access rights to 0, anytime the secure panel opens. Therefore, after one minute of inactivity, secure panel is opened and the access rights will reset to zero
vii. If you disabled Security at the close of the earlier exercise, you must

enable it now. Change the logout Behavior such that the application
jumps to the secure panel after 1 minute of inactivity (shown)

Also, Set your first panel to be the Secure panel. This forces you to login when the application first starts
Remove the Security from the Process button on the Navigate panel or the Boss

will not be able to navigate to the process panel


viii.

Validate, and test the operation of security. Notice that when The Boss is logged in, he can only see one recipe but when Bubba is
logged in, he can run any of the three batches

13-16

Version 5.1

September 2010

Chapter 14: Overview


Introduction

Data Sharing

This chapter covers Vijeo Designers Data Sharing feature

This Chapter Covers These Topics: Data Sharing Introduction....................................................14-2 Exclusive Input ....................................................................14-3 Input Synchronization..........................................................14-4 Variable Sharing Example ...................................................14-5 Exercise - Data Sharing .......................................................14-8

Data Sharing Introduction


Data Sharing

Data Sharing:

Vijeo Designer allows you to use variables (maximum of 300) to exchange data via Ethernet between the Magelis terminals involved in a project. The variables exchanged can be accessed in read or read/write mode. A variable declared in read-only mode means that it can be written into by its target machine but only read by other targets. A variable in read/write mode can be read and written by all targets. A variable is sent by the terminal or server Magelis and can be used by up to 8 clients. Similarly a client can use variables from 8 different servers (e.g. Target1.Variable1). To prevent several terminals from writing the same variable at the same time and causing conflicts, you can declare the input as exclusive. Designated variables data are shared between target machines Trend Graphs & Alarm Summaries support data sharing Targets must be in the same project Data Access - read or read/write mode to variables on other terminals Ethernet must be used to interconnect the targets 300 shared variables maximum are allowed(400 iPC) Sharing must be enabled Variables must be individually shared Think of the application as having Client and server targets 8 clients (max) may access 1 server 1 client may access up to 8 servers (max)

14-2

Version 5.1

September 2010

Exclusive Input
Overview

Data sharing is a useful feature that enables one target machine to view and change data on another target machine, or access the same PLC from two different physical locations. But this could also produce uncertain situations where two different operators might begin working with the same equipment without being aware of each other's actions. To prevent simultaneous inputs to the same variable, you can set up exclusive input relationships between target machines. With this feature you can stop other target machines from changing the value of variables you're working on Multiple users trying to access the same data from multiple monitors can be dangerous Setpoint entry from different locations at the same time is not desirable The Exclusive Input & Exclusive Panel options prevents this Functionality

Exclusive Input: Blocks navigation to panels with a control that is opens Prevents simultaneous data entry from multiple targets Enabled at the project and panel level The first target that opens a protected panel, locks out the others from opening the same panel Error message (bottom above) appears if you try to open a protected panel that has been locked out

Vijeo Designer

Manual Version 1.1

14-3

Input Synchronization
Property Inspector

At run time, when you try to change to a panel with exclusive input configured: the target requests permission from the target set up as the Input Manager. This target either grants the request (if none of the other targets is in exclusive input mode) or refuses the request (if one of the other targets is in exclusive input mode.)

If the request is granted, you can begin working with the exclusive input panel. If the request is refused, the target remains on the same panel and displays an error message. The target designated at the Input manager controls access to panels with exclusive input activated Designated target manages the inputs Sends target to the top panel after a period of time Optional Inactivity Timeout time panel can hold exclusive input

14-4

Version 5.1

September 2010

Variable Sharing Example


How to Configure Data Sharing Example
Typical Example Target A has the PLC driver installed, Target B has no PLC driver but shares the data from Target A

The configuration for this example will be explained over the next few pages. Create a New Project

Create a project with two targets PLC driver is installed on the Server target

Create panels in both projects

Vijeo Designer

Manual Version 1.1

14-5

Variable Sharing Example (cont.)


Input Synchronization

Select the project and activate Input Synchronization(1) Indicate which target will be the Input Manager and manage the exclusive
inputs

Specify an Inactivity Timeout if desired (2) Exclusive Input Panels

Enable Exclusive Input on both panels This option becomes available after Input Synchronization is enabled Do this on both targets

14-6

Version 5.1

September 2010

Variable Sharing Example (cont.)


Data Sharing

Select the first target in the Navigator and enable Data Sharing Repeat this for the other target Your top level panel cannot have objects that use data sharing Variable Sharing

Configure data sharing sharing on each variable to be shared Select Read Only or Read/Write Animating Target B

Add objects on panel for data display and entry Browse and select shared variables from the other target (e.g., Server.output_int) (1)

The other project gets the data from the PLC, this project uses it. The data is shared and the same in both panels

Vijeo Designer

Manual Version 1.1

14-7

Exercise - Data Sharing


1 Import a Project i. To save time, your Instructor will have you restore a project that has been started for you. You will need to complete the project and when you run your project, you will become a display client of the hardware target. In other words, the hardware target will poll the PLC for data and share it with your application running in the simulator. Right click the Vijeo Manager and select Import Project

ii.

Import the project Sharing from the C:\Class folder

iii.

Open the Sharing project. Two targets are configured. DO NOT EDIT THE SERVER PROJECT. This is a copy of the project that will be running in the hardware target

14-8

Version 5.1

September 2010

Exercise - Data Sharing (cont.)


iv.

Open the Client project. Notice that there are no communications


drivers configured. In this exercise, all target to PLC communication will be done by the hardware target. Also notice that the client program does not have any variables configured. The client will get all its information from that shared variables in the server. You will be configuring a pure HMI client

v.

Open Panel2. The animated fields are present but are not linked to
any variables yet

Link a variable to the animated field as follows:

1. Double click the field labeled Integer Input" and browse for the Server.input_int variable from the Server project. This variable has been previously shared in the server project so you can add it to the Client Project on Panel2

vi.

Link the other three Animation fields as follows:

Field
Integer Output Float Input Float Output

Variable
output_int input_float output_float

Save, Validate and test your project

Vijeo Designer

Manual Version 1.1

14-9

Exercise - Data Sharing (cont.)


i. Since there is no Exclusive Input or any protection enabled at this point, everyone should be able to go to Panel 2 at the same time. If there are more than 8 simulators, some will not be able to connect to the server until others leave

Shut down your simulator when finished testing


3 Add Exclusive Input to the Project i.

Select Panel2 of your Client program

1. In the Inspector, enable Exclusive Input

ii.

Save, validate and test your application. This time, only one target should be able to access panel 2 at a time. All others should receive
an error when they try. Take turns connecting

14-10

Version 5.1

September 2010

Chapter 15: Overview


Introduction

Web Server and Web Gate

This Chapter covers Vijeo Designer's Web Server and Web Gate features.

This Chapter Covers These Topics: What is the Web Server? .....................................................15-2 What is Web Gate? ..............................................................15-3 Web Gate Basics..................................................................15-4 Web Gate Features/Restrictions...........................................15-5 Types of Web Gate Connections .........................................15-6 Web Gate Configuration......................................................15-7 Web Gate Security ...............................................................15-9

What is the Web Server?


Web Server? Vijeo Designer has an optional Web Server that may be added to a project.

Once enabled, available Web Server (1) operations are: Variable Browse - display select variable data remotely and to update the display with current values Statistics - view Information about the Target and Project File Viewer - view and copy Web Server files and data files in the main, secondary, and optional drives Web Gate (2) publishes Vijeo Designer panels to a browser

15-2

Version 5.1

September 2010

What is Web Gate?


Web Gate? Web Gate allows a target machine to act as a web server. When Web Gate is enabled on a target, a user can connect to the target through a browser on a remote PC. Depending the Web Gate setup, you can read and write data on the target machine from the remote PC.

Web Gate allows a Magelis to act as a web server. You connect to the target through a browser on a remote PC You can read and write data on the target machine from the remote PC (depending on setup) You can see and operate the panels, just as if you were in front of a Magelis

Vijeo Designer

Manual Version 1.1

15-3

Web Gate Basics


Basic Concepts

Web Gate allows the target machine to share its data with a remote PC across the corporate LAN, dial-up connection r the Internet. Ethernet networks only You can limit access to Web Gate based on a remote PC's IP addresses or through passwords Exclusive input, data sharing, input synchronization, recipes, trend graphs and alarm summaries all work with the client PC 8 concurrent client connections are allowed Web Gate is an ActiveX

You must install the ActiveX Control from the target on your PC before you can make a connection Follow the instructions displayed the first time you try to connect to a target Connection Starting Can also install from the Vijeo Designer Installation Disk

Web Gate connection starting up

15-4

Version 5.1

September 2010

Web Gate Features/Restrictions


Features Web Gate features include: Robust Security - you can limit access to the Web Server and Web Gate based on a remote PC's IP addresses or through passwords Web Server Capability - The web server allows the target machine to share its data with a remote PC across the corporate LAN or the Internet Data Sharing - Data Sharing enables you to share data between a target and a remote PC. Each target has a set of variables. A client PC can access these variables at run time, as long as the target is set up with Web Gate, is accessible on a network or LAN, and the target is set up to share its data Synchronization - When a target and remote PC are synchronized, changing the panel display on the target also changes the panel on the remote PC. Synchronization is enabled from Web Gate on the remote PC Restrictions Vijeo Designer features that are not available in Web Gate: You cannot directly access system variables on Web Gate. However, you can indirectly access system variables by using the Read From Variable and Write To Variable properties Alarm Summary cursor-related operations - such as cursor up/down, page up/down, move top/bottomthat are run on the target machine are not reflected on the Web Gate client. In run time, Alarm Banner moves to the back when an error message box appears. But in Web Gate, the Alarm Banner does not change position when an error message box appears System Operations - . Restart runtime, display configuration Controller Start or stop an XBTGC target Copy Data to/from Drive copies runtime data from one drive to another Video multimedia feature Browser - enables you to navigate through documents and web content on the Browser Image capture viewer multimedia displays captured image

Vijeo Designer

Manual Version 1.1

15-5

Types of Web Gate Connections


Office LAN
Connect Using a Router Via the Office LAN - If your plant and office are connected to separate LANs, you can access a target machine with the remote PC using a router

Dial-up

Web Gate connection via a dial-up router (modem)

Internet

Connecting through the Internet - With Web Gate's web server capability, you can set a IP address for the target and allow a remote PC to access the target via the Internet.

15-6

Version 5.1

September 2010

Web Gate Configuration


How to Enable Web Gate

No graphical elements to set! With target selected, enable Web Gate (1) Default port is 80 Select initial panel client will see when connected Inactivity Timeout is supported Web Gate Access

Web Server access connections (1) Unrestricted - anybody can connect Allowed IP addresses - list of IP addresses that are allowed to connect Blocked IP addresses - List of IP addresses that will be denied access

Vijeo Designer

Manual Version 1.1

15-7

Web Gate Configuration (cont.)


Configure Web Gate To use Web Gate, you must define the Publish settings for your project. Publish settings define whether the project's panels, popup windows, and actions are published to Web Gate, HMI Runtime, or both.

How to Set Web Gate Publishing Options

With the target selected in the Navigator, select the Web Gate Publish option in the Inspector Browse then select the desired publishing options (1)

Option
No Change

Description
Displays when you make a publishing selection from the Target properties. This option allows you to retain the publishing settings individually defined in the panels, popup windows, and actions. The defined panels, popup windows, and actions only publish to the target machine's HMI Runtime, and will not be available from Web Gate. The defined panels, popup windows, and actions only publish to Web Gate, and will not be available from the HMI Runtime The defined panels, popup windows, and actions will publish to both the HMI Runtime and Web Gate.

HMI Runtime

Web Gate

All

15-8

Version 5.1

September 2010

Web Gate Security


Security

If security is configured in the tareget, Web Gate supports the same User Name/ Password security

See Also: For further information about Web Gate Configuration, see Vijeo Designer Help Remote Monitoring with Web Gate.

Vijeo Designer

Manual Version 1.1

15-9

Exercise - Web Gate


1 Use the Sharing project i. In this exercise, you will run the Sharing application again and work with another group in the class. First you will run your Sharing application in simulation mode while your partner group creates a Webgate connection with your simulator. Then you will reverse roles and you will make a Webgate connection with your partners simulator Finally, we will try multiple connections to a single server

ii. iii.

Open the Sharing project you used earlier. Once again, only edit
the client project With the Client project selected in the Navigator, enable the Webserver and Webgate in the Inspector

iv.

Ignore the publish options that popup when you enable Webgate. Follow the procedure below to set the Publish property globally

With the Client project selected, Select Publish and configure as shown below.

15-10

Version 5.1

September 2010

Exercise - Web Gate (cont.)


v. Work out with your partner group who will be the webgate client first and who will be the server. Both groups need to disable Exclusive Input on Panel 2 ..Start the server The Client group should open an Internet Browser and type in the IP address of the Server application. If this is the first time the client has made a Web Gate connection, the ActiveX control must be installed

vi.

Running the Web Gate Connection i. The default Web Gate screen appears

ii.

Click the Monitoring option

iii.

Select the New Window option and ignore any error messages you
might see

Vijeo Designer

Manual Version 1.1

15-11

Exercise - Web Gate (cont.)


iv.

Navigate to Panel 2. Observe that you see live data via the webgate connection. Where is the data actually coming from? ________________________

The hardware target is actually polling the PLC and sharing the data with your simulator which in turn, is sending it to your Webgate client. Change the setpoints and the data should change
v. Right click in an open area of the screen on the webgate client. Select the Synchronization option

vi. vii. viii.

Now, change panels on the server application and notice what the client does.

Switch roles with your partner group and let them try their webgate
connection and the options described

Designate one student station as a server and connect multiple clients to the server

15-12

Version 5.1

September 2010

Chapter 16: Overview


Introduction

Intelligent Data Service (IDS)

This chapter discusses the configuration and operation of Schneider Electric's Intelligent Data Service.

This Chapter Covers These Topics: IDS Functionality.................................................................16-2 IDS Basics............................................................................16-3 IDS Topology ......................................................................16-4 IDS Configuration Introduction...........................................16-5 IDS Manager........................................................................16-6 Database Type......................................................................16-8 Variables Tab.......................................................................16-9 Monitoring/Actions Tab ....................................................16-10 Create Data Tables.............................................................16-11 Exercise - IDS Manager.....................................................16-12 IDS Explorer ......................................................................16-20 Datasources Manager.........................................................16-21 Menu ..................................................................................16-22 Create a Panel ....................................................................16-23 Exercise - IDS Explorer.....................................................16-25

IDS Functionality
21 CFR Part 11 IDS provides an easy way to track all the operator input and relevant values linked to a process to ensure ... Full and safe traceability Transparent and secure data logging with local or remote historical data base Local or remote access to dashboards Email send, launch of third party tool on single or combined trigger

Professional reporting Dedicated action on events

of a process including one or several Vijeo Designer targets in order to fulfill all needs of traceability including FDA 21 CFR Part 11 Targeted Business

All business where the manufacturing of goods has to follow a very strict process including raw material genealogy and full process traceability of any events to ensure production quality and safety

16-2

Version 5.1

September 2010

IDS Basics
Data Collection Based on Vijeo Designer Data Sharing Data Logging Uses a subscription mechanism (event driven for bandwidth optimization) Up to 8 targets can be connected though Data Sharing iPC / XBTGTW Series : 400 variables max per targets can be shared XBTGC / XBTGT / XBTGH / HMISTU / XBTGK : 300 variables max per target can be shared Variable sharing limits apply to IDS Any variables (incl. Internal & Systems variable) can be recorded Any operator inputs (recipe, login) Inherits Data Sharing limitations (Number of shared variables ...)

Any Vijeo Designer activity can be recorded

Data to be collected may be logged to: Relational database MS-SQL Server Compliant with FDA 21 CFR Part 11 data inviolability rule Intelligent Data Vault (IDV)

Advantages

IDS is easy to configure and easy to display collected data. Configuration and viewing is done in three main steps

Vijeo Designer

Manual Version 1.1

16-3

IDS Topology
Stand Alone

Stand-Alone solution (All-In-One) Both Vijeo Designer and IDSs Server are located on the same machine running MS-Windows Data are stored locally Run on advanced panel (XBTGTW), Advanced BOX, Embedded BOX & PC BOX

Remote Data Logging

Both Vijeo Designer and IDSs Server are located on the same machine running MS-Windows Data are stored remotely Run on advanced panel (XBTGTW), Advanced BOX, Embedded BOX & PC BOX

Distributed Solution

Distributed solution

Vijeo Designer and IDSs Server run on MS-Windows Run on advanced panel (XBTGTW), Advanced BOX, Embedded BOX & PC BOX Small panels (XBT STU) Advanced panels (XBT GT / GK / GTW) Advanced / Embedded / PC BOX

Vijeo Designer targets can be any Ethernet enabled panels -

Data may be stored remotely

16-4

Version 5.1

September 2010

IDS Configuration Introduction


Configuration Introduction

IDS Consists of two parts, both accessed from the Icon in Windows tray (1). When icon in tray is clicked, select: IDS Manager (2) - Configures connection to target, data to be collected and data logging details IDS Explorer (2) Connects to IDS server to display collected data

Uses configuration created by the IDS Manager Can display all or part of configured data Real time or historical data may be displayed Many possibilities are available

Vijeo Designer

Manual Version 1.1

16-5

IDS Manager
How to Configure a New Target

Launch the IDS Manager Right click IDS icon (1) Select IDS Manager (2)

IDS Manager launches (3)

Target Connection

Select Add Target (1) to create a new connection to a target Dynamic (2) - live connection to target. connection Builds configuration from live

Static (2) offline connection to Vijeo Designer project. Browses project files for configuration informatiuon

16-6

Version 5.1

September 2010

IDS Manager (cont.)


How to Select Data to be Collected

Select Target Tab (4) IP Address (1) Enter IP address of target (127.0.0.1 for simulator) Events (2) Select if tracking is desired. Items (3) shared variables in Vijeo Designer application Items selected will become available to be stored in a database

Vijeo Designer

Manual Version 1.1

16-7

Database Type
How to Select Database

Database Type (1) select database type for data collection Use IDV for 21 CFR applications Enter path and Data Storage name.. e.g., name of table that contains collected data New Database (2) enter path and Data Storage Name for new database

How to Set Storage Limitation

Storage Tab (1) Set limits on database size and/or collection time

16-8

Version 5.1

September 2010

Variables Tab
Variables Tab

IDS searches the target and displays a list of shared variables Creates a Variable Group 1 to hold these variables (1) System variables may also be added by clicking the Add Variables button

Vijeo Designer

Manual Version 1.1

16-9

Monitoring/Actions Tab
How to Select Variables to be Monitored

Select Monitoring Tab Select the variables to be monitored from the Variable Group 1 you just created Final list is on the right (1)

How to Configure Actions

Actions tab controls when and how the data are logged Create a new action (1) by clicking on the "+" sign Select Data Storage as action type (2) Select a trigger mode Cyclic, 5 sec interval shown (3)

16-10

Version 5.1

September 2010

Create Data Tables


How to Configure Data Tables

Select create a new table (1) A new table will be built to hold variable data Select Columns (2) every variable has its own column

How to Select Table Variables

Select variables (1) IDS confirms creation of table (2) Click on Apply then Finish Buttons to complete System confirms save configuration (3) IDS restarts with new configuration (4) IDS successfully connected to target (5)

Vijeo Designer

Manual Version 1.1

16-11

Exercise - IDS Manager


1 Share variables for IDS i. Open Vijeo Designer. With your project selected in the Navigator, turn ON Data Sharing in the Inspector if it is not currently ON

ii.

Open your project's variables and open the SP_ADJ variable for
editing

iii.

Turn ON Sharing for the variable as shown

iv.

Activate Sharing in the same


variables:

manner for each of the following

SP_H2O SP_ING SP_STOCK SP_TEMP TANK_ADJ


v.

TANK_H2O TANK_ING TANK_STOCK TMP_act Batch_Total

Validate and start your project in the simulator

16-12

Version 5.1

September 2010

Exercise - IDS Manager (cont.)


2 IDS Manager Configuration i. Right click the IDS icon in the tray and select IDS Manager

ii.

Select Add a Target

iii.

Select Dynamic for this option, the target (simulator) must be running. Rename your target Simulator and click on the Next button

Vijeo Designer

Manual Version 1.1

16-13

Exercise - IDS Manager (cont.)


iv. Change the Monitoring option (bottom) in the Items Shared area to All, Monitoring All as shown. Click on Next when ready

v.

Select IDV Intelligent Data Vault as the database type

vi.

Select Create a new database. Create a subdirectory under C:\Class and Set the path as shown. Name the data table training as shown.

16-14

Version 5.1

September 2010

Exercise - IDS Manager (cont.)


vii. IDS confirms the successful creation of the database

Data Logging Control i. Limit the size of the database to 1 MB and 1 Days data

ii.

Click on the Variables tab. IDS looks at the simulator and returns a list of shared variables. The list shown here are the variables that are used in this exercise. Remove any additional variables that might be shown from the displayed list

This list is a list of variables that are available to be monitored

Vijeo Designer

Manual Version 1.1

16-15

Exercise - IDS Manager (cont.)


iii. Click the Monitoring Tab. The final list to be monitored is on the right. Use the arrow keys to make your right side match the one shown here.

At this point, the IDS explorer could display a snapshot of real time data if the configuration process was stopped here
iv. Click the Actions tab to create an historical variable database. Select the Create a new trigger action as shown

v.

Select Data Storage as the action and click the Next button

16-16

Version 5.1

September 2010

Exercise - IDS Manager (cont.)


vi. Name your action anything you like. Make the action Cyclic and set it up for a five second interval. Click on the Next button when ready

vii.

Select Create a new table and click on the Next button

viii.

Name your Table Simulator 1 and select column. Click on the Next button when ready

Vijeo Designer

Manual Version 1.1

16-17

Exercise - IDS Manager (cont.)


4 Pick variables to be logged i. Select all the variables to be part of this table and click the Next button when ready

ii.

The system confirms the creation of the historical data table. Click on the Finish button

iii.

Click the Apply button followed by the Finish button to complete the configuration

16-18

Version 5.1

September 2010

Exercise - IDS Manager (cont.)


iv.

Save your configuration when prompted

v.

Confirm the restart of IDS

vi.

IDS should restart and connect to your simulator

Vijeo Designer

Manual Version 1.1

16-19

IDS Explorer
IDS Explorer
The IDS Explorer (1) connects to the IDS server to display the collected data

The IDS Explorer: Uses MS Silverlight. If not installed, will automatically downlooad and install on PC IDS Explorer Dashboard Standard login is admin, admin

Datasources Manager (1) - Configured Databases Dashboard(2) list of previously saved dashboards Panels (3) max of 12 panels available Toolbar Menu (4)

Dashboard

A Dashboard saves the layout of the panels that you viewing Dashboard is a collection of panels
User or Public viewing indicate who can view (1)

Saved Dashboards (2)

16-20

Version 5.1

September 2010

Datasources Manager
Datasources Manager

Datasources Manager

Used to identify all databases and storage in the Targets. (1) Dragged to Panel area to create a visualization (2) Real Time View

Real-time views are dynamic grids containing shared variables from the target set in IDS Manager, their real-time value and other significant attributes. One can observe for each variable in the grid, different fields such as: Device - the target name to which the variable belongs. Group - the group name to which the variable belongs. Variable - the variable name. Value - the real-time value of the variable. Last update - the timestamp of the last update of the field "Value". Max - the maximum value reached by the variable. Max Timestamp - the timestamp of the last update field "Max." Min - the minimum value reached by the variable. Min Timestamp - the timestamp of the last update field "Min". Variations count - the number of variable variations since starting

communication.

Vijeo Designer

Manual Version 1.1

16-21

Menu
Menu

Period Filter

The period filter displays data on a specific period. It is applicable to all types of displays (grid, chart, form). To view this filter, click the icon(calendar) located in the menu bar

16-22

Version 5.1

September 2010

Create a Panel
How to Create a Panel

Drag table to Panel (1) Data are displayed as chart (2) Change the way the data is displayed (3) Trend Chart

Display as Trend Chart

Select variables to be displayed(1) Data are displayed as a trend chart (2)

Vijeo Designer

Manual Version 1.1

16-23

Create a Panel (cont.)


IDS Tracking

IDS automatically captures event information in the IDS Tracking table No configuration is required

16-24

Version 5.1

September 2010

Exercise - IDS Explorer


1 IDS Explorer i. Right click your IDS tray icon and select IDS Explorer

ii.

The IDS Explorer launches. The default password is admin, admin. Click Login when ready

iii. iv.

The IDS Explorer connects to your configured database(s) and your

Simulator 1 Table appears in the database you created Drag the Simulator 1 table to an empty panel

v.

Enter some setpoint data into your soup application on the simulator and run a batch of soup. You should see data displayed in a
spreadsheet format

Vijeo Designer

Manual Version 1.1

16-25

Exercise - IDS Explorer (cont.)


vi. Click the Gold colored icon (upper left) and select

view

as/charts/trend chart

vii.

Select all the variables and click the Next button

viii.

The data are displayed as a chart

16-26

Version 5.1

September 2010

Exercise - IDS Explorer (cont.)


2 Experiment i. ii.

Experiment with other options of the IDS feature Note The address of the IDS Web server is the address of the host PC. When starting the IDS Explorer, make sure the IP address is correct for your PC

Vijeo Designer

Manual Version 1.1

16-27

Chapter 17: Overview


Introduction

Initialise a Magelis Terminal

This chapter describes the operations required to initialise a Magelis XBT GT / XBT GK/XBT GC terminals or iPC for first time use and includes: Loading the Runtime system Configuring the terminal offline Configuring system parameters

This Chapter Covers These Topics: Vijeo Designer Runtime System ......................................... 17-2 Set the Initial IP Address..................................................... 17-3 Access the System Area ...................................................... 17-4 Adjust the Terminal............................................................. 17-5 Offline Configuration Screens............................................. 17-6 System Configuration Screens ............................................ 17-7 System Diagnostic Screens ................................................. 17-8

Vijeo Designer Runtime System


Runtime System
Terminal
XBT GT 1100 XBT GT 1105 XBT GT 1130 XBT GT 1135 / 1335 XBT GT 2110 XBT GT 2120 / 2220 XBT GT 2130 / 2230 to series 7000 XBT GH 2460 XBT GTW 450 / 652 / 750 XBT GK 2120 / 2330 / 5330 XBT GC 110 / 2120 XBT GC 2230 iPC No Yes Yes No No No Yes Yes Yes No No CF / CD / DVD Floppy Disk

Ethernet
No No Yes Yes No No Yes

Tool Port
Yes No Yes No No No No

USB
No Yes No Yes Yes Yes Yes

CF Card
No No No No

Yes Yes

The Runtime system installed on the terminal allows the user to run the HMI application. The Runtime system must be compatible with the Vijeo Designer Editor used to create the application. The Runtime system is automatically transferred with the application to the target if the installed runtime is different than the runtime currently installed in the Magelis. The Runtime Installer tool can be used to install the system separately (in recovery mode for example) if needed. The runtime can also be installed using the memory card (if it is supported by the terminal) or the Runtime Installer Tool, via the Ethernet, Tool or USB ports on the terminal. In addition, IPCs can use CD Roms or floppy drives to install the runtime if they have them.

17-2

Version 5.1

September 2010

Set the Initial IP Address


How to Select the Network

To select the Network:


Select the Language for the Magelis from the drop down menu then click the Network icon to open the network configuration screen.

How to Set the IP Address

To set the IP Address of the Magelis:


Use the touch screen to enter the Magelis IP Address, Subnet Mask and Gateway information.

Vijeo Designer

Manual Version 1.1

17-3

Access the System Area


How to Display the System Area

To display the System Area of the Magelis screen:


Press the three corners shown on the touch screen simultaneously.

For XBT GT / GK terminals: Press top-left corner or 2 corners simultaneously for 2 sec (defined by the To configuration menu in the application) The corners that must be pressed are programmable. If another user has altered the configuration, the corners required to press may be different to those described. Buttons may also be configured to gain access to the System Area.

17-4

Version 5.1

September 2010

Adjust the Terminal


How to Open the Terminal Settings Access to the terminal settings is available only if an HMI application is loaded in the terminal.

To display the configuration screens of the terminal:


Press the top-left corner of the screen

or
Press more than one corner of the touch-sensitive screen simultaneously, depending on the option selected for the application

or
Animate a screen area or a button to access the terminal configuration screens

There are two tabs for accessing the: Offline Configuration Screens System Configuration Screens

The To Run Mode key allows the user to return to the normal operating mode of the application.

Vijeo Designer

Manual Version 1.1

17-5

Offline Configuration Screens


Offline Configuration

This screen provides access to 8 icons which are used to:


Network
Define or redefine the Ethernet communication parameters, such as IP address, subnet mask and default gateway address. This function is only accessible on terminals which have an Ethernet link Enable or disable the buzzer function on your terminal. If the function is enabled, touching an object causes a beep to sound Configure the terminal to switch to standby mode after a certain period, from 15 seconds to 30 minutes. The keys are inactive in standby mode and only an alarm will reactivate the backlight. The keys may remain active in this mode: this option is recommended Launch terminal self-tests, such as testing the fonts, screen, touch panel, serial ports and video memory Enable power supply to the COM1 port (power/no power to connector pin 9). This function is not accessible with the XBT G and XBT GT1000 terminals Allows users to view or modify driver configuration and equipment configurations from the panel Allows users to configure the Web Gate option from the panel Allows users to adjust the multimedia configuration from the panel

Buzzer Backlight

Self Test Option

I/O Manager Webgate Multimedia

17-6

Version 5.1

September 2010

System Configuration Screens


System Screens

This screen provides access to 8 icons which are used to:


Stylus Date/Time Restart Language Ver. Info Memory Brightness Option
Calibrate the terminal. Press all of the crosses to complete calibration Update the date and time on the terminal Restart the HMI application Change the system language and user language Display the Runtime system and application versions (version of Vijeo Designer editor used to create the application and Build number) Display the memory used and memory available: dynamic memory (DRAM), internal user memory (Main Flash) and memory card Adjust the screen brightness and contrast. Color screens with an active TFT matrix only allow the brightness to be adjusted. Display data in video or reverse video mode if using a monochrome screen

Vijeo Designer

Manual Version 1.1

17-7

System Diagnostic Screens


System Diagnostic Screens

This screen provides access to 2 icons that are used to:


Variables: Statistics:
Used to test communications between the target and the PLC. It also traps communications errors Shows communication statistics between target and PLC

17-8

Version 5.1

September 2010

Appendix A: Multimedia Features Overview - Multimedia Features


Introduction This chapter discusses Vijeo Designer's multimedia features

This Chapter Covers These Topics: Multimedia Features ............................................................. A-2 ScreenSnapshot..................................................................... A-3 Screen Snapshot Configuration ............................................ A-5 ScreenSnapshot Save Tab..................................................... A-6 ScreenSnapshot Print Tab..................................................... A-7 ScreenSnapshot and Web Gate ............................................. A-8 Multimedia - Video............................................................... A-9 Video Record Configuration............................................... A-10 Video Recording - Playback Snapshot Configuration........ A-11 Live Snapshot Configuration .............................................. A-12 Video Snapshot Variables................................................... A-13 Video Display Options........................................................ A-14 Video Control Variables ..................................................... A-15 Exercise - Multimedia......................................................... A-16

Vijeo Designer

Manual Version 1.1

A-1

Multimedia Features
What are Multimedia Features?

Multimedia consists of two parts:

Screen snapshot & print or view ScreenSnapshot Take picture of targets screen at runtime Store captured images as a .JPEG picture Print picture options View picture with JPEG viewer Display or play video Video snapshot

Video

A-2

Version 5.1

September 2010

ScreenSnapshot
Hardware

ScreenSnapshot is available on the following platforms: Functionality XBTGT 1005 series and up, XBTGK, XBTGTW iPC with Windows XP

Captures panel screen image(s) Saves as JPEG image Retrieved via Data Manager (1) or
Viewed with JPEG viewer

Print Options Fit to page Header support title, date, time, panel number Orientation portrait, landscape

Vijeo Designer

Manual Version 1.1

A-3

ScreenSnapshot (cont.)
ScreenSnapshot Variables System automatically creates ScreenSnapshot Variables (1) when feature is enabled

Used to control and monitor the snapshot process Write value into variable (2) to control Local or Web Gate

Variables:

Error error codes associated with snapshot (3) Status snapshot status number code

A-4

Version 5.1

September 2010

Screen Snapshot Configuration


How to Configure ScreenSnapshot Once ScreenSnapshot is enabled for the target, the snapshot control variables, Control, Error, FileNo, and Status, are automatically created.

It is recommend that you use a switch to trigger screen snapshots. If you use a keypad to trigger a snapshot, the snapshot may include a picture of the keypad Add a switch to the panel that you wish to capture and set the action to Momentary ON for the ScreenSnapshot.Control variable. Scripts can also be created for automatic ScreenSnapshot capture Screen to be captured must be the one being displayed

Vijeo Designer

Manual Version 1.1

A-5

ScreenSnapshot Save Tab


Save Tab

Automatic or manual generated file names Number of pictures to jeep (1) Circular file system ... oldest files are overwritten Set compression setting for image

A-6

Version 5.1

September 2010

ScreenSnapshot Print Tab


Print Tab

Printing must be enabled for the project and the printer configured. (1) Many options are available, including printing to network printers Print Tab select header options (2) and desired font

The following headers may be added to the snapshots's print output: Project Name - &J - The project name defined in Vijeo Designer displays in the header Target Name - &G - The target name defined in Vijeo Designer displays in the header PanedID - &I - The Panel ID defined in Vijeo Designer displays in the header Time - &T - The time the snapshot was taken displays in the header Date - &D - The date the snapshot was taken displays in the header

Vijeo Designer

Manual Version 1.1

A-7

ScreenSnapshot and Web Gate


How to Configure ScreenSnapshot with WebGate You must follow all these steps in order to take a picture using Web Gate

You cannot directly write to the snapshot control variable (1) via Web Gate In the Editor, for the screen snapshot Control variable, enable Read From Variable and select a variable that you created. In this example, the variable's Data Source is set to Internal and Sharing is set to Read/Write

Enable Webgate Connection Security (2) Control the Read From Variable via Web Gate to take a picture

The following headers to the snapshots's print output may be optionally added: Project Name - &J - The project name defined in Vijeo Designer displays in the header Target Name - &G - The target name defined in Vijeo Designer displays in the header PanedID - &I - The Panel ID defined in Vijeo Designer displays in the header Time - &T - The time the snapshot was taken displays in the header Date - &D - The date the snapshot was taken displays in the header

A-8

Version 5.1

September 2010

Multimedia - Video
Video

The Video feature: Supported for iPC, GT, GC and GTW series Not supported in XBTGC Record and view live video streams Play back a recorded video file
Video snapshot & print (live & playback)

-

Take a snapshot fromt the video camera

Video Display Object (1) - control for viewing video files or live video

Multimedia Live Video

With the target selected, enable Video, pick format (1) Select the video format (NTSC USA, PAL Europe and other locations)

Vijeo Designer

Manual Version 1.1

A-9

Video Record Configuration


How to Configure Video Recording Video Recording configuration involves several configuration tabs Record Tab:

Variables (1) automatically generated by the system File Name (2) automatic or manual - select how the recorded files are to be named Buffer configuration (3) records video to buffer. Specify number of minutes of video to hold in the buffer Save file as type pick the file format you desire For MP4, you must have a Codec and player that can handle this format. Can play on your PC
VMG is a highly compressed, proprietary format but cannot be viewed outside the target's runtime environment

A-10

Version 5.1

September 2010

Video Recording - Playback Snapshot Configuration


How to Configure Video Snapshots Configuration settings for creating video snapshots from recorded video

This tab assigns status status variables to the Video SnapShot feature Select the number of files to be kept, the way these files are named and the amount of compression for the files File compression (1) lowest compression = best quality= biggest files

Vijeo Designer

Manual Version 1.1

A-11

Live Snapshot Configuration


How to Configure Live SnapShot Configuration settings for creating video snapshots from live camera image

Assign the status variables to to monitor the features runtime status Select: Number of files to keep How files are to be named Amount of compression for the files

A-12

Version 5.1

September 2010

Video Snapshot Variables


How to Configure Video SnapShot Variables

System creates variables for snapshot options (1) You create buttons or use the provided keypads to enter values into the control variables (2) Scripts may also be created to control video operations Video Display Object

To add a Video Display Object to a panel: Select the Video Display Object and drag to the panel (1) Size it using the handles (2)

Vijeo Designer

Manual Version 1.1

A-13

Video Display Options


How to Configure the Video Display The Video Display's configuration controls what it does at runtime

Live Video Feed (1) select if you wish to view live video Play File (2) plays the file indicated Popup Keypad enables built-in keypads for the control. Live Video keypad is shown (4)
Live Video - Configures the Video Display to show the feed coming from the video

camera connected to the target's RCA Composite port

A-14

Version 5.1

September 2010

Video Control Variables


How to Configure Video Control Variables The Video control may be controlled by writing values int the Control variable. The information provided shows valid entries for the control variable and what each value controls

System creates control variables automatically (1) when Video is enabled Works in the same as the snapshot variables Use to create your own controls or use the builtin keypad Specific information is given (2) for controlling the video control

Variable
Control Status Variable Error Variable

Description
An integer variable that controls video recording (see table above) An integer variable that indicates the status of the video operation An integer variable that indicates the error that occurred during the video operation

Video Switch

A switch can also be use to control the video process. THis is the easiest way to interact with the video control.

Vijeo Designer

Manual Version 1.1

A-15

Exercise - Multimedia
1 Add and Configure SnapShot feature to application i. ii.

Create a new sub folder in your Class folder named Picts path will be C:\Class\picts

Your

Open the Schneider Soup project. With the Soup Project selected in the Navigator, activate the Screen Snapshot feature in the Inspector.. The system will create several new variables when this
feature is activated

iii.

Open the Process panel and create a new switch with the label Picture

iv.

Create a new integer variable named PICT as follows:

Activate sharing for the variable PICT as shown

A-16

Version 5.1

September 2010

Exercise - Multimedia (cont.)


v. Animate the switch as follows:

Even though the Snapshot.Control variable is an integer, you can apply bit operations (SET/RESET) on it. Vijeo Designer does not differentiate between a bits value of 0 or 1 and an Integers value of 0 or 1. In other words Bits and Integer values of 0/1 are treated the same, Each time the switch is activated, a picture is taken
2 Complete the configuration i.

Enable target & Web Gate security. Make "Process" the starting
pane

Vijeo Designer

Manual Version 1.1

A-17

Exercise - Multimedia (cont.)


ii.

Add the following Panel Action script on the Process panel. Set the
triggering of the script as shown

The script runs whenever the variable PICT is TRUE

The Vijeo Designer Simulator cannot store pictures since there is no compact flash. It will display pictures using the JPEG viewer. This script runs in your simulator and also the hardware target. Anytime any student presses the Picture button in the simulator, it will set the bit PICT in the target. This bit causes the script in the real Target to run, take a picture and store it in the compact flash.
iii. iv.

Save, Validate and run your project. Take ONE picture. Go to the
JPEG viewer and see if your picture is there Ask your instructor to open the JPEG Viewer page in the target and see the picture(s) there. These pictures come from the compact flash

v.

Launch the Data Manager. This is located under the Tools menu

A-18

Version 5.1

September 2010

Exercise - Multimedia (cont.)


vi.

Create a new connection to the target and name it "Bubba" when


prompted

vii.

Enter the information shown. BUBBA, BUBBA (uppercase)

The User name and Password are

Data location is the secondary drive. Click on Create when ready

Vijeo Designer

Manual Version 1.1

A-19

Exercise - Multimedia (cont.)


3 Connect to the target i. With BUBBA showing in the Media window, click on Next

ii.

Select Retrieve files

iii.

Select only Captured Images. Set the path to the picts folder you created earlier

A-20

Version 5.1

September 2010

Exercise - Multimedia (cont.)


iv. If you are successful, you will see a status report similar to the one below

v.

Go to your C:\Class\picts folder and double click on one of the pictures. You should see the process screen.

If you have time, open a Web Gate connection to the target and take a picture from the process screen. Open the JPEG Viewer and observe the captured screens. Remember that each student is also taking pictures

Vijeo Designer

Manual Version 1.1

A-21

A-22

Version 5.1

September 2010

Vijeo Designer Quiz


Name __________________________________________________________

1) Vijeo Designer
a) b) c) d) Develops applications for the Magelis XBTF terminals Is only used for the XBTG terminals Is only used for the XBTGT terminals Is used for both the XBTG and XBTGT terminals

2)

All XBTGT terminals support Ethernet communications

a) TRUE b) FALSE

3) The Navigator WIndow


a) b) c) d) 4) a) b) c) d) 5) a) b) c) d) Is where you select the project you wish to work on Displays items to be added to a panel Discovers all XBTGTs in a network and displays their status Allows you to select the part of a single project that you want to edit

The Inspector Window


Is a diagnostic tool for troubleshooting network problems Is used to troubleshoot compile errors Shows you details on any item that is selected Is another name for the script editor

The IDS feature:


Is integrated into the Vijeo Designer software package Only runs in Magelis IPCs Is a separate software package Works with all supported Magelis networks

6)

Alarms may be triggered by

a) Only digital variables b) .Only analog variables c) digital, analog but not real data type variables d) any variable type or by expressions continue on reverse side (just four more questions)

7) Security
a) b) c) d) Is a built in feature and consists of users with permissions Must be created as a user application and involves scripting Security is not available in Vijeo Designer Individual screen objects cannot be made secure

8) Data Sharing
a) b) c) d) PLC(s) send the same information to multiple targets Data is shared with external applications such as Excel Multiple targets exchange data via Ethernet Data is shared between targets using any type of networl

9) Webgate
a) b) c) d) Since security may not be used, anyone can adjust a process Allows only one remote connection Webpages are displayed from the PLCs Ethernet module (factorycast) Allows multiple targets to display each others panels

10) Data Sharing is required by (circle all correct answers)


a) b) c) d) IDS Alarming Webgate Recipes

Course Evaluation
Name: Company: Job Title:
_________________________________________________________________________________________________________________ _________________________________________________________________________________________________________________

_________________________________________________________________________________________________________________

Employee Number Course: Trainer:

_______________________________________________________________________________________________________

_______________________________________________________________

Date:

________________________________

_________________________________________________________________________________________________________________

Please rate each of the points below from 1 (Extremely dissatisfied) through 4 (neutral) to 7 (extremely satisfied)

1. Overall satisfaction:
a. Please rate your overall satisfaction with this course
1 2 3 4 5 6 7

2. Please rate the corporate aspects of this course:


b. The course booking process c. The training room and facilities d. Course scheduling and daily attendance hours e. Breaks and overall course flow f. Catering and refreshments g. Handouts and product information Additional comments:
__________________________________________________________________________________________________________________________________

1 1 1 1 1 1

2 2 2 2 2 2

3 3 3 3 3 3

4 4 4 4 4 4

5 5 5 5 5 5

6 6 6 6 6 6

7 7 7 7 7 7

__________________________________________________________________________________________________________________________________

__________________________________________________________________________________________________________________________________

3. Please rate the course and content:


a. The course guide was relevant and accurate b. The training course was relevant and accurate c. The amount of content in the course was adequate d. There was adequate hands-on time during the course e. I will use the course guide as a reference after the training
1 1 1 1 1 2 2 2 2 2 3 3 3 3 3 4 4 4 4 4 5 5 5 5 5 6 6 6 6 6 7 7 7 7 7

Additional comments:
___________________________________________________________________________________________________________________________________

___________________________________________________________________________________________________________________________________

___________________________________________________________________________________________________________________________________

4. Please rate the course trainer:


a. The trainer engaged the students throughout the course b. The trainer was well-prepared to teach the material c. The trainer treated all students in a courteous manner d. The trainer created a positive learning environment e. The trainer was helpful and offered useful advice Additional comments:
___________________________________________________________________________________________________________________________________

1 1 1 1 1

2 2 2 2 2

3 3 3 3 3

4 4 4 4 4

5 5 5 5 5

6 6 6 6 6

7 7 7 7 7

___________________________________________________________________________________________________________________________________

___________________________________________________________________________________________________________________________________

5. Please rate yourself:


a. I enjoyed the course b. I was able to keep up with the material c. I intend taking further training d. I would recommend this course to others e. I consider this course to be value for money Additional comments:
___________________________________________________________________________________________________________________________________

1 1 1 1 1

2 2 2 2 2

3 3 3 3 3

4 4 4 4 4

5 5 5 5 5

6 6 6 6 6

7 7 7 7 7

___________________________________________________________________________________________________________________________________

___________________________________________________________________________________________________________________________________

6. Are there any course topics you would like to see Schneider Electric offer in the future?
___________________________________________________________________________________________________________________________________

___________________________________________________________________________________________________________________________________

7. Further space for comments:


___________________________________________________________________________________________________________________________________

___________________________________________________________________________________________________________________________________

___________________________________________________________________________________________________________________________________

___________________________________________________________________________________________________________________________________

___________________________________________________________________________________________________________________________________

Consider suggesting different courses, different content, and variations in the depth of material or rate of flow. Please express any and all opinions you might have all comments made will help improve the training experience in future courses. Your comments may be used in future marketing material.

You might also like