AVEVA™ System Platform Getting

Started Guide
© 2015-2023 by AVEVA Group Limited or its subsidiaries. All
rights reserved.
No part of this publication may be reproduced, stored in a
retrieval system, or transmitted, in any form or by any means,
mechanical, photocopying, recording, or otherwise, without
the prior written permission of AVEVA Group Limited. No
liability is assumed with respect to the use of the information
contained herein.
Although precaution has been taken in the preparation of this
documentation, AVEVA assumes no responsibility for errors or
omissions. The information in this documentation is subject to
change without notice and does not represent a commitment
on the part of AVEVA. The software described in this
documentation is furnished under a license agreement. This
software may be used or copied only in accordance with the
terms of such license agreement. AVEVA, the AVEVA logo and
logotype, OSIsoft, the OSIsoft logo and logotype, ArchestrA,
Avantis, Citect, DYNSIM, eDNA, EYESIM, InBatch, InduSoft,
InStep, IntelaTrac, InTouch, Managed PI, OASyS, OSIsoft
Advanced Services, OSIsoft Cloud Services, OSIsoft Connected
Services, OSIsoft EDS, PIPEPHASE, PI ACE, PI Advanced
Computing Engine, PI AF SDK, PI API, PI Asset Framework, PI
Audit Viewer, PI Builder, PI Cloud Connect, PI Connectors, PI
Data Archive, PI DataLink, PI DataLink Server, PI Developers
Club, PI Integrator for Business Analytics, PI Interfaces, PI
JDBC Driver, PI Manual Logger, PI Notifications, PI ODBC
Driver, PI OLEDB Enterprise, PI OLEDB Provider, PI OPC DA
Server, PI OPC HDA Server, PI ProcessBook, PI SDK, PI Server,
PI Square, PI System, PI System Access, PI Vision, PI
Visualization Suite, PI Web API, PI WebParts, PI Web Services,
PRiSM, PRO/II, PROVISION, ROMeo, RLINK, RtReports,
SIM4ME, SimCentral, SimSci, Skelta, SmartGlance, Spiral
Software, WindowMaker, WindowViewer, and Wonderware
are trademarks of AVEVA and/or its subsidiaries. All other
brands may be trademarks of their respective owners.
U.S. GOVERNMENT RIGHTS
4 • Contact information

Use, duplication or disclosure by the U.S. Government is

subject to restrictions set forth in the license agreement with
AVEVA Group Limited or its subsidiaries and as provided in
DFARS 227.7202, DFARS 252.227-7013, FAR 12-212, FAR
52.227-19, or their successors, as applicable.
Publication date: Thursday, November 2, 2023
Publication ID: 1284629
Contact information
AVEVA Group Limited
High Cross
Madingley Road
Cambridge
CB3 0HB. UK
https://sw.aveva.com/
For information on how to contact sales and customer
training, see https://sw.aveva.com/contact.
For information on how to contact technical support, see
https://sw.aveva.com/support.
To access the AVEVA Knowledge and Support center, visit
https://softwaresupport.aveva.com.
Contents
Welcome to AVEVA System Platform. . . . . . . . . . . . . . . . . 7
AVEVA Operations Control connected experience. . . . . . . 7
AVEVA System Platform functional components. . . . . . . . 8
AVEVA Application Server. . . . . . . . . . . . . . . . . . . . . . . . 8
AVEVA Development Studio. . . . . . . . . . . . . . . . . . . . . . 8
Visualization and analysis clients. . . . . . . . . . . . . . . . . . 9
AVEVA Historian. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Device integration tools. . . . . . . . . . . . . . . . . . . . . . . . . 10
AVEVA System Monitor. . . . . . . . . . . . . . . . . . . . . . . . . . 10
Other tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Before you start. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Development environment. . . . . . . . . . . . . . . . . . . . . . . . 13
Start the System Platform IDE. . . . . . . . . . . . . . . . . . . . . . . 13
Create a Galaxy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Connect to a Galaxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Run the default System Platform ViewApp. . . . . . . . . . . . 17
Become familiar with basic ViewApp features. . . . . . . . . 18

Workflow 1: Design standards. . . . . . . . . . . . . . . . . . . . . 21

Design graphic standards. . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Create a graphic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Edit a graphic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Build a graphic from graphic elements. . . . . . . . . . . . 25
Create object standards. . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Create a derived template or an instance. . . . . . . . . . 27
Edit objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Work with Object Wizards. . . . . . . . . . . . . . . . . . . . . . . . . . 29
Create screen profile standards. . . . . . . . . . . . . . . . . . . . . . 30
Create layout standards. . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
6 • Contents

Workflow Group 2: Build a ViewApp. . . . . . . . . . . . . . . . 33

Create a ViewApp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Assign screen profiles and layouts to a ViewApp. . . . . . . 35
Place content in a ViewApp. . . . . . . . . . . . . . . . . . . . . . . . . 36
Embed a graphic in a ViewApp. . . . . . . . . . . . . . . . . . . 36
Place an object in a ViewApp. . . . . . . . . . . . . . . . . . . . 37
Add external content to a ViewApp. . . . . . . . . . . . . . . . . . 38

Workflow Group 3: Deploy a ViewApp. . . . . . . . . . . . . . 41

Prepare to deploy a ViewApp. . . . . . . . . . . . . . . . . . . . . . . 42
Deploy a ViewApp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Workflow Group 4: Run a ViewApp. . . . . . . . . . . . . . . . . 45

