You are on page 1of 66

InTouch ArchestrA Integration

Guide

Invensys Systems, Inc.

Revision A
Last Revision: 4/23/07

Copyright
© 2007 Invensys Systems, Inc. All Rights
Reserved.

** DRAFT COPY **
All rights reserved. No part of this documentation shall be reproduced, stored in a
retrieval system, or transmitted by any means, electronic, mechanical,
photocopying, recording, or otherwise, without the prior written permission of
Invensys Systems, Inc. No copyright or patent liability is assumed with respect to
the use of the information contained herein. Although every precaution has been
taken in the preparation of this documentation, the publisher and the author
assume no responsibility for errors or omissions. Neither is any liability assumed
for damages resulting from the use of the information contained herein.
The information in this documentation is subject to change without notice and does
not represent a commitment on the part of Invensys Systems, Inc. The software
described in this documentation is furnished under a license or nondisclosure
agreement. This software may be used or copied only in accordance with the terms
of these agreements.

Invensys Systems, Inc.


26561 Rancho Parkway South
Lake Forest, CA 92630 U.S.A.
(949) 727-3200
http://www.wonderware.com
For comments or suggestions about the product documentation, send an e-mail
message to productdocs@wonderware.com.

Trademarks
All terms mentioned in this documentation that are known to be trademarks or
service marks have been appropriately capitalized. Invensys Systems, Inc. cannot
attest to the accuracy of this information. Use of a term in this documentation
should not be regarded as affecting the validity of any trademark or service mark.
Alarm Logger, ActiveFactory, ArchestrA, Avantis, DBDump, DBLoad, DT Analyst,
FactoryFocus, FactoryOffice, FactorySuite, FactorySuite A2, InBatch, InControl,
IndustrialRAD, IndustrialSQL Server, InTouch, MaintenanceSuite, MuniSuite, QI
Analyst, SCADAlarm, SCADASuite, SuiteLink, SuiteVoyager, WindowMaker,
WindowViewer, Wonderware, and Wonderware Logger are trademarks of Invensys
plc, its subsidiaries and affiliates. All other brands may be trademarks of their
respective owners.

** DRAFT COPY **
3

Using this Document...........................................................7


Typographic Conventions....................................................7
Contacting Support .............................................................8

Chapter 1 About InTouch ArchestrA Integration ......... 9


Overview of InTouch ArchestrA Integration .....................9
IDE-Managed InTouch Applications................................11
Differences to Stand Alone InTouch Applications ........11
InTouchViewApp Object ................................................13
InTouch Data Storage ................................................13
Restrictions of the InTouchViewApp Object .............14
Editing the IDE-Managed InTouch Application.......15
Testing the IDE-Managed InTouch Application.......15
Deploying the InTouchViewApp Object ....................15
Exporting the InTouchViewApp Object ....................16
Converting IDE-Managed InTouch Applications to Un-
managed InTouch Applications ...............................16
Importing the InTouchViewApp Object ....................17
Importing a Stand Alone InTouch Application.........17
Renaming the InTouchViewApp Object ....................17
Attributes of the InTouchViewApp Object................18
Exporting and Importing Tag Data Associated with an
IDE-Managed InTouch Application ........................18
ViewEngine Object .........................................................18
ArchestrA Symbols ............................................................18
Creating ArchestrA Symbols .........................................18
Inserting ArchestrA Symbols in InTouch Windows .....19
Creating New Automation Instances Automatically....19
Symbol Change Propagation..........................................19
Symbol Dynamic Size Propagation................................20
Overview Diagram..........................................................21

Chapter 2 Managing InTouch Applications with IDE.... 23


Starting the ArchestrA IDE from Application Manager .24
Creating an IDE-Managed InTouch Application.............24
Starting WindowMaker from the ArchestrA IDE ...........25
Submitting the Changes of an InTouch Application .......26
Importing an InTouch Application ...................................27
Importing and Exporting the InTouchViewApp Object ..29
Exporting an IDE-Managed InTouch Application as an
Unmanaged InTouch Application .................................30
Deleting the IDE-Managed InTouch Application ............31

InTouch ArchestrA Integration Guide

** DRAFT COPY **
4

Exporting and Importing Tag Data..................................31

Chapter 3 Using ArchestrA Symbols in WindowMaker..33


Inserting ArchestrA Symbols into an InTouch Window .34
Inserting ArchestrA Symbols from Objects Templates 34
Inserting ArchestrA Symbols from Instances...............36
Inserting ArchestrA Symbols from the Graphic
Toolbox........................................................................36
Configuring ArchestrA Symbols in WindowMaker .........37
Configuring WindowMaker Animation Links of an
ArchestrA Symbol ......................................................38
Connecting ArchestrA Symbols with InTouch
Tagnames ...................................................................40
Selecting an Alternate Instance from the Same
Parent .........................................................................46
Selecting Alternate Symbols of the Same Instance......46
Substituting Strings in an ArchestrA Symbol..............47
Substituting References in an ArchestrA Symbol ........48
Resizing the Inserted ArchestrA Symbol to its Original
Size .............................................................................48
Enabling or Disabling Dynamic Size Change of Inserted
ArchestrA Symbols ....................................................48
Editing ArchestrA Symbols in the ArchestrA Symbol
Editor ..............................................................................49
Editing an Inserted ArchestrA Symbol.........................49
Accepting Symbol Changes in WindowMaker ..............50
Accepting Symbol Changes in WindowViewer .............51
Testing ArchestrA Symbols in WindowViewer................51
Creating a New Automation Instance..............................53

Chapter 4 Using IDE-Managed InTouch Applications at


Run Time .........................................55
Deploying an IDE-Managed InTouch Application ..........56
Deploying the InTouchViewApp Object for the First
Time ............................................................................56
Deploying Changes to the IDE-Managed InTouch
Application .................................................................56
Starting the IDE-Managed InTouch Application ............57
Accepting New Application Versions at the Operator
Node ................................................................................58
Running ArchestrA Scripts in Inserted ArchestrA
Symbols...........................................................................60

InTouch ArchestrA Integration Guide

** DRAFT COPY **
5

Deploying the InTouchViewApp Object in a Terminal


Services Environment ....................................................61

Index .............................................. 63

InTouch ArchestrA Integration Guide

** DRAFT COPY **
6

InTouch ArchestrA Integration Guide

** DRAFT COPY **
7

Welcome

Welcome to the InTouch ArchestrA Integration Guide! This


documentation shows you how ArchestrA Integrated
Development Environment (IDE) can manage InTouch
applications so that you can effectively use the new
functionality introduced by the ArchestrA Symbol Editor.

Using this Document


You can view this document online or you can print it, in part
or whole, by using the print feature in Adobe Acrobat Reader.
This documentation assumes you know how to use Microsoft
Windows, including navigating menus, moving from
application to application, and moving objects on the screen.
If you need help with these tasks, see the Microsoft Help.
In some areas, you can also right-click to open a shortcut
menu. The items listed on this menu change, depending on
where you are in the product. All items listed on this menu
are available as items on the main menus.

Typographic Conventions
This documentation uses the following conventions:

Convention Used for

Initial Capitals Paths and file names.


Bold Menus, commands, dialog box names,
and dialog box options.
Monospace Code samples and display text.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
8 Welcome

Contacting Support
Wonderware Technical Support offers a variety of support
options to answer any questions on Wonderware products
and their implementation.
Before you contact technical support, refer to the relevant
section(s) in this guide for a possible solution to any problem
you have with the IDE. If you need to contact technical
support for help, have the following information ready:
• The type and version of the operating system you are
using. For example, Microsoft Windows XP, SP1.

• Details of how to recreate the problem.

• The exact wording of the error messages you saw.

• Any relevant output listing from the Log Viewer or any


other diagnostic applications.

• Details of what you did to solve the problem(s) and your


results.

• If known, the Wonderware Technical Support case


number assigned to your problem, if this is an ongoing
problem.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
9

Chapter 1

About InTouch ArchestrA


Integration

This section explains the concepts and capabilities of the


integration of ArchestrA and the InTouch HMI.

Overview of InTouch ArchestrA Integration


You can integrate applications and graphics between
ArchestrA and InTouch. You can:
• Use the ArchestrA Integrated Development Environment
(IDE) to manage InTouch applications instead of the
InTouch Application Manager.

• Use the ArchestrA Symbol Editor within the ArchestrA


IDE to create ArchestrA symbols, which you can also use
in InTouch WindowMaker.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
10 Chapter 1 About InTouch ArchestrA Integration

ArchestrA IDE InTouch WindowMaker

