Professional Documents
Culture Documents
September 2007
Part Number 05-2090
on
Wonderware@Application Server 3.0 and Device Integration Products
lnvensys and the author(s) assume no responsibility for errors or omissions and no liability is assumed for
damages resulting from the use of the information contained herein. Use of the lnvensys software described
in this document is subject to the terms of the applicable Wonderware Corporation or lnvensys Systems, Inc.,
license. These terms include provisions that limit your rights such as use restrictions, disclaimers of
warranties and limitations of Wonderware and lnvensys liability. A copy of the applicable license will be
displayed upon initial installation of the software. If a copy of the license is not displayed or you require an
additional copy of the license, you may obtain one from lnvensys' Wonderware business unit upon request by
calling 1.949.727.3200 or by sending an e-mail to support@wonderware.com.
Invensys; Wondeware; ActiveFactory; ArchestrA; DT Analyst; FactorySuite; FactorySuite A2; InBatch;
Incontrol; IndustrialSQL Server; InTouch; InTrack; QI Analyst; SCADAlarm; SPCPro; SuiteLink;
Suitevoyager; WindowMaker; Windowviewer; Every system in your plant, working in concert; and the
Visualize, Analyze, Optimize logo are trademarks or service marks of lnvensys plc, its subsidiaries and
affiliated companies. All other brands and product or setvice names may be the trademarks or service marks
of their respective owners.
Table of Contents
Table of Contents
Module 1
Introduction .................................................................................
- 1
Section 1 -Course Introduction
Section 2 - Wonderware System Platform
Lab 1 -Creating a Galaxy
Section 3 -The ArchestrA IDE
Section 4 -Automation Object
Section 5 - System Requireme
.............. 1-77
Section 6 - Application Plannin
Lab 2 - Identifying the Mixer .....................................................................
1-91
Module 2
Module 3
Module 4
Module 5
.....................................................................
Module 6
5-9
Security ........................................................................................
6-1
Section 1 - Security Overview ...........................................................................
6-3
Lab 17 -Security ......................................................................................
6-13
Module 8
Module 9
7-21
7-33
8-9
-19
. .
Multi-Node Appl~cat~ons
..........................................................9-1
Section I -Application Redundancy ..................................................................
9-3
Lab 18 - Configuring Application Redundancy ......................................... 9-17
Section 2 - Dl Redundancy.................................
Lab 19 -Configuring the Re
Section 3 - Multi Node Applicatio
Lab 20 - Convert to Network
Wondenvare Training
Introduction
Section 1 - Course Introduction
Section 2 - Wonderware System Platform
Lab 1 - Creating a Galaxy
Section 3 - The ArchestrA IDE
Section 4 - Automation Objects
Section 5
1-2
Module 1 - Introduction
Module Objective
Introduce the Wonderware@System Platform and its archftecture, envlronrnent, and
requirements for installation and l~censing.
Wonderware Training
Course Description
The Wonderware System Platform 3.0 - Part 1 course is a four-day, instructor-led course designed
to provide a fundamental understanding of the basic principles of ArchestrAa and supply the
knowledge necessary to develop and support applications for the Wonderware Application Server
3.0. The course utilizes a number of hands-on labs to reinforce concepts and features.
The focus of this course is to illustrate the use of ArchestrA@tools and services in the System
Platform to develop a project utilizing connectivity to the field, data processing, scripts, alarms and
nistory, using feat~resand f~nctionaitys ~ c as
h A~tomationObjects, templates, template
nstances, ArchestrAO Integrate0 Development Env ronment and Quickscript .NET.
This course also provides a fundamental understanding of how to utilize the lnTouch@Alarm DB
Logger for real-time alarm recording as well as the security settings available for securing the
applications.
Course Objectives
Upon completion of this course, you will be able to:
e
Create new projects using ArchestrAB Integrated Development Environment
Audience
This training class is targeted to engineers, application developers, system integrators, and other
individuals whose jobs include creating and/or maintaining a Galaxy for use with the Wonderware
System Platform
Prerequisites
The prerequisites for this course are:
Completion of Getting Started with Wonderware Application Sever web tutorial located at
http://ww.wonderware.com/training/online~training/tutorials.asp
e
Manufacturing industry experience
1-3
1-4
Module I- Introduction
Agenda
Module I- lntroduction
Section I -Course lntroduction
This section describes the Wonderware0 System Platform 3.0 course - Part 1, (Wonderware
Application Server 3.0), the objective of the course, intended audience, prerequisites, and the
course agenda. It also includes a description of Wonderware Products.
Section 2 - Wonderware System Platform
This section provides an overview of the Wonderware System Platform, the architecture of
ArchestrA and the importance of how it is critical to plant automation, and an overview of the
differences between Object-oriented and traditional Tag based HMI and SCADA products and
how it applies to Wonderware System Platform applications. It also provides an understanding
of what a Galaxy is, how it relates to the Galaxy Database and the Galaxy Repository and how
a Galaxy is created.
Lab 1 -Creating a Galaxy
Section 3 -The ArchestrA IDE
This section provides an overview of the ArchestrA IDE, the Template Toolbox and Application
Views and the object Check-in/Check-out process.
Section 4 -Automation Objects
This section provides an explanation of the various types of objects utilized in the ArchestrA
IDE and an overview of when and how they are used. Additionally, it describes how to create
and configure instances of objects and the hosting and containment relationships of objects.
Section 5 -System Requirements, Licensing and Support
This section provides a detailed explanation of the system requirements necessary for System
Platform, discusses Licensing details and covers Support services.
Section 6 -Application Planning
This section provides an explanation of the need for adequately modeling your plant in order
to achieve an application implementation that will be optimal for efficiency.
Lab 2 - Identifying the Mixer
Wondeware Training
1-5
Module I- Introduction
1-6
This section introduces and explains the scripting environment and the various scripting
configuration attributes of the Applicationobject
Lab 13 - DDESuiteLinkClient Auto Reconnect
Lab 14 -Automatic Reference Configuration
Module 6 - Security
Section 1 - Security Overview
This section provides an understanding of Security as it relates to Application Server.
Lab 17 - Security
Wondenvare Training
1-7
.-
1-8
Module 1 - Introduction
Wonderware Approach
to industrial Applications
All Wonderware Software Solutions-whether in the areas of Supervisory HMI, Production and
Performance Management, or Geo-SCADA-leverage the comprehensive ArchestrAB industrial
automation and information software architecture.
Wonderware Training
Functional Capabilities
The Wonderware System Platform contains an integral core set of capabilities and services to
support sustainable production and operations performance improvements via a comprehensive
set of six capability areas:
Industrial domain services for industrial computing functions that are not provided by
commercial operating systems or products
Software and device connectivity services for easy communication to any plant or
business information source
Information and data management services for management of real-time and historical
information
Information-delivery and visualization services for functions that provide information to
the right user at the right time, and in the form in which they expect it
Application development services that provide easy and intuitive development of
modular industrial software solutions that are easily changed to meet future needs
System management and extensibility services that provide easy management,
expansion, and modification of the application or host computing architecture
1-9
1-10
Module 1 - Introduction
S y s t e m Platform Components
The Wondeware System Platform consists of a variety of software components
Wonderware Clients
e
Wonderware InTouch63 View human-machine interface (HMI) software as a visualization
client for the System Platform
e
ActiveFactoryTMtrending and analysis software
Reporting Client-Access Licenses for lnformation Server to enable information-sharing
and reporting over the Web
Wonderware Functional Modules
To complement the capabilities and benefits offered by the Wondeware System Platform,
Wondeware also offers a set of easily implemented add-on modules to assist you in the areas of
Performance Management, Production Management, Supervisory Control, and Geo-SCADA.
Wonderware Training
Enable secure, wide-scale delivery of reports on KPls, downtime, OEE, and SPC through
a powerful portal that delivers the information contextually
Improve data analysis and information sharing with advanced trending and reporting
capabilities
.*
1-11
Module 1 -Introduction
P r o d u c t Offerings
The Wonderware Production and Performance Management Software Solutions consist of a
variety of products:
Wonderware System Platform providing a core set of service capabilities as a
foundation for application development, operations, and information delivery
lnBatchTMflexible batch management software
e
Manufacturing Execution Module (formerly known as lnTrackTM)resource and WIP
tracking software
e
Equipment Operations Module for formula management including product definitions
and equipment setups, and for capturing and storing information from production events
including product and production history and genealogy
e
Equipment Performance Module (formerly known as DT AnalystTM)equipment
downtime tracking and performance management software
e
QI AnalystTMfor using real-time and historical data to monitor, analyze, and predict
potentially harmful process variations, allowing for online adjustments for improved
production quality and consistency
Wondeware Training
These solutions offer several unique features that can greatly benefit companies looking to
implement a new SCADA solution or upgrade an existing system.
The easiest and most efficient, open software solution for SCADA
Highly available, reliable, and scalable SCADA applications
Single-click software redundancy
Leverages ArchestrA architecture for easy configuration and management of operational
and system security that is compatible with existing IT security capabilities
Empowers users to design, build, deploy, and maintain standardized SCADA applications
Lowest total system lifecycle costs
Product Offerings
The Wondeware Geo-SCADA Software Solutions consist of a variety of products:
e
Wonderware System Platform providing a core set of service capabilities as a
foundation for application development, operations, and information delivery.
e
InTouch human-machine interface (HMI) software for process visualization and control
SCADAlarmTMevent notification software for real-time alarm notification, data acqqisition,
and remote control from telecommunication devices to industrial automation software
systems
1-13
1-14
Module 1 - Introduction
Wondenvare Individual Software Products
All the latest Wonderware software offerings leverage the latest ArchestrA technology and are
essential to the Wonderware Production and Performance Management, GEO-SCADA, and
Supervisory HMI Software Solutions.
The following Wonderware products offer increased functionality and flexibility as well as
extensive connectivity:
e
Wonderware Application Server (formerly known as Industrial Application Sewer) for
system-wide, real-time data acquisition, alarm and event management, centralized
security, data manipulation, remote deployment, and collaborative engineering
rn ArchestrA Object Toolkit for creating application objects for use within the
Wonderware Application Sewer
e
InTouch human-machine interface (HMI) software for process visualization and control
e
Wonderware System Platform providing a core set of service capabilities as a
foundation for application development, operations, and information delivery
e
Functional Modules for searnlessly integrating new functional capabilities into
Wonderware Application Sewer applications using a modular approach, including:
Equipment Operations Module for formula management and real-time production
events collection
Equipment Performance Module (formerly known as DT Analyst) for equipment
downtime tracking and performance management
rn
Manufacturing Execution Module (formerly known as InTrack) for resource and
WIP tracking
Wonderware Historian (formerly known as IndustrialSQL Server) real-time historian for
SCADA and factory data
e
Wonderware Information Server (formerly known as Suitevoyager) Web analysis
software for InterneVintranet visualization and content management
e
Device and Software Connectivity Tools offering a library of hundreds of DA Servers
and 110 Servers, the DA Server Toolkit, and Device Integration (Dl) Objects
InTouch View human-machine interface (HMI) software as a visualization client for the
System Platform
ActiveFactory trending and analysis software for accelerating and improving decisionmaking at all levels within an organization
QI Analyst statistical process and quality control software to predict process variations
and enable online adjustments for improved production
e
Incontrol real-time control soflware
InBatch flexible batch management software
e
SCADAlarm event notification software for real-time alarm notification, data acquisition,
and remote control from telecommunication devices to industrial automation software
systems
0
InTouch for Terminal Services software for remote hosting of InTouch applications
Wondenvare software offers robust, best-of-breed soflware components that empower customers
to effectively develop and manage their automation and information applications in continuous,
discrete, process, hybrid, and batch manufacturing environments.
The Wonderware mission is to power intelligent plant decisions in real time.
.-
Wondeware Training
1-15
1-16
Module I- Introduction
- Intentionally
Wondenvare Training
left blank -
This section provides an overview of the Wonderware System Platform, the architecture of
ArchestrA and the importance of how it is critical to plant automation, and an overview of the
differences between Object-oriented and traditional Tag based HMI and SCADA products and
how it applies to Wonderware System Platform applications. It also provides an understanding of
what a Galaxy is, how it relates to the Galaxy Database and the Galaxy Repository and how a
Galaxy is created.
System Platform
The Wonderware@System Platform provides a single platform for all the SCADA, Supervisory
HMI, and Production and Performance Management needs of industrial automation and
information personnel. It provides a common and strategic industrial application services platform
on top of virtually any existing system, and is built upon the industry-standards based, ArchestrAe
real-time SOA technology.
The Wonderware System Platform is designed to make it easier for manufacturers to adjust to the
ever-changing needs of customers and the overall market. Its diverse functionality extends
Wonderware customers' software investments and encourages flexibility in application
development.
It supports consistent and reliable operations across industrial operations and manufacturing
facilities as well as promotes sustainable production and operational performance improvements.
The Wonderware System Platform contains an integral core set of capabilities and services to
support sustainable production and operations performance improvement via a comprehensive
set of six capability areas:
e
lndustrial domain services
e
Software and device connectivity services
Information and data management services
0
Information-deliveryand visualization services
e
1-17
Module I - Introduction
enables Wondeware customers to leverage lower-cost commercial PC hardware and operating
systems in industrial applications.
Application functions are quickly customized. Whether you have no knowledge of computer
programming or consider yourself an expert software engineer, the System Platform can empower
you to conveniently interact with process systems from any remote location. The result is a
reduction of personnel costs and improved response times because the software continuously
monitors and deploys messages, 2417.
Industrial Domain Services provide:
Real-time, peer-to-peer communications and messaging, enabling instant responses
High computing availability and redundancy for critical applications
r
Centralized alarm- and event-monitoring for operational conditions
..
Wonderware Training
Manual data
Labs and quality systems
Remote terminal unit (RTU) environments
Correlation of events and alarms with production history
Data transformation and normalization
Data Buffering and Store & Forward features
Simple and fast configuration with powerful process event monitoring
rn
1-19
1-20
Module I
- Introduction
Capabilities
e
Multiple client interfaces [i.e., Thick, Terminal Services Edition (TSE) or Web Client]
.
e
.-
Wondeware Training
.
e
rn
In essence, the Wonderware System Platform facilitates consistent and reliable operations across
manufacturing and industrial operations to protect brand integrity. It empowers Wonderware
customers to extend their systems in virtually any direction to meet their current and future needs.
Module 1 - Introduction
ArchestrA
ArchestrA is a comprehensive plant automation and information architecture designed from the
outset to extend the life of legacy systems by leveraging the latest software technologies.
Offerings built upon this architecture empower decision-makers to achieve their business goals,
without abandoning prior investments in automation systems, production processes or intellectual
property.
ArchestrA's complete approach to industrial architecture significantly reduces a plant's total cost of
ownership through easy installation, operation, modification, maintenance and replication of
automation applications.
In the ArchestrA environment, software applications can be rapidly assembled rather than
programmed. New applications also can be created simply through the reassembly of existing
applications.
The ArchestrA vision is to provide a unified and robust architecture that is the basis for
collaborative production systems in support of industrial enterprises. Its open-development
platform and tools uniquely enable lnvensys and third parties such as OEMs, machine builders
and system integrators to build domain knowledge and add significant value to the solutions they
provide. End-users and suppliers will benefit from ArchestrA's unified platform, which enables the
instant integration of application information.
ArchestrA is the comprehensive industrial automation and information architecture that
orchestrates a new way to run or expand older plants more efficiently, and an optimal way to build
new ~ l a n t s .
Wondeware Training
BUSINESS
SYSTEMS
In most plants today, "islands of automation" within business and manufacturing systems hinder
the plant manager's ability to synchronize business processes in real time.
Recognizing this challenge, lnvensys has developed a solution, ArchestrATMautomation and
information architecture (ArchestrA).
A powerful new infrastructure for industrial applications, ArchestrA promises to provide an
information and control superstructure that will increase the productivity of a plant's existing
systems, while enabling the plant to easily integrate important new technologies over the longer
term. Building on ArchestrA research and technology, the recently released !/A Series A2TM
system (IIA Series A2) has taken the first major step toward reducing the risk of automation
obsolescence and protecting manufacturers' investments far into the future.
1-23
1-24
Module I- Introduction
Manufacturing Goals
For approximately a decade, manufacturers have been revising business practices, organization
charts, and systems infrastructures to become more market-driven and customer-centric. Their
overall objectives have been straightforward and consistent:
Become more responsive to market shifts and the increased competition brought on by
globalization
0
Develop greater agility and a more collaborative, data-driven environment.
Synchronize the manufacturing process with planning and scheduling functions to
optimize enterprise performance
Empower operators with critical information to foster improved plant performance
e
Utilize existing assets more efficiently to increase production, without the need to expand
the plant or build new capacity
e
Ensure the greatest possible return on assets, and improve profitability, in the face of
continuing manpower reductions
.
.
To achieve these goals, managers know they can no longer simply "invest in technology" and
expect improvements to come about automatically. In fact, millions of dollars have already been
invested with only marginal returns. However, management cannot afford to stand still, because
there are significant rewards to be reaped by those who develop improved responsiveness,
greater agility, and a higher return on assets.
Compounding the problem, many of yesterday's automation and information systems are
beginning to show their age, failing to offer the agility or rapid response that today's producers
require. Acting as a massive anchor, they actually impede the organization's forward progress as
they increasingly require greater amounts of maintenance and the corresponding expansion of
infrastructure support. But the original investment in these systems was so extensive - and so
visible to owners and investors - that it is understandably difficult to broach the subject of
"bulldozing" and starting over with the latest generation of technology. Further, it means not only
eliminating extensive hardware infrastructure, but also destroying an asset that is even more
valuable - the intellectual capital unique to the manufacturing mission.
Synchronization of Systems
Today's collaborative manufacturing environment requires that manufacturers synchronize
automation systems with business/information systems to accomplish total supply chain
management.
To facilitate this collaborative environment, many manufacturers are working toward a rational,
cost-effective solution that does not require enormous investment and allows for the preservation
of as much existing infrastructure as possible. They are preserving, to the maximum extent
feasible, existing investments in hardware and software, as well as in intellectual properties
contained in application-specific software. They are working to synchronize the various
informational elements within the manufacturing domain, namely automation systems, business
systems, and information systems, thereby fulfilling these systems' original promise of improved
manufacturing efficiency. They are identifying optimal long-term strategies based on total cost of
ownership.
The pace of change has increased to a point at which it is difficult for manufacturers to execute a
new strategy before market conditions change once again. Today's manufacturer, however, must
have the ability to respond to challenges that are virtually unanticipated. Response times have
now become the cornerstones of manufacturing competitiveness, and will remain so for the
foreseeable future.
Wonderware Training
Such an architectural infrastructure is available through ArchestrA. This allows manufacturers to:
Preserve a significant portion of their existing automation and information infrastructures
e
Integrate and synchronize existing production systems and new applications
e
Move ahead into the future, confident of shorter project execution times, reduced total cost
of ownership, and a proven, long-term strategy that will remain in a leadership position for
the life of the ~ l a n t .
ArchestrA Architecture
ArchestrA, developed by lnvensys, is a software infrastructure designed to unify combinations of
Invensys, third-party, and customer internal applications, both current and emerging, into a
synchronized, plant-level application model, and to foster their ongoing adaptation and
improvement. It comprises a unique combination of new toolsets and new applications
infrastructure services, allowing the rapid generation of new applications, products, and services.
Because it enables easy upgrades via integration of existing systems with these new technologies,
it offers manufacturers the promise of extending the lifecycle of an entire plant's information and
control system infrastructure.
ArchestrA facilitates the next logical extension of enabling software architecture designed to
accommodate emerging technologies and to ease the reuse of engineering from one project to
another. The objective of this unique technology is to dramatically reduce engineering and
maintenance time and expense when a manufacturer must modify or expand his company's
process. Incorporating ArchestrA will considerably reduce the cost and time involved in executing
strategic: change.
BUSINESS
SYSTEMS
1-25
Module I- Introduction
ArchestrA enables manufacturers to synchronize the various informational elements within the
manufacturing domain and supply the information required by business systems in real time.
ArchestrA provides a number of key functions designed to free users from the complexities of
dealing with current underlying technologies. So users require only assembly skills, not
sophisticated programming knowledge, and are able to apply their time to functions in which they
have more expertise. By embedding common application services directly into a common
infrastructure, application engineers can design and reuse solutions that are instantly integrated.
The key elements of the software infrastructure are the following:
Common design and development environment
e
Deployment, scripting, and calculation services
e
Alarm and event subsystems with reliable delivery
Built-in distributed architecture services for scalability
Integration with various types of field devices
.
..
e
e
e
e
e
e
Supervisory
3.
Production
4. Plant Intelligence
5. Manufacturing Collaboration
The following page illustrates these segments as they relate to the Automation lnformation
Pyramid.
Wondeware Training
1-27
1-28
Module I- Introduction
Scalability
Wonderware Application Sewer provides a scalable and integrated architecture to meet the needs
of small, simple applications all the way up to highly challenging manufacturing information
management systems
Wonderware Application Server resolves the problems associated with scaling automation
applications because there are no limitations on system size and performance issues are easily
addressed through the introduction of new nodes. New workstations and any data points defined
are automatically integrated into the initial application through the plant model. The common
distributed peer-to-peer Namespace means that all information is shared between the nodes
without the user having to perform any additional engineering or configuration.
I,
Structure
Graphics Development
Background Process
Promotion of Standards
Global Application Change
Data Represented By
1 Hlerarchlcal
Done Last
Developed in Objects
Strictly Enforced
Progagated from Templates
Physical Devices as Objects
Tag Based
Flat
Done Early
Developed in Tags
Not Strictly Enforced
Changed in Tools like Excel
Data Types and communication
Bits as Tags
--
From the inception of PC-based HMI and Supervisory products, the development of data access,
scripting, alarming and data analysis has been based on the concept of tags. While simple and
very portable from one project to another, a tag-based environment has the downfall of a flat
Namespace, with no inherent ability to link elements together into more intelligent structures, with
built in relationships and interdependencies. Global changes to a tag database are typically done
externally to the development environment, in tools like Microsofl Excel or as a text file and then
re-imported into the application. Reuse in a tag-based system is commonly instituted through
dynamic or client-server referencing, that allows a common graphic to be created. Then a script is
executed to switch the tags being viewed in run-time. Furthermore, because of the flat structure of
the application, changes need to be sought out and analyzed as to the affect on the rest of the
application.
Wondenvare Training
e
e
e
e
0
Animation Scripts
Security Scripts
Supervisory Scripts
Historical data storage
Integration with other applications and Databases
Event Detection
Flow and movement calculations
Device integration
AlarmstEvents
ocumentation
In order to fully realize the benefit of an Object-oriented architecture, a SCADA System today
needs to depict all of these things, along with the graphics as objects.
Types of objects
In object-oriented SCADA, objects contain the aspects or parameters associated with the device
they represent. For example, a valve object can contain all the events, alarms, security,
communications and scripting associated with a device. Objects don't just represent plant
equipment. They can also model common calculations, database access methods, Key
Performance Indicators (KPls), condition monitoring events, ERP data transfer operations and
many more things that you want the plant information system to do. Because these operations are
modular, it is easy to add them to any and all parts of the application. For example, let's say that
there is a standard way your organization calculates and initiates a maintenance work order for a
pump. By encapsulating this function as an object, it is possible to use it with any pump in the
application.
Module I - Introduction
Using object-oriented tools in manufacturing applications
Manufacturing applications typically have a lot of common components. These include common
types of:
Plant devices and equipment
e
Operating procedures
Process measurements
Calculations
e
Graphics displays
This leads to a cookie cutter approach, where typically small software programs are developed as
objectslcode modules that can be stamped out and joined together to form an application. Almost
all of the automation vendors have this capability today with their software. Where an objectoriented SCADA System is different, is that after the cookies are stamped out, you can change the
stamp, and all of the cookies you already made are automatically changed
Parent
Template
Child Objects
Replication
D~aphragm
valve
Diaphragm
valve
D~aphragm
valve
D~aphragm
valve
1
Change
Propagation
Powered
valve
Powered
valve
Powered
valve
Powered
valve
This is possible because when a SCADA package is truly object-oriented, it has the notion of a
parent-child relationship, where parent templates are developed and then "Child Objects" are
replicated or instantiated from the parent templates. Now all of the children are tied back to the
parent, so a change in the parent can be replicated to all of the children. This is an extremely
powerful development capability in that:
Application creation is optimized by using parent Templates and automated child object
replication
Project change orders are easily accommodated by making changes in the parent
template and having the child objects inherit the changes via change propagation
Ongoing system changes and expansions are easier and more cost effective because of
automated object replication and change propagation
Wondenvare Training
8.
1
0 Tags are defined and linked to the application
9.
If the application is to be deployed in a client-server environment, the application is rearchitected to centralize alarming, event detection, history archiving, graphics and 10 servers.
10. Changes to the system require shutting down the application, making changes to the many
scripts and tag database references to enable the new functionality, and reloading the new
HMI application on each workstation.
1. A site survey is conducted to understand the layout of the manufacturing operation or process.
Piping and Instrument Diagrams (P&ID) can also be referenced to understand the specific
equipment in use.
2. A list is developed of similar pieces of equipment, like common types of motors, valves,
transmitters, control loops, drives, etc. Distinct areas of operation are also identified.
3. Templates are configured'for each common device or component in the facility. For example,
there may be 100 transmitters of a particular type that can be modeled as a single device
template. This process sets up the standards for the supewisory application and for any
applications that are created in the future. These templates will be used to develop objects
which represent a specific device, such as a level transmitter LIC101. In addition, templates
contain all of the logic, inputloutputs, scripting, history configuration, security and alarms and
events for the device.
4.
..-
Device templates can be contained within each other to build-up a more complicated device,
for example, a mixer may contain a level transmitter, pump, inlet I drain valves and agitator.
1-31
Module I- Introduction
5. Device templates have attributes which represent real I10 available in the PLC or control
system. These attributes are then linked to the I f 0 through Device Integration Objects.
6. The application can then be assembled by using a simple drag and drop capability inside if the
ArchestrA IDE. As templates are dropped into their individual plant areas, an object instance is
created that is linked back to the template. This is the "Object-Oriented" nature of the
Application Server, which provides incredible power when it comes time to modify anything in
the system. The software does all the work as the user is simply configuring templates that
represent the equipment in the plant.
7. Objects are then assigned to security groups. This can be done on an individual basis or by
area of the plant. These security groups have common permissions. Roles are created to map
rights onto each security group. Users can be given one or more roles. This offers a great
amount of flexibility in changing user permissions and in managing the security model.
8.
The model created in the ArchestrA IDE can now be deployed to the computers that will host
the application. Notice that absolutely no consideration needs to be given to how the
supervisory stations are going to be laid-out or which computer needs to have a specific part
of the system running on it. The Application Server is a fully distributed system, which can
reside on a single computer or on hundreds of computers. Standard system objects, such as
Platforms and Engines, represent specific computers that are used to host objects when they
are deployed.
9. Graphics are then configured using lnTouch@,the world's most popular HMI software
package. This can also be done using the Smart-Symbol functionality contained in InTouch
9.0 SP 2 which allows a graphic element to be created and linked to a template in the
ArchestrA IDE. That way the display graphics are also object-oriented and tightly coupled to
the plant model.
10. Once the application is developed, maintenance of the system is easy. Changes made to
Templates can be propagated to the "Child Objects" linked to the Templates. For example, if
the units associated with a level transmitter need to change from gallons to liters, this can be
done once in the template, and the changes can automatically propagate to all the operator
displays in the plant.
Wondenvare Training
B
PUMP 1
OUTLEl
What is a Galaxy?
It's important to understand what a Galaxy is before one is created. A Galaxy is your whole
application. The complete ArchestrA system consisting of a single logical name space and a
collection of WinPlatforms, AppEngines and objects. One or more networked PC's that constitute
an automation system. It defines the name space that all components and objects live in and
defines the common set of system level policies that all components and objects comply with.
A Galaxy Database is the relational database containing all persistent configuration information for
all objects in a Galaxy.
And a Galaxy Repository is the software sub-system consisting of one or more Galaxy Databases.
1-33
1-34
Module I- Introduction
Creating a Galaxy
Each ArchestrA IDE session requires connection to a specified Galaxy. In other words, the
ArchestrA IDE cannot be started in a Galaxy-neutral state. When you attempt to start the
ArchestrA IDE, the Connect t o Galaxy dialog box is displayed.
Licensing information
If the Galaxy Name box is empty, you have not yet created a Galaxy on the computer shown in the
GR Node Name box. Before you can start the ArchestrA IDE, you must either browse for a Galaxy
on another node or create a new Galaxy.
All new Galaxies are created with no security. They also have the following characteristics: two
users (Defaultuser and Administrator, both with full access to everything), two security roles
(Default and Administrator, both with full privileges) and one security group (Default).
If you previously created one Galaxy on the GR node shown, the Galaxy's name is automatically
shown. Click Connect to start the ArchestrA IDE and to connect to that Galaxy. If you previously
created more than one Galaxy on the GR node shown, the most recently accessed Galaxy name
is shown. Choose the desired Galaxy from the Galaxy Name list and click Connect to start the
ArchestrA IDE and to connect to that Galaxy.
Wondeware Training
Lab 1 - Creating a
Introduction
This lab illustrates the steps necessary to create a default Galaxy and open the ArchestrA
Integrated Development Environment (ArchestrA IDE). Throughout this class you will use this
Galaxy to develop a sample application.
Objectives
Upon completion of this lab you should be able to:
r
Create a Galaxy
r Open the ArchestrA development environment
Note: To better facilitate the clarity of individual work in this training environment, because of the
Global Naming Space, ALWAYS preface the object name with your FIRST and LAST initial.
(e.a., if the user is Ann Brown, Valve would be ABValve)
1-35
1-36
Module I - Introduction
Create a Galaxy
1. Launch the Integrated Development Environment by selecting Start IAll Programs I
Wonderware IArchestrA IDE. This will display the Connect To Galaxy dialog box.
The GR node name field will reflect the name of the local computer.
The Galaxy name drop-down list is initially empty since there are no Galaxies created in this
node.
2. Click the New Galaxy button to create a new Galaxy. The New Galaxy dialog box is
displayed.
Wondeware Training
For Galaxy name enter the ABGalaxy and make sure Galaxy type is set to
4.
.
-
-.
...
.I
35% completed
I
...
-.
.: ..,
1-37
1-38
Module 1 - Introduction
5. As soon as the process is complete and the Close button is enabled, click Close
uccess u y c e
El
6. At the Connect To Galaxy dialog box the name of the newly created Galaxy, ABGalaxy, is
displayed in the Galaxy name drop-down list.
Wonderware Training
1-39
1-40
Module I- Introduction
Wondeware Training
..
This section provides an overview of the ArchestrA IDE, the Template Toolbox and Application
Views and the object Check-inlcheck-out process.
Object Configuration
rn
Create new objects
rn
Check out objects
Edit objects
m
Configure Historization through objects
rn
Configure objects for Alarms and Events
Extending object functionality
rn
Check in objects with comments
Deploy/undeploy objects
a
Propagate changes to runtime objects
rn View object's configuration errorstwarnings
1-41
1-42
Module I - Introduction
As the main aspects of the ArchestrA IDE Main View (e.g., Menu options, Toolbars, Template
Toolbar and Application Views, etc.) are identified and discussed, they are elaborated on in
greater detail as to how these Key Functions can be used
The Main Window of the ArchestrA IDE is composed of the following components:
Title bar
e
Menu bar
e
Toolbar
Template Toolbox
e
Application Views
e
Wondeware Training
Menu Bar
The ArchestrA IDE Menu Bar is a dynamic element that includes the following menus:
Galaxy, Edit, View, Object, Window, and Help. Depending on what object or Main Window
element is in focus, what condition it is in, or whether certain functions are logically permitted,
some menu commands may be deactivated. The following is a description of menu commands.
Galaxy menu - Providing Galaxy or user-level global commands, the Galaxy menu includes the
following:
1-43
1-44
Module 1 - Introduction
e
e
e
e
e
Close - For terminating the object edit session in focus. This command is available only if
the editor for one or more objects is open. If the object has been modified, you are
prompted to save the new data to the Galaxy Repository. The same validation scenario
applies as described in the Save menu command.
Import- For importing Automation Objects, Script Function Library, and Galaxy Loads.
Export - For exporting Automation Objects, All Automation Objects, Script Function
Libraries, and a Galaxy Dump.
Save- For saving the currently-opened object's configuration, which is persisted to the
Galaxy Repository. This command is available only if the editor for at least one object is
open and configuration data has been modified in at least one of them. Validation occurs
on the editor level; if errors or warnings are identified during validation, they are displayed
in a message box and the user is given the choice to continue saving or cancel the save.
Save All - For saving ALL the currently-opened object's configuration, which is persisted
to the Galaxy Repository. This command is available only if the editor for at least one
object is open and configuration data has been modified in at least one of them. Validation
occurs on the editor level; if errors or warnings are identified during validation, they are
displayed in a message box and the user is given the choice to continue saving or cancel
the save.
Configure - For configuring Security, the Time Master, or to Customize Toolsets.
Galaxy Status - For viewing information relating to the Galaxy such as the total number
of instances, total number of templates and other related Galaxy information.
Properties - For viewing the properties of the object in focus.
Change Galaxy - For selecting a Galaxy repository that is different from the one to which
you are currently connected, this command opens the Select Galaxy dialog box.
Change User- For changing the logged in user of this ArchestrA IDE, this command
opens the ArchestrA IDE Login dialog box.
Edit menu - providing edit capabilities, the Edit menu includes the following commands:
e
e
Wondeware Training
IDE
View menu - similar to a standard Microsoft View menu, this menu provides commands for
controlling the Main Window display. On your initial ArchestrA IDE login, all four Main Window
components listed below are visible (checked) and the client language is set to the one chosen
during installation. Subsequent logins by the same user implement the previously saved ArchestrA
IDE settings. This menu includes the following commands:
Model - For bringing focus to the Model view of the Main Window.
Deployment - For bringing focus to the Deployment view of the Main Window.
Derivation - For bringing focus to the Derivation view of the Main Window.
Template Toolbox - For bringing focus to the Template Toolbox of the Main Window.
Graphic Toolbox - For bringing focus to the Graphic Toolbox of the Main Window.
Operations - For displaying the progress and results of a set of Galaxy database
operations that can be done at the same time as other application-building operations.
Synchronize Views - For specifying that a selected object stay selected as you move
through the views.
Reset Layout - For resetting everything back to its original default locations.
Toolbars - For toggling onloff the Toolbar of the Main Window.
Status Bar - For toggling onloff the Status Bar of the Main Window.
1-45
1-46
Module 1 - Introduction
Objects menu - the Objects menu includes the following commands:
Check-Out - For checking out an object from the Galaxy Repository so that you can
maintain sole authority to configure that object. Nobody else connected to the Galaxy can
affect the configuration of the object until you have checked it back in to the Galaxy.
Check-In - For checking in to the Galaxy Repository an object which was previously
checked out. This command opens the Check-In Object dialog box.
Undo Check-Out - For reversing a previous check-out without affecting the configuration
of the object in question. The result of this command is the object can be checked out by
anyone connected to the Galaxy.
Override Check Out- Use this command to disable the checked out flag on the selected
object. This command typically requires special security permissions and should be used
only in those circumstances in which it is certain that object configuration is not being done
by the user who originally checked out the object. If the object's editor is currently open,
the override function fails.
Validate - For checking allowable attribute value ranges, compiling its scripts, updating
and binding its references, validating its extensions, updating its status, and validating
other configuration parameters that may be unique to the object.
Note: See "Validating Objects" on page 1-49 for additional information regarding this feature.
e
e
e
e
View i n Object Viewer- For allowing the evaluation of attributes and conditions when the
objects are deployed. It provides a visual display of the actions being executed.
Deploy - For deploying the object or objects currently in focus to the nodes their
configurations denote, this command opens the Deploy Object dialog box.
Undeploy - For undeploying the object or objects currently in focus from the nodes that
currently host them, this command opens the Undeploy Object dialog box.
Assign To - For assigning objects to a different plafform.
Unassign - For unassigning objects to a different platform.
Set As Default - For setting a System Object, such as WinPlatform or AppEngine, as the
default for assigning appropriate objects.
Wonderware Training
Window menu - For manipulating the Object Editor Client Area of the Main Window, this menu is
available if at least one object's editor is open. This menu includes the following commands:
Cascade - Standard Windows command for cascading (layering) multiple object editors.
Tile Horizontally - Standard Windows command for displaying the editors horizontally.
Tile Vertically - Standard Windows command for displaying the editors vertically.
Close All - For closing all open object editors. If any data was changed on any editor, you
are prompted to save those changes individually for each editor.
Windows - For selecting through a separate dialog box which editors to activate or how
they are to be displayed.
Help menu- similar to a standard MS Help menu, the ArchestrA IDE Help menu includes the
following commands:
Help Topics -Standard Help command, used for opening the ArchestrA IDE's HTML
Help documentation system.
Object Help - Provides information about the object in focus.
About ArchestrA IDE - Opens the About ArchestrA IDE dialog box which provides
software version and copyright information.
Operations Pane
The Operations pane displays the progress and results of a set of Galaxy database operations
that can be done at the same time as other application-building operations. Currently, validating
the configuration of objects is the only operation that uses this pane.
Important! Validation can be done on both templates and instances, but only on those that are
chedied in.
1-47
1-48
Module I - Introduction
Validating an object checks its configuration; that includes checking allowable attribute value
ranges, compiling its scripts, updating and binding its references, validating its extensions,
updating its status, and validating other configuration parameters that may be unique to the object.
Note: A primary use of validation is to validate objects that were configured prior to the importing
of relevant script libraries. Such objects would have a status of Bad. Validating these Bad objects
corrects references to the scriot libraries and uodates their status to Good.
To display the Operations pane, either
e
Right-click on an object (multi-select is allowed) and click Validate on the shortcut menu.
Click Operations on the View menu.
The following pane is then displayed in the Main Window.
&
BAppEnslne
$Area
$AnalogDevce
$DDESuteLmkCbent
Good
Good
&
~l
ood
Good
Succeeded
Succeeded
succeeded
Succeeded
If multiple objects are validated, the list of objects is sorted by object name. You can click a column
heading to re-sort according to alphanumeric or icon groupings. Use the check mark column
heading to sort for objects that are checked out and, therefore, cannot be validated. The object's
icon indicates checked out status with a check mark.
You can perform any operation on an object listed in the Operations pane that is possible in the
Template Toolbox or Application Views. Right-click on the object and select commands from
the shortcut menu. You can open an object's editor from the Operations pane by double-clicking
it. To view an object's properties (particularly, the ErrorsiWarnings page of the Properties dialog
box), double-click its status icon. You can also copy a line of text in the Operations pane list by
clicking Copy from the shortcut menu (or CtrlcC). The Operations pane, like the Template
Toolbox and Applications Views, is also updated as the status and conditions of objects in the
Galaxy change.
Wondeware Training
Manual Validation
To manually validate one or more objects, select the object(s) and click Validate on the shortcut
menu (by right-clicking the object) or on the Object menu. You can select objects from the
Template Toolbox, the Application Views or the Find dialog box.
Important! Manual validation can be done on both templates and instances, but only on those that
are checked in.
Using the Find dialog together with the Validate command is an especially useful tactic. For
instance, you can find objects in Error state, select them all, right-click on one of them, and click
Validate on the shortcut menu.
The Validate command opens the Operations pane in the ArchestrA IDE. See section on
Operations Pane for more information.
Only one validation operation can be run at a time. But you can multi-select more than one object
for each validation operation. The set of objects are validated serially.
Note: Validation ooerations cannot be canceled.
Continue using the ArchestrA IDE to perform other operations, if necessary, while validation is
ongoing, including work on objects in the validation set. If an object is not available for validation
when the command is initiated on it, validation is not be performed. Also, if validation is in process
on an object, other operations initiated by you on the object fail. Failure to perform validation on an
object is indicated in the Command Results column of the Operations pane.
To validate all objects in the Galaxy, validate the Galaxy object.
1-49
1-50
Module I- Introduction
Toolbar
The ArchestrA IDE Toolbar consists of icons for quick access to frequently used commands. It is
shown below, and each icon, from left to right, is described afterwards. The description titles
associated with each below are based on the tool tip that appears when you hover over each
Toolbar icon.
Change Galaxy - For selecting a Galaxy repository that is different from the one to
which you are currently connected, this command opens the Select Galaxy dialog box.
*,.-z
Import Automation Object - For importing a template definition file (.aapdf). This
command opens the standard Microsoft Open dialog box with the default file extension
(.aapdf). One or more files can be selected at a time. Validation is done with regard to the
selected file(s) being a valid template definition file. A progress indicator then provides a visual
view of the importing process. After the file(s) is imported, one or more new objects is added to
Galaxy Repository and the Template Toolbox displays the new object(s).
O ~ en For o~eninathe editor of the obiect in focus. The editor appears in the Object
Editor d~ientArea o i the Main Window
Save - For saving the currently-opened object's configuration, which is persisted to the
Galaxy Repository. This command is available only if the editor for at least one object is open
and configuration data has been modified in at least one of them. Validation occurs on the
editor level; if errors or warnings are identified during validation, they are displayed in a
message box and the user is given the choice to continue saving or cancel the save.
Find - For locating specific objects based on a variety of configurable search criteria.
Check-Out - For checking out an object from the Galaxy Repository so that you can
maintain sole authority to configure that object. Nobody else connected to the Galaxy can
affect the configuration of the object until you have checked it back in to the Galaxy.
h g d Check-In - For checking in to the Galaxy Repository an object which was previously
checked out. This command ;pens the Check-In Object dialog box.
Undo Check-Out - For changing an object's status from checked out to checked in.
Afterwards, any user can check out and configure the object. Undo Check Out places a
notation in the object's change log. Changes you made to the object when it was checked out
are backed out. An error message is displayed when the object's configuration editor is open.
&- ' Properties - For accessing the properties of tf?; object in focus.
Wondeware Training
Deploy - For deploying the object or objects currently in focus to the nodes their
configurations denote, this command opens the Deploy Object dialog box.
Undeploy - For undeploying the object or objects currently in focus fmm the nodes that
currently host them, this command opens the Undeploy Object dialog box.
bd
%,ssa
3 Customize Toolsets - For maintaining the toolset categories displayed in the Template
Toolbox, this command opens the Customize Toolsets dialog box.
User lnformation - For configuring global user preferences for the ArchestrA IDE
Using this command opens the Configure User lnformation dialog box.
Galaxy Status - For accessing the status of the current Galaxy.
Model View - For displaying the Model view in the Main Window.
""-2 Deployment View - For displaying the Deployment view in the Main Window.
bxs-i
Derivation View - For displaying the Derivation view in the Main Window.
Template Toolbox - For displaying the Template Toolbox in the Main Window.
Graphic Toolbox - For displaying the Graphic Toolbox in the Main Window.
Operations View - For displaying the Operations View in the Main Window.
IDE Help - Standard Help command, used for opening the IDE's HTML Help
documentation system.
The availability of the previously described icons is dynamic depending on which part of the
ArchestrA IDE's Main Window is in focus, whether a particular action is allowed, or whether
something has been changed in the configuration environment. Depending on these conditions,
some icons may be unavailable.
Template Toolbox
This part of the Main Window hosts object template toolsets, which contain object Templates, from
which instances are created or other object templates are derived. The Template Toolbox contains
separate toolset bars for each toolset in the Galaxy Repository. Click the toolset bar to open that
toolset and display the object templates contained in the chosen toolset.
1-51
1-52
Module 1 - Introduction
When you first log in, the default toolset with default object templates is opened. Once a user has
logged in to the Galaxy Repositoly, the Template Toolbox is loaded with the toolset that was
displayed during the last login session.
An example of a Template Toolbox view is as follows:
The items with " $ prefixes are templates or templates which were derived from other templates.
IDE
Application Views
The Application Views pane displays the galaxy configuration based on how an object is related to
other objects:
e
Model View - This defines the Object relationship to the automation scheme layout. The
Objects are organized into Areas to represent the physical plant layout.
e
Deployment View - This view defines the Object instance relationship to the PC that the
Object code is running on.
Derivation View - This view displays what the derivation path is from Base Template to
Instance. All templates and instances are displayed in this view.
The Model view is the default display when the ArchestrA IDE is first launched. Subsequent
ArchestrA IDE sessions retain the user's last setting.
Model View
The Model view presents objects in terms of their physical or containment relationships, and
allows you to organize them through a folder structure. This view most accurately represents an
application perspective of the processes that users are emulating: for instance, specific process
areas, tanks, valves, pumps and their relationships based on containment.
An example of a Model view is as follows:
4
ass~gnedArea
Galaxy Name
This view is used to display the assignment of Object Instances to their area. All Object instances
belong to one and only one area.
Areas can be hierarchical. This means that an area can contain an area and the parent area
collects the statistics for all its Objects and its sub-areas.
The above diagram represents the tree view that is displayed within the model view. This
represents the area based relationships of each of the objects. The diagram is read left to right and
top to bottom, so an Area can host Application objects, DevicelntegrationObjects,.and Objects that
contain Objects
If the instance does not have a defined host then the instance will be displayed under the
"Unassigned Area" root of the tree.
The top of the tree is the GalaxyObject, This is displayed using the name that was given to the
Galaxy when it was created.
To assign one object to another, drag-and-drop it. To unassign an object currently assigned to
another object, drag-and-drop it to the Unassigned Area folder.
1-53
1-54
Module I- Introduction
Deployment View
Note: More detail of the Deployment View is discussed in Module 2. Section 2, "The Deployment
Model", page 2-11.
The deployment view is used to display the assignment of the automation scheme to physical
machines and process engines. This view describes where the objects are running. This view
does not represent your physical plant environment.
An example of a Deployment view is as follows:
This diagram represents the tree view that is displayed within the deployment view. This
represents the topology view based on which PC and Engines the objects run on. The diagram is
read left to right and top to bottom, so a Platform can host an AppEngine. Also, an AppEngine can
host an Area.
If the instance does not have a defined host then the instance will be displayed under the
"Unassigned Host" root of the tree.
To assign an object to another, drag-and-drop it onto the host object. An inappropriate assignment
match is not allowed. Conversely, to unassign an object, drag-and-drop it to the Unassigned
folder.
Derivation View
The Derivation view presents objects and templates in terms of their genealogy relationships. The
derivation view is the only tree view that shows both templates and instances. The purpose of this
view is to display to the user from which templates and derived templates an instance inherits its
properties.
Wondeware Training
. ..
; :..-..@ AnalogDavice-001
6.. @
. $AppEngine
.
.
:---.. AppEngine-001
.
.
&
. $Area
.
:--.@ Area-OOi
El 8 $DiscreteDevice
El.. O BFieldReference
6..
. @
. $Winplatform
; '..-.%Winplatform-001
This view contains all templates and instances. The tree is displayed in alphabetical order at each
level within the tree.
The base templates created within the Applicationobject Toolkit is on the left, as all other
templates and instances are derived from these an extra level will be added to the tree.
The items with " $ prefixes are templates or templates which were derived from other templates.
Base templates are shown in the second level of the tree structure, and derived templates and
object instances are appropriately indented based on their relationship with parent objects.
Templates with no associated instances are grouped together under Unused Templates. Under
each branch of the tree, child objects are listed in alphabetical order. Default objects are displayed
in bold.
Unlike the Model and Deployment views, you cannot drag-and-drop objects from one branch to
another in the Derivation view. The parent-child relationship between a template and a
downstream object cannot be changed dynamically. You can perform other commands on objects
in this view.
Graphic Toolbox
The Graphic Toolbox contains the global ArchestrA graphics that can be used in the Galaxy. It lets
you organize your symbols in special folders, called Toolsets. The Graphics Toolbox shows a
treeview of toolsets which contains ArchestrA Symbols and Client Controls.
It allows you to define graphics as a standard that you can re-use, such as a generic valve symbol.
Symbols in the Graphic Toolbox can later be used by Automation templates and instances. You
can store ArchestrA Symbols here, if you only want to use them in InTouch and not in any other
Automation object content.
1-55
1-56
Module 1 - Introduction
An example of a Graphic Toolbox is as follows:
g.aAnalog Meters
@ &3~uttons
@ rnclock
&
acompressors
Counters
El.
DiqitalMeters
E l BDisplays
Fans
@-
BISA
Symbols
Lights 8.Indicators
a--&3 Panels
&- 0 Pipes
+.-&3
Pumps
Sliders
Switches
9.
Q val%/es
h...
Vessels
Object Icons
When viewing the objects, there are several states that are reflected in the way the icons for that
particular object are represented.
For instance, notice the different types of icons in the following example:
Wondeware Training
1-57
1-58
Module 1 - Introduction
Configuration status indicators include:
F.
. .
.Description
.. . -
. . .
. . .
... .
1-
.. --..
Configuratlon warning
! Description
-m
Icon
Wondeware Trarnrng
Or, right-click on the object and select Check Out. Optionally, an object is automatically
checked out to you when you open its configuration editor. If the object is already checked out,
you can open its editor only in read-only mode.
To determine an object's status and history, open the Properties dialog box.
1-59
1-60
Module I- Introduction
WinPlatform_OOl
WinPlatform_OOl
WinPlatFoim_OOl
WinPlatform_OOl
Defaultuser
Defaultuser
Defaultuser
DefaultUser
Updated configuration.
Updated configuration.
Checkin by user.
The user responsible for an operation at a specific date and time is listed on the Change Log
page. Comments typed by a user in the Check in dialog box (see image later) are listed under the
Comment heading.
Or, right-click on the object and select Check In. The Check I n dialog box is displayed
Note: If the object was originally checked out to you when you opened its configuration editor,
the check in function can be combined with the save and close functions of the editor. If you
close the editor without making any changes to the object's configuration, a check in operation
effectively does an undo check out (no change log recorded):
Wonderware Training
b. Enter a comment (optional) and click OK to finish checking in the object. Click Cancel to
terminate the check in process.
The Galaxy indicates whether any of the objects you are attempting to check in are check-out to
other people. If an object you are attempting to check in already is checked in, check in is ignored
The Check I n dialog box enables you to provide comments about configuration changes made
while the object was checked out. It is comprised of the following options:
e
Comment: Use this box to enter your comments about configuration changes made to the
object.
Don't Prompt for Check-In Comments in the Future: Use this check box to turn off the
comment feature when checking in objects in the future. If you decide to reinstate this
feature, click User lnformation on the Edit menu and select Ask for Check In
Comments in the Configure User lnformation dialog box.
1-61
Module I- Introduction
Object Viewer
Note: The Object Viewer is explained in more detail when the Runtime Environment is discussed
in Module 2, Section 3, "The Runtime Environment,", page 2-27
The Object Viewer monitors the status of the objects and their attributes and can be used to
modify an attribute value for testing purposes.
To add an object to the Object Viewer Watch list, you can manually type the object and attribute
names into the Attribute Reference box in the menu bar and select Go. When prompted to enter
the Attribute Type, press the OK key.
You can save a list of items being monitored. Once you have a list of attributes in the Watch
Window, you can select all or some of them and save them to an XML file. Right-click on the
Watch window to save the selection or load an existing one. You can also add a second Watch
window that shows as a separate tab in the bottom of the Viewer.
Refer to the Platform and Engine documentation for information about attributes that may indicate
system health. These attributes provide alarm and statistics on how much load a platform or
engine may have when executing application objects or communicating with 110 servers and other
platforms.
Wondenvare Training
Objects
Within the Template Toolbox there are three main categories of objects. These are:
0
Application objects
AnalogDevice
Boolean
DiscreteDevice
Double
FieldReference
n
Float
Integer
Sequencer
String
Switch
UserDefined
1-64
Module 1 - Introduction
Application Objects
@J Application
;..... @ $AnalogDevice
;-----@ $Boolean
;----. g $DiscreteDevice
;--.-- g $Double
;-----@ $FieldReference
;----. @ $Float
;---. Q $Integer
;---- Q $Sequencer
;----. 8 $String
Application Objects are used to create devices in your Galaxy. These devices represent real
objects in your environment.
AnalogDevice Object
This object can act as either an Analog lnput (with optional Output) or as an AnalogRegulator that
provides an external representation of a PID controller that exists elsewhere (typically a PLC or
DCS).
The AnalogDevice can be configured to have a personality of one of the two basic types:
Analog - a basic Analog lnput or Analog Output
e
AnalogRegulator - an analog controller that represents an external PID controller
When configured as Analog, this Template is very similar in functionality to the Analog Tag within
InTouch today. Just as the InTouch Analog can be configured for Read or Readwrite, the
Archestra AnalogDevice configured as type Analog can be configured as an analog input (with no
output capability) or as an analog output (with output capability). The Analog supports the basic
alarming capabilities of level alarms, ROC alarms and deviation alarms from a SP target value. In
addition, the Analog in ArchestrA provides additional functionality such as PV override enable, PV
mode (auto, manual), bad PV alarming, and separate output reference capability.
When configured as an AnalogRegulator, this Template provides both PV and SP monitoring of an
external PID controller. It provides SP output capability with an optional separate feedback
address for the SP. Other controller-oriented features include controller mode (manual vs.
cascade). All the alarm capabilities of the more basic AnalogDevice object are included, with the
difference that the SP value for deviation alarms is based on the SP value read from the controller.
Some of the common features of the AnalogDevice regardless of type (Analog or
AnalogRegulator) are:
e
Supports optional scaling of input and output, both linear and square root conversions.
e
Supports HiHi, Hi, Lo, and LoLo level alarms on PV with both value and time
deadbanding.
e
Supports Rate of Change (ROC) alarming on PV for both positive-slope and negativeslope ROC.
PV Override - when true, allows the PV to be written by a user if the PV mode is set to
Manual.
Adds SP read and write capability with'optional separate read-back address. For data
integrity, the value of SP always represents the value read from the external controller, not
the requested SP that is output to the external controller.
Wondenvare Training
*
e
Supports minor and major deviation alarming when PV deviates from SP.
Initial Control Mode - When in Cascade, the SP can only be written by other objects.
When in Manual, a user can write the SP. When None, anything can write to it.
Control Tracking - optional capability to read a Boolean control track flag from an external
device or object. When tracking is on, the SP is pure read-only and cannot be changed.
Boolean Object
The Boolean object is derived from the FieldReference object and is used for evaluations that
result in either of the truth values of 'true' of 'false', often coded 1 and 0 respectively.
DiscreteDevice Object
A Discrete Device is a general purpose Object that is used to represent a large class of physical
equipment common in manufacturing such as pumps, valves, motors, and conveyors. These
devices have two or more physical states (e.g. Open, Closed, Moving), and are optionally
controlled using a combination of discrete outputs. Their actual state is monitored via a
combination of discrete inputs.
The meaning of the states depends on the kind of Discrete Device. In the case of a pump, the
states might be configured as "Of? and "On", while for a valve they might be configured as "Open",
"Closed", or "Moving". Note that a control valve has a continuous position represented by 0 to
100% and is not typically represented with a Discrete Device, since its state is represented by a
continuous signal rather than discrete signal.
When a Discrete Device is commanded to a new state, it sets an appropriate combination of
discrete outputs for that state. When its monitored discrete inputs change, the Discrete Device
determines the new actual state of the equipment and sets the " P V (process variable)
appropriately.
Through the use of the Discrete Device the operator is guaranteed that a value displayed on the
screen is a good and reliable value. This object will automatically display the state as " B a d if the
quality of any of the inputs is bad or the inputs are in an invalid combination determined at
configuration time by the application developer.
Some of the features of the Discrete Device object are as follows:
lnput and Output states of the DiscreteDevice object are totally independent of each other
and can be configured as required by the user's application.
lnput and Output can be linked by alarms, which allow the object to detect
CommandTimeout and UncommandedChange alarms, when devices unexpectedly
change, or fail to change when commanded.
e
Supports devices with two to three commandable states ('Passive', 'Activel', and
'Active2') plus two additional states 'Fault' and 'InTransition' which cannot be commanded.
All those states with the exception of 'InTransition' and 'Passive' can trigger a state alarm.
e
Supports the three input modes 'Auto', 'Manual', and 'Simulate'.
Supports the two control modes 'Manual' and 'Cascade'.
CtrlTrack allows a PLC to notify the Discrete Device that the PLC is in control of the state
e
of the actual physical device, and is no longer accepting commands. If configured this
way, the Command attribute of the DiscreteDevice object just tracks PV (i.e., the state
indicated by its inputs).
.-
1-65
1-66
Module 1 - Introduction
D o u b l e Object
The Double object is derived from the FieldReference object.
FieldReference Object
The FieldReference object is the generic object for accessing data from an external device. This
object can act as both the field input and a field output.
The FieldReference Object can be configured into three basic access modes:
e
ReadOnly - Input object
e
Readwrite - Output object with scanned Feedback
e
Writeonly - Output
Float Object
The Float object is derived from the FieldReference object.
lnteger Object
The Integer object is derived from the FieldReference object.
Sequencer Object
The Sequencer object allows you to configure, execute, and manipulate a sequence of operations
associated with ArchestrA attributes within a Wondeware Application Server application.
You can use it to automate:
0
repetitive manufacturing procedures with a finite number of steps
r supervisory processes with a finite number of steps
Note: There is an Online Seminar available for the ArchestrA Sequencer Object. To register,
visit www.wonderware.comltraining or call 1-866-WW-TRAIN (1-866-998-7246) or email
Wondeware Training at training@wonderware.com.
String Object
The String object is derived from the FieldReference object.
S w i t c h Object
~he'switchobject is the object for accessing data from a simple discrete (011) device. This object
can act as both a discrete input and a discrete output.
Wondeware Training
Writeonly - Output
The PV value can be historized, logged as an event, and alarmed when abnormal.
UserDefined Object
The UserDefined object is an empty object that you can use to create customized objects. You can
use the UserDefined object in the following ways:
e
As a "container" for other objects. An object relationship in which one object is comprised
of other objects is called containment. Containment allows you to group various objects
together to make complex objects. For detailed information on object containment, see the
Integrated Development Environment (IDE) documentation.
To use the UserDefined object as a container object, you simply create an instance of the object,
and add ApplicationObjects to it while in the Model View. The only indication of this containment
structure is in the tree structure in the Template Toolbox or Model View. The UserDefined object
editor does not provide any indication of this containment relationship. To edit the configuration of
any contained objects, you must open the individual editors of those objects.
As a base object to extend through user-defined attributes (UDAs), scripting, and attribute
extensions. For detailed information how to customize an object using these features, see
the common editor documentation.
For example, you might create a UserDefined object called "Tank" and use it to contain
ApplicationObjects that represent aspects of the tank, such as pumps, valves, and levels. You
could create two DiscreteDevice object instances called "Inlet" and "Outlet" and configure them as
valves, and create an AnalogDevice object instance called "Level" and configure an alarm to be
triggered when it overflows. The containment hierarchy would be as follows:
--Tank
--V101 ( I n l e t )
--V102 ( O u t l e t )
--LT103 ( L e v e l )
The Tank object derived from the UserDefined object can be customized to raise an alarm when
both the lnlet and Outlet valves are open. For example, you could add a Boolean UDA called
"StateAlarm," extend it with an alarm extension, and add the following script:
i f r n e . i n l e t == "Open" a n d m e . o u t l e t == "Open" t h e n
me.statealarrn
else
rne.statea1a.m
endif;
true;
false;
You would now have a UserDefined object that forms the complex Tank object, which uses
containment and has been extended to raise a specific process alarm.
1-68
Module 1 - Introduction
Device lntegration Objects
@Device Integration
i... @j $DDESuiteLinkClient
1- $InTouchProxy
j... $OPCClient
L.%
TBRedundantDIObiect
A Devicelntegration object (DlObjects) is an Automationobject that represents communication
with external devices. DlObjects run on an AppEngine, and include DlNetwork Objects and
DlDevice Objects. A DlDevice Object is a representation of an actual external device (for example,
a PLC or RTU) that is associated with a DlNetwork Object. A DlNetwork Object is a representation
of a physical connection to a DlDevice Object via the Data Access Sewer.
A more detailed discussion of the Device Integration Objects will take place later in this course in
Module 2, "Application Infrastructure", Section 4, "Connecting to the Field on page 2-41
System Objects
AppEngine Object
The AppEngine Object must have a Platform on which to run. The key functionality of this object
includes:
e
hosting application objects, device integration objects and areas
containing the logic to setup and initialize objects, when they're deployed.
e
containing the logic to remove objects from the engine, when they're undeployed.
e
determines the scan time within which all objects within that particular engine will execute.
In general the AppEngine contains no added value other then to support the creation, deletion,
startup, and shutdown of objects.
Wonderware Training
InTouchViewApp Object
The InTouchViewApp object represents an lnTouch application in the Industrial Application server
environment. The InTouchVewApp object manages the check-in, check-out, and deployment of an
InTouch application.
When you create an InTouchViewApp for a new lnTouch application, WindowMaker is started by
the ArchestrA IDE. You then create the application the same way you would if WindowMaker had
been started from the InTouch Application Manager.
ViewEngine Object
The ViewEngine object is used to host InTouchViewApp objects. The ViewEngine object supports
common engine features such as deployment, undeployment, startup and shutdown. One
ViewEngine object can handle several InTouchViewApp objects.
WinPlatforrn Object
The WinPlatform platform object is a key base object. The key functionality of this object includes:
e
Calculating various statistics related to the node it's deployed to. These statistics are
published in attributes.
e
Monitoring various statistics related to the node it's deployed to. These monitored
attributes can be alarmed as well has historized.
e
Starting and stopping engines, based on the engines startup type, which are deployed to
it.
Monitoring the running state of engines deployed to it. If the platform detects an engine
has failed it can (optionally based on the value of the engine's restart attribute) restart the
engine.
There is a special instance of the platform object called the galaxy platform. This platform
instance:
Exists on the galaxy node.
e
Is used by message exchange to bind unresolved attribute references
1-69
1-70
Module I - Introduction
Wondeware Training
Templates
/Emt
Template
Child Instances
lnstances
lnstances are the run-time objects treat$ from templates in Wonderware Application Sewer.
lnstances are the specific things in your environment like processes, valves, conveyer belts.
1-71
Module I- Introduction
holding tanks, and sensors. lnstances can get information from sensors on the real-world device
or from application logic in Wonderware Application Sewer. lnstances exist during run time.
in your environment, you may have a few instances or several thousand. Many of these instances
may be similar or identical, such as valves or holding tanks. Creating a new valve object from
scratch when you have several thousand identical valves is time-consuming. That's where
tem~latescome in.
Creating an Instance - 1
Drag and drop the template object from the Template Toolbox to the Application View. To delete
an instance of the Platform object highlight it and click on the Delete icon in the menu icon bar
,:,.,."n
j($,<]
Wondenvare Tmining
@.
m
. D e v i c e Integration
!. m$DDESuiteLinkClient
.i . @$InTouchProuy
;. .. D$OPCClient
i..
~
It can now be renamed using the naming convention as designated by your instructor.
1-73
1-74
Module I- Introduction
Creating a n Instance 2
Highlight the object in the Template Toolbox for which you desire an instance. Then from the
Galaxy menu, select GalaxylNewllnstance or use the short cut which is Ctrl+N.
Component Names
ArchestrA AutomationObject Toolkit This is the toolkit for developing core ApplicationObjects,
in a C++ environment, which will be imported into the Galaxy via the IDE.
Area AutomationObject - the AutomationObject that represents an Area of a plant within an
Application Server Galaxy. The area object acts as an alarm concentrator and is used to put other
AutomationObjects into the context of the actual physical automation layout.
ApplicationEngine (AppEngine) - a real-time Engine that hosts and executes
AutomationObjects.
Applicationobject - An AutomationObject that represents Some element of a user application.
This may include things such as (but not limited to) an automation process component (e.g.
thermocouple, pump, motor, valve, reactor, tank, etc.) or associated application component (e.g.
function block, PID loop, Sequential Function Chart, Ladder Logic program, batch phase, SPC
data sheet, etc.).
AutomationObject - A type of object that represents permanent things in your plant (such as
Application Objects or Device Integration Objects) as objects with user-defined, unique names
within the Galaxy. It provides a standard way to create, name, download, execute, and monitorthe
represented component.
.-
Wondeware Training
1-75
1-76
Module I
- Introduction
Product Names
ArchestrAObject Toolkit - a programmer's tool used to create new Application and Device
Integration Object Templates, including their configuration and run-time implementations along
with their corresponding ID editors.
Wonderware Application Server - This is the product name given to the Wonderware A2
Application Server, which will run the objects as a blind node, allowing a product to be loaded on
top of existing systems to extend value. This product has an execution engine (AppEngine) which
hosts the application objects performing the functionality, and then stores this into a history
storage system, which is also included in the product.
DAServer Toolkit - This is the toolkit for building Data Access Servers, which are the next
generation of 110 servers, and are 110 server executable. These are OPC servers, and this toolkit
is to be a product which enables Wonderware and third parties to develop powerful OPC servers
which can connect to third party clients and Application Server clients.
Data Access Server (DAServer) - Refers to the Sewer executable that interfaces to the device
serving data to the DlNetwork Object and DlDevice Object, via standard client protocols OPC, or
to any third party client. These replace our current 110 Servers.
Components of a DAS Toolkit:
e
Client Plug-ins: These are the components which are added to a DAS server to enable
communication with clients. Examples are: OPC 2.03, DDEISuitelink, etc.
DAS Engine: This is the .DLL which contains all the common logic to drive data access
(this used to be called "Core toolkit").
Device Protocol: This is custom code set up by the user to define the communication
with a particular device.
DAS Control Client: This is the MMC snap-in supplied with the DAServer that provides
the necessary UI for activation and configuration.
DAS Diagnostic: This is part of the DAS Control Client MMC snap-in-that provides a
set of diagnostic information for DAServers within the system
DAS Configuration: This is part of the DAS Control Client MMC snap-in which
enables configuration of the DAServer either locally or remotely.
rn
DAS Activation: This is part of the DAS Control Client MMC snap-in which enables
the user to start and stop the DAServer.
DAS AppWizard: This is the C++ Wizard that generates the framework of the DAServer
Generic State Engines: These are engines which enable the device protocol developer
to build the particular functions:
rn
Device Engine
m
Serial Engine
TCPllP Engine
Hardware Requirements
The following list shows the recommended hardware requirements to install Application Server
version 3.0.
Galaxy Repository Platform:
e
Dual core PC with 2 gigahertz (GHz) or faster processor clock speed, or single core PC
with 3 gigahertz (GHz) or faster processor clock speed
Dual core processor recommended for optimal performance
2 gigabytes (GB) or more of RAM. (1 GB minimum supported; may limit performance of
some features) The Galaxy Repository locks the SQL Server maximum memory usage to
65% of the physical memory.
Non-Galaxy Repository Platforms (IDE or Runtime):
e
PC with 2 gigahertz (GHz) or faster processor clock speed
e
1 gigabyte (GB) or more of RAM
All Systems (IDE, GR, Runtime):
e
30 gigabytes (GB) of available hard disk space
Super VGA (1024 x 768) or higher resolution video adapter and monitor
e
The Windows Vista operating system imposes hardware requirements that may exceed the
minimum requirements for Application Server version 3.0. If you intend to run Application Server
3.0 with Windows Vista, see the following Microsoft web site for hardware requirements:
1-77
1-78
Module I- Introduction
Software Requirements
This section describes the operating system and other software requirements to install Application
Server version 3.0.
Operating System
The following table lists the supported operating systems that can be installed on computers
runnina server. client. and run-time comDonents.
I
Operating Systems
Windows Vista Business (See Vista Restrictions)
Windows Vista Enterprise (See Vista Restrictions)
Windows Vista Ultimate (See Vista Restrictions)
Windows Server 2003 Standard Edition SP2
Windows Server 2003 Enterprise Edition SP2
Windows Sewer 2003 Standard Edition R2 SP2
Windows Server 2003 Enterprise Edition R2 SP2
Windows XP Professional SP2
Windows XP Tablet 2005
Aoolication
Sewer Comoonents
.
Galaxy
ArchestrARun
ArchestrA IDE
Repositoly
Time
0
0
0
0
&3
13
I3
63
I3
0
&3
l
3
Notes:
Windows 2000 Professional, Windows 2000 Server, and Windows 2000 Advanced Server
are not supported operating systems for Application Server version 3.0. If you attempt to
install or upgrade Application Server on a computer running one of these operating
systems, an error message appears.
Windows Server 2003 Standard Edition SP2 is the recommended operating system to run
server components.
The Bootstrap, IDE, and Galaxy Repository are supported on the following language versions of
Microsoft operating systems: English, Japanese, Chinese, German, and French. The Galaxy
Repository is also supported in English, Japanese, Chinese, German, and French versions of
Microsoft SQL Server 2005.
Wonderware Training
SQL Server 2005 with SP2 (Standard or Enterprise) is the only database supported
by Application Server version 3.0. The Compact, Express, and Workgroup editions of
SQL Server 2005 are not supported for the Galaxy Repository.
The SQL Server 2005 SP2 database must be installed on the same computer as the
ArchestrA Galaxy Repository.
TCPIIP must be enabled on the computer running SQL Server. The TCPIIP protocol
setting can be verified from the SQL Server 2005 Network Configuration under SQL
Server Configuration Manager.
Microsoft Visual Studio 2005 (toolkits only)
.NET Framework Common Language Runtime (CLR) 2.0.50727
Note: The Microsoft SQL Server login for BUILTIN\Administrators group must be present and
enabled.
Note: Application Server 3.0 requires installing Microsoft SQL Server 2005. You cannot use
Microsoft SQL Server 2000 with this version. You also cannot install and use Application Server on
a computer that has both Microsoft SQL Server 2000 and Microsoft SQL Server 2005 installed.
Vista Restrictions
Application Server version 3.0 can run under Windows Vista Enterprise, Windows Vista
Business, or Windows Vista Ultimate. The Windows Vista Home Basic and Home
Premium editions are not supported.
Users must log on as a Windows Vista administrator to run Application Server version 3.0.
You cannot run Application Server as a Windows Vista standard user or power user.
You can run Wonderware 32-bit software only with a 32-bit version of Windows Vista.
Running Wonderware 32-bit software with a 64-bit version of Windows Vista on 64-bit
hardware is not supported
The Windows Vista User Account Control (UAC) must be disabled when running
Application Server. Refer to Microsoft Windows Vista documentation for instructions to
disable UAC.
When you disable Windows Vista UAC, you must restart the computer before attempting
to install the ArchestrA IDE or Wondeware Application Server. A Galaxy connection error
occurs if you attempt to install the ArchestrA IDE or Wondeware Application Server and
you did not restart the computer after you disabled the UAC.
Windows Vista does not support a traditional Application Server 3.0 single-node
configuration that includes Wondeware Historian (formerly IndustrialSQL Server).
A Vista Platform cannot be configured to be an alarm provider and also have InTouch
Windowviewer on the same computer configured to generate alarms. Only one of the two
will function properly as an alarm provider.
Windows Vista does not support NetDDE. ArchestrA graphics make use of the client layer
when accessing InTouch tags, and appear as a third-party client trying to access
1-79
Module I- Introduction
Wonderware Training
;.
If you have only one NIC, no action is required. The profiles and firewall rules are automatic.
2.
If the second NIC is not physically connected to anything (that means no wire in it), no
action is required. The profiles and firewall rules are automatic.
If the second NIC is connected, it MUST be configured. Follow the rules for
configuring a normal redundancy setup, Vista will identify this NIC and assign it a
Private profile. If the NIC is not configured, Vista will assign a profile of pubic to this
NIC and cause all of our firewall exceptions to be deactivated on all NICs. Forthe NIC
to be configured properly, give it an IP address, sub net mask and gateway address.
The gateway address can be the same as the IP address. Usually these addresses
will be the internal, non-routable addresses like 192.168.0.x or the 10.x.x.x range.
If you have more than two NICs, make sure all connected NlCs are configured with an
IP address and default gateway address and have been assigned a profile of Private.
1-81
1-82
Module I- Introduction
Licensing
-.
.......
......
-. .
. . .
. . -
I?
Description
...... ... - . . . -.
.
~ n i s ; e z t o me lora Appl callon Moue thal rcstdes in a Galaxy repository
Galaxy
Term
Platform Count
/ Number of PCs in the Galaxy (note each InTouch needs a platform to be part /
Note: If a license expires while you are using the ArchestrA IDE, you are not allowed to connect to
the Galaxv the next time vou ooen the ArchestrA IDE.
To check your current license, expiration date (if any) and limitations (if any), double-click the
License icon at the bottom of the ArchestrA IDE's Main Window
For more information on licensing requirements, please contact your local distributor.
--
Wondeware Tramnmg
1-83
1-84
Module 1 - introduction
Wondeware Training
Introduction
In order to successfully implement a project for the Wondeware A2 environment, you should start
with careful planning to come up with a working model of your plant or plant area. A six-step
project workflow is provided that describes how to complete different tasks in a logical and
consistent order, so that you minimize the engineering effort.
The project information that you define will become your guide when actually creating your
industrial application using the ArchestrA IDE. The better your project plan, the less time it will take
to create the application, and with fewer mistakes and rework.
1-85
1-86
Module 1 - Introduction
Plan Templates
rr
F~eldDevice
.-.
.
.
. - . ...
Valves
. ..-
7
5
1 Attribute Name
t
- -....- ..
*
Data Type
.- ...
..
. - . ...
2
G
f
Default
Description
..
Value
Default
Min Max Securily
(D
Inputs Q)
Wanderware Training
Examine each component in your P&ID and identify each basic device that is used. For example,
a simple valve can be a basic device. A motor, however, may be comprised of multiple basic
devices.
1-87
1-88
Module 1 - Introduction
Once you have created the complete list, group the devices according to type, such as valves,
pumps, and so on. Consolidate any duplicate devices into common types so that only a list of
unique basic devices remains, and then document them in your project planning worksheet.
Each basic device is represented in the ArchestrA IDE framework as an "object." An instance of an
object must be derived from a defined template. The number of device types in your final list will
help you to determine how many object templates you will need to create for your application. You
can group multiple basic objects to create more complex objects, which is a concept known as
"containment."
Historization. Are there process values associated with this device that you want to
historize? How often do you want to store the values? Do you want to add change limits
for historization?
Alarms and events. What values require alarms? What values do you want to be logged
as events? (ArchestrA IDE alarms and events provide similar functionality to what is
provided within InTouch.)
Security. Which users do you want to give access to the device? What type of access do
you want to give? For example, you may grant a group of operators read-only access for a
device, but allow read-write access for a supervisor. You can set up different security for
each attribute of a device.
YY123XV456
with the following attributes:
OLS, CLS, Out, Auto, Man
The following illustration shows how the naming convention in a traditional Human-Machine
Interface (HMI) is different from the naming within ArchestrA IDE:
Wondeware Training
ArchestrA
YY123XV456\OLS
.CLS
Individual Tags
Object
mformat~onrefer
to the InTouch to
IAS Migration
document
Object
Attributes
For ArchestrA IDE, references are created using this naming convention:
<objectnarne>.cattributename>
For example:
YY123XV456.OLS
1-89
Module 1 - Introduction
assigned to the selected Area. Before you begin to create instances in another Area, change the
default to the new Area.
A final consideration for constructing Areas is that the various Areas equate to alarm groups. It is
at the Area level that alarm displays can easily be filtered.
Object Templates
A template is an element that contains common configuration parameters for objects that are used
multiple times within a project. Templates are instantiated to represent specific objects within the
application.
For example, you might need multiple instances of a valve within your application, so you would
create a valve template that has all of the required properties. This allows you to define once, and
reuse multiple times. If you change the template, the changes can be propagated to the instances.
You can use simple drag-and-drop within the ArchestrA ID to create instances from templates.
Additional information on how to actually develop objects using templates is covered in Module 3,
"Planning for Object Templates" on page 3-7.
The next three steps (Planning Templates, Defining the Security Model, and Defining the
Deployment Model) are done once the initial Plant Model is in place. These are represented
through subsequent Modules in this training course. Please refer to additional information which is
available in the Wondeware A2 Deployment Guide.
Wondenvare Training
Your instructor will assign you a student number that you will use to create the unique identifiers
for each heat exchanger and mixer assigned to you.
This lab will helpyou familiarize yourself with the work that is going to be made in the rest of the
labs for the class.
Objectives
Upon completion of this lab you should be able to:
Understand the information that needs to be collected before proceeding to develop a
Galaxy
Feel familiar with the naming convention and device structure to be used in this class
2. Create the IDSfor the heat exchangers and mixers assigned to you
1-92
Module I - Introduction
Wondemare Training
*+
Signal
Equipment
Hm-TCl
TC4: T%n?peratureTransmitter
--
----
I
I
uo
l 1
Type
Float
--
Flat
RAW: 0 - 4095
EU: 0 250
Float
RAW: 0 - 4095
EU:0 - 250
Flat
RAW 0 4095
/I
EU: 0 250
I
I
Celsius
Celsius
1i
Celsius
I
1
j
!
i
1-94
Module I- Introduction
Wondeware Training
1-95
1-96
Wondeware Training
Application Infrastructure
Section 1 - The Plant Model
Lab 3 - Creating the Plant Model
Section 2
2-2
Wondeware Training
+Section + Area
+ Production
Line
Manufacturing
Cell
Once a plant application model has been developed, applications can be easily extended or
replicated based on the structure you have provided. With this Facility Model you can:
Rapidly create application standards.
e
Deploy applications across multiple plants or projects.
This provides universal application development capabilities. Additionally, it provides the ability to
build industrial applications that ensure consistent engineering quality and operational best
practices.
.-
2-3
2-4
Area AutomationObjects
WinPlatform AutomationObjects
AppEngine AutomationObjects
Device Integrationobjects
WinPlatforms, AppEngines and Device Integration objects do not report their alarms and events to
Area AutomationObjects even though they belong to Areas. This allows alarm clients to receive
alarm notifications without any dependencies on Area AutomationObjects. For example, a
deployed and running WinPlatform can report alarms even though its Area is not deployed and
running.
Using the Area model will become a filtering mechanism for alarms when we cover the Module on
Alarms and History.
Wonderware Training
lant Model
Introduction
This lab illustrates the steps necessary to create the plant model for the Galaxy based on the
information gathered in Lab 2 -Identifying the Mixer. An additional $Area instance is created to
accommodate future system objects created throughout the rest of this class.
To help organize the templates, a custom toolset is created to hold the templates created in the
class.
Objectives
Upon completion of this lab you should be able to:
Create new template toolsets
e
Create derived templates
Create instances
Use the $Area object to create a plant model for the Galaxy
Note: Remember to ALWAYS preface the object name with your FIRST and LAST initial.(e.g., if
the user is Ann Brown, Valve would be ABValve) This will eliminate problems when deploying
your objects in a common galaxy later in the course.
4. Arrange the new $Area instances to model the factory layout defined in Lab 2.
2-5
In the ArchestrA IDE, make sure that the Template Toolbox is selected
2.
In the Template Toolbox, right-click on the Galaxy and select New Template Toolset
Wonderware Training
In the Template Toolbox, create a derived template of the $Area object by right-clicking the
$Area template and selecting New I Derived Template.
2-7
2-8
i i g l e m p l a t e Toolbox
-
Wonderware Tram~ng
- 9 . X
-
8. Create a new instance of the 5ABArea template by drag-and-dropping the $ABArea object
from the Template Toolbox to the Model view.
Name the new instance ABDischarge.
&3 SDiroeteDevire
Device integration
2-9
2-10
9.
ABlntake
ABProduction
ABLinel
ABLine2
ABControlSystem
:
:. ...a' Model
..
-.
--
.. . -
. - - - . ... .
V V .
X-
!.---a
BJ
UnassignedArea
;...
/..... @ ABDischarge
j...- @ ABIntakr
i - 9ABLinel
;--9ABLine2
'-----9ABProduction
10. Drag-and-drop the newly created objects to assign areas ABLinel and ABLine2 to the
ABProduction area. The final plant model should look like the following illustration.
"-
j--- 9ABDischarge
: 9ABIntake
b '$ ABProdlrction
;..--9ABLinel [ ABLinel]
i...
9ABLineZ [ ABLine2 ]
Wondeware Training
Section Objectives
Explain the concept of the Deployment Model.
Demonstrate the structure and organizational execution of the Deployment Model.
This section provides an explanation of the Deployment Model and demonstrates the structure of
the Deployment Model.
...
2-11
2-12
b. On the Galaxy menu, click Galaxy Status. The Galaxy Status dialog box appears.
You see information about total instances, total templates, deployed instances with changes,
undeployed instances with changes, objects that have an error or warning state, objects that are
checked out, and object you have checked out.
c. Click OK.
Deploying Objects
You deploy object instances for three reasons:
e
Testing.
Place the application into production to process field data
Update an existing application with changes you made.
When you are ready to deploy, make sure the following conditions are met:
e
Bootstrap software is installed on the target computer(s).
The objects being deployed are not in an error state in the Galaxy database.
e
You created, configured, and checked in objects to the Galaxy.
Objects are assigned to a host.
The object's host is already deployed. A cascade deploy operation, which deploys a
hierarchy of objects, deploys all objects in the correct order:.This deploys an object's host
before the object is deployed.
Wanderware Training
b. On the Object menu, click Deploy. The Deploy dialog box appears
c.
d.
In the Currently deployed objects area, select one or more of the following options. These
options are not available if the selected object has not been deployed before.
e
Skip: If one of the objects you are deploying is currently deployed, selecting Skip makes
no changes to the already-deployed object.
e
Deploy Changes: If one of the objects you are deploying is currently deployed, this option
updates the object in question with new configuration data.
e.
Redeploy Original: If one of the objects you are deploying is currently deployed, this
option deploys the same version as previously deployed. For example, use this option to
redeploy an object that is corrupted on the target computer.
Force Off Scan: If one of the objects you are deploying is currently deployed, this option
sets the target object to off scan before deployment occurs.
In the Currently undeployed objects area, select the Deploy New Objects check box to
start a normal deployment.
2-13
2-14
In the Deploy Status Mismatch area, select the Mark as Deployed check box to mark the
object as deployed in the Galaxy. A mismatch happens when the object is previously deployed
to a target node, but the Galaxy shows the object is undeployed. Clear this option to redeploy
the object to the target node.
On Scan: Sets the initial scan state to on scan for the object@)you are deploying. If the
host of the object you are deploying is currently off scan, this setting is ignored and the
object is automatically deployed off scan. While deploying multiple objects the deploy
operation will deploy all of the selected objects "off-scan." Once all of the objects are
deployed the system will set the scan-state to "on-scan."
p~
Note: Objects can only execute when both the hosffengine is "on scan" and the object is "on
scan." If either the hosffengine or the object is "off scan," the object can not execute.
Note: Always deploy Areas to their host AppEngines on scan. Since Areas are the primary
providers to alarm clients, deploying Areas off scan results in alarms and events not being
reported until they are placed on scan.
e
Off Scan: Sets the initial scan state to off scan forthe object(s) you are deploying. If you
deploy objects off scan, you must use the ArchestrA System Management Console
Platform Manager utility to put those objects on scan and to function properly in the runtime environment.
Note: The System Management Console controls on the state of the hosffengine. The
Objectviewer controls the state of the objects.
Note: The default scan setting is set in the User Default settings in the Configure User
Information dialoa box.
h. Click OK to deploy the object@).The Deploy progress box appears. When the deploy is
complete, click Close.
Redeploying Objects
Redeploying is similar to deployment. While you are testing, you frequently redeploy your
application to see changes you make. The redeploying process undeploys the object and then
deploys it back.
You may have an object whose deployment state is Pending Update. That means the object
changed since it last deployment. When you deploy those changes, the new object is marked as
the last deployed version in the Galaxy.
To redeploy
a.
Wondeware Training
On the Object menu, click Undeploy. The Undeploy dialog box appears.
In the upper right of this dialog box, the Undeploy Object Count box shows the number of objects
being undeployed. You can select a single object in Application view and, if you selected
Cascade Undeploy and other objects are assigned to the selected object, the total number of
objects appears in this box.
b. Select one or more of the following. Some of these options might not be available, depending
on the kinds of object you select.
e
Cascade Undeploy: Select to undeploy the selected object as well as any objects it
hosts.
e
Include Redundant Partner: Select to also undeploy an AppEngine's redundancy
partner object.
Note: The AppEngine in a redundant pair that was configured as the Primary can be
undeployed alone because objects hosted by it run on the deployed Backup AppEngine,
which becomes Active.
e
Force Off Scan: If one of the objects you are undeploying is currently on scan, selecting
Force Off Scan sets the target object to off scan before undeployment. If you do not select
Force Off Scan and the target object is on scan, the undeployment operation fails.
On Failure Mark as Undeployed: Marks the object as undeployed in the Galaxy when
the object targeted for undeployment is not found
2-15
2-16
- Intentionally leff
Wondenvare Training
blank -
Objectives
Upon completion of this lab you should be able to:
e
Use the $Winplatform, $AppEngine and $Area objects to create a deployment model for
the Galaxy
Deploy instances to the runtime environment
Note: Remember to ALWAYS preface the object name with your FIRST and LAST initial.(e.g., if
the user is Ann Brown, Valve would be ABValve) This will eliminate problems when deploying
your objects in a common galaxy later in the course.
2-17
2-18
2. Create an instance of the $ABPlatform template named ABGRPlatForm and assign it to the
ABControlSystern area.
Create a derived template from the $AppEngine object named $ABAppEngine and assign it
to the A B Training template toolset.
4. Create an instance of the $ABAppEngine template named ABAppEngine and assign it to the
ABControlSystern area.
2-19
2-20
Using the Template Toolbox and the Model view, create a new instance of the $ABPlatform
template.
Name the new instance ABGRPlatform.
+- @
ABIntake
6.StJ ABProduction
i . @ ABLind [ ABLinel ]
ABLinEZ [ ABLineZ]
5. In the Model view, assign the ABGRPlatform instance to the ABControlSystem area
i -t., Model
.
.............
;..... @ ABIntake
6 9ABProduction
9 ABLinel [ ABLinel]
9ABLine2 [ ABLineZ]
Wonderware Tmining
8.
2-21
2-22
/..... Stj
Q
ABIntake
@ ABProduction
10. In the Model view, assign the ABAppEngine instance to the ABControlSystem area.
6-$j ABProduction
Stj
Wondeware Training
ABLinrl [ ABLinel]
ABLine2 [ ABLine2 I
n...
.-
ABGalax)
a,.
Unassigned Host
. a
.
;..
. @ ABControlSysterr
;..-.
/....@ ABIntake
.
.
.
..
.-
;. -9 ABDischarge
.
..
9 ABLinel [ ABLinel ]
9 ABLine2 [ ABLine21
:....-a
ABProduciion
2-23
2-24
ABGalaky
6 Unassigned Host
E l@
AEGRPlatforrn
l
i(
,:"
-
Wondeware Training
16. Leave the default settings andclick the OK button. This will d i s, ~ l .
a va second Deploy dialog
box indicating the progress onbeploying the objects.
Deploycomplete
Valldabng GRNodeInfu...
0
1
Chedong wheiher oblecis being deployed requlre software upgrade...
Sorbno and Valldabno 8 obiectM starbno from ABGRPlafform hosted bv ~lafformABGR!
2-25
2-26
"-
i--.-6% ABIntake
Wonderware Trarnrng
"-
;----&% ABIntake
6 -& ABProduction
i... & ABLinel [ ABLinel]
& ABLine2 [ABLine2]
..
Section Objectives
Explain the concept of the Runtime Environment.
lllustrate the differences in the Development environment and the Runtime environment.
Explain the use of the Object Viewer in monitoring the Runtime environment.
This section provides an explanation of the Runtime environment and explains the use of the
Object Viewer in monitoring the Runtime environment.
Runtime Environment
The previous workflow task defined the deployment model that specifies where objects are
deployed. In other words, the deployment model defines which nodes will host the various
AutomationObjects.
The objects deployed on particular platforms and engines define the objects' "load" on the
platform. The load is based on the number of 110 points, the number of user-defined attributes
(UDAs), etc. The more complex the object, the higher the load required to run it.
After deployment, the Runtime environment facilitates the activity generated by the objects. In
Application Sewer the Object Viewer is used to monitor the Runtime environment. The Object
Viewer is used to check communications between nodes and determine if the system is running
optimally. For example, a node may be executing more objects than it can easily handle, and it will
be necessary to deploy one or more objects to another computer.
To view the activity in the Runtime database the Object Viewer is used. It displays the current
value of all of the objects and object attributes in the database. In order to create the Runtime
database, Application Sewer requires information about all of the variables being created. As
object and object attribute values change (e.g. created, value change, configuration change), the
changes are reflected in Runtime and monitored via the Object Viewer.
Object Viewer
The Object Viewer monitors the status of the objects and their attributes and can be used to
modify an attribute value for testing purposes.
To add an object to the Object Viewer Watch list, you can manually type the object and attribute
names into the Attribute Reference box in the menu bar and select Go. When prompted to enter
the Attribute Type, press the OK key.
You can save a list of items being monitored. Once you have a list of attributes in the Watch
Window, you can select all or some of them and save them to an XML file by right-clicking on the
Watch window and selecting Save. A previously saved Watch window can also be loaded to
monitor previously saved attributes. You can also add a second Watch window that shows as a
separate tab in the bottom of the Viewer.
.-
2-27
2-28
COiW
C?
co;-
C*
PI
Wondeware Training
Objects whose configuration are successfully uploaded have a new version number and a change
log entry for the upload operation. The run-time object's version number also has a new version
number. That version number matches the version in the configuration database.
If you select an object that is currently checked out to you, a warning appears during run-time
upload. If you continue, you lose all configuration changes you made to the checked out object.
The Galaxy performs an Undo Check Out operation on it before the run-time attributes are copied
to the Galaxy database.
Note: You cannot upload run-time changes for obiects checked out to other users
To upload run-time changes to the Galaxy
Select one or more objects in the Model view or Deployment view. For example, you could
select an entire hierarchy from AppEngine down.
On the Object menu, click Upload Runtime Changes. The run-time attributes of the selected
objects are copied over those in the Galaxy database.
2-29
2-30
Wondeware Training
Objectives
Upon completion of this lab you should be able to:
e
Open Object Viewer from the ArchestrA IDE
Add attributes to watch windows to get a live feed
.
e
Note: Remember to ALWAYS preface the object name with your FIRST and LAST initial.(e.g., if
the user is Ann Brown, Valve would be ABValve) This will eliminate problems when deploying
your obiects in a common galaxy later in the course.
Using O b j e c t v i e w e r
1. Open Object Viewer from within the ArchestrA IDE.
2. Rename the default watch window to Platform lnfo and add the following attribute references:
e
ABGRPlatforrn.CPULoad
ABGRPlatforrn.DiskSpaceFree[l]
ABGRPlatform.RAMAvai1ableAvg
3. Create a new watch window called Engine lnfo and add the following attribute references:
e
ABAppEngine.Scheduler.ScanPeriod
e
ABAppEngineScanState
ABAppEngineScanStateCmd
4. Save the watch list to you training folder (C:\Wonderware Training) with the name My Watch
Windows.
2-31
Using Objectviewer
1. In the Model view, open Object Viewer by right-clicking the ABGRPlatlorm instance and
selecting View in Object Viewer.
Wonderware Training
3.
Right-click in the Watch List (bottom section of Object Viewer) and select Rename Tab to
rename the default Watch List Itab
Modify.,.
Remove horn Waiiii
Add Atblbuti? Reference..
2-33
2-34
Wondeware Training
ABGiilaxy
EnaMe
Enable
false
false
C0:Good
CO:Good
CO:Good
CO:Gaod
CO:Good
CO:Good
GR.TimeORastCon%Chanse
$26/20074:35
...
CO:Good
Ok
Ok
Ok
Ok
Ok
Ok
Ok
operate
Readmly
ReadOnly
Readhly
Readhlly
Readmy
ReadOnly
operate
opwate
Readonly
Resdmly
Readmly
Readonly
ReadOniy
Readonly
ReadOnly
Readonly
ReadOnly
Tune
ReadOnlv
~ead0nl;
Writes
...
Cdda...
writes...
S y r t m...
system...
systan...
CaloAa...
Wntea ...
Writea ...
CidoAa...
Writea.. .
sy* tan...
Writea...
Writea. ..
System...
System...
Calcula. ..
Cdcula...
!wtea...
Cdcula. ..
Cdmla...
UnL&d
CustomEnum
CustomEnum
Boolean
Boolean
inteaer
RefeienreType
Integer
Integer
Boolean
lime
Time
2-35
2-36
8.
Right-click in the Watch List (bottom section of Object Viewer) and select Add Watch
Window to add a new tab to the watch list.
Rename Tab..
Open..
Save
Save As...
Wondeware Trammg
..
Right-click in the Watch List (bottom section of Object Viewer) and select Rename Tab to
rename the default Watch List I tab.
...
Modify
Remove +on Watch
...
Open
save
Save As..
Enter Engine Info for the Tab Name field and click OK.
-OK-_I
Cancel
2-37
2-38
Wondenvare Training
13. Right-click in the Watch List (bottom section of Object Viewer) and select Save As to save
the watch list to disk.
...
...
Open..
2-39
2-40
----
Wonderware Tmmmg
..
Section Objectives
Be famdiar w;th Device lntegration Objects, 110 Server and Data Access Server
Overview of Dl Objects.
Introduction
'Dynamic Data Exchange (DDE)
Dvnamic Data Exchanae
- ,1DDE) is a communication Drotocl31 developedi by Microsoft to allow
athications
in the Windows enhronment to sendlreckve data and instrt~ctionstolfrom each other.
,
It implements a client-server relationship between two concurrently running applications.
The server application provides the data and accepts requests from any other application
interested in its data. Requesting applications are called clients. Some applications such as
InTouch and Microsofl Excel can simultaneously be both a client and a server.
Note: NetDDE, an older protocol used for communication over the network to Wonderware and
non-Wonderware sources, is supported on Windows XP and Windows 2000, but not on Windows
2003 Server. Communication with Wonderware sources is recommended using SuiteLink.
2-41
2-42
--
Wondenvare Tramng
2-43
2-44
.....
$GPCCiient
'..... W BRedundantDIGbiect
A Devicelntegration object (DlObjects) is an Automationobject that represents communication
with external devices. DlObjects run on an AppEngine, and include DlNetwork Objects and
DlDevice Objects. A DlDevice Object is a representation of an actual external device (for example,
a PLC or RTU) that is associated with a DlNetwork Object. A DlNetwork Object is a representation
of a physical connection to a DlDevice Object via the Data Access Sewer.
DDESuiteLinkClient
The DDESuiteLinkClient object is a key member of the core set of AutomationObjects within the
ArchestrA system infrastructure. The DDESuiteLinkClient object is a Deviceintegration object that
allows access to a running 110 Server. A DDE or SuiteLink I10 Sewer can provide data points to
Galaxy application objects through the DDESuiteLinkClient object.
Note: The DDESuiteLinkClient object is compatible with ail Wonderware 110 Sewers and
components.
There is a one-to-one relationship between an instance of the DDESuiteLinkClient object and a
running 110 Sewer. If you want to reference data points in more than one I10 Server, you must
configure and deploy more than one DDESuiteLinkClient object. For example, you would need to
configure one DDESuiteLinkClient object to communicate to an ABTCP 110 Server and another
one to talk to the GEHCS I10 Server.
When you configure the DDESuiteLinkClientobject, you can specify one or more I10 Sewer topics
to which access is required. At run time, ail items that the Galaxy application requires for a
specified topic are updated with the latest values from the I10 Server. The rate at which the values
are updated depends on how the topics were configured within the target 110 Server.
If you want to connect to a DDE I10 Sewer, specify login information that the DDESuiteLinkClient
object uses to connect to the 110 Sewer.
From other objects and from scripts, you can reference the topics you configured for the
DDESuiteLinkClient object. For example, you might configure the input source for a
FieldReference object to reference an item for one of the topics. Thus, the FieldReference object
input source is receiving data from an 110 Sewer through the DDESuiteLinkClient object.
To aid in rapid application development, you can create a list of topic items that appear in the
ArchestrA Attribute Browser. To do this, specify the item address and associate it with a userdefined attribute name (alias). Creating the item list is not required in order to reference data from
the 110 Server.
The reference syntax for a DDESuiteLinkClient object data point is:
<objectnarne>.<topicname>.<itemname>
OR
<objectname>.<topicname>.<attributename>
The <objectname> is the name that you choose to give to the DDESuiteLinkCiient object.
Wondenvare Training
InTouchProxy
The InTouchProxy Object is a gateway between Galaxy application objects and data that is
available through an lnTouchTMapplication. The InTouchProxy object allows you to browse a
selected InTouch application tagname dictionary, add selected tags as attributes in the Galaxy
application, then read these attributes from the InTouch application at run time.
Note: Before using the tagname browser to browse for tags, make sure that InTouch
WindowMaker is not running on the InTouch node. Windowviewer, however, can be running. Also,
be sure that you have given share permission of Read to the InTouch folder that contains the
Tagname.X file.
The InTouchProxy object is a key member of the core set of AutomationObjects within the
ArchestrA system infrastructure. The InTouchProxy object is a Devicelntegration object that
represents a running InTouch node. The InTouch node effectively serves as the data provider
(supporting the SuiteLink communication protocol) by providing data points to Galaxy application
objects through the InTouchProxy object.
Note: This obiect is com~atiblewith InTouch v7.11 and later a ~ ~ l i c a t i o n s
There is a one-to-one relationship between an instance of the InTouchProxy object and a running
InTouch node. An InTouch "node" is a unique combination of the computer name and InTouch
application. If you want to reference data points in more than one InTouch node, you must
configure and deploy more than one InTouchProxy object. For example, you would need to
configure one InTouchProxy object to get data from an InTouch application running on Computer1
and another one to get data from an InTouch application running on Computer2.
When you configure the InTouchProxy object, you might want to specify one or more existing
InTouch tagnames (items) to use as object attributes. At run time, if these attributes are added in
the client (for example, the Object Viewer watch window), they are updated with the latest values
from the InTouch items. InTouch sends a new data value for an item to the InTouchProxy object
each time the value changes. Any items that you configure for an InTouchProxy object
automatically becomes available within the ArchestrA Attribute Browser.
From other objects and from scripts, you can reference the attributes you created for InTouch
items. For example, you might configure the input source for a FieldReference object to reference
one of these InTouchProxy object attributes. Thus, the FieldReference object's input source would
be receiving data from a tag in an InTouch node through the InTouchProxy object. The reference
syntax for an InTouchProxy object data point is:
<objectname>.<InTouchTagName>
The <objectname> is the name that you choose to give to the InTouchProxy object
The group of specified InTouch items for an InTouchProxy object is also known as the "scan
group." Only one scan group exists in the InTouchProxy object. Run-time object attributes within
the scan group allow you to monitor errors related to the data quality for InTouch item values in a
scan group.
2-45
2-46
An OPCClient object supports the following operations on 110 points for the OPC DA Server:
Subscriptions, which are implemented via scan groups. Read transactions, which are
implemented via block reads.
e
Write transactions, which are implemented via block writes.
Note: If you are using this object to communicate with an OPC DA Server, you must properly
configure the OPC DA Server before deploying this object.
RedundantDlObject
The RedundantDlObject provides you with the ability to configure a single object with connections
to two different data sources (proxy objects or DlDevice objects). In the event of a failure of the
active data source, this object automatically switches to the standby data source.
This capability allows clients to configure redundant connections to a field device
The RedundantDlObject is a Devicelntegration object that makes redundant connections to a field
device possible. If one of the source objects is unable to provide connection to the field device, the
RedundantDlObject automatically switches to the other source object for continued data
acquisition.
The way the RedundantDlObject determines that a data source is in Bad state by monitoring the
Connectionstatus attribute common to all DlObjects, the ProtocolFailureReasonCode attribute
that reflects a failure in communication by a DAS DlObject with a field device, and the Scanstate
attribute common to all ApplicationObjects. When those attributes are, respectively, Disconnected,
non-zero, or Offscan, the status of the corresponding data source object is changed and a
switchover attempt is made to the other data source.
There is a one-to-two relationship between an instance of a RedundantDlObject and a pair of
source Devicelntegration objects.
The RedundantDlObject supports the following operations on I10 points from field devices:
e
Subscriptions, which are implemented via scan groups. Read transactions, which are
implemented via block reads (when available in the source DlObject). Write transactions,
which are implemented via block writes (when available in the source DlObject).
Wonderware Training
Note: Most Applicationobjects in the ArchestrA environment write only the last data received in a
scan cycle. DevicelntegrationObjects, including the RedundantDlObject, operate differently. They
queue all data received in a scan cvcle and write them all in the order received.
The two source DlObjects do not have to be the same type. But they must support the same type
of DAGroups and must have the same item address space.
Note: The RedundantDlObject checks the state of its source DlObiects on every scan cvcle.
Note: During configuration, one DlObject is set as the Primary Dl source and the other is set as
Backup Dl source. These are just the starting points. During runtime, the terms Active and Standby
apply, the configured Primary object initially being the Active object (if able to provide connection
to the field device) and the configured Backup object initially being the Standby. If the connection
to the Active object fails, then the Standby becomes the Active one and the other becomes the
Standby. This switching between Active and Standby objects can be repeated multiple times
depending on the configured switch attributes.
For complete redundancy coverage, the RedundantDlObject must be configured to have the
DAGroups that are common to both source DlObjects. When the connection fails to the Active
DlObject, all items are unsubscribed from the Active DlObject and new subscriptions are made to
the Standby DlObject. If either DlObject has unique DAGroups, it is important that the
RedundantDlObject should not be configured to use those uncommon DAGroups.
RedundantDlObjects belong to a family of objects called DlNetwork objects.
2-47
For Device Integration objects like ABClP and ABTCP DlNetwork objects, both the
DAServer and the corresponding Dl Objects must reside on the same computer hosting
an AppEngine.
I10 Servers can run on Workstations, provided the requirements for visualization processing, data
processing, and 110 read-writes can be easily handled by the computer. Run the I10 Server and
the corresponding Dl Object on the same node where most or all of the object instances (that
obtain data from that Dl Object) are deployed.
This implementation expedites the data transfer between the two components (the I10 Server and
the object instance), since they both reside on the same node. This implementation also minimizes
network traffic and increases reliability.
However, it is good practice to evaluate the overhead necessary to run each
Wonderware Training
The DAServer is like a driver: it can receive data from different controllers simultaneously. For
example, a DAServer might use OPC to access data remotely in one machine, and use InTouch to
communicate with another machine. When a DAServer transfers data, it also transfers a
timestamp and quality codes.
The DAServer is flexible enough to be used in a variety of topologies, but some topologies are
more efficient than others.
For example, the DAServer can connect to the OPC Server directly across the network, or
FactorySuite Gateway can be placed on the same machine as the OPC DAServer and SuiteLink
can be used to link the server to devices. Of the two topologies, using FactorySuite Gateway is
more efficient than connecting the DAServer directly to the OPC Server.
OPC DAServer technology also has drawbacks; for instance, data may be lost briefly without the
user realizing the loss has occurred.
2-49
2-50
Module 2
- Application Infrastructure
Wonderware Training
Objectives
Upon completion of this lab you will be able to:
Create and configure a $DDESuiteLinkClient object to connect to an 10 Server or DA
Server using SuiteLink as the communication protocol
Monitor the connection status of the $DDESuiteLinkClient object on runtime
Note: FOR THlS LAB ONLY!!! This time you will NOT preface the object name with your FIRST
and LAST initial. Aaain, this is for THlS LAB ONLY!
4.
On the Topic tab, add a topic called tagname and import the Incontrol Items List.csv file
from the C:\Wonderware Training folder.
5.
In the Model view, assign the Incontrol instance to the ABControlSystem area.
Deploy t h e Object
6. On the Deployment view, assign the Incontrol instance to the ABAppEngine object and
deploy the object.
2-51
2-52
8. Using the watch list created in Lab 5, create a new watch window called Incontrol and add
the following attribute references:
e
Connectionstatus
e
Reconnect
ServerNode
Se~erName
ComrnunicationProtocoI
e
ScanGroupList (enter 1 as the array index)
9.
Wondenvare Training
2-53
2-54
Using the Template Toolbox and the Model view, create an instance of the
$ABDDESuiteLinkClient template. Name the new instance InControl. (Note that you will not
use your initials for this object)
Server node:
Server name:
Priority:
Communication protocol:
.c--,.8 : K
8-4
,.
..........
E c i r a - h r v huser
!
Domain name:
Wondeware Training
Sewer node: <ask your instructor>. The following screenshot uses 'MOE' as an
(+F"
+?I)cl
example.
Sewer name: RTEngine
Communication protocol: SuiteLink
2-56
9. With the topic tagname selected, click the Import button at the Associated attributes for
tagname section.
The Open dialog box is displayed. Navigate to the C:\Wonderware Training folder, select the
Incontrol Items List.csv file and press the Open button.
Wondeware Training
-11 Click the Save and Close button and check in the object.
13. In the Model view, assign the Incontrol instance to the ABControlSystem area.
...
i.
....
. & ABAppEngine
i
i&.-& ABIntake
&.- 63 ABProduction
6
. @Unassigned
.
i !.....@
B
Host
ABGRPlalform
6;.@ ABAppEngine
ABControlSystem
...
& ABDischarge
i . 6%
ABIntake
j .
Wondenvare Training
Lo Deployment
- .
,a
Unassigned
. .--
- P X
,A
Host
$.-@ ABGRPiatforrn
R- @ ABAppEnqine
;----$3ABControlSystm
i-.-. i;il ABDischarge
I...-.611 ABIntake
i--- ABLinel [ ABLinell
i - ABLine2 [ ABLineZ]
2-59
This will display a second Deploy dialog box indicating the progress on deploying the object.
As soon as the process is complete, the Close button will be enabled.
aUnassignedHost
8 . @ ABGRPlatforrn
@-.- @ ABAppEngine
+ $3ABControlSystm
:r.i
..
:.
i.
;---.-63 ABDischarge
: 63 ABIntake
: & ABLinel [ ABLinel ]
@
...
.
I.--
& ABAppEngine
63 ABProducUon
'..... 63 ABLinel[ ABLinel]
'..... 6% ABLine2[ABLineZ]
2-61
2-62
22. Right-click in the Watch List (bottom section of Object Viewer) and select Add Watch
Window to add a new tab to the watch list.
M0dfy..
Remuve kcm Waicii
Add Atirlbute Reference.,,
Rename Tab..
Open..
Save
Save As..
Wonderware Training
I
I
~ d watch
d
whdow
...
Open
Save As...
24. The Rename Tab dialog box is displayed. Enter Incontrol for the Tab Name field and click
OK.
25. On the Attribute List (lefl section of Object Viewer) locate the following
- attributes, right-click
on them, and select ~ d t odWatch to add them to the watch list:
e
ConnectionStatus
Reconnect
e
ServerName
ServerNode
CommunicationProtocoI
ScanGroupList (enter 1 as the array index)
I----
Atb b~teRefmnce
Value
0d1ty
1nControl.ConnecbonSt~tus
Connected
1nControl.Reconnect
InControlServerNarne
InControlServerNode
RTEngine
C13:Good
CO:Good
CO:Good
CO:Good
CO:Good
C0:Good
false
MOE
Suitelink
InControl.A~B~(SmnGroupList)[l] tagname
1nCon~ol.ComrnunicationProtocol
/ stab2
Ok
Ok
Ok
Ok
Ok
Ok
2-63
..
Modi*.
Remove from \Vat&
Wonderware Training
Application Objects
Section 1 - Templates and Instances
Section 2
Lab 9 - Meter
Section 5 - The $DiscreteDevice Object
3-2
Wonderware Training
Module Objectives
Be able to
Identify and work w ~ t htemplates
Derive and configure templates
3-4
Wondeware Training
This section:
Introduces you to the concept of templates and explain how to derive a template.
This section introduces you to the concept of templates and explain how to derive a template.
Templates
One of the major benefits of Application Server is that it allows you to re-use existing engineering.
Working with templates is the best way to illustrate such capability.
A template is an entity that represents the common functional requirements of a field device
(valves, pumps), a group of field devices (skids, stations), or a user function (algorithms). These
requirements reflect information such as number of Inputs and Outputs, alarm conditions, history
needs, and security. One object template performs the equivalent functions of multiple InTouch
tags and scripts.
A template is created either from a base template or from another derived template. Base
templates are the objects provided with the Application Server. Base templates cannot be
modified.
Note: You should avoid creating instances directly from base templates, since you will not be able
to take advantage of advanced configuration and maintenance capabilities.
Templates are high-level definitions of the devices in your environment. Templates are like a
cookie cutter from which you can make many identical cookies.
You define a template for an object, like a valve, one time and then use that template when you
need to define another instance of that item. Template names have a dollar sign ($)as the first
character of their name.
A template can specify application logic, alarms, security, and historical data for an object.
A template can also define an area of your environment. You can extend and customize a template
by adding User Defined Attributes (UDAs), scripts, or extensions to meet the specific needs of
your environment. Objects inherit attributes from their parents.
Wonderware Application Server comes with predefined templates, called base templates. You
cannot change these templates. All templates you create are derived from base templates.
You can also nest templates, or contain them. Contained templates consist of nested object
templates that represent complex devices consisting of smaller, simpler devices, including valves.
A reactor is a good candidate for containment.
Templates only exist in the development environment.
Using the Diaphragm valve template, you can quickly create an Diaphragm valve instance when
you need another Diaphragm valve in your application.
3-5
3-6
/ParentTemplate
Child Instances
inherih attributes
from its template
lnstances
lnstances are the run-time objects created from templates in Wonderware Application Server.
lnstances are the specific things in your environment like processes, valves, conveyer belts.
holding tanks, and sensors. lnstances can get information from sensors on the real-world device
or from application logic in Wondeware Application Server. lnstances exist during run time.
In your environment, you may have a few instances or several thousand. Many of these instances
may be similar or identical, such as valves or holding tanks. Creating a new valve object from
scratch when you have several thousand identical valves is time-consuming. That's where
templates come in.
Propagation
If you need to change something about all diaphragm valves, you can change the template for the
diaphragm valve and all diaphragm valves in your application inherit the changes, assuming the
attributes are locked in the parent template. This makes it easy to maintain and update your
application.
Wondeware Training
Valve 001
Valve 002
Valve 003
Wonderware Application Server is shipped with a number of pre-defined templates to help you
create your application quickly and easily. Review these templates and determine if any of their
functionality match the requirements of the devices on your list. If not, you can create (derive) new
templates from the supplied UserDefined templates.
-Application
Objects
$AnalogDevice
$DiscreteDevice
SFieldReference
Base Templates
SUserDefined
$Valve -Derived
Template
For your project planning, document which existing template can be used for which objects, and
what templates you will need to create yourself.
A child template that you derive from a parent template can be highly customized. You can
implement user-defined attributes (UDAs), scripting, and alarm and history extensions.
Note: You can use the Galaxy Dump and Load Utility to create a .CSV file, which you can then
modify using a text editor and load back into the galaxy repository. This allows you to make bulk
edits to the confiauratlon auicklv and easilv.
3-7
Right-click the selected Template and click Derived Template on the Create submenu of the
context menu. The new Template is created, placed in the same toolset as the original
Template, and set in rename mode.
3.
Note: The new Template is created in the Galaxy in a checked in state. It can be viewed in the
Template Toolbox or in the Derivation View of the Aoolication Views Dane.
Wonderware Training
$UserDefined Object
The UserDefined object provides the basic functionality you need to develop an ArchestrA
supervisory application. The UserDefined object provides this functionality as Field Attributes,
scripts, User Defined Attributes (UDAs), and attribute extensions.
You can configure Field Attributes as an Analog or Discrete type with one of the following access
modes:
Input. The Field Attribute only accepts input. The Field Attribute is updated based on the
value that is read from the configured input address.
e
InputOutput. The Field Attribute accepts input and sends output. The output destination
can optionally differ from the input source address. The InputOutput mode supports the
User writeable and Object writeable attribute categories.
Output. The Field Attribute only sends output. The Field Attribute writes to the specified
output destination. The Output mode supports the following categories:
m
Calculated
Calculated retentive
User writeable
rn
Object writeable
Note: We recommend you do not extend the Field Attribute value with an lnput, InputOutput, or
Output extension. If the value is extended, unstable behavior with the Field Attribute value will
occur.
The Analog Field Attribute supports the following data types:
e
Integer
* Float
e
Double
The Analog Field Attribute provides the enabling and configuration for the following functionality:
Scaling of lnput and Output values
e
e
e
e
e
History
HIHi, Hi, Lo and LoLo Limit Alarms
Rate of Change Alarms
Target Deviation Alarms
Bad Value Alarm
Statistics
3-9
3-10
Statistics
The UserDefined object is an object that you can use to create customized objects. You can use
the UserDefined object in the following ways:
1. As a template containing Field Attributes associated to multiple variables in a system. In this
case, the object provides a simple and manageable structure as all the variables are
contained in the same object.
For example, you might create a UserDefined object called "Tank" and configure Field
Attributes that represent variables associated to the tank system:
e
LTIOO -Analog Field Attribute - lnput from a level transmitter configured with options
such as: Scaling, Limit alarms and Statistics (MinlMaxlAvg).
TT100 -Analog Field Attribute - lnput from a temperature transmitter configured with
options such as Rate of Change alarm and Statistics (MinIMaxlAvg).
SWlOOa - Discrete Field Attribute - lnput from a limit switch configured with options
such as State Labels and State alarm.
SWlOOb - Discrete Field Attribute - lnput from a limit switch configured with options
such as State Labels and State alarm.
XV100a - Discrete Field Attribute - lnputoutput to a solenoid valve configured with
options such as State Labels, State alarm, and Statistics (OpenlClose time).
XV100b - Discrete Field Attribute - lnputoutput to a solenoid valve configured with
options such as State Labels, State alarm, Statistics (OpenlClose time).
References between attributes in the object can be accomplished by using relative reference.
for example:
The "Tank" can be customized to raise an alarm when both XVlOOa and XVlOOb valves are
open. For example, you can add a Boolean UDA called "ValueOpenAlarm", extend it with an
Alarm Extension, and'then add the following OnExecute script:
I F m e . X V 1 0 0 a == "Open" AND me.XV100b == "Open" THEN
rne.Value0penAlarm = true;
ELSE
me.Value0penAlarm = false;
ENDIF;
2. As a "container" for other objects. An object relationship in which one object is comprised of
other objects is called containment. Containment allows you to group various objects together
to make complex objects.
Wondeware Training
Objectives
Upon completion of this lab you should be able to:
e
Configure and use object templates to create instances that will inherited the configuration
Use the Field Attributes functionality provided by the 5UserDefined object
Use the Galaxy Browser to build references to instances' attributes within the Galaxy
Note: Remember to ALWAYS preface the object name with your FIRST and LAST initial.(e.g., if
the user is Ann Brown. Valve would be ABValve) This will eliminate problems when deploying
vour obiects in a common oalaxv later in the course.
2. Add to the $ABHeatEx template four analog field attributes named T I , T2, T3 and T4.
Configure each field attribute as follows:
Access mode:
Input
Data type:
Float
Engineering units:
Deg F
checked
"
EU value Maximum:
4095.0
250.0
-5.0
255.0
3-11
3-12
7. Using the watch list created in Lab 5, add a new watch window called HeatEx and add the
following attribute references:
ABHeatEx.TI
ABHeatEx.T2
ABHeatEx.T3
ABHeatEx.T4
8.
$oirartroe"i<e
'-
kBiBLine2 lABLlnr21
3.
3-13
3-14
5. On the Field Attributes tab, click on the Add Analog button to add a new analog field
attribute.
d
$ABHeatEx
Feld Am D - u s /object
s. -UC-.... ..1nfo:rnation
... ..- I..Scr
. - .p
.-
Wondeware Training
TI
Access mode:
Input
Data type:
Float
Engineering units:
Deg F
checked
4095.0
EU value - Maximum:
250.0
-5.0
255.0
3-15
3-16
Click the Save and Close button and check in the object
The Check I n dialog box appears. Enter initial configuration and setup in the Comment
field and click OK.
Wonderware Training
Check I n complete
&
ABGalaxy
;--
UnassignedArea
Q
@
ABControI5ystnn
.
.
@ ABAppEngine
.. ..;----.. i---. @ ABGRPlatform
i.....[71
s Incontrol
j+ & ABDischarge
~.
-
! - -&ABLinel [ ABLinel]
61ABLine2 [ ABLineZ]
3-17
3-18
Name:
A<clsr mode:
category:
Derolpbon:
Wondeware Training
tiamr:
i1
Access mode:
In%:
AtltibvteWp
Data bps:
..
a.
.;
input sa~rce:
.. .. ...
.--
...
-. .- .
...- ..
...-. .
. . .
3-19
3-20
18. Repeat steps 13 to 17 to configure the lnput source for attributes T2, T3 and T4 using the
tagname.HEXXO-TC2, tagname.HEXXO-TC3 and tagname.HEXXO-TC4 attributes.
19. Click the Save and Close button and check in the object.
Wonderware Training
3-21
3-22
23. A second Deploy dialog box appears indicating the progress on deploying the object. As soon
as the process is complete, the Close button will be enabled. Click Close
Vrdidatino
...
. - -GRNodeInfo
-.
- - -~
~hechn~nhemer
omlecrs beng oeployed reqJre sofware upgrade...
Subng and '/a oabng 1objecr(s) smrbng from ABHearL-001 hosted by p l a 3 ~ r nABGRP
l
i
Deploying 1 ALrornauon Objectk) smrong n AKHeatEx-001 to the ABApp3g'ne
Wonderware Training
3-23
3-24
26. Right-click in the Watch List (bottom section of Object Viewer) and select Add Watch
Window to add a new tab to the watch list.
M06fy.. .
Remove +ern \Vat&
Open
Save
...
Save As..
Wondeware Training
Open
save
save As...
...
...
28. The Rename Tab dialog box is displayed. Enter HeatEx for the Tab Name field and click OK.
29. On the Attribute List lrioht section of Obiect Viewer) locate the followina attributes, right-click
on them, and select Add t o Watch to a& them to thk watch list:
e
e
e
e
TI
T2
T3
T4
ABHeatEx-001.T2
ABHeatEx-OOl.T3
ABHeatEx-001.T4
201.8844
61.41854
152.7081
CO:Good
CO:Good
CO:Good
Ok
Ok
Ok
3-25
3-26
ModiFy..
Remove from Watd-i
Add Attribute Referene...
Add Watch Window
Remove Watch Window
Rename Tab
...
Wonderware Training
Locking an attribute in a Template indicates that its value is to be logically "shared kith all derived
objects (Templates or instances). In other words, when the value changes in the template, that
change is propagated to all the derived children of the object. When an attribute is "locked" in the
Template, the value can be changed in that Template but not in any of the derived children.
Based on this concept, an attribute can have one of three logical lock types:
Unlocked: Both Templates and instances can have these. Attribute is read-write. The
object has its own copy of the attribute value and is not shared by derived objects.
Locked: Only Templates can have these. Attribute value is read-write. Derived objects
don't have a unique copy of the attribute value, but instead share the locked one (it is
Locked In Parent - see next item). By changing the value of a locked attribute, the logical
value of that attribute is updated in all derived objects.
e
Locked In Parent: Both Templates and instances can have these. Attribute is read-only.
The object does not have a unique copy of the attribute value, but references the one in
the ancestor in which the attribute is Locked.
Locking an Attribute
3-27
3-28
3.
Select the locking mechanism for that attribute. Some editors may have lock icons associated
with certain edit fields, but this possibility is within the scope of the developer of the object's
editor.
The locked attribute in any derived templates and instances created from this template are locked
and unavailable. To test this, you can derive a new template or create an instance from the original
template, and then check the new object's editor. The locked attribute is unavailable for editing.
Unlocking an Attribute
To unlock a Template attribute, do the following:
1. Select the desired Template in the ArchestrA IDE and launch its editor.
2. Select the locking mechanism for the locked attribute in the object's editor. Some editors may
have lock icons associated with certain edit fields, but this possibility is within the scope of the
developer of the object's editor.
Wondeware Training
Objectives
Upon completion of this lab you should be able to:
Lock attributes in templates to control the changes that can be made on derived objects
e
Propagate changes from templates to derived object by modifying the value of locked
attributes
Note: Remember to ALWAYS preface the object name with your FIRST and LAST initial.(e.g., if
the user is Ann Brown, Valve would be ABValve) This will eliminate problems when deploying
your objects in a common galaxy later in the course.
Engineering units:
Scaling section:
locked
3-29
3-30
'1
,.Yabe
8@
1 D~~~~~~~~~~~~~~
~ ~ ~ 8
. .iW-
Wonderware Traming
Valuedeadban&
Engineering unill:
....
~T
8 :4 1
- ....
3-31
2. In the Field attributes section, select the T I attribute and change the configuration as follows:
Engineering units:
Scaling section:
locked
/
Access mode:
Ahributetype:
Wt
, ,I
! Cowenionmode:
i.
Datatype:
/Li"ear/8
.
13-1
ildwinpotto~lianse
tJ
. ...
.>
3-32
The existing ABHeatEX-001 instance indicates that a change has been made to its
configuration since it was last deployed.
6.
Double-click the ABHeatEx-001 instance to open its configuration editor and verify the
changes.
Select the T I field attribute and expand the Enable 110 scaling section.
valvr deadband
Select the Deployment view, right-click the ABHeatEx-001 instance and select Deploy.
3-34
10. A second Deploy dialog box appears indicating the progress on deploying the object. As soon
as the process is complete, the Close button will be enabled. Click Close.
Deploycomplete
..
validating ~ ~ ~ o d e ~ n f o .
Cheddng whether objects being deployed require s o h a r e upgrade..,
Sorting and Validating 1object(s) starting from ABHeatEx-001 hosted by platform ABGRPI:
Deploying 1Automation Object(s) starting with ABHeatEr 0 0 1 to the AB
Wondenvare Training
$AnalogDevice Object
The AnalogDevice object is an Applicationobject that can be configured as either a basic analog
device, or an analog regulator device. When configured as a basic analog device, the
AnalogDevice object follows the traditional model of a basic analog inputloutput object with
alarming and history. When configured as an analog regulator device, the AnalogDevice object
provides an external model of a PID controller that exists in a field device, in addition to providing
the traditional analog alarming and history capabilities.
AnalogDevice Object as a Basic Analog InputlOutput Object
e
AnalogDevice Object as an Analog Regulator Object
The process value (PV) is read from the field (except when the AnalogDevice object is
configured to be in Manual mode).
You can configure the AnalogDevice object to enable or disable analog output. If you
enable output, you can configure the output destination address to be the same (default)
or different from the input source address. Commands to change the PV will result in an
output to field. For data integrity, the value of PV represents the value read from the
external controller (except when the AnalogDevice object is in Manual mode), not the
requested PV that is output to the external controller.
The input and outputs can be optionally scaled between raw counts and engineering unit
values using either linear or square-root conversions.
The AnalogDevice object supports alarming for PV conditions, such as when the PV:
e
Exceeds level limits, such as Lo, Hi, LoLo, and HiHi.
e
Exceeds rate-of-change limits, for both positive and negative directions
e
Exceeds major and minor deviations from a target value
e
Has a quality value of BAD
In addition, you can configure the AnalogDevice object to allow or disallow the overriding of the PV
value. If you enable the PV override, then you can use the PV.Mode attribute to place the
AnalogDevice object into either Auto or Manual mode. When the AnalogDevice object is in Auto
mode, the PV is updated from the field and matches the value and quality of the PVAuto attribute.
When the AnalogDevice object is in Manual mode, the PVAuto attribute continues to be updated
from the field, but the PV value does not. Instead, the PV can be set by a user write or a script, and
the quality is always set to UNCERTAIN.
Finally, you can configure the AnalogDevice object to historize key variables, including PV and
PV.Mode.
3-35
3-36
The process value (PV) is read from the field (except when the AnalogDevice object is
configured to be in Manual mode), but is never written.
The SP value is both read from the field and written to the field. You can configure the SP
output destination address to be the same (default) or different from the input source
address. Commands to change SP result in an output to field. For data integrity, the value
of SP always represents the value read from the external controller, not the requested SP
that is output to the external controller.
The PV and SP can be optionally scaled between raw counts and engineering unit values
using either linear or square-root conversions.
The AnalogDevice object supports alarming for PV conditions, including when the PV:
Exceeds level limits, such as Lo, Hi, LoLo, and HiHi.
e
Exceeds rate-of-change limits, for both positive and negative directions.
e
Exceeds major and minor deviations from the SP value.
0
Has a quality value of BAD.
In addition, you can configure the AnalogDevice object to allow or disallow the overriding of the PV
value. If you enable the PV override, then you can use the PV.Mode attribute to place the
AnalogDevice object into either Auto or Manual mode. When the AnalogDevice object is in Auto
mode, the PV is updated from the field and matches the value and quality of the PVAuto attribute.
When the AnalogDevice object is in Manual mode, the PVAuto attribute continues to be updated
from the field, but the PV value does not. Instead, the PV can be set by a user write or a script, and
the quality is always set to UNCERTAIN.
Other controller-oriented features that can be configured for an AnalogDevice object of type
analog regulator include:
Controller mode (CtrlMode attribute). You can use the controller mode to govern what
types of writes are allowed to the SP value within the system. Controller mode options are
Manual, Cascade, and None. When the object is in Manual mode, only end users are
allowed to command a change in the value of SP. In Cascade mode, only scripts or other
supervisory objects are allowed to command a change to SP. Finally, if None is specified
for the controller mode, any type of write is allowed for the SP.
Control tracking. A Boolean control track flag can be read from an external device or
object. When tracking is on, the external controller "owns" the value of the SP; the SP is
purely read-only and cannot be commanded to be changed and output to the field.
Wonderware Training
Lab 9 - Meter
Lab 9 - Meter
Introduction
This lab illustrates how to use the $AnalogDevice object to model a meter template which will be
used later to create the objects for the mixer level and temperature transmitters identified in Lab 2.
The template created in this lab will be integrated later with other templates to form the mixer
object; because of this, no instances will be created yet for this object.
Objectives
Upon completion of this lab you should be able to:
e
Configure an $AnalogDevice object
Note: Remember to ALWAYS preface the object name with your FIRST and LAST initial.(e.g.. if
the user is Ann Brown, Valve would be ABValve) This will eliminate problems when deploying
vour obiects in a common aalaxv later in the course.
General Steps
Create t h e Meter template
1. Derived a new template from the $AnalogDevice object, name it $ABMeter, and assign it to
the A B Training template toolset.
2. Configure the object as follows:
Type:
Analog (locked)
Unchecked (locked)
Enable PV override:
Unchecked (locked)
checked (locked)
0.0 (locked)
4095.0 (locked)
Conversion mode:
Linear (locked)
unchecked (locked)
3-37
3-38
2. Use $ABMeter for the name of the template and move it to your template toolset
i ;&Template
.
.
.-..- .... .
Toolbox
. . . .. . .
Ti
.. .
. . .. - ....
....
Wandemere Training
Lab 9 - Meter
4. Configure the General tab as follows:
5.
Type:
Analog (locked)
Unchecked (locked)
Enable PV override:
Unchecked (locked)
checked (locked)
0.0 (locked)
4095.0 (locked)
Conversion mode:
Linear (locked)
unchecked (locked)
Click the Save and Close button and check in the object.
3-40
Wondeware Training
$DiscreteDevice Object
The DiscreteDevice object is a general purpose Applicationobject that represents a large class of
physical equipment common in manufacturing, such as pumps, valves, motors, and conveyors.
These devices have two or more discrete physical states (for example, Open, Closed, and
Moving). The actual state of a device is monitored using a combination of discrete inputs, and a
device can be optionally controlled using a combination of discrete outputs.
The state names are configurable and are mapped to both input and output Boolean combinations
in truth-table form. The meaning of the states depends on the type of discrete device. For a pump,
the states might be configured as "OW' and "On," while for a valve they might be configured as
"Open," "Closed," and "Moving." Note that a control valve has a continuous position represented
by an analog signal of 0 to 100% and is not properly represented with a discrete device. Control
valves are best represented with the AnalogDevice object.
When a DiscreteDevice object is commanded to a new state, it sets the configured combination of
discrete outputs for that state. When one or more of its monitored discrete inputs change, the
DiscreteDevice object determines the new actual state of the equipment and sets the process
value (PV) appropriately.
Input and output states are totally independent of each other and can be configured as required by
your application; however, the input and output states can be linked by alarms. This allows the
object to detect a command timeout and uncommanded change alarms when devices
unexpectedly change, or fail to change when commanded to do so.
Historization of key attributes including the current state (PV) and commanded state (Cmd) can
also be configured.
Finally, the DiscreteDevice object supports a rich set of statistics reporting that you can enable
during configuration.
The passive state represents the state of the discrete device when it is idle, stopped, or
closed (the typical non-running position). For example, the passive state for a motor might
be "Off."
First Active
The first active state (Activel) represents the state of the discrete device when it is
considered to be running. For example, the active state for a motor might be "Forward."
You can use outputs to control the first active state.
3-41
3-42
(Optional) Some discrete devices have more than one active state. For example, a motor
might have a second active state of "Backward." You can use outputs to control the
second active state (Active2).
Transition
(Optional) The discrete device is in a transition state any time it is changing from one valid
state to another. For example, if you have a valve with a passive state of "Off' and an
active state of "On," the transition state might be "Moving."
Fault
The fault state occurs when the feedback that is coming from the field is incorrect or
impossible based on how the discrete device works. For example, a fault would occur if
the Hi and Lo limit is being reached at the same time for a single device. Examples of fault
state names are "Error," "Bad," or "Broken."
Valve-Close
Mapped State
Bad
Closed
Opened
Bad
where:
By default, when the monitored discrete inputs change, the DiscreteDevice object determines the
new actual state of the equipment and updates the value of the process value (PV) appropriately.
You can configure the DiscreteDevice object to allow or disallow overriding of the PV value. If you
enable the PV override, then the object can be placed in Auto, Manual, or Simulate modes using
the PVMode attribute.
0
When the object is in Auto mode, the PV updates from the field and matches the value
and quality of PVAuto.
When the object is in Manual mode, PVAuto continues to update from the field but the PV
does not. Instead, the PV can be set by a user or script and the quality is always marked
as UNCERTAIN.
W o n d e w r e Training
Alarm Capabilities
The DiscreteDevice object provides sophisticated alarming capabilities, including:
e
Command timeout alarm, which indicates that the PV state did not change to match the
Crnd state within a configurable timeout period.
e
Uncommanded change alarm, which indicates that the PV state changed from the
expected Cmd state to some other state and the quality of PV is GOOD or UNCERTAIN
(not BAD).
e
Individual alarms for each of Activel, Active2, and Fault state conditions.
Duration alarms for each of Activel and Active2 states, indicating the discrete device has
been in the state for too long of a time period.
Statistical Features
The DiscreteDevice object offers advanced built-in state tracking calculation^ that can be used for
equipment monitoring and time-in-use tracking, including:
The most recent time durations of the Activel, Active2 and Passive states.
e
The total accumulated time durations of the Activel, Active2 and Passive states, with
optional alarming on the Activel and Active2 total durations.
e
The number of transitions into the Activel. Active2 and Passive states.
A commandable reset of all statistics.
3-43
3-44
- Infentionally
Wondeware Training
left blank -
Lab 10 - Valve,
Introduction
This lab illustrates how to use the $DiscreteDevice object to model a valve, a pump and a motor
template which will be used later to create the mixer's inlet and outlet valves, as well as the
transfer pumps and agitator identified in Lab 2.
Initially, the templates for the pump and the motor are quite similar. Later, you will extend the motor
template to handle the speed associated with the mixer's agitator.
The templates to be created in this lab will be integrated later with other templates to form the
mixer object; because of this, no instances will be created for these objects at this time.
Objectives
Upon completion of this lab you should be able to:
e
Configure a $DiscreteDevice object
Note: Remember to ALWAYS preface the object name with your FIRST and LAST initial.(e.g., if
the user is Ann Brown, Valve would be ABValve) This will eliminate problems when deploying
vour obiects in a common aalaxv later in the course.
2.
Checked (locked)
Enable outputs:
Checked (locked)
3-45
3-46
4.
Unchecked (locked)
Checked (locked)
State names:
(locked)
Passive state:
Closed
Opened
Transition state:
Traveling
Fault state:
Fault
2 (locked)
lnput Name:
(locked)
CLS
OLS
lnput t o PV Map:
(locked)
0 0: Traveling
0 1: Opened
1 0: Closed
1 1: Fault
PV override:
(locked)
I(locked)
Output Name:
(locked)
CrndOpen
Closed:
Unchecked (locked)
Opened:
Checked (locked)
~ a n u a(locked)
l
Control tracking:
(locked)
Wondemare Training
6.
Derived a new template from the $DiscreteDevice object, name it $ABPump, and assign it to
the A B Training template toolset.
Checked (locked)
Enable outputs:
Checked (locked)
9.
Unchecked (locked)
Unchecked (locked)
State names:
(locked)
Passive state:
Stopped
Running
Fault state:
Fault
1 (locked)
Input Name:
(locked)
FlowSwitch
Input t o PV Map:
(locked)
0: Stopped
1: Running
PV override:
(locked)
Number of outputs:
1 (locked)
Output Name:
(locked)
CrndStart
Stopped:
Unchecked (locked)
Running:
Checked (locked)
Manual (locked)
Control tracking:
(locked)
3-47
3-48
Checked (locked)
Enable outputs:
Checked (locked)
Unchecked (locked)
Unchecked (locked)
State names:
(locked)
Passive state:
Stopped
Running
Fault state:
Fault
1 (locked)
Input Name:
(locked)
Input IInput
Name:
AuxContact (locked)
lnput t o PV Map:
(locked)
0: Stopped
1: Running
PV override:
(locked)
1 (locked)
Output Name:
(locked)
CmdStart
Stopped:
Unchecked (locked)
Running:
Checked (locked)
Manual (locked)
Control tracking:
(locked)
Wondeware Training
2. Use $ABValve for the name of the template and move it to your template toolset
3-49
3-50
Checked (locked)
Enable outputs:
Checked (locked)
Unchecked (locked)
Checked (locked)
State names:
(locked)
Passive state:
Closed
Opened
Transition state:
Traveling
Fault state:
Fault
Wonderware Training
2 (locked)
lnput Name:
(locked)
CLS
OLS
lnput t o PV Map:
(locked)
0 0: Traveling
0 1: Opened
1 0: Closed
1 1: Fault
PV override:
(locked)
:.
3-52
I(locked)
Output Name:
(locked)
CmdOpen
Closed:
Unchecked (locked)
Opened:
Checked (locked)
Manual (locked)
Control tracking:
(locked)
;m~km------
Numberof outputs:
Commandablertater:
a
output ~ a m eB
OutputDermatlon Reference
8. Click the Save and Close button and check in the object
Wondewere Training
In the Template Toolbox, create a derived template of the $DiscreteDevice object by right.
clicking the $DiscreteDevice template and selecting New I Derived Template.
10. Use $ABPump for the name of the template and move it to your template toolset
i &Template
Toolbox
.. . ... .
.....
-- ..-.- .. .....
8..
- J ? X
.. . . .
ABGalaw
E. l @
. AB Training
,~\
; ;.....@ $ABAppEngine
:
i
.
.
.
:
i:
..
.
.
.
.
i.....
:
..
& $ABArea
a$ABDDESuiteLinkClient
&) S4BHeatEx
;.... &) $ABMeter
3-53
3-54
Enable inputs:
Checked (locked)
Unchecked (locked)
Unchecked (locked)
State names:
(locked)
Passive state:
Stopped
Running
Fault state:
Fault
,Shh,nnrrrr-t--.~
P a r w e state:
Stowed
R O t P d i v e state:
Runilg
*::;e2
Transitionstate:
~zuitrtate:
Wonderware Training
rPiiri"slr.i
I (locked)
Input Name:
(locked)
Flowswitch
Input t o PV Map:
(locked)
0: Stopped
1: Running
PV override:
(locked)
3-56
I(locked)
Output Name:
(locked)
CrndStart
Stopped:
Unchecked (locked)
Running:
Checked (locked)
Manual (locked)
Control tracking:
(locked)
16. Click the Save and Close button and check in the object
Wondeware Training
18. Use 5ABMotor for the name of the template and move it to your template toolset.
.....
.......
WTunplate Toolbox
.....
.....
- ............
- P X
. .
3-57
3-58
Enable inputs:
Checked (locked)
Unchecked (locked)
Unchecked (locked)
State names:
(locked)
Passive state:
Stopped
Running
Fault state:
Fault
-state names
d?-
~arrivertate:
Tranritionrtate:
Faultstate:
Wondenvare Training
Number of Inputs:
I (locked)
lnput Name:
(locked)
AuxContact
lnput t o PV Map:
(locked)
0: Stopped
1: Running
(locked)
PV override:
Inputto M Map
8
lniiiat W mode: /~~u!:iilu
.-
3-59
3-60
I(locked)
Output Name:
(locked)
CrndStart
Stopped:
Unchecked (locked)
Running:
Checked (locked)
Manual (locked)
Control tracking:
(locked)
mwbpJ
Nurnberaf outputs:
Cornrnandablertater:
.. .
.-
d
output name
output~ertinationRefennce
24. Click the Save and Close button and check in the object
Wondenvare Training
Section 6 - Containment
Section 6 - Containment
Section Objectives
This section illustrates the concept of containment and how it works with Appication Objects and
Templates.
This section illustrates the concept of containment and how it works with Application Objects and
Templates.
--
:ontained Name
iierarchical Name
Description
. . .. .
. .
... . . ..... . .- - . . ... . - ...
The ~ n i q name
~ e of tne individ~alobect. For example, Valvel
The name of the object within the context of its container object. For
example, the object whose Tagname is Valvel may also be referred to
as Tankl .Outlet, if Tankl contains it and it has the contained name
"Outlet".
Hierarchical names that are fully-qualified names of a contained object
include the name of the objects that contain it.
Since the object that contains it may also be contained, there are
potentially multiple hierarchical names that refer to the same object.
For example, if:
"Reactorl" contains Tankl (also known within Reactorl by its contained
name "SurgeTank").
"Tankl" contains Valvel (also known within Tankl by its contained
name "Outlet").
Valvel could be referred to as:
"Valvel"
"Reactorl .SurgeTank.Outlet".
3-61
Applicationobject Containment
ApplicationObjects can be contained by other ApplicationObjects. This provides context for the
contained object and a naming hierarchy that provides a powerful tool for referencing objects.
Note: Base templates cannot be contained by another template, either as the container or as the
template being contained. You can only use containment with derived templates.
--
Section 6 - Containment
.
r
Level
3-63
3-64
Wondenvare Training
Section 6 - Containment
Within the context of each hierarchy, the contained names are unique, in that the names only refer
to this tank system and the contained objects.
So if the tank is named TankOl. the contained names are:
e
TankOl.lnlet
TankOl .Agitator
e
Tank01.0utlet
e
TankOl .Level
3-65
3-66
Wondenvare Training
Lab 11 - Mixer
Introduction
This lab uses the templates created in Labs 9 and 10 to create dedicated templates for each of the
Mixer's components identified in Lab 2. Using the $UserDefined template to create a template for
the mixer itself, you will use object containment to integrate all the pieces together and build the
"mixer system".
The Incontrol object created in Lab 6 provides the connection to the live values for each of the
objects that are part of the mixer.
Objectives
Upon completion of this lab you should be able to:
e
Create and configure a containment relationship between objects.
Note: Remember to ALWAYS preface the object name with your FIRST and LAST initial.(e.g., if
the user is Ann Brown, Valve would be ABValve) This will eliminate problems when deploying
vour obiects in a common galaxy later in the course.
Derived three new templates from the $ABValve object, name them $Inletl, $Inlet2 and
$Outlet, and assign them to the $ABMixer template.
3. Derived two new ternplates from the $ABPump object, name them $Pump1 and $Pump2, and
assign them to the $ABMixer template.
4.
Derived a new templates from the $ABMotor object, name it $Agitator, and assign it to the
$ABMixer template.
3-67
3-68
6.
Engineering units:
Liters (locked)
EU value Minimum:
0.0 (locked)
EU value Maximum:
100.0 (locked)
-5.0 (locked)
105.0 (locked)
Derived a new template from the $ABMeter object, name it $TT, and assign it to the $ABMixer
template. Configure the object as follows:
Engineering units:
Celsius (locked)
EU value Minimum:
0.0 (locked)
EU value Maximum:
250.0 (locked)
-5.0 (locked)
255.0 (locked)
Wondeware Training
Lab 11 - Mixer
8. Configure the input and output references for the contained objects as follows
where XXis your student number.
For Agitator-001
AuxContact.lnputSource:
CmdStart.OutputDestination:
For lnletl-001
CLS.lnputSource:
0LS.lnputSource:
CmdOpen.OutputDestination:
For lnlet2-001
CLS.lnputSource:
0LS.lnputSource:
CmdOpen.OutputDestination:
For LIT-001
PV.lnput.lnputSource:
For Outlet-001
CLS.lnputSource:
0LS.lnputSource:
CmdOpen.OutputDestination:
For Pumpl-001
F1owSwitch.lnputSource:
CmdStart.OutputDestination:
For Pump2-001
FlowSwitch.lnputSource:
CmdStart.0utputDestination:
For TT-001
PV.1nput.lnputSource:
3-69
3-70
11. Using the watch list created in Lab 5, add a new watch window called Mixer and add the
following attribute references:
Agitator-001 .PV
Agitator-001 .Crnd
lnletl-001 .PV
lnletl-001 .Cmd
lnlet2-001 .PV
lnlet2-001.Crnd
LIT-001 .PV
Outlet-001 .PV
Outlet-001 .Cmd
Purnpl-001 .PV
Purnpl-001 .Crnd
Pump2-001 .PV
Pump2-001 .Cmd
TT-001 .PV
Wondeware Training
Lab 11 - Mixer
2. Use $ABMixer for the name of the template and move it to your template toolset.
3. Create a derived template of the SABValve object by right-clicking the template and selecting
New IDerived Template.
4.
Use $Inlet1 for the name of the template (Notice that you will not use your initials for this
object) and assign it to the $ABMixer template to contain it within the $ABMixer object.
i .gTeniplate Toolbox
......
-.- - . - - .................................
3-71
3-72
5.
Create a derived template of the $ABValve object by right-clicking the template and selecting
New IDerived Template.
6. Use $Inlet2 for the name of the template (Notice that you will not use your initials for this
object) and assign it to the $ABMixer template to contain it within the $ABMixer object.
i iSTemplate
Toolbox
.
-. .
.-
- V X
ABGalaxy
8.@JAB Training
. .
;. ;--@ $ABAppEnqine
.
; ;----. & $ABArea
.
.
.i
.
;.
7.
..
I"
+-
. @$BDDESuiteLinkClient
.
.?-- @ $ABHeatEx
.
. @ SBMeter
;.....
15@ SABMixer
Create a derived template of the $ABValve object by right-clicking the template and selecting
New 1 Derived Template.
8. Use $Outlet for the name of the template (Notice that you will not use your initials for this
object) and assign it to the $ABMixer template to contain it within the $ABMixer object.
Wondewwe Training
Lab II - Mixer
Create t h e Mixer's P u m p s a n d Agitator templates
9. Create a derived template of the $ABPump object by right-clicking the template and selecting
New / Derived Template.
10. Use $Pump1 for the name of the template (Notice that you will not use your initials for this
object) and assign it to the $ABMixer template to contain it within the $ABMixer object.
i QTemplate Toolbox
...- .
o...
.........
ABGalax,
- P X
-- ......
e -@ AB Training
;
a~
@ $ABAppEngine
;. ;..
/$ SABArea
.
:
.~.
i.
:
.
;.
..
.i:.
.
"
!:.
i.
.$
a.
SABDDESuiteLinkClient
SBHeatEx
$ABMeter
SBMixer
..
..i..... 0 Inlet1
. O Inlet2
0
0
0
9
..
..i
>
:.
11. Create a derived template of the $ABPump object by right-clicking the template and selecting
New I Derived Template.
12. Use $Pump2 for the name of the template (Notice that you will not use your initials for this
object) and assign it to the $ABMixer template to contain it within the $ABMixer object.
3-73
3-74
13. Create a derived template of the $ABMotor object by right-clicking the template and selecting
New IDerived Template.
14. Use $Agitator for the name of the template (Notice that you will not use your initials for this
object) and assign it to the $ABMixer template to contain it within the $ABMixer object.
-tgjTemplate Toolbox
- .- .- .-....... .
- 9 X
. . .. .. ..
...
Wondenvare Training
Lab 11 - Mixer
16. Use $LIT for the name of the template (Notice that you will not use your initials for this object)
and assign it to the $ABMixer template to contain it within the $ABMixer object.
-...
: &Ternplate
Toolbox
4 X
. ~ .. . ~
3-75
3-76
Engineering units:
Liters (locked)
EU value Minimum:
0.0 (locked)
EU value Maximum:
100.0 (locked)
-5.0 (locked)
105.0 (locked)
19. Click the Save and Close button and check in the object.
20. Create a derived template of the $ABMeter object by right-clicking the template and selecting
New I Derived Template.
Wonderware Training
3-77
3-78
Celsius (locked)
EU value Minimum:
0.0 (locked)
EU value Maximum:
250.0 (locked)
-5.0 (locked)
255.0 (locked)
24. Click the Save and Close button and check in the object.
Wonderware Training
Lab 11 - Mixer
Create a Mixer Instance
25. Using the Template Toolbox and the Model view, create an instance of the $ABMixer
template using the default name of ABMixer-001.
Assign the instance to the ABLinel area
27. Select the Inputs tab and configure the Input Source Reference as follows:
AuxContact: InControl.tagnarne.TXXOOAGGAuxContact
where XX is your student number.
3-79
3-80
CmdStart: InControl.tagnarne.TXXO~AG~CmdStart
where XXis your student number.
29. Click the Save and Close button and check in the object
Configure Inlet1
30. Double-click on the lnletl-001 instance to open its configuration editor.
31. Select the Inputs tab and configure the Input Source Reference as follows:
CLS:
InControI.tagname.TXX0-IVI-CLS
OLS:
InControl.tagnarne.TXX0-IVI-OLS
32. Select the Outputs tab and configure the Output Destination Reference as follows:
CmdOpen: InControl.tagnarne.TXX0-IVI-CmdOpen
where XXis your student number.
33. Click the Save and Close button and check in the object.
Lab 11 - Mixer
Configure Inlet2
34. Double-click on the lnlet2-001 instance to open its configuration editor.
35. Select the Inputs tab and configure the Input Source Reference as follows:
CLS:
InControl.tagnarne.TXX0-IV2-CLS
OLS:
InControl.tagnarne.TXXO-IV2-0LS
inputSourreRefeirorc
-- j
/as .$
/I.~~~...TWIV~C
36. Select the Outputs tab and configure the Output Destination Reference as follows:
CmdOpen: InControl.tagname.TXX0-IV2-CmdOpen
where XXis your student number.
37. Cl~ckthe Save and Close button and check in the object.
40. Click the Save and Close button and check in the object.
3-81
3-82
42. Select the Inputs tab and configure the Input Source Reference as follows:
CLS:
InControl.tagname.TXXL-OV-CLS
OLS:
InControl.tagname.TXXO~OV~0LS
43. Select the Outputs tab and configure the Output Destination Reference as follows:
CmdOpen: InControl.tagnarne.TXXO-OV-CrndOpen
where XXis your student number.
44. Click the Save and Close button and check in the object.
--
Wonderware Training
46. Select the Inputs tab and configure the Input Source Reference as follows:
FlowSwitch: lnControl.tagnarne.TXXO_TP1~FlowSwitch
where XX is your student number.
47. Select the Outputs tab and configure the Output Destination Reference as follows:
CmdStart: InControl.tagname.TXXOOTP1-CmdStart
where XXis your student number.
48. Click the Save and Close button and check in the object
Configure P u m p 2
3-83
3-84
51. Select the Outputs tab and configure the Output Destination Reference as follows:
CmdStart: InControl.tagname.TXXO-TP2-CmdStart
where XXis your student number.
52. Click the Save and Close button and check in the object.
Configure t h e TT
53. Double-clickon the TT-001 instance to open its configuration editor.
54. Select the 110 tab and configure the PV input source as lnControl.tagname.TXXO-TT-PV.
where XXis your student number.
55. Click the Save and Close button and check in the object.
Wondeware Training
Lab 11 - Mixer
The Deploy dialog box displays. By default the system will do a Cascade Deploy of all 9
objects in the containment relationship and set all instances On Scan as soon as the objects
are deployed. Leave the default settings and click OK.
A second Deploy dialog box displays indicating the progress on deploying all 9 objects. As
soon as the process is complete, the Close button will be enabled. Click Close.
Deploy complete
3-85
3-86
60. Right-click in the Watch List (bottom section of Object Viewer) and select Add Watch
Window to add a new tab to the watch list.
61. Right-click in the Watch List (bottom section of Object Viewer) and select Rename Tab to
rename the watch list to Mixer.
Wonderware Training
Lab 11 - Mixer
62. Using the Object List (lefl section of Object Viewer) and the Attribute List (right section of
Object Viewer), locate and add the following attributes to the selected watch list by rightclicking on each attribute and selecting A d d t o Watch:
For Agitator-001
PV
Crnd
For lnletl-001
PV
Crnd
For lnlet2-001
PV
Crnd
For LIT-001
PV
For Outlet-001
PV
Cmd
For P u m p l ~ O O l
PV
Cmd
For Pump2-001
PV
Cmd
For TT-001
Agitator-0Ol.PV
Agitator-001.Crnd
Inletl-001.PV
Inletl-001.Crnd
Inlet2-001.PV
Inlet2-001.Crnd
Lrr-001.PV
Outlet-001.PV
Outlet 001.Crnd
PV
Stopped
Stopped
Closed
Closed
Closed
Closed
100.0
Traveling
Closed
63. Right-click in the Watch List (bottom section of Object Viewer) and select Save to save the
watch list to disk.
3-87
3-88
- lnfentionally
Wondeware Training
left blank -
- Motor Speed
Section 3 - Introduction to Quickscript .NET
Lab 12
4-2
Module objectives
Be able to work with extending the objects and configurhg them for addytional
functional~ty.
Wonderware Training
Section 1 - UDAs
Section I- UDAs
Section Objective
This section introduces and explains UDAs and how they are configured and used.
This section introduces and explains UDAs and how they are configured and used.
Note: After you add an attribute to an instance, it appears in the Attribute Browser list for use with
the scriotina and attribute extension functions.
Put to the extreme, scripts and UDAs can be used to create a completely new type of
ApplicationObject starting from an empty container object that has no behavior / logic itself.
You can add UDAs to a template or an instance. When you add a UDA to a template, the UDA, its
data type, and category are automatically locked in the child instances.
If UDA parameters such as initial values and security classifications are locked in the template,
they cannot be changed in child instances. If these parameters are unlocked in the template, the
initial value and security are editable and lockable in derived templates. When unlocked in either
the base or derived template, the value is editable in instances.
After you add an attribute to an instance, it appears in the Attribute Browser list for use with the
scripting and attribute extension functions.
4-3
4-4
-.
Geners
I Object Inforrnatlon
.-- . -..
Data type:
Category:
Iwrnber of elements
Wondenvare Training
Section 1 - UDAs
You can create an array for each data type except InternationalizedString.Select This is an
array and specify the array's length in the Number of elements box.
The Value parameter specifies the initial setting for the attribute when the object is deployed. Enter
value data for each data type. In the case of a non-arrayed Boolean, select the TrueIFalse check
box to use a True value. Clear the check box to use a False value. For an arrayed Boolean, select
the desired element and provide a default value by typing either true or false.
When using UDAs in scripting, note the following:
0
When using Calculated and Calculated Retentive UDAs as counters, they must be
manually initialized. For instance, if you use me.UDA=me.UDA+l as a counter in a script,
you must also initialize the UDA with something like me.UDA=l or me.UDA=<some
attribute value>.
Calculated UDAs can be initialized in OnScan and Execute scripts (that is, scripts with
those types of Execution Type triggers), but not Startup scripts.
Calculated Retentive UDAs must be initialized in Startup scripts, and can be initialized in
OnScan and Execute scripts. The main purpose of a Calculated Retentive UDA is to
retain the attribute's current value afler a computer reboot, redundancy-related failover, or
similar occurrence in which valid checkpoint data Is present. Therefore, your Startup script
should contain a statement testing the Boolean value of the attribute,
StartingFromCheckpoint,on the object's AppEngine. If the value is TRUE, you should not
initialize the UDA; if the value is FALSE, you should initialize the UDA.
4-5
4-6
Wonderware Training
Section 2 - Extensions
Section 2 - Extensions
Section Objective
This section descr:bes the Output Functionality for Application Objects in the Extensions
environment.
This section provides describes the Output Functionality for Application Objects in the Extensions
environment.
Extensions
The Extensions page is comprised of five main functional areas. These are described below.
v&bedc-
4-7
4-8
1. On the Extensions page of the object's editor, select an attribute in the Extendable Attributes
List. The four extension groups dynamically change according to allowed extension rules for
the selected attribute type.
2. Select the check box of the kind of extension you want to apply to the selected attribute. The
associated parameters for each kind of extension are then made available.
3. For InputOutput Extension, enter a Source attribute by either typing in the reference string or
clicking the attribute browser button at right. Use the Attribute Browser dialog box to search
for the desired reference string in an object. Then if Destination is different from Source, click
Output Destination Differs from lnput Source, and enter a Destination attribute by either
typing in the reference string or clicking the attribute browser button. An X is placed in the
InputOutput column of the selected attribute.
Caution! If you clear the Output Destination Differs from lnput Source check box, the
content of the Destination box automatically becomes "---". In the run-time environment, "---"
is interpreted as the same reference as the Source value entered during configuration time. In
the run-time, you can change the Source reference. Therefore, during configuration, do not
lock the Destination parameter if you clear the Output Destination Differs from lnput
Source check box.
4.
For lnput Extension, enter a Source attribute by either typing in the reference string or
clicking the attribute browser button at right. Use the Attribute Browser dialog box to search
for the desired reference string in an object. An X is placed in the lnput column of the selected
attribute.
5. For Output Extension, enter a Destination attribute by either typing in the reference string or
clicking the attribute browser button at right. Use the Attribute Browser dialog box to search
for the desired reference string in an object. Select the Output Every Scan check box if you
want the extended attribute to write to the Destination attribute every scan period of the
object (otherwise, the write executes only when the value is modified or when quality changes
from Bad or Initializing to Good or Uncertain). An X is placed in the Output column of the
selected attribute.
6.
For Alarm Extension, select a Category from the list: Discrete, Value LoLo, Value Lo,
Value Hi, Value HiHi, DeviationMinor, DeviationMajor, ROC Lo, ROC Hi, SPC, Process,
System, Batch or Software. Type a Priority level for the alarm (default is 500). Also, choose
between Use Object Description for Alarm Message or typing in another alarm message in
the Message box. An X is placed in the Alarm column of the selected attribute.
Wondeware Training
Section 2 - Extensions
7. For History Extension, enter values for the remaining parameters: Force Storage Period,
Engineering Units, Value Deadband, Trend High and Trend Low, if available (depends on
the data type of the selected attribute). An X is placed in the History column of the selected
attribute.
8.
Lock the value if desired. The lock symbol is available only when you are extending a
template. Otherwise, it indicates the lock condition of the value in the parent object.
9.
Set the security classification for the attribute if available. See "Security Icons" in "Working
with Object Editors" for more information.
10. Save and close the object editor to include the new attribute extensions in the configured
object.
Output Functionality
The following information applies to the functionality of Inputoutput and Output extensions as well
as the output function of the Field Reference. Switch and Analog Device objects.
If a single set request is made to a destination attribute during a single scan cycle, that value is
sent to the destination. During a single scan cycle, though, more than one set request to the same
destination is possible. In that case, folding occurs and the last value is sent to the destination.
The following occurs during a single scan cycle: Only the last value requested during a scan cycle
will be sent to its destination when the object executes. Its status is marked as Pending as it waits
for write confirmation from the destination object. All other set requests during that scan cycle are
marked as successfully completed.
If one or more new sets are requested during the next scan cycle, then the second scan cycle's
value is determined in the same way as described above. It is then sent to the destination when
the object executes again and the value sent to the destination during the previous scan cycle is
marked with successful completion status even if write confirmation had not been received.
In other words, within a single scan cycle, data is folded and only the last set requested is sent to
the destination. For instance, an {11,24,35,35,22,36,40) sequence of set requests will result in a
value of 40 being sent to the destination object. All other values result in successful completion
status.
The exception to the above-described functionality is for Boolean data types used in User sets
(sets from InTouch or FactorySuite Gateway). This functionality accounts for an unknown user
input rate (for instance, repeated button pushes) with a consistent object scan rate for outputs, and
therefore creates reproducible results. In this case, a combination of folding as described above
plus maintenance of a queue of one element deep in order to better meet the expectation of users.
To begin with, the first value set after the object is deployed (the default True or False) is always
written to its destination.
Subsequently, the following occurs during a single scan cycle: A two-tiered caching scheme of a
Value to be Sent and a Next Value to be Sent is implemented. The Value to be Sent is based on
data change as compared to the last value sent to the destination object. The Next Value to be
Sent is based on data change as compared to the Value to be Sent value. When the first data
change occurs, the new value is cached in the Value to be Sent queue. Folding occurs if the same
value is requested again. If another value change occurs, this second value is cached in the Next
Value to be Sent queue. Again, folding occurs if the same value is requested again.
zf
The Value to be Sent value is sent during the next scan cycle, and the Next Value to be Sent value
is sent during the following scan cycle.
4-9
4-10
In other words, for Boolean data types and User sets, the following examples apply:
Note: In the case of Boolean data types used in Supervisory sets (sets between
ApplicationObjects and ArchestrA) or a mixture of Supervisory and User sets during a single scan
cycle, the behavior is the same as the other data types.
Important! When the same attribute is extended with an Input extension and an Output extension,
writes to the Output extension's Destination occur every scan regardless of whether the extended
attribute has changed. This behavior occurs even when the Output Every Scan check box is
cleared, increasing the potential for additional network traffic. The behavior described in this note
does not apply to an Inputoutput extension.
Wondemare Training
Objectives
Upon completion of this lab you should be able to:
e
Add and configure UDAs to your objects
Extend attributes with input and output functionality
Note: Remember to ALWAYS preface the object name with your FIRST and LAST initial.(e.g., if
the user is Ann Brown, Valve would be ABValve) This will eliminate problems when deploying
vour obiects in a common aalaxv later in the course.
2.
Extend the Speed attribute with an Input extension and configure its Source as
3.
Extend the SpeedSP attribute with an Inputoutput extension and configure its Source
as
Leave Output destination differs from input source unchecked and lock it.
~n~ontrol.tagname.~~~~~~-Speed
SpeedSP.lnputSource:
InControl.tagname.TXX0-AG-SpeedSP
4-1 I
4-12
6.
Using the watch list created in Lab 5, add a new watch window called Extensions and add the
following attribute references:
Agitator-001 .PV
e
Agitator-001 .Cmd
e
Agitator-001 Speed
e
Agitator-001SpeedSP
7. With the Agitator Running, set the SpeedSP attribute to any valid float value to test it.
Wondeware Training
3.
Data type:
Float
Category:
Object writeable
Data type:
Float
Category:
User writeable
4-14
checked
Source:
-.-.
Wondeware Training
Inputoutput extension:
checked
Source:
--- ---
unchecked (locked)
7. Click the Save and Close button and check in the object.
4-15
4-16
9. Select the Speed attribute and configure its Input extension as follows:
Source: InControl.tagname.TXXO_AG-Speed
where =is
Attribute name:
Wondeware Training
*ed
II
4-17
10. Select the SpeedSP attribute and configure its Inputoutput extension as follows:
Source: InControl.tagname.TXXO_AG-SpeedSP
where XXis the student number.
I/
Attribute name:
SpeedSP
11. Click the Save and Close button and check in the object
II
4-18
13. Open Object Viewer by right-clicking the Agitator-001 instance and selecting View i n Object
Viewer. If you closed Object Viewer before, you can use File ILoad Watch List to open the file
you saved earlier.
14. Right-click in the Watch List (bottom section of Object Viewer) and select Add Watch
Window to add a new tab to the watch list.
15. Right-click in the Watch List (bottom section of Object Viewer) and select Rename Tab to
rename the watch list to Extensions.
.
e
PV
Cmd
Speed
SpeedSP
17. With the Agitator Running, set the SpeedSP attribute to any valid float value (e.g. 50).
Aaitator 001.PV
A&ator~001.~rnd
Agitator-001.Speed
Agitator-00 1.SpeedSP
Wandeware Training
Runnina
Running
50.56385
50.0
C0:Good
C0:Good
C0:Good
C0:Good
Ok
Ok
Ok
Ok
If the user selects an Execute type script, the script editor exposes one edit field for an expression
and another edit field for the script code.
The script expression acts as a filter for the invocation of Execute script execution. The expression
is evaluated every time the object that the script is attached to is executed. Dependent on the
evaluation the actual script is triggered or not.
4-19
4-20
~oduie
4 - Extending the Objects
This model is fine for simple scripts that just do some simple calculations. However, as soon as it is
necessary to instantiate external objects and keep them alive across multiple executions of the
script, the simple model falls apart. In order to support those more complex scenarios the script
writer can fill in script code for the Startup() and Shutdown() methods. External objects would be
instantiated in the Startup() method and destroyed in the Shutdown() method. If finer granularity is
needed the Onscan() and Offscan() methods can be used respectively. Onscan() and Offscan()
are invoked whenever the scan state of the object changes to OnScan and OffScan, respectively.
In order to support the just described scenarios the script offers a way to mimic static variables
(e.g., variables holding an instance of an object alive across different execution cycles). This is
accomplished by using a Dim statement in the upper Declarations section of the script editor.
Variables so dimensioned stay alive for the lifetime of the object.
In contrast, Variables dimensioned in the script section are destroyed between calls to the Object's
script. In either case, dimensioned variables are only accessible from within the script. Other
scripts cannot access those variables. Also, there is no means to expose those variables as
attributes of the associated object (e.g., for debugging purposes). To expose these member
variables, they can be set to a UDA.
Due to this tight link between scripts and UDAs, a script has more open access to UDAs (of the
object that the script is attached to) than to any other attribute on the object. It could be said that
UDAs are owned by a script
A script can also leverage UDAs to persist values across different script runs. Therefore, UDAs
allow users that do not want to get exposed to the complexity of script member variables to still
mimic static variables for data types that fit into Application Server attributes.
Reference Strings
Reference strings refer to an object or to data within an object's attributes. A reference string
consists of an object's reference string plus an attribute's reference string.
Automationobject Reference + Attribute Reference
A reference string is the object name plus the attribute name: ObjectName .AttributeName.
T I C ~ is
O the
~ Automationobject reference and PV is the attribute reference.
In T I C ~ O IPV
.
The AttributeName can be omitted in a reference string, PV being assumed in such cases.
Reference strings are concatenated substrings, each no more than 32 characters separated by
periods. A substring cannot contain a period. Mathematical operator characters are not allowed. At
least one character in each substring must be non-numeric.
Note: The Galaxy resolves reference strings. If the GR is not available, resolution is done on a
peer-to-peer level. Afler initial resolution, an object is provided an alias that handles references to
its location across your network. If an object is relocated or renamed, the reference string
resolution is repeated and a new alias provided.
Wondeware Training
Me
MyContainer
Myplatform
MyEngine
MyArea
Relative references are especially useful in templates because absolute references typically do
not apply or make sense.
When you use relative references, like MyContainer, you can refer to contained objects within that
container. For example, a reference to MyContainer. Inletvalue. PV is equivalent to
~ a n k .lInletvalve. PV in the following hierarchy:
Tank1
4-21
4-22
n data5omrce
taSonrcr
Wonderware Training
lu String:
~~lnConsrol.raenaxc.I"i Srrmgiiigbr(We.Ta'~'~'~'J,
3):
Scripts list: Shows all scripts currently associated with the object. The columns indicate
which kind of trigger the script uses: Startup, On Scan, Execute, Off Scan and Shutdown.
Click the Add button to add a new script.
Inherited scripts name list: Shows all scripts associated with the object's parent. The
columns indicate which kind of trigger the script uses: Startup, On Scan, Execute, Off
Scan and Shutdown.
Aliases area: Lets you create and modify aliases that apply to the script you are working
on. Aliases are logically descriptive names for typically long ArchestrA reference strings
that you can use in the script to make the script more readable.
Declarations area: Provides a place to add variable declaration statements, such as DIM
MyArray[l] as FLOAT;. These declared variables live from the startup to the shutdown of
the object and can be used to hold values that persist from one execution of the script to
the next. They apply only to the script in which they are declared.
Basics area: Provides a location in which you set the expression, triggering conditions,
and other settings that run the script in the run-time environment. This area includes:
Configure Execution Order: Sets the execution order of multiple scripts (inherited and
local) associated with this object.
Historize Script State: Select to send the state of the script to a Wonderware Historian
Server historian, the ArchestrA historian.
Script Creation box: Shows the script you are writing.
4-23
4-24
Script Examples
The following script examples may be used for reference,
Wondeware Training
Section 3
Note: Many aadjr ona scr pr examples may be localeo in me ArchesrrA IDE He p files under
Enhancing an Object's FunctionalitylQuickScript .NET Scripting LanguageISample Scripts.
Load an XML Document from Disk and Do Look-ups on It
dim doc as System.Xml.XmlDocument:
dim node as System.Xml.XmlNode;
doc = new System.Xml.XmlDocument;
doc.Load ("c:\catalog.xml") ;
' find the title of the book whose isbn is 044023722X
node = doc.SelectSingleNode("/catalog/bo0k[@isbn=~O44023722X']/title'~);
LogMessage(node.InnerText);
next;
..-
The script developer can specify external attributes in two distinct ways:
4-25
4-26
==
True Then
Endif;
While inline specification of external attributes is very convenient (you just type in the name or pick
the right name using the attribute browser), it imposes restrictions when used in scripts attached to
templates.
Consider the following script snippet:
ValvelOl.ControlMode=Auto;
V a l v e 1 0 1 .Cmd="Open";
Valve101.Contr01M0de=Cade;
If this script is attached to a template and the script code (script text) is locked in the template, then
any instance of this template can only meaningfully work if there is a Valve101 -obviously a bad
design of the script.
The script environment offers two solutions for this problem:
1. Usage of relative names in the script code (e.g., MyContainer.ControlMode=Auto). While this
approach works perfectly in scripts which are locked in a template, it severely constrains the
number of attributes that can be accessed this way.
2.
Using aliases in the script code that link to a reference table. This option is discussed in more
detail in the next section.
Wonderware Training
This script can be locked in the template without locking down which attribute on what object is
actually used in an instance derived from this template.
The actual mapping to an attribute is done via the Alias Reference table exposed by the script
editor. The table exposes the following fields:
--.-...........
Alias
..........
..
PVof nletvalve
.
.
.
-. .... -. .
7-
Reference
. . .
Va ve101 PV
.
4-27
4-28
.-
Wondemare Training
Execution Mode
OnExecute() mode scripts can be configured to execute in one of two execution modes,
synchronous or asynchronous. All other script types are always synchronous and cannot be
configured otherwise.
Synchronous Execution
The synchronous mode is the default choice and represents serial script execution by the
ApplicationEngine in the course of calling the Execute method of all Applicationobjects that are
on-scan in the ApplicationEngine. For satisfactory determinism, this mode requires that all scripts
execute deterministically and quickly enough to prevent an ApplicationEngine over-scan condition.
Asynchronous Execution
The asynchronous mode is used for the class of scripts that perform operations that don't meet the
above speed and determinism criteria. These scripts will be executed on a worker pool of
separate, lower priority threads than the Application Engine's primary thread. No support will be
provided to establish prioritization of execution among Asynchronous mode scripts; they will all
receive the same priority.
An asynchronous script running in a separate thread can access ArchestrATUattributes via normal
geffset calls. The call is marshaled over to the main engine thread and processed. The calling
thread waits for call return until main thread can process geffset request. This is OK since
asynchronous thread is usually slower and background in nature.
4-29
4-30
Module 4
true. Only one script can execute on one thread at a time. If an asynchronous script comes due
and no worker thread is available, it is immediately queued for execution and awaits a free worker
thread. As soon as the worker thread is free from its previous script, it executes the newly queue
script.
A default number of worker threads is to be provided. This is a configurable attribute of the Engine.
Watchdog Timeout
The execution time of both synchronous as well as asynchronous mode scripts is monitored
against a timeout period. All synchronous scripts on an AppEngine share the same timeout period
which is exposed as a configurable attribute of the AppEngine.
In the case of asynchronous scripts a timeout period that is shared for all asynchronous scripts
does not make sense since the needed execution time can vary by orders of magnitude between
different asynchronous scripts. In order to account for this, the timeout period can be separately
configured for each asynchronous script. It is exposed as an attribute of the script.
Wondeware Training
you assume t h a t
If PID.SetPoint==30
PID,SetPoint==30
at
the s t a r t of the
script)
then
PIO.Mode=Auto
PID.SetPoint=SO
PID.Mode=Cascade
Endif;
IfPID.SetPoint==50 then
(Do s o m e t h i n g else1
Endif;
If the PID object exists and its SetPoint can be set to 50 then the second 'if' statement will always
evaluate to true if the PID object is on-engine. However, in the off-engine case both 'if' statements
will never evaluate to true in the same execution cycle of the script.
In other words, when a script performs an attribute set (write) operation followed, at a later point in
the script, by a read of the Same attribute, the value written will not be read back if the attribute is
off-engine, rather the attribute value existing when the script commenced execution is returned
instead. In this case, the value written to the attribute will not be returned by a get (read) operation
until succeeding execution scans of the script.
Notes:
As described above a script performing read Iwrite operations on the same attribute will
behave differently depending on whether the attribute is on-engine or off-engine. If
necessary, the script developer can avoid this situation by using a local script variable to
manage the attribute's value in the course of the script's execution. At the end of the
script, the value of the local variable is then written to the attribute.
Scripts attached to an ApplicationObject are part of the supervisory control logic. Le., read
and write operations performed by the script are treated as S ~ p e ~ i s o r y G eI
t sSets.
4-31
4-32
Accessing UDAs
The precautions taken for regular attributes do not apply for UDAs. UDAs are added to an object
for the main purpose of having one or more scripts on this object drive them.
As a result script access to UDAs is treated exactly like the internal runtime access of a primitive to
its attributes. In particular, a script can set the quality property of a UDA on the hosting object.
However, the quality of a UDA is defaulted to GOOD.
On the other hand propagation of quality in calculations is handled in the following manner: In the
expression a = b + c, if b is bad (or initializing), the value of a is not updated and its quality is set to
BAD or (initializing). If the quality of b is uncertain then the calculation is performed, the value of a
is updated and a's quality is set to uncertain.
Wonderware Training
4-33
4-34
(ValvelOl.PV.Quality == 192) Or
ValvelOl.PV.Quality == 0) Then ...
== "Closed") And
(Valve102.PV == "Closed") Then
Set Valvel03.Cmd = "Open"
Else
Set Valvel03.Cmd = "Close"
(This should be the fail safe mode)
Endif;
If the quality of ValvelOl.PV and Valvel02.PV is acceptable then the 'if' and 'else' branches are
executed purely based on the value of those two attributes.
However, if at least one of the PV values has an unacceptable quality (bad or initializing) then
automatically the 'else' branch is executed. I.e., if statements should be written in a way that the
else branch always constitutes the fail safe mode.
Wondeware Training
.-
PID2.SP
PID1.SP = PID2.SP
10
PID3.SP = Sqrt(TanklOl.Leve1)
PID4.SP = PID2.SP
A
( A is a l o c a l v a r i a b l e )
As soon as the right side is not just a single attribute reference but involves additional statements,
the script execution system has to ignore the quality. From a user's perspective it is easier if all the
listed cases are treated equally; i.e., the quality is ignored in all cases.
When a script execution abort occurs, the script just stops. Sometimes it might be
necessary to set the quality of some UDAs that are controlled by the aborted script to bad.
The user can accomplish this by exercising a second script that monitors the abortion of
the first script.
Failed writes constitute a normal behavior that does not constitute an alarm.
Example: A script constantly tunes the parameters of a PID loop which is typically in
control mode. However, every time when a shift changes, the PID object is set to manual
mode for a short period of time. Now the writes fail but the script just keeps going and
eventually a script run will again successfully be able to set the PID parameters.
Of course it is also possible to check the Writestatus from within the script and react accordingly.
Watchdog T i m e o u t Error
To prevent the possibility that a script can cause an overrun of the ApplicationEngine scan cycle
(e.g., by running in an infinite loop), a script is aborted after the timeout period for the script has
elapsed. The script execution infrastructure will clean up after the aborted script as best as
possible. E.g., the script infrastructure must attempt to release external objects or data base
4-35
I m p o r t i n g Additional B i n a r y Libraries
Script Library Packages can be added to the system and made available to the user like preinstalled script libraries.
Note: Script libraries developed with the InTouch 32-bit Extensibility toolkit can be imported and
converted to Script function Libraries.
E x p o r t i n g B i n a r y Libraries
Once imported, script functions exposed in the imported libraries can be used in any scripts. When
objects using those scripts are exported from the Galaxy (say Galaxy A) and imported into another
Galaxy (Galaxy B) the libraries once imported into Galaxy A are not automatically exported with
the object. I.e., in order to run the exported object in Galaxy 6, the script libraries that the object
depends upon need to be manually copied to Galaxy 6.
Wondenvare Training
e
e
e
e
Calling public instance methods (with and without parameters) of .NET types.
Calling public static methods (with and without parameters) of .NET types.
Calling public indexers (with one or more parameters) of .NET types.
Using .NET enumerations.
Language Definition
QSll Case Sensitivity
All QuickScript .NET keywords and variable name identifiers are not case sensitive. However, the
case is p r e s e ~ e dthroughout editor sessions.
QSll Comments
Both single line and multi-line comments are supported. Single line comments start at a ' in a
source code line that has no matching ending ' in the line. Multi-line comments start with a (and
end with a ) and can span multiple lines as the name sugge&s.
4-37
4-38
/ Description
Complement
/ Negation
NOT
/ Logical NOT
MOD
Description
Muittpl~cat~on
D~v~s~on
Addlt~onand Concatenation
Subtractm
Assignment
Modulo
/ SHL
/ Lefl Shifl
SHR
/ Right Shift
&
I Bitwise AND
/ Exclusive OR
inclusive OR
Pnwer
1 Less than
>
<=
1 :1
--
<>
AND
OR
/ Greater than
/ Not Equal to
/ Logical AND
I Logical OR
..-
Wondeware Training
.......
Precedence
' Operator
- . . . . . ., ~.
-,
2
3
- . ..-.... -- . .
1-
/ -(negation), NOT, .*
5
6
7
.I. MOD
SHL. SHR
<, >, <=, > =
p
p
13
14 (lowest)
1 AND
/ OR
QSll Variables
Variables must be declared before any other code. Local variables or attributes can be used
interchangeably within the same script. However, local variables go out of scope at the end of the
script function they are used in. However, variables declared in the general section of the script
exist and keep their value throughout the lifetime of the object that the script is associated with.
Thus this kind of variable turns into a 'member variable' of the script class. Other scripts attached
to the same object cannot access this variable.
Variables can be used on both the left and right hand side of statements and expressions.
<upper-bound>
>I1
I;
where
variable-name : : = <letter> I <letter> I <digit> i <special-character> )
letter : : = A-Z I a-z
digit ::= 0-9
special-character : : = upper-bound : : = 1-2,147,483,647
data-type : : = Boolean I Discrete I Integer I Float I Real i Double I String
Message I Time I Object
The variable name is limited to 255 Unicode characters. Note that, in contrast to attribute names,
variable names must not contain dots. Variable names and the data type identifiers are not case
sensitive. If there is a naming conflict between a declared variable and another named entity in the
script (attribute name, alias, name of an object leveraged by the script), the variable name takes
precedence over the other named entities.
For example, let's assume that your script accesses the hosting object's PV attribute in the script
text and you declare 'DIM PV AS Integer;'. Within the declaring script, expressions using 'PV' in a
4-39
4-40
Integer
long (4 bytes)
Float. Real
*__
float (4 bytes)
7
Double
String, Message
NaN
I
,,,,
Double (8 bytes)
BSTR
Based on .NET'S
SystemDateTime
(8 bytes)
.-
Object
Nothing
Based on .NET'S
System.TimeSpan
structure (8 bytes)
Dispatch pointer
Wondeware Training
.....
.....
QuickScript
Application Sewer Data Type
.NET Data
Type
.................
Boolean or
Discrete
Mxlnteger
Integer
MxFloat
Float or Real
MxDouble
Double
MxString
String or
Message
.........
......
Comments
.-
---
MxStatusType
Integer
4-41
4-42
..
Quickscript
, .NET Data
dxQ~al~fiedEn~m
. ..
i
. ..
...
/ Comments
Type. . . . .'-Iintegcr
or
String
.
.-.
.
.. Anroutcs of type m x Q a ftedEn-m can bc read I
set as an integer or a string.
Example:
Dim intV1-PV as Integer;
Dim strVl_PV as String;
intV1-PV = Valve101.PV:
( Now intV1-PV holds the ordinal value of the
qualified enumeration )
strV1-PV = ValvelOl.PV:
I Now strVl PV holds the strino value of the
qualified enumeration )
regular integer.
I
sign ::=
<digit>*
+I-
Wondenvare Training
Floats
Float constants are applicable as values for variables of type float 1 real or double. I.e., float
constants do not take the number of bytes into account. It is up the validation step of the script
(lexer 1 parser) to detect an overflow when too big a float constant is assigned to either a variable
of type float I real or double.
sign ::= + I
digit ::= 0 - 9
exponent ::= exponent-character [sign] <digits>+
exponent-character ::= e 1 E
Sign is either plus (+) or minus (-); and digits are one or more decimal digits. If no digits appear
before the radix character (.), at least one must appear after the radix character. The decimal digits
can be followed by an exponent, which consists of an introductory letter (e or E) and an optionally
signed integer. If neither an exponent part nor a radix character appears, a radix character is
assumed to follow the last digit in the string.
Please note that the allowed range depends on the data type (4 byte float I real versus 8 byte
double) of the variable that the value is assigned to.
String Literals
String literals need to be surrounded by double quotes. They are referred to as quoted strings
Within the quoted string the character 'Y can be used as an escape character. The following
escape characters are supported:
..............
....1 Escape
-Sequence
/ \n
\r
\t
--
............
Description
.....
I New line
..............
.....
I Carriage return
Horizontal tab
Sinale atiotation mark. Sinale Quotes can
alsodirktly be used in a siring' without
using the escape sequence.
I Double auotation mark
/
\"
--
4-43
4-44
r---
, Escapesequence
. . . . - --.
/ \Uxxxxxxxx
....-- -
..
/Descnpiion
...
I Represents single Unicode character
formed by the hexadecimal number
xxxxxxxx. E.g. '\u00000066' is the letter'f'.
-1I
WHILE Loop
THEN
[statements]
[ { ELSEIF
[statements] } ]
[ ELSE
[statements] ]
ENDIF;
Where
boolean-expression is an expression that can be evaluated as a Boolean. Dependent on
the data type returned by the expression the expression is evaluated to constitute a True
or False state according to the following table:
........
1 Z X Z w-c r e t e
.
---.
........
. . . . . . . l Mapping
. . .-.-..-- ....
.
D red .y used
(no. mappang
needed)
.
Integer
Float, Real
String. Message
I
Time
/
Wondeware Training
/ Mapping
I Cannot be mapped Usmg an expression
Data Type
Object
value = 0
Message =
Then
"Value
i s zero";
E l s e I f v a l u e > 0 Then
Message = " V a l u e is p o s i t i v e " ;
value < 0 t h e n
Message = " V a l u e i s negative";
ElseIf
Else
( D e f a u l t . Should never
occur
in t h i s example)
For consistency with InTouch Scripting, the following syntax is also supported:
IF <boolean-expression> THEN
[statements]
[ { ELSE IF
[statements] ) ]
ELSE
[statements] ]
ENDIF;
ENDIF;
This approach basically nests a brand new IF compound statement within a previous one and
requires an additional ENDIF.
FOR ... TO
A FOR-NEXT loop is used to perform a function (or set of functions) within a script several times
during a single execution of a script. The general format of the FOR-NEXT loop is as follows:
FOR <analog-var> = <start-expression> TO <end-expression> [STEP
<change-expression>]
[statements]
[EXIT FOR;]
[statements]
NEXT
4-45
4-46
Where:
e
It is possible to exit the loop from within the body of the loop via the EXlT FOR statement.
The FOR loop is executed as follows:
1.
2. The system tests to see if analog-var is greater than end-expression. If so, the loop exits. (If
change-expression is negative, the system tests to see if analog-var is less than
end-expression.)
3. The statements in the body of the loop are executed. Here the loop can potentially be exited
via the EXlT FOR statement.
Note: FOR-NEXT loops may be nested. The number of levels of nesting possible depends on the
memory and resource availability.
FOR EACH
The FOR EACH loop can only be used with collections exposed by OLE Automation servers .A
FOR-NEXT loop is used to perform a function (or set of functions) within a script several times
during a single execution of a script. The general format of the FOR-NEXT loop is as follows:
FOR EACH <object-variable> IN <collection-object >
[statements]
[EXIT FOR;]
[statements]
NEXT;
Where:
e
As in the case of the FOR ... TO loop it is again possible to exit the execution of the loop via the
statement 'EXIT FOR;' from within the loop.
Wondeware Training
Note: Collections are frequently leveraged by VB and VBA / JScript. Microsoft's office suite is built
around the concept of collections. Furthermore Microsoft@started to expose more and more of the
Windowsa system via collections.
Example:
Dim
Dim
Dim
Dim
Dim
fso As IFileSystem;
folder As IFolder;
fileCollectian As IFileCollection;
file As IFile;
fileName as String;
so = new FileSystemObject;
folder = fso.GetFalder("C:\Temp");
fileCollection = folder.Files;
For Each file In fileCollection
fileName = file.name;
Next;
WHlLE Loop
A WHlLE loop is used to perform a function (or set of functions) within a script several times during
a single execution of a script while a condition is true. The general format of the WHlLE loop is as
follows:
WHlLE <boolean-expression>
[statements]
[EXIT WHILE;]
[statements]
ENDWHILE;
Where:
e
It is possible to exit the loop from within the body of the loop via the EXlT WHlLE statement.
The WHILE loop is executed as follows:
1. The system tests to see if boolean-expression is true. If not, the loop exists
2. The statements in the body of the loop are executed. Here the loop can potentially be exited
via the EXlT WHlLE statement.
3.
Note: WHlLE loops may be nested. The number of levels of nesting possible depends on the
memory and resource availability.
order to follow the naming syntax of InTouch QuickScript, binary shared functions are referred to
as script functions. Functions written in QuickScript are named QuickFunctions.
4-47
4-48
Where StringRight is a binary script function as described in the Scripting DFS. After executing the
script snippet PumpState holds the value "On".
Any of the script functions provided by The Application Server can be invoked this way.
Syntax:
ScriptFunction ::= <FunctionName> ( {cParamater>) {"." <Paramater>) );
~ctiveX@
Server:
Other names for ActiveX Sewer are COM Server, ActiveX component, ActiveX EXE, ActiveX DLL.
Support for
Once created, the methods exposed by a COM object can be accessed as if they would be script
functions.
There are at least two different approaches:
Wondenvare Training
Keywords
,.........
and
as
attribute
boolean
din
discrete
double
each
/ elaosedtime
else
elseif
endif
kdwhile
/
/
/
/
exit
false
float
for
if
in
indirect
integer
messaae
mod
new
next
not
.............................
---
null
object
or
real
shl
shr
/ step
string
/ then
/time
to
/ true
/w e
4-49
4-50
. ..
x.BindTo(s); ' where s is any expression that returns a string
x = 1234;
if WriteStatus(x) == MxStatusOk then
'
do something
endif;
...
Note: The Attribute() keyword does not accept values as a parameter. If you need to use dynamic
references to an attribute value, use lndirect instead.
Quickscript .NET also reserves for future use the following words:
call
case
catch
class
continue
default
delegate
do
end
I endsub
endswitch
enum
error
/ function
/ goto
this
namespace
/ nothing
implicit
1 throw
on
triger
private
protected
public
raiseevent
readonly
ref
return
select
sizeof
typeof
until
using
virtual
void
when
with
Wondeware Training
imports
include
inherits
interface
internal
1 is
like
Me
MyArea
Lab 13 -
uiteLinkCIient Auto
econnect
Introduction
Since the $DDESuiteLinkClient object lacks the capability to automatically reconnect to the data
source if the connection is lost, you are to extend the object with UDAs and scripts to add such
functionality.
Note: Your instructor will demonstrate the scrid.
Objectives
Upon completion of this lab you should be able to:
Use the QuickScript.NET scripting engine to extend your objects with extra functionality
e
Use attributes, including UDAs, within scripts
e
Create scripts with different execution types
e
Reconnect whenever the Incontrol object gets disconnected
Me.ConnectionStatus <> 2
Trigger type:
WhileTrue
Trigger period:
00:00:05.0000000
Script body:
Me.Reconnect
True;
4-51
4-52
Me.ConnectionStatus <> 2
Trigger type:
OnTrue
Script body:
Me.DisconnectCnt = Me.DisconnectCnt + 1;
0;
Wonderware Training
Aliases section:
(locked)
Declarations section:
(locked)
Scripts section:
Execution type:
Execute (locked)
Basics section:
(locked)
Expression:
Me.ConnectionStatus o 2
Trigger type:
WhileTrue
Trigger period:
00:00:05.0000000
3.
.*-
4-53
4-54
Data type:
Integer
Category:
Calculated
(locked)
Declarations section:
(locked)
Scripts section:
Execution type:
Execute (locked)
Basics section:
(locked)
Expression:
Me.ConnectionStatus o 2
Trigger type:
OnTrue
Wondemare Training
1;
Click the Save and Close button and check in the object.
4-55
4-56
Wonderware Training
Lab 14 - Automatic
eference
onfiguration
Introduction
This lab illustrates how to add to the mixer objects the capability of automatically configuring the
input and output references within the objects based on the naming conventions established for
your galaxy.
To successfully provide this functionality, a compromise regarding the naming of the objects has to
be arranged. In this example, it is required that every instance derived from the $ABMixer template
is named with the valid three-digit mixer identification number at the end as identified in Lab 2.
Objectives
2. Add a script called Assign10 (locked) with an Execute execution type configured as follows:
Expression:
Me.AssignlOCmd
Trigger type:
WhileTrue
Trigger period:
00:00:00.0000000
Script body:
(provided as a text file as part of the training material)
4-57
4-58
Wondeware Training
Data type:
Boolean
Category:
User writeable
TruelFalse:
checked
3.
AnbnIOCmd
4-59
4-60
(locked)
Declarations section:
(locked)
Scripts section:
Execution type:
Execute (locked)
Basics section:
(locked)
Expression:
Me.AssignlOCmd
Trigger type:
WhileTrue
Trigger period:
OO:OO:OO.OOOOOOO
Me.TT.PV.Input.InputSource
+ "-LT-PV";
+ "-TT-PV";
'Configure agitator.
Me.Agitator.AuxContact.1nputSource = datasource t "-AG-AuxContact";
Me.Agitator.CmdStart.0utputDest = datasource t "-AG-Cmdstart";
Me.Agitator.Speed.1nputSource = datasource + "-AG-Speed";
Me.Agitator.SpeedSP.1nputSource = datasource + "-AG-SpeedSP";
'Reset trigger.
Me.AssignIOCmd = False;
Wondemaare Training
5. Click the Save and Close button and check in the object
4-61
4-62
Note: The new instance of the SABMixer template will display the warning icon on all
contained objects. This is OK. These warnings can be cleared by setting the default
references from ---.---to ---.
I m ~ o r t a n t If
! there is a warnina icon on the mixer instance itself, notifv Your instructor.
& ABoischarpe
8..
& ABlntake
:
&
'
Q aanwto;_ool
& ABProduction
AgitatorJol [Asitat
hletl..OOl [ I n l e t i l
hletZ.OD1 [inlet21
outlet_ool [outlet I
Pump1_001 [Pump1
P"mp2_001 [PompZ:
l"let1_002 [Inlet1 1
l"lti2_002 [Inlet2 1
o"!l~!_oo2 [outlet I
Pump1_002[Pumpl:
Pump2-002 [Pump2
.*
9. Use Object Viewer to verify that both mixers, and their contained objects, are working.
Wonderware
Training
Alarms and
Section 1 - Alarms
Lab 15 - Configuring Alarms
- Historization
Lab 16 - Configuring History
Section 2
5-2
Wondenvare Training
Section 1 -Alarms
Section 1 -Alarms
Section Objectives
Famll~arlzeyou w ~ t hthe concept of alarms and events, and
Enable you to understand how ArchestrA handles alarms and events
This section provides familiarization of the concept of alarms and events and how ArchestrA
handles them.
What is an AlarmlEvent
The alarm and event capabilities in the system provide for users to automate the detection,
notification, historization and viewing of either application (process) alarms and events or system1
s o h a r e alarms events. Alarms and events are things that occur in the runtime system. Events
and alarms are different and the system distinguishes between the two. An event is simply an
occurrence of a condition at a certain point in time. The system can detect events, store them
historically and report them to various clients. Alarms, on the other hand, represent the
occurrence of a condition that is considered abnormal (generally bad) in nature and requiring
immediate attention from a user. Alarms are a special type of event that indicate something
abnormal has happened. The system handles the real-time reporting of alarms in a special
manner and provides special clients for their viewing.
Examples of alarms include:
A process measurement has exceeded a predefined limit, such as a high temperature
alarm.
e
A process device is not in the desired state, such as a pump that should be running has
stopped.
..
e
The system hardware is not operating within desired limits, for example the CPU utilization
on a Platform exceeds a certain percentage for an extended time.
Examples of events include:
e
A plant process has started; for example, a new batch or campaign starts.
The operator has changed a plant operator parameter; for example, a setpoint on a
temperature controller.
e
The system engineer has changed the runtime system configuration; for example,
deployment of a new Automationobject.
* The system engineer has started or stopped a system component; for example, stopping
an engine.
e
A platform has come back online after it had a failure or shutdown.
e
A user has logged into the system.
e
Detection of a severe software problem; such as a failed Application Object component.
5-3
5-4
Alarms:
/ Time
1 Comment
1 Area
I Alarm a r o u ~
1 Common name for alarm primitive I Alarm Type
.. (string)
.
..
(e.g. "PV.HiAlarm")
New alarm state lack. rtn. etc.l
Value MxReference
Limit MxReference
Units MxReference
Category
Category
/ Nla
1
1
1 State
1 Nla
/ Nla
1 Class
/ Subclass
Wondenvare Training
Section I-Alarms
AutomationObject's acknowledge attribute for the alarm. Security is used as part of this set (it is a
Userseattribute). An optional comment can be entered when the acknowledge is requested.
An acknowledge of an alarm is reported as an alarm state change back to the distributed alarming.
The optional operator comment is included in the event message sent back.
Distributed Alarming has no support for passing a rejected acknowledge failure feedback.
Therefore, if an acknowledge is requested from a client but does not succeed, the only feedback
on the InTouch client will be no change in acknowledge status on the client.
Alarm EnablelDisable
The InTouch Alarm Client can enableldisable alarming on any Automationobject. The platform
receives the enable request and forwards it to the target AutomationObject's AlarmMode attribute.
Security is used as part of this set (it is a UserSetAttribute).
Svstem Events:
.............
fie,,
Priority = 1
N/a
N/A
N/A
Provider = Galaxy
Event Class = EVENT
---
. . . . . . . . . . .
ArchestrA field
.
-. . . . . . . .
5-5
5-6
..
-.
..
I Operator 1 name
.........
Mapping
... -!..
. . . . . --
Limit
/ value
New value
Nla
Nla
Priority = 999
NIA
Provider = Galaxy
NIA
--
.............
........
..
...
1 .
Type = LGC
Timestamp
Time
Tag.primitive.attribute
Name? Or name+comment?
.....
I old value
..
Nla
Nla
NIA
Wondeware Training
Comment
P!a~m.92Jp
Platform (!he PC's node n
-. -. .
Limit
/ Value
/ State = none (preferred)or
New value
/
--
.-
Tag description
. . . .
/ RequestingEngineName+
"UNACK-R T N
Priority = 999
Provider = Galaxy
1
1
Section 1 -Alarms
Alarm Queries
Alarm queries provide alarm information and event reports coming from the galaxy.
Use the following syntax for querying alarms from a Galaxy. This syntax gets alarms from a
specific attribute of an object in a specific area on a specific computer.
\\NodeName\Galaxy!Area+Blyestff#n8ate
The following syntax gets all alarms from the Platform on computer node (by default):
-+
You can also use a wildcard. The following syntax gets all alarms from Areal, Area2, Area3, and
SO on:
The following syntax gets all alarms from all objects starting with the characters "Tank" in the area
"Area":
5-7
5-8
Wondewwe Training
Objectives
Upon completion of this lab you should be able to:
e
Configure the $Winpiatform object as an alarm provider for the galaxy
e
Configure alarms within objects including using the Alarm Extension
e
Configure and use the Alarm DB Logger Manager
e
Use alarm queries to request real-time alarms from alarm providers
Note: Remember to ALWAYS preface the object name with your FIRST and LAST initial.(e.g., if
the user is Ann Brown, Valve would be ABValve) This will eliminate problems when deploying
vour obiects in a common aalaxv later in the course.
1. Configure the ABGRPlatForm instance to be an InTouch alarm provider for ail areas in the
galaxy.
Configure the $ABMixer.LIT template with a Hi level alarm, with a limit of 80.0, a priority of
500 and "Mixer Hi Level alarm" as the alarm message.
.-
5-9
5. Extend the Malfunction attribute with an Input extension and configure its Source as
6.
Extend the Malfunction attribute with an Alarm extension and lock it. Configure its category
as Process and leave the default values on the rest of the attributes.
7. Modify the Assign10 script of the $ABMixer template by adding the following line of code to
the Configure agitator section of the code:
Me.Agitator.Malfunction.1nputSource
datasource
"_AGMalfunction";
9.
Using the watch list created in Lab 5, add a new watch window called Alarms and add the
following attribute references:
e
LIT-001.PV
LIT-001 .lnAlarm
0
.
e
e
e
e
LIT-001 .Hi.lnAlarm
LIT-001.Hi.Limit
LIT~001.Hi.TimeAlarmOn
LIT-001.Hi.TirneAlarmOff
Agitator-001.lnAlarm
Agitator-001 .Malfunction
Agitator-001 .Malfunction.lnAlarm
Agitator~OO1.Malfunction.TimeAlarmOn
Agitator~OO1.Malfunction.TimeAlarmOff
Wondeware Training
sa
Password:
12. Configure the Alarm DB Logger Manager to query all priorities from the following alarm
query:
13. Leave the defaults advanced settings and start Alarm DB Logger Manager.
5-12
3.
Click the Save and Close button and check in the object.
Wonderware Training
5.
checked (locked)
Level alarms:
(locked)
Hi:
checked (locked)
Hi Limit:
80.0 (unlocked)
Hi Priority:
500 (locked)
Hi Alarm Message:
6 . Click the Save and Close button and check in the object.
5-13
5-14
8. Select the UDAs tab, add a UDA named Malfunction and configure it as follows:
Data type:
Boolean
Category:
Object writeable
urnname:
m:
9.
Naiiuntbon
~~t~
We"
Categoq:
I0bjert.a~iteab:e
id
.-14
10. Select the Malfunction attribute and configure its extensions as follows:
Input extension:
Source:
Alarm extension:
checked
-..
checked (locked)
Category:
Process
Priority:
500
Alarm message:
me.ShortDesc
True
Wondeware Training
13. Select the Assign10 tab and add the following line of code to the Configure agitator section of
the code:
Me.Agitator.Malfunction.InputSource
datasource +"-AG-~alfunction";
14. Click the Save and Close button and check in the object
5-15
16. Open Object Viewer by right-clicking the LIT-001 instance and selecting View in Object
Viewer. If you closed Object Viewer before, you can use File I Load Watch List to open the
file you saved earlier.
Note: If you had Object Viewer opened, you will need to switch to it first and click the OK
button to close before trying to re-opened again from the ArchestrA IDE.
17. Right-click in the Watch List (bottom section of Object Viewer) and select Add Watch
Window to add a new tab to the watch list.
18. Right-click in the Watch List (bottom section of Object Viewer) and select Rename Tab to
rename the watch list to Alarms.
Wonderware Training
Malfunction
bue
bue
30.0
8/13/2007 2:08:17.741..
8/13/2007 2:07:17.743
bue
.
...
CO:Good
C0:Good
C0:Good
CO:Good
CO:Good
C0:Good
C0:Good
C0:Good
Ok
Ok
Ok
Ok
Ok
Ok
Ok
Ok
C0:Good
Ok
5-17
5-18
22. In the Alarm DB Logger Manager window, click the Settings button
23. Configure the Alarm DB Logger Manager - Configuration dialog box as follows and then
click the Create button:
Server Name:
(local)
Database:
WWALMDB
User Info:
User Name:
sa
Password:
Logging Mode:
Wonderware Training
Detailed
Note: If the following Warning dialog is displayed, click the Yes button to delete the existing
database and create a new one.
25. Back at the Alarm DB Logger Manager - Configuration dialog box click the Next button to
continue.
5-19
To Priority:
999
Alarm Query:
\Galaxy!ABControlSystern
\Galaxy!ABDischarge
\Galaxy!ABlntake
\Galaxy!ABProductio
Wonderware Training
28. Back at the Alarm DB Logger Manager window, click the Start button to start the Alarm
Database Logger.
5-21
5-22
30. Configure the Connect to Sewer dialog box as follows and then click the Connect button to
continue:
Sewer type:
Database Engine
Sewer name:
localhost
Authentication:
Windows Authentication
Wondenvare Training
32. On the Views list (right pane), right-click on the v-AlarmHistory view and select Open View
to display the current list of alarms logged in the database.
.... WACXRTh
Lli.00l.h
8/13/2007 2 5 7
Agitalw_W2.M
/l3/2007 257:..,
WACKPLM
12007257:
...
/ZOO7 256:
... WACVUlt.I
12007 2%:
...
...
ThemroeieDev..
M x e i Hi level al...
ABLine2
liBUne2
WA
WACK-rVM
5-24
Wonderware Training
Section 2 - Historization
Section 2 - Historization
Section Objectives
Familiarize you with the background concept of historization, and
Enable you to understand details of historizable configuration.
This section provides familiarization with the background concept of historization and the details of
historizable configuration.
Historization Background
The history system supports historization of process data in distributed history architecture.
One or more Historian products can be installed on the same network as the Application Sewer
Galaxy. The Galaxy can be configured to store history data into one or more of those Historians.
Since the Engines use push technology to historize, the Historian box does not have any
ArchestrA software requirements.
Each Engine in the Galaxy is configured with the location of the Historian storage node to which its
history data is to be sent. This configuration is stored in an attribute within the Engine.
Wonderware Historian requires a Historian tag to be configured in its database for each attribute to
be historized by an AutomationObject. Thus, there is a one-to-one relationship between a
historized object and a tag in Wonderware Historian.
When an AutomationObject starts up it registers its configuration data with Historian using a
Historian supplied interface. If the Historian tag already exists, it means this object has been
previously registered. If the Historian tag does not exist, it is created automatically. In either case,
the object receives back a unique identifier (handle) for that tag. This is a push-style configuration
model, meaning the configuration data for each historized property of an object is dynamically, and
automatically, pushed to Historian. The user does not need to run Historian configure and import
tags from Application Sewer (as done with InTouch today).
For storage, the story is similar. When an object decides to store a new VTQ to Historian, it
pushes that storage update message, with the new VTQ, to Historian using a Historian supplied
interface. The Historian must exist on a different node from the AutomationObject. The history
primitive uses the previously-returned unique identifier for the Historian tag that corresponds to the
historized property to identify the tag being stored.
Note: Alarms are stored at the Platform, history is stored at the Engine.
History Configuration
Historizable Data Types for Attributes
Attributes of the following data types support historization:
Float (numerical)
Double (numerical)
Integer (numerical)
Boolean (non-numerical)
5-25
5-26
Wonderware Training
Section 2 - Historization
product automatically. For example, if the engineering units string for the tag changes from "Deg
F to "Deg C upon a redeploy, the Historian configuration database must reflect this change.
NaN Handling
For Float and Double attributes, a potential value is the IEEE NaN encoding for the float or double
representation. NaN values can be generated for attributes that are to be historized. These NaNs
will be accompanied by a Bad OPC Data Quality. In any case, NaN is a valid value that can be
generated for floats and doubles. Unfortunately, Historian clients do not handle NaN properly.
Therefore, ArchestrA will convert the NaN value to a Null value representationjust prior to sending
to Historian.
5-27
5-28
Wondeware Training
Objectives
Upon completion of this lab you should be able to:
e
Configure the $AppEngine object to store history data to a Wondeiware Historian
e
Configure attributes within objects for historization including the History Extension
Note: Remember to ALWAYS preface the object name with your FIRST and LAST initial.(e.g., if
the user is Ann Brown, Valve would be ABValve) This will eliminate problems when deploying
your objects in a common galaxy later in the course.
Enable the ABAppEngine instance for storage to the historian in your local computer.
Configure the $ABMixer.LIT template to historize the PV attribute using the default values for
the history attributes.
5-29
5-30
10. Use ActiveFactory Trend to connect to the local Wonderware Historian using Integrated
security.
11. Visualize the trend for the following tags:
e
e
Agitator-001.Speed
Inlet1.PV
LIT-001.PV
Wanderware Training
C:\S&F
3. Click the Save and Close button and check in the object.
checked
Historian:
6. Click the Save and Close button and check in the object.
5-31
5-32
8. Select the History tab and check the PV box to historize the PV attribute. Leave the default
values and lock all attributes by clicking the lock on Historize.
9.
Click the Save and Close button and check in the object,
checked (locked)
0 (locked)
12. Click the Save and Close button and check in the object
Wondeware Training
14. Select the Speed attribute, check and lock the History extension and configure it as follows:
Engineering units:
RPM
seed
ANriLwte name:
I1r~uiommicimS:n
!-[I-/
B
&
&
9,,,,:
~ j ~ ~ ! ~ ~ t ~tifferr
~ t +omirp~iiarcc
. - s t i l
~
w
..
....................
63l
~-
"
..............................rf-.
.............
Alarm message:
Engineering units:
value dcadband:
Trend high:
/ O g j
TI
EU
14
EU
Trend tour:
7-
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
15. Click the Save and Close button and check in the object.
5-34
18. Configure the Sewer List Configuration as follows and click the Add button:
Sewer:
LOCALHOST
Authentication information:
Use Integrated security:
checked
20. With LOCALHOST selected on the Sewers pane (top-left pane), you will see the attribute
references configured for historization in the Tags pane (bottom-left pane).
5-35
5-36
Wondeware Training
Module 6
Security
- Security Overview
Lab 17 - Security
Section 1
6-2
Module 6 - Security
Module Objective
Configure, deploy, and test securtty w ~ t hAppllcatlon Server
Wonderware Training
The system is not designed to stop malicious access to the system. The security system is
designed to support the normal operating parameters of an automation system. Passwords are
encrypted but they are stored in a database that is accessible. So, the system is not designed to
stop determined programmers from accessing the system.
If your application requires a higher level of security, this can be achieved by typical IT
departments using tools provided by Microsoft@.To facilitate a higher level of security, the security
model can be configured to support operating system authentication. In that case, the
configuration and runtime permissions can be mapped to the external operating system account.
Some options include password timeout and electronic signature authentication.
6-3
6-4
Module 6 - Security
Security
Access Map
...............................................
\ .....................................I i:
'
Each attribute of an Automationobject is given a security classification. This provides the ability to
define who can write to attributes of an object.
For example, a certain attribute of the DiscreteDevice may be set by the operator to change its
status while a different attribute may be set by a technician. These attributes are meant for
different people, Operator (operate) and Technician (tuning). Configuring access to all users for all
AutomationObjects on individual bases would be a time-consuming and repetitive effort. Thus,
configured Roles and Security Groups can be applied to Users to enable easier configuration of
the Security Model.
Security Groups are simply the grouping of objects that you want to behave in the same way with
respect to security. Every Automationobject belongs to exactly one Security Group. By default all
new objects belong to the Default Security Group, which cannot be removed. Roles generalize
Users function, such as Intake Operator or Dispatcher. Roles are granted permissions onto a
number of Security Groups. If, for instance, a Role is granted Tuning access to a Security Group,
then that role has write permissions to all object attributes with a security classification of Tuning
(but none other). Roles are also granted utility functions-based permissions, such as Deploy or
Can Edit.
For example, a Role of Soflware Engineer is created. This Role has full permissions to modify the
objects in the ArchestrA IDE, and has permissions to deploy as well. To undeploy an object,
though, the system requires that the object is offscan. Control of offscanlonscan is controlled by
Operation permissions -- not granted to the Software Engineer, so he cannot undeploy any objects
in Onscan mode. Only an operator (with Operation permissions) can do so.
Permissions are required to perform most ArchestrA activities. Usually only one permission is
required to perform a given activity, but occasionally, two or more permissions may be required for
operation-critical actions.
..-
Wondenvare Tra~n~ng
1. Enabling Security
2.
Authentication Mode
6-6
Module 6 - Security
Wonderware Training
Open security gives all users the Defaultuser credentials. No login dialog boxes are
presented to users during configuration, administration or runtime operations. Login dialog
boxes are presented for all other Authentication Modes.
If you have previously configured security under one Authentication Mode and then you
switch authentication modes, only those users created while configuring the new mode
are enabled. Other users are not deleted, just disabled in the new mode.
When you close the Configure Security dialog box after selecting any Authentication
Mode other than None, you must login. This action ensures that the new security model
can be enforced. If you select Cancel on the login dialog box, the ArchestrA IDE closes.
When you switch to None from another Authentication Mode and click OK, the
ArchestrA IDE is shut down.
When Galaxy authentication is selected, each user must provide a user name and
password in a login dialog box. The security system authenticates the user's credentials
against Galaxy user data. Access to all operations in the ArchestrA IDE and anywhere in
the ArchestrA environment are granted based on the logged in user's associated roles
and permissions. The ArchestrA IDE customizes the user interface to the user's previous
preferences (for instance, which Application Views are shown). The logged in user's
name is shown in the status bar of the ArchestrA IDE.
When OS User Based authentication is selected, each user must provide a domain, user
name and password in a login dialog box. The security system ensures that the OS user is
authorized to use the ArchestrA ID.
When OS Group Based authentication is selected, each user must provide a domain, user
name and password in a login dialog box. The security system first ensures that the user
is authorized to use the ArchestrA IDE. Then the system authorizes the user's credentials
against operating system groups mapped to security roles in the Galaxy.
Note: In both OS-based authentication modes, a user is not presented with a log in dialog box
if that user has authorization to use that ArchestrA utility.
e
A user can have multiple accounts within the security system. For instance, a user may
have an account that provides permissions for working with instances but not templates.
The same person may have another supervisory account for working with templates and
managing users in the ArchestrA environment. To switch between levels of authority, the
person must login as the new user. To do this, click Change User on the Galaxy menu.
6-7
6-8
Module 6 - Security
If you use OS Group Based Authentication Mode, you should first familiarize yourself indepth with
the functions of the Windows operating system, particularly its user permissions, groups and
security features. ArchestrA OS Group Based security leverages those Windows features.
Take note of the following behaviors that are unique to OS Group Based Authentication Mode:
e
A newly-added user working on a computer that has no access to the Galaxy node cannot
write to an attribute on a remote node if that user has never logged on to the remote node.
This is true even if the user has been given sufficient runtime operational permissions to
do writes. To enable remote writing capabilities, log on to the remote node at least once.
e
If you log in to ArchestrA on a workstation that belongs to Domain A and Domain
Controller A fails, locally cached login data is used on subsequent logins. When the
domain controller returns to operation, your login will fail during the time period that trusts
are being reestablished by the controller. If during the controller outage, your usernamel
password data was changed, you may be able to use the old login data if you intend to
work locally. If you want to perform remote operations, you should attempt to log in with
Wondeware Training
User Authentication
Client utilities like ArchestrA IDE, SMC, and View require their users to be authenticated so that
the appropriate permissions can be confirmed. An authenticated user is granted the sum of all
Permissions within their assumed Roles.
6-9
6-10
Module 6 - Security
Logon Dialog
If security is enabled within the Galaxy, a client utility Logon dialog will be displayed. Application
Sewer provides a standard login dialog.
The login appears:
The user explicitly chooses a Log On option from within the UI. It is not necessary to
explicitly Log Off before logging on using a different User Profile. The previous user will
be implicitly logged off.
Username and Password are entered onto this dialog.
If OS Authorization is being used then the user will also be required to select from a list of
accessible domain name for the user being logged in.
Logon Object
A Logon COM object is provided for use by any OS client utilities that need to log on to Application
Server. This COM object either provides a Log-on Dialog or is driven silently by an automation
interface. OS authentication and log on dialogs may be leveraged.
6-11
6-12
Module 6 - Security
Wondenvare Training
Lab 17 - Security
Lab 17 - Security
Introduction
As you work with the security settings within the ArchestrA ID you set up various Roles and
Users and configure them with different sets of permissions. You then observe the different
behaviors in the Object Viewer as you logon as various users.
In this lab you configure the security settings for your galaxy and test it with a sample automation
object that has been partially pre-configured for you.
Note: Importing objects will be discussed in detail, including the options in this dialog box, in the
following module.
Objectives
Upon completion of this lab you should be able to:
e
e
Configure the security classifications for individual attributes within automation objects
Configure the security settings for a galaxy
Record and view the security audit trail for a galaxy
Note: Remember to ALWAYS preface the object name with your FIRST and LAST initial.(e.g., if
the user is Ann Brown, Valve would be ABValve) This will eliminate problems when deploying your
objects in a common galaxy later in the course.
6-14
Module 6 - Security
Configure t h e SecurityTest Object
3.
Configure the Security Classifications for each UDA in the object as follows:
Attl-FreeAccess:
Free Access
Att2-Operate:
Operate
Att3-SecuredWrite:
Secured Write
Att4-VerifiedWrite:
Verified Write
Att5-Tune:
Tune
Att6-Configure:
Configure
Att7-ReadOnly:
Read Only
5. Assign the new instance to the ABDischarge area and deploy it.
7. Add a security group named TestGroup and assign the ABSecurityTest-001 instance to it.
8.
unchecked
SMC Permissions:
unchecked
checked
checked
TestGroup:
unchecked
Wondenvare Training
Lab 17 - Securitv
6-15
9. Add a new role named Operators with an access level of 500 and with the following
permissions:
No General permissions
No Operational permissions for the Default security group
Configure the Operational permissions section for the TestGroup security group as follows:
Can acknowledge Alarms:
checked
unchecked
checked
unchecked
10. Add a new role named Supervisors with an access level of 1000 and with the following
permissions:
No General permissions.
No Operational permissions for the Default security group.
Configure the Operational permissions section for the TestGroup security group as follows:
Can acknowledge Alarms:
unchecked
unchecked
unchecked
checked
11. Add a new role named Engineers with an access level of 2000 and with the following
permissions:
Configure the General permissions as follows:
IDE Permissions: checked (this will check every box within the node)
Framework Configuration:
unchecked
SMC Permissions: checked (this will check every box within the node)
Configure the Operational permissions for the TestGroup security group as follows:
Can acknowledge Alarms:
unchecked
checked
unchecked
unchecked
.-
6-16
Module 6 - Security
12. Configure the Administrator role with all Operational permissions.
13. Add a new user named Hoper with a full name of Homer Operator and make it part of the
Operators role. Assign ww as the password.
14. Add a new user named JSup with a full name of Joe Supervisor and make it part of the
Operators and Supewisors role. Assign ww as the password.
15. Add a new user named WEng with a full name of William Engineer and make it part of the
Engineers role. Assign ww as the password.
Test General P e r m i s s i o n s
16. Verify that the WEng user cannot modify the security configuration through the ArchestrA IDE
Test Operational P e r m i s s i o n s
17. Login as Administrator and deploy the ABSecurityTest-001 object,
18. Using the watch list created in Lab 5, add a new watch window called Security and add the
following attribute references:
20. Test the different security classifications and the security permissions by modifying the value
of the attributes under the different user accounts created before.
Wondemare Training
Lab 17 - Security
View the Security Audit Trail
21. Use SQL Sewer Management Studio to query all data from the v-EventHistory view
6-17
6-18
Module 6 - Security
From the Galaxy menu, select Import1 Object@) to import an automation object
2. On the lmport Automation Object(s) dialog box, navigate to C:\Wonderware Training and
select the $SecurityTest.aaPKG file. Click the Open button.
Wondenvare Training
Lab 17 - Securitv
3. On the Import Preferences dialog box, leave the default options and click OK to continue
Note: Importing objects will be discussed in detail, including the options in this dialog box, in
the followina module.
e.
ABGala?
$ @ A6 Training
.
i:
.
i..
:
:.
.i
.
,.,,
@ Application
.
:
(J SAnalogDevim
:
.
. (9 SBoolean
.i
:
;- g SDiscreteDevice
.
.i 9 $Double
.
yO
SFieldReference
6-19
6-20
Module 6 -Security
4.
-.
.-
pjTemplate Toolbox
.
. .. .
. . . .. ..
Wondeware Training
Lab 17 - Security
6. Select the Attl-FreeAccess UDA and click the Shield icon to select the security
classification for the attribute. Select the Free Access security classification from the popup
menu.
Datatype:
category:
7.
Repeat step 6 to configure the security classifications for the following attributes:
~tt2-operate:
Att3-SecuredWrite:
Att4-VerifiedWrite:
I
@
rq
AM-Tune:
[
-
Att6-Configure:
8.
Operate
Secured Wr~te
-
Ver~f~ed
Wr~te
Tune
Configure
Click the Save and Close button and check in the object
6-22
Module 6 - Security
Create and deploy an instance of SecurityTest
9.
Using the Template Toolbox and the Model view, create an instance of the $ABSecurityTest
template. Leave the default name and assign the instance to the ABDischarge area.
Wondenvare Training
Lab 17 -Security
12. Select Galaxy for the Authentication Mode.
6-23
6-24
Module 6 - Security
13. Select the Security Groups tab.
Wonderware Training
Lab 17 - Security
15. Select the Default security group and locate the ABSecurityTest-001 instance in the objects
list (right pane).
6-25
6-26
Module 6 - Security
16. Drag-and-drop the ABSecurityTest-001 instance to the TestGroup in the security group list
(left pane).
Select the TestGroup security group.
Important! Make sure that you are moving the object's instance and NOT the object's
template.
Wonderware Training
Lab 17 -Security
17. Select the Roles tab.
Ei
Ei
E
6-27
6-28
Module 6 - Security
18. From the Roles available list, select the Default role and configure the permissions as
follows:
SMC Permissions:
checked
TestGroup:
unchecked
Wonderware Training
Lab 17 -Security
checked
unchecked
checked
unchecked
6-29
6-30
Module 6 - Security
unchecked
unchecked
unchecked
checked
'
C] c a n Startfitop EngineiPiatbrm
[?can Write t o GObject Atbibutes using 0
[?can
acknowledge Alarms
Wonderware Training
Lab 17 - Security
unchecked
checked (this will check every box within the node)
Configure the Operational permissions for the TestGroup security group as follows:
Can acknowledge Alarms:
unchecked
checked
unchecked
unchecked
............
'
6-31
6-32
Module 6 - Security
22. Select the Administrator role and configure the Operational permissions for the TestGroup
security group as follows:
TestGroup: checked (this will check every box within the group)
SMC Permissions
..
..
Wondenvare Training
-m
Lab 17 - Security
23. Select the Users tab.
6-33
6-34
Module 6 - Security
Wonderware Training
Lab 17 - Security
With Hoper selected, click on the Change Password button, enter the following information
in the Change Password dialog box, and then click the OK button to continue.
Old Password:
[blank]
New Password:
ww
ww
6-35
6-36
Module 6 -Security
27. With JSup selected, click on the Change Password button, enter the following information in
the Change Password dialog box, and then click the OK button to continue.
Old Password:
[blank]
New Password:
ww
ww
Wondenvare Training
Lab 17 - Security
29. With WEng selected, click on the Change Password button, enter the following information in
the Change Password dialog box, and then click the OK button to continue.
Old Password:
[blank]
New Password:
ww
ww
30. Back on the Configure Security dialog box, click OK to accept the security configuration
31. On the Change User dialog box, enter the following information and then click the OK button
to log in:
User name:
WEng
Password:
ww
6-37
6-38
Module 6 - Security
33. From the Galaxy menu, select Change User to log in as the Administrator.
34. Enter Administrator for the User name and click the OK button to log in as the Administrator.
Note: Bv default the Administrator account DOES NOT have a
Wondeware Training
D ~ S S W O
assianed.
~ ~
Lab 17 - Securitv
36. Open Object Viewer by right-clicking the ABSecurityTest-001 instance and selecting View
in Object Viewer. If you closed Object Viewer before, you can use File I Load Watch List to
open the file you saved earlier.
37. Right-click in the Watch List (bottom section of Object Viewer) and select Add Watch
Window to add a new tab to the watch list.
38. Right-click in the Watch List (bottom section of Object Viewer) and select Rename Tab ... to
rename the watch list to Security.
Scanstate
ScanStateCmd
ABSecurityTest-ODl.Att2-Operaie
ABSecurityTest_001.At1313SecuredWriie false
ABsecurityTest-ODl.A~4-Verified\fiIrite false
ABSecurityTest-001.AE5-Tune
false
ABSecurityTest-00l.Am-Configure
false
ABSecurityTest-001.Att7-ReadOnly
false
ABSecurityTest-00l.ScanState
true
ABSecurib,Test-001,SmnSiateCmd
hue
C0:Good
C0:Good
C0:Good
C0:Good
C0:Good
C0:Good
Ok
Ok
Ok
Ok
Ok
Ok
6-39
6-40
Module 6 - Security
41. Test the different security classifications and the security permissions by modifying the value
of the attributes under the different user accounts created before.
To log in to Object Viewer with a different user account, select Change User from the
Options menu.
42. Enter the user's credentials in the Change User dialog box and then click the OK button.
You can verify the current logged in user on the lefl side of the status bar.
.
--. -.-- ....
.. . .. . ..-.
.. ...-. ....
-..
FILE: C:\.?ona~r,;,areTrain~ng'fily
Watch rnr~ndc;,!
..
. . User: hoper
Wondeware Training
- -.. .. . -. ..
.!.lode:
.
U S E T I
.p4
Lab 17 - Security
View the Security Audit Trail
Note: Make sure that the Alarm DB Logger Manager utility is started.
Tip: You can refer to Lab 15 - Configuring Alarms to see how to run and start the Alarm DB
Loaaer Manaaer utilitv.
43. Launch the SQL Sewer Management Studio by selecting Start / A l l Programs IMicrosoft
SQL Server 2005 1 SQL Server Management Studio.
44. Configure the Connect to Server dialog box as follows and then click the Connect button to
continue:
Server type:
Database Engine
Server name:
localhost
Authentication:
Windows Authentication
6-41
6-42
Module 6 - Security
45. In the Object Explorer (left pane) navigate to localhost IDatabases IWWALMDB [Views to
get a list of all the database's Views in the Object Explorer Details (right pane).
dbo
dbo
dbo
dbo
dbo
dbo
dba
dba
dba
dba
dbo
ot
l Mampement
o CI NobficaPan Sernces
46. On the Views list (right pane), right-click on the v-EventHistory view and select Open View
to display the current list of alarms logged in the database.
-T... LBDerharge
OPR
false
bue
hue
hue
Closed
Stopwd
false
Wondeware Training
Galaxy Maintenance
Section 1 - Exporting and Importing Objects
Section 2 - Configuring Instances Through a .CSV File
Section 3 - System Management Console (SMC)
Section 4
7-2
Module Objectives
Obtain an overview and understanding of:
Exporting and Importing Objects
Configuring Instances Through a .csv File Using Galaxy Dump and Load
Using the System Management Console to manage platforms
Using the Network Account Ut:lity
Wonderware Training
Section Objective
T h ~ ssection discusses some fundamental funct~onsdealing with Galaxy Maintenance.
Specifically, it illustrates how to Export for future use and how to Import a galaxy created
previously.
7-3
2.
Note: You can export more than one object with this function by first multi-selecting objects
(Shift+Click or Ctrl+Click). If you want to export all of the objects in the Galaxy, point to
Export and then click All AutornationObjects.
Wondenrare Training
In the Export Automation Object(s) dialog box, browse to the path and filename (.aaPKG
extension) of the export file and click Save. Click Cancel to terminate the export function. If
you click Save, a progress box is displayed.
I/
Export completed
7-6
'
ABAulur~~al~unOblecI~~aPKG
Size Type
6.61 3 KP M P G F e
..
.-
Note: Export maintains containment relationships that were previously specified. Also, if an
object is currently checked out, the last checked in version of the object's configuration is
exported.
Wondenvare Training
7-7
7-8
Export completed
I[
Wondeware Training
I 4
' Name
~~ABAulomalion0b:ecl
aaP(&
B
-
..
Sic] Type
6.613 <B
12.788 <I3
M P < G F It
PAFG F
One key factor to mention is that the security model settings for objects does NOT get exported
when using the Export function. In order to export those you would have to use the Backup
process in the Galaxy Database Manager in the System Management Console (SMC)
discussed in the next Section of this manual.
7-9
7-10
Wondeware Training
7-11
7-12
When the import process is complete, you can start using the objects you imported
Wondeware Training
Galaxy Dump
Object instances and their configuration data can be exported to a comma-delimited format Galaxy
dump file (.csv extension).
Note: This function only dumps instances. Templates cannot be dumped. The .csv file contains
the configuration for the checked in versions of the selected objects as well as the checked-out
objects of the user who initiates the Galaxy dump. The file contains only those attributes that are
unlocked and configuration time-writeable, one column per attribute. Attributes that are locked,
calculated or runtime writeable only are not saved to the file. Attributes that are not text based (for
example, type QualifiedStruct) are not dumped. Object Help files are not dumped.
To export objects to a Galaxy dump file
1. Select an object in the Application Views pane. You can export more than one instance with
this function by first multi-selecting objects (Shift+Click). Also, you can dump all instances
derived from a template by selecting just the template.
2)
7-13
7-14
Wondeware Training
Browse to the name and location of the .csv file to which you want to dump the selected
instances. Click Save to continue or Cancel to end the export function. The Galaxy Dump
progress box is displayed.
4. After the Galaxy dump process is finished, click Close. A .csv file has been created containing
the selected objects and configuration data.
I/
Dump completed
7-15
7-16
Note: Carriage returns in scripts associated with dumped objects are replaced with "\nu in the .csv
file. If you edit the dump file, do not delete the "\n" characters. If you edit scripts in the dump file.
use "\nu for a carriage return. This character set is interpreted as a carriage return when the dump
file is used in a Galaxy Load function. When editing a script in a dump file, use "\\nu if you want to
include the character "\" followed by the character "n" in a script. This character set is not
converted to a carriaoe return in a Galaxv Load function.
Wondeware Training
7-17
7-18
Select the file and click Open to continue or Cancel to end the import function
Wondeware Training
3.
Choose the preferred conflict resolution and click OK. A progress box is displayed during the
Galaxy load process. Click Cancel to terminate the Galaxy load process.
A Galaxy Load dialog box appears indicating that the Load was successful
All objects that were changed or created during the Galaxy Load process are checked out to
the logged in user.
Note: A comment line in a .csv file created in Microsoft@Excel may create an unintended
default-value object. To avoid this scenario, open the .csv file in Notepad to ensure the
comment line does not contain quote marks.
-v*
7-19
7-20
Wondenvare Training
Section Objectives
Understand the role of the System Management Console, and;
Have an understandmg of how it can be configwed
This section provides an understanding of role of the System Management Console and how it can
be configured.
.
..
.
Some of the key features of the Platform Manager are that it:
Runs with minimal ArchestrA and operating system requirements, equivalent to "Safe
mode"
Uses the local platform as the gateway to the ArchestrA application
Does not rely on the Galaxy Repository to exist
Allows viewing of the layout of the Galaxy Repository, Platforms, and Engines
.
e
7-21
If Platform Manager has security enabled, the Platform Manager Login dialog box appears.
....
....................
iug!! .
User name'
! -
Passv:ord:
Darnan:
OK
Cancel
I-~
' -J
...............
. . . . . . . . . . . . . . . . . . .
..
. w~ .. " .... ..
. . . . . . .
...-....
.
Change Password
From the Platform Manager Login dialog box, enter your User Name and Password. If the
configured security is OS User Based, then select the domain from the Domain list box. Click OK.
Wonderware Training
Console Tree
The console tree has a Windows Explorer-type hierarchical structure layout, with the ArchestrA
System Management Console appearing as the root node and the SMC snap-ins appearing
below this node. Like Windows Explorer, the console tree can be expanded or collapsed by
clicking on the "+" or the "-" symbols that appear next to the snap-in.
The console tree shows the items that are available in the console. The snap-ins that appear
below the ArchestrA SMC node include the PlatForm Manager, the Log Viewer, the DASewer
Manager, and the Galaxy Database Manager.
The contents of the details pane changes as you select items in the console tree.
Details Pane
The details pane is comprised of two main elements:
e
Column headings: when Galaxy Database Manager is selected in the console tree, two
columns are displayed, Node and Galaxy. The Node column identifies which node a
galaxy resides on. The Galaxy column displays the galaxy's name. Use this information
when backing up and restoring galaxies.
e
The contents of the details pane changes as you select items in the console tree.
7-23
7-24
There are four authentication modes for security that can be enabled for Platform Manager:
No authentication
e
Galaxy authentication mode
e
OS User Based authentication mode
e
When no security is enabled from the ArchestrA IDE, the user is automatically logged into Platform
Manager as "DefaultUser." Without security, the logon dialog box does not display when Platform
Manager is launched and the user is granted all permissions.
If the security configured from the ArchestrA IDE requires Galaxy authentication, OS User Based
authentication, or OS Group authentication, then some of the existing users and roles are not valid
and the user may not be able to perform some operations.
Galaxy Authentication
Galaxy authentication requires the user to log into Platform Manager every time the utility is
started.
OS Group Authentication
In OS Group authentication, the user defines roles that match OS Groups and at log in, the OS
Groups are matched with the roles.
The following commands are available from the Platform Manager Action menu when you select
a platform or engine in either the console tree or the details pane.
Wonderware Training
Command j .
Configure
Log Flags
Open Log File
Connect
Messages
Refresh
Help
.,)<'
'',:
,,
i 'i
' ;'
,, ,, ,<,
2pIIir,.<p,y,rr.o,,
.,.,
i.,,:.,
,
~
e
t
~
, , : .,,, ,
Allows configuration of the Log Viewer and Storage
Opens the Log Flag editor
Allows the opening of a Log File
Allows either local or remote connections configuration
Allows Messages to be exported, purged, or printed
Refreshed the database
Access to the System Management Console Help files
, . ,, ,i
, , ,,<'.:'
These commands are also available by right-clicking an item in either the console tree or the
details pane. The available commands are dependant o n the current state of the object and your
security permissions. If you do not have permission to perform a particular command, then that
command is grayed out.
The following commands are available from the Platform Manager View menu when you select a
platform or engine in either the console tree or the details pane.
.....
Command
Filter
Find
...
.........
......
- - .------
Description
-..- . . . . ................
- - .-,
Allows filtering of Messages. Time Range, or Terminal Sessions
Search capability on Process ID, Thread ID, Log Flag, Component, or
Message
7-25
7-26
>':
,,.,
,~.,*
,
, ' , ,:.>
,$,,, ~
, ,<,
dommana,~$~""":,',';:,',,
,:'.,,/'..~ ~1 +'~ c ~ ,,,:,~7,,,.<,
t i,,;:-;,:'
~ n , .:A?$$;;,,,,,,
,,,,..,,,. ,,.,. ,.3/?i
5 . ,, ,,
Allows redirection to a Bookmarked location
Go To
Allows Adding or removing of a Bookmark
Bookmarks
Allows the entry of a Marker Message to the log
Mark
Select specific columns to show or hide
Choose Columns
Change the appearance of the view
Customize
,',-.C
,,,;,, :,>.,,
,,2,
>,, >,
~y>,.,,,<c"**,.c,
,:;~,,~9:;;'s;~L~~$>',7?:8~~<~j~~
>#,,
,,,,:,~:~.,,,,
.
, ,
Forward
Up one level
ShowIHide Console TreelFavorites
Refresh
Help
Filter
EnableIDisable Message Filte~
Find
Fast Mark
Print
Print Preview
Wondeware Trammg
2. Open the Log Viewer by clicking Start, pointing to Programs and then to Wondeware, and
then clicking System Management Console. In the SMC, select Log Viewer and then the
7-28
The following chart indicates the key differences in Log Viewer and WWLogger.
. .Yes
..~
The journey of a Log Message originates with the Application where Log Flags are generated.
These are passed to the Logger where they are then stored in the Log Message Storage. They
are then available for viewing by the LogFlag Viewer. The LogFlag Editor provides the capability
to edit the LogFlags. This is illustrated in the following diagram.
Wondenvare Training
Using Bookmarks
Bookmarks are unique labels you can apply to individual messages for quick access. They differ
from marks in that bookmarks are associated with specific messages while marks are messages
added below the message that is currently last in the log.
You cannot enter duplicate bookmark names for more than one message, and a message can
have only one bookmark.
The message window can display a Bookmark column, which is initially hidden by default. To
show the Bookmark column, right-click on the column header of the message window and click
Show. In the Choose Columns dialog box, click Bookmarks in the Columns Hidden box, click
the Show button to move it to the Columns Shown box and click OK. The Bookmark column is
added at the far right of the column header. Click and drag it to another position if you want. When
the text of a bookmark in the Bookmark column is partially obscured, point to it to display the
entire bookmark like a tool tip.
You can set bookmarks in two ways: adding a regular bookmark that you can name and setting a
fast bookmark that is named for you.
To a d d a regular b o o k m a r k t o a message
1. Right-click the message and click Add Bookmark on the Bookmark submenu.
2. In the Add Bookmark dialog box, either accept the default name (Bookmarkx where x is a
number in an ascending sequence) or overwrite it with something more descriptive. You can
change the bookmark name in the Bookmarks dialog box at a later time. See "To manage
bookmarks" below.
3.
To s e t a f a s t b o o k m a r k on a message
1. Right-click the message and click Fast Bookmark on the Bookmark submenu. A default
naming sequence is applied to the message (Bookmarkx where x is a number in an ascending
sequence). Alternatively, you can set a fast bookmark by selecting the message and clicking
the Fast Bookmark icon on the toolbar.
2. Change the bookmark name to something more descriptive, if necessary, in the Bookmarks
dialog box at a later time. See "To manage bookmarks" below.
7-29
7-30
2.
In the Go To dialog box, enter the name of the message's bookmark by typing it in the box or
selecting from the list.
3.
4.
Use the Previous and Next buttons to go to the nearest bookmarked message above and
below, respectively.
To manage b o o k m a r k s
1. On the View menu, click Bookmarks.
2.
In the Bookmarks dialog box, you can manage current bookmarks and create new ones. The
bookmark list shows the current set of bookmark names and associated Message No. (the
same number as the No. column in the message window). The bookmark list provides several
functions.
3. For instance, to rename a bookmark, select it, press F2 and type the new name. Note that
each bookmark must have a unique name; so you cannot bookmark two messages with the
same name.
4. To go to a bookmarked message, double-click on it in the list or select it and click Go To.
5. To remove one or all bookmarks from your logged messages, select a message and click
Remove, or click Remove All.
6. To add a new bookmark, select the message you want to bookmark in the message window
and click Add. This function is comparable to a fast bookmark. Rename it by pressing F2.
7. When you are done, click Close,
Note: Bookmarks are not saved when you quit the Log Viewer application. To mark your message
log more permanently, use the Mark command on the View menu.
DAServer Manager
The QASewer Manager allows local or remote configuration of the DA Sewer and its device
groups and items, and can monitor and perform diagnostics on DASewer communication with
PLCs and other devices.
Wondeware Training
7-31
7-32
Wondenvare Training
Node-to-Node Communications
All computers that have installed ArchestrA-enabled software must be able to communicate with
each other. This communication is enabled through an ArchestrA-specific user account set up
during the initial installation of an ArchestrA component on each computer.
Subsequent installations of ArchestrA components do not prompt for user account
information. They automatically use the account set up during the installation of the initial
component.
The user account described in this document only enables node-to-node communications
between ArchestrA components. It is not associated with ArchestrA security, which provides user
authentication for individual access points to the infrastructure.
Note: You must have Administrator privileges on the computer to make changes with the Change
Network Account utilitv.
To recreate a n ArchestrA u s e r a c c o u n t
1. Start the Change Network Account utility by selecting StartlProgramslWonderwarel
CommonlChange Network Account.
7-33
7-34
The data shown in this dialog box are those settings entered during the initial installation of an
ArchestrA component on the computer. The password options are shown blank for security
reasons.
Wonderware Training
Note: After you recreate the user account in the Change Network Account dialog box, the
Microsoft Windows security component on your computer may take several minutes to update
this information on the ArchestrA Galaxy node. Until that occurs, your ArchestrA IDE may not
function properly. Rebooting the Galaxy node causes this update to occur immediately.
7-35
7-36
Error Messages
When using the Change Network Account utility, you may encounter the following error messages
. .. .
...
fiction
.
.
. Required . .. .. .. .. . - ... .
YUJ m ~ shave
t
Adm~nstrator ~ r leqcs
v
on the compdter to rJn Ihs
~tility.Click OK, login as a uskr with~dministratorrights, and start the
Shange Network Account utility again.
You must type a password in the Change Network Account utility. Click
OK, type a password in the dialog box, type the same password in the
:onfirm
Password box, and then click OK again.
--
You chose to use a local machine or network domain account that does
not exist. Click OK. Ensure the user account you entered in the
DomainlLocal Machine Name box is valid and the user name and
password you typed are valid for that user account, and then click OK.
If this message is displayed again, check with your network
administrator about the existence of the account.
~~~~~
You chose to use a local machine user account, but the password you
typed does not match the accounPs password. Click OK if you want to
change the password for this user account or Cancel to revert to the
original settings. If you click OK, the password for the account is
changed. If you click Cancel, the Change Network Account utility is
displayed, allowing you to correct the password or type another user
name and password.
Invalid ~omaizname'dom'.
Please enter a valid domain
name.
Wondeware Training
grroi Message':".'
,.\,.X.<' -.
>';:,,,:r,/e:;,
\
You used one or more invalid characters in the User Name box: Click
OK,type a valid user name and click OK.
You must type a user name in the Change Network Account utility.
Click OK,type a user name in the dialog box, and then click O K again.
,,'
1I'~ddress
IFli
@GO
I!
7-37
7-38
Wondeware Training
2.
Select lnternet Protocol (TCPIIP) in the list of components used by this connection, and click
Properties. The lnternet Protocol (TCPIIP) Properties dialog box (see image below) is
displayed.
7-39
7-40
3.
For the supewisory network, select Obtain an IP address automatically. For the other
network connections, select Use the following IP address. Consult your network
administrator for the proper settings for the remainder of the parameters in this group.
4.
Click Advanced. The Advanced TCPIIP Settings dialog box (see image below) is displayed.
Click the DNS tab.
Wondeware Training
5.
Forthe supervisory network, select Register this connection's addresses in DNS. For the
other network connections, clear this check box.
6.
Click OK.
.-
7-41
7-42
- Infentionally
Wonderware Training
left blank -
evice Integration
Section 1 - Wondeware 110 Servers
Section 2 - Data Access Servers
Section 3
8-2
Module 8
Module Objectives
Obtain an overview and understanding of:
DAServers and Dl Objects and how they relate to the connectivity of your application to
external data.
FactorySuire Gateway and how it can enhance the connectivity of your applcalion.
Wondeware Training
Section Objective
Configure a Wonderware I10 Server (Modbus)
This section will describe the configuration of a Wonderware I10 Server (Modbus).
Introduction
Wonderware 110 Servers are Microsoft Windows application programs that enable other DDEaware Windows applications (such as InTouch or Excel) access to data in the real world (such as
PLCs or RTUs).
Wonderware servers are primarily intended for use with Wonderware's InTouch program; however,
they can be used by any Microsoft Windows program capable of acting as a DDE client.
In this section, we will examine the start-up, configuration and use of a Wonderware 110 Server.
Because Wonderware's I10 servers are Windows applications, they will all have the same basic
appearance and capabilities. Keep in mind that depending on server required, additional hardware
(network, and so on) may be necessary and the configuration screens may require additional
information.
The following information references the Modbus I10 Server as a point-to-point server using the
RS-232 serial port to PLCs provided at the Wonderware facility training environment. Your
instructor may have you configure the following screens differently.
Note: All I10 Server setup which follows is specific to the Wonderware facility training
environment. Your instructor will provide the proper configuration information. It accesses one
Koyo DirectLogic 0 5 PLC via its programming port.
8-3
8-4
Corn Port: Select the communication port that is connected to the PLC equipment
Reply Timeout: Enter the amount of time (in seconds) that all PLCs connected via this serial
communications port will be given to reply to commands from the I10 Server.
Note: This timeout is sustained only when the PLC fails to respond. When the PLC is
responding normally, there is no penalty. The default value of 3 second should be sufficient for
most confiaurations.
Protocol area: Select the protocol configured for the equipment attached to this
communication port. RTU is recommended.
Baud Rate area: Select the baud rate (serial bit rate) setting that matches the equipment
connected to this communication port.
Data Bits area: Select the option for the number of data bits that corresponds to the
configuration of the equipment on this communication port.
If ASCII is selected for the protocol, use 7. If RTU is selected, use 8
Stop Bits area: Select the appropriate number of stop bits for the communication port. If the
baud rate is greater than 300, the stop bits should be set to 1.
Parity area: Select the setting that corresponds to the configuration of the equipment on this
communication port.
Note: All devices on a single communication port must be configured with the same Protocol,
Bits, Data Bits and Baud Rate.
Paritv. S t o ~
Wonderware Training
Save your changes in the suggested directory and click Done to exit.
Note: Click Save to save the current settings entered for the selected communication port.
The Communication Port Settings dialog box remains displayed and another communication
port can be configured.
8-6
Note: Once topics have been defined, their names will be listed in the Topics pane of this
dialoa box.
c. Topic Name: Enter a unique name (up to 32-characters long) for the PLC in the field
Note: When communicating with InTouch, this exact name is used as the topic name in the
Access Name definition.
d. Comport: Select the communications port to be associated with this topic.
Wondewwe Training
f.
Slave Device Type: Drop-down list contains slave device types other than the default,
g. String Variable Style: The PLC will use this style to store ASCII strings in its registers.
Block 110 Sizes: Coil Read: Enter the maximum number of consecutive coils to be read at
one time. In this example, the valid coil read values can be between 8 and 2000 and must be
an even multiple of 8.
j.
Coil Write: Enter the maximum number of consecutive coils that can be written to at one time.
In this example, the valid coil write values can be between 8 and 800 and must be an even
multiple of 8.
k.
Register Read: Enter the maximum number of consecutive registers to be read at one time.
In this example, the valid register read values can be between 1 and 125.
I.
Register Write: Enter the maximum number of consecutive registers that can be written to at
one time. In this example, the valid register write values can be between 1 and 100.
m. Update Interval: Enter the frequency (in milliseconds) that the 110 Server will read (poll) the
itemslpoints associated with this topic. Different itemslpoints can be polled at different rates by
defining multiple topic names for the same PLC and setting different update rates for each
topic.
o. Click the Done button to close this dialog box and return to the server's program window.
p. Click Modify to change an existing topic definition
q. Click Delete to delete an existing topic definition
Note: The previous information is provided for example only. Configuration steps for this class
are provided in the following lab.
8-7
8-8
Wondeware Training
Section Objective
Become familiar with DAServer and its use with Wondeware Application Server.
This section provides familiarization with DAServer and its use with Wonderware Application
Server.
Introduction
Wonderware's DAServer is designed to provide simultaneous connectivity between client
applications based on Wondeware@SuiteLinkN, OPC and DDE protocols that run on Microsoft's
Windows@2000 and Windows XP operating systems and the data devices supported by the
specific protocol being translated.
Wonderware's DAServers also come with an exclusive new user interface called the DAServer
Manager, which is installed as a Microsoft@Management Console snap-in. Its end-user benefits
include simple remote server activation, configuration and operation, and extensive protocol
diagnostic troubleshooting.
Several standard features are available with each DAServer, including:
e
Compliance with OPC version 2.05
e
Stand-alone operation mode
e
Support for hot configuration, device additions and device- and server-specific parameter
modifications
A wide range of DAServers support connectivity to numerous protocols and products
Wonderware's current DAServers offering also includes support for:
Allen-Bradley's CIP protocol for ControlLogix
e
Allen-Bradley's TCP protocol
e
e
e
Configuration
DAServers can be configured using the DAServer Manager utility. The DAServer Manager is an
MMC shell capable of displaying specific configuration pages for each configuration node. This
utility allows browsing and editing of servers on different nodes.
DAServers are hot configurable. In other words, they are configurable while the server is running
or even acquiring data. Certain restrictions imposed by the underlying networklprotocol/hardware
might apply. For instance, if you uncheck System ltems on the global parameters configuration
dialog of the DAServer Manager and select Apply, and then re-check System ltems and Apply,
System ltems data is valid only to newly connected clients.
The configuration data format for DAServers is XML. Any XML-enabled program (for example, I
and XML Notepad) can read this format.
8-9
8-10
Typical Plug-ins use DDE, SuiteLink or OPC protocol, and serve as interfaces between
their clients and the DAS Engine. A protocol can be disabled when customizing the
installation for your DASewer.
DAS Engine: common component used by all DASewers.
The DAS Engine is a middleware component that exposes two sets of unique interfaces,
one for communicating with Plug-ins and one for communicating with Device Protocol
Layer components. It encapsulates common tasks for the DAServer, like handling the item
database, distributing data to clients, propagating clients' requests to the protocol, and
providing diagnostics.
Device Protocol Layer: Server specific (responsible for communicating with hardware and
specific to the DAServer). The Device Protocol Layer provides translation between the
hardware- specific protocol such as ModBus and CIP and the DAS Engine interface:
Components
DAS ENGINE
DEVICE
eel
C-
HARDWARE
Each physical part of a DAServer is comprised of a set of .EXE and/or .DLL modules. ArchestrA
provides the Plug-in and DAS Engine modules.
Wondeware Training
Plug-ins
Plug-ins provide protocol translation functionality for device integration clients. Typical Plug-ins
communicate in DDE, SuiteLink or OPC protocol, and serve as interfaces between their clients
and the DAS Engine. You can disable a protocol when customizing the installation for your
DAServer.
DAS Engine
The DAS Engine is a middleware component that exposes two sets of unique interfaces, one for
communicating with Plug-ins and one for communicating with Device Protocol Layer components.
It encapsulates common tasks for the DAServer, like handling the item database, distributing data
to clients, propagating clients' requests to the protocol, and providing diagnostics.
DAServer Characteristics
Configuration
The DAServer Manager is capable of displaying specific configuration pages for all servers. This
utility allows browsing and editing of servers on different nodes.
Recall that DAServers are hot-configurable. In other words, they are configurable while the server
is running or even acquiring data. Certain restrictions imposed by the underlying network/protocol/
hardware might apply.
For instance, if you uncheck System ltems on the global parameters configuration dialog of the
DAServer Manager and select Apply, and then re-check System ltems and Apply, System ltems
data is valid only to newly connected clients.
The configuration data format for DAServers is XML. Any XML-enabled program (for example, IE
and XML Notepad) can read this format.
Runtime
The DAS Engine is loaded by the DAServer as an in-process COM object.
It is not statically linked. In other words, a new DAS Engine (feature enhancement or bug fix)
would not require re-linking to the other components nor re-QA of those other components. It is
deployed to the system and attaches to all existing server components.
This is an important added value for the customer to be independent of ArchestrA release cycles,
especially for OEM customers with their own release schedule.
Newly deployed Plug-ins do not require re-linking nor re-QA of associated components. Even new
Plug-ins would not require any development effort for the other components. In fact, it is feasible to
implement new functionality (like Store-and-Forward) in a Plug-in t o p h a n c e the server without
involvement of the code of the other components.
8-11
Hot Configuration
One of the big advantages provided by the DAServer is the ability to make your DAServer
configurable while the server is running - hot configuration.
The extent to which a specific DAServer is hot configurable varies from server to server. You can
choose from a variety of hot configuration responses, from not being hot configurable at all to
being configurable of each individual parameter while the server is running.
The DAServer handles most of the hot configuration work. In general, a user will run the DASewer
Manager and configure each hierarchy. Any changes she makes that addldeletelupdate a
hierarchy are sent immediately to the running DAServer.
Sewer-specific code may elect to react to the change. Some parameters cannot be changed while
the DAServer is running due to protocol-specific issues, and these can be ignored by the sewerspecific code.
Here is a complete list of notifications to the sewer about changes in the configuration:
Add configuration hierarchy.
Delete contiguration hierarchy.
Rename configuration hierarchy.
Update parameters of configuration hierarchy.
Add device group.
Delete device group.
Rename device group.
Update parameters of device group.
Clear the current configuration set.
Switch to a new configuration set.
Wondeware Training
FS Gateway is also useful for legacy servers, controllers, and operating systems. Gateway can
translate older DDE to the newer SuiteLink protocol, enabling legacy products to connect to newer
systems.
8-13
8-14
Refer to the Wondeware support website, especially the Compatibility Matrix, for more
information on specific connectivity tools.
Wondenvare Training
7) Does FS Gateway provide Galaxy to Galaxy communications with ArchestrA and the
Wonderware Application Server?
FS Gateway does provide the means for data access from an ArchestrA Object Attribute in
Galaxy A to an ArchestrA Object Attribute in Galaxy 6, in the same fashion that an Object
Attribute in Galaxy A could receive data from any OPC Server. The plan is that a future release
of the Wonderware Application Sewer will have built-in "Intergalactic Communications". FS
Gateway can still be used for this in the interim, but an even better solution is forth coming.
..-
When used with the Wonderware Application Server, Role-based security is employed. That
means that a User is defined on the node where the FS Gateway is installed. That User
account is linked to an ArchestrA Role, which is linked to a Security Group, which is linked to
individual Object Attributes. Therefore, the defined user can only access those attributes
which it is assigned within the Galaxy. This needs to be managed carefully as any program
that utilizes that user account on the FS Gateway node, either locally or remotely can access
the associated attributes, with no specific knowledge of which external application is
accessing the Galaxy.
8-15
8-16
10) What capability is there to browse tag and attribute values for products using the FS Gateway?
FS Gateway can "browse" InTouch and OPC DA Servers Data Connections. This is
accomplished inside the SMC which is the centralized place for configuration and diagnostics.
All other data connection items are manually entered (or alternatively can be imported from a
CSV file) before the data can be browsed. This "browse" is the ability to navigate the actual
native information (either on InTouch or OPCSewer). Once a group is created and the items
created inside the group then a client can browse this "configured" data.
For the Wondeware Application Sewer, it is necessary to manually enter the item names.
This can be done on the IAS platform first and then exported into a .csv file and then imported
into the FS Gateway. Once these items have been manually entered the OPC Client will be
able to browse the data. The user can still access data that has not been configured for
browsing but the item name must be known. SuiteLink inherently does not allow for browse
capabilities.
12) What data is accessible in the Wonderware Application Sewer Galaxy via the FS Gateway?
The FS Gateway exposes 4 basic data types in a Galaxy. They are Boolean, String, Float and
Integer.
Wondeware Training
Server Products
e
DDE Servers
e
14) Can I run more then one instance of FS Gateway on a single computer?
No, only a single instance of the FS Gateway can be run on a single computer at the same
time. This is similar to our DAServers.
15) Can I have multiple galaxies as data sources connected to an instance of FS Gateway?
No, the FS Gateway must be on the same platform as the Application Server and only one
instance of Application Server can reside on a particular platform.
17) How many Data Sources can I have connected to an instance of FS Gateway?
The FS Gateway can act as a data concentrator and can access as many sources as you
would like to connect to (with the limitation of only one can be an Application Server).
For additional information or details on how to access and configure Factory Suite Gateway please
refer to the Wondeware FactorySuite Gateway User's Guide.
.-
8-17
8-18
Wondenware Training
Section Objective
Become more familiar with Dl Objects and their use with Wonderware Application Sewer.
This section provides familiarization with Dl Objects and their use with Wonderware Application
Server.
Introduction
Device lntegration (Dl) Objects are designed for applications that connect to Application Server.
They represent the application's network and devices, and mirror the actual device hierarchy. In
Application Server, Device lntegration (Dl) Objects are a subset of Automation Objects available in
the Template Toolset of the Integrated Development Environment (IDE). As a subset of these
Automation Objects, Device lntegration Objects consist of two parts:
e
Dl Network Object, which represents the communications port and are thus associated
with DA Sewers.
Dl Device Object, which represents the physical devices that make up a network.
Examples of Dl Device Objects are network bridge devices or PLCs. When the objects are
deployed, they represent the network hierarchy. Each level of this hierarchy can be
monitored for its individual status.
Device lntegration objects are used to represent communications channels and field controllers.
As such, they are most oflen arranged in a hierarchy that models the physical hierarchy of the
network and devices on that network.
Device lntegration objects are designed to make it very easy to integrate DAServers into the
ArchestrA environment.
Therefore, deploying a Dl Network actually deploys the DASewer and its associated components
within the ArchestrA IDEIGalaxy. This facilitates the DAServer installation process for end-users.
Dl Object Advantages
Device lntegration Objects (Dl Objects) represent communication with external devices. Dl
Objects may be DlNetwork Objects (for example, the Redundant Dl Object) or Dl Device Objects.
Dl Objects (and their associated AppEngine) can reside on any 110, DA, or Automation Object
Server node in the Galaxy. Dl Objects allow connectivity to data sources such as DDE servers,
SuiteLink servers, OPC servers, and existing InTouch applications.
The advantages of using Dl Objects are as follows:
e
When ArchestrA IDE soflware is installed on a Wonderware Application Server, Dl objects
allow you to configure, deploy, and monitor DAServers from one centralized location.
o
Dl Objects can be used to represent all devices and PLCs in a network, enabling
representation of an entire plant, including a hierarchical view of network connectivity.
e
Dl objects are so closely tied to the DAServer that when an object is deployed across the
network, it remotely installs the DAServer (This means that you can install the DAServer
without going to the actual machine, and that the DAServer connects immediately.).
8-19
8-20
Dl objects are very closely tied to the DAServer they are assigned to, so that when an
object is deployed, it brings with it all code, including registry, scripting, attributes, and
parent.
Note that in a large project, this process may take some time. However, tremendous savings are
achieved when comparing centralized deployment with individual tasks should the Servers be
separately installed and configured on each node.
$InTouchProxy
$OPCClient
Cp $RedundantDIObject
The differences between the Application and Dl Objects are listed below:
e
Dl Objects are associated with a DAServer.
e
Dl Objects include some extra primitives in addition to the common Primitive (also hidden
by default. A special dialog provides access to the attributes developers might need to
override.).
e
Dl Objects include extra dependency files.
Dl Network Objects are hosted by an AppEngine, not an Area.
This impacts the Deployment view within the ArchestrA IDE.
rn
The Host must be deployed before the object can be deployed.
e
Dl Objects can be hosted by each other or by Dl Networks.
m
GUlDs tie the host and the hosted object together.
Dl Devices and Dl Network objects have extra tabs within their editors to configure
ScanGroups, BlockReads, and BlockWrites.
Wonderware Training
Multi-Node Applications
Section 1 - Application Redundancy
Lab 18 - Configuring Application Redundancy
Section 2 - Dl Redundancy
Lab 19 - Configuring the Redundant Dl Object
Section 3 - Multi Node Application
Lab 20
9-2
Wondenware Training
This section provides an understanding of the concept of redundancy, how it can be configured
and key points to more effectively implement this feature. It also provides an understanding of the
concept and functionality of Redundant Dl Objects
Redundant Configuration
Redundancy is important in processes that rely on continuous availability of information. There are
two basic types or topologies of redundant configuration:
Redundant Application Engines
Redundant Dl Objects
-*-
9-3
9-4
7
UEnable redundancy
Wondeware Training
Since an engine is required to run under a platform, the platform objects that sponsor the Primary
and Backup application engines need to be configured to use the dedicated NIC. This NIC
provides a high speed inter-connection link or Redundant Message Channel between the
platforms. The Message Channel is vital to keep both engines synchronized with alarms, history,
and checkpoint items from the engine that is in the Active Role. Each engine also uses this
Message Channel to provide its health, along with status information, to the other.
The sequence of deployment (cascade, Primary first, or Backup First) of the redundant pair of
Application engines determines which of these in the pair will take the Active Role. The first engine
deployed takes the Active role while the other one takes the Standby role. The engines maintain
their current roles until a failure occurs. (A failure might consist of computer hardware lost or failed,
or a network card failure.) If a failure occurs, the engine with the Standby role assumes the Active
role and the engine that was in the Active role is given the role of Standby - Not Ready. When the
cause of the failure has been remedied, this engine assumes the Standby - Ready role.
Terminology
Two sets of terms are critical to understanding the functions of redundant objects. These are
described below.
During Configuration
Primary object: The object intended as the main or central provider of the functionality in the
run-time. For AppEngines, it is the object you enable for redundancy. For data acquisition, it is
the DlObject you intend to use first as your data source in the run-time.
Backup object: The object that provides the functionality of the Primary object when it fails.
For AppEngines, it is the object created by the ArchestrA infrastructure when the Primary
object has been enabled for redundancy. For data acquisition, it is the DlObject you do not
intend to use first as your data source in the run-time.
During Run-Time
Active object: The object that is currently executing desired functions. For AppEngines, it is
the object that is hosting and executing ApplicationObjects. For data acquisition, it is the object
that is providing field device data through the RedundantDlObject.
Standby object: The passive object; that is, it is waiting for a failure in the Active object's
condition or for a force-failover. For AppEngines, it is the object that monitors the status of the
Active AppEngine. For data acquisition, it is the object that is not providing field device data
through the RedundantDlObject.
The PrimarylBackup and ActivelStandby objects form a redundancy pair. For AppEngine pairs,
only the Primary and its hierarchy of assigned Applicationobjects must be created, configured and
deployed. The Backup is handled completely by the ArchestrA infrastructure (for instance, it is
deployed separately from the Primary). For data acquisition, the PrimaryIBackup DlObjects (the
data sources) must be separately created, configured and deployed. Also, you must create,
configure and deploy a RedundantDlObject to control failovers between the two data source
objects.
9-5
Note: In the case of AppEngine redundancy, ArchestrA supports a one-to-one topology in which
the computers hosting the Primary and Backup object sets must be connected by crossover cable
and have fixed IP addresses.
Key Points
a.
Before placing an engine with redundancy enabled under a platform in the Deployment view,
configure the platform Redundant Message Channel; otherwise the engine will show an error
b. In the Application Views panes of the ArchestrA IDE, only in the Deployment view will the
Backup engine be visible.
c.
d. Afler editing an engine with redundancy enabled while it is deployed, when it is redeployed the
engine which has the Active role will perform this function. It will then update the engine that is
in the Standby role.
e. A Backup engine's deployment status can be different from that of the Primary Engine, but
operations such as renaming, importing and exporting, GRdump and GR load that are
performed on the Primary Engine are automatically performed on the Backup. These
operations cannot be performed on the Backup Engine alone.
f.
Platforms hosting primary and backup AppEngines should have identical configuration. For
instance, it is possible to configure the platform with the Primary to be the InTouch Alarm
provider and filter the areas you want to query in the Platform editor. For the Alarm
Management system to behave correctly, this same configuration should be implemented in
the platform with the Backup. It is recommended that you make the following parameters
common to both platforms:
IT Alarm provider-Areas
e
Store Forward directories
0
Common user-defined attributes (UDAs)
.
0
Common scripting
Role Determination
The sequence of deployment (cascade, Primary first, or Backup First) of the redundant pair of
Application engines determines which of these in the pair will take the Active Role. The first engine
deployed takes the Active role while the other one takes the Standby role. The engines maintain
Wandemwe Training
9-7
9-8
Supervisory Network
AutomationObiect Server
AutomationObiect Server
Control Network
In a Share
dun
lo or more Redundant Engines reside on each of two
platforms. Each platform hosts a Primary and a Backup engine. see the illustration below. This
scenario operates similarly to the Dedicated configuration, but allows the application load to be
shared on two computers until a failure occurs. When a failure occurs, one platform hosts the load
of both application engines. The benefits of using this approach is that the time of failover is
shortened and that only part of an application process is affected during a failure.
Note: It is important to understand both the CPU and memory load requirements of each engine.
Each computer must be capable of supporting these needs when a failure occurs: otherwise,
throuohout for the aoolication can be ~ 0 m ~ r o m i S e d
Wonderware Training
Visualization Nodes
I
Automationobject S e w e r
Supewisorv Network
I
AutomationObject S e w e r
Control Network
9-9
9-10
Standby Missed Heartbeats: The state of an AppEngine when 1) a heartbeat ping has
not been received from its Active partner within a configured timeout period, 2) the Active
AppEngine fails or hangs up, or 3) the Active AppEngine is shutdown on purpose. When in
this state, the Standby object attempts to determine whether or not the Active object has
failed. If a manual failover is initiated (by using the ForceFailoverCmd attribute), it will be
processed only if the heartbeats were missed over the primary network and not missed
over the RMC.
Standby - N o t Ready: The state of an AppEngine when one.pf several conditions occurs:
1) its has lost communications with its partner object or it maintains communications with
its partner but has missed checkpoint updates or alarm state changes from the Active
Wonderware Tra~nmg
Standby Ready: The state of an AppEngine when is has completed synchronizing code
modules and checkpoint data with the Active AppEngine. In this state, the AppEngine
monitors for Active AppEngine failure by verifying heartbeat pings received from the
Active engine, checks that all files required for execution are in sync with the Active
engine, and receives the following from the Active AppEngine: checkpoint change data,
subscription-related notifications, alarm state changes, and history blocks.
Standby Sync'ng with Active: The state of an AppEngine when it is synchronizing code
modules with the Active object. If code modules exist on the Standby computer that do not
exist on the Active node, they are uninstalled, and likewise, any code modules that exist
on the Active node but not on the Standby node are installed. Once all code modules are
synchronized, the AppEngine transitions to Standby-Sync'd Code state.
Standby Sync'd Code: The state of a Standby AppEngine that has successfully
synchronized all code modules with the Active object.
Standby - Sync'd Data: The state of a Standby AppEngine when all object-related data,
including checkpoint and subscriber information, are synchronized with the Active object.
An object in this state typically transitions to Standby-Ready state.
Switching t o Active: A temporaiy, transitional state when a Standby AppEngine is
commanded to become Active.
Switching t o Standby: A temporary, transitional state when an Active AppEngine is
commanded to become Standby.
Unknown: The state of a redundant partner when a communication loss occurs between
AppEngines or when the partner AppEngine is not running.
Alarm Generation
When failover conditions occur, the ArchestrA system reports alarms to the Logger. These alarms
contain the following information:
e
The name of the AppEngine reporting the alarm.
e
The node name of the AppEngine reporting the alarm.
e
The state of the AppEngine.
e
The node name of the AppEngine's partner object.
Note: Depending on the scenario that causes a failover, the Standby AppEngine may become the
Active in an offscan state and alarms may not be generated. If the Active AppEngine is shutdown
offscan, the checkpointer may transfer that state to the Standby, and when the latter becomes the
Active, it will startup offscan. When the AppEngine is put onscan, alarms then are generated.
9-1 1
9-12
Previous
! State
State
. . --.--.
Ready
'
Available
. .
....
Standby - Not
Ready
Active Standby Not
Available
Standby - Not
Ready
Engine
--
Active
Engine
Active
Engine
Legend:
When a failover occurs, the Standby AppEngine that becomes active will not report alarms
outstanding from the old Active AppEngine. The state of those old alarms, though, is reflected on
the new Active AppEngine as follows:
e
Out of alarm
Unacknowledged
r
Unacknowledged-Return to normal
Acknowledged-Return to normal
e
Acknowledged
Timestamps are also preserved for alarms, including when:
The alarm was acknowledged
e
e
History Generation
All active objects (AppEngine and hosted objects) report history data as they normally do in the
run-time environment.
Historical data is reported to the historian only from the Active AppEngine.
Loss of connectivity with the historian does not cause a failover. The Active AppEngine then goes
into store-forward mode and caches data every 30 seconds. Store-forward data (when the
historian is unavailable) is synchronized with the Standby AppEngine.
Wondenvare Training
Forced Failover
Failover can be forced to occur. Do this through the ForceFailoverCmd attribute of the AppEngine.
For instance, you can link multiple conditions in a script or use the Object Viewer utility to trigger a
forced failover.
Deployment
Primary and Backup AppEngines can be deployed together or individually. When they are
deployed together (no matter which object is actually selected for deployment), the Primary always
becomes the Active and the Backup becomes the Standby. When they are deployed individually,
the first one deployed becomes the Active.
Hosted ApplicationObjects are always deployed to the Active AppEngine. When deploying the first
of a redundantpair of AppEngines, you can cascade deploy all objects it hosts. This operation can
be paired with deploying both the Primary and Backup AppEngines at the same time.
Note: If you deploy the Backup AppEng~nef~rstand then deploy hosted objects to that
AppEng~ne,ensure that network communications to both target computers is good before
deDl0vinCl the Pr~mawADDEnaine. Otherwise, errors mav occur.
In the run-time environment, either the Primary or Backup AppEngine can become the Active or
Standby depending upon failure conditions on either computer.
Before deploying the Primary and Backup AppEngines, all configuration requirements must be
met. Each AppEngine must be assigned to a separate WinPlatform. A valid redundancy message
channel (RMC) must be configured for each WinPlatform. To deploy the Primary and Backup
together, select Include Redundant Partner in the Deploy dialog box. This option is not available
when doing the following operations:
Cascade deploy from the Galaxy
e
Multiple object selection deploy
e
Deployment of the WinPlatform that hosts the Primary or Backup AppEngine
sP
9-13
9-14
~.
-. ..
-. . --- .
Deploy Both Primary
, Cascade Deploy
I and Backup Objects
Allowed
. . -.,-.
.
,
. . .--.
Yes
Yes
... .. . , .
Condition
-.
..
..
Backup AppEngine's host Winplatform configured for
failover and deployed.
Backup AppEngine in error state.
... .-.
Yes
Yes
No
Yes
Yes
Yes
No
Yes
No
Yes
No
No
No
Yes
Yes
Yes
Yes
Yes
Undeploying redundancy pairs of AppEngines is similar to any regular object undeployment. The
Active and Backup AppEngines can b e undeployed separately. Also, they can be undeployed as a
pair by selecting one of the objects in an Application View, selecting the Undeploy command, and
selecting Include Redundant Partner in the Undeploy dialog box.
Note: Undeployrnent of any AutomationObjects, including redundant AppEngine pairs, does not
uninstall code modules for that object from the hosting computer. Code modules are uninstalled
onlv when the WinPlatform is undedoved.
Wondeware Training
>
If the RMC IP Address parameter is not configured in both hosting WinPlatforms, then the
configuration state of both Primary and Backup AppEngines changes to Error, with a
message indicating that the host WinPlatform is not configured with the network adapter
required for redundant communications. When the RMC IP Address is configured and the
WinPlatforms are checked in, the hosted AppEngines are automatically revalidated and
the Error state is resolved. If hosted AppEngines are checked out, they are not
revalidated.
If both Primary and Backup AppEngines are assigned to the same WinPlatform and an
attempt is made to deploy both engines, both the Primary and Backup will fail to deploy
with a message noting that the Primary and Backup objects must be hosted by different
WinPlatforms. Reassign the Backup object to another WinPlatform and deploy it
separately.
If both the Network Address and RMC IP Address parameters in the WinPlatform's
editor address the same network card, you will get a warning message when you save the
configuration. These two parameters must address different network cards.
9-15
9-16
Wondenvare Training
Objectives
Upon completion of this lab you should be able to:
Configure a second network connection in Windows as the redundant message channel
e
Configure the $Winplatform and $AppEngine object for redundancy
e
Create a deployment model for redundant engines
e
Force a failover on a redundant system
to ArchestrA
to RMC
2. Use the network connections Advanced Settings to make sure that the ArchestrA
connection is access before the RMC connection.
9-17
4. On the Advanced setting for TCPIIP, configure the RMC connection to @ Register this
connection's addresses in DNS.
6.
7. Create a new instance of the $ABPlatform template using the default name and assign it to
the ABControlSystem area.
8. Configure the ABPlatform-001 object with the name of the second computer and its own
RMC IP address for the Redundancy message channel IP address.
9.
Configure the ABAppEngine object for Redundancy and assign its backup to the
ABPlatform-001 object.
Test Redundancy
10. Deploy the galaxy.
11. Using the watch list created in Lab 5, add a new watch window called Redundancy and add
the following attribute references:
e
ABAppEngine.Host
Wondenvare Training
9-19
9-20
Wondenvare Training
3.
to ArchestrA
to RMC
ArchesbA
rnnnert;ri
9-21
9-22
and
Wonderware Training
Repir
Bridge Connections
Create s o r t a r t
Qd&
6. At the RMC Properties dialog box, on the General tab, select the Internet Protocol (TCPIIP)
item and click the Properties button.
9-23
9-24
Note: In this example the first computer will have an IP address of 192.168.1.1 and the
second one will have an IP address of 192.168.1.2. Both will be have a subnet mask of
255.255.255.0
Wondenvare Training
9.
Click the
Click the Close button to close the RMC Properties dialog box.
9-25
9-26
1
~ mo1
moo
iff
d4
13. Click the Save and Close button and check in the object.
Wondeware Training
Neh.iorkaddrerr:
1
0
802
Hlstoryrtorefonvard dlrebow
1024
-
Mlnlmvm R4M:
/ M E
rg
10000
stabrtlrsaveragepenod:
,.ne*"deacv
,@
192.168.1.2
moo1
/ 6
3WW
17. Click the Save and Close button and check in the object.
9-28
Forced hilovertimeout:
1 mr
j
O
EcIIIzl
q
q
q
]loooms
/
i$l
1 7 - 1
'33
ms
I$@
tp
(141007rnr
,@
p i o O l ms
'9
';3
Fmefailovci command:
20. Click the Save and Close button and check in the object
21. On the Deployment view, assign the automatically created ABAppEngine (Backup) object to
the ~ B ~ l a k o ; m - 0 0 1instance:
~l... ABGalaw
1'6
,,- ~.
.&Unassigned Host
@
. @
. ABGRPlaLform
ok @ ABAppEngine
h...@ AB
'..... 'W
Wonderware Training
Test Redundancy
22. Deploy the galaxy by right-clicking the name of the galaxy and selecting Deploy.
23. Open Object Viewer by right-clicking the ABAppEngine instance and selecting View i n
Object Viewer. If you closed Object Viewer before, you can use File I Load Watch List to
open the file you saved earlier.
24. Right-click in the Watch List (bottom section of Object Viewer) and select A d d Watch
Window to add a new tab to the watch list.
25. Right-click in the Watch List (bottom section of Object Viewer) and select Rename Tab ... to
rename the watch list to ~ e d i n d a n c ~ .
Host
9-30
You can use the Mixer watch window to verify that the objects are running properly
29. Failover the system doing any of the following on the second computer:
e
Unplug the power cable
Shut down Windows
e
Disconnect both network cables at the same time.
ABGWlatfoirn
ABAppEngine.Hosi
ABnppEngine.Redundanc/.Identib
Piirnary
ABA~~Enoine.Redunda~~~.Sbhls
Active -Standby not Available
~ ~ k p p ~ ~ i n e . ~ e d u n d a n & . ~ a r t n e r ~ l a t fABPlatfarrn-001
om
ABAppE~ine.Redundancy.PartnerStatus
Unknown
ABAppE~ine.RedundancycyFaiIoverOc~rred 6 l s e
ABAppE~ine.Redundancyc/ForceFailoverCrnd false
C0:Good
C0:Good
CO:Good
C0:Good
CO:Good
CO:Good
Ok
Ok
Ok
Ok
Ok
Ok
You can use the Mixer watch window to verify that the objects are running properly.
Wondeware Training
Section 2 - Dl Redundancy
Section 2 - Dl Redundancy
Section Objective
This section covers the concept of redundancy, how it can be configured and key points
to more effectively implement this feature.
Understand the concept and functionality of Redundant Dl Objects
This section provides an understanding of the concept of redundancy, how it can be configured
and key points to more effectively implement this feature. It also provides an understanding of the
concept and functionality of Redundant Dl Objects
Redundant Dl Objects
Application Engines can host Redundant Device Integration Objects (Dl Objects). The
RedundantDlObject monitors and controls the redundant DlObject data sources. Unlike redundant
AppEngines, individual DlObject data sources do not have redundancy-related states. For all
intents and purposes, they function as standalone objects.
Only one DlObject data source provides field device data through the RedundantDlObject at a
time. Both data sources must have commonly configured DAGroups which are reflected in and
channeled through the RedundantDlObject, which monitors the two DlObject data sources and
determines which one is Active at any given time. Both data sources must also have the same
item address space.
The Redundant Dl Object is a DlNetwork Object used to enable continuity of 110 information from
field devices. The Redundant Dl Object provides the ability to configure a single object with
connections to two different data sources. If the primary data source fails, the Redundant Dl
Object automatically switches to the backup data source for its information. There is a one-to-two
relationship between an instance of the Redundant Dl Object and the running instances of the
source Dl objects; that is, for each Redundant Dl Object, a pair of source Dl Objects is deployed.
9-31
9-32
Workstations
Redundant
Dl Object
Supervisory Network
u,
-7
pplicatibn Server
Configuration
Control Network
:
:
I
:
::
RedundantDlObjects
Configure redundancy in data acquisition objects in the ArchestrA IDE through their editors. Data
acquisition redundancy objects (two DlObjects and the RedundantDlObject) do not have
redundancy-related deployment statuses.
In data acquisition redundancy, you must configure all three components: a Primary DlObject data
source, a Backup one, and a Redundant DlObject.
Because data acquisition redundant components are essentially standalone objects, all valid
operations that apply to any other Applicationobjects apply to the three objects. All ArchestrA IDE
commands, Galaxy Dump and Load functions, and import and export operations are valid on the
t w o DlObject data sources and the RedundantDlObject.
The main focus of RedundantDIObject configuration is:
Setting the Primary Dl Source and Backup Dl Source on the General tab of the object's
editor.
Setting up the common scan groups, and block read and block write groups on the
respective tabs OF the object's editor.
Wonderware Training
Section 2 - Dl Redundancy
Note: You must configure at least one scan group before you can deploy the RedundantDlObject.
Also, only scan, block read, and block write groups shared by the Primary and Backup DlObjects
should be ~ 0 n f i ~ u r eindthe RedundantDlObiect.
Deployment
Deployment for data acquisition redundancy is the same as individually deploying unrelated
objects. No special conditions apply to each DlObject data source and the RedundantDlObject
9-34
Wondeware Training
Objectives
Upon completion of this lab you should be able to:
e
Configure and use the $RedundantDlOObject
e
Create a deployment model for redundant Dl object
0
Force a failover on a redundant Dl system
1. Create two new instances of the $ABAppEngine template, name them ABAppEngineDll
and ABAppEngineDI2 and assign them to the ABControlSystem area.
2. Host ABAppEngineDll on the ABGRPlatform platform and ABAppEngineD12 on
ABPlatform-001 platform.
3.
Rename the Incontrol instance as Dl01 and host it on the ABAppEngineDll engine.
4. Create a copy of the Dl01 object by repeating Lab 6 but naming the object D102. Assign the
new object to the ABControlSystem area and host it on the ABAppEngineDI2 engine.
5.
9-35
9-36
8.
Primary Dl source:
Dl01
Backup Dl source:
Dl02
On the Scan Group tab, copy the common scan groups and attributes from the primary or
backup Dl sources.
11. Using the watch list created in Lab 5, add a new watch window called RDlO and add the
following attribute references:
* InControl.DISourcePrimary
e
InControl.DISourceBackup
InControl.DISourceActive
e
InControl.DISourceStandby
e
InControl.StatusPrimaryDlSource
InControl.StatusBackupDlSource
.
e
e
InControl.ConnectionStatus
InControl.SwitchReason
InControl.ForceFailoverCmd
13. Force a failover in the system and monitor the objects using Object Viewer and the different
watch windows created during the class.
Wonderware Training
@-
I
3.
-I F - #
'..... FE)
ABAppEngine (Backup)
Undeploy the Incontrol instance, rename it Dl01 and host it on the ABAppEngineDll
engine.
9-37
9-38
4.
Use Lab 6 -Connecting t o the Field to create another device integration object, but name it
Dl02 instead of Incontrol. Assign it to the ABControlSystem area.
Note: You can export your object, rename the original, and then import the object to create a
copy of the object with all of the original object's configuration attributes.
5. In the Deployment view, host the Dl02 object on the ABAppEngineD12 engine
Wonderware Training
........... - ......
J? X
9-39
9-40
Dl01
Backup Dl source:
Dl02
~arkD
~I psource:
AS
0102
'B
10. Select the Scan Group tab and click on the Copy Common Scan Groups button.
On the Copy Common Scan Groups dialog box, click the OK button to accept tagname as
the scan group for the new Incontrol object.
Wondenvare Training
12. Click the Save and Close button and check in the object
9-42
-;-.-..a
I*"
-
UnassignedHost
6.Fiil
ABGRPlafform
Y
8...
ABAppEngine
. @
.
1 1.- & ABControl5ystm
61 ABDischarge
@ $1ABIntake
. Cfl. & ABLinel [ABLinel]
i: @: . & ABLine2 [ABLine2]
;
& ABProduction
I 6.;
'.....p
ABAppEngineDIl
i..... &
I,
I @ ABPlatform-001
17. Open Object Viewer by right-clicking the Incontrol instance and selecting View in Object
Viewer. If you closed Object Viewer before, you can use File / Load Watch List to open the
file you saved earlier.
18. Right-click in the Watch List (bottom section of Object Viewer) and select Add Watch
Window to add a new tab to the watch list.
19. Right-click in the Watch List (bottom section of Object Viewer) and select Rename Tab ... to
rename the watch list to RDIO.
Wondeware Training
Add the
DlSourcePrirnary
SwitchReason
ForceFailoverCrnd
InConbol.ConnecticnStab&
1nCmbol.SwitchReason
Connected
Unhown
device
- -
AttnbuteReference
InConb~l.DISwrcePT~mary
1nConbol DISwrceBadmc
1nConbol.DISwrceActive
1nCmbol.DISwrceStandby
~
~~
InCcnbol.StahizPTim~y0ISouice
1nConbol.Sta~sbckupDISource
1nConhol.ConnecbbnStatus
1nConbol.SwitchReason
1nC~bol.For~eFailo~mCmd
] value
DIOl
DIOZ
DIO2
DIOl
Connected
Connected
Connected
ForceFailover
fake
guality
C0:Good
C0:Good
C0:Good
C0:Good
C0:Good
C0:Good
C0:Good
C0:Good
C0:Good
1 stahis I
Ok
Ok
Ok
Ok
Ok
Ok
Ok
Ok
Ok
9-43
9-44
1nConbd.DISo~rceActive
1nConbol.DIsourceStandby
1nConbd.Stab~PrimaryDISource
InConbol.StamsBahpDISource
1nConbol.ConnectionStabs
1nConbol.SbMtciResron
1nConbd.ForceFailoverCmd
DI02
DIOl
Dl02
Connected
Unhown: C o r n Error p1Source not accessible)
Connected
Unlnobm: C o r n Enor (DISource not accessble)
ialse
C0:Mod
C0:Good
C0:Good
C0:Goad
C0:Good
C0:Mad
C0:Gwd
C0:Good
Ok
Ok
Ok
Ok
Ok
Ok
Ok
Ok
You can use the Mixer watch window to verify that the objects are running properly.
Wonderware Training
9-45
9-46
Coniabbs
Bwlstmp
Galaxy Reposjtory (GR)
COntSinf
Histarian
Present on
each machine
Standalone Configuralion
PLC
PLC
I
............
G<W3
GfH2
IhTolzh 10.0
InTw3,lO.O
GlNI
InTorsh 30.0
Galaxy R e p i l o t y
InTcuch
Wonderware Training
.-
9-47
9-48
Wonderware Training
Lab 20 - Conve
nvironment
introduction
This lab describes the steps necessary to convert to a Networked Configuration. In this lab you
team up with your classmates to create a galaxy that spans across multiple nodes. In the
networked environment a common Galaxy Repository is shared between a set of PCs allowing
multiple users to simultaneously work on the same application.
To speed up the process, templates you created in the class are re-used.
Since there can only be one Galaxy Repository per galaxy, your team needs to designate one of
the team members' computer to become the sole Galaxy Repository for the galaxy. This person1
computer is designated as the Galaxy Master. The Galaxy Master has specific extra steps to
perform.
Objectives
Upon completion of this lab you will be able to:
Configure a galaxy for a multi-node environment.
Preparation
Note: This section is to be performed by everyone except where noted.
1. Undeploy the galaxy.
2.
9-49
9-50
Module 9 - ~ulti-
ode A p p l i c a t i o n s
Create a N e w Galaxy
Note: This section is only to be performed by the Galaxy Master.
4.
Create an area instance named ControlSystem and assign the Incontrol object to it.
7. Create a platform instance named ABPlatform and assign it to the ControlSystem area.
8.
Create an engine instance named AppEngineDl and assign it to the ControlSystem area.
12. Create a user account that belongs to the Administrator role for each member of the team.
Setup t h e Platforms
Note: This section is not to be Derformed bv the Galaxv Master.
13. Use the ArchestrA IDE to connect to the MultiNodeGalaxy galaxy in the Galaxy Master's
computer using your designated user account.
15. Create a platiorm instance named ABPlatform and configure it with your local computer's
name. Assign it to the ControlSystem area.
.
16. Deploy the ABPlatform object on cascade.
Wonderware Training
18. Create an area instance named ABLine and host it on your ABAppEngine object.
19. Create an instance of your mixer template and name it properly with the valid 3-digit mixer ID
at the end (ABMixer-XXY) as identified in Lab 2. Host it on your ABLine area.
21. Use Object Viewer to verify that all objects are running properly and are getting data from the
field.
Note: Feel free to experiment and play around with the multi-node system to reinforce the
knowledge acquired during this class.
9-51
9-52
Wonderware Training
A-2
Wondenvare Training
Appendix A
Application
A collection of objects within a Galaxy Repository that performs an automation task. Synonymous
with Galaxy. There may be one or more applications within a Galaxy Repository.
Application Engine (AppEngine)
A scan-based engine that hosts and executes the runtime logic contained within
AutomationObjects.
Applicationobject
An AutornationObject that represents some element of your application. This may include things
such as (but not limited to) an automation process component (for instance, a thermocouple,
pump, motor, valve, reactor, or tank) or associated application component (for instance, function
block, PID loop, Sequential Function Chart, Ladder Logic program, batch phase, or SPC data
sheet).
Application Server
The supervisory control platform. Application Server uses existing Wondeware products such as
InTouch for visualization, the Wonderware Historian for data storage, and the device Integration
product line like a Data Access Server (DAServer) for device communications.
An Application Server can be distributed across multiple computers as part of a single Galaxy
Namespace.
Application Views
The Application Views pane displays the object-related contents of the Galaxy in different ways:
Model view, Deployment view, Derivation view and Operations view. The Model view is the default
display when the Integrated Development Environment (IDE) is first opened.
ArchestrA
The distributed architecture for supervisory control and manufacturing information systems. It is an
open and extensible technology based on a distributed, object-based design.
ArchestrA Object Toolkit
A programmer's tool used to create new ApplicationObjects and Device lntegration Object
Templates, including their configuration and run-time implementations. Includes a developer tool
used to build Dl Objects and create unique Domain Objects that interact with Dl Objects in the
ArchestrA environment.
Area
A logical grouping of AutomationObjects that represents an area or unit of a plant. It is used to
group related AutomationObjects for alarm, history, and security purposes. It is represented by an
Area AutomationObject.
Area Object
The System Object that represents an Area of your plant within a Galaxy. The Area Object acts as
an alarm concentrator, and is used to place other Automation Objects into proper context with
respect to the actual physical automation layout.
Assignment
The designation of a host for an AutomationObject. For example, an AppEngine AutomationObject
is assigned to a WinPlatform AutomationObject.
Attribute
An externally accessible data item of an AutornationObject
Attribute Reference String
A text string that references an attribute of an AutomationObject,
A-3
A-4
.-
Wondeware Training
A-5
A-6
Wondenvare Training
A-7
A-8
.-
Wondeware Training
Properties
Data common to all attributes of objects, such as name, value, quality, and data type.
Proxy Object
A Proxy Objects is an Automation Object that represents an actual product for the purpose of
device integration with the Wonderware Application Server or lnTouchG3 HMI. For example, there
is a Proxy Object that enables the Wondenvare Application Server to access an OPC server.
Redundancy
During Configuration
e
Primary object: The object intended as the main or central provider of the functionality in
the run-time. For AppEngines, it is the object you enable for redundancy. For data
acquisition, it is the DlObject you intend to use first as your data source in the run-time.
Backup object: The object that provides the functionality of the Primary object when it fails.
For AppEngines, it is the object created by the ArchestrA infrastructure when the Primary
object has been enabled for redundancy. For data acquisition, it is the DlObject you do not
intend to use first as your data source in the run-time.
During Run-Time
Active object: The object that is currently executing desired functions. For AppEngines, it
is the object that is hosting and executing ApplicationObjects. For data acquisition, it is the
object that is providing field device data through the RedundantDlObject.
e
Standby object: The passive object; that is, it is waiting for a failure in the Active object's
condition or for a force-failover. For AppEngines, it is the object that monitors the status of
the Active AppEngine. For data acquisition, it is the object that is not providing field device
data through the RedundantDlObject.
e
Redundant Dl Object
The RedundantDlObject monitors and controls the redundant DlObject data sources. Unlike
redundant AppEngines, individual DlObject data sources do not have redundancy-related states.
For all intents and purposes, they function as standalone objects.
Redundant Message Channel
The Redundant Message Channel (RMC) is a dedicated Ethernet connection which is required
between the platforms hosting redundant engines. The RMC is vital to keep both engines
synchronized with alarms, history, and checkpoint items from the engine that is in the Active Role.
Each engine also uses this Message Channel to provide its health and status information to the
other.
Reference
A string that refers to an object or to data within one of its attributes.
Relational Reference
A reference to an object's attributes that uses a keyword in place of an object's tagname. These
keywords allow a reference to be made by an object's relationship to the target attribute. Examples
of these keywords are "Me", "Myplatform", and "Mycontainer".
Remote Reference
The ability to redirect ArchestrA object references or references to remote InTouch tags. The new
script function used to redirect remote references at runtime is IOSetRemoteReferences.
.*
Runtime
The InTouchG3 (WindowViewerT") function that provides the viewing of data from the configuration
of the application in InTouch development (WindowMaker).
A-9
Wondenvare Training
iagrams
B-2
Appendix B
Wondeware Training
The Plant Model Planning Diagrams are displayed on the following pages.
B-4
W o n d e w r e Training
B-6
)
I
lh
ui
Wondeware Training
6-8
Appendix B
Wonderware Training