Launch and run a ViewApp. . . . . . . . . . . . . . . . . . . . . . . . . 45

Get more information. . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Application Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
AVEVA OMI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
AVEVA InTouch HMI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
AVEVA Historian. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
AVEVA Historian Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Technical support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Product training. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Welcome to AVEVA System Platform
AVEVA System Platform is an industrial software platform that
uses System Platform technology for human machine
interface (HMI), operations management, SCADA, and
production and performance management.
System Platform contains an integrated set of services and an
extensible data model to manage plant control and
information management systems. System Platform supports
both the supervisory control layer and the manufacturing
execution system (MES) layer, presenting them as a single
information source.
Modular applications sit on top of System Platform. Other
third-party integrators are delivering a growing inventory of
application components that use System Platform services.

AVEVA Operations Control connected experience

AVEVA Operations Control is an industrial software
subscription to one or more of two packages that provides
access across both on-premises and cloud applications. This
flexibility provides multiple configuration, architecture, and
deployment options that support your objectives and meet
your requirements.
Adding connected experience to an Operations Control
subscription provides the security of federated identity
management for authentication and authorization,
superseding the segmented approach of individual product
security configurations. Authentication is via a unified AVEVA
ID, configured and managed through AVEVA Connect.
The connected experience provides stable user account and
credential management across all products, and streamlines
secure access to your licensed products, applications, and
data.
8 • Welcome to AVEVA System Platform

AVEVA System Platform functional components

The following figure shows a functional representation of
System Platform, which incorporates an architectural
framework.

The framework consists of server-side configuration- and

deployment related components. In System Platform, these
components include a centralized object repository (Galaxy
Repository), an integrated development environment (IDE),
and a database to store historical data (Historian).

AVEVA Application Server

AVEVA Application Server provides an object-based
framework repository to construct an asset hierarchy of your
physical processes. This repository, called a Galaxy, is built on
a SQL Server database that manages the deployment and
operation of the run-time elements that form a System
Platform application.

AVEVA Development Studio

AVEVA Development Studio is an engineering environment
for developing, maintaining, and managing for supervisory
SCADA and HMI application development. It provides a
 Welcome to AVEVA System Platform • 9

shared development environment that helps you drive

standards and best practices across your company.

Visualization and analysis clients

Visualization and analysis clients enable you to visualize real-
time and historical data from System Platform.
• AVEVA InTouch HMI provides an optional visualization
capability for control and optimization of any industrial and
manufacturing process through unparalleled situational
awareness.
• AVEVA Operations Management Interface (OMI) delivers
immersive control applications that weave context
throughout the visual design, including situational
awareness concepts, for improved operator performance.
With AVEVA OMI, you can create responsive visualizations
that organize content based on user devices. These
visualizations use AVEVA System Platform's asset model
hierarchy to drive intuitive navigation, adapting content and
context, based on user selection.
• AVEVA Insight is an AI-infused SaaS application for asset
reliability and operational performance visualization for
hybrid markets. Users can access critical asset and process
data with powerful visualization tools that drive prescriptive
actions, ranging from self-service analytics with no
programming required, to comprehensive analytics for in-
depth analysis of critical assets and processes.

AVEVA Historian
AVEVA Historian is a process database integrated with
operations control, enabling access to your process, alarm,
and event history data. It stores plant data from
Communication Drivers and other data sources, allowing
operators to make real-time decisions from a secure and
trustworthy set of industrial data. AVEVA Historian also
contains summary, configuration, and system monitoring
information. AVEVA Historian enhances and is tightly coupled
to Microsoft SQL Server.
10 • Welcome to AVEVA System Platform

Device integration tools

System Platform can connect to a diverse set of data sources
to integrate all plant and industrial data. The System Platform
IDE offers I/O auto-assignment and I/O mapping features to
streamline device integration and data access.
Data sources include OPC and OPC UA Servers, databases,
and any application that exposes data from an API such as
XML, SQL, HTTP, or .NET. In addition, a library of device
integration tools provide data from the factory floor.
• Communication protocols provide data from PLCs and
other factory devices to HMI applications. These protocols
can be used with any Microsoft Windows program or
supervisory application capable of acting as a DDE,
FastDDE, OPC, OPC UA, or SuiteLink™ client.
• A Communication Driver encapsulates the functionality of
an I/O server in the System Platform environment.
Communication Drivers are models of the network and
devices associated with a specific HMI application. The
hierarchy of the the Communication Drivers is the same as
the hierarchy of the actual devices.

AVEVA System Monitor

AVEVA System Monitor keeps a watchful eye on the critical
performance indicators associated with your AVEVA software
applications and the underlying hardware to proactively
maintain healthy systems for easy maintenance and reliability.
 Welcome to AVEVA System Platform • 11

Other tools
System Platform readily integrates with other applications
including:
• AVEVA Teamwork is a Software-as-a-Service (SaaS) app that
allows users to perform tasks, achieve learning goals,
identify and manage issues, and capture and document
standards. AVEVA Teamwork enables industrial
organizations to implement skills development, knowledge
sharing, and collaboration management across their
enterprise from the cloud.
• AVEVA Reports is no-code software with simple drag-and-
drop, point-and-click configuration, and integration of real-
time sources and manual data to HMI/SCADA, historians,
enterprise software and relational databases.

Before you start

