You are on page 1of 628
I) Ie COCSSETOVIOT~IaADg INVENSYS LEARNING SERVICES Training Manual Revision A, July 2013 Part Number 11-GM-10036 InTouch for System Platform 2012 R2 INFORMATION IN THIS DOCUMENT IS SUBJECT TO CHANGE WITHOUT NOTICE. © 2013 by Invensys Systems, Inc. All rights reserved. No part ofthis document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical. photocopying, recording or otherwise), or for any purpose, without the express written permission of Invensys Systems, Inc. Except where noted, the companies, organizations, products, domain names, e-mail addresses, logos, people, places and events depicted herein are fictitious and no association with any real company, ‘organization, product, domain name, e-mail address, logo, person, place or event is intended or should be inferred Invensys and the author(s) assume no responsiblity for erors or omissions and no liability is assumed for ‘damages resulting ftom the use ofthe information contained herein. Use ofthe Invensys software described in this document is subject to the terms ofthe applicable Invensys Systems, Inc. /Wonderware license. These terms include provisions that limit your rights such as use restrictions, disclaimers of warranties and imitations of Wonderware / Invensys liability. By installing or using the Invensys software, you agree to accept all ofthe terms ‘ofthe applicable Invensys Systems, Inc. ‘Wonderware license. A copy ofthe applicable license will be displayed upon initial installation ofthe software. fa copy ofthe license is not displayed or you require an additional copy of the license, you may obtain one from Invensys’ Wonderware business unit by caling 1.849.727.3200 or by sending an e-mail o support@wonderware. com. Invensys, Wonderware, ArchestrA, Facteligence, IntelaTrac, InBatch, InControl, IndustrialSQL Server, InSQL, InTouch, InTrack, Ql Analyst, SCADAlarm, SuiteLink, SuiteVoyager, WindowMlaker, WindowViewer are trademarks and registered trademarks of Invensys plc, its subsidiaries and affliated companies. All other brands ‘and product names may be the trademarks or service marks of their respective owners. Table of Contents Table of Contents Module 4 ~ Introduction... Section 1 ~ Course Introduction... Section 2— System Platform Review .. Lab 4 — Creating and Deploying a Galaxy. Section 3—ArchestrA Visualization Overview. Lab 2— Creating a New InTouch Application Section 4— System Requirements and Licensing, Module 2 - Application Design Basics.. Section 4 — Development Em nment and InTouch Windows Section 2 — ArchestrA Symbols Overview. Lab 3 Building the Application Layout.. Section 3 — Runtime Environment and Application Deployment.. Lab 4— Deploying an InTouch Application. Module 3 - ArchestrA Symbols Basics Section 1 —ArchestrA Objects and Symbols Section 2~ ArchestrA Symbol Edito Lab 5— Creating the Tank Symbol Section 3 — Basic Tools and Animations vn Section 4— ArchestrA Symbols in Contained Objects. Lab 6 Creating the Mixer Display. Section § ~ Basic Windows Controls Section 6 - The OwningObject Property. Lab 7— Switching Botwoon Mixers, Module 4 — ArchestrA Symbols Creation Section 4 ~ Tools and Animations. Lab 8 ~ Creating a Thermometei ‘Section 2~ Custom Properties .. Lab 8 — Adding Custom Properties to the Thermometer InTouch for System Platform 2012 R2 4 Module 5 — More on ArchestrA Symbols. Module 6 - Alarm Visualization. Module 7 — Trend Visualization. Module 8 - Security. InTouch for System Platform 2012 R2 ‘Section 3 ~ Scripts in ArchestrA Symbols.. Lab 10 ~ Creating a $DiscroteDevice Two-State Command. Lab 11 ~ Creating a Resizable Analog Meter. Lab 12 - Reusing the Resizable Analog Meter.. Section 4— Quality and Status Display... — Lab 13 ~ Adding Status Display tothe | Thermomet Section 1 - Show Symbol and Hide Symbol Animation: Lab 14 ~ Creating a Popup Symbol . Section 2— ShowGraphic Script Function Lab 15 — Creating a Multi-View Displa Section 3 Client Controls. Lab 16 ~ Creating a Document Viewer: Section 1 — ArchestrA Alarming Review. Section 2 - Live Alarms Visualization Lab 17-B Lab 18 ~ Creating a Live Popup Alarm Display. Section 3 - Logged Alarms Visualization .. Lab 19 Building a Historical Alarm Display 19 a Live Alarm Display ‘Section 1 ~ Historization Review .. Section 2 — Historian Client Trend Control. Lab 20 ~ Building a Historical Trend Display Section 3 ArchestrA Trend Client Control. Lab 21 - Creating a Live Popup Trend Display Section 4 — Security Overview Lab 22 ~ Using Security Features in Graphics. Section 2~ Signed Writes.. Lab 23 ~ Signing Writes from InTouc! Lab 24 ~ Signing Writes from Scripts. Tnvensys Leaming Services Appendix A — Runtime Language Switching Table of Contents Section 3— Signed Alarms Lab 25 - Signing Alarms with the Alarm Client Control Lab 26 - Signing Alarms Through Scripting ‘Section 4 ~ Customization of the Runtime Environment. Lab 27 — Locking Down Your Appli Section 1 — Runtime Language Switching Lab A-1 ~ Switching Languages During Runtim InTouch for System Platform 2012 R2 6 InTouch for System Platform 2012 R2 a Tnvensys Leaming Services invensss Learning Services Module 1 — Introduction Section 1 - Course Introduction Section 2 - System Platform Review Lab 1 - Creating and Deploying a Galaxy Section 3 - ArchestrA Visualization Overview Lab 2 - Creating a New InTouch Application Section 4 - System Requirements and Licensing 1-2 Module 1 — Introduction Invensys Leaming Services Section 1 - Course Introduction 1-3 Section 1 — Course Introduction This section identifies the objectives and agenda for the InTouch for System Platform Course. Course Description ‘The InTouch for System Platform 2012 R2 course is a §-day, instructor-led class designed to provide a fundamental understanding of the features and functionality of how the Wonderware Application Server provides visualization for your plant Galaxy data using ArchestrA Symbols by seamlessly integrating the InTouch for System Platform software. ‘This course illustrates the use of visualization tools in the Wonderware Application Server to provide a Human Machine Interface (HM) with connectivity to the Galaxy, graphic symbols, animations and scripting features, functionality found in InTouch WindowNlaker, ArchestrA Symbols, the ArchestrA, ‘Symbol Editor, and QuickScript NET. ‘The course uses lectures and hands-on labs to provide a fundamental understanding of how to apply alarm, trending, and history controls for visualization, and security for an InTouch application, Objectives Upon completion ofthis course, you willbe able to: + Create and deploy new Managed InTouch applications using the ArchestrA IDE © Create ArchestrA Symbols + Embed ArchestrA Symbo's in Automation Objects and reference attributes of an object + Use ArchestrA Symbols in a containment relationship + Work with the ArchestrA Alarm Client control for alarm visualization © Work with the ArchestrA Trend Client control for reabtime trending + Work with the Historian Client Trend control for historical trending ‘+ Apply ArchestrA security in a Managed InTouch application Audience = Application developers + Engineers + System Integrators ‘Other individuals who need to develop Galaxies for System Platform applications TnTouch for System Platform 2012 R2 14 Module 4 Introduction Prerequisites + Attendance of the Application Server course ‘© Attendance of the Historian Client course is recommended to obtain knowledge of the Historian Client Trend component ‘+ Manufacturing industry experience ‘= Some graphical design experience helpful Course Outline Module 4 — Introduction Section 1 - Course Introduction ‘This section identifies the objectives and agenda for the InTouch for System Platform Course Section 2 ~ System Platform Review This section provides an overview of the components of the Wonderware System Platform and the benefits of an integrated ArchestiA architectural environment, Section 3 — ArchestrA Visualization Overview This section provides a brief introduction to ArchestrA Graphics and the creation of a managed InTouch application, Section 4 ~ System Requirements and Licensing ‘This section provides a detailed explanation of the system requirements necessary for the Wonderware System Platform and the Licensing model. Module 2— Application Design Basics Section 1 — Development Environment and InTouch Windows ‘This section provides a brief overview of the features of the WindowNlaker environment and its settings, describes InTouch windows, and explains how to use the Show and Hide Window animations, ‘Section 2— ArchestrA Symbols Overview ‘This section provides an overview of ArchestrA symbols, the library where they are contained, and ‘explains on how to embed them into InTouch Windows. Section 3 — Runtime Environment and Application Deployment ‘This section provides a brief overview of the InTouch WindowViewer and the $ViewEngine, and describes some WindowViewer settings. Module 3 - ArchestrA Symbols Basics Section 1 — ArchestrA Objects and Symbols This section provides a brief overview of text tools and value display animations. ‘Section 2— ArchestrA Symbol Editor ‘This section covers the creation and manipulation of graphic objects, lines and outlines, text objects, images, and bitmaps using the ArchestrA Symbol Editor. Invensys Learning Sorvicos Section 1~- Course Introduction 1-5 Section 3 — Basic Tools and Animations ‘This section provides a brief overview of the text element, working with text, and basic animation, Section 4 — ArchestrA Symbols in Contained Objects This section provides a brief overview of how to use ArchestrA symbols in a contained object within a symbol in the container object. ‘Section 5 ~ Basic Windows Controls This section provides a brief overview of various controls used in basic window functions. ‘Section 6 ~ The OwningObject Property This section introduces advanced ArchestrA Symbol editing techniques. Module 4 ~ ArchestrA Symbols Creation Section 1 — Tools and Animations “This section provides a brief overview of the graphic tools in the ArchestrA Symbol Editor, Visualization animations, and Interaction animations, Section 2 - Custom Properties ‘This section provides a brief overview of Custom Properties in an ArchestrA Symbols and describes how to link Custom Properties to Extemal Sources. Section 3 — Scripts in ArchestrA Symbols ‘This section provides a brief overview of the scripting environment and explains the execution types: and triggers. Soction 4— Quality and Status Display ‘This section provides a brief overview of the Status element and its application in monitoring data status and quality in runtime, 2s well as the quality and status display overrides for the Galaxy. Module 5 ~ More on ArchestrA Symbols ‘Section 1 — Show Symbol and Hide Symbol Animations This section provides a brief overview of Show Symbol and Hide Symbol animation. Section 2 - ShowGraphic Script Function ‘This section provides a brief overview of the ShowGraphic Script Function Section 3— Client Controls This section provides a brief overview of NET controls and their use with ArchestrA Graphics, Module 6 — Alarm Visualization Section 1 — ArchostrA Alarming Review This section provides a brief review of the concept of alarms and events and how ArchestrA handles them, Section 2— Live Alarms Visualization ‘This section provides a brief overview of how to visualize live alarms by using the ArchestrA Alarm control available from within the ArchestrA Symbol Editor. “nTouch for System Platform 2072 RO 1-6 Module 4 — Introduction Section 3 Logged Alarms Visualization ‘This section provides a brief overview of how to visualize logged alarms by using the Alarm DB Logger in the alarm database. Module 7 — Trend Visualization Section 1 — Historization Review ‘This section provides a brief overview of the concepts of historization covered in the Wonderware System Platform — Application Server course. Section 2— Historian Client Trend Control This section provides a brief overview of the Historian Client NET controls available for use in ArchestrA Symbols. Section 3 ArchestrA Trend Client Control This section provides a brief overview of the ArchestrA Trend control available from within the ArchestrA Symbol Editor. ; Module 8 - Security Section 1 - Security Overview This section provides a brief review of ArchestrA Security, Authentication Modes, General and Operational permissions, Security classifications, the security audit tral, and InTouch security-related tags and script functions. Section 2 ~ Signed Writes This section provides a brief review of the SignedWriteQ) function, Section 3 ~ Signed Alarms ‘This section provides a brief review of Signed Alarms. Section 4 ~ Customi jon of the Runtime Environment ‘This section provides a brief review of the customization of the runtime environment to more fully secure and protect the application. Appendix A - Runtime Language Switching Section 4 - Runtime Language Switching This section provides a brief overview of how to configure multiple languages and how to switch between languages at Runtime. Invensys Learning Services| Section 1 -Course Introduction 1-7 Wonderware Software Solutions ‘Wonderware is the market leader in real-time operations management software, including Supervisory Human Machine Interface (HMI), GeoSCADA, Mobile Operations, Production Management, Manufacturing Execution System (MES), Performance Management, and Enterprise Manufacturing Inteligence (EMI) workflow. itis also the leader in integration with asset management, supply and demand chain, and Enterprise Resource Planning (ERP) applications. Wonderware is a brand offering of the Invensys Operations Management Division, ‘Wonderware software delivers significant cost reductions associated with designing, building, deploying, and maintaining secure and standardized applications for manufacturing and infrastructure operations, Wonderware solutions enable companies to synchronize their production and industrial operations with business objectives, obtaining the speed and flexibility to attain sustained profitability More than one-third of the world's plants and facilities run Wonderware software solutions in dozens of industries worldwide, such as: + Automotive ‘+ Chemical & Pharmaceutical + Consumer Packaged Goods + Discrete Manufacturing * Electrical Power + Faciities Management + Food & Beverage + Mining and Metals + Olland Gas + Process Manufacturing + Water and Wastewater Wonderware software solutions deliver manufacturing and operational performance improvements that help reduce the amount of project-specific work that is required to develop integrated information and automation applications across entire operational enterprises. Wonderware software solutions can be implemented in the context of existing systems, at a company’s own pace, and to the extent that the ‘company chooses. ‘These solutions leverage a powerful, layered software architecture that enables a variely of features and capabilities, such as visualization, optimization and control of plant floor data collection, data storage, and analysis. InTouch for System Platform 2012 R2 18 Module 4 Introduction ‘Wonderware offers the following software solutions: ‘© Manufacturing Execution Systems — Wonderware MES software helps customers track the transformation of products from raw materials through finished goods. The software gathers in- process data, such as yields, throughput, equipment efficiencies, material consumption, and product quality It also provides functionality, such as inventory management, work orderiBill of Material management, real-time reporting, and analysis, for a full view into operational efficiencies Leveraging the ArchestrA software architecture (see page 1-4), Wonderware MES solutions are completely scalable and configurable. This enables a unique, incremental approach to operational improvements, where low-risk deployment of increased application functionality can be realized one step atatime Wonderware MES solutions help to substantially reduce lead time and manufacturing costs, increase production throughput and product quality, and reduce efforts involved in compliance and governance + Enterprise Manufacturing Intelligence — EMI software solutions empower companies to analyze their overall operational Key Performance Indicators (KPIs), using simple, yet powerful, data analysis, reporting, and visualization tools KPIs such as production, costs, process capability, equipment downtime, and quality and variance data can be collected, aggregated, and displayed using Wonderware EM| software solutions. A powerful, yet secure, web interface, with intuitive, dril-down dashboards, helps deliver this information to the full range of plant workers, talored to their specific information requirements, '* HMU/Supervisory Control and Data Acquisition (SCADA) ~ HMIISCADA solutions often impose complex demands on software architecture. Wonderware InTouch HMI visualization software, coupled with the award-winning ArchestrA technology-based Wonderware System Platform, is uniquely positioned to meet these challenges ‘The HMI/SCADA sofware solutions are easy to use, implement. and configure, and offer simplified maintenance, high security and availabilty, and virtually unlimited scalability + Data Historian — Wonderware Historian Server software leverages the state-of-the-art Wonderware System Platform, industry-leading historian technology, web-based reporting capabilities, and renowned open data source connectivity from Wonderware. The resulting Historian solution is unlike any other data archiving and reporting solution found in the market, today. With blazing speed, broad scalability, highly efficent data storage and retrieval, high availabilty, and simple one-click historization setup, the Wonderware Historian Server software has an industry reputation for low total cost of ownership reconfigured web-based reports and data analysis capabilities derive immediate value from data captured by the Wonderware Historian Server + Batch Management - Wonderware batch management solutions perform repeatable and consistent execution of batching processes across all hybrid industries, whether itis Electronic Batch Records (EBR) systems in regulated industries, Paper-On-Glass capabilities in paperless production environments, or automated recipe management for supervisory systems From simple batch processes, where only the formula changes for different products, to the most complex batch processes requiring dynamic allocation of shared equipment, Wonderware has a solution. Each of these solutions ensures reduced lifecycle costs and investment protection by leveraging the ArchestrA, architecture + Product Quality Management and Statistical Process Control (SPC) ~ Delivering products with high “quality’—defined as “meeting specifications at the lowest possible cost'—is a top priorty for manufacturers and industrial operations. Quality has many aspects, and Wonderware applications provide valued, integrated Quality Management functionality to tens of thousands of companies worldwide Tivensys Learning Services Section 1-Course Introduction 1-9 —. _Srtion 1 — Course introduction ‘Starting with Wonderware MES, which provides the most sophisticated, integrated quelity management ‘and enterprise-wide SPC, to Historian Server, which provides incremental solutions to store volumes of process data for quality analysis, Wonderware applications consistently meet quality needs. The Wonderware InTouch HMI software offers real-time data monitoring and alarming. Historian Client trends data, MES/Operations and MES/ Performance software provides specification management, genealogy, BOM enforcement, OEE, and downtime monitoring. System Platform monitors data levels, and pplication templates can deliver nearly any quality capability. InBatch software collects information on batch quality and recipe settings. The capability list goes on ‘+ Mobile Solutions — Wonderware Mobile Solutions enable manufacturers and producers to manage the processes and procedures used to ensure all field tasks required to achieve reliable operations are executed consistently Software running on rugged handheld computers enables field operators to collect data on non- instrumented machinery and to receive contextual information and guidance based on conditions encountered in the field. This helps ensure the consistent exacution of best operating practices Collected data can also be used for process analysis and production reporting, as well as integrated into existing back-end systems and plant data historians + Workflow — Workflow solutions allow customers to take thelr standard operating procedures, in- house knowledge base, and standard practices and make them part of everyday operations. Workfiow can overlay any Wonderware product to provide visiblliy, collaboration, enforcement of procedures, and documentation of results For more information on Wonderware software solutions and products, visit the Wonderware website at hito:/www.wonderware.com, ArchestrA Technology ‘ArchestrA is a comprehensive automation and information software architecture designed to integrate land extend the life of legacy systems by leveraging the letest, open industry standards and software technologies. It also unifies the Invensys Operations Management products that make up the InFusion ECS. ArchestrA “industrializes’ Microsoft LNET and other Microsoft technologies to provide an even more productive toolset for building critical operations management software solutions for manufacturing, production, and facilites operations. The result exposes services needed by manufacturing and industrial infrastructure, such as common name space, object management. industrial security, high availablity and redundancy, plant connection, enterprise connection, client interface, web portal, and systems management. Using ArchestrA technology, applications can be rapidly assembled using software objects rather than being "programmed." Templates can be created for almost any purpose, and then used to build new applications, simply through reassembly and slight modifications, saving time and lowering development costs. Offerings built on ArchestrA empower decision makers to achieve their business goals without abandoning prior investments in systems or intellectual property. ArchestrA technology helps reduce application engineering effort and deployment, increase efficiency, provide optimization and standardization, and enable integration of distributed automation systems and applications from virtually any vendor. Geographically dispersed applications (from a few hundred to one million V/O, and from a single node to hundreds of stations) can be rapidly and securely implemented ‘The ArchestrA architecture leverages advanced software technologies to fil the gap between ERP ‘systems and control systems. This architecture provides the following, * Framework, which supports common services and a core set of eystem objects + Domain Objects, which are industry-speciic objects + Object Development Toolkit, which enables third parties to create new domain objects customized for specific needs InTouch for System Platform 2012 R2 1-40 Module 4 ~ Introduction The supervisory control and manufacturing information environment is served by a variety of systems, including HII, Distributed Control Systems (DCS), SCADA, Process Information Management systems (PIM), MES, batch and recipe management systems, and advanced control/simulation systems. The ArchestrA Framework supports core services that are required by most of these different types of supervisory control and manufacturing information systems. ‘These core services include the following Integrated Development Environment (IDE) Version management License management and centralized deployment ‘System diagnostics and system administration Internationalization Data visualization and monitoring Event-based processing, scripting, and calculation capabilities Alarm and event management, historization, and security Data acquisition and field device integration Inter-object communications and name service Reporting and ad-hoc query capability Support for industry standards, such as OPC and SQL ‘The ArchestrA architecture consists ofthe following: Configuration and Deployment-Related Components that are required for centralized deployment of the runtime components. These components are installed like any Windows. application and include the folowing: © Centralized object repository (called Galaxy Repository) © Integrated Development Environment (IDE) © Object deployment services (called Bootstrap) Runtime Components that are centrally deployed and administered. These components include the following: ‘9 PCs with core infrastructure (called Platforms) Key software applications (Engines) © Objects (Framework Objects) that expose framework-related functionality Wonderware Individual Software Products Wonderware software solutions offer robust, best-of-breed software components that empower customers 1 effectively develop and manage their automation and information applications in continuous, discrete, process, hybrid, and batch manufacturing environments. All the latest Wonderware software offerings leverage the latest ArchestrA technology and offer increased functionality and flexibility, as well as extensive connectivity Tnvensys Learning Services Section 4—Course Introduction 1-11 Wonderware System Platform Wonderware System Platform provides a single and scalable platform for al the SCADA, Supervisory HMI, MES, and EMI software-solutions needs of industrial automation and information personnel, At the center of the Wonderware System Platform is the ‘plant model,” which is the logical representation Of the physical processes being controlled and supervised. ArchestrA object technology makes configuration, logging, delivery, and maintenance of real-time and historical information point-and-click simple. Within the System Platform is @ high-performance process historian with production history archiving, efficient data compression, and auto-configuration of historical archiving that eliminates duplicate effort. ‘The platform also contains an industrial web information server that dramatically simplifies the organization and delivery of operations information for use across all functions in an organization Wonderware InTouch HMI InTouch software provides graphic visualization that takes operations management, control, and ‘optimization to a completely new level. The InTouch HMI reputation stands above all the rest. What the industry now knows as HMI all began with InTouch software more than 20 years ago. No other HMI can ‘match InTouch software for industry-leading innovation, architectural integrity, unequaled device integration and connectivity, uninterrupted software version migration path, and truly legendary ease of use. All this leads to well-designed standards-criven systems that maximize productivity, optimize user ‘effectiveness, increase quaity, and lower development, maintenance, and operational costs, helping to make a company the best it can be. Wonderware Development Studio Wonderware Development Studio consists of a suite of cooperative tools designed to enable the rapid construction and maintenance of Wonderware applications. ‘The heart of the Development Studio is the IDE. Within the IDE, engineers can design, develop, test, maintain any industrial application. Without leaving the IDE, the user can develop vibrant and sophisticated graphics, and incorporate those into effective HMI, SCADA, MES, or Operations Inteligence applications Once development is ready for delivery, a single click is all it takes to deploy applications, objects, and associated logic to anywhere inthe enterprise namespace. ArchestrA Workflow Software ArchestrA Workflow software is an advanced workflow application that enables companies to digitize ‘manual and automated processes that include people or systems, or both. This sophisticated Business Process Management (BPM) application enables companies to model, execute, analyze, and improve processes inside and outside their organization to drive higher levels of collaboration, productivity, and innovation, With ArchestrA Workflow, companies can institutionalize work processes that manage normal Unscheduled, or disruptive events within their operations environment, providing the Right People with the Right Information at the Right Time. Wonderware HMI Reports ‘Wonderware HMll Reports provide the most intuitive and easy-to-use reporting solution available on the ‘market today, giving the power to quickly and easily create reports from Wonderware InTouch HM and many other data sources. It requires no IT or programming skills to design, schedule, and produce ‘appealing and informative dynamic reports. Itis easy to configure HM Reports through simple drag-and- ) "4aaa23 23°23 Section 3~ ArchestrA Visualization Overview 1-33 Section 3 — ArchestrA Visualization Overview ‘This section provides a brief introduction fo Archestr Graphics and the creation of a managed InTouch application, Introduction InTouch provides the tools to develop interactive and animated graphical displays ~ InTauch applications, ‘The behavior of those displays, including the animation and visual representations, can be associated with properties of industrial processes and equipment through real-ime data provided by the Wonderware System Platform. InTouch provides multiple user interface capabilies including keyboard, mouse, tablet ‘and touch screen inputs, 2s well as multiscreen outputs, InTouch offers a host of capabilities that provide value for Engineering, Operations, and IT departments, ArchestrA Graphics ArchestrA Graphics are developed through the Archesir/ IDE and allow customization of graphical representations of the processes in virtually any permutation desired. ArchestrA Graphics are embedded within Application Server objects, so everything about a given object is defined within it: alarms, history, logic, graphics, and so on, allowing greater flexibilty This allows: ‘+ The reuse of objects, Objects can be derived from templates and preconfigured to work within the ‘environment they are embedded in, to reference the desired object attributes + Centralized development of equipment including graphical representation What Is InTouch for System Platform? InTouch for System Platform is configured and licensed to be used as a visualization client in conjunction with the Wonderware System Piatform, displaying data from objects defined in a Wonderware Application Server Galaxy, What Is a Managed InTouch Application? ‘A managed InTouch Application is one that is created from within the ArchestrA IDE, and deployed as an object in the Wonderware Application Server application. Creating a managed Application allows use of ‘ArchestrA Symbols. A managed InTouch Application exhibits the same kind of behavior as other objects in the IDE, such as the ability to check out and check in, but opens in an external development environment called WindowMaker. ‘nTouch for System Platform 2012 R2 Module 4 - Introduction InTouch Components InTouch consists of three main components: * WindowMaker: The InTouch development environment, where object-oriented graphics are used to create animated, click-sensitive display windows. ArchestrA graphics are embedded in InTouch windows. + WindowViewer: The Runtime environment used to display the graphic windows created in WindowMaker. * Application Manager: Organizes the applications that are created. InTouchViewApp Object ‘The InTouchViewApp object represents an InTouch application in the Wonderware Application Server environment. The inTouchViewApp object manages the check-in, check-out, and deployment of an InTouch application, ‘The InTouchViewApp object includes the capabilities of the Application Server InTouchProxy object, so that InTouch tags can be referenced by Application Server Message Exchange clients as InTouchViewApp attributes The InTouchViewApp objects used to incorporate InTouch applications into an overall system defined by 2 Wonderware Application Server Galaxy. The Application Server system manages: ‘+ Checkin and check-out for multiple users + Security restrictions on who can deploy the InTouch application and when the InTouch application can be deployed + Backup and restore + Deployment and undeployment ‘The InTouchViewApp object allows application objects running on a ViewEngine object to access InTouch tags as ifthey were Application Server attributes of the InTouchViewApp object itself. The tags are browsed through the standard Application Server attribute browser. Create an InTouch application by deriving an InTouchViewApp abjact from the standard template SinTouchViewApp. Creation includes the choice of starting a new application, or creating a copy of an existing application, Either way, opening an InTouchViewApp object launches WindowMaker. There is no Object editor for the InTouchViewApp object. In Special | Configure | WindowViewer, the Managed tab contains settings similar to the InTouch Network Application Development (NAD) feature that can be configured to change the deployment behavior. Assign multiple [nTouchViewApp objects to the same ViewEngine object to make multiple InTouch applications available on a node. Tvensys Learning Services Section 3 ArchestrA Visualization Overview 1-35 To run an InTouch application on an Application Server platform: Create and assign a ViewEngine object to a platform, Create an instance of the InTouchViewApp object from the template that defines the InTouch application. ‘Assign the InTouchViewApp object to the ViewEngine object Deploy the ViewEingine object and the InTouchViewApp objects assigned to the ViewEngine object Run the InTouch Application Manager to select the application and run WindowViewer. This only needs to be done the first time. InTouchViewApp Object Rules ‘Some key aspects of an InTouchViewApp object include: InTouchViewApp instances cannet be created from the InTouchViewApp base template, Only one level of InTouchViewApp template can be derived from the base InTouchViewApp template. ‘An instance of the InTouchViewApp cannot be derived from an existing instance of the InTouchViewApp. InTouchViewApp objects cannot host other objects. Only ViewEngine objects can host and deploy InTouchViewApp objects. In the Model view, an InTouchViewApp object can be assigned to an Area object if the InTouchViewApp object's alarms should to belong to that area, Undeployment of an InTouchViewApp object is not permitted if itis currently loaded on a target node. When the file copying process at the end of an InTouchViewApp object deployment is stil Underway, the only allowable operation is to undeploy the object. This will cancel the deployment and remove any partially copied files. Existing InTouch Applications When creating an InTouchViewApp object to handle an existing InTouch application, the InTouch application files are transferred to a file repository directory. The original InTouch application files are not modified or deleted. Do not access files in the file repository directly or make assumptions about the file repository structure, ‘When making changes to the InTouchViewApp InTouch application using WindawMaker launched from the IDE, the original InTouch application is not changed. Once the InTouchViewApp object is created, deleting the original InTouch application does not affect the InTouchViewApp object's application. I an InTouchViewApp object that represents an existing InTouch application is deleted, the application files are removed from the file repository directory, but the existing application is not affected. TnTouch for System Platform 2012 R2 Module 4 ~ Introduction New InTouch Applications When creating an InTouchViewApp object for a new InTouch application, WindowMaker is started by the IDE. Create the application the same way as if WindowMaker had been started from the InTouch application manager. ViewEngine Object ‘A Viewngine object is a simplified version of an AppEngine object. A ViewEngine object hosts only InTouchViewApp objects. The ViewEngine object supports common engine features such as deployment, undeployment, startup, and shutdown. The ViewEngine does not support redundancy, One ViewEngine object can handle several InTouchViewApp objects. The ViewEngine object ‘+ Is assigned to and deployed to a WinPlatform object. ‘+ Hosts and executes InTouchViewApp objects. The scan rate of the ViewEngine object determines the scan rate of allits hosted InTouchViewApp objects. + Contains the logic to set up and initialize InTouchViewApp objects when they are initially deployed and started, so that they can communicate with other objects within the Galaxy, + Does not need to be running in order for WindowViewer to execute its scripts or access process data, ‘= Can host Application Server scripts and UDAs. These continue to run when WindowViewer is shut down, ‘© Provides a set of configuration and run-time attributes. ‘+ Contains its own set of runtime diagnostic attributes that can be monitored, alarmed, and historized, * Can include the Wonderware Historian as part of the ViewEngine object configuration. All InTouchViewApp objects that the ViewEngine object hosts use this historian, + Does not support redundancy. Because a ViewEngine object only hosts a few InTouchViewApp objects, InTouchViewApp objects only serve as a proxy for InTouch tags, Historization and alarm options of the ViewEngine object may not need to be used. When referencing tags as InTouchViewApp attributes, a shorter ScanPeriod on the ViewEngine object ‘can minimize the latency of tag value updates. Tnvensys Learning Services ms Lab 2—Creating a New InTouch Application 1-37 Lab 2 - Creating a New InTouch Application Introduction In this lab, you will complete the steps necessary to create a simple managed InTouch application for your Galaxy using the SinTouchViewApp object. This application will be used throughout the rest of the labs in this course, Objectives Upon completion ofthis fab, you vl be able to + Cfaate a new managed InTouch applcaton InTouch for System Platform 2012 R2 1-38 Module 4 — Introduction Create a New Managed InTouch Application In the following steps, you will create a Managed InTouch Application. 4. Inthe ArchestrA IDE Template Toolbox, expand the TrainingGalaxy / System template toolset. 2. Right-click the $InTouchViewApp template and select New | Derived Template, 3, Rename the new template $MixerView. Invensys Learning Services| = Lab 2~ Creating a New InTouch Application 1-39. 4. Assign the S| ixerView template to the Training/Working template toolset. ‘Template toolbox 5g Trsrinlony (SyAepleaton (B Gpoewe negation © sen @ teorerane Bis Ee fistoucvenagy [5 Mievenano swt => yang + Gite = Ee Wong © @ Wer ® ‘ota @ Stank @ five 5. Double-click $MixerViow. 6. Retain the default: Create new InTouch application, eae slat the sure ofthe szzoatedInouch ppescn 6 caster Intouch appeaten © Inport exsting InTouch option 7. lick Next. rs TnTouch for System Platform 2012 R2 Module 1 — Introduction 8. Retain the default Application nam¢ 9. Check the InTouchView application check box. 10. Enter the following Description: InTouchView application for the InTouch for System Platform course. -ppkcaton name: i i techn appleation Deseret: eee The nfo for Span Paterm cous a 11, Click Noxt. InTouch WindowMaker displays. It will be described in detail later. Tnvensys Leaming Services, DD. 9 OLD ) De PD S1es' 5 Section 4— System Requirements and Licensing 1-41 Section 4 — System Requirements and Licensing System Requirements for Wonderware Application Server/Galaxy Repository a Minimum Hardware Requirements. ‘The following list shows the minimum computer hardware requirements to host Application Server 2012 ‘components, For Application Server Galaxy Repository or ArchestrA System Platform 2012 Combination of Products: iinTouch for System Platform 2012 R2 1-42 Introduct Windows 7 and Windows Server 2008 R2 operating systems and SQL Server 2008 impose hardware requirements that may exceed the minimum requirements for Wonderware Application Server 2012. If You intend to install Wonderware Application Server 2012 on a computer running Windows 7, Windows Server 2008, or SQL Server 2008, also see the Microsoft Web site for further hardware requirements. Software Requirements This section describes the operating system, database, and other software requirements to install Application Server 2012 + Operating Systems + SQL Sorvor Database Requirements + Other Software Requirements Operating Systems ‘+ The recommended operating system for a Galaxy Repository is Windows 2008 R2 SP1 ‘+ The recommended operating system for development (IDE) or run-time nodes (Bootstrap) is Windows 7 SP1 ‘+The recommended operating system for computers running server components is Windows Server 2008 R2. ‘©The recommended operating system for computers running client components is Windows 7, 64- bit. The following table lists the supported operating systems that can be installed on computers running as Wonderware Application Server development, application, and GR nodes. Development and application nodes are considered to be clients of the server GR node. Wonderware Application Server Components Invensys Learning Services| Section 4 System Requirements and Licensing 1-43 Operating System Notes ‘The computer designated as the Galaxy Repository node can run on Windows XP Pro only as a single- ode configuration of Wonderware Application Server. Windows Server 2008 R2 is the recommended operating system for the GR node. ‘The Bootstrap, IDE, and Galaxy Repository are supported by the following language versions of Microsoft operating systems: English, Japanese, Simplified Chinese, German, and French. The Galaxy Repository is also supported by the English, Japanese, Simplified Chinese, German, and French versions of Microsoft SQL Server 2005 and SQL Server 2008 SP1. ‘Support for Windows Operating System User Access Control Application Server versions 3.1, 3.1 SP1, 3.1 SP2, 3.1 SP2 Patch 01, 3.1 SP3, 3.2, and 3.5 (2012) ‘support User Access Control enabled runtime operations without elevated privileges. For all configuration and installation operations, including those called during runtime operations, User ‘Access Control (UAC) must be disabled or privileges must be elevated to the required level Itis highly recommended to check wnw.wonderware,com for the latest supported operating systems. DDE Support In Windows Vista, Windows Server 2008 and later operating eystems, DDE is supported only on a local node. Windows Server 2008, as with Windows Vista, does not support NetDDE. ArchestrA Symbols use the client layer when accessing InTouch tags and appear as a third-party client trying to access WindowViewer as a data server. Therefore the use of NetDDE for communication is not supported and not recommended. In ArchestrA Symbols, InTouch: is stil @ valid method of referring to an InTouch tag on a local node. SQL Server Database Requirements Microsoft SQL Server 2008 SP1 is supported by Wonderware Application Server 2012. You must use the Standard SQL Server 2008 SP1 ‘SQL Server 2008 SP1 must be installed on the computer designated as the ArchestrA Galaxy Repository node prior to installing Wonderware Application Server Galaxy Repository feature | multiple versions of SQL Server are installed, the one utilized as the Galaxy Repository must be the default instance. ‘The Galaxy Repository locks the SQL Server maximum memory usage to 65% of the computer's physical ‘memory, ‘TCPIIP must be enabled on the computer hosting a SQL Server 2008 database. The TCPIIP protocol ‘setting can be verified from the SQL Server Network Configuration under SQL Server Configuration Manager. In order to use the Alarm DB Logger with SQL. Server Express, you need to change the default authentication mode from Windows-based to Mixed Mode. InTouch for System Platform 2072 R2 144 Module 4 — Introduction Other Software Requirements ‘The other third-party software required for Wonderware Application Server version 3.5 is Microsoft NET Framework 3.5 SP1. This must be installed on every computer that hosts a Wonderware Application Server component. The GR node will require .NET Framework 3.5 SPY if its being installed with SQL ‘Server 2008 as .NET Framework 3.5 SP1 is a SQL Server 2008 prerequisite. Wonderware Application ‘Server 3.5 has been validated with NET Framework 3.5 SP1. Wonderware System Platform Licensing Licensing To calculate the licenses needed to implement an application based on the Wonderware System Platform, itis necessary to gather the following information: Application Server 10 Count Number of VO points accessed by the Galaxy ‘Application Server Platform Count Number of dedicated Application Object Server nodes in the ‘application Historian Server Count Number of Historian Server nodes in the application rhumer ofneces that are going to access the servers ‘remotely ‘Device integration Server Count Number of Deviee integration Server nodes in ihe application Number of visualization 1 Nu dedicate Historian Client nodes in the appiication| Number of development workstations in the application | Information Server and Glens Count Number of information Server nodes inthe application ané_| | = ‘The Wonderware System Platform is licensed as a single product that includes the following individual features: ‘+ 1 Application Server license sized by IfO-count ‘+1 Historian Server Standard Editon license sized by Tag-count ‘+1 Information Server license ‘+ 1 Information Server Advanced Client license ‘+ 1 Device Integration Server license ‘+n Application Server Platform licenses (where n is 2, 3 or 4) for the purpose of hosting © An Application Object Server © The Historian Server ‘The Device Integration Server ‘The Information Server Note: An Application Server Platform for a dedicated Galaxy Repository node is not included, ‘The Wonderware System Platform license is available indifferent sizes, each one offered as a unique combination of the following, + Application Server 1O-count + Historian Server Tag-count ‘+ The number of Application Server Platforms included Tnvensys Learning Services Section 4 System Requirements and Licensing 1-45, Wonderware System Platform Options licenses, listed below, are added to this license as needed, depending on the size of the system and requirements: ‘+ Additional Historian Servers with Platform available at different Tag-counts, ‘+ Additional information Servers with Platform ‘+ Additional Device Integration Servers ‘+ Additional Application Server Platforms Wonderware Clients In addition to the Wonderware System Platform, one or more of the following Wonderware Clients are usually required: * InTouch for System Platform (also available as Terminal Services Edition if needed) + Information Server Client * Historian Client ‘The InTouch for System Platform license includes an Application Server Platform and is available in different flavors, as follows: ‘= InTouch for System Platform with Trend/Analysis* ‘* InTouch for System Platform without Trena/Analysis" InTouch for System Platform Read-only with Trend/Analysis* * Trend/Analysis refers to a Historian Client license. ‘The Information Server Client license is available in two different versions: ‘© Information Server Advanced Client ‘+ Information Server Standard Client; which lacks InTouch Write Back and InBatch ‘The Historian Client license supports Terminal Services Server applications (except with a Per Device license), Wonderware Development Studio ‘To develop applications for the Wonderware Systom Platform one or more Wonderware Development ‘Studio licenses are required. The Wonderware Development Studio license includes a single-node license to run the following products: ArchestrA Integrated Development Environment (IDE) ‘= Application Server sized by 1/0 count ‘+ Application Server Platform for testing System Platform-based applications ‘+ InTouch Development and Runtime ‘= Device Integration Products ‘Historian Server Standard Edition limited to 24 hour data retrieval and sized by Tag-count Microsoft SQL Server ‘An Unlimited version of the Wonderware Development Studio license includes all the above products, plus: ‘= Information Server ‘© Information Server Client ‘© Historian Client InTouch for System Platiorm 2012 R2 1-46 introduction ‘The Wonderware Development Studio license is available in different sizes, each one offering a unique ‘combination of: * Application Server l/0-count * InTouch Tag-count ‘+ Historian Server Tag-count Tivensys Learning Services invensys ning Services e Module 2 — Application Design Basics Section 1 — Development Environment and InTouch Windows Section 2— ArchestrA Symbols Overview Lab 3 - Building the Application Layout Se ~ Lab 4 — Deploying an InTouch Application n 3 — Runtime Environment and Application Deployment 2:2 _Module 2 - Application Design Basics Tinvensys Learning Services Section 4 — Development Environment and InTouch Windows 2-3 Section 1 — Development Environment and InTouch Windows This section provides a brief overview of the features of the WindowMaker environment and its settings, describes InTouch windows, and explains how to use the Show and Hide Window animations. ‘The WindowMaker Interface ‘The WindowMaker user interface (Ul) adheres to Windows XP standards. WindowMaker supports features including, but not limited to, such features as right-click mouse support, floating and docking toolbars, pull-down menus, and contex!-sensitive help. Right-click menus provide quick access 10 frequently used commands and a customizable color palette that provides 16.7 milion color support, Which is limited only by the video display. ‘The WindowMaker development environment is configurable. When Windowlaker is intially opened, most of the available elements are automatically displayed including all toolbars, the Application Explorer, and the status bar. Show or hide any or all of these elements. Move the toolbars and the Application Explorer to any location within the WindowMaker window. The optional ruler can be displayed and the visible grid turned on and off. The following figure shows the elements of the WindowMaker development environment using the Conveyor Window in the ReactorDemo application that comes with Application Server. When creating a ‘new application and running WindowMaker forthe first time, its program elements will automatically appear in the default configuration as shown. The main parts ofthe development environment Fast switch button that opens WindowViewer (intouch runtime) Toolbars Project view, which shows the windows and scripts arranged ina project format Classic view, which shows the windows, and scripts Development area, where windows are developed Status bar ‘The Windowlaker Application Explorer Classic and Project views provide a hierarchical araphical view of the windows and items configured in the application. The view also provides easy access to items in the ‘application and many of WindowMaker's most commonly used commands and functions. TnTouch for System Platform 2012 R2 24 Module 2 - Application Design Basics ‘Additionally, the Tools pane of the Application Explorer displays all installed add-on programs, such as ‘SQL Access Manager, SPCPro, and Recipe Manager. Italso provides a customizable application launcher. Windows and other InTouch elements can be created and configured from the Application Explorer. ‘Access to the InTouch managed application fles is available through File | Open Application Folder. ‘Add additional files to the managed InTouch application here so they are deployed and available at runtime. Files such as sounds, libraries, pictures, databases, and documents, which are referenced by the InTouch application or need to be available to the remote user, can be placed here. AMTRAININGPCReactorDemo-SaaReactorDemo fe Ett Yow Fates Teo Heb ® F Psewch Wp Faldes (Ss 2 x) Aides [2 WRamiercResobeetestestoere Eo Sze Type Date Modi Attra 4 File Folder '5/1992008 10:13 aM File Folder '5/14(2009 10}22 AM eK Fle 7/81/2007 956 aM DCH Fle 127/208 9:26 FM aK Fle 7/25/2007 5:55 4M DCHFile 1127/2009 9:26 FM, aK Fe ‘7isojzea7 11:13.m KSC Fle 2127/2008 9:26 FM aK Fle 6(282007 7:04 PM crGFile 1/27/2009 9:25 eM YER Fle 1/27/2009 9:25 EM LoK Fle ‘54/2008 10:22 AM Configure the Tools pane of the Application Explorer to launch a Windows program. This powerful feature quickly switches between the HMI configuration, JO Server configuration, and other control, configurations, ‘Warning: Do net add WindowViewer (view.exe) to the Application Explorer. The proper way to launch Window/Viewer is by executing the WindowViewer command on the File menu, or by clicking the Runtime fast switch in the WindowMaker menu bar. Invensys Learning Services ‘Section 4 — Development Environment and InTouch Windows WindowMaker Toolbars ‘The buttons on the WindowNlaker toolbars are grouped by common functionality. For example, the Arrange toolbar contains tools that for quickly applying most of the commands found on the Arrange menu, When hovering the cursor over a button, a Tool Tip appears displaying the tool name: General Toolbar ‘The General toolbar consists of buttons that execute most of the window commands found on the File ‘menu. The toolbar also includes the Microsoft Windows clipboard tools found in the Edit menu. Raab Sn Pai Button Description T [Ey] | Eccutes the New Window command on the File menu to apen the Windows Properties dilog boxta create 8 now window, [Executes the Open Window command onthe File menu to open the Windows to Open alo box listing the names of existing windows that hat can be select o open. [Executes the Close Window command on the Fle mento cpen the Windows to Close dlog box stg the ames of al cirreray open windows tht can be selecod to dose [Executes the Save Window command onthe File meno open the Windows to Save dai box sting the names ofall curenty open windows that have been modified ince they ware lst saved xscutes the Save All Windows command on the File manta eave all curently open windows that have been ‘modified since they were lst saved. This tool does not ask fr confimaton on @ per window basis. saves all meciied windows automaticaly [Executes me Duplicate command onthe Eat menu te duplicate the curently selected abec() in the window, Exocuies the Cut command on the Edt menu to out the cure selected objects) rom the window and copies them to the Windows Cipboar Exocules the Copy command on the Edlt menu to copy tha oxtentySelctes abject) and coples them to he Widows Cipboard. (Copied objects are not orzsod re the window) ‘Executes the Paste command on the Edt menu to pasts any objact that hes beon cut or coped tothe Windowe Clipboard. (The cursor changes tothe paste mode, Ck inthe window to paste the copied or cut abject) Exocules the Undo commend onthe Edit menu te reverse (undo) the Int action or command applied to an objec Ee Bee @\o o/e [Executes the Redo commend on the Edit menu to reverse (red) the last und action or command apples to an objact. | Executas the Print command onthe File manu to open the WindowMaker Printout calg box uso to pint database and window information and QuickScits. TaTouch for System Platform 2072 R2 25 26 Module 2 - Application Design Basics Wizard Toolbar The Wizards toolbar contains the tools used to embed ArchestrA Graphics, access the Wizard Selection dialog box. Add any installed wizard or ActiveX control to the toolbar by using the Wizard Selection | Add to toolbar feature, Button Description (ieplays the Wizard Selection clog box used for seloctng wizards fo paste int the application Into the application. ‘SmartSymbole are superseded by ArchestA Graphics in managed InTouch applcallons | fa Executes the Embed ArchestrA Graphic command on the Edit menu used for seloding ArchesA Symbols f0 place Tnvensys Learning Services nd ‘Section 1 — Development Environment and InTouch Windows 2-7 ~ Format Toolbar a ‘The Format toolbar is grouped with tools that execute most of the text object formatting commands found on the Text menu. it also contains the tools used to access the color palette to select line, fil, text, A window background, and transparent object color. ~ Button Description [Execs the Font command on the Text mento open the Font dialog box used io selec the font, fs style and Sze ‘Execs the Bold command on the Text menu (0 apply Bold sng to single or mutipla text sting selections and numero value lds, "Execute alle command onthe Text menu to eppy dal styling to single or mullet sing selections and numeri value lds a "Execs the Undertine comand on the Text menuto apply undein sing to single or mule to sing soletons and numeric value lds. [Executas the Reduce Font cernmand on the Text ment to raduos the pont size ofa sizeable fo Apply Hs ‘command by slocting the text tng) ane icking onthe too "Executas the Enlarge Font command on the Text menu to enlage pont size ofa slzesble fort. This command can be applied by selocing the txt sting(e) and clicking on the too. Execus the Left Justified command onthe Text menu to algn the ll edge of single or mulple ent sting slocione and numeri value falds [Executes the Centered command on the Text menu to contr aingle or mulipe tex ang selections and numeric vals fds. ‘Executes the Right Justified command onthe Taxt manu fe algn the right edge of ingle or mulipla text sing selections and numeric vale feds (Opens the color paletio used to cect tho colo: for ine objet or an objects outine > See eee eeee > ‘Opens the color palate used to select an abjate fl color ‘Opens the color palais ueed to edlect an abject text color. ‘Opens the color pale lo select a window background olor. ‘Opens the coir paleie to selec a Vansparent color fora bitmap objod. TinTouch for System Platform 2072 R2 e a ° ° ° ° ° . ° ° ® e 6 e e e e 28 Module 2 ~ Application Design Basics Drawing Toolbar The Drawing toolbar is grouped with all the tools used to draw both simple graphic objects such as rectangles, ellipses, lines, or text objects. It also contains complex objects such as real-time trends, historical trends, bitmaps, and 3-dimensional buttons with labels. fr Button Description ‘Selocior made used To select abject in the window ‘Rectangle ool used to draw roctangies or squares. Rounded rectangle fool used to draw reclangles o squares wih rounded comers lip tool used o draw elie or ree. Line ool wsedto draw nos al any angle Tine tool wed to draw horzonial or vocal lines Line tool used to draw panes, ‘Shape fool weed te araw polygon Tent tol used enter ton bea, ‘iunap iol used Io raw a bitmap corner for pasting a imap draly fom the Windows Clipboard or one ofthe folowing fle ypes: BMP, JPG, JPEG, POX or TGA. Real tie tend tool used fo draw eal ne tend abject. (Nel applicabe fo InTouch for System Paton epplcaions), Fistorical rend to! used to draw historical trend objects. (Not applicable to iTouch for System Patfom epplcaions)._| ‘Baton ool used a draw a Sdmensional buon wih & abel TE FHAQAANDIooE Invensys Leaming Services ‘Section 4 — Development Environment and InTouch Windows 2-9 View Toolbar ‘The View toolbar is grouped with tools that execute most of the window commands found in the View ‘menu. These commands are used to control the state of the WindowMaker window. 4 Button Description n FE] | Exsetes the lassie View command fom te View toobarto showhide the Aplation Explor: Classi View FS] | Esato the Prefect View command rom be Edit ioobar to show>ide he Apleaton Explorer Prec View. “Togales the Hide All command on the View menu on ard oto hidalshaw al docked toobars ‘When the hice all mode is active, the overall size of Windowtaker emalns the same. To retum to normal made, Fj] | ctckthe Hermes too on he fosteg View Toolbar or lek on te View Hide Al conmand “ Inthe hide all mode, all foating toolbars remain vse andthe View Toolbar automatically foets on top of ‘WindawMaker. any of te floating toolbars ate docked inthe hide all mode, the mode ie automatically aq tevminated. = “Togales Full Screen command onthe View menu ov and off to swith the eiplay mode fom nonvial ew to fal > “Toretum to normal made, cick the Full Seen too on the fosting View Toolbar cr click onthe View / Full Sereon command Inthe fl screen mode, all Wirdowhaker program elements are hidden except any open windows and floating toolars. The Restore Toolbar automatically foals cn top of WirdowNaker vs Inthe fl screen mode, the coordinates of the clent area wi remain the same. For example, the top lets 0.0 “The full screen mede automaticaly sts the coordinates after it maximizes the client area, hides the Tile Bar and menu bar and eduss the lent ere to mimic Views ful screen mode, “Toggles the Snap to Grid command onthe Arrange menu cn and off showihide the vse gid used lo aig [BE] | comers th te Arange San Gr cerman + apts ta Madea Proparsa log bot et eed hs lh ro a. By | ete earn ont oo ow ie oo SS oe DB ceteris ee rot orcncec re sparse ep epee a cae InTouch for System Platform 2012 Re 4 ° o a . ° e e « e e e e e 6 Module 2 ~ Application Design Basics Snap to Grid (On the View toolbar, click the Snap to Grid too! ill to turn snap to grid on and off When arranging objects in windows, turning on the grid will cause the graphic to snap at the upper left Pixel interval on the grid. If multiple objects are selected, the snapping will be applied to the upper left comer ofthe first object selected in the group, ‘With Snap to Grid on, use the arrow keys to move an object the number of pixels between grid coordinates (10 by default). Select an object and hold down the SHIFT key, press an arrow key such as up, down, right, or left to move an object twice the number of pixels between grid coordinates (20 by default), or the Ctrl key to move the object 4 times the number of pixels between grid coordinales (40 by default) If Snap to Grid is off, select an object and hold down the SHIFT or Ctrl keys, press an arrow key such as up, down, right, or left. To move an object in 10-pixel increments use the Shift key. For 50-pixel, increments use the Ctrl key. Use the arrow keys alone to move an object 1 pixel ata time, These features can be useful when making fine alignment and location adjustments, Note: By default, the grid is set to 10 pixels and visible when WindowMaker is initally started. Configure the pixel interval for the grid through the WindowMaker Properties dialog box, described later in this section. Ruler ‘The WindowNlaker ruler [lean be used to precisely align objects in windows, and when to determine the movement of an object during an animation sequence. ‘The small tick marks are spaced 5 pixels apart. The medium tick marks are spaced 10 pixels apart. The numbered large tick marks are spaced 60 pixels apart. Tnvensys Learning Services Section 4 — Development Environment and InTouch Windows Pan and Zoom Toolbar ‘The Pan and Zoom toolbar allows quick movements around a window and enlarge or reduce the ‘magnification level [eA N i Button Description oom out rom the area wire hal ccd, 2 = Zoom in on the area where thats Gcked. S “Zoom Normal relurns fo the default magnification level (100%). Rubber Band Zoom uses ihe mouse lo select a specie area to zoom in on ‘Show / Hide thombnall ofthe window on which a red box-an be {the red box to 200m in and ou Pan moves he pasion ofthe wewing area 8d around fo pan ar resize Use the Zoom Entry Bax to selector enter 2 magneton level Not that not all ere can be frome FE] | zoomed. Zooming ver 100% wil display graphics placeholders in place of ArchestA Graphics. For ‘more Information please eoa te product documentation Use a mouse with a scroll wheel, by holding down the trl key and scrolling forward to zoom in and scrolling backward to 200m out. InTouch for System Platform 2012 R2 214 2412 Module 2 ~ Application Design Basics Arrange Toolbar “The Arrange toolbar is grouped with tools that execute most of the abject arranging commands found on the Arrange menu. Most of the arrange toolbar elements buttons are activated if more than one object: selected. Button Description [Executes the Align Left command onthe Arrange / Align submenu. Align the le edge ofa seloced cbjects wit {he let ode ofthe lft most selected objec. [Executes the Align Center command on the Arange/ Align submenu. Algns the vertcal canlarline of al elected objects with the center of the group of objects slocies, [Executes the Align Right command onthe Arrange / Align submenu. Aigns the right edge oa selected objecis with he right edge ofthe righ most selected object. Executes the Align Top command onthe Arrange / Align submenu. Algns the top edge of all selecled objecs with the top edge ofthe top most selected object. Executes the Align Middle command on the Arange/ Align submenu. Algrs te middie of al selected objeds with the mise ofthe group of objects. [Executes the Align Bottom command onthe Arrange / Align submenu. Ags the bation edge ofall seleciod ‘objects wih tho bation eage of he ousst selected abject ‘Executes the Align Genterpoints command onthe Arrange / Align submenu, Ags te centerpolk of al the selected objects withthe conterpoint ofthe group of selected objects “Execules the Sond fo Back command on the Arrange menu to place all seeded objec behind al objec Wal are not selects. Executes the Bring to Front command on the Arrange menu to place a slecied objects in font ofa objecs that ‘are not selected Executes the Space Horizontal command on the Arrange ment to evenly space al selecied objects horizontally botwoan the left most and ight most colocted objects. Executes he Space Vertical command onthe Arrange mento evenly space al slated cbjecs veil between the top most and bottom mest selected obocs. & ‘Executes the Make Symbol carmand on the Arange menu io combine muliple ebjecs into a single unit called & symbol ‘Execute the Break Symbol command on the Arrange mento break 8 symbol into snail components. Execs the Make Cell command onthe Arrange menu to combine multiple slocid objects into asngle unit called ‘cel When combining cals, each cell wil be retained. When the combined cll is roken, the ariginal calls re restored ‘Executes the Break Cell command on the Arrange menu to break a selected cell. When combining calls, each cell willbe retained. When the combined cellis broken, the original cells are restored, Execuls the Rotate Clockwise command onthe Arrange menu to rotate selected cbjects clockwise 80 degrees, ‘Executes the Rotate GounterGlockwise command onthe range menu lo ole saleded objeds courier doce 90 dogrees. ‘Executes the Flip Horizontal command on the Arrange menu to fip selected objects horizortaly, ‘Exeoutes the Fp Vertical conmand on the Arrange menu to fip selected objecsvercaly Sie e|\2|5|3| a ‘Exacui the Reshape Object command onthe Eat menu to reshape a polygon or payne. Tnvensys Leaming Services ‘Section 1 — Development Environment and InTouch Windows 2-13 WindowMaker Status Bar When an object is selected in a window, the WindowNaker status bar displays the upper left X and Y Pixel coordinates of the object and the pixel height and width. The X and Y pixel coordinates displayed are relative to the window the object isin, rather than the overall WindawMaker workspace. When a blank area of a window is clicked, the status bar displays the X and Y coordinates for the current location of the cursor in the window. Manual Positioning and Sizing In the WindowNaker status bar, there are controls for manually positioning and resizing objects. Select the object on the window, and then click the controls to enter exact X.Y coordinates and W,H values. Multiple objects can also be selected, moved, or resized as a group. a mie EE a AE Press the Enter key to accept and apply manual positioning and sizing entries, Note: Hold the Shift key down while drawing rectangles, rounded rectangles, and ellipses to constrain the height and width and to create exact squares and circles. InTouch for System Platform 2012 R2 2-14 _Module 2 ~ Application Design Basics WindowMaker Properties Use the WindowMaker Properties dialog box to configure preferences and options affecting the behavior of WindowMaker. The WindowMaker Properties dialog box can be accessed through the Special | Configure | WindowNaker menu option or through the WindowMaker option found in the Tools pane (Classic View) under Configure. Ce bd Genes | |. Weddle Te Bar | Toba Tou [fistous wrote | | show Anca Dieta | (id Conia << Spacing: [10 Pixels Show Grid TT Show Tag Count FF Lock Window Size T Cheon Trar WindowViewer I Pick Through Hollow Objects [/ Configre Fonts 1 EnabloF ant Sitch Line Selection Precisiorr if Pinels eo Oe eee Cancel ly In the WindowMaker Properties window: + Change the title bar text ‘+ Show the folder name of the open application in the ttle bar ‘© Display the grid or tum off the grid + Change the spacing between the pixels on the grid ‘© Set an option to close WindowMiaker when switching to WindowViewer ‘+ Set an option to pick through hollow objects + Enable fast switch from WindowMaker to WindowViewer ‘Set the precision for line selection ‘+ Set the number of undo levels + Change the default fonts for text and buttons + Lock window size Tnvensys Learning Services 4 Section 4 — Development Environment and InTouch Windows 2-15 ———eermenittonment Environment and InTouch Windows InTouch Windows ‘The InTouch application is comprised of windows that can contain graphics, text objects, animations, and action scripts. When first creating the window, define the properties of the window itself, such as background color, tile, and screen position. The General Toolbar contains buttons for most of the ‘ ‘commands in the File menu. To create a new window, in the General toolbar, click the New Window button Window Properties Dioramas ree Wino Type Dinenons + ORerkce Orel Pome — xLocaton —[d = Frane Syl Ylocaton, [| a Osinae Window Width: (632_| ‘Window Height (278 InTouch for System Platform 2012 R2 246 Module 2 ~ Application Design Basics ‘The basic window properties are described below: Action/Result PropertyiFiold Name Type a unique name that identifies the window. 5 ‘Comment Type any comments to be associated with the window. The comment must be 50 characters or fewer, and is optional Window Color Select the background color for the window. Window Type Configure how the window opens at runtime Replace ‘The window automatically closes any windows it intersects with when it appears on the screen. pane Overlay ‘The window appears on top of currently open windows. It can be larger than the windows) itis overlaying, When an overlay window closes, any windows behind it reappear. Clicking on any Visible portion of a window behind an overlay window brings that window to the foreground as the active window. Popup ‘The window always stays on top ofall other windows. Popup windows usually require a response from the user to be removed. Frame Style Configure the border around the window. Single ‘A three-dimensional bordered window, which can have a ttle bar ‘and size controls, Select the Title Bar check box to include the tile bar, Double Athree- & Pushbutton ‘53 PushbuttonRound 33 Pushbuttonsquare = Rocker ‘3G RockerSwitcht BB Rockerswitch2 © tens 2B Tank Type_Aos = Qvabes EB valverypen EB valverype8 Note: Symbol names must be unique within the Graphic Toolbox. lf the symbol is hosted by the Graphic Toolbox and edited: ‘+ Allsymbols hosted by AutomationObject templates and instances that contain embedded instances of this symbol are also updated. ‘+ All embedded instances of this symbol in InTouch WindowNlaker are also marked for an update, InTouch for System Platform 2012 R2 2-24 2-22 Module 2 — Application Design Basics Managing Symbols in Automation Objects Create ArchestrA symbols in AutomationObjects. Each AutomationObject has a Graphics tab where Archestré symbols can be created, edited, renamed, and deleted. These symbols appear in the Local Graphics list. When deriving an AutomationObject from a parent AutomationObject that contains symbols, all the symbols are inherited. Inherited symbols appear in the Inherited Graphics list. ‘Note: Only open inherited symbols in the Archest’A Symbol Editar in read-only mode, © SUserDefined_oo1. = ‘ sii 2, “Feld Atte | Obectinfomaton [Supt [ute [eeone| Che | Loc roi ae Ceaphicrame: Anlopnyi00 Bersoste 009 SBootadernnstied Desoto a ‘Soterk she_o01 “Ths's Te AnsiogDispey thet shows values from ) to 1000 with 2dgt precson, - Bre oen.o0: tated ache are | Ifthe symbol is hosted by an AutomationObject and edited: ‘+ All symbols hosted by derived AutomationObjects are also updated ‘+ Alllembedded instances of this symbol in InTouch WindowMaker hosted by derived - ‘AutomationObjects are marked for an update Tnvensys Learning Services Section 2 ArchestrA Symbols Overview ArchestrA Symbol Creation: The ArchestrA Symbol Editor The ArchestrA Symbol Editor is the tool used to create an ArchestrA symbol. First, select a basic graphical object, called an element, from a tools panel and place it on the drawing area, called the canvas. Typical elements are lines, rectangles, ellipses, and curves, ‘Change the appearance of the drawn elements by accessing thelr properties directly or by graphically ‘manipulating them. Finally, configure animations for the elements or the symbol. Reusing ArchestrA Symbols Reuse ArchestrA symbols created in the Graphic Toolbox in AutomationObject templates, ‘AutomationObject instances, or in InTouch windows. This is called embedding, ‘Automation ‘Automation Templates Instances InTouch HMI TiTouch for Systom Platform 2072 R2 2-23 2-24 Module 2 ~ Application Design Basics When deriving an AutomationObject template, its ArchestrA symbols are inherited by the new instance, This can be caused by’ ‘+ Deriving an instance of the template in the IDE. When deriving an instance of an ‘AutomationObject template that contains symbols, the created instance contains inherited symbols, ‘* Embedding a new ArchestrA symbol in WindowMaker. A new AutomationObject instance is derived to which the symbol in InTouch WindowMaker then points, Automation Instance — Automation Template Instantiated in IDE ~ ~ Browse and Instantiation caused Select Template by InTouch InTouch HMI Automation Instance Tivensys Leaming Services = Section 2—ArchestrA Symbols Overview 2-25 ArchestrA Symbols and Instantiation fe ‘When embedding an ArchestrA symbol into an InTouch window and the symbol is contained in an AutomationObject template, create a new instance of the AutomationObject. The embedded ArchestrA symbol automatically references the new object. Automation Automation Template ‘, Instance 1 Instantiation caused by InTouch 9 Browse and References “sf Select Instance j i = References 2 ‘Automation ms Instance 2 InTouch HMI ) » InTouch for System Platform 2012 R2 o ° ° ° ° ° °e 2-26 —_Module 2 — Application Design Basics Insert an ArchestrA Symbol into an InTouch Window ‘An ArchestrA symbol can be inserted into an InTouch Window of the managed InTouch application and may either be part of ‘The Graphic Toolbox. ‘An ArchestrA object template ‘An ArchestrA abject instance 1. Glick the Embed ArchestrA Graphic button [Ell to place an Archest-A Symbol in a WindowMaker 2. Click the Graphic Toolbox icon /& ‘The Graphic Toolbox list appears on the left. an Inserted ArchestrA Symbol with the ArchestrA Symbol Editor ‘When editing an inserted ArchestrA symbol from within InTouch WindowMaker, the symbol changes will be propagated to all instances of the ArchestrA Symbol. Right-click on the inserted ArchestrA symbol, Select ArchestrA Graphic “” / Edit Symbol. The Archestr’ Symbol Eaitor with the ArchestrA symbol appears. Sree oui a ie ea Ezit the ArchestrA Symbol 4. Save the ArchestrA Symbol and refresh the working cor in WindowMaker by double clicking the ‘Symbol Changed icon in the WindowMaker status bar Invensys Leaming Sorvicos ~ Section 2— ArchestrA Symbols Overview 5. Select the desired symbol from the ArchestrA Symbol Library and click OK. 6. The insertion icon appears if the mouse is over the InTouch window "* 7. Click in the InTouch Window to place the ArchestrA Symbol. The selected symbol displays in the WindowMaker window: nee InTouch for System Platform 2012 R2 2-28 _Module 2~ Application Design Basics See eee Tivensys Leaming Services 2-29 Lab 3 — Building the Application Layout Introduction In this lab, you will create windows for the managed InTouch application created in the previous lab. You will use graphics from the ArchestrA Symbol Library to create a navigation bar that will allow you to open different windows in the application in runtime. Later in the class you will add more grephics to the Main ‘window to display system information, Note’ The steps and screen shots used in his lab are designed fora resoliion of 1280 x 1024 J ) J9DID9D d 7 Objectives LUpon completion of this lab, you wl be able to + Create and configure InTouch windows + Ada and postion ArchestrA Symbols in a window + Assign values to symbol properties from InTouch + Use InTouch animations to open windows with the click ofa button ) TaTouch for System Platform 2012 R2 eee0ee009 2-30 _Module 2 ~ Application Design Basics Create New Windows In the following steps, you will create the windows you will use in your InTouch application. 1. Close Classic View to allow more usable screen space. Create @ new window and configure as follows 2. Onthe File menu, select New Window. Tavensys Learning Services “4 Lab 3~ Building the Application Layout 2-31 ‘The Window Properties dialog box appears, 3. In the Name field, enter Main, 4. Configure the following window properties as shown below. Window Type: Overlay i Title Bar: uncheck) nd Size Control: 1 (Uncheck) Frame Style: None ) ) = ee . on Tap2 Diner — > [Crate © Oty © Pawp) | xian fF | | See} a FromeSe———————— | Yocetoe [5D 5 te ne ~ 5. Click OK to close the Window Properties dialog box. , InTouch for System Plalform 2012 R2 ° ° ° ° ® e » e e 2-32 _Module 2 ~ Application Design Basics Create a new window and configure as follows: 6. Onthe File menu, select New Window. The Window Properties dialog box appears. 7. Configure the following window properties as shown below, Name: Navigation Window Type: Overlay Title Bar: 1D uncheclg Size Control: 1D [Uncheck None x: o Y: 0 Width: 140 Height: 650 ee [EEE von coee [3] ee ee Yous p| Sel Gea Window Wide FO File Bar TM Site Comte FF Coe ton | Window Height [B50 8. Click OK to close the Windaw Properties dialog box. Tivensys Learning Services, Lab 3— Building the Application Layout, 2-33 Create one more window that contains the same properties as the remaining windows you will create. 8. Onthe File menu, select New Window, 10. Configure the following window properties as shown below. Name: Alarms Window Type: Replace Title Bar: 1 [Chook) Size Control 1 [Uncheck] Close Button: [Chacld Frame Style: Single Dimensions 141 o 1139 650 edace Ovetay © Porn Frame Sple Location [T © Side © Doble © Nove eet | Window Heit: [550 11, Click OK to close the Window Properties dialog box. Ss _______ InTouch for System Platform 2012 R2 2-34 _Module 2— Application Design Basics 412. Onthe menu bar, click the Save All Windows button oad sras pela) WindowMaker retains the settings from the last window created, You only need to change the name to create the following windows. 43. In the Project View, Windows and Scripts pane, right-click Alarms and select Save As. 114. In the New Name field, enter DocViewer and click OK ae ‘Sove “Ale Ae, Meee Docent | crest “The Alarms window is now closed and the DocViewer window remains open. 45. Inthe Project View, Windows and Scripts pane, right-click DocViewer and select Save AS, 16, In the New Name field, enter History and click OK. 17. In the Project View, Windows and Scripts pane, right-click History and select Save As. 48. In the New Namo field, enter Mixer and click OK. 49. Inthe Project View, Windows and Scripts pane, right-click Mixer and select Save As. 20. In the New Name field, enter Overview and click OK. 21. In the Project View, Windows and Scripts pane, right-click Overview and select Save As. 22. In the New Name field, enter System and click OK. nnn Tavensys Learning Services Lab 3 - Building the Application Layout, 2-35 Embed and Configure ArchestrA Graphics In the following steps, you will insert graphics from the ArchestrA Symbol Library on the InTouch windows you just created. You will then configure navigation buttons to open the different InTouch windows, 23, Click the Embed ArchestrA Graphic button, ed fecha Gag] ‘The Galaxy Browser dialog box appears, 24, Expand ArchestrA Symbol Library and select the Buttons folder 25, Scroll to the bottom ofthe list, select the ButtonText button and click OK. TnTouch for Systom Platform 2012 R2 2-36 _Module 2 ~ Application Design Basics 26. Click in the top of the Navigation window to place the button on the window. (HR oe tm tlm mod Unow DIGH@ssanoc gd Bem Mer mick, ay iF , 1 i HEGEL 1 t 28. In the Now String field, type Mixer and click OK. Tnvensys Leaming Services Lab 3 - Building the Application Layout 2-37 29. Right-click the Mixer button and select Animation Links. InTouch for System Platform 2012 R2 2-38 _Module 2 ~ Application Design Basics 31. Select Mixer and click OK. Cores! | deste | sesh | nwa 32. Click OK again to close the Animation Link selection dialog box. 33, Right-click the Mixer button and select Duplicate to create another button. 34, Move and align the new button below the original 36, Repeat Steps 27-34 to Rename and appropriately animate the buttons to access the following windows: + Alarms © History © Doc Viewer = Overview + system Tnvensys Learning Services Lab 3 — Building the Application Layout ‘Your Navigation window will look similar to this when you have finished these steps. HSGH@tkan oo a hem More cK eee Crmetven |x : ‘InTouch for Systom Platform 2012 Re 2-39 2-40 Module 2 Application Design Basics 36. Click the Embed ArchestrA Graphic button. 37. Expand ArchestrA Symbol Library and select Clocks. 38, Select the ClockWonderware clock and click OK. 39, Use the window area scroll bars to scroll down to see the entire Main window. 40. Click on the right portion of the Main window to place the clock on the window. Tnvensys Leaming Services| Lab 3 — Building the Application Layout 2-44 41. Click the Embed ArchestrA Graphic button. 42. Expand ArchestrA Symbol Library and select Widgets. 43, Select the ValueDisplayLabelEngUnitsStacked symbol and click OK. insisted etre. 44. Click on the bottom-right portion of the Main window to place the ValueDisplayLabelEngUnitsStacked symbol under clock on the Main window. InTouch for System Platform 2012 R2 2-42 _Module 2 ~ Application Design Basics 45. Right-click the vaiue display symbol and select Substitute | Substitute Strings. 46. In the EngUnits field, place one blank space. ; Inthe Label field, enter Version. Subse Stings 203 47. Click OK to close the Substitute Strings dialog box. ) > ) Tavensys Leaming Services 530808006080832323 2 Lab 3 ~ Building the Application Layout ‘48. Double-click the ValueDisplayLabel to open the Edit Custom Properties dialog box. 49. In the Custom Properties list, select Value. 50. In the Default Value field, delete all existing data and click the Browse Galaxy ellipsis button. a TTT | Custom Properties + © (2) Value ValueDisplayLabe. tee uy _—————— = rere ratty 6 pai pmomy cote meen yi ra Bia Pn th oni need Posi [aeedstyntatm @ | eee ‘The Select Tag dialog box appears. 51, From the Tagname list, select $ ApplicationVersion. 52. Click OK to close the Select Tag dialog box. 53, Click OK to close the Edit Custom Properties dialog box. TnTouch for System Platform 2012 R2 2-44 Module 2— Application Design Basics Test in Runtime ‘You will now check to see if everything you configured works as intended in the Runtime environment. InTouch uses @ program called WindowViewer for its Runtime environment, Clicking on the Runtime link ‘automatically launches WindowViewer. 54. Click the Runtime link in the top-right comer to display the windows in Runtime. Note: _Window\lakor automaticaly saves any open windows betore deplaying them in Runtime. 55. Click each of the butions you created to see the windows displayed change between Mixer, Alarms, History, etc ‘56. Watch the clock and check the version display. ‘Your instructor will discuss WindowViewer, the InTouch Runtime interface, in more detail in the next - section of this training, 57. Close WindowMaker and check in the object. WindowViewer will close automaticaly Invensys Leaming Services Section 3 ~ Runtime Environment and Application Deployment 2-45 Section 3 —- Runtime Environment and Application Deployment ‘hig eadon prasdes 3 bet over ofthe InTouch Windowviower andthe $itwEnging. and See se oe ower andthe SViewEngino, and WindowViewer \WindowViewer provides the runtime environment for InTouch applications. When an application is started in WindowViewer, the windows that are configured to open by default are started in runtime, unless \WindowViewer is called from WindowMaker for testing the application. In this case, the windows opened Jn WindowMaker are opened in WindowViewer. Information displayed in WindowViewer is realtime application data from the plant floor. Processes can then be controlled by the operator by clicking items con the screen. InTouch for System Platform 2072 R2 2-46 Module 2 Application Design Basics Deploy a Managed InTouch Application Associating all Galaxy graphics with an InTouchViewApp template enables deployed and published InTouch applications to execute show graphic requests made of any graphic in the Galaxy without having to embed them in the application Before a managed InTouch application can be used in a production environment, it must be deployed to the target platform(s) from the ArchestrA IDE. An instance of the SinTouchViewApp template is treated as any other ArchestrA object and must be deployed to the target node. You can deploy a managed InTouch application from the ArchestrA IDE to the local node or a remate node. After you deploy the application, you can run itn WindowViewer on the remote nodes. The $ViewEngine object must have a Platform on which to run. This object: ‘+ Hosts InTouchViewApp objects ‘= Contains the logic to set up and initialize objects when they are deployed ‘+ Contains the logic to remove objects when they are undeployed ‘+ Determines the scan time which all objects within that particular engine execute ‘The $InTouchViewApp object must have a ViewEngine on which to run. This object: ‘+ Manages the synchronization and delivery of files required by the associated InTouch application ‘+ Provides runtime access to tags on the associated InTouch application ‘+ Starts WindowMaker for the associated InTouch application when edited InTouch Application Manager and WindowViewer When the Application Manager is fist run, it searches the computer for any existing InTouch ‘applications. Application links are displayed by an icon containing the application's name. Other information is displayed in columns. Notice the Application Type column indicates that an application is managed from the ArchestrA IDE, or Stand Alone. Note: Stand Alone InTouch applications are not managed, cannot use ArchestrA Symbols, and are not intended to be used with the System Platform. ‘When a managed application is selected, several toolbar buttons are grayed out: WindowMaker, DBLoad, and DBDump. These functions are not available for managed InTouch applications. See eee 2 ae z ‘(25007 1525591 Waders apieaon 10281768 sas 0.07PM ado Apleton 12003024 Sian? sesorm Wapene apleaton 600x600 e yoann? 6::s9Pm Tivensys Learning Services Section 3 ~ Runtime Environment and Application Deployment 2-47 ‘A managed InTouch application can be run by selecting it in the Application Manager and clicking the WindowViewer button Resolution at Runtime ‘Access the Resolution tab in Node Properties. to configure WindowViewer to dynamically change resolution at runtime. Doreen ‘App Development| Fesoion | Alon Windowioner to danicay change teschtion Dyna Retain ‘Ose appaton rection © Cena steer vies aii Custom resolution = Tor System Platform 2072 RO Module 2 ~ Application Design Basics WindowViewer Properties Like Windowhtaker, WindowViewer includes many options to customize the runtime environment Configure these options by configuring Window/Viewer Properties from WindowNaker WindowViewer Properties - Managed Application Tab ‘The WindowViewer Properties cialog box can be accessed through the Special | Configure | Windowviewer menu option or through the WindowViewer option found in the Tools pano (Clacsic View) under Configure Ce Genera ‘Window Corfiguation Viewer Memory Home Windows ‘Advanced Fammat Mansged Applcaion Pee es Localvoki decoy | SEEES=oR ee SSS a oo Changs Mode © Ignore changes © Restart Windouviewes (© Prompt use to restan WindowWiewer © Load changes into Window viewer © Prompt use to load changes into WindowViewer Deployed Updates Area Local Working Directory: Where the InTouch application is deployed on the target node, Reminder interval (sec): How often, in seconds, the user is reminded to load or restart the changes into WindowViewer. This option is available when the applicable change mode has been set. Set the interval to 0 to not remind the user. Script timeout (msec): When running a managed InTouch application in WindowViewer, any scripts associated ArchestrA Symbols run as expected. However, some scripts contained in symbols can run for a long time and prevent interaction with other InTouch elements, To prevent this, set a script time-out that is applicable for all scripts in the managed InTouch application. A script timeout stops script execution and returns the control to the operator. By default, scripts time out after 5 seconds. Tnvensys Learning Services Section 3 ~ Runtime Environment and Application Deployment 2-49 Change Mode Area Ignore changes: WindowViewer wil ignore any deployed changes. Manually configure the RestartWindowViewer() and ReloadWindowViewer() script functions to accept the changes depending on the $ApplicationChanged system tag. Restart WindowViewer: WindowViewer will restart automatically when changes are deployed, Prompt user to restart WindowViewer: Window/Viewer will prompt the user to restart Window Viewer when changes are deployed. Load changes into WindowViewer: WindowViewer will load any deployed changes automatically, Prompt user to load change: ‘any deployed changes. ito WindowViewer: WindowViewer will prompt the user to load Home Windows Home windows are windows that appear in WindowViewer when the user starts WindowViewer direcly ‘either from an icon or a menu command, Cie ‘Window Configuration Viewer Memony ‘Advanced Format Menaped Application Home windows do not appear if the Runtime fast switch is used to start WindowViewer. Display home windows at any time during runtime by using the ShowHome() function in a script To set home windows: 1. On the Special menu, point to Configure and click WindowViewer. The WindowViewer Properties dialog box appears. 2. Click the Home indows tab, Select the window or windows to open when WindowViewer starts 4. Click OK. InTouch for System Platform 2072 2-50 Module 2 ~ Application Design Basics Viewer Memory Configure how WindowViewer uses memory for application windows to improve performance at runtime, Reopening closed windows that have been cached retrieves them from memory rather than loading them from disk in certain conditions. Designate certain windows to have a higher priority for memory usage and configure separate memory settings just for those windows. ‘After any of the Window\iewer memory options are modified, restart WindowViewer to apply changes. To set the memory properties: 4. On tthe Special menu, point to Configure, and then click WindowViewer. The WindowViewer Properties dialog box appears, 2. Click the Viewer Memory tab, ‘Advanced Format Managed Application Widow Configuration ‘Viswer Merny Use Intemory Window Coche Memory Link forin Memow Windows: [70% InnMemoy Window Expitation Tine: [0 {Hoh exp Window Casting Enable High Print Window Caching ‘Memory Lin for High Piri Windows: [90% ‘High Poly Windows: Tnvensys Learning Services - Section 3 - Runtime Environment and Application Deployment 2-51 3. In the In-Memory Window Caching area, do the following! ‘+ _ Select the Use In-Memory Window Cache check box to save all closed in-memory windows Inmemory at runtime. os ‘Inthe Memory Limit for in-Memory Windows box, enter the limit for keeping closed in- ‘memory windows in cache memory at runtime. The default memory limit is 70% of process memory. Ifthe memory limit is exceeded, the system automatically removes the oldest closed in- memory window from the cache at runtime, unless it is merked as a high-priority window. rt ‘The memory limit for in-memory windows will always be less than the memory limit for high- Priority windows, + In the In-Memory Window Expiration Time box, enter the maximum duration for which the ~ Closed in-memory windows will remain in cache memory at runtime. Enter a value between 0 and 8760 hours. The default value is 0 hours, which designates no time limit. ‘The memory limit or the expiration time limit is applied depending on which limit is reached first. 4. In the High Priority Window Caching area, do the following ‘+ Select the Enable High Priority Window Caching check box to allow some windows to be ao ‘marked as high priority. These windows will always be kept in cached memory after they are at closed at runtime. = ‘+ _ Inthe Memory Limit for High Priority Windows box, enter the limit for keeping closed high- priority windows in cache memory at runtime, The default memary limit is 90%. The system a removes the oldest in-memory window first, and then removes the oldest high-priority window me when the percentage of used memory exceeds this limit at runtime. = ‘+ _ Inthe High Priority Windows box, select the windows to mark as high priority. = 5. Click OK. ) InTouch for System Platform 2072 - ° ° ° ~ e ® ° 2-52 _Module 2 ~ Application Design Basics Invensys Learning Services Lab 4— Deploying an InTouch Application 2-53 Lab 4 — Deploying an InTouch Application Introduction In this lab, you will deploy an InTouch application, and then view that application in Runtime, FIDFDIFIDFDIFIIPIVDIFIDZDIF III VIVID Objectives Upon completion ofthis lab, you will be able to: + Create and configure a ViewEngine + Configure WindowMaker and WindowViewer properties + Deploy a Managed InTouch Application + Open a deployed InTouch application in Runtime = me InTouch for System Platform 2072 R2 PIDIDIFFIF III IF IFZIVIDQISI 2-54 Module 2 ~ Application Design Basics Create New Platform and Engine In the following steps, you will create a visualization platform and a ViewEngine. Single Node: Single node users will start at Step 7. In the ArchestrA IDE Template Toolbox, expand the TrainingGalaxy / Training / Global template toolset. Right-click the $gWinPlatform template and selact Now | Instance to create a new instance. ‘Shy EF ten Det Sib PRISMA SUBAXRS A sa vecow © Sunes (ure) > Slurecturez] Invensys Learning Services, = Lab 4~ Deploying an InTouch Application 2-55 4. Double-click VISPlatformt to open its configuration editor. 5, Inthe Network address field, enter the server name for your Visualization station node name. Your instructor will provide this information, Save and Close and Check In the object. ~ 7. From the System template toolset, right-click the $ ViewEngine template and select New | Dorived Template. ‘ley Eat yen bet won to ~ FBGH SO Ms owe! (StompateToobox + 8 x InTouch for System Platform 2072 R2 2-56 _Module 2 ~ Application Design Basics 8. Rename the template $aViewEngine. (Trenpise Toabox va ennrobey i F iceaen 4} Blosertmoee 2 Eine gen Station 9. Move the template to the Training/Global template toolset, (Template Toobox yo Fs tancaaey peskton 1 Eeoewe megan store Seco Bierce | Sven Sheraton = Gta ‘© srostmane Sh tomes gee Csaweeation © aWeing © Fer ed @ tr @ Fk 8 Fire Trvensys Learning Services 5 Lab 4 — Deploying an InTouch Application 2-57 10. Create an instance of the $gViewEngine template and name it ViewEnginet. “Deployment 78 = grrannasiay Foire | real — aiena| oe pee por | Genes | gee ean aod 411. Host the ViewEnginet instance under the VISPlatform1. ‘Single Node: Single node users will place ViewEngine! under the GRPlatform rather than visPlatformt “eDenloyment 2s = gpanngsainy = CSlnsesgned Host 2S Groseitrmt = @ dgptrcet Bh cotetton © Ble (tre) > Bune turez) adanno TnTouch for System Platform 2012 R2 258 Module 2 ~ Application Design Basics Create an Instance of the InTouch Application Create a new instance of the SMixerView template. 12. In the ArchestrA IDE Training / Working template toolset, create a New Instance of the $MixerView template. Do not rename the instance. 13. Host the MixerView_001 instance under the ViewEnginet instance created earlier. Tnvensys Learning Services s Lab 4— Deploying an InTouch Application 2-59 14, In the Model View, assign VISPlatform1, ViewEnginot, and MixerView_001 to the ControlSystem Area, Single Node: Single node users will only assign ViewEngine1 and MixerView_001 to the Controlsystem area. — eS vec reat A gree 2 Configure WindowMaker and WindowViewer Properties Configure InTouch Windowttaker and Window Viewer Properties to determine default viewing In runtime. 15. In the ArchestrA IDE Training/Working template toolset, double-click the $MixerView template to open InTouch WindowMaker. InTouch for System Platform 2012 R2 2-60 _Module 2 ~ Application Design Basics 16. Click Cancel ie Tinvensys Learning Services| ~% Lab 4 — Deploying an InTouch Application 18, 19. 20. ‘The WindowNaker Properties dialog box appears, Check Lock Window Size. Retain all other default settings and click OK. Gere | = Wrote Te ag Veber Tot Jtoxh-wedonter : | IF Shaw ApeestenDrectoy id Corigston — soos FO” Pet Peak F rath (Seofae— Fea ee Boe Pee Love Und: ir Bot | eee eal ee will take effect. isnecessry torestart Whar forthe charges to take eect. Ess Click OK to acknowledge that you will need to close and restart WindowMker before your changes TnTouch for System Platform 2012 R2 2-62 _Module 2 ~ Application Design Basics menu, select Configure | WindowViewer. 22. Click the Home Windows tab. 23, Select the following windows to open: © Main © Mixer + Navigation 24. Click OK to close the WindowViewer Properties dialog box. 25. Close WindowMaker and Check In the object. Invensys Leaming Services Lab 4 ~ Deploying an InTouch Application 2-63, Deploy the Managed InTouch Application In the following steps, you will deploy the visualization platform, the ViewEngine and the InTouch ‘Application you created earlier. 26. In the Deployment View, right-click VISPlatform1 and select Deploy. 27 Single Nodo: Right-click ViewEnginet and selec Deploy “pDeloyment © @rtabigialay uosined Retain all defaults and click OK. cascaiodepoy FT roice 6 ip Frese oF InTouch for System Platform 2012 R2 2-64 Module 2 - Application Design Basics 28. Click Close when complete. Dey cenit (rade amecad olan: [sists cna. [cocina wear cbs tong delved ecuresefoye a: Sng ad Ung pe) srg om ir Nesey lore Sar [enn Pinar) art ts Virsa sty Taney Tnvensys Learning Services, Lab 4 — Deploying an InTouch Application 2-65, View the Deployed Application in WindowViewer (pen the MixerView application in InTouch WindowViewer and test the navigation buttons in runtime, 28. Log into the computer hosting the deployed InTouch application, From the Start menu, select All Programs | Wonderware | InTouch to open the InTouch — Application Manager. Sorters Mi iecesrA DE Wd Setemmerssener conde pee = ort i Fret cert E mown ee InTouch for System Platform 2012 R2 2.66 _Module 2 ~ Application Design Basics ‘The MixerView application automatically opens in Runtime. Notice that the Home Windows (Main, Mixer, Navigation) open automaticaly. 32. Click each of the buttons you created to see the windows displayed change between Mixer, Alarms, History, ete 33, Wateh the clock and check the version display. ee Tavensys Learning Services invenssys Learning Services ~ Module 3 — ArchestrA Symbols Basics Section 1 ~ ArchestrA Objects and Symbols Section 2— ArchestrA Symbol Editor Lab 5 — Creating the Tank Symbol = Section 3 — Basic Tools and Animations = Section 4 ArchestrA Symbols in Contained Objects ~ Lab 6 ~ Creating the Mixer Display Section 5 ~ Basic Windows Controls 4 Section 6 - The Owning Object Property Lab 7 — Switching Between Mixers 3-2 _Module 3 - ArchestrA Symbols Basics Tnvensys Learning Services| Section 1 —ArchestrA Objects and Symbols 3-3 Section 1 — ArchestrA Objects and Symbols | This section provides a briet averview of text tools and value display animations. a HDR aE ore z ee ee Introduction ‘ArchestrA Symbols can be added to Automation Objects, templates, or instances, through the Graphics tab in the configuration editor of the object. Symbols added to object templates are inherited by any derived object just like script and UDAS. Any changes made to a symbol included in an object ternplate will be propagated to all derived objects as soon as the template is checked in, ‘Similar to adding scripts or extensions to an object, when an ArchestrA Symbol is added to an automation object, all references within the symbol should use relative references (Me.PV) to integrate the functionaity of the symbol within the object, instead of using absolute reference (InletValvet PV). This way, when working with object templates, all derived instances will have their inherited symbols properly ‘configured. ‘When working in @ containment relationship, all contained objects should have their own symbols added to them (device-specific symbols), and the container object symbols (system-wide symbols) will have the symbols from its contained objects embediled in them. This way, all relative references will be handled properly by the software without any additional configuration, (ipsa terete teeter InTouch for System Platform 2012 R2 Module 3 ~ ArchestrA Symbols Basics Managing ArchestrA Symbols Within Automation Objects Use the Graphics tab for the configuration ecitor of the Automation Object, to add a new [3] symbor, ive Ita valid name and type an optional description ‘The names must be unique. Valid characters for symbol names include alphanumeric characters such 2s §, #, and _ (underscore). Symbol names cannot include spaces and the symbol name cannot begin with the § character. Bsemiahe Brenfenne Breonfevare SBuaterave To edit a newly created symbol or to make changes to an existing one, select the Archestr/A Symbol under the Local Graphies list and click the Open button to open the symbol in the ArchestrA Symbol Editor. ‘Symbols under the Inherited Graphics list are inherited from a template up the derivation hierarchy. The symbol name will show with the name of the template the symbol comes from in square brackets ‘appended to it. Attempting to open an inherited symbol will result in a read-only editing session with the ArchestrA Symbol Editor. Invensys Leaming Services > Liha a ~ Section 1—ArchestrA Objects and Symbols ———_—_aaart ArchestrA Objects and Symbols z Inserting ArchestrA Symbols from an Automation Object - From the ArchestrA Graphics perspective, symbols added to Automation Objects are referenced like any other attribute within that object using the symbol's name. When embedding an Archest Symbol either nto anctner symbol orn WindowMoker, select ether the Template Toolbox button {I to embed a symbol from a template, or the Instances button ‘embed a symbol from an instance. Either way, the Galaxy Browser wil only display the objects, ~ templates, or instances that have ArchestrA Symbols. Selecting an object will display all the symbols that object includes. 0 z ‘When embedding a symbol in WindowMaker from an object template, you will be prompted for the name to create a new instance of the selected template, The name needs to be unique since the software will attempt to create a new instance in the Galaxy. If the intent is to add a symbol from an existing instance, then select the instance instead. InTouch for System Platform 2012 R2 35 Module 3 ~ ArchestrA Symbols Basics Selecting Alternate Symbols of the Same Instance ‘Automation Objects can include more than one ArchestrA Symbol. The Select Alternate Symbol feature allows the replacement of an embedded symbol with another symbol belonging to the same instance. ‘This feature is available in both the ArchestrA Symbol Editor and WindowMaker. Note: This function cannot be used with ArchestrA symbols that originate from the Graphic Toolbox, as they are not part of any object To access this feature from the ArchestrA Symbol Editor do one of the following «Select the embedded symbol, go to the Edit menu and select Embedded Symbol | Select Alternate Symbol + Right-click the embedded symbol and select Embedded Symbol | Select Alternate Symbol To access this feature from WindowMaker you can do one of the following: ‘= Select the embedded symbol, go to the Edit menu and select ArchestrA Graphic “" | Select Alternate Symbol ‘+ Right-click the embedded symbol and select ArchestrA Graphic “” | Select Alternate Symbol ‘The Galaxy Browser displays symbols belonging to the same instance an altemate symbol can be selected: . Galmy Browser Rec If the alternate symbol is a different size than the original symbol, a message appears asking ifthe size of the currently inserted ArchestrA Symbol should be retained. Yes will keep the current size of the selected ‘Archestré Symbol, while No will update the size of the selected ArchestrA Symbol to the size of the new ArchestrA Symbol. ‘bo you want oretain the sie of he curen AchestrA Graphic Object? Cele] Tnvensys Learning Sorvicos Section 2—ArchestrA Symbol Editor 3-7 Section 2 - ArchestrA Symbol Editor This section covers the creation and manipulation of graphic objects, lines and outlines, text objects, images, and bitmaps using the ArchestrA Symbol Ecitor. ArchestrA Graphics One of the most powerful features of InTouch for System Platform is the ability to graphically represent Processes using ArchestrA Graphics. A quick way to do so is to embed preconfigured graphics from the ArchestrA Symbol Library. Organizing Symbols in the Toolbox Inthe Graphic Toolbox, organize the symbols by creating a folder hierarchy as with files and folders in Microsoft Windows Explorer. Move symbols around within the folder hierarchy, These folders are called Graphic Toolsets, To create a toolset, in the Graphic Toolbox, right-click on the Galaxy and choose New | Graphic Toolset. The toolset is created and a prompt to rename the toolset appears. InTouch for Systom Platform 2012 R2 3-8 Module 3 - ArchestrA Symbols Basics The ArchestrA Symbol Editor ‘Menu Bar Toolbars Tools| Pane Properties Editor Elements ust Properties Categories Canvas Status Bar ‘Animations. Summary ‘The ArchestrA Symbol Editor includes the following areas: ‘© Toolbars: Includes the Embed Graphic button used to embed preconfigured graphics from the ArchestrA Symbol Library. = Tools Pane: A collection of elements used to create a symbol. ‘* Elements List: A list of named elements on the canvas in a hierarchical view. «Canvas: The area in which elements are moved and placed to create a symbol. ‘Status bar: Includes information about the currently selected element. ‘+ Properties Editor: A list of properties belonging to the currently selected elements), or the. ArchestrA symbol being edited ifthe canvas is selectediclicked. The element can be configured here, or with buttons in the toolbars. + Animation Summary: A list of animations belonging to the currently selacted element It is only visible if an element is selected. Embed preconfigured ArchestrA Graphics from the ArchestrA Symbol Library. Select basic graphical objects, called Elements, from the Tools Panel and draw in the drawing area, called the Canvas. Typical ‘elements are lines, rectangles, elipses, or curves. Change the appearance of elements by accessing their Properties in the Properties Editor or by using the tools in the Graphics Toolbars. ‘Then configure the elements or the symbol with Animations, Scripts, Custom Properties, and more. Tnvensys Leaming Services Section 2—ArchestrA Symbol Editor 3-9 ArchestrA Graphics from the ArchestrA Symbol Library ‘The ArchestrA Graphics located in the Archestr/A Symbol Library graphic toolset, can be used as building blocks for custom ArchestrA symbols, 1. Click the Embed Graphie button baal 2. Select the ArchestrA Graphic from the ArchestrA Symbol Library and clck OK. Galery Bromer ResctorDemo 3. Click the canvas to place the element on the canvas, ‘Add additional elements and configure as desired 5. Once the symbol is saved and checked in, a thumbnail image displays when the mouse hovers over it in the Graphic Toolbox. = gp ResctorDema | & Gharchestra Symbol Lbrary | Camycranhics InTouch far System Platform 2012 R2 3-40 Module 3 — ArchestrA Symbols Basics Tools Pane The Tools pane contains tools to draw symbol elements on the canvas, ‘The Tools pane includes: + Basic objects such as lines, rectangles, polygons, and arcs + Apointer tool to select and move elements on the canvas ‘+ Windows Common controls such as combo boxes, calendar controls, radio button groups and others ‘= Status Element can use fo show quality and status of selected ArchestrA attributes Elements List The Elements List is a list of all elements on the canvas. 4 SwtchzPestiont 4 Chesebuttont = Ri Chsebin Ora 1 res |} | Cement + ime 5 pane panes | | wore BO pate ® © Bi Gout ° g ‘The Elements List is particularly useful for selecting one or more elements that are visually hidden by ‘other elements on the canvas. Use the Elements List to: ‘= See a list ofall elements, groups of elements, embedded symbols and client controls on the + Select elements or groups of elements to work with them «Rename an element or a group of elements Caution: iFan element or @ group Is renamed, the animation references toit are not automatically updated. Manually change all animation links referencing the old name. Tivensys Learning Services| Section 2- ArchestrA Symbol Editor Properties Editor Use the Properties Editor to view and set properties for the selected element or group of elements Properties such as size, location, color and fill style, and runtime behavior can be configured from this pane, Animation Summary Use the animation summary to review, select, and configure the animation behavior of an element selected on the canvas, TnTouch for System Platform 2012 R2 3-14 3-12 Module 3 - ArchestrA Symbols Basics Canvas ‘The canvas is the drawing area, Itis similar to any other image editing software as elements are drawn fon the canvas and adjusted as needed. Drawing Status Elements Use the status element to indicate specific quality and status conditions of attributes, ® Drawing Windows Controls Draw Windows controls on the canvas to add additional functionality to a symbol. Each of the Windows controls has specific behavior when itis drawn. For example, the width of a combo box can be changed, but not the height. 4a dae a Editing Element Properties Control the appearance of an element, a group of elements, or multiple elements with functions on the toolbar or properties in the Properties Editor. The Properties Editor shows the properties common to all selected elements, ‘+ Read-only properties appear in grey ‘+ Non-default values appear in bold "Note: The Properties Edior not only supports values, but also allows Input of coor, fon and Re information in the respective dialog boxes. Tnvensys Learning Services Section 2—ArchestrA Symbol Editor, 3-13 Properties are organized in categories so they can be easily located. The following table shows the categories Property Category Graphic ‘Appearance Fill Style Line Stylo Text Style Runtime Behavior Custom Propertios Purpose Properties Editor Element name or other describing identifiers, ‘Any parameters related to the appearance of the element including location, size, orientation, and transparency. ‘Any parameters related to the fill appearance of the element. Any parameters related to the line appearance of the element. Any parameters related to the text appearance of the element. Element visibilly, tab order, and any other element behavior at run time. ‘Additional user-defined properties that can be associated with any ‘element. TinTouch for System Platform 2012 R2 3-14 Module 3 - ArchestrA Symbols Basics Selecting Elements Select one or more elements by: ‘© Clicking on them with the mouse ‘© Dragging the lasso around them with the mouse ‘+ Selecting them in the Elements List ‘When an element is selected, it appears with handles that enable control over its size and orientation ‘When multiple elements are selected, the last selected element is the primary element. All other previously selected elements are secondary elements, To select multiple elements, press Shift + click or drag the lasso around all of the elements. To change the primary element, simply click on the desired element Selected Element ___Description Primary Element Appears with color-fled handles. Behaves as an active selected element. ‘The point of reference for all operations, such as aligning or spacing multiple elements selected. Secondary Elements Appear with white handles. eee Behave as inactive selected elements. | Follow the edits made to the primary element. eee Tnvensys Learning Services = Lab 5 ~ Creating the Tank Symbol Lab 5 - Creating the Tank Symbol Introduction In this lab, you will configure existing ArchestrA Symbols from the ArchestrA Symbol Library to configure the Tank Object. You will then embed the symbol into an InTouch application and view it in Runtime on a the deployed application. Objectives Upon completion of this lab, you will be able to: Create ArchestrA Symbols within automation objects ‘= Embed ArchestrA Symbols within ArchestrA Graphics ‘+ Configure ArchestrA Symbols with relative references InTouch for System Platform 2012 R2 3-16 Module 3 - ArchestrA Symbols S Create a Level Display In the following steps, you will embed and configure existing ArchestrA Symbols to create a tank graphic that will be used to visualize mixers throughout this training) 4. Return to the ArchestrA IDE, 2. ‘pen its configuration editor (Crores Toatbox 3 © grmarrgisey 2 Gremn 1 Becienywen 3. Click the Graphies tab. Click the Add Symbol button. © Stank Feld tates | cbc ¥omatin | ct | Us | etrsons Soe | S+{[x] Locales R pes GS cape name: Tnvensys Leaming Services In the TrainingGalaxy J Training / Working template toolset, double-click the $Tank template to Lab §~Creating the Tank Symbol 3-17 5. Name the new symbol LevelDisplay, 6. Click the Open button to open the ArchestrA Symbol Editor. © Sion Fetes Copan | Lie | ere Cu | Ba) coven toy 7. Click the Embed Graphic button. InTouch for System Platform 2012 R2 3-18 Module 3 — ArchestrA Symbols Basics OWE ESE) arm feo oI eee F mz iii Lal Ww mu ow Y wv [el ft 1 —w | tape ae as as SS 10. Click on the drawing canvas to place the TankCylinderVertFill symbol on the drawing canvas. iA swendone bdo |) - |Eia.8a Invensys Learning Services 99999009000 ) ) ° ° ~ e 2 Lab 5 ~ Creating the Tank Symbol 11, Right-click on the TankCylinderVertFill symbol and select Custom Properties. 7 ee 12, From the Custom Properties list, select Value. 13. In the Default Value field, delete the existing characters and click the Browse Galaxy (elipsis) 14. On the Galaxy Browser ~ TrainingGalaxy menu bar, click the Relative References button. = [PE [Oe eter: footaw aie tine References OME | instances ‘Agitator_0o1 Tse = | [aus = Toa @ papa Sou Cato corde TaTouch for System Platform 2012 R2 3-19 3-20 Module 3 - ArchestrA Symbols Basics 15, From the Relative References list, select Me and select the attrbute LT.PV. FE ctor feveciey lew fT Att met [et |i Bom] “E reat Referees ne as ate wrens cor 16, Click OK. 17, From the Custom Properties lst, select Min, 18.1 in the Default Value field, delete the existing characters and click the Browse Galaxy (elipsis) button. 19, Click the Relative References button. 20. Check Show alll attributes. LS Pee cee oe ‘eine wt saint hor tree Tnvensys Learning Services| ~ Lab 5 — Creating the Tank Symbol 3-21 = 24. Expand the width of the Attribute field column so you can read the entire attribute name. 2. Scroll down and select the attribute LT.PV.EngUnitsMin. - paabas econ nepal “Ena roc es 5 eee eee oS SE . ies Be ant cotare ~ Er a sa ake aes = Bemetomgten tar wieanlae cafe Sumacanae” One wns va Hecimitccaette feos ete camer coe ‘ 23. Click OK: 24, From the Custom Properties list, select Max * 25. In the Default Value field, delete the existing characters and click the Browse Galaxy (ellipsis) = button ° 26. Click the Relative References button. * 27. Scroll down and select the attribute LT.PV.EngUnitsMax, ° a a ‘e © EE © ae [raroey a? en Se oo sero oem Emmett | er Tapowe | “Lan Reowens > | 28. Click OK eee Touch for System Platform 2012 R2 3-22 Module 3 — ArchestrA Symbols Basics 29, From the Custom Properties lst, select EngUnits, 20, In the Default Value field, delete the existing characters and click the Browse Galaxy (ellipsis) button, 31. Click the Relative References button. 22. Scroll down and select the attribute LT.PV.EngUnits, E(B] © olow fremeoiy Sd feed | ‘arto vse | hone Bo | to Tabor | Relative References pair = j ote 33, Click OK. 34, Click OK to close the Custom Properties dialog box. ‘Custom Properties + = EngUnits TankCylinderVert... a einai si aa — = —— mT s = =—__—s— = le 35. Save and Close the $Tank LevelDisplay symbol Tnvensys Learning Services| 9193393393539 9339 ) ) ting the Tank Symbol_ 3-23 _—S— A ——_ 2 8 Creating the Tank Symbol Create a Temperature Display ‘Add an analog meter symbol from the ArchestrA Symbol Library and configure it to display the temperature in the tank 36. Click the Add Symbol bution and name it TempDisplay. 37. Click the Open button to open the ArchestrA Symbol Editor. o aaa ‘seeeaes| cette Sows He Eamon ates | Sabo 38. Click the Embed Graphic button 38. In the Graphic Toolbox, expand TrainingGalaxy / ArchestrA Symbol Library and select Analog Meters. 40. Select the AnalogMeterRound symbol and click OK, ee Ue amie aD © crite seseares © tet teny ESsy 4 a lesen) eel ‘ctretons mee Wa fal “InTouch for System Platform 2012 Re 3-24 Module 3 ~ ArchestrA Symbols Basics 41. Place the AnalogMeterRound symbol on the drawing canvas, 42. Right-click the AnalogMeterRound symbol and select Custom Properties, 43, From the Custom Properties list, select Value. 44, Repeat Steps 13 ~ 28 to configure the following custom properties for the AnalogMotorRound symbol Custom Propertios Default Value Value MeTT.PV Min. Me.TT.PV.EngUnitsMin Max Me.TT.PV.EngUnitsMlax. Custom Properties re ‘AnalogMete Roun. fee ee as s = ane eae eT TESE J} a 45. Click OK to close the Edit Custom Properties dialog box 46. Save and Close the $Tank TempDisplay symbol Invensys Leaming Services Lab 5~Creating the Tank Symbol_ 3-25 Create the Tank Display Combine symbols to configure the tank cispiay that will represent the mixers in your application 47. Click the Add Symbol button and name it TankDisplay. 48. Click the Open bution to open the ArchestrA Symbol Editor @ Stank * Pk eres | cet nterstn | Sete | nes: | extension thes SAog cal apis CGraphicname: TarkDieplay 49. Click the Embed Graphic button. ape JP Je. uls so Bul, 50, Click the Relative References button. 51, Select the LevelDisplay symbol and click OK. TaTouch for System Platform 2012 R2 3-26 _Module 3 ~ ArchestrA Symbols Basics 52. Place the Le IDisplay symbol on the drawing canvas. i) ‘Gatti Ek ven Arange Fornat soetal hp Ge seveendchse Kd O99 =| ELK a 53. Click the Embed Graphic button again. 54. Select the TempDisplay symbol and click OK. oe ce Peter, Tnvensys Learning Services se Lab 5—Creating the Tank Symbol 3-27 55. Place the TempDisplay symbol on top of the tank. Resize and position it appropriately. 57. Save and Close the $Tank template and check in the object. Tn Touch for System Platform 2012 Re 3-28 _Module 3~ ArchestrA Symbols Basics Add the Tank Display to InTouch Place the TankDisplay symbol on the Mixer window. 58. In the Working template toolset, double-click the $MixerView template to open WindowMaker. Grenaets Tootor © gerry 2 Giterean beverage 2 itmny 59. In the Windows to Open dialog box, check the following windows to open and click OK. © Main © Mixer + Navigation eee! | _betle | _Sabant | cen 60, Click the Embed ArchestrA Graphic bution. 61. Click the Instances button. 62. From the Instances list, select M4xx ‘The examples in this training manual will show M400. Yours will reflect your student number. 63. Select the TankDisplay symbol and click OK. Tavensys Leaming Services| Lab 5-Creating the Tank Symbol_ 3-29 64. Place the TankDisplay symbol on the Mixer window. InTouch for Systom Platform 2012 R2 3-30 _Module 3 ~ ArchestrA Symbols Basics Test in Runtime Test the TankDisplay symbol in runtime, 65. Click Runtime. 66. Verify that the TankDisplay symbol is displaying live data, 67. Click Development to return to InTouch WindowMaker. 68. Save and Close WindowMaker and check in the object. 69, In the ArchestrA IDE, in Deployment view, right-click the MixerView_001 and select Deploy. Invensys Leaming Services Lab 5 — Creating the Tank Symbol 70. Retain all defaults and click OK, F casaotelyy TF iviseRetecet ine Dethy Ob Cats | Smart soe bts © ip 7 DaoyChngee Rey Cit FF raceoft om 71. Click Close when complete. ey elt [ducing haber pc's bing depo eur fn pe irs antigen ta onl oy patoaa 72, Switch back to the visualization station pplication. ‘The following message will appear: 73, Click Yes to restart Window Viewer. ‘Single Node: Open the InTouch Application Manager and Stan WindowViewer for the SMixerView InTouch for System Platform 2012 R2 3-31 3-32 _Module 3 ~ ArchestrA Symbols Basics ‘Once WindowViewer restarts you should see the TankDisplay symbol with live data Tavensys Learning Services Section 3— Basic Tools and Animations _ 3-33 Section 3 - Basic Tools and Animations This section provides a brief overview of the text element, working with text, and basic animation Text Tools ‘Text tools are items on the canvas that can be edited to include or modify written text. The font, alignment, and style of the text element can also be changed, The too's that will be discussed in this ‘section are all considered to be text tools because of these features, Placing Text" ‘The text element has no border and no background fil. The text does not wrap. When typing the text, the size of the Text element expands. Drag the handles of the Text element to resize it Drawing Text Boxes [! Draw text boxes on the canvas. Text boxes can have borders and backaround fil Edit Text Objects ‘The font, font style, font size, justification, and rotation of any selected text object can be configured in the ArchestrA Symbol Editor by using the Properties categories. ‘Tn Touch for System Platform 2012 R2 3-34 _Module 3 ~ ArchestrA Symbols Basics Text Objects: Substitute Strings Select the text object. 2, Choose either Special | Substitute Strings, right-click the text object and select Substitute Strings, or press the Ctri+L keys. 3, In the New field, enter the new text sting or strings, or choose Find & Replace to edit just a word ‘or phrase within the text object(s. 4. Click OK. ce Noto: Use the Substitute String command on strings that are included in a symbol to change the label on buttons drawn with the Button tool Tnvensys Learning Services ‘Section 3~ Basic Tools and Animations 3-35 Edit Animations Select an element, and then cick the Edit Animations button [BB toad, emmove, and view animations. : Eat Animation After an animation is selected, its parameters can be configured. InTouch for System Platform 2072 R2 3-36 _Module 3 ~ ArchestrA Symbols Basics Value Display Use the Vaiue Display animation to specify a Discrete, Analog, String, Time, or Name expression to display at Runtime. Eat Animations Invensys Learning Services Section 4 ArchestrA Symbols in Contained Objects 3-37 Section 4 -— ArchestrA Symbols in Contained Objects This section provides a brief overview of how to use ArchestrA symbols in a contained object within a ‘symbol in the container object Creating Contained Templates Containment is the relationship in which one object includes another, Containment relationships organize objects in a hierarchy. Build objects that represent complex devices consisting of smaller, simpler devices. In scripts, these objects can be referred to by the name that derives from the containment relationship. This name is called a hierarchical name. ‘The name of the contained object can be changed, though, within the scope of the hierarchy. Contained ames can be up to 32 alphanumeric or special characters, Using § to begin a container name is reserved for templates. The second character cannot be $ and the name must include at least one letter. Do not use spaces. ‘The contained name of a contained object only has to be unique in the context ofits container. An object ccan have three kinds of names if itis contained by another object. The three names include; Name. Description. = Tag name ‘The unique name of the individual object. For example, Valvet Contained name ‘The name of the object within the context ofits container object. For example, the object whose tag name is Valve1 may also be referred to as Tankt.Outlet, if Tank? contains it and it has the contained name “Outlet.” Hierarchical name Hierarchical names that are fully-qualified names of a contained object include the name of the objects that contain it. Because the object that contains it may also be contained, there are potentially multiple hierarchical names that refer to the same object. For example, if: teactor” contains Tankt (also known within Reactor1 by its contained name "SurgeTank’) ‘ank1" contains Valvet (also known within Tankt by its contained name "Outlet’), Valvet could be referred to as: + "Valvet" + "Tank! Outlet” + _"Reactort SurgeTank Outlet” ae LE InTouch for System Platform 2012 R2 3-38 _Module 3 ~ ArchestrA Symbols Basics Higher level objects contain lower level objects. This allows users to more closely model complex plant equipment, like tank systems. Users can nest templates to 10 levels, inlet Valeo Note: Objects can only contain objects like themselves, For example, ApplicationObjects can only be contained by other ApplicationObjects. Areas can only contain other Areas, Tivensys Leaming Services Section 4— ArchestrA Symbols in Contained Objects 3-39 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. Containment can only be used with derived templates. ‘An example of a containment hierarchy is a tank that contains the following objects: © Inlet Valve Agitator Inlet Valve © Outi Valve + Level ‘Tank Tempiate Example: a inervane LA ‘ise eS ‘Oatetvave eS oe sss TnTauch for System Platform 2012 R2 3-40 _Module 3 - ArchestrA Symbols Basics ‘To enable referencing and flexibility within scripting, these objects can be referenced in several different ways, Each object has a unique tag name, such as: ‘+ Inlet Valve = InletValve0t + Agitator = Agitator0t = Outlet Valve = OutletValveot + Level = Levelo1 Example of Referencing: Tank = TankO1 a Agitator Gutletvalve = OutletValveot me) Level = Levelo ‘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, Tavensys Leaming Services Section 4 ~ ArchestrA Symbols in Contained Objects 3-41 For example, an instance of @ $Tank is named Tank01. An instance of $Valve called Valve01 is contained within the instance of $Tank. Change the contained name of Valve01 to InletValve. Now Valve0t can also be referred to by its hierarchical name Reactort InletValve. ‘So ifthe tank is named Tank01, the contained names are: © TankOt Inlet = Tank01 Agitator © TankOt.Outiet © Tank0t.Level ‘Tank = TankOL inlet Valve = TankOL.Inletvalve ete Agitator Pek utiet vale @ mee Se Level = Tankot.Levelot TinTouch for System Platform 2012 R2 3-42 Module 3 ~ ArchestrA Symbols Basics ‘This naming convention adds context to the instances contained by Tank01 ‘Bey BBE Mew Cae Urn tH PROUS A660 BUXRSeGeveow (pTaeplte Toot + # x{[ © tnetvoiveor Reex oem 21) cone se | ss tnt |e [SETTERS] sous [uns [eceare|_| 9 far _ et (Sob tau) {@ tet] Sousa Coutenve) ey f tbs |S teomee [uso] ae ists cy Sacanetonws aD ‘Adcitionally, use containment references in scripts such as: ‘+ Me.Outlet: Allows a script running within the parent object to generically reference its child outiet instance ‘+ MyContainer.Iniet: Allows a scriot running in any of the children instances to reference another child instance named Inlet that belongs to the same parent Invensys Leaming Services Lab 6 ~ Creating the Mixer Display 3-43 Lab 6 - Creating the Mixer Display Introduction In this lab, you will embed and configure a number of existing graphics to create a fully functioning display for a Mixer that will be used throughout this training Objectives Upon completion of this lab, you will be able to: ‘+ Configure and use embedded Archestr Symbols in a containment relationship InTouch for System Platform 2012 R2 3-44 Create the Mixer Display In the following steps, you will embed and configure the graphics to create the Mixer Display. 1 In the ArchestrA IDE TrainingGalaxy / Training / Working template toolset, expand the SMixer template, 2. Double-click the Agitator template to open its configuration editor. Dromore Toate Click the Graphics tab. Click the Add Symbol button. Name the new symbol Display. Click the Open button to open the Archestr Symbol Editor. © Sree Aamator™ ‘coneral| seates | ones | ouput | Aas | obec iformaten | souks | uDAs | Extensons Geis | S260 mee a 7. Click the Embed Graphic button. (Gephe Cat New Brags Femit Siecl He Seder a6 I Aes sie BULA Tavensys Leaming Services Module 3 ~ ArchestrA Symbols Basics Lab 6 ~ Creating the Mixer Display 3-45 8. Click the Graphic Toolbox button, 8. Expand TrainingGalaxy ! ArchestrA Symbol Library and select Pumps. 10. Select the PumpVert symbol and click OK. 11, Place the PumpVert symbol on the drawing canvas. 12, Right-click on the PumpVert symbol and select Custom Properties. ae “InTouch for System Platform 2012 R2 3-46 _Module 3 ~ ArchestrA Symbols Basics 13, 14 15, 16 Configure the Value custom property as follows: Default Value: Me PV.IsActivet = cum ES 2 a ete) Click OK to close the Custom Properties dialog box. ‘Save and Close the $Mixer Agitator Display symbol e704 azoo oeeo BaD wapo Bi7e> ese i ‘Save and Close the SMixer Agitator template and check in the object. Tnvensys Learning Services pe Lab 6 ~Creating the Mixer Display 3-47 17. In the ArchestrA IDE, TrainingGalaxy / Training / Working template toolset, double-click the $V ‘template to open its configuration editor. Gtewekterooboe | a © gr tenagcy scan c 2 Howes aga 18. Click the Graphics tab. 5 419. Click the Add Symbol button 20. Name the new symbol Display. 21. Click the Open button to open the ArchestrA Symbol Editor. ae “= wd | | rt | tt | Aare te een | sth [ena Ss Sab) 2. Click the Embed Graph 23. Expand TrainingGalaxy / ArchestrA Symbol Library and select Valves. 24, Select the ValvePositioner symbol and click OK button, TnTouch for System Platform 2012 R2 3-48 Module 3 ~ ArchestrA Symbols Basics 25. Place the ValvePositioner symbol on the drawing canvas, 26. Right-click the ValvePositioner symbol and select Custom Properties. ict £8 Aare Fo a AA aa iew 27. Configure the Value custom property as follows: Default Value: (Me.PV.IsInTransition“50)+(Me.PV.IsActive1*100) Cay ValvePositionert 5» Liv. ‘Custom Properties tron etan seni eet) 28, Click OK to ciose the Edit Custom Properties dialog box. 28, Save and Close the $Valve.Dispiay symbol 30. Save and Close the $Valve template and check in the object, Invensys Learning Services Lab 6—Creating the Mixer Display 3-49 31. In the ArchestrA IDE TralningGalaxy / Training / Working template toolset, double-click the $Mixer template to open its configuration editor. tab. 33. Click the Add Symbol button. 34, Name the new symbol TP4 Display. 35, Click the Open button to open the ArchestrA Symbol Editor. 36, Click the Embed Graphic button, 37, Expand TrainingGalaxy / ArchestrA Symbol Library and select Pumps. 38, Select the PumpCentrifugal symbol and click OK. ‘InTouch for System Platform 2072 R2 3-50 _Module 3 ~ ArchestrA Symbols Basics 39. Place the PumpCenttifugal symbol on the drawing canvas, 40, Right-click on the symbol and select Custom Properties, 2 okate ene ao i Oa cow oatic on ix pew ow Tmeorn , tnediedSmicl ene > EB emermanre.. ora suse 41, Configure the Value Custom Property 2s follows: Default Value: Me.TP1.PV Custom Properties Value PumpCentrfugalt ee | Fister = ae Einar = Boe dna a ae 7 al 7... ¢ nenorenynices ee SESE 4 42, Click OK to close the Edit Custom Properties dialog box Invensys Learning Services ae Lab 6 — Creating the Mixer Display 3-51 43, From the Tools pane, select the Text tool 44. On the drawing canvas, directly under the pump, place a text element that displays the text Stat 48. Click the drawing canvas, and then select the text 46. On the menu bat, click the Increase Font Size button three times to make the font size larger. 47. On the menu bar, click the Align Text button and select Center to center justify the text as chown below. InTouch for System Platform 2072 R2

You might also like