Stand Alone
InTouchViewApp Imports and Exports Manages
InTouch Applications
Automation
Object (Template)

Manages
IDE-Managed InTouch
Provides Applications
ArchestrA
Symbols
ArchestrA Symbol InTouch
Derive
Editor Application Manager
InTouch WindowViewer

Provides
ArchestrA Test Application
Symbols

InTouchViewApp
Automation
Starts
Object (Instance) Creates IDE-Managed InTouch Starts
Application Directory Applications

Instead of creating an InTouch application with visualization


objects in WindowMaker that connect to plant data and also
to ArchestrA Galaxy objects which you can configure
independently, you can now:
• Develop the visualization directly in the IDE with the
ArchestrA Symbol Editor.

• Use the IDE to start WindowMaker.

• Insert the ArchestrA Symbols on to your InTouch


windows.
• Test the InTouch application in WindowViewer.

Additionally, you can start the ArchestrA IDE directly from


Application Manager.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
IDE-Managed InTouch Applications 11

The following diagram shows you the workflow of using


InTouch and ArchestrA in this new way:

InTouch
ArchestrA Symbol
Application WindowMaker WindowViewer ArchestrA IDE
Editor
Manager

1. Install InTouch ArchestrA IDE

2. Licensing FactorySuite License

Start ArchestrA IDE


3. Launching and create new
Galaxy

Create ArchestrA
4. Creating Symbol Symbol

5. Configuring ArchestrA Configure and deploy


Objects ArchestrA objects

Derive
6. Creating InTouch App. InTouchViewApp
Template

Start WindowMaker
7. Adding Tags etc. and add tags etc.

Select ArchestrA
8. Embedding Symbols Symbol with Galaxy
Browser

Configure Custom
9. Configuring Symbols Properties

Test Application in
10. Testing Application WindowViewer

IDE-Managed InTouch Applications


You can manage your InTouch applications using ArchestrA.
These applications are called IDE-managed InTouch
applications.
Unlike stand alone InTouch applications that are managed
by the InTouch Application Manager, they are better
integrated into the ArchestrA environment and support
advanced graphics.
They are not fully interchangeable with stand alone InTouch
applications and can only be interchanged by importing and
exporting.

Differences to Stand Alone InTouch Applications


Stand Alone InTouch applications appear in the InTouch
Application Manager as Stand Alone and you can edit them
by selecting them and clicking the WindowMaker icon.
IDE-managed InTouch applications appear in the InTouch
Application Manager as Managed and can only be edited by
starting WindowMaker from within the IDE.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
12 Chapter 1 About InTouch ArchestrA Integration

Unlike stand alone InTouch applications, with IDE-managed


InTouch applications you cannot:
• Create an application with the InTouch Application
Manager.
• Start an application in WindowMaker from the InTouch
Application Manager.

• Use DBLoad or DBDump to import or export the


tagname dictionary of an IDE-managed InTouch
application.

• Change the properties of an IDE-managed InTouch


application.

• Rename IDE-managed InTouch applications in the


InTouch Application Manager.

• Configure security settings in the Configure Security


dialog box of the IDE while an IDE-managed InTouch
application is opened for editing in WindowMaker.

• Use retention if you are working with multiple


applications on the same node. This is because all
IDE-managed InTouch applications use the same
working directory and all files are replaced when you
switch from one application to another.
However you can work around this behavior with the
following steps:

a Open the IDE-managed InTouch application with


WindowMaker from the IDE.
b On the Special menu, point to Configure, then
WindowViewer. The WindowViewer Properties dialog
box appears.
c Click the Managed Application tab and enter a unique
existing directory in the Local Working Directory box.
• Use the DB Dump and DB Load functions of Application
Manager. Instead use the DB Dump and DB Load
functions that are specific to the managed InTouch
application from within the IDE.

You can however:


• Read the properties of an IDE-managed InTouch
application.
• Fast-switch between WindowMaker and WindowViewer
to test and develop the application.
• Change the node properties in the InTouch Application
Manager.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
IDE-Managed InTouch Applications 13

• Close the IDE. WindowMaker attempts to close and may


prompt you to save any changes. If you started
WindowViewer from within WindowMaker, it also closes.

• Edit the InTouch application in its original resolution


without having to convert it.

• Determine how WindowViewer on the target nodes


handle a redeployment of InTouchViewApp instances.
This is similar to Network Application Development
(NAD).

InTouchViewApp Object
ArchestrA manages your InTouch applications with a specific
type of ArchestrA object called the InTouchViewApp object.
An InTouchViewApp template references one specific
IDE-managed InTouch application.
However, a number of limitations apply on what you can do
with the InTouchViewApp compared to other automation
objects. For more information, see Restrictions of the
InTouchViewApp Object on page 14.

InTouch Data Storage


The InTouchViewApp object contains the following
information:
• Reference to the IDE-managed InTouch application
folder.

• Other behavior-specific information of the IDE-managed


InTouch application.

The object does not contain the InTouch application data,


such as the tagname configuration and values, but when it is
exported, the resulting .aaPKG file contains the InTouch
application.
Like other ArchestrA automation objects, the
InTouchViewApp can be checked-out and checked-in again.
This ensures that only one person can edit the associated
managed InTouch application at any one time.
The IDE-managed InTouch application itself is stored in two
separate folders in the file repository:
• The last checked-in version of the InTouch application.

• The last checked-out version of the InTouch application.

When you deploy the InTouchViewApp instance to a target


node, the InTouch application is contained in:
• A folder on the development node.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
14 Chapter 1 About InTouch ArchestrA Integration

• A folder on the target node from which the InTouch


application is run.

Restrictions of the InTouchViewApp Object


The InTouchViewApp object is unlike other Automation
objects. You cannot perform some operations that you would
normally do with other Automation objects.

InTouchViewApp Object – Permitted Operations

InTouchViewApp base
template

$InTouchViewApp Derive instances?

Configure?
Derive templates

InTouchViewApp
template derived from
base template
$MyInTouchViewA
$MyInTouchViewA
$MyInTouchView
pp_Template WindowMaker
pp_Template Configure
App_Template
O
pe
ns

Derive Instances Configure?


InTouchViewApp
instance derived from
template
MyInTouchViewAp
MyInTouchViewAp
MyInTouchView
p_Instance
p_Instance
App_Instance

You cannot:
• Configure an InTouchViewApp instance. Only derived
InTouchViewApp templates can be configured. If you
attempt to configure an InTouchViewApp instance, you
can select to open associated derived InTouchViewApp
template instead.

• Derive templates from an InTouchViewApp template


that is already derived.

• Derive instances directly from the InTouchViewApp base


template.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
IDE-Managed InTouch Applications 15

• Change the association between the InTouchViewApp


and the InTouch application. You must delete the
template and all instances and recreate them.

• Open more than one InTouchViewApp template for


configuration at a time on one node. This is because you
can only run one instance of WindowMaker at one time.

• Use ArchestrA security in InTouch, if InTouch only uses


the Galaxy as a provider of ArchestrA symbols. In order
to use ArchestrA security, you must at least deploy a
Winplatform to the node on which the deployed
IDE-managed InTouch application is running.

Editing the IDE-Managed InTouch Application


You can edit the IDE-managed InTouch application with
WindowMaker as with stand alone InTouch applications.
The only difference is that you:
• Open the editor of the InTouchViewApp template to
start the associated InTouch application in
WindowMaker.
• Close WindowMaker after making changes to the
InTouch application, which checks the
InTouchViewApp object in again.

Testing the IDE-Managed InTouch Application


You can test the IDE-managed InTouch application with
WindowViewer as with stand alone InTouch applications.
From the IDE-managed InTouch application that is open in
WindowMaker, you can fast-switch to WindowViewer and
back to WindowMaker again.

Deploying the InTouchViewApp Object


After you derive an instance of your InTouchViewApp
template (not the base template), you can assign it to the
target platform under a ViewEngine object.
You deploy the InTouchViewApp object. If you open the
InTouch Application Manager on the target node, the
associated IDE-managed InTouch application appears in the
list together with the timestamp of its last deployment in the
Date Modified column.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
16 Chapter 1 About InTouch ArchestrA Integration

You can only start the IDE-managed application in


WindowViewer. When WindowViewer is started, it copies the
application to a special folder that it uses for run time. This
folder is, for example, c:\documents and settings\all
users\application data\archestra\managedapp.

IDE-Managed InTouch Applications


INTEGRATED DEVELOPMENT ENVIRONMENT INTOUCH

$InTouchViewApp
Base Template

Shared