This booklet describes a set of essential workflows to get you
started building applications with System Platform. It explains
the steps to create an OMI ViewApp.
For information about creating InTouch HMI applications, see
the InTouch HMI Getting Started Guide.
Before you get started building an OMI ViewApp, you must
install, configure, and activate the licenses of your System
Platform products. The last section of this booklet includes a
set of tables that list the documentation for each System
Platform product.
Installation
Installing System Platform products is a straightforward
procedure of selecting options from a series of installation
dialogs. You can find more information about hardware and
software installation requirements in the AVEVA System
Platform Installation Guide.
12 • Welcome to AVEVA System Platform

Configuration
Immediately after installation, the Configurator appears to
configure various aspects of System Platform, including
product licensing, security, and the Historian database. The
AVEVA System Platform Installation Guide includes guidance
for configuring System Platform products.
Licensing
All System Platform products must have their licenses
activated to be fully functional. Before you can complete the
procedures described in this booklet, you must activate your
product licenses and subscriptions.
Development environment
The System Platform IDE and AVEVA InTouch HMI
WindowMaker are typically installed on the same computer,
referred to as the System Platform Development Server. You
use the System Platform IDE to build your AVEVA OMI
ViewApps and InTouch HMI managed applications.

Start the System Platform IDE

You start the System Platform IDE by selecting the System
Platform IDE icon from from your computer’s Start menu or
the Windows Apps window.
To start the System Platform IDE
1. Open the Windows Start menu.
2. Locate the AVEVA System Platform app group.
3. Select the AVEVA System Platform IDE folder.
14 • Development environment

The IDE Home dialog box appears.

Some details
• You must create and connect to a Galaxy before the System
Platform IDE opens.
• Your product licenses or subscriptions must be activated
before starting the System Platform IDE
• You must be a member of the aaConfigTools Windows user
group to connect to a Galaxy from the IDE. The
aaConfigTools user group is created during System Platform
installation. Assign users to this group through the Local
Users and Groups utility of the Windows Control Panel.
• For more information, see "Steps to Create a Galaxy" in the
Application Server Help.
Some definitions
• Galaxy - The entire application. The complete system
consisting of a single logical name space (defined by the
Galaxy Database) and a collection of Platforms, Engines and
objects. It can includes one or more networked computers
that constitute an automation system. This is referred to as
the Galaxy Namespace.
• Galaxy database - The relational database containing all
persistent configuration information like templates,
 Development environment • 15

instances, security, etc. The galaxy database is created when

you create a galaxy.
• Galaxy repository - Can contain one or more Galaxy
Databases.

Create a Galaxy
You must connect to a new or existing Galaxy each time you
start the System Platform IDE.
To create a Galaxy
1. Start the System Platform IDE.
2. Select the New button and then select a galaxy template.
The New Galaxy dialog opens.

3. Enter a Galaxy name in the Galaxy name field. Complete

the fields of the New Galaxy dialog box.
4. Click Create to begin creating a new Galaxy.
5. Click Close after the new Galaxy is created.
Some details
• You can only create a new Galaxy on a computer with the
Bootstrap and Galaxy Repository software installed.
• The IDE automatically connects to the newly created Galaxy
when the "Connect to this Galaxy" checkbox is enabled.
• Typically, you will select the Default.cab as the Galaxy type
to build AVEVA OMI ViewApps.
16 • Development environment

Connect to a Galaxy
You must connect to a Galaxy before you can perform any
work on a ViewApp using the System Platform IDE.
To connect to a Galaxy
1. Start the System Platform IDE.
2. Select the Recent, Pinned, or On server tab and then
select the Galaxy that you want to open.
3. Select the Open icon.
The IDE opens and shows the different views of your Galaxy.

The IDE provides different ways to view the structure of the

Galaxy and how it will be deployed to run time.
Some details
• For more information, see "Connect to a Galaxy" in the
AVEVA Application Server Help.
 Development environment • 17

Run the default System Platform ViewApp

System Platform provides a set of default symbols, apps, and
other content, and templates that are accessible from the
System Platform IDE. Folders containing default content and
templates are located in the Template Toolbox and Graphic
Toolbox.
A default ViewApp is also included. After deploying the
ViewApp, you can run immediately without any editing.
To run the default ViewApp
1. Select the Deployment tab at the bottom left of the IDE.
The Deployment view shows the arrangement of
supporting system objects that are required to run a
ViewApp. Beneath the ViewEngine object is the default
ViewApp named OMI_ViewApp_Desktop.
The exclamation point icon to the right of each object
indicates the object is in an undeployed state.
2. Select Deploy from the ribbon bar, or right-click and select
it from the shortcut menu.
3. Click OK from the Deploy dialog box.
The Deploy dialog box shows the progress of deploying all
of the objects. The "undeployed" icon disappears as each
object is deployed.
4. On the Windows desktop, locate the AVEVA Application
Manager icon and open it.
5. Select the ViewApp you want to run and click the LAUNCH
button.
The ViewApp should start running in several seconds.
Some details
• Right-click on deployed objects and select Properties. The
General tab lists the template the object was derived from.
• Workflow Groups 3 and 4 in this booklet provide more
information about deploying and running a ViewApp.
18 • Development environment

Become familiar with basic ViewApp features

The default ViewApp provided with System Platform
demonstrates some of the basic features of a ViewApp.

You can place a slide-in pane on each

side of a ViewApp window. During run
time, slide-in panes are hidden until
you select the tab to extend the slide-in
pane and show its contents.

