Unity application generator
Download
1 / 262

Unity Application Generator - PowerPoint PPT Presentation


  • 44 Views
  • Uploaded on

Unity Application Generator. Technical Training. Contents. Options 14 Structured Data 15 Import Export 16 PLC PLC Communication 17 Net Partner Communication 18 Profibus IO HMI System Extensions 19 Generating for Vijeo Citect 20 Generating for ArchestrA 21 Generating for Monitor Pro

loader
I am the owner, or an agent authorized to act on behalf of the owner, of the copyrighted work described.
capcha
Download Presentation

PowerPoint Slideshow about ' Unity Application Generator' - palmer-duncan


An Image/Link below is provided (as is) to download presentation

Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author.While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server.


- - - - - - - - - - - - - - - - - - - - - - - - - - E N D - - - - - - - - - - - - - - - - - - - - - - - - - -
Presentation Transcript
Unity application generator

Unity Application Generator

Technical Training


Contents
Contents

Options

14 Structured Data

15 Import Export

16 PLC PLC Communication

17 Net Partner Communication

18 Profibus IO

HMI System Extensions

19 Generating for Vijeo Citect

20 Generating for ArchestrA

21 Generating for Monitor Pro

22 Generating for iFix

01 System Overview

02 System Requirements

03 Physical Model

04 Generating the PLC

05 Generating the HMI

06 Generation

07 Variable Properties

08 Template Types

09 Ethernet IO

10 Customization

11 From DFB to SCoD

12 SCoD Editor

13 Workflow


Uag v3 2 technical training

UAG V3.2 Technical Training

01 System Overview


Unity application generator as part of the solution approach
Unity Application GeneratorAs part of the solution approach

  • SoCollaborative Engineering

    • Based upon the customers standard

    • For multiple PLCs /SCADA

    • With documentation


Unity application generator customer focused system software from schneider electric
Unity Application GeneratorCustomer focused System Software from Schneider Electric

  • Reduced Cost & Project Schedules

    • System implementation cost savings

    • Reduced risk and improved project schedules.

    • Improved time to market by allowing the project to go live and give return on investment sooner

  • Improved Quality

    • Improved software quality.

    • Improved maintainability.

  • Continuous Performance Improvement

    • Standardized design and systematic improvement.

    • Reuse of Customer best practices.

Save 20-35%

on project

schedules


System software for automation the uag approach

Process Design – Think Process not PLC

Standardized approach

Application function oriented

Automation Architecture

Automation equipment and networks

Mapping to “Control Modules”/Library objects

Single data source, consistent data

Automatic Incremental Application Generation

PLC, HMI, Networking & Communications

Reuse and Continuous Improvement

Application functions

Library management

System Software for AutomationThe UAG approach…

Define

  • Customer Specification

  • Process libraries

Deploy

  • Process description

  • Automation architecture

Generate

  • PLC

  • SCADA

  • Documentation


Gamp life cycle model support by unity application generator
GAMP Life Cycle Model Support by Unity Application Generator

User Requirement

Specification

Performance

Qualification

related to

Functional

Specification

Operational

Qualification

related to

Software Design

Specification

Process control

system documentation

Validation Qualification

FAT SAT

Design

Specification

Installation

Qualification

related to

PLC/HMI

Application

Software

System

Build

Unity Application Generator

Unity Application Generator

GAMP 4.0 Supplier Guide

Good Automation Manufacturing Practice


Uag value proposition for system integrators and end users
UAG Value Propositionfor System Integrators and End Users

System Integrator

End User

… how can I reduce my engineering efforts…

… how do I keep my schedules and operational efficiency…

  • Re-using existing DFB and SCADA design elements

  • One project environment with structured approach.

  • Offering one common database for the whole project.

  • Incremental generation and network configuration.

  • Providing a guided system that forces system consistency and checks for errors.

  • Using pre-developed and tested libraries

  • Structured and uniform programming method applying EU standards.

  • Incremental modification of the applications.

  • Generation of consistent project documentation.

  • Import and export using xml formats providing flexibility of an open system.


Unity application generator linking process design and automation design

For the Process Engineer

1: Assign process functions to the UAG physical model

2: Choose the library object for each process function

For the Automation Engineer

3: Design the automation architecture in the topological model

4: Assign each process function to the relevant automation device

5: Generate the application – automatically

Unity Application Generator Linking Process Design and Automation Design

5 Step Design Process

From process design

to physical model


Process design standardized design approach

Site

Area

Process

Cell

Unit

Equipment Module

Control Module

Process Design Standardized Design Approach

Process – P&ID

UAG – Physical Model

From process design

to physical model

Created by the Process Engineer

Based on ISA-88 standard

(flexibility to customize)


Standard functional libraries
Standard Functional Libraries

Control Module

UAG Library Element (SCoD)

Library element contains:

  • PLC part

    • Control logic

    • Variables

    • Interconnections

    • Interlocking

  • HMI / SCADA part

    • Symbol

    • Status Display

    • Operator control

    • Logging, trends, alarms, ...

  • Documentation

    • Manuals

    • Data Sheets

Reflecting the needs of the process

Created by the Automation & SCADA Engineer

Motor

Application function


Automation architecture equipment and networks
Automation ArchitectureEquipment and Networks

Automation Objects

UAG: Topological Model

  • Multiple PLC

  • Multiple SCADA / HMI

  • Network Topology

  • Network Devices (Partners)

Reflecting the needs of the process

Created by the Automation Engineer


Automation architecture integrated device configuration
Automation ArchitectureIntegrated Device Configuration

UAG: Topological Model

  • Network configuration

    • Address management for Ethernet and Modbus Plus

    • PLC, PC, Panel and 3rd party devices

  • PLC Configuration

    • Unity Pro and Concept PLC platforms

    • PLC IO configuration including Hot Standby

    • Ethernet & Profibus IO configuration


Automation architecture link the control module
Automation ArchitectureLink the Control Module

Physical Model

Topological Model

Define where the

functionality is located:

- PLC

- Data Server

- HMI

- Network


Generate the application
Generate the Application

  • Single entry type for PLC/HMI database

    • Synchronized, consistent PLC / HMI databases

  • Use and re-use application objects from the library

    • Apply process context by parameterization

  • Incremental generation for PLC/HMI

    • Global resource mapping

    • PLC application (code, variables, configuration, communication…)

    • HMI application (mimics, faceplates, variables, attributes, alarms…)

    • Communication management (Ethernet, MB+)


Result of the generation example

UAG Project

SCADA Project

Unity Pro Project

Result of the GenerationExample

HMI

Network

Communication

PLC


Uag libraries built your application using what is available
UAG libraries Built your application: using what is available!

Standard Libraries shipped with UAG

Customer-Specific Libraries

Process Application Library

focused mainly on WWW

with 32 Blocks

Chengdu

Water Library

CSPEL

Water Library

Enhanced Process Library 1

focused mainly on thermal applications

with 50 Blocks

Denizli Cimento

Cement Library

Lafarge

Cement Library

Device & Process Library 1

focussed mainly on device integration

with 50 Blocks

South Africa

Mining Library

Many others..

Standard Libraries are available for the country organizations

1 Will be available in Q3 2009

Customer- Specific Libraries are developed by Schneider Electric project teams


Uag v3 2 technical training1

UAG V3.2 Technical Training

02 System Requirements


What you learn in this chapter
What you learn in this chapter

  • UAG Installation

    • Hardware and software requirements

    • Installation procedure

  • UAG Installed Package

    • Single Tools: UAG, Customization, SCoD Editor

    • Folder Structure

    • Important File Types

  • Set Up a New Project

    • Procedure

    • Files belonging to a project


Uag hardware requirements
UAG Hardware Requirements

  • Hardware

    • Pentium Processor 2 GHz or higher

    • 2048 MB RAM

    • 1 GB free space on hard disk

    • DVD-ROM drive

    • SVGA higher-resolution monitor with high color (24 bits)

    • TCP/IP compatible network adapter

  • Optional Hardware

    • Modbus Plus Adapter (PCI85)


Uag supported software platforms
UAG Supported Software Platforms

  • Operating System

    • Microsoft Windows XP

    • Microsoft Windows Vista Business

  • PLC Programming Software

    • Schneider Electric Unity Pro V4.1 (S, M, L, XL)

  • HMI & SCADA Software

    • Vijeo Citect V6.1a, V7.0 or V7.1

    • Monitor Pro V7.6

    • iFix Intellution V3.5 or V4.1

    • Wonderware ArchestrA V3.0

    • PCVue (driven by Schneider Electric France)


Uag software add on
UAG Software Add On

  • Remote IO

    • Advantys Configuration Software V4.5

  • Profibus Fieldbus

    • Sycon System Configurator V2.9 (Premium PLC)

    • ProSoft Configuration Builder V2.1.6.7 (Quantum PLC)

  • Additional Software

    • Microsoft Word 97, 2000 or 2003 to create UAG project documentation

    • Acrobat Reader for reading documentation

    • Tools as needed for displaying information, e.g. CAD etc.

    • XML viewer or editor for Import and Export files


Installation and configuration workflow
Installation and Configuration Workflow

  • Basic Installation

    • Install Unity Pro

    • Install HMI / SCADA system, e.g. Vijeo Citect

    • Install Unity Application Generator

  • Install optional packages (as needed)

    • Other HMI generator than Vijeo Citect, e.g. ArchestrA

    • Library Packages, e.g. Process Application Library (PAL)

    • Remote IO and Fieldbus configuration, e.g. Prosoft

  • Configure the system

    • Restore the library projects for Vijeo Citect


Folder structure important folders
Folder Structure & Important Folders

  • Default installation path

    • \Programs\Schneider Electric\Unity Application Generator

  • Unity Application Generator

    • Root folder with the UAG programs

    • Default Customization Files (*.osc)

  • Db

    • Default folder for SCoD-libraries (*.osl)

    • Default folder for XML stylesheets (*.xsl)

  • Vijeo Citect

    • Archived libraries for Vijeo Citect (*.ctz)

    • Use these for restoring the libraries in Vijeo Citect


Single tools of uag
Single Tools of UAG

  • Unity Application Generator

  • Application Design

  • Code Generation

  • Template Libraries

  • SCoD Editor

  • Library Definition

  • Customization Editor

  • Project settings

  • Library Selection


File types of uag
File Types of UAG

  • SCoD libraries (*.osl)

    • Contain all the information about the library objects for PLC and HMI

  • Template Types libraries (*.ost)

    • Contain all the information about template objects (combined SCoDs)

  • Customization file (*.osc)

    • Defines which SCoD libraries are used

    • Defines the naming rules for objects and variables

    • Defines the hardware to be used

  • UAG project file (*.osp)

    • Contains the project itself

    • A customization with the same name is attached to it


