AVEVA™

Object Viewer User Guide

 AVEVA™ Object Viewer User Guide

© 2020 AVEVA Group plc and its subsidiaries. All rights reserved.

No part of this documentation shall be reproduced, stored in a ret rieval system, or transmitted by any
means, electronic, mechanical, photocopying, rec ording, or otherwise, without the prior written
permission of AVEVA. 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 soft ware described in this
documentation is furnished under a license agreement. This soft ware may be used or copied only in
accordance with the terms of such license agreement.
ArchestrA, Aquis, Avantis, Citect, DYNSIM, eDNA, EYESIM, InBatch, InduSoft, InStep, Int elaTrac,
InTouch, OASyS, PIPEPHASE, PRiSM, PRO/II, PROV ISION, ROMeo, SIM4ME, SimCentral, SimSci,
Skelta, SmartGlance, Spiral Software, Termis, WindowMaker, WindowViewer, and Wonderware are
trademarks of AVEVA and/or its subsidiaries. An extensive listing of AVEVA trademarks can be found at:
https://sw.aveva.com/legal. All other brands may be trademarks of their respective owners.
Publication date: Monday, November 16, 2020
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 0HB. UK
https://sw.aveva.com/
For information on how to cont act sales and customer training, see https://sw.aveva.com/contact.
For information on how to cont act technical support, see https://sw.aveva.com/support.

2
 AVEVA™ Object Viewer User Guide

Contents
Chapter 1 Overview ............................................................................................................... 5
A vailability ................................................................................................................................ 5
Starting Object Viewer............................................................................................................... 5
Navigating In Object Viewer....................................................................................................... 5
Finding Objects ................................................................................................................... 6
Closing Object Viewer ............................................................................................................... 7

Chapter 2 Viewing Attributes ............................................................................................... 9

Viewing an Object’s Attribute Data ............................................................................................. 9
Quality ................................................................................................................................ 9
Status................................................................................................................................. 9
Has Buffer ........................................................................................................................ 10
Understanding Failed Requests ............................................................................................... 11
Communication Errors ....................................................................................................... 11
Configuration Errors .......................................................................................................... 12
Operational Errors ............................................................................................................. 13
Sorting Data ........................................................................................................................... 13
Viewing Attributes in a Watch Window...................................................................................... 13
Using the A veva OP C UA Client Service ............................................................................. 14
Adding a Watch Window .................................................................................................... 14
Saving a Watch Window .................................................................................................... 14
Removing Attributes from Watch Windows .......................................................................... 15

Chapter 3 Modifying Attribute Values ............................................................................... 17

Attribute Properties ................................................................................................................. 17
Category Property ............................................................................................................. 17
Value Property .................................................................................................................. 18
Timestamp Property .......................................................................................................... 18
Modifying an Attribute Value .................................................................................................... 18
Modifying an Attribute from the Watch Window ......................................................................... 18
Viewing Changes Dynamically ................................................................................................. 19
Setting an ApplicationObject OnScan ....................................................................................... 19
Setting an ApplicationObject OffScan ....................................................................................... 19

3
 AVEVA™ Object Viewer User Guide

C HAPTER 1
Overview
Object Viewer provides performance and diagnostic information about ApplicationObjects. You can use
Object Viewer to show performanc e parameters, resource consumption, and reliability measurements of
objects you select.
In addition to viewing an object’s data value, data quality, and the communication status of the object,
you can also modify some of the object’s attributes for diagnostic testing. Modifications can include
adjusting timing parameters and setting objects in an execution or idle mode.
Object Viewer runs with minimal System Platform and operating system requirements.
Using Object Viewer you can:
 View the data type, data quality, data value, timestamp, and communication status of
ApplicationObject attributes.
 Do diagnostic testing on ApplicationObjects.
 Modify selected ApplicationObject attributes.

Availability
Object Viewer is a common component of any Galaxy application and is available from any workstation
in the application with a deployed WinPlatform. You do not need to install the utility on each workstation.

Starting Object Viewer

You can use Object Viewer from any workstation that is part of your Galaxy application.
To start Object Viewer
1. Click Start, navigate to AV EVA, and click System Management Console.
2. In the console tree, expand the Platform Manager to show the list of Galaxies, and then expand a
Galaxy to show a list of platforms.
3. Right -click a platform, and then click Launch Object Viewer.
You can also start the Object Viewer from the System Platform IDE by right -clicking a deployed object
and then clicking View in Object Viewer.