You can place navigation icons within a

pane that include short navigation
scripts. This allows you to return to the
home view or scroll forward or
backward through a sequence of views.

System Platform includes a default set

of apps that you can drag and drop
onto a pane requiring minimal
configuration. This example shows the
default Map app, which provides
controls and touch support to enable
users to pan to different areas of the
map and zoom in or out to show more
or less map detail.
 Development environment • 19

System Platform includes a NavTree

app that shows a ViewApp's navigation
items arranged in a hierarchical tree.
When you select an item from the tree,
the content of the selected view are
displayed.
20 • Development environment
Workflow 1: Design standards
You can create symbols and objects that are incorporated into
your ViewApps. Rather than create unique symbols and
objects for each ViewApp, you can use IDE tools to create a
set of reuseable template symbols and objects that can be
individually configured to meet the differing requirements of
your ViewApps.
The following figure summarizes the major workflows to
create reusable standards you need to build ViewApps. As
shown in the figure, the System Platform IDE includes a set of
editors to build reusable symbols, objects, scripts, layouts, and
screen profiles.
22 • Workflow 1: Design standards

Design graphic standards

System Platform provides a set of graphic tools and libraries
to visualize data in a ViewApp. You can use these tools within
the Graphic Editor to create graphics from basic elements,
such as rectangles, lines, and text.
You can also embed pre-built graphics from the Industrial
Graphic and Situational Awareness libraries in a template to
visualize object-specific information. Embedding a graphic
enables you to update one graphic template and cascade the
changes throughout all of the instances of the graphic in your
application.
Standard Industrial Graphics, available from the Visualization
folder, show reasonably realistic views of process objects. You
can embed an Industrial Graphic in a template or instance of
an object to visualize object-specific information.

The Situational Awareness Library contains protected graphics

that include multiple visual and functional configurations.
These are enabled by selecting values from a set of Wizard
Options associated with each graphic. Incorporating multiple
configurations in a single graphic reduces the types and
numbers of visualization elements you need to develop for an
application.
 Workflow 1: Design standards • 23

Create a graphic
You can create a symbol in the Visualization folder by the
following methods:
• Keyboard shortcut: Press Ctrl + Shift + H
• Shortcut menu: From the Visualization folder, right-click
on the Galaxy name, select New, and then select Graphic.
• Ribbon Bar: From the Home tab, select Graphic from the
Create group
You should see the symbol listed in the Visualization folder
as Graphic_001 with a blue background. The symbol is
selected and you can assign a new name by typing over the
default name.
Depending on your development requirements, you can
select where and how to store Industrial Graphics.
• Store graphics in the Visualization folder if you want to
define them as a reusable standard that will be used
frequently.
• Store graphics as AutomationObject templates if you want
to re-use the graphic in combination with the object
functionality.
• Store graphics in the Content pane of an
AutomationObject instance. Do this if you are unlikely to re-
use the graphic in any other situation.
Some details
• Graphic names must be unique within the entire
Visualization folder hierarchy.
• Valid characters for graphic names include alphanumeric
characters, #, and _ (underscore).
• Symbol names cannot contain spaces and the symbol name
cannot begin with the $ character.
24 • Workflow 1: Design standards

Edit a graphic
After you create a graphic, you need to check it out in order
to edit it in the Industrial Graphic Editor. You also need to
check the graphic in the after you are done editing it.
To edit a graphic in the Visualization folder
1. In the Visualization folder, right-click on the graphic you
want to edit and select Check Out.
The checked-out icon (an open padlock) appears to the left
of the graphic name to indicate that it is checked out.
2. Right-click on the checked-out graphic and select Open to
show the graphic in the Graphic Editor.
3. After you have finished editing the graphic, click Save and
Close from the task bar of the Graphic Editor.
When you save and close the graphic, it is automatically
checked in.
To edit a graphic contained in an object
1. Open the object in the Object editor.
2. In the Attributes tab, go to the Content pane.
3. Select the graphic and click the edit content (pencil) icon.
The Industrial Graphic Editor appears.
4. Edit the graphic.
5. Click Save and Close.
The Industrial Graphic Editor closes and the updated
graphic is checked in.
Some details
• Situational Awareness Library graphics are protected
templates and cannot be directly edited. You must embed
an instance of a Situational Awareness Library graphic in
another graphic to edit it and make configuration changes.
• You check out a graphic when you open it for editing with
the Industrial Graphic Editor. No other user can edit the
graphic while you have it checked out.
 Workflow 1: Design standards • 25

Build a graphic from graphic elements

You can assemble and edit a set of graphic elements in the
Industrial Graphic Editor to represent a visual component.
To build a symbol from graphic elements
1. Check out and open a symbol .
The Industrial Graphic Editor opens and shows the Tools
menu in the upper left corner.

2. Select a graphic element from Tools to include in the

symbol.
3. Move the cursor over the canvas area.
The cursor shape should change to a plus sign.
4. Holding your left mouse key down, drag the mouse to set
the initial size of the graphic element.
5. Select the graphic element and then select an option from
the Configuration bar to configure the visual appearance
of the graphic element.
Continue adding and configuring elements as needed to
complete your graphic.
6. Select all graphic elements, right-click, and then select
Grouping >Group option from the shortcut menu.
7. Save and Close the Industrial Graphic Editor. This
automatically checks the graphic back into the
Visualization folder.
26 • Workflow 1: Design standards