DERIVATION
Checked-Out
Version

$MyITViewApp
Derived Template CHECK OUT

WindowMaker
CHECK IN

Checked-In
DERIVATION Version Application
Manager

DEPLOYMENT Run-Time STARTS


Version

MyITViewApp_001 Deployed
Derived Instance Version
WindowViewer

Exporting the InTouchViewApp Object


You can export the InTouchViewApp object. You would do
this, for example, to use the IDE-managed InTouch
application together with its hosting InTouchViewApp object
in other Galaxies.
When you export the object, a package file is created
containing information about the object and also the
associated IDE-managed InTouch application.

Converting IDE-Managed InTouch Applications to


Unmanaged InTouch Applications
You can convert an IDE-managed InTouch application to an
unmanaged InTouch application by exporting the InTouch
application that is managed by the InTouchViewApp object.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
IDE-Managed InTouch Applications 17

When you export the InTouch application, a folder is created


containing the InTouch application itself and possibly
inserted ArchestrA symbols.
If you export the IDE-managed InTouch application for use
as an unmanaged InTouch application, you cannot:
• Open the inserted ArchestrA symbols in the ArchestrA
symbol editor.

• Configure inserted ArchestrA symbols to use alternate


symbols.

• Configure inserted ArchestrA symbols to use the same


symbol of a different Automation instance.

• Change any custom properties of the ArchestrA symbols.

• Re-associate the unmanaged InTouch application with


another InTouchViewApp object.

You can however:


• Still communicate with the Galaxy via the ArchestrA
symbol. You can, for example, write data back to the
Galaxy or visualize data.

• Perform regular InTouch operations on them, such as


copying, cutting, pasting, duplicating, moving, resizing,
flipping, rotating and configuring them with a few
InTouch animation links.

Importing the InTouchViewApp Object


When you import an InTouchViewApp object, the ArchestrA
IDE imports the InTouchViewApp object itself as well as the
IDE-managed InTouch application.

Importing a Stand Alone InTouch Application


You can import a stand alone InTouch application to use as
an IDE-managed InTouch application. The advantage is that
you can use the sophisticated ArchestrA Symbol Editor to
enhance existing applications with enhanced functionality
and animations that are not possible with WindowMaker
alone.

Renaming the InTouchViewApp Object


You can rename the IDE-managed InTouch application or
the InTouchViewApp object. Renaming the InTouchViewApp
object has no impact on the associated InTouch application.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
18 Chapter 1 About InTouch ArchestrA Integration

Attributes of the InTouchViewApp Object


You can use the ArchestrA attributes of the InTouchViewApp
object to access the run-time data of the tagnames of the
associated InTouch application. This is useful for using
InTouch data directly in the Galaxy namespace and replaces
the purpose of the InTouchProxy object.

Exporting and Importing Tag Data Associated with an


IDE-Managed InTouch Application
You can export tag data that is associated with an
IDE-managed InTouch application to a *.csv file. This is
equivalent to the DB Dump function of the InTouch
Application Manager.
You can import the exported tag data from a *.csv file back
into an IDE-managed InTouch application in the same way
as the DB Load function.
The exported *.csv files from the IDE-managed InTouch
application and those of the stand-alone InTouch
applications are fully interchangeable.

ViewEngine Object
The ViewEngine is an ArchestrA object that manages session
and security information for the running InTouchViewApp
instances and the terminal service sessions.
A platform can host multiple ViewEngine objects, every
InTouchViewApp must be assigned to a ViewEngine.
You cannot create multiple instances of the same
InTouchViewApp template to run under the same
ViewEngine object. But you can run instances from different
templates under the same ViewEngine object, or run
multiple instances of the same template under different
ViewEngine objects.

ArchestrA Symbols
The ArchestrA IDE contains a symbol editor that lets you
create symbols that visualize production processes and
provide an HMI interface to ArchestrA automation objects.

Creating ArchestrA Symbols


ArchestrA symbols are created with the ArchestrA Symbol
Editor in the IDE.
You can either create:

InTouch ArchestrA Integration Guide

** DRAFT COPY **
ArchestrA Symbols 19

• ArchestrA symbols in the Graphic Toolbox. These are not


associated with any specific ArchestrA template or
ArchestrA instance.

• ArchestrA Symbols contained in a specific ArchestrA


template or instance.

Inserting ArchestrA Symbols in InTouch Windows


The ArchestrA Symbols can be inserted into an
IDE-managed InTouch application and used.
You can insert an ArchestrA symbol to a window of an
IDE-managed InTouch application from either:
• The Graphic Toolbox.

• An Automation template.

• An Automation instance.

Creating New Automation Instances


Automatically
If you insert an ArchestrA symbol from an template, the
InTouch HMI can create an instance of that object and the
symbol instance references the new instance.

Example
1 Create an Automation template $Valve1 and open it in
the ArchestrA IDE editor.
2 On the Graphics tab, add an ArchestrA symbol, called
ValveSymbol.
3 Create a derived template of the InTouchViewApp object
and open it in WindowMaker.
4 Create a new InTouch window and insert the ArchestrA
symbol ValveSymbol from the Automation template
$Valve1. WindowMaker prompts for an instance name.
5 Type a name, for example Valve1_E122 and click OK. The
ArchestrA symbol is pasted on the InTouch window and
an instance called Valve1_E122 is derived from $Valve1
in the IDE.

Symbol Change Propagation


Any changes to the parent ArchestrA symbol are propagated
to all child Archestra symbols derived from it. This affects
the ArchestrA symbols in WindowMaker as well as the
ArchestrA symbols of its derived child objects.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
20 Chapter 1 About InTouch ArchestrA Integration

If WindowMaker is open and one of its windows contains an


inserted ArchestrA symbol and a change is made to the
inserted ArchestrA symbol, an icon appears in the status bar.
You can double-click this icon to accept the change.

Example
1 Follow the example from Creating New Automation
Instances Automatically on page 19.
2 Open the ArchestrA symbol ValveSymbol that is hosted
by the Automation template $Valve1.
3 Make some changes and click Close and Save. The
changes are propagated to Automation instance
Valve1_E22. In WindowMaker, the Change Symbol icon
appears.
4 Click on the icon. The changes are updated in
WindowMaker.

Symbol Dynamic Size Propagation


You can control the way that size changes of the parent
symbol are propagated to its child symbols, which are
inserted ArchestrA symbols. For example, a size change is:
• Resizing one of the elements in the parent symbol so that
the symbol boundary changes.

• Adding elements to or removing elements from the


parent symbol so that the symbol is boundary changes.

This feature is called dynamic size change and can be either


enabled or disabled.

Note For more information about dynamic size propagation, see


Creating and Managing ArchestrA Graphics User’s Guide.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
ArchestrA Symbols 21

Overview Diagram
The following diagram shows you how symbols that are
created with the ArchestrA IDE ArchestrA Symbol Editor
can be used in InTouch applications.

Usage of ArchestrA Symbols


INDUSTRIAL APPLICATION SERVER OBJECTS INTOUCH WINDOWMAKER

Graphic BROWSING Browsing the


Toolbox Symbol Toolbox

Instances of
ArchestrA Symbols

Object Templates Browsing for


BROWSING
with Symbols Object Template with
Symbol

Object Instances Instances of


with Symbols ArchestrA
Symbols

CREATING
OBJECT
INSTANCES

InTouch ArchestrA Integration Guide

** DRAFT COPY **
22 Chapter 1 About InTouch ArchestrA Integration

InTouch ArchestrA Integration Guide

** DRAFT COPY **
23

Chapter 2

Managing InTouch Applications


with IDE

This section shows you how to use the ArchestrA IDE to:
• Start the ArchestrA IDE from Application Manager.

• Create a new IDE-managed InTouch application.

• Import an existing InTouch application to use as an


IDE-managed InTouch application.

• Start WindowMaker from within the IDE.

• Submit the changes you make in WindowMaker to the


IDE-managed InTouch application.

• Export and import the IDE-managed InTouch application


together with its InTouchViewApp object.

• Convert an IDE-managed InTouch application to an


unmanaged InTouch application.

• Delete the IDE-managed InTouch application.

• Import and export tag data used in the IDE-managed


InTouch application.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
24 Chapter 2 Managing InTouch Applications with IDE

• Export tag data to and import tag data from a *.csv file.

ArchestrA IDE InTouch WindowMaker

Imports Stand Alone InTouch


InTouchViewApp and Applications
Automation Exports
Object (Template)
Manages

IDE-Managed InTouch
Applications
Imports and Exports

aaPKG. File

IDE-Managed
InTouch
Applications