Navigating In Object Viewer

The main window of the Object Viewer is composed of three areas:
 Cons ole tree on the left
 Details pane on the right

5
AVEVA™ Object Viewer User Guide Overview

 Watch window bottom

The console tree works like Windows Explorer. Use t he plus (+) and minus (-) signs to expand or hide the
nested list items shown in the pane. When you select an object in the console tree, its associated
attributes and their properties are shown in the details pane.
Drag a specific set of attributes of interest to a watch window to monitor their Quality, Status,
Timestamp, and Value as you manipulate them and other attributes that affect their data values. You
can save the contents of a watch window to a file for future reference.

Finding Objects
You can use the Find dialog box to search for an object in your Galaxy application.

6
Overview AVEVA™ Object Viewer User Guide

To find an object by name

1. On the Edit menu, click Find Object.

2. Select the Search by Name check box.

3. In the Find What box, type or select a tag name. The Find button becomes active.
4. In the Which Name area, select either Tagname or Hierarchical.
5. In the Search Criteria area, click a search option.
6. In the Search Scope area, select a platform and an engine.
7. In the Only Show Objects area, select the That Are Quarantined and That Are OffS can check
boxes to limit the search scope.
8. Click Find.
To find an object without using the name
1. On the Edit menu, click Find Object.
2. Clear the Search by Name check box.
3. In the Search Scope area, select a platform and an engine.
4. In the Only Show Objects area, select the That Are Quarantined and That Are OffS can check
boxes to limit the search scope.
5. Click Find.

Closing Object Viewer

By default, when you close the Object Viewer, your settings are not saved, including the attributes you
selected for the Watch window. You can choose to save the watch windows you creat e. For more
information about saving watch windows, see "Saving a Watch Window" on page 20.
To close the Object Viewer
 On the File menu, click Exit.

7
 AVEVA™ Object Viewer User Guide

C HAPTER 2
Viewing Attributes
Using Object Viewer, you can view the attribut es of all ApplicationObjects in your Galaxy application from
any workstation used in the application.

Viewing an Object’s Attribute Data

All AutomationObjects consist of attributes and common properties such as data type, initial value, and
value range. Each object’s set of attributes appears in the details pane when you select the object in the
console tree.
To view an object’s attribute data
1. Start Object Viewer. Object Viewer’s main window appears. The object in focus in the IDE or
Platform Manager is put into focus in the console tree of the Object Viewer.
2. To view another object’s attributes, select the object in the console tree.

Quality
E very readable attribute is assigned a quality property that matches one of four categories.

Quality Description

Good Data is good and can be used.

Uncertain Data is questionable, but can be used.

Initializing Data is not yet available, but will be soon.

Bad Data cannot be used.

Status
The status of an ApplicationObject’s attribute describes wh ether a particular Read or Write request
succeeded or failed. Possible status conditions include:

Status Description

OK Operation completed successfully.

Pending Request is received, but is not yet complete. A

transitory status.

Warning Operation completed successfully, but with

some warning condition. Applies only to Write
actions.

9
AVEVA™ Object Viewer User Guide Viewing Attributes

Status Description

Communication Error Request failed due to an error communicating

with the target ApplicationObject.

Configuration Error Request failed due to an error in configuration.

Operational Error Request failed due to an operat or error.

Software Error Request failed due to an internal software error.

Security Error Request failed due to insufficient security

access rights.

Other Error All other errors.

Has Buffer
The Object Viewer Ha s Buffer column indicates if an attribute has a buffer property. The value dis played
in the column is True if the attribute has a buffer property or False if the attribute has no buffer property.

To view the value of the Buffer property, add the <attributename>.buffer property to the Attribute
Reference dialog box. You can also use an alternate syntax, <attributename>.property(Buffer), which
should be used for subscribing to attributes on a DI Object.

10
Viewing Attributes AVEVA™ Object Viewer User Guide

Double-click the attribute. The View Buffer Elements dialog box appears.

The View Buffer Elements dialog box header displays the Attribute Reference, Type, Timestamp and
Count. A details window dis plays the Value, Timestamp, and Quality (V TQ) columns for each item.