Setting up a new uag project
Setting up a new UAG Project

  • Define a new project

    • Start Unity Application Generator

    • Select “New” icon or chose from menu

    • Choose a Customization File

      • Should contain the required libraries and project settings

      • See chapter 10 for details, how to configure

      • Example: UAGProcessLibVCV2.0.osc

  • Save the new project

    • Save is only required after defining a new project

    • Once project is saved, UAG executes automatic save of the project

    • On save the Customization File is copied and stored together with project

    • The Customization File gets the same name as the Project File


Summary system requirements
Summary System Requirements

  • Unity Application Generator

    • Generating Code for Unity Pro

    • Generating HMI application for Vijeo Citect, Monitor Pro, iFix & ArchestrA

  • Three tools

    • SCoD Editor for Libraries

    • Customization for Project Settings

    • UAG Tool for Application Design

  • UAG Projects

    • Libraries are global (Multiple Projects)

    • Customization and Project are bound to an Application


Uag technical training

UAG Technical Training

03 Physical Model


What you learn in this chapter1
What you learn in this chapter

  • UAG Physical Model

    • Modeling and structuring the process

    • Hierarchy Levels in ISA S88

    • Types and Instances

  • Defining the Process Model

    • Equipment, Control Modules and Templates

    • Interlocks and Links

    • Variables

    • Representation in the PLC


Physical and topological model
Physical and Topological Model

  • Physical Model

    • Defines the structure according to the process

    • Default model based on ISA S88.01 hierarchy

      • Site, Area, Process Cell, Unit, …

    • Model can be defined in Customization

      • Levels according to project’s needs

  • Topological Model

    • contains the automation hardware and structure

      • PLC, HMI, Network


Hierarchy levels in physical model
Hierarchy Levels in Physical Model

ISA S88 Structure

Example

Site

Softdrinks

Area

Production

Process Cell

Ingredients

Unit

01Sugar

Equipment

Tank01A

Control Module

VA21


Structuring levels in isa s88
Structuring Levels in ISA S88

  • Site

    • Concern the organization of the enterprise

  • Area

    • Concern the organization of the enterprise

    • Sublevel of the Site

  • Process Cell

    • Contains all the Units, Equipment and Control Modules required for batch processing

  • Unit

    • Processing activities are concentrated in a Unit

    • Used for a recipe


Equipment module
Equipment Module

Equipment Module

Describes a functional group

Holds Control Modules

Level of Template instantiation

Variables can be declared

Linking to the physical Model

Allocation of the PLC

Linked to the HMI and a picture

Non ISA S88 models

Functionality of an Equipment can be set up for each hierarchy level

Control Modules can be placed all over the Physical Model


Control module
Control Module

  • Single Function of the Process

    • Physical : motors, valves, sensors, …

    • Logical: PID loops, counters, ...

  • Contains all aspects of the automation

    • PLC (DFB, EFB)

    • HMI (Symbols, Faceplates)

    • Communication relationship

    • Variables and their behaviour in the HMI

      • Alarming, Trending, Historical Data

  • Physical Model

    • Linked to one Equipment

    • Interaction with other Control Modules linked to the same or other Equipment


Template instance
Template Instance

  • Higher Level Function of the Process

    • Multiple pre-wired Control Modules

    • e.g. PID, Sequence

  • Instantiation in Physical Model

    • Template is instantiated as

      • Equipment Module

      • Couple of Control Modules

    • HMI link can be a common symbol

    • Control Modules and variables can be added to instance

  • Details see Chapter 8


Instantiation from types
Instantiation from Types

  • SCoD as Type for Control Modules

    • SCoD: Smart Control Device

    • Type definition of a Control Module

    • Member of a Library

    • Designed in the SCoD-Editor

      • based on a DFB or EFB

      • contains an HMI representation (symbol, behaviour)

      • definition of variables and pin usage

      • definition of communication, alarming etc.

    • After design the SCoD is committed for use


Process application library
Process Application Library

  • SCoDs from the standard UAG Process Application Library

  • Motor & Valves

  • CRKBRK_P20 Circuit Breaker

  • VALMO_P20 Monostable Valve

  • VALBI_P20 Bistable Valve

  • VALPRO_P20 Proportional Valve

  • MCCDOL_P20 Direct Online Starter

  • MOT1D1S_P20 Motor 1 Direction 1 Speed

  • MOT1D2S_P20 Motor 1 Direction 2 Speed

  • MOT1DVS_P20 Motor 1 Direction 2 Speed

  • MOT2D1S_P20 Motor 2 Direction 1 Speed

  • MOT2D2S_P20 Motor 2 Direction 2 Speed

  • MOT2DVS_P20 Motor 1 Direction 2 Speed

  • Standard Functions

  • COUNTER_P20 Counter

  • HOURMET_P20 Hour Meter

  • INTERLCK_P20 Interlock

  • ADD4_P20 Math - Adding

  • MUL4_P20 Math - Multiplying

  • OPMODE_P20 Operation Mode

  • TIMER Timer

  • Inputs & Outputs

  • DIGIN_P20 Digital Input

  • DIGOUT_P20 Digital Output

  • ANAIN_P20 Analog Input

  • ANAOUT_P20 Analog Output


Process application library1
Process Application Library

  • SCoDs from the standard UAG Process Application Library

  • Control Functions

  • DIGICONT_P20 Digital Controller

  • PIDCTRL_P20 PID Controller

  • PIDCTRLAD_P20 Advanced PID Ctrl.

  • SCHEDULER_P20 Scheduler

  • RCONBAT_P20 Batch Ratio Ctrl.

  • RCONCON_p20 Continuous Ratio Ctrl.

  • SEQUENCE_P20 Sequencer

  • TOTALIZER_P20 Totalizer

  • Process Specific

  • PUMSEL_P20 Pump Selection

  • TANKCTRL_P20 Tank Control

  • Schneider Devices

  • MOTATV_P20 ATV31/61/71

  • PM700S_P20 Power Meter

  • ION73_P20 Energy Meter

  • TESUIO_P20 TeSys U

  • PLCSTAT_P20 PLC Diagnostics


Representation of physical model
Representation of Physical Model

  • Representation of Area, Process Cell, Unit

    • PLC: groups in the Unity Pro project browser(same structure as in UAG)

    • HMI: no equivalent

  • Representation of Equipment and Control Modules

    • PLC

      • One Equipment = One Section

      • One Equipment and all its Control Modules are usually assigned to the same PLC

    • HMI

      • An Equipment can be freely assigned to a picture of the HMI

      • One picture can contain more than one Equipment

      • The equipment and all its Control Modules are usually assigned to the same picture


Create a level in the physical model
Create a Level in the Physical Model

  • Area, Process Cell & Unit

    • Select “New …” from context menu

    • Enter a (unique) name

    • Enter a description


Create an equipment module
Create an Equipment Module

  • Equipment Module

    • Select “New …” from context menu

    • Enter a name and a description

    • Section name is derived from Name

    • PLC and HMI link is set after the Topological Model is defined


Create a control module
Create a Control Module

  • Control Module

    • Select “New …” from context menu

    • Select needed SCoD-Type form Pop Up

    • Enter a name and a description

    • Instead of using the context menu, drag & drop the SCoD from the library Window


Interactions of control modules
Interactions of Control Modules

  • Links

    • connection to variables or other Control Modules

    • represented by link lines in the PLC program(in the same section only)

    • used on unconnected input pins

    • simply created by drag and drop of variables

  • Interlocks

    • definition of interlock logic for a single input pin

    • only for Control Modules with interlock input pin defined in the SCoD Editor (e.g. MOT1D1S)

    • device can have one or more interlocks

    • created by defining a logical condition of variables


Definition of an interlock
Definition of an Interlock

  • Define an Interlock

    • Select “Open Interlock” from context menu

    • Place Function Blocks as needed

    • Link blocks as needed

    • Open Variable Browser from context menu

    • Drag & drop variables to pins

    • Connect last output to the Interlock Input

    • Apply interlock


Interlock representation
Interlock representation

  • Interlock representation

    • generated code in Unity Pro similar to the code in UAG

    • indicated as Comment box in front of the function block


Variables in uag
Variables in UAG

  • Come along with the Control Module

    • they are automatically generated during instantiation

  • Additional Variables can be defined in UAG for

    • Equipment Modules

    • Control Modules


Variable representation in plc and hmi
Variable Representation in PLC and HMI

  • Standard Name Creation Rule

    • Control Module Level

      • Concatenation of the variable and two parent objects

      • EQname_CMname_VARname

    • Equipment Module Level

      • Concatenation of the variable and one parent objects

      • EQname_VARname

  • Other Name Creation Rules

    • Naming rules can be set up in the Customization using all levels of the Physical Model, either the complete name or a part of it

    • Maximum length of 32 characters in Unity has to be respected

      Declaration : EQ – Equipment Module, CM – Control Module,VAR – Variable


Variable declaration
Variable Declaration

  • Variables can be defined in UAG for

    • Equipment Modules

    • Control Modules

  • Declare a variable

    • Select “Open Variable” from context menu

    • Select “New” from context menu in the variable browser

    • Define properties for new variable (see next slide)

    • Apply new variable


Variable basic properties
Variable Basic Properties

  • Name

    • Name of the variable

  • Data Type

    • must be defined for each variable,e.g. Bool, Word, Byte, Int, Real, Time, User defined DDTs,..

  • Connection Type

    • part of the application, where the variable is used (see next slide)

  • Initial Value / Update initial Value

    • an initial value can be assigned

  • Update Initial Value

    • Graphic representation of the variable in the SCADA (HMI variables only)


Variable connection types
Variable Connection Types

  • PLC

    • used PLC internal only

  • IO_PLC

    • variable is used within the PLC logic

    • and connected to an I/O point of the PLC

  • HMI

    • used HMI internal only

  • PLC_HMI

    • variable is used in the PLC and the HMI

    • communicated between both

  • PLC_NET

    • variable is communicated between the PLC and a network node, e.g. hand- held panel

Note:

With Unity Application Generator all variables are defined only once and are automatically generated in all of the systems, in which they are needed.


Summary physical model
Summary Physical Model

  • Structuring the process

    • Ordering the process in a hierarchy

    • based on ISA S88, but freely adjustable

    • Area, Unit, Process Cell, Equipment, Control Module

  • Functionality of the process

    • Single function represented by Control Module

      • Type definition done as SCoD

      • Linked to DFB for PLC code

      • Linked to an HMI representation

    • Interaction of Control Modules done by

      • Links (single connection to a variable)

      • Interlocks (condition set of variables)

    • Variables

      • bound to a Control Module (defined in SCoD)

      • freely added on Equipment and Control Module level


Uag technical training1

UAG Technical Training

04 Generating the PLC


What you learn in this chapter2
What you learn in this chapter

  • UAG Topological Model

    • Structure the Automation Platform

    • Define Network and link devices

    • Define and configure a PLC

  • Generate a PLC program

    • Assign a PLC to the Physical Model

    • Assign IO points

    • Analyze the project

    • Generate PLC code