Starting the ArchestrA IDE from Application


Manager
If ArchestrA IDE is installed on the same computer as
InTouch, you can easily start the ArchestrA IDE from the
InTouch Application Manager.

To start the ArchestrA IDE from Application Manager


‹ In the InTouch Application Manager, do either of the
following:
• On the File menu, click ArchestrA IDE.
• Click the ArchestrA IDE icon on the toolbar.
The Connect to Galaxy dialog box appears.

Creating an IDE-Managed InTouch Application


You can create an IDE-managed InTouch application by
creating and configuring an InTouchViewApp object.

To create an IDE-managed InTouch application


1 Open the ArchestrA IDE.
2 In the Template Toolbox, expand the System toolset.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Starting WindowMaker from the ArchestrA IDE 25

3 Derive a template from the $InTouchViewApp base


template.
4 Open the derived template. The InTouchViewApp
Initialization dialog box appears.
5 Select Create New InTouch Application and click Next.
The next panel appears.
6 Type a name for the InTouch application and a
description.
7 Select InTouchView Application to create an InTouch
application that uses only ArchestrA references
8 Click Next. WindowMaker is started.

Note The InTouch application directory is created as a share


\\$ARCHESTRA-GalaxyName-$InTouchViewAppObjectName. It is
managed by IDE, not by the InTouch Application Manager.

Starting WindowMaker from the ArchestrA


IDE
You can edit an IDE-managed InTouch application at any
time by starting WindowMaker from within the ArchestrA
IDE.
You can start WindowMaker from either an
InTouchViewApp template or an instance.
When opening a managed InTouch application that was
created with a different screen resolution than your current
system resolution, a message appears.

You can click:


• Yes to convert the InTouch application to the current
system resolution and open it.

• No to open and edit the InTouch application in its original


resolution.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
26 Chapter 2 Managing InTouch Applications with IDE

To start WindowMaker from an InTouchViewApp template


1 Open the ArchestrA IDE.
2 Locate the InTouchViewApp template that contains the
IDE-managed InTouch application you want to modify.
3 Double-click on it. WindowMaker starts as the object’s
default editor and opens the InTouch application. You are
ready to edit the IDE-managed application.

To start WindowMaker from an InTouchViewApp instance


1 Open the ArchestrA IDE.
2 Locate the InTouchViewApp object whose parent
contains the IDE-managed InTouch application you want
to modify.
3 Double-click on it. The InTouchViewApp Instance Edit
dialog box appears.

4 Click Yes to open the associated InTouchViewApp


template in WindowMaker, or No to not open it.
If you select Don’t ask me again and click Yes, the next
time you open an InTouchViewApp instance, the
IDE-managed InTouch application is automatically
opened from the associated InTouchViewApp template.
You can change this setting anytime on the User
Information dialog box that can be opened from the Edit
menu.

Submitting the Changes of an InTouch


Application
After you modify your IDE-managed InTouch application,
you can submit the changes to IDE.
After you make changes to an IDE-managed InTouch
Application, any derived InTouchViewApp objects appear
with the Pending Changes icon.
This indicates that you must reploy the changes to the target
nodes, for WindowViewer on those nodes to reflect the
changes.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Importing an InTouch Application 27

For more information on how to deploy the changes to the


operator nodes, see Deploying an IDE-Managed InTouch
Application on page 56 and Accepting New Application
Versions at the Operator Node on page 58.

To submit the changes of an InTouch Application


1 Modify your IDE-managed InTouch application in
WindowMaker as you would do with a stand alone
InTouch application.
2 When you are done, save and close your InTouch
windows.
3 Click File, then Exit. WindowMaker closes and the focus
returns to IDE. The Check In dialog box appears.
4 Type a comment for the Check In procedure, if necessary,
and click OK. The Check In progress dialog box appears.
5 Click Close.

Importing an InTouch Application


You can import an existing InTouch application to use as an
IDE-managed InTouch application. This is done in two steps:
• Create an InTouchViewApp object to associate with the
imported InTouch application.

• Import the InTouch application.

The imported InTouch application becomes an IDE-managed


InTouch application.

Note The ArchestrA IDE creates a copy of the existing InTouch


application in a folder that it manages and accesses and leaves
the existing InTouch application and location unchanged.

To import an InTouch application into a Galaxy


1 Open the ArchestrA IDE.
2 In the Template Toolbox, derive a template from the
$InTouchViewApp base template.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
28 Chapter 2 Managing InTouch Applications with IDE

3 Open the derived template. The InTouchViewApp


Initialization dialog box appears.

4 Select Import Existing Application and click Next. The next


panel appears.

5 You can either:


• Browse for the IDE-managed InTouch application
folder, if you know its location.
• Select Find applications, specify a search root for the
search to begin, and click Find. After InTouch
applications are found, they appear in the list. Select
one from the list.
6 Click Next. The next panel appears.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Importing and Exporting the InTouchViewApp Object 29

7 If necessary, type:
• A new name in the Application Name box.
• A new description in the Description box.
8 After you are done, click Next. The next panel appears
and shows you the import progress.

9 Click Done. InTouch WindowMaker is started and you


can edit the InTouch application as an IDE-managed
InTouch application.

Importing and Exporting the InTouchViewApp


Object
You can import and export the InTouchViewApp object. The
InTouchViewApp object contains all information for hosting
an IDE-managed InTouch application and can be used to
exchange IDE-managed InTouch application between
Galaxies.

Note For more information about importing and exporting


Automation objects, see the Industrial Application Server
User’s Guide.

To import an InTouchViewApp object


‹ Import the ArchestrA package (.aaPKG) file that contains
the InTouchViewApp object(s) you want to import. This is
the same as importing any other Automation object.

To export an InTouchViewApp object


‹ Export the ArchestrA package (.aaPKG) file that contains
the InTouchViewApp object(s) you want to export. This is
the same as exporting any other Automation object.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
30 Chapter 2 Managing InTouch Applications with IDE

Exporting an IDE-Managed InTouch


Application as an Unmanaged InTouch
Application
You can export an IDE-managed InTouch application as a
Stand Alone InTouch application from the InTouchViewApp
object that is managing it.
It is exported as a folder containing information about the
object and the IDE-managed InTouch application.
This is different than exporting the InTouchViewApp object
itself. For more information, see Importing and Exporting
the InTouchViewApp Object on page 29.

Note The unmanaged InTouch application cannot be reimported


into an InTouchViewApp object.

To export an IDE-managed InTouch application as an


unmanaged InTouch application
1 Open the ArchestrA IDE.
2 Locate the InTouchViewApp object that contains the
IDE-managed InTouch application you want to convert.
3 Right-click it, point to Export, and then click InTouch
Application. The Browse For Folder dialog box appears.

4 You can either:


• Select a folder to which you want to export the
InTouch application.
• Create a new folder or folder structure by clicking
Make New Folder.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Deleting the IDE-Managed InTouch Application 31

5 When you are done, click OK. The Export Automation


Object(s) progress dialog box appears.

6 When the export is complete, click Close. A directory


containing the new unmanaged InTouch application is
created in the selected folder.

Deleting the IDE-Managed InTouch


Application
You can delete an InTouch application in the ArchestrA IDE
by deleting the associated InTouchViewApp object.
When you do this, the template and the InTouch application
directory associated with that template are deleted
completely.
You can only delete an InTouch application if the associated
InTouchViewApp object does not have any derived instances.

To delete the InTouchViewApp object


1 Select the InTouchViewApp object that contains the
IDE-managed InTouch application you want to delete.
2 On the Edit menu, click Delete. The Delete dialog box
appears.
3 Click Yes. The InTouchViewApp object and the associated
InTouch application folder are deleted.

Note Deleting an InTouchViewApp instance does not delete the


associated InTouch application.

Exporting and Importing Tag Data


You can export the tag data of an IDE-managed InTouch
application to a .csv file. This data can be used for importing
into another IDE-managed InTouch application or a
stand-alone InTouch application.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
32 Chapter 2 Managing InTouch Applications with IDE

To export tag data from an IDE-managed InTouch application


1 In IDE, select the derived InTouchViewApp template
that contains the IDE-managed InTouch application from
which you want to export the tag data.
2 On the Galaxy menu, point to Export and then click DB
Dump. The CSV File to Dump To dialog box appears.
3 Specify a location and file name for the .csv file and click
Save. A confirmation dialog box appears.
4 Select Group output by types if you want the tag data to
be grouped by data types in the .csv file. Then click OK.
5 A success message appears. Click OK.

To import tag data from a CSV file to an IDE-managed InTouch