Understanding Failed Requests

When a failure occurs during a request, the det ails of the error appear in a dialog box, which contains the
source of the error and a description of the error.

Communication Errors
Communication errors include the following:

Source Description Reason

Requesting NMX Request Timed Out A message was not processed in a timely
manner.

11
AVEVA™ Object Viewer User Guide Viewing Attributes

Source Description Reason

Requesting NMX Communication Error: Attempt to get or set an attribut e from an

Platform communication ApplicationObject on a remot e platform with the
error network down between the two platforms.

Responding NMX Communication Error: Attempt to get or set an attribut e from an

Engine communication ApplicationObject on a remote engine that is
error currently not running, but deployed.

Responding NMX Communication Error: Attempt to get or set an attribut e from an

Engine communication ApplicationObject on a remote engine, but that
error remot e engine is currently undeployed while the
remot e platform is deployed.

Responding Index out of range Attempt to get or set an attribut e from an

Automation Object ApplicationObject attribute that is an array, but
specified an array index that is out of range.

Configuration Errors
Configuration errors include the following:

Source Description Reason

Responding LMX Invalid Object ID Attempt to get or set an attribut e from an

ApplicationObject on a remote engine, but that
remot e ApplicationObject is currently
undeploy ed while the remot e engine is
deployed.
Requesting NMX Invalid Platform ID Attempt to get or set an attribut e from an
ApplicationObject on a remote plat form, but that
remot e platform is currently undeployed.

Requesting LMX Invalid reference Attempt to get or set an attribut e from an

ApplicationObject that is not yet configured in
the system. A bad reference.

Responding NMX Invalid Engine ID Attempt to get or set an attribut e from an

ApplicationObject on a remote engine, but that
remot e engine is currently undeployed while the
remot e platform is deployed.

12
Viewing Attributes AVEVA™ Object Viewer User Guide

Operational Errors
Operational errors include the following:

Source Description Reason

Responding Attribute not writable Attempt to set an attribute in an

Automation Object ApplicationObject that cannot be written to.

Responding Write access denied. Attempt to set an attribute in an

Automation Object ApplicationObject that can be written to, but that
the user cannot write to. This can be an
operational error ( the attribute is read only) or a
security error (the current user does not have
permission to write to the attribute).
Responding Software error: The dat a Attempt to set an attribute in an
Automation Object to be set was to the wrong ApplicationObject can be written to, but with a
data type. data type that cannot be written to because it
cannot be coerced. For example, trying to write
a Boolean value of True to an attribute of type
QualifiedStruct or QualifiedE num.

Sorting Data
You can sort the dat a shown in the det ails pane in either ascending or descending order by clicking any
column heading. You can show hidden attributes in the details pane by selecting the Include hidden
command from the Options menu. For example, click the Attribute Name heading to sort the list by
attribute name. Attribute names appear in ascending or descending alphabetical order.
Hidden attribut e names include leading underscores and appear at the t op of an ascending order list. For
example, the following figure shows the _AdviseOnlyActiveEnabled hidden attribute, which indicat es
whet her Advanced Communication Management is active or not.

Viewing Attributes in a Watch Window

You can use the watch window to view an attribute or a group of attributes apart from the entire list of
attributes.
The attributes in the watch window are listed by their AttributeReference, which shows which object the
attribute belongs to.

13
AVEVA™ Object Viewer User Guide Viewing Attributes

For example, the AppEngine_001 object contains AlarmOnCnt and AlarmUnAckCnt attributes. When
you add it to a watch list, the object’s tag name is appended to the reference string.

To view selected attributes in a watch list

1. Select an ApplicationObject from the console tree. A list of its attributes appears.
2. Add an attribute to the watch list.
o In the details pane, right-click an attribute to place it on the watch list. Click Add to Watch. The
attribute in the AttributeReference format, along with its data, appears in the watch list.
o Right -click in the watch window and click Add Attribute Reference. In the Add Attribute
Reference dialog box, type the attribute name in the following format: Object
Referenc e.Attribute Reference. For example, enter SystemArea.ScanState to view the
ScanState attribute of the SystemArea object.
3. To add a block of attributes to the watch window, hold down the SHIFT key and click the left mouse
key while selecting the first and last attribute of the block.
4. To add a random list of attributes to the watch window, hold down the CTRL key and click the left
mouse button while selecting attributes.

