System Platform Getting Started
System Platform Getting Started
Contents
Development Environment....................................................................... 7
Start the System Platform IDE.................................................................... 7
Create a Galaxy................................................................................................. 9
Connect to a Galaxy and Start System Platform IDE .......................10
Run the Default System Platform ViewApp........................................10
Become Familiar with Basic ViewApp Features.................................12
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.
4 Welcome to AVEVA System Platform
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
Before You Get Started 5
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.
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 a chapter
that describes how to configure System Platform products.
6 Welcome to AVEVA System Platform
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 with AVEVA License Manager. For more
information about the steps to activate licenses, see the AVEVA
Enterprise Licensing Guide and online help.
7
Development Environment
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 AVEVA OMI ViewApps and AVEVA
InTouch HMI managed applications.
Some Details
• You must connect to a Galaxy before the System Platform
IDE opens. That means you must create a Galaxy before
opening the IDE for the first time.
• Your product licenses must be activated before starting the
System Platform IDE.
• Users must be a member of the aaConfigTools Windows
user group to connect to a Galaxy from the IDE. Assign
users to this group through the Local Users and Groups
utility of the Windows Control Panel.
• For more information, see the “Steps to Create a Galaxy”
topic in the Application Server Help.
Create a Galaxy 9
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.
Some Details
• For more information, see the Connect to a Galaxy topic in
the AVEVA OMI help.
Design Standards
Workflow
Groups
Product
Tools Symbol Object Script Layout Screen
Editor Editor Editor Editor Profile Editor
Layouts
Symbols
14 Workflow Group 1: Design Standards
Create a Symbol
You can create a symbol in the Graphic Toolbox by the
following methods:
• Keyboard shortcut: Press Ctrl + Shift + S
• Shortcut menu: From the Graphic Toolbox, right-click on
the Galaxy name, select New, and then select Symbol
Build Symbol Standards 15
• Ribbon Bar: From the Home tab, select Symbol from the
Create group.
You should see the symbol listed in the Graphic Toolbox as
Symbol_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 symbols in the Graphic Toolbox if you want to
define them as a reusable standard that will be used
frequently.
• Store symbols as AutomationObject templates if you want
to re-use the symbol in combination with the object
functionality.
• Store symbols in the Content tab of an AutomationObject
instance. Do this if you are unlikely to re-use the symbol in
any other situation.
Some Details
• Symbol Names must be unique within the entire Graphic
Toolbox hierarchy.
• Valid characters for symbol names include alphanumeric
characters, #, and _ (underscore).
• Symbol names cannot contain spaces and the symbol
name cannot begin with the $character.
Edit a Symbol
After you create a symbol, you need to check it out to be able
to edit it in the Industrial Graphic Editor. You also need to
check in the symbol after you are finished editing it.
To edit a symbol in the Graphic Toolbox
1. Right-click on your symbol listed in the Graphic Toolbox
and select Check Out.
A red check mark appears to the left of your symbol's
name to indicate that it is checked out.
16 Workflow Group 1: Design Standards
Edit Objects
The Object Editor contains tabbed pages to modify objects.
Some Details
• When you open the Object Editor, the object is checked
out. No one else can edit an 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.
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.
Create a Layout
Create a layout in the Graphic Toolbox by these methods:
• Keyboard shortcut: Press Ctrl + Shift + L
• Shortcut menu: Right-click on the Galaxy name, select
New, and then select Layout
26 Workflow Group 1: Design Standards
• Ribbon bar: From the Home tab, select Layout from the
from the Create group.
To create a layout
1. Open the System Platform IDE and select Graphic Tool-
box.
2. With your cursor, select a folder in the Graphic Toolbox
where you want to place the new layout.
3. Press Ctrl + Shift + L.
A layout appears in the Graphic Toolbox folder with a
default name of Layout_001 for the first layout you create.
A blue background around the layout name indicates the
name can be changed.
Configure a Layout
A layout configuration workflow includes these essential steps:
• Add panes
• Set layout and pane properties
Build Layout Standards 27
To configure a layout
1. Select a layout to configure from the Graphic Toolbox.
Create a ViewApp
You must create a ViewApp derived template before you can
begin create 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
an 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 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 a red icon to
indicate that it 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 online
help for more information about assigning a screen profile
and layouts to a ViewApp,
Assign Screen Profiles and Layouts to a ViewApp 31
Some Details
• At least one screen in a screen 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 online help.
32 Workflow Group 2: Assemble a ViewApp
Some Details
• Double-clicking on an asset identified by a search shows
the thumbnails of the graphics associated with the asset.
• Place your cursor over a graphic thumbnail in the search
results to show its folder location within Toolbox.
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, Word
documents, or images into a running ViewApp.
• Place your external content at a folder location within your
network. Verify connectivity between your Desktop Studio
computer and the folder containing External content.
Some Details
• Deployment includes installing 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
40 Workflow Group 3: Deploy a ViewApp
Deploy a ViewApp
You can tell if you have objects that need to be deployed by
looking at the icons next to the objects shown in the
Deployment view. Typical deployment status icons include:
• Not deployed
• Deployed
• Deployed, but pending changes have not been deployed
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.
Application Server
The following table describes each Application Server
documentat in the library.
Publication Name
(file name) Description
Publication Name
(file name) Description
Log Viewer User Guide Explains how to use the Log Viewer
LogViewer.pdf utility to determine system
diagnostics.
Log Flag Editor User Guide Explains how to turn on and off
LogFlagEditor.pdf certain diagnostics logging
messages.
AVEVA InTouch HMI and Integration Explains how you can use the
Guide System Platform Integrated
ITAAIntegration.pdf Development Environment (IDE) to
manage InTouch HMI applications
so that you can use symbols you
create in the Industrial Graphic
Editor. This guide is available on the
AVEVA InTouch HMI installation CD.
Application Server documention is also available as online
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 online
help that you view with a web browser. Press F1 from the
System Platform IDE modern editors to show online help:
• Screen Profile editor
• Layout editor
• ViewApp editor
• ViewApp Namespace editor
AVEVA InTouch HMI 51
Publication Name
(file name) Description
Publication Name
(file name) Description
Publication Name
(file name) Description
AVEVA Historian
The following table describes the AVEVA Historian
documentation library delivered as PDF files. Online help is
available from within the application.
Publication Name
(file name) Description
Publication Name
(file name) Description
Historian Client User Guide This guide describes how to use the
HistClient.pdf Historian Client to organize,
explore, 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
Fax: +1 949-639-1545
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
Fax: 1-949-639-1847
Mail: AVEVA
26561 Rancho Parkway South
Lake Forest, CA 92630 USA
Attn: Training Department
E-mail: avevatraining@aveva.com