Some details
For more information about creating and integrating graphic
elements into a ViewApp, see "Working with Graphic
Elements" in the Industrial Graphic Editor Help.

Create object standards

The Template folder is the part of the System Platform IDE
that shows host objects organized by folders, from which
other object templates are derived or instances are created.

Templates are objects that contain common configuration

parameters for object instances that can be re-used.
Derived templates are created from base templates. Base and
derived templates are identified in the Template folder by a
dollar sign ($) as the prefix to their names.
Object instances are the specific devices in your environment
that are deployed as part of your ViewApp. You create an
instance from a template and then customize the specific
instance as needed.
 Workflow 1: Design standards • 27

Some details
Only object instances are deployed to the run-time
environment. Templates exist in the development
environment and cannot be deployed to a ViewApp.

Create a derived template or an instance

Select the template from the Template folder that you want
to use to create a derived template or instance. You can create
a derived template or an instance by the following methods:
• Keyboard shortcut
Derived template: Press Ctrl + Shift + N
Derived instance: Press Ctrl + N
• Shortcut menu
Right-click on the base template, select New, and then
select either Instance or Derived Template.
• Ribbon Bar
From the Home tab, select Instance or Template from the
Create group.
The new derived template is listed in the Template folder as
$<ObjectName>_001. A new instance appears in the Model,
Deployment, and Derivation views as <ObjectName>_001.
You can rename the derived template or instance.
Some details
• All templates you create are derived templates. A derived
template inherits attributes and behaviors from the base
template. You cannot change the attributes in a base
template.
• Derived template and instance names can be up to 32
alphanumeric characters. Derived template and instance
names must include at least one letter and cannot include
spaces. An instance name cannot have $ as the first
character.
28 • Workflow 1: Design standards

Edit objects
The Object Editor contains tabbed pages to modify objects.

Each Object Editor page modifies a specific aspect of objects.

The Attributes, Scripts, and Object pages are common to all
objects. Other pages are unique to certain object types
To edit an object
1. From the Template folder, double-click on an object to
open it in the Object Editor.
2. Make your modifications to the object.
3. Select Save or Close from the Galaxy menu.

Some details
• When you open the Object Editor, the object is checked
out. No one else can edit the checked-out object.
• When you save an object, the configuration data for the
object is validated. If errors or warnings are identified
during validation, a message appears.
 Workflow 1: Design standards • 29

• When you close the object, it is checked in unless you

specify that you want to keep it checked out.

Work with Object Wizards

An Object Wizard can be added to any derived template to
provide a simplified user interface to build a set of object
configurations. Users select from these choices and options.
Each object configuration has a unique combination of
attributes, scripts, and graphics.

You can replace the requirement for many derived templates

by using a single template with an Object Wizard that
supports multiple configurations.
Some details
• Attributes and features contained in the Object Wizard that
are not needed in a particular instance are removed from
the run-time object.
• To maximize the benefits of using Object Wizards, add your
Object Wizard to the template as close to the top level of
the derivation hierarchy as possible.
30 • Workflow 1: Design standards

• For details on creating Object Wizards, see "Configuring

and Using Object Wizards" in the Application Server Help.

Create screen profile standards

A screen profile defines the physical characteristics of one or
more client workstation screens and how these screens are
arranged with respect to each other. Each screen icon that
appears in a screen profile represents a physical screen of a
computer running a ViewApp.
A screen profile can represent all of the monitors in a
production control room or the single screen of a cell phone.

You assign a screen profile to a ViewApp with the

Initialization wizard the first time you open the ViewApp.
Some details
• The System Platform IDE includes a set of default screen
profiles located in the Visualization folder. See the Default
Content 1. Screen Profiles folder.
• A screen profile includes a set of lock properties to ensure
safety using touch screens while running a ViewApp.
• For details on creating and configuring screen profiles, refer
to the AVEVA OMI Help.
 Workflow 1: Design standards • 31

Create layout standards

Layouts define the organization of rectangular areas of a
screen called panes that contain content shown in a ViewApp.

You configure layouts with the Layout Editor. The Layout

editor includes controls to add panes and adjust their size and
arrangement to other panes within the layout's window. The
Layout editor provides properties to configure the layout itself
and each individual pane. You can also drag and drop content
onto panes as part of configuring a layout.
Some details
• The Layout editor includes a script editor to write built-in
OnShow, While Showing, and On Hide scripts.
• Responsive layout mode enables you to create a layout for
ViewApps that will run on a variety of different device
screen sizes.
• For details on creating, configuring, and adding content to
layouts, see "Add Content to Panes" in the AVEVA OMI Help.
32 • Workflow 1: Design standards
Workflow Group 2: Build a ViewApp
A ViewApp typically includes a set of related screen profiles
and layouts. You associate screen profiles and layouts the first
time you open your ViewApp using the Initialization wizard.
Graphic and object standards can be added to a ViewApp
from either the Layout or ViewApp editors.
The ViewApp Editor is the integration tool to combine your
reusable standards to build a ViewApp. The ViewApp Editor
incorporates the ability to add, replace, and edit screen
profiles, layouts, and content

Also, based on defined user roles and assigned access levels,

you can use the ViewApp editor to restrict the display of
ViewApp content to specific user roles.
34 • Workflow Group 2: Build a ViewApp