application
1 In IDE, select the derived InTouchViewApp template
that contains the IDE-managed InTouch application to
which you want to import the tag data.
2 On the Galaxy menu, point to Import and then click DB
Load. The CSV File to Load From dialog box appears.
3 Select the .csv file and click Open.

Note During the import, one or more messages may appear


warning you of duplicate names. Select the appropriate option for
each tag name that is duplicate. For more information, see the
InTouch Data Management Guide.

4 A success message appears. Click OK.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
33

Chapter 3

Using ArchestrA Symbols in


WindowMaker

You can use ArchestrA Symbols that are created with the
ArchestrA Symbol Editor in the IDE in your IDE-managed
InTouch application.

ArchestrA IDE InTouch WindowMaker

InTouchViewApp
IDE-Managed InTouch
Automation Manages
Applications
Object (Template)

Provides
ArchestrA
Symbols InTouch WindowViewer

ArchestrA Symbol Test Application


Editor

Templates and
Instances
IDE-Managed InTouch
Provides Applications
ArchestrA
Symbol Functionality

You can:
• Insert ArchestrA symbols into an InTouch window.

• Configuring inserted ArchestrA symbols.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
34 Chapter 3 Using ArchestrA Symbols in WindowMaker

• Start the ArchestrA IDE Symbol Editor.

• Test the ArchestrA Symbols in WindowViewer.

• Create a new Instance of the Automation object that is


hosting the inserted ArchestrA Symbol.

Inserting ArchestrA Symbols into an InTouch


Window
You can insert an ArchestrA symbol into the InTouch
Windows of your IDE-managed InTouch application.
The ArchestrA symbol may either be part of:
• The Graphic Toolbox.
• An ArchestrA template.

• An ArchestrA instance.

Note You cannot insert ArchestrA Symbols into windows of stand


alone InTouch applications. Instead, convert the IDE-managed
InTouch applications to stand alone InTouch applications. Any
contained ArchestrA symbols are also converted, but have limited
functionality.

Inserting ArchestrA Symbols from Objects


Templates
You can insert an ArchestrA symbol from a template that
hosts ArchestrA symbols. At the same time, a new derived
instance of the selected template is created.

Note To create a new instance based on an ArchestrA symbol


already on the InTouch window, see Testing ArchestrA Symbols in
WindowViewer on page 51.

To insert an ArchestrA symbol from atemplate template


1 In WindowMaker, on the Edit menu, click Embed
ArchestrA Symbol. The Galaxy Browser dialog box appears.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Inserting ArchestrA Symbols into an InTouch Window 35

2 Click the Template Toolbox icon. The Template Toolbox


list appears on the left.

3 Click on the template that contains the ArchestrA symbol


you want to insert. The ArchestrA symbols that are
contained in the selected template appear on the right.
4 Click on the ArchestrA symbol you want to insert and
click OK. The Galaxy Browser closes and the insertion
icon appears if the mouse is over the InTouch window.
5 Click on the InTouch window where you want to insert
the ArchestrA symbol. The Create Instance dialog box
appears.

6 Type a name for the instance and click OK. An instance is


automatically derived from the template with the name
you specify. The symbol is inserted on the InTouch
window.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
36 Chapter 3 Using ArchestrA Symbols in WindowMaker

Inserting ArchestrA Symbols from Instances


You can insert ArchestrA symbols from instances that have
ArchestrA symbols associated with them.

Note When you insert an ArchestrA symbol from an instance, the


symbol is associated with that instance.

To insert an ArchestrA symbol from an instance


1 In WindowMaker, on the Edit menu, click Embed
ArchestrA Symbol. The Galaxy Browser dialog box appears.
2 Click the Instances icon. The Instances list appears on the
left.

3 Click on the instance that contains the ArchestrA symbol


you want to insert. The ArchestrA symbols that are
associated with the selected instance appear on the right.
4 Click on the ArchestrA symbol you want to insert and
click OK. The Galaxy Browser closes and the insertion
icon appears if the mouse is over the InTouch window.
5 Click on the InTouch window where you want to insert
the ArchestrA symbol. The symbol is inserted on the
InTouch window.

Inserting ArchestrA Symbols from the Graphic


Toolbox
You can insert ArchestrA symbols from the Graphic Toolbox.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Configuring ArchestrA Symbols in WindowMaker 37

To insert an ArchestrA symbol from the Graphic Toolbox


1 In WindowMaker, on the Edit menu, click Embed
ArchestrA Symbol. The Galaxy Browser dialog box appears.
2 Click the Graphic Toolbox icon. The Graphic Toolbox list
appears on the left.

3 Select the ArchestrA symbol you want to insert and click


OK. The insertion icon appears if the mouse is over the
InTouch window.
4 Click on the InTouch window where you want to insert
the ArchestrA symbol. The object is inserted on the
InTouch window.

Configuring ArchestrA Symbols in


WindowMaker
You can configure inserted ArchestrA symbols in the
following ways:
• Standard editing, such copying, cutting, pasting,
duplicating, resizing, moving and deleting. For more
information, see the InTouch Visualization Guide.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
38 Chapter 3 Using ArchestrA Symbols in WindowMaker

• Configuring WindowMaker animation links.

• Connect an ArchestrA symbol with InTouch tagnames.

• Selecting an alternate instance of the same parent.


• Selecting an alternate symbol of the same instance.

• Resizing the inserted ArchestrA symbol to its original


size.

• Enabling or disabling dynamic size propagation.

Configuring WindowMaker Animation Links of an


ArchestrA Symbol
You can configure WindowMaker animation links of an
inserted ArchestrA Symbol in the same way as any other
InTouch object. You can only configure animation links that
are external to the inserted ArchestrA Symbol. These are:
• Object size.

• Object location.

• Visibility.

• Orientation.

• Enablement.

Note The animation links configured in WindowMaker are


independent from those configured in the ArchestrA Symbol
Editor. They do not inherit the settings of the ArchestrA symbol
and take precedence when run in WindowViewer.

To configure WindowMaker animation links of an inserted


ArchestrA symbol
1 Select the inserted ArchestrA symbol.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Configuring ArchestrA Symbols in WindowMaker 39

2 On the Special menu, select Animation Links. The


Animation Links dialog box appears.

3 Make any changes as you would to any other InTouch


object.
4 When you are done, click OK.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
40 Chapter 3 Using ArchestrA Symbols in WindowMaker

Connecting ArchestrA Symbols with InTouch


Tagnames
You can connect ArchestrA symbols with InTouch tagnames
by overriding the custom properties of an inserted ArchestrA
symbol. The custom properties expose the ArchestrA symbol
animation links to InTouch.

Connecting ArchestrA Symbols with InTouch Tags

ArchestrA Symbol Editor

SYMBOL4
SYMBOL3

SYMBOL1 SYMBOL2

ELEMENT1 CustomProperty1

ANI CustomProperty2
MA
TIO
N CustomProperty3

InTouch WindowMaker EMBED ARCHESTRA SYMBOL

InTouch Tags

tag3

SYMBOL1 tag2

tag1
ELEMENT1 CustomProperty1

ANI CustomProperty2
MA
TIO
N CustomProperty3
USES INTOUCH
TAG AS REFERENCE

When you insert an ArchestrA symbol in an InTouch


window, the references in the animation links are converted
as follows:

ArchestrA Symbol Inserted ArchestrA Symbol

Object.Extension galaxy:Object.Extension
intouch:Tagname Tagname

For more information about custom properties, see the


Creating and Managing ArchestrA Graphics User’s Guide.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Configuring ArchestrA Symbols in WindowMaker 41

To connect an ArchestrA symbol with an InTouch tagname


1 Right-click the inserted ArchestrA symbol on the InTouch
window. The context menu appears.
2 Point to ArchestrA Graphic and then click Edit Custom
Properties. The Edit Custom Properties dialog box appears.

3 Select the custom property you want to connect to an


InTouch tagname. The configuration for the selected
custom property appears on the right.
4 In the Default Value box, either:
• Type the name of the InTouch tagname.
• Click the browse button and select a tagname from
the Select Tag dialog box.

Note You can restore the original value of the custom property by
clicking the Restore icon.

5 When you are done, click OK. Any animation in the


ArchestrA symbol that is configured with the selected
custom property now interacts with the InTouch tagname
instead.

Example
This example shows you how to connect a tank symbol with a
percent vertical fill animation created by the ArchestrA
Symbol Editor to an InTouch tagname.
This is done in three parts:
• Creating a sample Tank as an ArchestrA symbol.

• Creating the InTouch application.