Physical and topological model1
Physical and Topological Model

  • Physical Model

    • Defines the structure according to the process

    • Default model based on ISA S88.01 hierarchy

      • Site, Area, Process Cell, Unit, …

    • Model can be defined in Customization

      • Levels according to project’s needs

  • Topological Model

    • contains the automation hardware and structure

      • PLC, HMI, Network


Elements of the topological model
Elements of the Topological Model

  • Build the control hardware architecture

    • Network Segments

      • Network Segments (Ethernet /MBP)

    • PLC

      • Unity PRO with Premium / Quantum / M340

    • Data Server / HMI

      • Vijeo Citect

      • ArchestrA, Monitor Pro, iFIX

      • Generic

    • Network Nodes

      • Netpartner devices for data exchange

  • Defines resources used by the physical model


Configuring the network
Configuring the Network

  • Network Segments

    • Basic elements of the communication architecture

    • Definition of the used different Networks

    • Possible Network Types are

      • Modbus Plus

      • Ethernet

    • nodes like PLC, HMI, Data Server and Net Partners are attached to one or more Network Segments.


Network Segments and Routing

  • Network Segment

    • a single network line of a defined type

      • Modbus / TCP

      • Modbus Plus

    • with the full range of addresses available.

  • Routing Path

    • connections between different network segments

    • via bridges or routers

    • used only for Modbus Plus


Configuring the plc
Configuring the PLC

  • PLC

    • Modules and Racks are edited in UAG

    • Is assigned to Equipment modules

  • PLC Configuration

    • Definition of the Racks and Modules

    • Assign network addresses

      • CPU and communication modules

    • Definition of communication Channels

      • Communication to PLC, Data Server, Net Partner

  • Module Configuration

    • Assign variables for I/O-Modules

    • Failure behavior for Output Modules

    • Import of fieldbus configuration


Adding a new plc

Define a PLC

Select “New PLC” from context menu

Enter a name and a description

Project name is derived from PLC name

Open Variable Browser from context menu

Select PLC Family, the rack size and the CPU type

Apply PLC

Adding a new PLC


Selecting slot cards for a plc
Selecting Slot Cards for a PLC

  • Adding Slot Modules

    • Select “Open Rack” from context menu of the rack

    • Select for each slot of the rack the module category and the module itself

  • Adding Extension Racks

    • If an extension rack is required, add the expander module to the local rack and choose “New extension Rack” from the context menu of the rack


Properties of a plc
Properties of a PLC

  • Network Addresses

    • Under properties of the CPU or any other network interface card the network addresses can be entered

  • Memory Layout

    • Under properties of the PLC the memory usage can be defined in terms of size and area, e.g. for IO cards HMI exchange etc.


Assign equipment to plc
Assign Equipment to PLC

  • Assign PLC

    • Select “Properties” from context menu of Equipment

    • Select PLC from list in properties dialog

    • Apply selection


Assigning io variables to plc
Assigning IO variables to PLC

  • Assigning IO variables

    • Select “Open Variables” on context menu of Equipment or Control Module

    • Apply filter on IO_PLC type in variable browser

    • Select “Open IO Points” from context menu of slot card

    • Drag and drop IO_PLC variables from variable browser to the IO points of the slot card


Generate the plc
Generate the PLC

  • Generate PLC

    • Open UAG project exclusively

    • Select “Analyze” from the generation menu and analyze your project

    • Check for relevant errors and correct them(a double click on the message leads to the dialog where to correct)

    • Start the generation from the “Generate” menu


Summary generating the plc
Summary Generating the PLC

  • Topological Model

    • Structures the needed Automation Platform

    • Linked to the process (Physical Model)

    • Network and Communication

    • PLC including (remote) IO

  • Generating the PLC

    • Assign Equipment Module to a PLC

    • Link IO signals to hardware

    • Analyze project

    • Generate PLC project


Uag technical training2

UAG Technical Training

05 Generating the HMI


What you learn in this chapter3
What you learn in this chapter

  • UAG Topological Model

    • Data Server and HMI

    • Control Domains and Pictures

    • Communication: Channels and Frames

  • Generating the HMI

    • Assigning a Control Domain and a Picture

    • Analyze the project

    • Generate the HMI (and the PLC)


Generating for the hmi overview
Generating for the HMI Overview

  • HMI Configuration

    • Data Server

    • HMI, Control Domain and Pictures

  • PLC- HMI communication

    • Communication between PLC and Data Server

    • Communication Channel with frames inside

    • Assigning frames to variables of type PLC_HMI

  • HMI Properties of variable type PLC - HMI

    • Alarm Definition

    • Archives

    • Display Format for analog Values

    • Free Properties


Configuring the Data Server

  • Interface between the PLC and the HMI application

  • A PLC is connected to one Data Server only, but a Data Server can have multiple PLC

  • Communicates PLC_HMI variables defined in the UAG project

  • More than one Data Sever may be configured

  • Not directly linked to the Physical Model

  • Is represented by an IO Server in Vijeo Citect

HMI B

HMI A

PLC 1

PLC 2

Data Server

1 Data Server per PLC

Modbus TCP / OFS


Adding a new data server
Adding a new Data Server

  • Add a Data Server

    • Select “New Data Server” from context menu

    • Enter a name

    • Switch to Network-Tab

    • Select network type and segment and enter a network address

    • Optionally configure redundant connection and redundant server

    • Apply Data Server


Communication channel
Communication Channel

  • Definition

    • bound to a PLC and enables communication between:

      • PLC and 1 Data Server (HMI)

      • PLC and PLC

      • PLC and Net Partner

    • defines the communication path between partners and alternative path

    • defines objects to be exchanged

      • frames for PLC - Data Server communication

      • variables for PLC – PLC communication.

      • variables for PLC – Net Partner communication

  • Communication is always bound to a PLC!


Plc to data server channel
PLC to Data Server Channel

  • Frames

    • Organization of PLC_HMI variables according to the data type (the frame is a property of the variable)

    • Communication frames are defined in the SCoD Editor or in the Customization

    • Frames are defined as read-write or read-only for different data types

  • Transport

    • Via located variables or OPC server

    • from HMI to the PLC

      • operator inputs are transmitted immediately

    • from the PLC to the HMI

      • refresh rate is configured in the Data Server application, i.e. Vijeo Citect’s IO Server


Create a new channel
Create a new Channel

  • Add a Channel

    • In the context menu of the PLC select “Open Channels”

    • In the context menu of the Channels select “New”

    • Define a name for the channel

    • Set the type, the partner, the path and the timeout

    • Define optionally a redundant path

    • Apply Channel


Memory assignment for frames
Memory Assignment for Frames

  • Memory Assignment

    • Open Channel

    • Press default button to assign memory

    • Check, if %Used is not above 100% for any frame

    • Adjust addresses and length manually, if necessary


HMI, Control Domain and Pictures

  • HMI

    • HMI application as operator front-end

    • Represented as Vijeo Citect project

  • Control Domain

    • Splits an HMI application into several areas

    • Alarms are linked to a Control Domain

    • Can be used for operator access rights

    • Represented as Area in Vijeo Citect

  • HMI Picture Definition

    • HMI Pictures are organized in picture groups

    • Pictures are member of a picture group

    • Pictures are assigned to Equipment Modules


Add a new hmi and control domain
Add a new HMI and Control Domain

  • Add HMI

    • Select “New HMI” from context menu

    • Enter a name

  • Add a Control Domain

    • Select “New Control Domain” from context menu

    • Enter a name and a description


Add a picture group and pictures
Add a Picture Group and Pictures

  • Add a Picture Group

    • Select “Open Pictures” from context menu

    • Select “New Picture Group” from picture’s context menu

    • Enter a group name

  • Add a Picture

    • Select “Open Pictures” from context menu

    • Select “New Picture” from the group’s context menu

    • Enter a picture name


Assign equipment to hmi and picture
Assign Equipment to HMI and Picture

  • Assign HMI and Picture

    • Select “Properties” from context menu of Equipment

    • Select Control Domian from list in properties dialog

    • Select Picture from pop up window

    • Apply selection


Generate the hmi
Generate the HMI

  • Generate HMI

    • Open UAG project exclusively

    • Select “Analyze” from the generation menu and analyze your project

    • Check for relevant errors and correct them

    • Start the generation from the “Generate” menu

  • Consistency

    • Generate as well the PLC to be sure that HMI and PLC are consistent


Summary generating for the hmi
Summary Generating for the HMI

  • SCADA and HMI in the Topological Model

    • Data Server and HMI server functions

    • HMI including Control Domain and Pictures

  • Communication

    • between PLC and Data Server is done by Channels

    • Channels consist of different frames

    • Variables of type PLC_HMI are assigned to frames

  • Generating for the HMI

    • Assign Equipment Module to a Control Domain and Picture

    • Analyze project

    • Generate HMI and PLC (!) project


Uag technical training3

UAG Technical Training

06 Generation


What you learn in this chapter4
What you learn in this chapter

  • Generation for PLC and HMI

    • What is generated?

    • Different Types of Generation

    • Objects to be generated

    • Analyzing the Project

    • Memory Mapper

  • UAG Documentation

    • Change History

    • Generating Documentation

    • Backup and Restore


General information
General Information

  • Generation for the PLC

    • Unity Pro

    • Premium, M340 and Quantum PLC

    • Configuration, Variables and Code

  • Generation for the HMI

    • Vijeo Citect V7.0 / V7.1 , Monitor Pro V7.6 , ArchestrA V3.0, iFIX V3.5

    • tags and graphics

    • communication, alarms, data logging

  • Generation of Export files

    • XML-file with all information about the UAG project

      • for usage with unsupported HMI systems, e.g. by import

      • as additional information for supported HMI systems

    • transformable with the usage of style sheet XSL-files


Generation for the plc
Generation for the PLC

  • PLC configuration

    • Hardware Configuration

    • Configuration of Communication, e.g. Ethernet

    • PLC memory managing

  • All variables

    • All variables including addresses and comments

  • PLC Program Code

    • For program initialization & analog scaling

    • For communication channels & remote IO

    • Code for Control Modules

    • Interlock logic for Control Modules

    • Links between Control Modules


Generation for hmi vijeo citect
Generation for HMI (Vijeo Citect)

  • One Vijeo Citect project for each configured HMI

    • One Page for each defined picture in UAG

    • Picture contains Genie instances for all Control Modules linked to the picture via the Equipment

  • One Cluster for each configured HMI

    • Name of the HMI

    • Alarm, Trend and Report server are derived from the cluster

    • Alarm Handling & Trending

  • One IO Server for each configured Data Server

    • All tags communicated between HMI and PLC (PLC_HMI) on regular IO Device

    • All HMI internal tags (HMI) on a Disk Device

    • PLC Communication (Boards & Ports)


Generation for the monitor pro hmi
Generation for the Monitor Pro (HMI)

  • One Server Application for each configured data server

    • All tags communicated between HMI and PLC (PLC_HMI)

    • All HMI internal tags (HMI)

    • PLC Communication

    • Alarm handling

    • Data logging

  • One Client Application for each configured HMI

    • One Mimic for each defined picture in UAG

    • Picture contains symbols for all Control Modules linked to the picture