Using the Aveva OPC UA Client Service

You can use an instance of the A veva OP C UA Client Service hosted by your Galaxy to subscribe to
attributes hosted by an OPC UA server. Using an instance of the A veva OP C UA Client Service in Object
Viewer requires the use of the specific service instance name as a prefix.
For example, using an instance of the UA Client Service with Scope Name of "OPCUAClient_010'"
would be specified as follows:
OPCUAClient_010:AppEngine_001.AlarmOnCnt.value

Adding a Watch Window

By default, a single watch window appears in the Object Viewer. You can add more watch windows to
view different groups of attributes or view attributes of different ApplicationObj ects.

Note: If attributes already appear in the watch window, right-click away from the list of attributes to open
the correct shortcut menu.

To add a watch window

1. Right -click in the watch window and click Add Watch Window. A new watch window appears with
the default tab name, Watch List 2.
2. To rename the new watch window, right-click it and click Rename Tab. Type the name of the watch
window in the Rename Tab dialog box and click OK.
3. Add attributes to the watch window or add another watch window.
4. Move from one watch window to another by clicking the tabs.

Saving a Watch Window

You can save a watch window and reuse it each time you start Object Viewer.

14
Viewing Attributes AVEVA™ Object Viewer User Guide

To save a watch window

1. Right -click in the Watch List and select Save As to save the watch list. The Save As dialog box
appears.
2. Select the folder path to save the watch window, which is an XML file.
3. Click Save.

Removing Attributes from Watch Windows

The attributes that you add to watch windows remain until you remove them or until you close Object
Viewer. For example, if you are viewing the attribut es of an AppE ngine and place s ome of its attributes in
a watch window, those attributes remain even when you select another object in the console tree.

Note: This action does not delet e the attribute from the object. The attribute is viewable in the details
pane.

To remove an attribute from a watch window

 In the watch window, right-click the attribute you want to remove and click Remove from Watch.
The attribute is removed from the watch window.

15
 AVEVA™ Object Viewer User Guide

C HAPTER 3
Modifying Attribute Values
You can modify an attribut e’s value for diagnostic testing. You must have the proper security permissions
to do this and the attribute’s value must also be changeable.
Before making modifications to any attribute, you mus t be familiar with the attributes and their functions.
Also, you must understand the effects that changing attribute values can have on your Galaxy
application.

Attribute Properties
Each data point of an attribut e is associated with a unique V TQ identifier (Value, Time, and Quality). Only
the value can be modified, provided that the attribute is user-writable. When value is modified, a new
VTQ is generated.
When you try to modify an attribute value, a dialog box appears that shows the type (datatype) and
current value of the attribute. Use this information as a guide for continuing.
Before modifying an attribut e value, check its category shown in the Category column to determine
whet her modification is possible.

Category Property
An attribute’s Category property determines if the attribut e is writable. The only categories that you can
write to are:
 Writeable_U
 Writeable_US
 Writeable_UC
 Writeable_US C
 Writeable_UC_Lockable
 Writeable_US C_Lockable
The letters included in the Writable categories mean the following:

Letter Description

U UserSets are OK. You can modify these in the Object Viewer.

S SupervisorySets are OK. You can modify these only with an

application function. You cannot modify them in the Object
Viewer.

C Configtime time sets only. You can modify these only when you
are configuring the object. You cannot modify them in the Object
Viewer.

17
AVEVA™ Object Viewer User Guide Modifying Attribute Values

Value Property
You can modify the value property of an attribute shown in the Value column, if the attribut e is
user-writ able (see Category Property on page 17). The datatype of the attribute is shown in the Type
column, and indicates the kind of value that you can assign to the attribut e, for example, Boolean,
integer, double, etc.

Timestamp Property
The timestamp of an attribut e is the Time element of the VTQ packet. It repres ents the time of the last
recorded change to the attribute, and is shown in the Timestamp column. The Timestamp cannot be
modified, or turned on or off. An attribut e will have a timestamp if the value in the Has
Quality/Timestamp column is true.

Modifying an Attribute Value