• Deriving and viewing the sample tank in WindowViewer.

For more details on the individual steps, see Creating and


Managing ArchestrA Graphics User’s Guide.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
42 Chapter 3 Using ArchestrA Symbols in WindowMaker

To create a sample Tank as ArchestrA symbol


1 In the IDE, create a new symbol called “Tank” and open it
in the ArchestrA Symbol Editor.
2 Paste a rectangle on the canvas. Change its appearance it
as desired.
3 Create a colored polygon element that represents a
cutout of the tank to show the tank level.

4 Click on the canvas and from the Special menu select


Custom Properties. The Edit Custom Properties dialog box
appears.
5 Add a custom property called, for example, Level.
6 On the right panel, set:
• Data Type as Float.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Configuring ArchestrA Symbols in WindowMaker 43

• Default Value as 0.

7 Click OK.
8 Double-click on the polygon element that represents the
tank level. The Edit Animations dialog box appears.
9 Add a % Vertical Fill animation.
10 On the right panel, in the Analog box, type the name of
the custom property. In this example, it is Level.

11 Click OK to close the Edit Animations dialog box.


12 Click Close and Save to close the ArchestrA Symbol
Editor.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
44 Chapter 3 Using ArchestrA Symbols in WindowMaker

To create the InTouch application


1 In IDE, create a new IDE-managed InTouch application.
For more information, see Creating an IDE-Managed
InTouch Application on page 24.
2 Open the IDE-managed InTouch application in
WindowMaker.
3 Create a new window and define a new real InTouch
tagname, for example TankLevel.
4 Insert the Tank symbol on the window.

5 Right-click the inserted ArchestrA symbol, point to


ArchestrA Graphic “Tank”, and then click Edit Custom
Properties. The Edit Custom Properties dialog box appears.
6 Select the custom property Level, and in the Default
Value box, either:
• Type TankLevel.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Configuring ArchestrA Symbols in WindowMaker 45

• Browse for TankLevel with the Select Tag dialog box


that is opened from the ellipsis button.

7 Click OK.
8 Paste a slider on the window and configure it with the
local InTouch tagname TankLevel.
9 Save changes and close WindowMaker. The
IDE-managed InTouch application is checked in.

To derive and test the sample tank


1 In IDE, derive an instance of the IDE-managed InTouch
application and deploy it together with a Winplatform
and a ViewEngine instance.
2 Open Application Manager and start the listed
application in WindowViewer. The tank and the slider
appear on the window in WindowViewer.
3 You can move the slider to affect the tank level.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
46 Chapter 3 Using ArchestrA Symbols in WindowMaker

Selecting an Alternate Instance from the Same


Parent
You can use this function to redirect all references in the
ArchestrA symbol to the alternate instance. The appearance
of the ArchestrA symbol does not change, except possibly for
its size, as it is not possible to edit inherited ArchestrA
symbols.

Note You cannot use this function with ArchestrA symbols that
originate from the Graphics Toolbox, as they are not associated
with any object.

To select an alternate instance from the same parent


1 Right-click the inserted ArchestrA symbol. The context
menu appears.
2 Point to ArchestrA Graphic, and then click Select Alternate
Instance. The Galaxy Browser dialog box appears. It shows
all other instances that have the same parent.

3 Select an alternate instance from the list and click OK.


The references of the ArchestrA symbol are updated to
point at the new alternate instance.

Note The size of the ArchestrA symbol on the InTouch window is


unchanged.

Selecting Alternate Symbols of the Same


Instance
You can use this function to replace an inserted ArchestrA
symbol with another ArchestrA symbol belonging to the same
instance.

Note You cannot use this function with ArchestrA symbols that
originate from the Graphic Toolbox, as they are not associated
with any object.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Configuring ArchestrA Symbols in WindowMaker 47

To select an alternate ArchestrA symbol from the same


instance
1 Right-click the inserted ArchestrA symbol. The context
menu appears.
2 Point to ArchestrA Graphic, and then click Select Alternate
Symbol. The Galaxy Browser dialog box appears.

3 Select an alternate symbol from the window on the right


and click OK.
4 If the alternate symbol is a different size than the
original symbol, a message appears prompting if you
want to keep the size of the currently inserted ArchestrA
symbol.

Either click:
• Yes, to keep the current size of the selected ArchestrA
symbol.
• No, to update the size of the selected ArchestrA
symbol to the size of the new ArchestrA symbol.
In both cases, the inserted ArchestrA symbol is updated
with the new alternate ArchestrA symbol.

Substituting Strings in an ArchestrA Symbol


You can substitute all strings in an inserted ArchestrA
Symbol with alternate strings.

To substitute all strings in an inserted ArchestrA symbol


1 Select the inserted ArchestrA symbol.
2 On the Special menu, point to Substitute, and then click
Substitute Strings. The Substitute Strings dialog box
appears.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
48 Chapter 3 Using ArchestrA Symbols in WindowMaker

3 Type new strings in the corresponding boxes and click OK.


The strings in the inserted ArchestrA symbol are
substituted by the new alternate strings.

Substituting References in an ArchestrA Symbol


You can substitute all references in an inserted ArchestrA
Symbol with alternate references.

To substitute all references in an inserted ArchestrA symbol


1 Select the inserted ArchestrA symbol.
2 On the Special menu, click Substitute Tags. The Substitute
Tags dialog box appears.
3 Type new references in the corresponding boxes and click
OK. The references in the inserted ArchestrA symbol are
substituted by the new alternate references.

Resizing the Inserted ArchestrA Symbol to its


Original Size
You can resize the inserted ArchestrA Symbol to its original
size when created in the ArchestrA Symbol Editor.

To resize an inserted ArchestrA symbol to its original size


1 Right-click the inserted ArchestrA symbol you want to
change to its original size. The context menu appears.
2 Point to ArchestrA Graphic, and then click Symbol -
Original Size. The inserted ArchestrA symbol is changed
to its original size.

Enabling or Disabling Dynamic Size Change of


Inserted ArchestrA Symbols
You can enable or disable the dynamic size change of
inserted ArchestrA symbols.
If the dynamic size change is enabled, any changes to the
absolute anchor point position of the parent symbol:
• Leave the anchor points of its child symbols unchanged.

• Move the child symbol position accordingly.

If the dynamic size change is disabled, any changes to the


absolute anchor point position of the parent symbol:
• Move the anchor points of its child symbols accordingly.

• Leave the child symbol position unchanged.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Editing ArchestrA Symbols in the ArchestrA Symbol Editor 49

Note For more information about dynamic size propagation, see


Creating and Managing ArchestrA Graphics User’s Guide.

To enable or disable dynamic size change of an inserted symbol


1 Right-click the inserted ArchestrA symbol. The context
menu appears.
2 Point to ArchestrA Graphic, then check or uncheck
Dynamic Size Change.

Editing ArchestrA Symbols in the ArchestrA


Symbol Editor
You can edit inserted ArchestrA symbols with the ArchestrA
Symbol Editor that is integrated in the ArchestrA IDE. This
is done in two steps:
1 Open the inserted ArchestrA symbol in ArchestrA
Symbol Editor, modify the symbol and save it. The
ArchestrA symbol is updated in the template, instance or
in the Graphic Toolbox.
2 Accept the changes in WindowMaker by clicking on the
Symbol Changed icon in the status bar. The changes are
then propagated to WindowMaker.

Editing an Inserted ArchestrA Symbol


You can easily edit an inserted ArchestrA symbol from
within InTouch WindowMaker.
If the symbol or its children are used by other IDE-managed
InTouch applications, the changes are propagated to the
children and the InTouch applications.

Note Any changes you make to the ArchestrA symbol are not
propagated to the inserted ArchestrA symbol automatically. For
more information, see Accepting Symbol Changes in WindowMaker
on page 50.

To edit inserted ArchestrA symbols with the ArchestrA Symbol


Editor
1 Right-click the inserted ArchestrA symbol. The context
menu appears.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
50 Chapter 3 Using ArchestrA Symbols in WindowMaker

2 Point to ArchestrA Graphic, and then click Edit Symbol.


The ArchestrA Symbol Editor with the ArchestrA symbol
appears.

3 Edit the ArchestrA symbol. For more information, see the


Creating and Managing ArchestrA Graphics User’s
Guide.
4 When you are done, click Close and Save. The changes are
saved and the ArchestrA Symbol Editor closes.
5 If the ArchestrA object is hosted by an instance or
template, save and close the object editor in the IDE.

Accepting Symbol Changes in WindowMaker