Generation for the archestra hmi
Generation for the ArchestrA (HMI)

  • UAG application is transferred into the specified Galaxy

    • Physical Model is transferred into the Galaxy with the same structure

    • Dedicated templates can either exist or will be created in the Galaxy

    • All communicated tags (PLC_HMI) and HMI internal tags (HMI)

      • Alarm handling

      • Data logging

      • Additional Properties

  • One OPC Client for each configured data server

    • All tags communicated between HMI and PLC (PLC_HMI)

    • PLC Communication


Generation for the generic hmi
Generation for the Generic HMI

  • Generic HMI

    • a XML-file with complete information about the UAG project

    • a file with a format specified by a style sheet XSL-file

      • e.g. CSV, HTML

      • contains a subset of the XML-file in the specified format

    • used export formats are entered in the customization

  • Net Partners

    • a CSV-file containing all variables related to a Net Partner

    • can be used as import file for the net parter software


Types of generation
Types of Generation

  • COMPLETE

    • first generation

    • if selected before generation

    • existing code for the PLC and / or HMI will be overwritten

  • INCREMENTAL

    • Only the modified part of the UAG project is generated

    • existing PLC and HMI application will be updated

GENERATION

The generated code has to be completed by the control engineer afterwards in order to build the complete control application.


Complete and incremental generation
Complete and Incremental Generation

  • Complete Generation

    • First generation (required for a new project)

    • Can be forced for an existing project for Memory Mapper, PLC or HMI

    • Necessity to “download” to the PLC (STOP mode)

      All additional programming in the PROJECT is DELETED, but stored in a Backup file!

  • Generation Incremental (default mode)

    • After modifications in UAG in an existing project

    • “Download Changes” to the PLC (RUN mode)

      • Only possible, if NO modification in the hardware configuration

      • and if address ranges are not modified (length and start address)


Open project
Open Project

  • Open Project

    • Work on the project: add, modify, delete

    • Project can be opened by more than one user

    • Analyze the project: Customization and Project

      Nothing can be generated

  • Open Exclusive

    • Project can be opened by only one user

    • Analyze the project Customization and Project

    • Code generation

      Execute Memory Mapper

      Application Generation / Modification for PLC and HMI


Options for generation
Options for Generation

  • Options

    • Select from menu “View\Options”

    • Set path for generated code / files

    • Select complete generation for next generation

    • Diverse settings for HMI system (dependant on Type)

  • Handling

    • Should be set at the beginning of the project

    • Exception: Complete generation is set when needed


Objects to be generated
Objects to be Generated

  • Lists of Objects to be generated

    • Select from the menu “File\Properties”

    • At the bottom of the newly opened window lists can be opened for objects to be generated for PLC, Data Server and HMI.

    • Especially useful when the PLC or HMI generation throws a warning that there are objects left for generation.

  • Used Types

    • Lists can be opened for SCoDs, Templates and HW modules


Analyze customization project
Analyze Customization & Project

  • Analyze Customization

    • Done when project is opened and the customization file has changed (automatically detected by UAG)

    • Analyzes what is non compatible in the project

    • Detected errors have to be fixed manually

  • Analyze Project

    • Analyzes the project and checks all errors and warnings

    • Warnings and errors don’t inhibit the generation, except

      • path non-existent

      • memory layout too small

    • Errors are excluded from generation

    • Ojects declared as “not assigned” cause a warning message

    • Errors can be reached by a double click on the error message


Configure analyze project
Configure Analyze Project

  • Analyse Project Options

    • Open the “Options” dialog to configure the analyzer (Menu “View\Options”)

    • Select “Analyze Project”

    • Configure as needed

  • How to fix errors or warnings

    • Double click on the message: UAG opens the error causing dialog

    • Directly from the Physical or Topological Model e.g., for mapping of I/O points


Memory mapper
Memory Mapper

  • Configuration for address ranges

    • Individually for each PLC

    • IO modules and IO variables

    • PLC_HMI variables

    • PLC_NET variables

  • Configure Memory Mapper

    • Default values in the addresses tag (properties of each PLC)

    • Start address and length can be modified

    • Column “Current Length” shows usage of each address range


Change history
Change History

  • Change logging

    • Select from menu “File\Change History”

    • Window lists all modifications done in the UAG project

      • Who & When

      • Changed Objects

      • Type of Change

      • Old & new value

    • Cannot be modified

    • Report and Export are possible


Generate documentation
Generate Documentation

  • Generate a Documentation

    • Select from menu “File\Report”

    • Define a template file

    • Define a report file

    • Select the contents

    • Start the Report


Backup and restore
Backup and Restore

  • Setting Up an Archive

    • Select from menu “File\Versions”

    • In versions window select “Save now”

    • Enter a name and a comment and select the contents of the archive

    • Apply Archive

  • Version Management

    • Done from Versions window

    • Especially delete and restore a version


Backup and restore1
Backup and Restore

  • Restoring an Archive

    • Select from menu “File\Versions”

    • In versions window select the archive to be restored Restore(if no UAG project is opened the archive folder can be selected)

    • Chooses location for restoring and the contents to be restored

    • Apply Restore

  • Remark

    • Vijeo Citect project is always restored in the Vijeo Citect user directory


Summary generation
Summary Generation

  • Generation for PLC and HMI

    • Complete and Incremental Generation

    • PLC: configuration, variables, program code

    • HMI: variables, alarms, pictures and symbols

    • Memory mapping for PLC

    • Communication: PLC to HMI, IO, PLC and Net Partner

  • Workflow

    • Analyze Project

    • Correct errors and warnings as necessary

    • Open project exclusively

    • Run generation (PLC and HMI)

    • Add code for PLC and HMI as necessary


Uag technical training4

UAG Technical Training

07 Variable Properties


What you learn in this chapter5
What you learn in this chapter

  • Generation for PLC and HMI

    • What is generated?

    • Different Types of Generation

    • Objects to be generated

    • Analyzing the Project

    • Memory Mapper

  • UAG Documentation

    • Change History

    • Generating Documentation

    • Backup and Restore


Property page for variables
Property Page for Variables

  • Variables for the HMI

    • Connection type

      • HMI: Variable only available in the HMI

      • PLC_HMI: Variable available in PLC and HMI

    • 8 categories of properties

      • Basic

      • Communication

      • Alarm

      • Command

      • Archive

      • Display

      • Free

      • Usage


Variable properties
Variable Properties

  • Properties Origin

    • Properties can be already set in the SCoD Editor

    • Change and visibility can be restricted in the SCoD Editor

    • Values of Pop Ups are edited in the ScoD Editor or the customization

  • Properties availability

    • Availability of single property depends on data type, connection type

      • E.g., PLC connection type does not have alarm properties

      • E.g., BOOL type data type does not have display properties

    • Accessibility can be restricted in the SCoD editor


Basic properties
Basic Properties

  • Name and Description

  • Data Type

    • must be defined for each variable,e.g. Bool, Word,..

  • Connection Type

    • for HMI: HMI or PLC_HMI

  • Initial Values

    • an initial value can be assigned

  • Graphical Symbol

    • define a symbol used in the HMI to display the variable

  • Dead Band

    • Suppressing an update of the value, if the change is within the dead band


Communication properties
Communication Properties

  • PLC-PLC Channels

    • Allows to communicate the variable between PLC

  • Failure state

    • Allows to set a value, when the communication fails

  • Communication frame

    • Select frame for transfer between PLC and Data Server


Alarm properties
Alarm Properties

  • Alarm

    • Defines, if an variable is an alarm

    • Values: Not assigned, yes, no

  • Alarm Group

    • Defines the alarm group the alarm belongs

  • Alarm List

    • Defines the alarm condition

    • Sets the alarm text to be displayed in the operator screen

    • Sets the priority depending on the used HMI system

    • Multiple alarms can be defined


Command properties
Command Properties

  • Command

    • Only available for In and In/Out variables

    • Defines the origin of an command, e.g. from the Operator

  • Access level

    • Required access level in the HMI to modify the value, e.g., Operator, Maintenance, Supervisor etc.

    • Levels are defined in the customization or SCoD-Editor

  • Remark

    • Only used with iFix


Values of command option

Possibility

ViewOnly

EQ_CM

FB

Possibility

EQ_CM_Var1

Var1

Logic

Operator

Parameter

Constant

EQ_CM

FB

EQ_CM_Var1

Var1

Values of Command Option

  • View Only

    • Value is only displayed in the HMI

    • Operator cannot change the value

  • Logic

    • Value is displayed in the HMI

    • Operator cannot change the value

    • Value comes from logic command in the PLC

  • Operator, Parameter

    • Value is displayed in the HMI

    • Can be modified by the operator

  • Literal

    • Value is a constant and cannot be modified


Example for command option

EQ_CM

FB

Possibility

Possibility

Logic

C_Var1

Logic

H_Var1

EQ_CM_Var1

Possibility

Different

Access Levels

EQ_CM_Var2

C_Var2

Operator

Parameter

H_Var2

EQ_CM_Var2

C_Var3

Possibility

16#F876

H_Var3

Constant

EQ_CM_Var3

Example for Command Option

  • Use of different Command Options

    • for In/Out variable type

    • additional information for the operator


Archive properties
Archive Properties

  • Archive Properties

    • Vijeo Citect: Definition of Trends

    • ArchestrA, Monitor Pro: Definition of Archiving

  • Archive

    • Defines if a variable is archived

  • Archive Name

    • Sets the archive name that is defined in the Customization

  • Sample Rate

    • Sets the sample rate of the Trend / Archive


Display properties
Display Properties

  • Display Format

    • Sets the format how the variable is displayed in the HMI

  • Unit Group, Unit

    • Sets the engineering unit of the variable

  • Scaling Min, Max

    • Sets the scaled range in the HMI

  • Boundary Min, Max

    • Sets the range for operation

  • Raw Min, Max

    • Sets the raw value range in the PLC


Display properties1
Display Properties

Unit

(list in Customization)

Display Format

(list in Customization)

10.0

15.0

85.0

90.0

°C

Analog

Value

 

 

Scaling min

Boundary min

Boundary max

Scaling max

Operator range

Value range ( HMI display )

Raw min

Raw max

Remark: If scaling is done in the PLC, raw values can be left empty


Free properties
Free Properties

  • Free Properties

    • up to 20 properties to be freely assigned

    • can be used for HMI properties not specified in UAG

      • e.g. attach variable to report

      • e.g. configure trending

    • Evaluation is usually done via export of the Generic HMI


Usage properties
Usage Properties

  • Usage

    • Not a property, but a cross-reference, where a variable is used