Create a ViewApp
You must create a ViewApp derived template before you can
begin editing a ViewApp instance (only instances can be
deployed to run time). Create a new ViewApp by any of the
following methods:
• Keyboard shortcut: Select base ViewApp template, then
press Ctrl + Shift + N to create a derived template. Press
Ctrl + N to create a ViewApp instance.
• Shortcut menu: Right-click on the ViewApp base template,
select New, and then select Derived Template. To create a
ViewApp instance, select the derived template, select New,
and then select Instance.
• Ribbon bar: Select the ViewApp base template, and then
select Template from the ribbon bar. To create a ViewApp
instance, select the derived template, then select Instance
from the ribbon bar.
To create a ViewApp derived template
1. Open the System Platform IDE and select the Template
Toolbox tab to show your Galaxy objects.
2. Expand the Default Templates folder and open the 4.
ViewApps folder.
3. Right-click on the $ViewApp base template, select the New
option, and then select Derived Template.
A $ViewApp derived template appears with an error icon (X
in a black circle) to the left of the template name. This
indicates that it is not yet configured.

Some details
• A screen profile and layouts must be assigned the first time
you open a ViewApp in the ViewApp editor.
• See "Steps to Create a ViewApp" in the AVEVA OMI Help for
more information about assigning a screen profile and
layouts to a ViewApp.
 Workflow Group 2: Build a ViewApp • 35

Assign screen profiles and layouts to a ViewApp

When you start the ViewApp Editor for the first time after
creating a ViewApp, the ViewApp Initialization Wizard
appears to select a screen profile and layout(s) that will be
used with the ViewApp.
To assign screen profiles and layouts to a ViewApp
1. Open the System Platform IDE and select the Template
folder.
2. Locate the ViewApp derived template and select it.
The ViewApp Initialization Wizard appears with a set of
screen profiles.

3. Select a screen profile from the list and select Next.

4. Select a screen within the profile to place a layout, then
select a layout and associate it with the screen.
5. Select Finish to open the ViewApp and start editing.
Some details
• At least one screen in a profile must be associated with a
layout before editing with the ViewApp editor (profiles can
contain multiple screens).
• For more information about assigning a screen profile and
layouts to a ViewApp, see "Steps to Create a ViewApp" in
the AVEVA OMI Help.
36 • Workflow Group 2: Build a ViewApp

Place content in a ViewApp

You can add content to a ViewApp from the ViewApp Editor
using a drag and drop mouse action or finger gesture.
Assigning content to a pane adds a Show Content action to
the ViewApp’s navigation Action List.
Select either the Toolbox or Assets tab to show a list of
content.
Content can include graphics, layouts, controls, and app
instances.
If you select a folder, the content area beneath the list shows
thumbnails of the content within it

Embed a graphic in a ViewApp

Preview thumbnails of graphics appear beneath the tabbed
Toolbox list of the ViewApp or Layout editors.
 Workflow Group 2: Build a ViewApp • 37

You place a graphic in a ViewApp by using your mouse to

select and drag a graphic from the Toolbox area and drop it
onto a layout pane from the Layout or ViewApp editors.
Objects shown in the tabbed Assets area of the Layout or
ViewApp editors can be placed in a ViewApp using a similar
drag and drop method.

Place an object in a ViewApp

You can create a graphic to embed in an empty pane shown
from the ViewApp Editor. Typically, you create a graphic to
contain an embedded graphic associated with an object.

The Graphic Editor appears again to embed the graphic you

selected in the new symbol.
The Configure New Asset wizard appears with options to
configure the graphic.
The pane in the ViewApp Editor should show the graphic you
created.
38 • Workflow Group 2: Build a ViewApp

Add external content to a ViewApp

External content refers to content outside of a Galaxy that can
be shown in a running ViewApp.
External content is associated with a ViewApp by placing an
external content item on a layout pane during design time. An
external content item is created and then configured with the
external content editor to identify the location of the content
and the type of content.
The following figure summarizes the major workflows during
design time to configure an external content item to point to
content that operators can display while managing a running
ViewApp.

Some details
• An external content item can be incorporated into a
ViewApp by dragging the item thumbnail onto a layout
pane or linking it to an object.
• System Platform includes a set of four default apps to
incorporate external videos, spreadsheets, Microsoft Word
documents, or images into a running ViewApp.
• Place your external content at a folder location within your
network. Verify connectivity between your computer and
the folder containing external content.
• You can create, edit, configure and associate an external
content item with an OMI ViewApp. See "External Content"
in the AVEVA OMI Help for details.
Workflow Group 2: Build a ViewApp • 39
40 • Workflow Group 2: Build a ViewApp
Workflow Group 3: Deploy a ViewApp
An instance of your ViewApp must be deployed with a
ViewEngine and other system and application objects before
you can run it.
Deployment instantiates Galaxy objects in a run-time
environment, which are required to run a ViewApp. You must
deploy your objects before attempting to run a ViewApp.
You can see the arrangement of your system and application
object instances from the Deployment or Model views of the
System Platform IDE.

Some details
• Deployment includes installing the required software on a
target computer. Bootstrap software must be installed on
every computer running a ViewApp.
• No object can be in an error state to deploy a ViewApp.
• Objects must be checked into the Galaxy.
42 • Workflow Group 3: Deploy a ViewApp

Prepare to deploy a ViewApp