You can only modify attribute values if you have the proper privileges and the attribute is writable. Check
the Category value in the details pane for the attribut e you want to modify. You cannot modify Calc ulated
and SystemWriteable attributes.
Some attribute values affected by the changed attribute are updat ed only after you select the attribute.
For example, an object’s ScanStateCmd controls the object’s scan state, with True being OnScan, False
being OffScan. The object also has a ScanState attribute that indicat es the current scan state of the
object.
Assuming ScanStateCmd and ScanState are Fals e, change ScanStateCmd to True. Notice that the
object’s ScanState attribute value remains False. Select the ScanState attribute. Its value changes to
True.
To modify an attribute value
1. Select the object that contains the attribute you want to change.
2. Right -click the attribute and click Modify. A Modify <data type> Value dialog boxes appears,
related to the dat a type for the selected attribute.

3. Modify the values as needed.

4. Click Apply and click OK. The new value appears in the Value column of the details pane for that
attribute.

Modifying an Attribute from the Watch Window

You can change an attribute’s value while in a watch window.

18
Modifying Attribute Values AVEVA™ Object Viewer User Guide

Important: Attributes in the watch window update immediately. Attributes in the det ails pane update
when you click them.

To modify an attribute from the watch window

1. In the watch window, double-click the attribute. A dialog box related to the attribute’s data type
appears.
2. If the attribut e is writable, enter or select the new value for the attribute.
3. Click Apply and click OK. The new value appears in the Value column of the watch window for that
attribute.

Viewing Changes Dynamically

Attribute values shown in the details pane are static. You must click on an attribute in the details pane to
update the display.
You may have a configuration in which the Galaxy Repository node was upgraded, but other nodes were
not upgraded. If you use ObjectViewer on the upgraded node to view information for attributes from a
non-upgraded node, the time stamps should not be considered as valid source times. In thi s case, the
time stamps reflect the time of the local node (the one running ObjectViewer) for the attributes running on
the non-upgraded node.
Attribute values shown in the watch window are updated immediately when the attribute’s value
changes.
For example, objects have two common attributes, ScanStateCmd and ScanState. ScanStateCmd
controls the scan state of the object (OnScan or OffScan). ScanState shows the last known scan state of
the object.
If you place the ScanState attribute in a watch window and c hange the ScanStat eCmd attribut e in the
details pane, the ScanState attribute is updated immediat ely. Instead, if you place the ScanStateCmd
attribute in a watch window, leave the ScanState attribut e in the details pane, and then change the value
of ScanStateCmd, the ScanState attribute is not updated until you select it in the details pane.

Setting an ApplicationObject OnScan

The OnScan state indicates the object’s run-time state, which means it is performing its normal
processing as part of its execute method.
When setting AppE ngines OnScan:
 The hosting WinPlatform’s status must also be OnScan.
 Any object hosted on the AppE ngine is automatically set OnScan.
To set an ApplicationObject OnScan
1. Select the object in the console tree.
2. In the details pane, right-click the ScanStateCmd attribute and click Modify. The Modify Boolean
Value dialog box appears.
3. Assuming the current value is False (OffScan), click True, click Apply, and then click OK.
Note that the ScanState attribut e’s value in the details pane remains False (OffScan).
4. To update the dis play, click the ScanStateCmd attribute.

Setting an ApplicationObject OffScan

OffScan is the run-time state that indicates that an object is idle and not ready to run.

19
AVEVA™ Object Viewer User Guide Modifying Attribute Values

Because WinPlatforms host AppE ngines, you must ensure that all AppEngines hosted by the
WinPlatform are OffScan before setting the WinPlatform OffScan. An error message appears if you try to
set a WinPlatform OffScan while its hosted AppEngines are still OnScan.
Although AppEngines host other objects, it is not necessary for all the objects to be OffScan before
setting the AppEngine OffScan. When you set an AppE ngine O ffScan, all of its hosted objects are
automatically set OffScan.
To set an ApplicationObject OffScan
1. Select the object in the console tree.
2. In the details pane, right-click the ScanStateCmd attribute and click Modify. The Modify Boolean
Value dialog box appears.
3. Assuming the current value is True (OnScan), click the False option button, click Apply and then
click OK.
Note that the ScanState attribut e’s value in the details pane remains True (OnScan).
4. To update the attribute value to False, select it.

20