Control module properties
Control Module Properties

  • Summary of Variable Properties

    • Most important Variable Properties are summarized in the Control Module Properties

    • Definition is done in the SCoD Editor

  • Idea of full configuration of Control Module

    • All relevant parameters are there

    • Ordered in different tabs

    • Easy to access and to modify

    • Access via context menu “Properties”


Add a variable
Add a Variable

  • Add a Variable

    • Open Variable Browser from context menu of the tree

    • Select “New” from context menu of the Variable Browser

    • Define the variable, at least:

      • Name

      • Description

      • Connection Type

      • Type

    • Apply Variable


Summary variable properties
Summary Variable Properties

  • Properties of HMI variables

    • Variable types PLC_HMI and HMI

    • Alarm definition and assignment

    • Possibilities of Operator interaction

    • Archive and Trending (storage of historical values)

    • Display and measurement unit

    • Free properties


Uag technical training5

UAG Technical Training

08 Template Types


What you learn in this chapter6
What you learn in this chapter

  • Template Types

    • Pre-defined higher level functions

    • Organized in Libraries

    • Setting up a Library and Template Types

    • Change Propagation of Template Types

  • Template Instances

    • Instantiating a Template

    • Linking to the Topological Model

    • Additional Control Modules and Variables

    • Handling of Change Propagation


Template types and instances
Template Types and Instances

  • Template Types

    • Pre-defined higher level functions, e.g. PID Control, Sequence

    • Combination of multiple Control Modules with

      • Variables and Properties

      • Pre-wired Links and Interlocks

      • Common or single HMI symbols

    • Organized in Libraries

  • Instances

    • Instantiation on Equipment Level

      • As Equipment and Control Modules

      • Naming of Equipment is applied

    • Wiring of the open Links and Interlocks

    • Connection to the Topological Model


Add a template library
Add a Template Library

  • Add a Template Library

    • Select “New Template Library” from Template Libraries’ context menu

    • Enter a name and a description

    • Apply Template Library

  • Remarks

    • A new Template Library can also be added from the Customization

    • Existing Libraries can be opened in the UAG project and included.


Add a template type
Add a Template Type

  • Add a new Template Type

    • Select “New Template Type” in the context menu of the library

    • Enter a name and a description

    • Select the HMI Symbol

      • HMI symbol of template: A common symbol (Genie) for the entire template

      • HMI symbol of members: The symbols (Genies) of the single member Control Modules are used

    • Optionally add a help file

    • Apply the Template Type


Add members to template type
Add Members to Template Type

  • Add a Control Module Member

    • Select “New Control Module” from the type’s context menu

    • The dialog opened is the same as for regular Control Modules in the Physical Model

    • Select the SCoD type, enter a name and description

    • Set the properties of the Control Module as necessary

    • Apply the Control Module


Properties of a template type
Properties of a Template Type

  • Template Properties

    • Allow quick configuration of Template instances (like Control Module Properties)

  • Add Properties to the Type

    • Select “Open Property List” from type’s context menu

    • Select “add from Member Control Modules”, if an existing property should be visible on Type level

    • Select “New” from context menu of the property list, if property that does not exist for a Control Module should be created


Properties of a template type1
Properties of a Template Type

  • Add existing Property

    • Select “Add from Member…” in property list’s context menu

    • Select the properties that should appear on the level of the Template

    • Name of the Tab and Position on the Tab can be adjusted in the property list


Properties of a template type2
Properties of a Template Type

  • Add new Property

    • Select “New” in property list’s context menu

    • Select the variable and its property that should become a Template property

    • Enter a caption name for the property

    • Name of the Tab and Position on the Tab can be adjusted in the “Position” tab

    • Apply Property


Links and interlocks in template types
Links and Interlocks in Template Types

  • Links

    • Links of member Control Modules can be pre-wired with all variables that exist inside the Template Type

    • New Variables can be defined on Template or member level

    • Workflow is the same as for regular Links

  • Interlocks

    • Interlocks of member Control Modules can be pre-wired with all variables that exist inside the Template Type

    • New Variables can be defined on Template or member level

    • Workflow is the same as for regular Links

    • An Interlock must be fully configured. It is not possible to keep function block connections open that are set in the instance


Connection to the topological model
Connection to the Topological Model

  • Template Type

    • There is no link to the Topological Model

  • Template Instances

    • On instantiation, or later via Equipment properties can be set

      • The executing PLC

      • The HMI/Control Domain and the Picture

    • Once a PLC is set the IO signals can be assigned

    • There is no difference in Workflow compared to a standard Equipment


Save a template library
Save a Template Library

  • Save a Template Library

    • In opposite to the rest of a UAG project a Template Library has to be saved

    • A modified and unsaved Library is indicated by an asterisk

    • In the UAG project always the last saved version is applied

    • Changes are propagated to the instances

    • For save use “Save” from context menu of the Template Library


Instantiate template type
Instantiate Template Type

  • Instantiate a Template

    • Select “New Equipment” in context menu of Physical Model

    • Checkmark “Use Template” and select the Template

    • Enter a name and a description

    • Optionally assign PLC and HMI

    • Set the Template’s properties

    • Apply Template


Instantiate template type1
Instantiate Template Type

  • Appliance of Naming Rules

    • When the Template is instantiate the following dialog is popped up

    • Instance names can be adjusted according to the needs

    • Instance names must be adjusted according to the naming rules

    • The checkmark indicates a valid name according to the rules


Use instantiated template
Use instantiated Template

  • Interlocks, Links

    • Interlocks and Links can be defined with the standard workflow for Control Modules

    • Only those Interlocks and Links can be defined that were not defined in the Template Type definition

    • Already in the Type defined Interlocks and Links do not appear in the lists of Interlocks and Links

  • Connection to the Topological Model

    • The connection to the Topological Model is done in the same way as for standard Equipment and Control Modules, i.e.

      • Assigning of PLC, HMI and Picture in the Equipment

      • Assigning of IO_PLC variables to the IO cards


Additional control modules variables
Additional Control Modules & Variables

  • Additional Control Modules

    • Additional Control Modules can be added to a Template Instance

    • They are not part of the Template instance but displayed on the same HMI picture

  • Additional Hierarchy Elements

    • If the definition of the Physical Model allows additional hierarchy levels can be added to a Template Instance

  • Color Indication

    • Template Instances are displayed in blue, standard instances are displayed in black

    • There is no color indication for Variables


Modification of template type
Modification of Template Type

  • Modifications of Template Type

    • Template Types can be modified

    • Modifications are applied to the instances when the library is saved

  • Impact on Instances

    • A dialog is popped up that list all affected instances and the changes done

    • The user can decide if the particular instance is updated, deleted or disconnected

    • In case of disconnection the instances are converted to regular Equipment and Control Modules

    • There are cases where an update of particular instances is not possible due to name conflicts, e.g. an additional Control Module exists with the same name


Define template types by drag drop
Define Template Types by Drag & Drop

  • Drag & Drop from Physical Model

    • Existing Equipment with Control Modules can be dragged to a Template library node

    • User is asked for a name and description

    • All links to the Topological Node are stripped

    • All references that are outside the Equipment and the Control Modules are stripped, e.g.

      • A Link Variable that is not part of the Equipment

      • Interlocks that use those Variables

    • New Template Type gets created and has to be saved


Reference existing template libraries
Reference Existing Template Libraries

  • Existing Libraries

    • Existing libraries can be opened via the context menu

  • Include

    • To use an existing library it has to be included into the project via the context menu

  • Exclude

    • An included library can be excluded via the context menu

  • Read only

    • Only the first UAG project that opens a library gets the write access


Summary template types
Summary Template Types

  • Template Types

    • Combination of multiple Control Modules with

      • Variables and Properties

      • Pre-wired Links and Interlocks

      • Common or single HMI symbols

    • Organized in Libraries

    • Changes are propagated

  • Instance

    • Instantiation on Equipment Level as Equipment and Control Modules

    • Wiring of the open Links and Interlocks

    • Connection to the Topological Model

    • Propagated Changes can be applied or Instance is disconnected


Uag technical training6

UAG Technical Training

09 Ethernet IO


What you learn in this chapter7
What you learn in this chapter

  • Ethernet IO Points

    • As Ethernet IO Rack for single Ethernet IO modules, e.g. Momentum

    • As Ethernet IO Device for Advantys STB

    • As Modbus IO Rack for Modbus Gateways

    • As Profibus IO Rack for Profibus Gateway ( described with Profibus IO)

  • Handling in UAG

    • Linked to a particular Ethernet Interface, e.g. NOE, ETY, CPU

    • Memory assignment is done by Memory Mapper

    • IO Scanner entries are generated for Unity Pro

    • Code for data exchange and variable assignment is generated


Add ethernet io rack
Add Ethernet IO Rack

  • Ethernet IO Rack

    • An Ethernet IO Rack allows the data exchange with IO modules that have a fixed IO map and an own IP-address

  • Add an Ethernet IO Rack

    • In context menu of the PLC select “New Rack”

    • Set Link Type to Ethernet IO and Rack type Ethernet IO

    • The Head Slot offers all slots that are equipped with an Ethernet Interface, select one

    • Apply Rack


Add io modules to an ethernet io rack
Add IO Modules to an Ethernet IO Rack

  • Populate the Rack

    • The rack is populated in the same way as the PLC Rack

    • UAG offers all Ethernet Momentum IO and Ethernet IO that are additionallly configured in the Customization

  • Assign the IP address

    • In the Properties of each module the IP-address and the scan rate can be configured


Configured ethernet io rack
Configured Ethernet IO Rack

  • Example

    • The screenshots show an Example for an Ethernet IO Rack configured with some Momentum IO

    • The Rack is listed under the slot of the Ethernet Interface and shown in the Network Viewer


Add an advantys io on ethernet
Add an Advantys IO on Ethernet

  • Advantys IO Rack

    • An Advantys IO Rack allows the data exchange with Advantys IO that is configured with Advantys Software

  • Add an Ethernet IO Rack

    • In context menu of the PLC select “New Rack”

    • Set Link Type to “Ethernet Device” and Rack type “Advantys STB”

    • The Head Slot offers all slots that are equipped with an Ethernet Interface, select one

    • Name the Advantys configuration file

    • Apply Rack


Import an advantys io on ethernet
Import an Advantys IO on Ethernet

  • Open Advantys Configuration

    • Once an Advantys Rack is created, the IO system can be opened in Advantys software and configured

    • Select “Open Advantys” from context menu

  • Import Advantys Configuration

    • To make the configured Advantys IO usable in UAG, it has to be imported

    • Select “Import Advantys” from context menu

    • After the imported the Advantys slot cards and IO points are available in the model


Assign ip address to advantys io
Assign IP-address to Advantys IO

  • Assign IP address

    • Advantys IO successfully imported

    • IP-address assignment is available in the Properties of NIP-module, i.e. the first module of the Advantys Rack

    • Repetitive rate for IO scanner can also be set