You can deploy and test your objects at any time during
development. When you are ready to test or run a ViewApp in
production, you deploy the Galaxy. You can see what your
application looks like in the Deployment view or Model view
of the System Platform IDE. Both views show you the structure
of your application.
The Deployment view provides the simplest way to
understand the object hierarchy during deployment. Objects
appear in a hierarchical tree structure according to their
distribution relationships.
• The top of the tree is the Galaxy.
• WinPlatforms are shown under the Galaxy.
• AppEngines are under each WinPlatform.
• Under each AppEngine, assigned Areas and device
integration (DI) objects, such as OPCClient objects, are
listed.
• Assigned application objects are listed under each Area.
• Under each application object, contained application
objects are listed. Multiple levels are allowed.
• Communication Drivers are listed under the device
integration object to which they are assigned.
• Unassigned objects are placed in the Unassigned Area
folder. Area and containment relationships are maintained
in this view.

Deploy a ViewApp
You can tell if you have objects that need to be deployed by
checking the icons next to the objects. The icons are visible in
the Deployment, Model, and Derivation views.
 Workflow Group 3: Deploy a ViewApp • 43

To deploy a ViewApp
1. Right-click on the Galaxy object in the Deployment view
and select the Deploy option from the shortcut menu.
The Deploy dialog box appears.

2. Accept the default options and select OK.

Key points
• During deployment, all files to run a ViewApp are copied to
a folder on the client computer designated to run the
ViewApp.
• A cascade deploy operation deploys all objects in
hierarchical order. A cascade operation deploys a host
object before deploying its child objects.
44 • Workflow Group 3: Deploy a ViewApp
Workflow Group 4: Run a ViewApp
You typically run a ViewApp on a different computer than the
computer you use to develop a ViewApp. You start a ViewApp
by selecting it from a list of deployed ViewApps shown from
AVEVA OMI Application Manager.

Launch and run a ViewApp

After you successfully deploy your ViewApp, you can launch it
from AVEVA OMI Application Manager.
To launch and run a ViewApp
1. Show the Windows desktop of the computer where the
ViewApp has been deployed.
46 • Workflow Group 4: Run a ViewApp

2. Select the AVEVA OMI Application Manager icon shown on

the Windows desktop.

Application Manager appears with a list of deployed

ViewApps.

3. Select the LAUNCH button of the ViewApp that you want

to run.
After several seconds, the ViewApp's main window appears
in a separate window on your screen.
Some details
• You can run multiple ViewApps simultaneously.
• Click the icon shown to the right of the LAUNCH button for
options to run the ViewApp in read/write mode (default) or
launch the ViewApp with a read-only data connection.
 Workflow Group 4: Run a ViewApp • 47

• You can run a ViewApp in preview mode to preview and

assess your changes in run-time mode. This lets you work
more quickly because you do not have to undeploy and
redeploy objects each time you make a change.
48 • Workflow Group 4: Run a ViewApp
Get more information
The System Platform library consists of a set of online books
and help. Each product that is part of System Platform
includes individual documentation about using the product.
System Platform documentation is offered in two different
media:
• Portable Document File (PDF), which can be viewed with
Adobe® Reader®. Each book is included on the product
installation DVD as a PDF file.
• Installed web help, which is accessible from the Windows
start menu (listed as AVEVA help). Hyperlinks built into
System Platform products, such as the IDE and InTouch
WindowMaker, also provide access to the help.
The PDF books and online help include a table of contents
and a search function to find information quickly.
Product documentation uses a task-based approach. This
means information is organized by the typical workflows to
build, configure, and use the System Platform products.

Application Server
The following table describes each Application Server
document in the library.

Publication Name
(file name) Description

AVEVA System Includes descriptions of new

Platform Readme product features introduced in
ReadMe.html System Platform, installation
requirements, and any known
issues.
50 • Get more information

Publication Name
(file name) Description

AVEVA Application Explains configuring and

Server User Guide deploying Application Server and
IDE.pdf AVEVA OMI applications.

Industrial Graphics Explains how to create and

User Guide manage Industrial Graphics with
IndustrialGraphics.pdf the Graphic Editor within the
Integrated Development
Environment (IDE).
Application Server Reference for the Application
Scripting Guide Server scripting language.
Scripting.pdf
Object Viewer User Explains how to acquire run-time
Guide data using the Object Viewer.
ObjectViewer.pdf
Alarm Control Guide Explains how to configure the
AlarmClientControl. alarm control (client) to show
pdf current and historical alarms and
events in a grid.
Trend Client User Explains how to configure a chart
Guide to trend real-time data values.
TrendClient.pdf
Platform Manager Explains how to start and stop
User Guide system components.
PlatformManager.pdf
Galaxy Database Explains how to back up and
Manager User Guide restore the Galaxy database.
galaxymanagement.p
df
 Get more information • 51

Publication Name
(file name) Description

Log Viewer User Guide Explains how to use the Log

LogViewer.pdf Viewer utility to determine system
diagnostics.
Log Flag Editor User Explains how to turn on and off
Guide certain diagnostics logging
LogFlagEditor.pdf messages.

AVEVA Enterprise Explains how to use the AVEVA

Licensing Guide Licensing system to manage
AELicenseManagerGui software product licenses.
de.pdf
Protocols User Guide Explains background information
Protocol.pdf on the main protocols used
between components of System
Platform products.

Application Server documentation is also available as locally

installed web help. Press F1 from the System Platform IDE to
show the help in your browser.

AVEVA OMI
All AVEVA OMI product documentation is available as locally
installed web help.
The AVEVA OMI help system includes tutorial videos, a search
engine, a table of contents, and a set of navigation controls to
find information quickly and easily.