After an ArchestrA symbol has changed and you are
currently using it in WindowMaker, you can accept the
change in WindowMaker.

To accept symbol changes in WindowMaker


‹ Either:
• Double-click the Symbol Changed icon in the status
bar.
• Close the InTouch window containing the inserted
ArchestrA symbol and open it again.
In both cases the changes made to the ArchestrA symbol
are reflected in the inserted symbol in the InTouch
window.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Testing ArchestrA Symbols in WindowViewer 51

Accepting Symbol Changes in WindowViewer


After an ArchestrA symbol has changed and you are
currently testing it in WindowViewer, you can accept the
change in WindowViewer.
For more information about testing inserted ArchestrA
symbols, see Testing ArchestrA Symbols in WindowViewer
on page 51.

To accept symbol changes in WindowViewer when testing


‹ Either:
• Fast-switch to WindowMaker and then back to
WindowViewer.
• Close the InTouch window and open it again.
In both cases the changes made to the ArchestrA symbol
are reflected in the inserted ArchestrA symbol in the
InTouch window.

Testing ArchestrA Symbols in WindowViewer


You can test the inserted ArchestrA symbol in an InTouch
window without having to derive and derive an
InTouchViewApp instance. You can test an inserted
ArchestrA symbol, if you have previously:
• Created an ArchestrA symbol in the Graphic Toolbox, in
an automation template or automation instance.

• Created an IDE-managed InTouch application.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
52 Chapter 3 Using ArchestrA Symbols in WindowMaker

• Inserted the ArchestrA symbol in the IDE-managed


InTouch application.

Development and Testing Process of


ArchestrA Symbols

ArchestrA Symbol Editor

Modify
Create
ArchestrA
ArchestrA
Symbol and
Symbol
Save

WindowMaker

Insert
ArchestrA Accept
Symbol into Changes in
InTouch WindowMaker
Window

WindowViewer

Test ArchestrA
Fast Switch to Fast Switch to
Symbol in
WindowViewer WindowMaker
WindowViewer

To test inserted ArchestrA symbols in WindowViewer


1 From WindowMaker, click Runtime to switch to
WindowViewer.
2 Test the animations, behavior and appearance of the
inserted symbol(s) as you would with a normal run-time
environment.

Note You can fast-switch back to WindowMaker to make changes


to the way the ArchestrA symbol is inserted.

To change and test inserted ArchestrA symbols in


WindowViewer
1 Make changes to the ArchestrA symbol in the IDE.
2 Save the changes. If WindowViewer is:
• Open then after a short while, a message appears in
WindowViewer asking you to accept the changes.
Click Yes.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Creating a New Automation Instance 53

• Closed then you can fast-switch from WindowMaker


to WindowViewer to see your changes.

Note After you have made changes to an ArchestrA symbol and


saved it, it is faster to close WindowViewer and to re-open
WindowViewer than to wait for the changes to propagate to the
open WindowViewer session.

Creating a New Automation Instance


You can create a new instance of the Automation object that
contains a currently inserted ArchestrA symbol. Use this
function to create new instances without creating new
inserted ArchestrA symbols.

Note You can only create new Automation instances for ArchestrA
symbols that are hosted by templates or instances. ArchestrA
symbols that are in the Graphic Toolbox do not have this
functionality.

To create a new Automation instance


1 Right-click the inserted ArchestrA symbol. The context
menu appears.
2 Point to ArchestrA Graphic, and then click New Instance.
The Create Instance box dialog box appears.

3 Type a name for the instance and click OK. An instance is


automatically derived from the template with the name
you specify.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
54 Chapter 3 Using ArchestrA Symbols in WindowMaker

InTouch ArchestrA Integration Guide

** DRAFT COPY **
55

Chapter 4

Using IDE-Managed InTouch


Applications at Run Time

You can run IDE-managed InTouch applications on remote


nodes by deploying InTouchViewApp instances to those
nodes.
ArchestrA IDE

InTouchViewApp
Automation
Derive Object (Template) Derive

InTouchViewApp InTouchViewApp
Automation Automation
Object (Instance) Object (Instance)

Create
Application Directories on
Operator Nodes When Deployed

InTouch InTouch
WindowViewer WindowViewer
on Node 1 on Node 2

IDE-Managed InTouch IDE-Managed InTouch


Application Application

Start WindowViewer on
Operator Nodes

InTouch InTouch
Application Manager on Node 1 Application Manager on Node 2

InTouch ArchestrA Integration Guide

** DRAFT COPY **
56 Chapter 4 Using IDE-Managed InTouch Applications at Run Time

You can also deploy changes of the InTouch application and


contained ArchestrA symbols to these nodes and select
whether to accept or decline the changes for each node.

Deploying an IDE-Managed InTouch


Application
You can deploy an IDE-managed InTouch application from
the ArchestrA IDE to the local node or a remote node. After
you deploy the application, you can run it in WindowViewer
on the operator nodes.

Deploying the InTouchViewApp Object for the


First Time
The first time you deploy an InTouchViewApp object, the
associated InTouch application is copied to the node of the
platform that hosts the object. This is called the operator
node.

To deploy an IDE-managed InTouch application


1 Open the ArchestrA IDE.
2 Select the instance of the InTouchViewApp for which you
want to deploy the IDE-managed InTouch application.
3 On the Object menu, click Deploy. The Deploy dialog box
appears.
4 Click OK and the complete InTouch application is copied
to the operator node.

Deploying Changes to the IDE-Managed InTouch


Application
You can change the IDE-managed InTouch application either
by:
• Changing the references, content or size of an ArchestrA
symbol that is used in an IDE-managed InTouch
application.

• Changing the IDE-managed InTouch application itself by


opening WindowMaker from the InTouchViewApp
template.

In both cases, when you save the changes, the changes are
propagated from the updated template to the derived
children instances. These appear with the Pending Changes
icon.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Starting the IDE-Managed InTouch Application 57

To deploy changes to an IDE-managed InTouch application


1 Open the ArchestrA IDE.
2 Select the instance of the InTouchViewApp for which you
want to deploy the changes of an IDE-managed InTouch
application.
3 On the Object menu, click Deploy. The Deploy dialog box
appears.
4 Click OK and the changes are copied to the operator node.

Note The changes are not immediately reflected in a running


WindowViewer session. The operator of each node can select to
accept or decline the changes. For more information, see
Accepting New Application Versions at the Operator Node on
page 58.

Starting the IDE-Managed InTouch Application


On the operator node, you can start WindowViewer to run
the IDE-managed InTouch application.
The managed application runs according to the resolution
settings for Dynamic Resolution Conversion in Application
Manager.
These can be set from the Tools menu, Node Properties dialog
box, Resolution tab.
If Allow WindowViewer to dynamically change resolution is
checked, the application runs according to the setting:
• Use application resolution: the managed application is run
at the same resolution as it was developed in.

• Convert to screen video resolution: the managed


application is converted so that it can run with the screen
resolution.
• Custom resolution: the managed application is converted
to the specified resolution.

If Allow WindowViewer to dynamically change resolution is


unchecked, the managed application runs with the resolution
in which it was developed.

To start the IDE-managed InTouch application


1 On the node the InTouchViewApp object is deployed to,
start the InTouch Application Manager.
2 In the application list, select the managed IDE-managed
InTouch application you want to run in WindowViewer.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
58 Chapter 4 Using IDE-Managed InTouch Applications at Run Time

3 Click the WindowViewer icon. The application starts in


WindowViewer after a short while.

Accepting New Application Versions at the


Operator Node
If the IDE-managed InTouch application is changed and its
associated InTouchViewApp instance deployed, you can
select to accept or decline the changes.
A message appears prompting you if you want to accept the
changes to the IDE-managed InTouch application, either:
• When you start WindowViewer from the InTouch
Application Manager.

• While WindowViewer is running.

Depending on the nature of the change, you may either be


prompted to restart the WindowViewer application, or just
reload it. You can also set the behavior of WindowViewer for
application changes, such as:
• How WindowViewer accepts or rejects these changes.

• How frequently WindowViewer should remind you to


reload or restart WindowViewer when changes are
pending.

To accept new application versions at the operator node


‹ Click Yes. The changes to the IDE-managed InTouch
application are copied to the operator node and
WindowViewer either restarts or reloads.

To set the behavior of WindowViewer for application changes


1 Open the IDE-managed InTouch application in
WindowMaker.
2 On the Special menu, point to Configure, and then click
WindowViewer. The WindowViewer Properties dialog box
appears.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Accepting New Application Versions at the Operator Node 59

3 Click the Managed Application tab.

4 In the Change Mode area, click:


• Ignore Changes, so that WindowViewer ignores any
deployed changes. You can manually configure the
script functions RestartWindowViewer() and
ReloadWindowViewer() to accept the changes
depending on the $ApplicationChanged system tag.
• Restart WindowViewer, so that WindowViewer
restarts automatically when changes are deployed.
• Prompt user to restart WindowViewer, so that
WindowViewer shows a message prompting you to
restart WindowViewer when changes are deployed.
• Load changes into WindowViewer, so that
WindowViewer loads the changes automatically when
changes are deployed.
• Prompt user to load changes into WindowViewer, so
that WindowViewer shows a message prompting you
to load changes into WindowViewer when changes are
deployed.
5 To remind the user to load or restart the changes into
WindowViewer (when the applicable change mode has
been set), in the Reminder Interval (sec), enter either:

InTouch ArchestrA Integration Guide

** DRAFT COPY **
60 Chapter 4 Using IDE-Managed InTouch Applications at Run Time

• A value in seconds.
• 0, to not be reminded again.
6 When you are done, click OK.

To set the default behavior for WindowViewer


1 Open the IDE-managed InTouch application in
WindowMaker.
2 On the Special menu, point to Configure, and then click
WindowViewer. The WindowViewer Properties dialog box
appears.
3 Click the Managed Application tab.
4 Click Restore Defaults. The settings are reset to their
default values.
5 Click OK.

Running ArchestrA Scripts in Inserted


ArchestrA Symbols
When you run an IDE-managed InTouch application in
WindowViewer, any ArchestrA scripts associated with
elements or symbol scripts themselves run as expected.
However, some scripts contained in symbols may run for a
long time and stop you interacting with other InTouch
elements.
To prevent this, you can set a script timeout, that is
applicable for all scripts in the IDE-managed InTouch
application. A script timeout stops script execution and
returns the control to the operator.
By default, scripts timeout after 5 seconds.

To set the script timeout


1 Open an IDE-managed InTouch application in
WindowMaker.
2 On the Special menu, click Configure, and then
WindowViewer. The WindowViewer Properties dialog box
appears.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Deploying the InTouchViewApp Object in a Terminal Services Environment 61

3 Click the Managed Application tab.

4 In the Script timeout (msec) box, type a value in


milliseconds.
5 Click OK.

Deploying the InTouchViewApp Object in a


Terminal Services Environment
You can run IDE-managed InTouch applications in a
Terminal Services environment. The main advantage of this
architecture is that you can run multiple InTouch
applications on one machine at the same time.
To do this, you must:
• Use InTouch Terminal Services Edition.

• Deploy each InTouchViewApp instance with its own


ViewEngine host.

InTouch ArchestrA Integration Guide

** DRAFT COPY **
62 Chapter 4 Using IDE-Managed InTouch Applications at Run Time

• Run each IDE-managed InTouch application in its own


terminal services client session.

Using IDE-managed InTouch applications


in a Terminal Services environment
Galaxy and Development Node

ArchestrA EDIT
$InTouchViewApp1
IDE $InTouchViewApp2
ViewEngine1
WindowMaker
DERIVE InTouchViewApp1
ViewEngine2
InTouchViewApp2

DEPLOY DEPLOY

Terminal Server

WindowViewer running
InTouchViewApp1
InTouch
IDE Platform
(Terminal
Services)
WindowViewer running
InTouchViewApp2

VISUALIZATION VISUALIZATION

Client1 Client2

InTouch ArchestrA Integration Guide

** DRAFT COPY **
Index 63

Index

A documentation conventions 7
adjusting, setpoint value 38 Downloaded Formula Parameters
reports, generating 58
as a new formula, saving 42
downloading
attributes to formula template
parameters, mapping 30 formulas 39
from the working space to the target
B space 15
dynamic attributes, Formula Manager
basic structure, formula file 122
Object 90
C E
changing access rights
editing, formula data 15
formula names 36
errorcode 78
formula parameters 34
errormessage 79
the formula commands 35
example of a Formula File in Excel 130
concepts, formula 10
existing formulas, overwriting 43
confighistorian 78
exporting Formula Files 23
configuring
formula download event 31 F
Formula Manager Object settings 31
files, formula 11
formula reporting data source 47
Formula
server timeout value 31
Import Export Utility, using 20
connecting, to the formula database 20
formula
creating
commands, changing access rights 35
formulas and formula templates 19
concepts 10
sample Formula File 25
data 126
database 13
D
database view definitions 103
data, formula 126
databases, selecting 27
database view definitions, formula 103
definitions 125
database, formula 13
download event, configuring 31
definitions, formula 125
download events, searching 62
deleting formulas in the formula
files 11
database 24

Sequencer Object User’s Guide

** DRAFT COPY **
64 Index

management concepts 11 alarms when errors occur 33


reporting data source, configuring 47 Downloaded Formula Parameters
template parameters from the formula reports 58
database, loading 29 Formula Details reports 52
template parameters, name, data type, Formula Download Details reports 57
default value, default limits and Formula Download List reports 55
engineering units 12 Formula Parameters reports 53
templates 10 Formula reports 51
templates from the formula database, Formula Template Details reports 49
selecting 28
Formula Template Parameters
templates, searching 60 reports 50
view definition 106 Formula Template reports 48
formula data Formula Templates List reports 49
editing 15 Formulas List reports 52
moving 15 PEM reports 59
searching 60
Formula Manager Object I
dynamic attributes 90 importing
settings, configuring 31 FMM Formula files 21
static attributes 77 formula files 21
formula parameters InTouch Recipe Manager files 22
attributes, mapping 27 InError.Alarmed 84
changing access rights 34 InError.Condition 84
name 12
FormulaDownload view definition 111 L
FormulaDownloadCmd 79 loading
FormulaDownloadEpa View formula template parameters from the
Definition 117 formula database 29
FormulaDownloadParameter View formulas from the formula database 37
Definition 113
LogFormulaDownloadEvent 85
FormulaLoadCmd 80
logging the formula download event 16
FormulaName 80
FormulaParameter view definition 108 M
formulas
management concepts, formula 11
and formula templates, creating 19
mapping
downloading 39
attributes to formula template
from the formula database, loading 37 parameters 30
searching 61 formula parameters to attributes 27
the formula database, saving 42 moving, formula data 15
FormulaSaveNewCmd 81
FormulaSaveOverwriteCmd 82 N
FormulaTemplate view definition 103 name
FormulaTemplateParameter view data type, default value, default limits
definition 105 and engineering units, formula
FormulaTmpltName 82 template parameters 12
FormulaUploadCmd 83
O
G overwriting, existing formulas 43
generating

Sequencer Object User’s Guide

** DRAFT COPY **
Index 65

P synchronizing the Formula Import


Export Utility with the formula
ParamNames 85
database 25
ParamStringNames 86
ParamTimeNames 86 T
propagating from the target space to the
Target.DownloadWriteStatus 88
target attributes 15
Target.FormulaName 89
R Target..HasLimits 91
Target..HighLimit 92
Rejected Messages Viewer Utility,
using 66 Target..InputOutput.Reference 93
reports Target..LowLimit 94
Downloaded Formula Parameters 58 Target..SP 95
Formula 51 Target..UseInputOutputSource 96
Formula Details 52 Target..WriteStatus 97
Formula Download Details 57 technical support, contacting 8
Formula Download List 55 template
Formula Parameters 53 definition 123
Formula Template 48 parameters 124
Formula Template Details 49 the formula
Formula Template Parameters 50 commands, changing access rights 35
Formula Templates List 49 timeout 89
Formulas List 52 troubleshooting
PEM 59 import and export of formulas 65
ResetCmd 86 messages 66
restrictions on formula data 127
U
S uploading
sample Formula File, creating 25 formulas 41
saving from the target space to the working
space 16
as a new formula 42
using
formulas to the formula database 42
Formula Import Export Utility 20
searching
Rejected Messages Viewer Utility 66
formula data 60
formula download events 62
formula templates 60
W
Working Space and Target Space 14
formulas 61
Working..DataType 98
securing your Formula Manager
Object 33 Working..EngUnits 99
selecting Working.FormulaName 90
formula databases 27 Working..HasLimits 99
formula templates from the formula Working..HighLimit 100
database 28 Working..LowLimit 101
server timeout value, configuring 31 Working..SP 102
static attributes, Formula Manager writing back from the target attribute to
Object 77 the target space 16

Sequencer Object User’s Guide

** DRAFT COPY **
66 Index

Sequencer Object User’s Guide

** DRAFT COPY **

You might also like