Configured advantys io on ethernet
Configured Advantys IO on Ethernet

  • Example

    • The screenshots show an Example for a configured Advantys IO

    • The Advantys is listed under the slot of the Ethernet Interface and shown in the Network Viewer

    • CANopen extension of Advantys can be used. UAG shows the extension devices as part of the rack


Add a modbus ethernet gateway
Add a Modbus-Ethernet Gateway

  • Modbus IO Rack

    • A Modbus IO Rack allows the data exchange with Modbus devices that are connected via a Modbus Ethernet Gateway

  • Add an Ethernet IO Rack

    • In context menu of the PLC select “New Rack”

    • Set Link Type to “Modbus IO” and select the Gateway type”

    • The Head Slot offers all slots that are equipped with an Ethernet Interface, select one

    • Enter the IP-address of the Gateway

    • Apply Rack


Add a modbus ethernet bridge
Add a Modbus-Ethernet Bridge

  • Populate the Rack

    • The rack is populated in the same way as the PLC Rack

    • UAG offers all Modbus devices IO that are configured in the Customization

  • Assign the Modbus address

    • In the Properties of each Modbus device in the rack the Modbus address and the scan rate can be configured


Configured modbus ethernet gateway
Configured Modbus-Ethernet Gateway

  • Example

    • The screenshots show an Example for a configured Modbus-Ethernet Gateway with an ATV running on Modbus

    • The devices are listed under the slot of the Ethernet Interface and shown in the Network Viewer as separate Modbus network behind the Gateway


Memory mapper1
Memory Mapper

  • Memory Mapping

    • The Memory Mapper assigns %IW and %MW according to the specified IO range of each module


Generated code
Generated Code

  • Transfer from Variables to IO scanner tables (Read & Write)


Summary ethernet io
Summary Ethernet IO

  • Different Ethernet IO are supported

    • Ethernet Rack for Momentum and any other IO Module with own IP-address

    • Advantys STB Rack for Advantys based IO including CANopen extension

    • Modbus Rack for Modbus based devices via Modbus-Ethernet Gateway

  • IO modules are organized in Racks

    • Located under the serving Ethernet Interface

    • Modules and IO points can be accessed in the same way as for local PLC modules

    • Memory Mapper assigns PLC addresses

  • Generated Code

    • IO Scanner entries for Unity Pro

    • Data Conversion to the IO Scanner Interface


Uag technical training7

UAG Technical Training

10 Customize the project


What you learn in this chapter8
What you learn in this chapter

  • UAG Customization

    • General Project Settings

    • Define the Physical Model to be used

    • Set the naming rules for objects

    • Define how variable names get created

    • Edit configuration data for the HMI system

    • Select the PLC hardware you want to use

    • Add specific IO devices


General information1
General Information

  • Adjust the UAG project to the needs

    • Select HMI to be used

    • Select Libraries and Templates to be used

    • Customize Physical Model

    • Define Naming Rules for Objects

    • Define general behavior of HMI values

    • Select used Hardware

  • Why to do? Benefits

    • Adjust UAG to the project

    • Make the use of UAG easier

    • Enforce company and project standards

    • Less mistakes in doing the project with UAG


Workflow customization
Workflow Customization

  • General

    • Define the Libraries to be used in the project

    • Define the Tools to document your process e.g. CAD, Word, ...

  • Physical Level

    • Define the parameters of Area, Process Cell, Unit and Equipment

    • Define the availability of control module and variable container at each layer.

  • Naming Convention

    • Define the Description Length of the comments

    • Define the Naming Rules for the different objects UAG


Workflow customization1
Workflow Customization

  • Name creation rules

    • Define the rules for naming variables at different hierarchy levels

  • Data

    • Define the Access Level

    • Define Alarm Priorities

    • Define Archiving and Trending behavior

    • Define the Display Format

    • Define the Measurement Unit Groups and Measurement Units

  • PLC

    • Select the hardware for the project: PLC, modules etc.

    • Define additional IO and field-bus devices


Settings general
Settings - General

  • Paths

    • Path for SCoD libraries

    • Path for XML style sheet conversion

    • Path for help files of the used SCoD


Settings general1
Settings - General

  • Libraries

    • Selection of the libraries to be used in the project

  • Tools

    • Add programs (known extensions) for direct use in UAG

  • Export Format Name

    • Enter the transformations to be done after XML export (Style sheet and export file name)


Settings library
Settings Library

  • Libraries

    • All available libraries (SCoD and Templates) are listed in the library window according to the specified path

    • A library can be selected, if the correct HMI system is supported

    • A library can be de-selected, if it is not used in the UAG project


Settings physical level
Settings – Physical Level

  • Layer Levels

    • Adjust, add or remove layer levels in the Physical Model of the project.

  • Modification of Level

    • Give the level an individual name

    • Selection, if unique names are required

    • Selection, if the Control Module and / or Variables can be used at this level



Settings naming convention
Settings - Naming Convention

  • Description length (comments)

    • Maximum of characters authorized in UAG

    • Up to 64 characters for all mentioned elements

      • Control Domain, PLC, Rack, etc.

      • Control Module, Equipment, Variable, etc.

  • Naming convention

    • Rules how to name single element in the project

    • Freely editable or restrictions can be made

      • Enforce the applied naming standard

      • Avoid mistakes during naming


Settings naming convention1
Settings - Naming Convention

  • Naming convention

    • Rules how to input single element names in the UAG project

    • Freely editable or restrictions can be made

      • to enforce the applied naming standard

      • to avoid mistakes during naming

  • Example

    • Object Name is concatenated out of two parts

      • First part: 3 digit number

      • Second part: Freely editable text with a maximum of 10 characters

    • E.g., “001HelloWorld”


Settings naming convention2
Settings - Naming Convention

  • Setting Up Naming Conventions

    • Enter the number of different name components parts

      • number of edit fields

    • Each component can be edited

      • Via buttons “Edit1”, …

      • as a Letter, a Number or a List

      • actual result for the field is displayed

    • Total length of the name is supervised


Settings naming convention3
Settings - Naming Convention

  • Field Type: Letter, fixed size

    • size is editable (maximum 16 characters)

    • capital letters without digits

    • small letters without digits

    • capital and small letters with digits

    • specify small or capital letter for each character (digits not allowed)


Settings naming convention4
Settings - Naming Convention

  • Field Type: Letter, variable size

    • minimum and maximum size Size are editable

    • capital letters with digits

    • small letters with digits

    • capital and small letters with digits

  • Field Type: Letter, fixed string

    • Fixed Text


Settings naming convention5
Settings - Naming Convention

  • Field Type: Number, fixed size

    • size is editable (maximum 16 characters)

    • add or no leading digits

  • Example for 3 digits

    • 056 with leading digits

    • 56 without leading digits


Settings naming convention6
Settings - Naming Convention

  • Field Type: List

    • define a new list or choose an existing one

    • select predefined values in a list

    • the “short” field is displayed in UAG

      • up to 4 alphanumeric characters

      • always the same number of characters

    • the “description” field can have up to 64 characters


Settings naming convention7
Settings - Naming Convention

  • List Designer

    • Open

      • from menu “List”

      • from field type List (Button “Designer”)

    • create, modify and remove a list

      • up to 15 characters for the name of the list

    • edit the values contained in the list


Settings naming convention8
Settings - Naming Convention

  • Comment

    • appears in UAG, beside or below the name field

    • standard comment contains information about the length

    • possible to edit and adjust according to the used naming rule

    • Recommended to adjust, when naming convention is changed


Settings naming convention9
Settings - Naming Convention

  • Maximum length of the name

  • Maximum length of the Physical Model levels must reflect the Name Creation Rule

    • see next slide


Settings naming convention10
Settings - Naming Convention

  • Limitation of Variable Names by PLC and HMI Software

    • Unity Pro with Vijeo Citect: 31 + 1 characters (addition is separator)

    • Unity Pro with Monitor Pro: 30 + 2 characters

    • Unity Pro with iFix: 28 + 2 characters

    • Unity Pro with ArchestrA: 31 + 1 characters

  • Name Creation Rule

    • Standard Rule is Equipment_ControlModule_Variable

    • I.e., the summed length of these three elements must not exceed 30 characters (as 2 separators “_” are used)

    • If only parts of a level name are used (Field), the summed length uses the length of the part

    • See next slides for details


Settings name creation rules
Settings – Name Creation Rules

  • Defining rules for naming

    • Define rules for Variables used in a particular hierarchy level of the Physical Model

      • Used in a Control Module

      • Used directly on the level

    • Define rules for Variable’s comment on the particular level

  • Remark

    • In the default ISA S88 model rules can be set only on Equipment level, as only there Control Modules and Variables are allowed


Settings name creation rules1
Settings – Name Creation Rules

  • Naming rules for Variables

    • Define the number of name components (Fields; max. 32).

    • Each field can be edited and three types can be selected:

      • Fixed String,

      • Physical Level

      • Variable

    • All Physical levels can be used either with

      • Complete name

      • Single name fields


Settings name creation rules2
Settings – Name Creation Rules

  • Following rules have to be applied

    • Name components to be used

      • Variable name

      • Control Module name (for Control Module Variables only)

    • Variable name has to be separated by “_”-character from the rest of the name

    • Maximum length of 32 (iFix 30) has to be respected

  • Consistency check

    • Rules are checked during Analyze of the Customization


Settings name creation rules3
Settings – Name Creation Rules

  • Example 1: Standard ISA S88 Model

    • The variable will be defined with name of Equipment followed by Control Module then the variable

    • E.g., EQ2_Mot22_MFwd


Settings name creation rules4
Settings – Name Creation Rules

  • Example:

    • The variable will be defined with a fixed string followed by Control Module then the variable

    • E.g., Plant_Mot22_MFwd


Settings data
Settings - Data

  • Alarm Group

    • Organization of Alarms into groups

  • Availability in the single HMI systems

    • Vijeo Citect: Combines Alarm Group and Priority (next slide) to an Alarm Category

    • Monitor Pro: Fully supported

    • iFix: Not supported

    • ArchestrA: Not supported


Settings data1
Settings - Data

  • Alarm Priority

    • list of the different alarm priorities available in the HMI

  • Availability in the single HMI systems

    • Vijeo Citect: Combines Alarm Group and Priority to an Alarm Category (max. 253)

    • Monitor Pro: 3 priorities supported

    • iFix: fully supported

    • ArchestrA: fully supported


Settings data2
Settings - Data

  • Archive Name

    • Defines the name and location of Archive

  • Availability in the single HMI systems

    • Vijeo Citect: fully supported for Trends

    • Monitor Pro: fully supported

    • iFix: not supported

    • ArchestrA: fully supported


Settings data3
Settings - Data

  • Communication Frame

    • Definition of communication frames

    • Data exchange between PLC and HMI

  • Availability in the single HMI systems

    • Fully supported by all systems


Settings data4
Settings - Data

  • Data Type

    • the elementary data types for Unity Pro

    • structured data imported from the used libraries

    • possible to deselect a type (as long as not used)

    • possible to add a new data type

      • no definition of internal structure

      • rename or remove possible

    • impossibility to modify or remove

      • elementary types

      • types coming from a SCoD library

    • at least one data type must be selected