AVEVA InTouch HMI

The following table describes the InTouch documentation
library delivered as PDF files. Web help is available for each
application.
52 • Get more information

Publication Name
(file name) Description

AVEVA™ InTouch HMI Contains information on creating

Creating Standards for standards for various InTouch HMI
InTouch HMI components, and describes how to
Components Guide prepare the development
ITStandards.pdf environment, view the application
in run time, and gain an
understanding on how to work
with tags, alarms, and data items
in the InTouch HMI to connect
your application to the physical
devices in your plant environment.
AVEVA™ InTouch HMI Contains information on creating
Application Development and managing InTouch HMI
Guide applications locally and in a
ITBuild.pdf network environment, including:
How to create visualization
windows, how to draw and
animate graphic elements, and
how to use wizards and ActiveX
controls in your application.
This guide also includes a
reference of the InTouch HMI
scripting language and functions,
along with details on working with
Industrial Graphics in the Cloud..
AVEVA™ InTouch HMI Contains information on deploying
Application Deployment InTouch HMI applications to work
Guide with terminal and remote desktop
ITDeploy.pdf services, and describes how to
configure InTouch HMI Network
Application Development and use
Managed applications at run time.
 Get more information • 53

Publication Name
(file name) Description

AVEVA™ InTouch HMI Contains information on using

Application Run Time WindowViewer and Web Client to
Guide view the InTouch HMI applications
ITOperate.pdf in run time, and also describes
viewing application graphics in a
web browser, with a focus on
language switching, tag viewer,
and various alarm components.
AVEVA™ InTouch HMI Contains information on migrating
Application Maintenance and upgrading InTouch
Guide applications, components, and
ITMaintain.pdf alarms, and also describes how to
set up an InTouch HMI application
on tablet PC or multi monitors.

AVEVA™ InTouch HMI Contains troubleshooting

Troubleshooting Guide information to understand error
ITDiagnose.pdf messages and resolve issues with
the InTouch HMI application and
Web Client.
AVEVA™ InTouch HMI Contains authentication and
Management Guide entitlement information for the
ITManage.pdf InTouch HMI application and Web
Client, as well as generic and
InTouch-specific security
configurations, and also describes
using other supplementary
components.
54 • Get more information

AVEVA Historian
The following table describes the AVEVA Historian
documentation library delivered as PDF files. Locally installed
web help is available from within the application.

Publication Name
(file name) Description

Historian Concepts Guide This guide provides an overview of

HistorianConcepts.pdf the entire Historian system and
describes each of the subsystems in
detail.
Historian Administration This guide describes how to
Guide administer and maintain an installed
HistorianAdmin.pdf Historian, such as configuring data
acquisition and storage, managing
security, and monitoring the system.

Historian Database This guide provides documentation

Guide for all of the Historian database
HistorianDatabase.pdf entities, such as tables, views, and
stored procedures.

Historian Glossary This guide provides definitions for

HistorianGlossary.pdf terms used throughout the
documentation set.

Historian Retrieval Guide This guide describes the retrieval

HistorianRetrieval.pdf modes and options that you can
use to retrieve your data.

Historian Scenarios This guide discusses how to use

Guide Historian to address some common
HistorianScenarios.pdf customer scenarios.
 Get more information • 55

AVEVA Historian Client

The following table describes the Historian Client
documentation delivered as a PDF file. Online help is available
from within the application.

Publication Name
(file name) Description

Historian Client User This guide describes how to use the

Guide Historian Client to organize, explore,
HistClient.pdf analyze, present, and disseminate
process data in a wide variety of
formats.

Technical support
AVEVA Technical Support consists of a global team of
qualified Certified Support Providers. If you have questions or
concerns about System Platform, contact AVEVA Technical
Support.
Telephone: U.S. and Canada
800-966-3371
7 a.m. to 5 p.m Pacific Time

Outside the U.S. and Canada

For local support in your language,
contact a certified support provider in
your area or country.
Refer to the following web address for a
local phone number in your country:
Dial your country's local international
direct dialing (IDD) code and then the
800-number listed for your country.

Fax: +1 949-639-1545
56 • Get more information

E-mail: Customer First members, send an e-mail

message to our priority address:
custfirstsupport@aveva.com
Customers without a support
agreement, send an e-mail message to:
wwsupport@aveva.com
Web: Registered customers, submit your
questions to our Support web site.
https://softwaresupport.aveva.com/
Refer to the following web site for
instructions to register for AVEVA
technical support:

Product training
AVEVA offers a training course for System Platform and
individual courses for the products that make up System
Platform. Training courses are held at our training facilities in
Lake Forest, California, as well as at regional offices
worldwide. On-site customer training programs are also
available at your site.
Telephone: U.S. and Canada
866-998-7246

Outside the U.S. and Canada

+1 949-639-8508

Fax: 1-949-639-1847

Mail: AVEVA Inc.

26561 Rancho Parkway South
Lake Forest, CA 92630 USA
Attn: Training Department

E-mail: avevatraining@aveva.com
 Get more information • 57

Web: For training in your language, contact

a AVEVA-Certified Training Provider in
your area or country.
Refer to the following web address
that lists Certified Training Providers in
various countries:
https://sw.aveva.com/training/
 High Cross
Madingley Road
AVEVA Group Limited Cambridge
CB3 0HB, UK
https://sw.aveva.com

September, 2023
Part Number 13-0273