Settings data5
Settings - Data

  • Display Format

    • list of the different display formats available for the HMI

    • at least one format must be selected

  • Availability in the single HMI systems

    • Fully supported by all systems


Settings data6
Settings - Data

  • Measurement Unit Group

    • list of the groups the Units belong to

  • Measurement Unit

    • list of the different units used in the application

    • a unit can only be added, if a group is defined

  • Availability in the single HMI systems

    • Fully supported by all systems


Settings plc
Settings - PLC

  • Define the hardware used in the project

    • PLC family

    • Rack

    • Module

    • User Defined Module

  • PLC Family

    • Choose the PLC-Types used in the project


Settings plc1
Settings - PLC

  • Rack

    • Choose the Racks used in the project

  • Module

    • Choose the Modules used in the project


Settings plc2
Settings - PLC

  • User defined module

    • Adding specific modules to be used in UAG

    • Specify name, description of the module

    • Specify a category and the possible racks

    • Specify the input and output range according to the modules documentation


Settings - Fieldbus

  • Add a new Fieldbus Slave Type

    • Select “Add” from Profibus context menu

    • Enter a name for the type to be added

    • Apply Type


Settings - Fieldbus

  • Add a Module to a Slave Type

    • Select “Add” form Slave Type’s context menu

    • Enter a Module Name and a Description

    • Define input and output range

    • Select IO Map to define the Input and Output signals on the defined range


Settings - Fieldbus

  • Edit the IO Mapping of a Fieldbus Slave Type

    • Adding / modifying a module item

    • Define data type, byte order, position in byte stream

    • Enter so many items until the complete range is used (gaps are possible)


Settings fieldbus
Settings - Fieldbus

  • Module definition using user FFBs for the mapping mapping

    • Using a DFB instead of the direct mapping of the byte stream

      • Instead of the logic constructed by UAG,

      • a user DFB maps the correct information into the variables

    • Satisfy more complex data type modification

    • DFB interface is based on the variable description

      • proposed from UAG to be imported in Unity Pro

      • enhanced with the user logic


Analyze the customization
Analyze the Customization

  • Checking the Customization

    • start the analyze via the menu or the icon

      • at any time by the programmer

      • a report is displayed with the errors in red

    • automatically when exiting the file or the editor

      • in this case the report is not displayed;

      • if errors are detected, a dialog box opens

      • the report is displayed by pressing the “details” button


Additional information
Additional Information

  • Analyze

    • Analyze the project

  • Version

    • Shows the Version of the project


Uag technical training8

UAG Technical Training

11 From a DFB to SCoD


What you learn in this chapter9
What you learn in this chapter

  • Design a DFB

    • Basic steps to set up a DFB

    • Basic steps to put a DFB in a library

    • Basic steps to export a DFB

  • Design a Smart Control Device (SCoD)

    • Basic steps to import a DFB

    • Basic steps to make a ScoD avialable for a Project


From a dfb to scod
From a DFB to SCoD

  • Unity Pro Part

    • Create a DFB in Unity Pro

    • Analyze and validate the DFB

    • Put the DFB in the Unity library

    • Export the DFB from Unity Pro

  • UAG Part

    • Open an existing SCoD library with the SCoD editor

    • Save the library under a new name

    • Import the DFB by using the Unity export file

    • Validate DFB as new ScoD

    • Save SCoD library


Create a new dfb
Create a new DFB

  • Create a new DFB in Unity Pro

    • Open Derived FB instances

      • Context Menu of Derived FB Instances

      • Open

      • Choose DFB Types

    • Enter a name for the new DFB, e.g. MOT2D


Modify the dfb interface
Modify the DFB Interface

  • Modify the interface of the DFB

    • Enter in- and outputs as required for the function

    • Enter internal variables as needed

    • Use of public variables

      • not supported by UAG

      • only for programming inside Unity available

    • Create the sections needed for the function

  • Add code to the DFB

    • Open the created sections

    • Design the code as required for the function

      • Insert Blocks with Icon or <CTRL> D or right mouse click

      • Connect variables and blocks


Modify the dfb code
Modify the DFB Code

  • Recommended logic inside the block


Modify the dfb code1
Modify the DFB Code

  • Recommended logic inside the block


Validate dfb and put into the library
Validate DFB and put into the Library

  • Analyze and Validate the DFB

    • In the Data Editor

    • In context menu select “Analyze type”

  • Put the DFB in the Unity Library

    • Choose “Copy into Library” in the context menu

    • Select the library family

    • Only the library reference allows UAG to instantiate a function block during generation


Export function block
Export Function Block

  • Export the DFB

    • Select the DFB in the Project Browser

    • Select “Export” in the context menu


Import dfb as new scod
Import DFB as new SCoD

  • Used SCoD library

    • Open existing SCoD Library

      • e.g. Processxx.OSL

    • Save SCoD Library with new Name

      • e.g. TEST_LIB.OSL


Import dfb as new scod1
Import DFB as new SCoD

  • Import DFB

    • Select “Import DFB”

      • Depending on the selected file one or several function blocks are offered

      • Select or de-select the single DFB

    • Only DFB interface is imported as SCoD

      • the DFB interface (inputs, outputs) is available

      • UAG does not know about the internal code (Black Box)

  • Default Settings

    • for all pins variables of type PLC are added to the SCoD

    • all pins are connected to the variable of the same name


Make the scod available
Make the SCoD available

  • Commit SCoD

    • In context menu of the SCoD select “Commit SCoD”

  • The Commit Procedure

    • After modifications an analyze is necessary first

    • Correct errors, if necessary

    • Click “Commit SCoD” for a second time


Use the scod
Use the SCoD

  • Update the Customization

    • Open the Customization of the project

    • The new SCoD is recognized and its data imported (Message Box)

    • Save the Customization file

  • Use of ScoD

    • In the UAG project the updated library has to be confirmed

    • The new ScoD can now be instantiated as a new Control Module


Summary from dfb to scod
Summary From DFB to SCoD

  • Define a DFB

    • Define the interface (Inputs, Outputs)

    • Write the necessary DFB code

    • Put the DFb in the Unity Pro library that UAG can reference it

    • Export the DFB for SCoD definition

  • Define a SCoD

    • Import the DFB into the SCoD editor (only the Interface is used)

    • Commit the SCoD when it is finalized

    • Update the Customization of the Project

    • Use SCoD in the Project



What you learn in this chapter10
What you learn in this chapter

  • ScoD Definition

    • How are pins of DFB used

    • How variables are defined and used

    • What are variable properties

    • What are SCoD properties

    • What is inheritance

    • How is an HMI symbol assigned

    • How is the SCoD committed

  • General Data

    • General Data for Variable properties


Overview scod editor functions
Overview SCoD Editor Functions

  • Design and Handling of SCoDs in Libraries

    • Create new SCoDs

    • Assign a DFB or EFB and an HMI graphics

      • Import DFB and EFB from Unity Pro

      • Import Data Types

    • Commit the SCoD

  • SCoD Interface Design

    • Modification of SCoD Interface (IO)

    • Allow Additional Logic (Interlocks)

    • Allow Linking of Pins


Overview scod editor functions1
Overview SCoD Editor Functions

  • Variables and their Usage

    • Variable Environment and Communication

    • Variable Properties like Alarms, Trends etc.

  • SCoD Properties

    • General Data like Access Levels, Alarm Priorities, etc

    • Adds Properties for single variables (Alarms, Initial Value, etc.)

    • Connect Variables (Inherit Values)


Scod editor workflow
SCoD Editor Workflow

  • Set up a new SCoD library

    • Create new SCoD library

      • Select the HMI used

    • Alternative rename an existing library

      • Delete the unused SCoDs

      • Advantage: re-use of general data

    • Import DFB and EFB as new ScoDs

    • Import DDT not in DFB included


Scod editor workflow1
SCoD Editor Workflow

  • Define General Data as needed

    • General Data for HMI

      • Access levels

      • Alarm Groups and Priorities

      • Archive names

      • Measurement Units

    • Communication Frames

    • Enumeration

  • SCoD Interface Design

    • Modification of SCoD interface (IO)

    • Allow Additional Logic (Interlocks)

    • Allow Linking of Pins


Scod editor workflow2
SCoD Editor Workflow

  • Define the behavior of variables

    • Modify imported variables and their usage

      • variable environment and communication

      • Define PLC behavior: initial value

      • Define HMI behavior: alarms, archives, ...

    • Add variables as needed

  • Define Properties and Inheritance

    • Define values to be listed on the property page

    • Define inherited values

  • Finalize SCoD

    • Assign HMI Graphics (symbol) and help file

    • Analyze the SCoD, correct errors

    • Commit SCoD


Set up a new scod library
Set Up a new SCoD library

  • SCoD Editor new Library

    • Select “New” icon or menu entry

    • Choose the appropriate HMI system

    • Save the library

  • Rename existing library

    • Open existing SCoD Library, e.g. UAGProcessLibVCV2.0.osl

    • Save SCoD Library with new Name, e.g. TestLib. osl

    • Delete unused SCoDs from library

    • Advantage: re-use of general data


Set up a new scod library1
Set Up a new SCoD library

  • Import DFB or EFB

    • Only the DFB interface is imported

      • Inputs and Outputs

      • Code remains in Unity Pro

    • Import DFB from Unity Pro: *.xef, *xdb file

    • Import DDT for additional variables from Unity Pro: *.xef, *xdb file

  • Imported DFB as SCoD

    • With the import the SCoD editor automatically

      • Creates variables of type PLC for all pins

      • Connects all pins to those variables

    • The variable name and the pin name is the same


Scod representation in the editor
SCoD representation in the Editor

  • SCoD is represented by

    • Variables

      • coming along with the SCoD

      • (partially) connected to pins

    • FFB Pins

      • Interface of DFB / EFB

      • Usage of the pins

    • Properties

      • Value modification via Property Page

    • Inheritance

      • connecting variables of the SCoD

      • edit once, modify multiple


Workflow for modification of scod
Workflow for Modification of SCoD

  • FFB Pins

    • Define how the pins are going to be used: Variable, Link, Interlock, …

  • Variables

    • Define for each variable, where and how it is used

  • Properties

    • Define the general properties of the SCoD

  • Inheritance

    • Define the inherited values


Scod ffb pins
SCoD FFB Pins

  • Declare the usage of the pins

    • Variable connected, Link, Interlock, Literal

  • Add, delete and modify pins

    • Added (modified) pins must be available in the original DFB / EFB

    • Deleted pins are ignored and appear unconnected in PLC code


Add and modify a pin
Add and modify a pin

  • Add or Modify a Pin

    • Select “New Pin” or “Properties” from context menu

  • Properties of a Pin

    • Name

      • Name of the pin

    • Data Type

      • Select from a list, e.g. Real, Bool, ...

    • I/O Type

      • IN, OUT, INOUT

      • Defines the pin type

    • Position

      • Position of the pin


Add and modify a pin1
Add and modify a pin

  • Pin usage

    • Not connected

    • Variable

    • Literal (Inputs only)

    • Interlock (Boolean inputs only)

  • Literal Mode

    • Assign a static or editable literal

    • Literal Value (static, assigned fixed in the SCoD Editor)

    • Variable Property (editable, derived from a variable)


Scod variables workflow
SCoD Variables Workflow

  • Declare environment of usage

    • Connected to pin or additional variable

    • Connection type: PLC, PLC_HMI, ...

  • Add, delete and modify variables

    • Set basic properties for adding

  • Copy variables

    • Insert to same or other SCoD

  • Adjust properties

    • Make values visible and changeable

    • PLC: initial value, communication frame

    • HMI: alarms, archives, operator access

    • Free properties for various purpose


Scod variables basic properties
SCoD Variables Basic Properties

  • Basic Properties

    • Name and description

    • Data Type

    • Connection type

      • Environment the variable is used

      • PLC, PLC_HMI, HMI, PLC_NET, PLC, IO, Literal

    • I/O Type

      • depending on the connected pin or usage

      • IN, OUT, INOUT


Scod variables general properties
SCoD Variables General Properties

  • HMI Bitfield Variable

    • Assign a structure of type HMI to a Word, DWord

      • Sending HMI values in compact way (Word)

      • Split single values by bitfield structure

    • Recommended for Monitor Pro and ArchestrA

    • For Vijeo Citect use Cicode Function for extraction


Scod variables general properties1
SCoD Variables General Properties

  • Connected Pins

    • Shows connected pins for this variable

    • Add and remove connected pins

  • Inheritance Relation

    • Shows where this variable is used for Inheritance


Scod variables value properties
SCoD Variables Value Properties

  • Initial Value

    • set initial value of variable

  • Deadband Mode

    • Suppressing an update of the value, if the change is within the dead band

  • Variable Used

    • defines, if an IO_ PLC the variable must be used

  • Invert

    • Inverts the value of an input (IN) variable


Scod variables communication prop
SCoD Variables Communication Prop.

  • Communication Frame

    • set communication frame for type PLC_HMI

  • Failure State & Value

    • Allows to set a value, when the communication fails

    • set timeout behavior (last value, user defined)

    • set the timeout value

    • available for type IO_PLC


Scod variables alarms
SCoD Variables Alarms

  • General

    • Only available for type PLC_HMI and HMI

  • Alarm

    • Assigns an alarm to this variables

  • Alarm Group and Priority

    • Assigns the alarm group

    • Aelect from predefined lists ( General Data)

  • Alarm List

    • Shows all defined Alarms on a variable

    • For single Alarm switch to Details


Scod variables alarms1
SCoD Variables Alarms

  • Alarm Text

    • Defines the text displayed in the alarm viewer

    • Default:

      Comment Variable - Control Module –Equipment

    • Default Composition can be set in the Customization

  • Alarm Operator and Limit

    • Defines the comparison operator (=, >, <, <>, ...)

    • Defines the limit for activating the alarm


Scod variables command
SCoD Variables Command

  • General

    • Only available for type PLC_HMI and HMI

  • Command

    • Assigns the interaction level for this variable

      • Operator, Parameter: read and write

      • all other: read only

  • Access level

    • Necessary access level for interaction

    • Select from predefined lists ( General Data)


Scod variables command1
SCoD Variables Command

  • State 0 / 1 Text

    • Text to be displayed for the variable in the HMI

  • Update Initial Value

    • Enables the update of initial values in Unity Pro

    • Recommended to set in SCoD library only

    • Available for PLC_HMI, PLC, PLC_NET


Scod variables archive
SCoD Variables Archive

  • General

    • Only available for type PLC_HMI and HMI

    • Not supported by iFix

  • Archive

    • Sets the variable to be stored in an archive or displayed as trend

  • Archive Name

    • Set the archive name to be used, i.e. the file name or database table

  • Sample Rate

    • Sets the sample rate of the Trend / Archive


Scod variables display
SCoD Variables Display

  • General

    • Only available for type PLC_HMI and HM

    • Only analog variables (Int, Dint, Real, ...)

    • Not supported by Monitor Pro 7.2 / 7.6

  • Display Format

    • Set the display format

    • Select from predefined lists ( General Data)

  • Measurement Unit

    • set the measurement unit for the value

    • select from predefined lists ( General Data)


Scod variables display1
SCoD Variables Display

  • Raw Min, Max

    • Sets the raw value range in the PLC

    • Mainly used for Vijeo Citect, when scaling is not done on PLC side

  • Scaling min / max

    • Scaling for Display output in the HMI

  • Boundary min / max

    Boundaries for manual input in the HMI


Scod variables free properties
SCoD Variables Free properties

  • Free Property List

    • set up to 20 properties can be defined

    • usable for additional information, e.g.

      • trending

      • mathematical operation

    • available in the XML export file

      • transferred to HMI format via style sheets


How to modify variable properties
How to modify Variable Properties

  • Property Value

    • free editable value

    • pop up select for Boolean values or enumeration

  • Availability

    • Visible: value is visible in the UAG project

    • Changeable: value is changeable in the UAG project

      • visible is automatically selected

      • if not selected, the user cannot change this value


How to modify variable properties1
How to modify Variable Properties

  • Enumeration

    • Use enumeration to choose values

    • Enumeration must be defined under General Data

    • Possibility to restrict the user’s choice

  • Inheritance

    • Shows to which variables / properties the value is inherited


Scod properties
SCoD Properties

  • Define variable properties to be changed in UAG

    • Control Module configuration

  • Properties available in the module’ s property page in UAG

    • easy way to get all necessary modification at one place

    • instead of going through all variables looking for modification

  • Add, delete and modify properties


Set up a scod properties
Set up a SCoD Properties

  • Step 1: Define Property

    • Select “New Property” from context menu

    • Choose Tab “General”

    • Select a variable (“Select” button)

    • Choose a property to be updated in UAG

    • Set a name for the new SCoD property (“Caption”)

  • Important Note

    • The variable property must be “Changeable”

      • Otherwise the SCoD property cannot be modified

    • Select “Changeable” for the variable’s property


Set up a scod properties1
Set up a SCoD Properties

  • Step 2: Assign Position on property page

    • Select Tab “Position”

    • Choose the position of the property on

      • the right property tab, e.g. Configuration

      • the position on the page (select 1 to 12)

    • Property pages can be

      • added (Button “Add”)

      • named (Enter name under “Caption”)


Scod inheritance
SCoD Inheritance

  • Connect variables between SCoDs or within a SCoD

  • Usable for deploying values to different variable properties, e.g.

    • One Initial value for different variables

    • The same values for scaling or boundaries

  • Reduce effort for user, avoid mistakes

  • Add, delete and modify inheritance


Set up inheritance
Set up Inheritance

  • Inheritance

    • Select “New Inheritance” from context menu

    • Select source ScoD, Variable (DDT Element) and Property

    • Select target SCoD, Variable (DDT Element) and Property

    • Apply Inheritance


Scod general data
SCoD General Data

  • Purpose

    • Pre-define values for several variable properties

    • restricts property value,

      • if free selection is not useful

      • the user should be restricted (Enumeration)

  • SCoD General Data

    • Access Levels

    • Alarm Groups

    • Alarm Priorities

    • Archive Names

    • Communication Frames

    • Data Types

    • HMIs

    • Measurement Unit Group


Scod general data1
SCoD General Data

  • General Information on Items

    • All check-marked items are imported into the Customization and the project

    • Used items automatically get check-marked

    • Possibility to add, modify or delete an entry

    • No limitation for the number of values


General data access level
General Data - Access level

  • Access level

    • List of the different access levels available

    • Add, modify or delete via context menu

    • Needs a Name and a Description

    • Used by iFix


General data alarms
General Data - Alarms

  • Alarm Group

    • List of available Alarm Groups

    • Add, modify or delete via context menu

    • Needs a Name and a Description

    • For Monitor Pro and Vijeo Citect


General data alarms1
General Data - Alarms

  • Alarm Priority

    • List of the different Alarm Priorities

    • Add, modify or delete via context menu

    • Needs a Name and a Description

    • Has to fit to the capabilities of the HMI, e.g. Monitor Pro supports only 3 levels


General data archive
General Data - Archive

  • Archive Name

    • Definition of Archive Names, i.e. database table or the file name

    • Add, modify or delete via context menu

    • Needs a Name and a Description

    • Not used by iFix


General data communication
General Data - Communication

  • Communication Frame

    • Definition of communication frames

    • Data exchange between PLC and HMI

    • Frame needs a name and a data type

    • Frame is Read or Read/Write


General data data type
General Data - Data Type

  • Data Type

    • the elementary data types for Unity Pro

    • imported or added structured data types

      • no definition of elements, when adding

      • rename or remove possible, if not used


General data display format
General Data – Display Format

  • Display Format

    • Definition of Display Format, i.e. how values appear in the HMI

    • Add, modify or delete via context menu

    • Needs a Definition


General data enumeration
General Data - Enumeration

  • Enumeration

    • List with predefined values

      • Values can be added or removed

    • Can be used instead of freely editable value fields

    • Needs a name and a description


General data enumeration1
General Data - Enumeration

  • Enumeration Value

    • Single Value in a List

      • Values can be added or removed

    • Needs a name and a description


General data measurement unit
General Data - Measurement Unit

  • Measurement Unit Group

    • List of the groups the Units belong to

    • Needs a name


General data measurement unit1
General Data - Measurement Unit

  • Measurement Unit

    • List of the different units used in the application

    • A unit can only be added, if a group is defined

    • Needs a name, a description and the group it belongs to


Scod properties1
SCoD Properties

  • SCoD Properties

    • Set SCoD name and a Description

    • Assign

      • Function Block

      • HMI Symbol (one or multiple)

      • Help File

    • Select Icon for UAG project

      • Default

      • All picture types, e.g. jpg, gif, bmp


Commit scod
Commit SCoD

  • Commit SCoD

    • After modifications an analyze is necessary first

    • Correct errors, if necessary

    • Click “Commit SCoD” for a second time

  • Report

    • Generate a report about the SCoD

      • Select template file

      • Select target file

      • Select topics to be included

    • MS Word must be installed


Summary scod editor
Summary SCoD Editor

  • SCoD Workflow

    • Define Pin Usage (Variable, Link, Interlock, …)

    • Define Variables and their behavior (Alarm, Trend, PLC/HMI, …)

    • Define SCoD properties

    • Define Inheritances

    • Assign DFB and HMI symbol

    • Analyze SCoD

    • Commit SCoD

  • General Data

    • Pre-definitions for HMI (Alarm Priority, Archive, Units, …)

    • Help to enter Variable Values (Enumeration, …)


ad