0% found this document useful (0 votes)
83 views226 pages

Exaquantum Engineering Guide Vol 4

Exaquantum V3.2 Engineering Guide Vol 4

Uploaded by

r.kh.arjomandi
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
83 views226 pages

Exaquantum Engineering Guide Vol 4

Exaquantum V3.2 Engineering Guide Vol 4

Uploaded by

r.kh.arjomandi
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 226

Instruction Exaquantum Engineering Guide

Manual Volume 4 – Web Authoring


IM 36J04A15-04E

IM 36J04A15-04E
th
© Yokogawa January 14 2020
21st Edition Issue 1
Exaquantum Engineering Guide – Volume 4 Web Authoring i

Copyright and Trademark Notices


© 2020 Yokogawa Electric Corporation
All Rights Reserved
The copyright of the programs and online manuals contained in the software medium of
the Software Product shall remain with YOKOGAWA.
You are allowed to print the required pages of the online manuals for the purposes of
using or operating the Product; however, reprinting or reproducing the entire document is
strictly prohibited by the Copyright Law.
Except as stated above, no part of the online manuals may be reproduced, transferred, sold,
or distributed to a third party in any manner (either in electronic or written form including,
without limitation, in the forms of paper documents, electronic media, and transmission
via the network).
Nor it may be registered or recorded in the media such as films without permission.
Trademark Acknowledgements
 CENTUM, ProSafe, Exaquantum, Vnet/IP, PRM, Exaopc, Exaplog, Exapilot, Exasmoc
and Exarqe are registered trademarks of Yokogawa Electric Corporation.
 Microsoft, Windows, Windows Server, SQL Server, Excel, Internet Explorer, SharePoint,
ActiveX, Visual Basic, Visual C++, and Visual Studio are either registered trademarks or
trademarks of Microsoft Corporation in the United States and other countries.
 Adobe and Acrobat are registered trademarks of Adobe Systems Incorporated, and
registered within particular jurisdictions.
 Ethernet is a registered trademark of XEROX Corporation.
 All other company and product names mentioned in this manual are trademarks or
registered trademarks of their respective companies.
 We do not use TM or ® mark to indicate those trademarks or registered trademarks in this
manual.
 We do not use logos in this manual.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


ii Contents

Highlights
The Highlights section gives details of the changes made since the previous issue of this
document.
Summary of Changes
This is 21st Edition of this document.
Detail of Changes
The changes are as follows.

Chapter/Section/Page Change

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring iii

Exaquantum Document Set


The documents available for Exaquantum are:

Exaquantum General Specification (GS 36J04A10-01E)

Exaquantum Technical Information (TI 36J04A10-01E)

Exaquantum/PIMS User's Manual (IM 36J04A11-01E)

Exaquantum/Explorer User's Manual Volume 1


General Information (IM 36J04A12-01E)

Exaquantum/Explorer User's Manual Volume 2


Custom Controls (IM 36J04A12-02E)

Exaquantum/Explorer User's Manual Volume 3


Microsoft Excel Reports (IM 36J04A12-03E)

Exaquantum/Explorer User's Manual Volume 4


Advanced Configuration (IM 36J04A12-04E)

Exaquantum Installation Guide (IM 36J04A13-01E)

Exaquantum API Reference Manual (IM 36J04A14-01E)

Exaquantum Engineering Guide Volume 1


Administration (IM 36J04A15-01E)

Exaquantum Engineering Guide Volume 2


Network Configuration (IM 36J04A15-02E)

Exaquantum Engineering Guide Volume 3


Support Tools (IM 36J04A15-03E)

Exaquantum Engineering Guide Volume 4


Web Authoring (IM 36J04A15-04E)

Exaquantum Engineering Guide Volume 5


PI Connection (IM 36J04A15-05E)

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


iv Contents

Table of Contents

Copyright and Trademark Notices .....................................................................................i


Highlights ......................................................................................................................... ii
Exaquantum Document Set ............................................................................................. iii
Table of Contents .............................................................................................................iv
Chapter 1 Introduction ............................................................................................................. 1-1
Chapter 2 Introduction to Legacy Exaquantum/Web ........................................................... 2-1
2.1 General ............................................................................................................................... 2-1
2.2 The Exaquantum/Web Client ............................................................................................. 2-2
2.3 Installing Additional Components on Web Clients ............................................................ 2-2
2.4 Web Server Manager .......................................................................................................... 2-3
Chapter 3 Legacy Exaquantum/Web Site ............................................................................... 3-1
3.1 Data Users Web Site .......................................................................................................... 3-1
3.2 Administrator’s Web Site ................................................................................................... 3-2
Chapter 4 Web Page Authoring Overview.............................................................................. 4-1
4.1 Customising the web site.................................................................................................... 4-1
4.2 Comparison of Web Authoring with Exaquantum/Explorer .............................................. 4-2
4.3 How the Authoring Tools Work......................................................................................... 4-3
4.4 Before You Start Authoring Web Pages ............................................................................ 4-4
Chapter 5 Creating Graphics and Process Mimics ................................................................ 5-1
5.1 Creating and Managing Mimics ......................................................................................... 5-2
5.2 Graphic Editor Components ............................................................................................... 5-3
5.3 Expression Editor ............................................................................................................. 5-13
5.4 Notes on Converting CS 3000 Graphics .......................................................................... 5-17
5.5 Notes on Converting CENTUM VP Graphics ................................................................. 5-22
5.6 Notes on Importing Exaquantum/Explorer Documents ................................................... 5-25
Chapter 6 Creating Pre-configured Trend ............................................................................. 6-1
6.1 Configuring the Trend Control ........................................................................................... 6-1
Chapter 7 Creating Pre-configured Alarms and Events Summary...................................... 7-1
7.1 Configuring the Alarm and Event Control ......................................................................... 7-1
Chapter 8 Moving a Web Server to a Dedicated PC .............................................................. 8-1
8.1 Set Up the Dedicated Web Server ...................................................................................... 8-1
8.2 Back Up User Views .......................................................................................................... 8-1
8.3 Restore User Views ............................................................................................................ 8-1
8.4 Remove the Web Server from the Exaquantum Data Server ............................................. 8-1

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring v

8.5 Adjusting Views ................................................................................................................. 8-2


Chapter 9 Managing the Number of Users .............................................................................9-1
9.1 Deleting User Profiles ........................................................................................................ 9-1
Chapter 10 Introduction to Exaquantum Web .......................................................................10-1
10.1 Content ............................................................................................................................. 10-1
10.2 Key Functions .................................................................................................................. 10-2
10.3 Intended Audience ........................................................................................................... 10-2
10.4 Glossary ........................................................................................................................... 10-3
Chapter 11 Overview of the Exaquantum Web ......................................................................11-1
11.1 Page Layout...................................................................................................................... 11-2
Chapter 12 Using the Exaquantum Web Website ..................................................................12-1
12.1 Opening the Exaquantum website .................................................................................... 12-1
12.2 Website Homepage .......................................................................................................... 12-3
12.3 Choosing a display language ............................................................................................ 12-4
12.4 Choosing a display mode ................................................................................................. 12-4
12.5 Accessing Trends ............................................................................................................. 12-4
12.6 Accessing Mimics ............................................................................................................ 12-5
12.7 Accessing Reports ............................................................................................................ 12-5
12.8 Accessing XY Plots.......................................................................................................... 12-5
12.9 Display of Time and Dates ............................................................................................... 12-5
12.10 Logging out of Exaquantum Web .................................................................................... 12-6
12.11 Tablet Device Differences................................................................................................ 12-6
Chapter 13 Working with Exaquantum Web Trends ............................................................13-1
13.1 Trend Web Page Features ................................................................................................ 13-1
13.2 Alarm and Event Features ................................................................................................ 13-4
13.3 Annotation Features ......................................................................................................... 13-6
13.4 Displaying an existing Trend Webpage ........................................................................... 13-9
13.5 Creating a new Trend Webpage ..................................................................................... 13-11
13.6 Adding a pen to a trend .................................................................................................. 13-12
13.7 Removing a pen from a trend ......................................................................................... 13-21
13.8 Modifying a pen on a trend ............................................................................................ 13-22
13.9 Setting a Time Range for a Trend Webpage .................................................................. 13-24
13.10 Showing Alarm & Event Data on a Trend Webpage ..................................................... 13-28
13.11 Showing Annotations on a Trend Webpage ................................................................... 13-29
13.12 Adding a Trend to a Trend Webpage ............................................................................. 13-33
13.13 Removing a Trend from a Trend Webpage .................................................................... 13-35

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


vi Contents

13.14 Saving a Trend Webpage ............................................................................................... 13-36


13.15 Copying a Trend Webpage ............................................................................................. 13-37
13.16 Deleting a Trend Webpage ............................................................................................. 13-38
13.17 Updating your Trend Favorites List ............................................................................... 13-39
13.18 Sharing a Trend .............................................................................................................. 13-40
13.19 Printing a Trend.............................................................................................................. 13-41
13.20 Advanced Features of Trends ......................................................................................... 13-42
13.21 Displaying Trend Data Directly from the URL.............................................................. 13-53
Chapter 14 Working with Exaquantum Web Mimics ........................................................... 14-1
14.1 Mimic Webpage Features................................................................................................. 14-2
14.2 Displaying an existing Mimic Webpage .......................................................................... 14-3
14.3 Creating a new Mimic Webpage ...................................................................................... 14-6
14.4 Creating the Graphic for a Mimic Webpage .................................................................... 14-8
14.5 Setting a Spot Time for a Mimic .................................................................................... 14-10
14.6 Zooming and Panning a Mimic ...................................................................................... 14-12
14.7 Displaying a Trend from a Mimic .................................................................................. 14-13
14.8 Updating your Mimic Favorites List .............................................................................. 14-15
14.9 Modifying a Mimic ........................................................................................................ 14-16
14.10 Deleting a Mimic............................................................................................................ 14-17
14.11 Sharing a Mimic ............................................................................................................. 14-18
14.12 Printing a Mimic ............................................................................................................ 14-18
Chapter 15 Working with Exaquantum Web Reports .......................................................... 15-1
15.1 Report Features ................................................................................................................ 15-1
15.2 Opening an existing Report .............................................................................................. 15-2
15.3 Adding a Report to Exaquantum Web ............................................................................ 15-4
15.4 Modifying a Report .......................................................................................................... 15-6
15.5 Saving a Report ................................................................................................................ 15-7
15.6 Deleting a Report ............................................................................................................. 15-7
15.7 Updating your Report Favorites List ................................................................................ 15-8
15.8 Sharing a Report ............................................................................................................... 15-9
Chapter 16 Working with Exaquantum XY Plots .................................................................. 16-1
16.1 XY Plot Web page Features ............................................................................................. 16-1
16.2 Displaying an existing XY Plot Webpage ........................................................................ 16-4
16.3 Creating a new XY Plot Webpage ................................................................................... 16-6
16.4 Configuring an XY Plot ................................................................................................... 16-7
16.5 Adding a pen to an XY plot ............................................................................................. 16-9

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring vii

16.6 Removing a pen from an XY plot .................................................................................. 16-18


16.7 Modifying a pen on a XY plot ....................................................................................... 16-19
16.8 Changing the Reference pen on an XY plot ................................................................... 16-21
16.9 Setting a Time Range for an XY Plot Webpage ............................................................ 16-22
16.10 Saving an XY Plot Webpage .......................................................................................... 16-25
16.11 Copying an XY Plot Webpage ....................................................................................... 16-26
16.12 Deleting an XY Plot Webpage ....................................................................................... 16-27
16.13 Updating your XY Plot Favorites List ........................................................................... 16-29
16.14 Sharing an XY Plot ........................................................................................................ 16-30
16.15 Printing an XY Plot ........................................................................................................ 16-31
16.16 Advanced Features of XY Plots ..................................................................................... 16-32
16.17 Displaying XY Plot Data Directly from the URL .......................................................... 16-37
Chapter 17 Administering the Exaquantum Web Website ...................................................17-1
17.1 Granting Users Access to Exaquantum Web ................................................................... 17-1
17.2 Display Control for Mimics ............................................................................................. 17-3
Chapter 18 Scope of CS 3000 Conversion ...............................................................................18-1
18.1 CS 3000 Primitives .......................................................................................................... 18-1
18.2 Properties.......................................................................................................................... 18-5
Chapter 19 Scope of CENTUM VP Conversion .....................................................................19-1
19.1 CENTUM VP Primitives ................................................................................................. 19-1
19.2 Properties.......................................................................................................................... 19-4
Chapter 20 Enable Read of Large Data Volumes by Legacy Web Client ............................20-1
20.1 IIS 7.0 Increase ASP Response Buffering Limit in the IIS Manager ............................... 20-1

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


viii Contents

This page intentionally left blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 1-1

Chapter 1 Introduction
This document is split into two parts and covers the 2 different Web Sites which are
provided as part of an Exaquantum Web or Combined Server installation: -
 Legacy Exaquantum/Web
 Exaquantum Web
Although both installations provide similar functionality, they are completely different in
operation, administration and usage.
Legacy Exaquantum/Web is described in detail from Chapter 2 – ‘Introduction to Legacy
Exaquantum/Web’ and extends up to Chapter 9.
The description for the Exaquantum Web starts at Chapter 10 – ‘Introduction to Exaquantum
Web’ and runs to 17.1.
The remainder of the document (17.2 - Chapter 20) contains general information relevant to
both Web Servers.

NOTE that Chapter 5 is applicable to both Web Sites.


The Legacy Exaquantum/Web website was the only website supported for Exaquantum
installations prior to the R2.80 release. For the R2.80 release, the Exaquantum Web website
was introduced. Both websites run concurrently.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


1-2 Chapter 1 Introduction

This page intentionally left blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 2-1

Chapter 2 Introduction to Legacy Exaquantum/Web


Legacy Exaquantum/Web allows users to connect to Exaquantum systems using Internet
technology. It provides a number of pre-configured, ready to use Web pages, while users
can add their own pages to extend the standard coverage.
Although the technology involved, such as access through port 80 (http protocol), would
generally be appropriate for the World Wide Web, clients are limited to Intranet users. This
is because of the highly confidential nature of both the data and the functionality that
requires strictly controlled access.
2.1 General
Fully installed Exaquantum clients can connect directly to an Exaquantum Server, but web
only clients must connect to a Legacy Exaquantum/Web Server.
Both types may co-exist physically as indicated:
Figure 2-1 Exaquantum Overview
Exaquantum/Web Exaquantum/Explorer

Web client Web client User PC User PC

Intranet Local Area Network

Web Server

Role Based View

Long-term
OLE DB, etc Archive
Administration Tools

Real Time Database Historian


External Data:
ERP,
LIMS, etc
PCS Interface
Exaquantum/PIMS
(Server)

Exaquantum/PIMS
(Server)

Exaquantum/PIMS
(Server)
OPC Servers

PCS, DCS, PLCs etc

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


2-2 Chapter 2 Introduction to Legacy Exaquantum/Web

2.2 The Exaquantum/Web Client


The Legacy Exaquantum/Web client is a lightweight set of components that allow the
Exaquantum data to be displayed using a standard Web browser. It needs to be installed on
every PC that will access Exaquantum using the Web server interface.
The home page for users to access the Legacy Exaquantum/Web is:
http://<ExaquantumWebServerName>:<PortNumber>/ExaquantumHome
Where:
<ExaquantumWebServerName> is the name of the web server as specified during
the installation of the Exaquantum Web Client.
<PortNumber> is the port number as specified during the Web Server or Combined
Server installation.

For example:
http://MyExaquantumServer:8000/ExaquantumHome
ActiveX Security
The Legacy Exaquantum/ Web user interface uses ActiveX technology. The ActiveX
controls supplied with Exaquantum are signed and are safe for scripting. The controls can be
downloaded on initial visit to the web site or explicitly from the CD. If downloading via a
browser, then the security settings ‘Download signed ActiveX controls’ must be set to
‘Enable’ or ‘Prompt’. For users to run the software, the ‘Run ActiveX controls and plug-ins’
should be set to ‘Enable’.
Installing Legacy Exaquantum/Web Client
The Legacy Exaquantum/Web client can be installed in either of two ways, in each case the
user must have administrator permissions on the PC:
 Download from the Legacy Exaquantum/Web server – On a PC that has no
Exaquantum/Web client installed, the first time a user tries to access the Legacy
Exaquantum/Web server the client will be automatically downloaded and installed.
 Directly from the Exaquantum DVD – Place the Exaquantum Installation DVD in the
drive and follow the menu to the Legacy Exaquantum/Web client installation
procedure.
Refer to the Exaquantum Installation Guide on the DVD for more information on this topic.
2.3 Installing Additional Components on Web Clients
To provide the additional functionality for importing Exaquantum data into the Microsoft
Excel program, the Exaquantum Excel Add-in has to be installed on each PC that will use it.
The Excel Add-in software is available as a selectable item during the installation.
Alternatively, it can be added at a later stage by using the update facility. Refer to the
Exaquantum Installation Guide for more information.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 2-3

2.4 Web Server Manager


To allow a user of the Excel Web Client to change connection settings, a new tool, the “Web
Server Manager” has been introduced. This tool provides a user interface, as shown in Figure
2-2. The tool can be accessed from the Windows Start menu.
Figure 2-2 Web Server Manager Tool

This allows modification of the following settings:


1. Web server: This is the name of the machine that hosts the Legacy Exaquantum/ Web
or Exaquantum Combined server
2. Port: The port number for communication with the Exaquantum web site
3. User name: The username to use when logging on to the web server (may be blank to
use integrated authentication)
4. Password: The password to use when logging on to the web server (may be blank to
use integrated authentication)
Each of these settings is stored in the registry for the current user and the password is held in
encrypted form.
The tool also contains a Test button in order to validate connection with the new settings.
When settings have been modified, any existing excel web clients must be restarted in order
to use the new settings.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


2-4 Chapter 2 Introduction to Legacy Exaquantum/Web

This page intentionally left blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 3-1

Chapter 3 Legacy Exaquantum/Web Site


The Legacy Exaquantum/Web provides web sites for two different types of users:
 Data users
 Administrators.
3.1 Data Users Web Site
This is a function-rich Web site that allows users to start using Web pages out-of-the-box.
The URL will normally be:
http://<ExaquantumWebServerName>:<PortNumber>/ExaquantumHome
The first page the user will see is a Role based view of Exaquantum data. From here, the
user can:
 View tags and function blocks data, live or historical
 Update Tag Values
 Navigate through tags and function blocks by altering the role-based view, or searching
tags or function blocks by name.
The user can also visit other types of pages such as:
 Mimics with a windows refresh period of 1 minute
 Pre-configured trends
 Pre-configured alarms and events summary.
How to configure these types of pages is described in this manual. Exaquantum provides the
navigation mechanism to access the configured pages, and the means to author them. There
are two ways in which a user can access a mimic/pre-configured trend/alarms and events
summary. These are:
 Start with the role based view, click the appropriate derived view entry (e.g. mimics) to
replace the view with a list of available entries, and then launch the target page (e.g. Plant
1 overview) in the list page.
 Show the list page as above, then check target page(s) and use ‘add to MyList’. This
creates an entry in the right hand view named MY LIST.
When user wants to get to the page(s) MY LIST view is used to select an entry in the My
List.
The content of My List is user-dependent. The user can use this mechanism to record
subjects of interest and access such pages without having to search for entries again and
again.
The QuickLink part of the page (on the right side) is for recording Web pages that the user
wants to visit frequently. This is also user-dependent content.
The QuickHelp part of the page (on the right side) shows the context-sensitive help entries
that are available for the current page.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


3-2 Chapter 3 Legacy Exaquantum/Web Site

3.2 Administrator’s Web Site


Certain parts of the Exaquantum system can be administered using Remote Desktop Services
(Terminal Services) from any client provided the user has the correct security permissions.
See the following technical note on how to setup Remote Desktop Services: ‘TN
GMSCS0106-01E Setting up Windows Terminal Server For Exaquantum Client’

For web servers that are Windows Server 2012 and 2012 R2 any of the applications enabled
can be accessed from a client by navigating to:
http://<servername>:<port>/rdweb
NOTE By default the remote desktop services website ‘rdweb’ is installed under the ‘Default
Web Site’ so the port number will be 80.

For web servers that are Windows Server 2008 R2 the following applications can be
accessed from a client by navigating to:
NOTE The port number will be the same as used for the legacy website.

 Exaquantum Admin tools


http://<servername>:<port>/Exaquantum/Applications/admintools.asp

 System Events Viewer


http://<servername>:<port>/Exaquantum/Applications/syseventview.asp

 Exaquantum Tag Configuration Viewer


http://<servername>:<port>/Exaquantum/Applications/tagconfigtool.asp

 Exaquantum Cross Reference tool


http://<servername>:<port>/Exaquantum/Applications/xreftool.asp

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 4-1

Chapter 4 Web Page Authoring Overview


The Legacy Exaquantum/Web site for data users allows additions of configured web pages.
This chapter describes the general guidelines for this configuration work.
NOTE. From this point onwards, the term ‘Legacy Exaquantum/Web site’ always means
the web site for data users. Administrators’ web sites are fixed and users cannot
change them.
4.1 Customising the web site
Three types of web pages
The Legacy Exaquantum/Web site provides you with three places where you can locate your
own web pages:
 Mimics – they are usually plant animations that look very similar to
Exaquantum/Explorer mimics.
 Pre-configured trend – an equivalence of Exaquantum/Explorer’s Trend
 Pre-configured alarms and events summary – an equivalence of Exaquantum/Explorer’s
Alarms and Events Summary.
These categories are not rigorous. For example if you are creating a web page that consists
of a plant mimic together with various trends, you can locate the page in either mimics or
pre-configured trend (or even in pre-configured alarms and events). Three categories are
provided for the users’ convenience only.
NOTE. The rest of this manual describes in more detail how you can add and administer
these pages.
Importing mimics files from Exaquantum/Explorer or CS 3000
The import of mimics from Exaquantum/Explorer is a standard function. This function is
useful for converting existing Exaquantum/Explorer documents to the Web environment;
however, there are restrictions with this tool (see Section 5.6).
Importing from a CS 3000 graphics file is an optional feature. In order for you to use this
feature, you must order this option.
NOTE. When used in this document, the term ‘CS 3000’ means CS 1000 and CS 3000
graphics.
Adding your own web pages by programming them
If you have project specific requirements to end up with specially built pages, for example
LIMS data entry page, you can do this by:
1 Programming an ASP page to implement the required function.
2 Registering the ASP page into Legacy Exaquantum/Web site into one of three types
mentioned earlier.
As this is a programming exercise, ask your Yokogawa representative for more details.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


4-2 Chapter 4 Web Page Authoring Overview

User preferences
The Legacy Exaquantum/Web site is a personally customizable web site. This means that
some of contents and settings are customizable on a user basis, and are preserved across uses.
Such customizable content and settings are:
 My List entries
 Quick Link links
 Availability of derived views of a view
 Heading title and icon.
Look and feel
You cannot change the look and feel of the Legacy Exaquantum/Web site, including the
location or size of screen elements.
4.2 Comparison of Web Authoring with Exaquantum/Explorer
The following paragraphs indicate the differences between Web Authoring and
Exaquantum/Explorer.
There are two distinct authoring tools: Graphics Editor and a commercial tool
Exaquantum/Explorer can do the whole job, that is configure Exaquantum/Explorer
documents and run them.
In the Web environment, two types of tools are required:
 Graphics Editor (to author mimics)
 A commercial tool (to author other pages).
Microsoft Expression Web is the recommended commercial tool, but you may use your
preferred tool.
NOTE. Exaquantum provides a Web Authoring Add-In for Expression Web that allow the
incorporation of web pages into the Legacy Exaquantum/Web site. This feature is
not available in other tools.
Web mimics are slightly different from Exaquantum/Explorer mimics
The Graphics Editor originates from Exaquantum/Explorer, hence shares the same features.
However, there are some functions that are not available in the Graphics Editor:
 You cannot use ActiveX inside Web mimics
 You cannot use client scripting, except pre-defined ones (see below).
You have to use Expression Web in various cases
The Web pages that you have to use Expression Web to create include:
 Pre-configured trend page
 Pre-configured alarms and events page
 Any mixture of any of these elements, e.g. a plant mimic showing a trend next to it
 Mimics that have navigation features between them.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 4-3

Client scripting is offered for pre-defined uses only


One of the advantages of Exaquantum/Explorer is its functionally rich client scripting that
allows inter-documents or inter-controls interactions. Because the client scripting in the
Web environment is limited to manipulation to render objects, the equivalence to
Exaquantum/Explorer client scripting in the Web is limited to pre-defined uses only:
 Report times in mimics – this allows a time selection of values to show
 Parameterization in mimics – this allows a selection of data items to show, e.g. raw item,
hourly aggregated mean, etc.
4.3 How the Authoring Tools Work
This overview of how your web pages are incorporated into the Legacy Exaquantum/Web
site is intended to facilitate a general understanding of the authoring steps.
What you Create when Authoring Web Pages
Authoring Web pages creates:
 A Web page file. This is usually a HTML file, with the exception of the SVG (Scalable
Vector Graphics) file in the case of the Graphics Editor.
 An entry to the Legacy Exaquantum/Web site. When you use Expression Web, Publish
View via the Add In menu generates this information for you.
Web page files are to be located on the web server. In order to accomplish this, there is a
pre-configuration made in advance of the authoring work (see Section 4.4 for further
information). Each time you generate web page files (html files or SVG files) you have to
be careful to save the files at the designated location.
Entries appear in the list view of mimics, pre-configured trend and alarms and events
summary. This information is stored in the configuration database that resides on the
Exaquantum server. Populating this information is done by the Graphics Editor or Web
Authoring Add-In when you publish a view.
Installing Authoring Tools
In order for you to be able to author web pages, you have to install authoring components on
your client PC. This is a part of the client installation; see the Exaquantum Installation
Guide for more detail about installing client components.
The Legacy Exaquantum/Web authoring components consist of:
 Graphics Editor, a standalone Windows program
 Web Authoring Add-In, which provides these features:
 Tags and Function blocks browser to allow tags to be dragged and dropped into
components such as Trend. This is a useful mechanism to configure components that
require tag path names as parameters.
 Publish View, which creates an entry in the Legacy Exaquantum/Web site.
The authoring components require online access to both the Exaquantum server and web
server. Such servers are pre-defined during the installation. You cannot change the web
server unless you re-install the components. If it is an Exaquantum multiple server
deployment, you can specify a primary server and a secondary server during installation.
Your authoring tool will try to access the primary server; it will go to the secondary one if
the primary fails to respond.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


4-4 Chapter 4 Web Page Authoring Overview

4.4 Before You Start Authoring Web Pages


You have to set up your client PC so that you can use the Legacy Exaquantum/Web
authoring tools properly.
Setting Up a Folder to Store Web Page Files
Web page files should be stored in the right place on a web server; this is necessary for all
authoring users. Follow these steps:
1 Create the folder(s) that will be used to store your Views. The folder should reside under
the WebRoot folder, for example:
Drive:/<Install Folder>/Yokogawa/Exaquantum PIMS/WebRoot/Views
2 Share the folder that you have created.
NOTE. If you want to be able to save views in this folder from other authoring PCs, you
will need to Share the Views folder.
Installing the Web Authoring Add-In - Expression Web 4:
No additional steps are required before you use Expression Web 4 to configure web pages
and the Add-In should already be available.
1. From the Exaquantum menu select Insert Trending Control or Insert Event
Summary Control, the corresponding control is added to the page.
Figure 4-1 Exaquantum Menu

Understanding Control Activation


Interactive controls are ActiveX controls that provide user interfaces. When a web page uses
the APPLET, EMBED, or OBJECT elements to load an ActiveX control, the control's user
interface is blocked until the user activates it. If a page uses these elements to load multiple
controls, each interactive control must be individually activated.
When a control is inactive, the following effects occur.

 Dynamic HTML events related to user interaction, such as onblur and onclick, are blocked.
 The control does not respond to window messages generated by the keyboard or mouse.
 An overlay window, created on the control's OLE site, prevents keyboard and mouse
messages from reaching the inactive control.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 4-5

When a control is inactive, it does not respond to user input; however, it does perform
operations that do not involve interaction. If, for example, you open a web page that uses
Microsoft Windows Media Player to play a music file, the music plays after the page loads.
You cannot interact with Windows Media Player until the control's user interface is activated,
as shown in the following figure.
Figure 4-2 Windows Media Player Control

NOTES.
While inactive controls do not respond to direct user interaction, they do respond to script
commands.

To activate an interactive control, either click it or use the TAB key to set focus on it and
then press the SPACEBAR or the ENTER key. Interactive controls loaded from external
script files immediately respond to user interaction and do not need to be activated.
Loading Interactive Controls Externally
To create web pages that load interactive controls that respond immediately to user input, use
Microsoft JScript to load controls from external script files. You cannot write script elements
in line with the main HTML page to load your control externally. If the script is written
inline programmatically, for example with the writeln function, the loaded control will
behave as if it was loaded by the HTML document itself and will require activation. To
ensure a control is interactive when it is loaded, use one of the following techniques to load
your control from an external file.
The following example uses document.write to load a control dynamically.
<!-- HTML File -->
<html>
<body leftmargin=0 topmargin=0 scroll=no>
<script src="docwrite.js"></script>
</body>
</html>
// docwrite.js
document.write('<object classid="clsid:6BF52A52-394A-11d3-B153-
00C04F79FAA6">');
document.write('<param name="URL" value="example.wmv">');
document.write('<param name="autoStart" value="-1"></object>');

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


4-6 Chapter 4 Web Page Authoring Overview

External script files can also modify an element's outerHTML property to achieve the same
effect, as shown in the following example.
<!-- HTML File -->
<html>
<body>
<div id="embedControlLocation">
<script src="embedControlOuterHTML.js"></script>
</div>
</body>
</html>
// outerhtml.js
embedControlLocation.outerHTML = '<embed src="examplecontrol">';
The next example uses document.createElement to load an ActiveX control using the
OBJECT element.
Important When using createElement to add an Object or Embed element to a web page,
use care to create the element, initialize its attributes, and add it to the page's DOM before
creating the ActiveX control to be loaded by the new element.
<!-- HTML File -->
<html>
<body>
<div id="DivID">
<script src="createElementExplicit.js"></script>
</div>
</body>
</html>
// createElementExplicit.js
var myObject = document.createElement('object');
DivID.appendChild(myObject);
myObject.width = "200";
myObject.height = "100";
myObject.classid= "clsid:6BF52A52-394A-11d3-B153-00C04F79FAA6";
myObject.URL = "example.wmv";
myObject.uiMode = "none" ;

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 4-7

The next example uses innerHTML and a JScript function to load an ActiveX control while
specifying parameter values.
<!-- HTML File -->
<html>
<head>
<script src="external_script.js" language="JScript"></script>
</head>

<body>
<div id="EXAMPLE_DIV_ID">
This text will be replaced by the control
</div>
<script language="JScript">
CreateControl( "EXAMPLE_DIV_ID",
"clsid:6BF52A52-394A-11d3-B153-00C04F79FAA6",
"EXAMPLE_OBJECT_ID", "600", "400",
"example.wmv",
"-1")
</script>
</body>
</html>
// external_script.js
function CreateControl(DivID, CLSID, ObjectID,
WIDTH, HEIGHT, URL, AUTOSTART)
{
var d = document.getElementById(DivID);
d.innerHTML =
'<object classid=' + CLSID + ' id=' + ObjectID +
' width=' + WIDTH + ' height=' + HEIGHT +'>
<param name="URL" value=' + URL + '>
<param name="autoStart" value=' + AUTOSTART + '/>';
}
There are sample documents installed on a Legacy Exaquantum/Web server that demonstrate
these techniques. They can be found under <Exaquantum Installation
Folder>\WebRoot\Samples. These samples also include an example of a page that displays a
blank trend along with a data selector so that tags may be dragged onto the trend.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


4-8 Chapter 4 Web Page Authoring Overview

This page intentionally blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-1

Chapter 5 Creating Graphics and Process Mimics


The Graphics Editor is a “Design Time” only version of Exaquantum/Explorer. It provides
the following functionality:
 An environment to create graphic plant views in PXG format (the native source format of
the program), which can then be saved as a web documents (SVG) for deployment over
the Web.
 An Import mechanism to convert existing Explorer (PXD) and CS 3000 (sva) graphics
documents into PXG documents.
This chapter covers how to create and manage mimics, followed by a more detailed
description of the features and operations of the Graphics Editor. Finally, there is
information about importing Explorer graphics, and converting CS 3000 graphics.
NOTES.
1. This applies to Graphics Editor running with Virtualization enabled (Local Security
Policies, “User Account Control: Virtualize file and registry write failures to per-user
locations”). Virtualization was introduced in these Operating Systems, as part of the
security enhancements. This feature controls write access to files and folders, to which
the user does not have write access (for example, to the windows “Program Files” folder).
If a user creates a folder or saves a pxg document to such a location, the Operating
System writes the actual file or folder to the users Virtual Store Folder. This location is
determined by the value of the userprofile environment variable. The effect of this is that
users other than the user who created the file or folder will not be able to read that
location. Therefore, users wishing to create shared documents should be careful when
selecting the location of where to save the stored files.
2. The Graphics Editor can be used to create Mimics for both websites:
 Legacy Exaquantum/Web
 Exaquantum Web

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-2 Chapter 5 Creating Graphics and Process Mimics

5.1 Creating and Managing Mimics


Creating Mimics from Scratch
1 Start the Graphics Editor and use the File menu, New option.
2 Drag and drop palette components onto the main drawing screen and configure the
properties of each component.
3 You can enrich functionality with features such as:
 Hyperlinks to other web pages
 Managing many components by way of layers
 Expressions that allow conditional rendering.
4 Save the mimic regularly in PXG format to avoid losing the file accidentally. You will
need this file again if you want to make amendments to the mimic, so store it in a secure
location that is backed up regularly.
5 When editing of the mimic is complete, use File menu, Save as Web Page option. This
generates an SVG format file available for viewing through the Exaquantum/Web site.
Use the folder on the Exaquantum/Web server that you created to hold these files, for
example:
<Exaquantum Installation Folder>/WebRoot/Views
6 Use Publish View to make the mimic available for viewing.
NOTE.
The History Replay option is only available in Exaquantum/Explorer and is not supported in
the Graphic Editor.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-3

5.2 Graphic Editor Components


General features of the Graphics Editor are described in this section.
User Interface
Figure 5-1 Graphic Editor User Interface - Example

As with the existing Exaquantum/Explorer programs, objects from the Palette may be
dragged onto the central work area to create a static plant mimic and plant information may
be dragged from the Data Selector to animate this static view. For example, in Figure 5-1
the ‘A’ object from the Palette has been dragged underneath the right tank, and the open PV
object in the Data Selector has been dragged into it. This will mean that the live value of
Test.Root.TestTag.20FIC053.PV will be shown when the mimic is finally viewed.
Mimics produced should be saved in a native PXG format, which works as a source for
future enhancements. When mimics are ready for viewing over the Web, they must be saved
as an SVG file and incorporated into the Exaquantum/Web site.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-4 Chapter 5 Creating Graphics and Process Mimics

Data Selector
You can use the standard Data Selector to add tags to the view via property pages. As in
Exaquantum/Explorer, tags can be attached to Gauges, Pointers, Color dynamics etc., to
provide dynamic graphics.
The update rate of the data item can be set explicitly. During run time the data will be
updated at a frequency no greater than 1 minute. This is to not overload the client machine.
Navigation
Hyperlinks can be used to provide navigation from objects on the current page to any other
web page that is available, either on the Internet, an intranet or on the Exaquantum/Web
server. Whenever a user clicks on an object for which a Hyperlink is set, the target page will
be opened.
 The target page for the Hyperlink is set in the object’s ‘Property Sheet’ dialog box.
 Exactly how the target page opens will depend on settings in the ‘Hyperlink
Navigation properties’ dialog box.
Setting a Hyperlink
To set an objects hyperlink:
1 To access the object properties, right-click on the object.
2 From the context menu select ‘Object Properties’.
3 In the object’s Property Sheet dialog box, locate the Hyperlink property.
4 In the Hyperlink property, enter the address in the appropriate format.
Figure 5-2 Object Property sheet highlighting Hyperlink property

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-5

Hyperlink address formats


There are four distinct forms of links:
 Links to standard web pages on the Internet, or an intranet.
These take the form of a standard internet URL. An example could be:
http://www.yokogawa.com/
 Links to pages on the Exaquantum/Web server
These are web pages served by the Exaquantum/PIMS server. They can be standard HTML
files such as those created with a web editor like SharePoint Designer for displaying Trend
or Alarm and Event data; or system originated pages generated using ASP (Active Server
Pages).
This sort of address takes a similar form to that above, but the address of the local Web
server is used instead:
http://<servername>:portnumber>/<path to file>
Where
<servername> is the name of your Exaquantum/Web server;
<portnumber> is the port through which to communicate to the web site
<path to file> is the file name and location of the file within the servers Web file system.

 Links to Legacy Exaquantum/Web mimic pages created with the Exaquantum Graphics
editor (See section Hyperlink address formats – Legacy Exaquantum/Web for details).
 Links to Exaquantum/Web mimic pages created with the Exaquantum Graphics editor
(See section Hyperlink address formats – Exaquantum/Web for details).

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-6 Chapter 5 Creating Graphics and Process Mimics

Hyperlink address formats – Legacy Exaquantum/Web


Web pages created by the Exaquantum Graphics Editor are in SVG (Scalable Vector
Graphics) format. This means they have to be loaded into a host framework in order to be
displayed.
The Hyperlink takes the form:
<Address of framework>?svg=<address of target page>
Which is made up of three elements;
<Address of framework> - This is the address and name of the basic framework page that
will be used to host the target page. This is provided as part of the system. In a default
installation, the address will be similar to:
http://<servername>:<portnumber>/exaquantum/applications/wa
c/mimicframeset.asp
Where
<servername> is the name of your Exaquantum/Web server;
<portnumber> is the port through which to communicate to the web site
?svg= - This is the instructions to the system to use the following information as the target
page to be displayed in the framework.
<address of target page> - This is the address and name of the target page that was
originally created using the Exaquantum Graphics Editor.
A complete example would be:
http://servername:8000/exaquantum/applications/wac/mimicfra
meset.asp?svg=../../TargetPage.svg
In this case, the address to the target is a relative address using standard file system paths.
The base for calculating the relative address is the location of the framework page.
There is an alternative form of address that uses the web address to locate the target:
http://servername:8000/exaquantum/applications/wac/mimicfra
meset.asp?svg=http://servername/exaquantum/TargetPage.svg
In this case, the base of the address is the Exaquantum/Web server ‘WebRoot’ folder.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-7

Hyperlink address formats – Exaquantum/Web


Mimic pages for Exaquantum/Web created by the Exaquantum Graphics Editor are in SVG
(Scalable Vector Graphics) format. They have to be loaded into the website in order to be
displayed. They can contain hyperlinks to other mimics that are also loaded into the website.
This Hyperlink takes the form:
http://<servername>:<portnumber>/<exaquantumwebvirtualdirec
tory>/mimic/display?id=<mimic name>
Where
<servername> is the name of your Exaquantum/Web server;
<portnumber> is the port through which to communicate to the web site
<exaquantumwebvirtualdirectory> is the website virtual directory (ExaquantumWeb by
default)
<mimic name> is the mimic name. NOTE that any URL unfriendly characters must be URL
encoded.
Examples are:
http://servername:8000/exaquantumweb/mimic/display?id=Disti
llation (Mimic name is Distillation)
http://servername:8000/exaquantumweb/mimic/display?id=Press
ure%20Vessel (Mimic name is Pressure Vessel)

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-8 Chapter 5 Creating Graphics and Process Mimics

Hyperlink Navigation Properties


Then how the new Internet Explorer window is displayed can be controlled using the
Hyperlink Navigation Properties window.
Figure 5-3 Hyperlink Properties in an Animation Component

Clicking on the Hyperlink Navigation entry displays the Hyperlink Navigation Properties
window. The style of Internet Explorer window can be selected from the drop-down list, and
the display settings and window dimensions can be checked and set as required.
Window target allows you to specify the name of the window in which the URL will be
opened. (This name is used as the value for the TARGET attribute on a form or an <a>
element.) There are four pre-defined targets:
 New Window – the URL is loaded into a new, unnamed window
 Parent Window – the URL is loaded into the current frame's parent. If the frame has no
parent, this value acts as the Replace Window.
 Replace Window – the current document is replaced with the specified URL
 Main Window – the URL replaces any framesets that may be loaded. If there are no
framesets defined, this value acts as the Replace Window.
If New Window or a specific target name is supplied, then the options in Display settings
may be set to control how the new Internet Explorer window is displayed:
 Show Directory buttons – specifies whether to add directory buttons
 Display Fullscreen – specifies whether to display the browser in full-screen mode. Use
full-screen mode carefully. Because this mode hides the browser's title bar and menus,
you should always provide a button or other visual clue to help the user close the window.
ALT+F4 closes the new window.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-9

 Show Location bar – specifies whether to display the input field for entering URLs
directly into the browser
 Display Menubar – specifies whether to display the menu bar
 Resizable Window – specifies whether to display resize handles at the corners of the
window
 Show Scrollbars – specifies whether to display horizontal and vertical scroll bars
 Show Status bar – specifies whether to add a status bar at the bottom of the window
 Show Toolbar – specifies whether to display the browser toolbar, making buttons such as
Back, Forward, and Stop available.
The third section allows the user to amend the Window dimensions:
 Left – specifies the left position, in pixels. This value is relative to the upper-left corner
of the screen. A value of –1 uses the default Left position.
 Top – specifies the top position, in pixels. This value is relative to the upper-left corner
of the screen. A value of –1 uses the default Top position.
 Width – sets the width of the window, in pixels. A value of –1 uses the default Width.
 Height – specifies the height of the window, in pixels. A value of –1 uses the default
Height.
Palette
As in Exaquantum/Explorer, the palette has number of Native objects that can be used in the
PXG graphics:
Table 5-1 Palette

Line

Ellipse

Border

Polyline

Bitmap

Pointer

Text

Arc

Gauge

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-10 Chapter 5 Creating Graphics and Process Mimics

Layers
To assist in creating views, the Graphics Editor allows you to define layers, put objects on
any of the layers, and view any number of layers simultaneously. To set the layer
configuration, click on an empty area of the view to display the Property Sheet; then click
the ellipsis in the right column of ‘ViewLayers’ to see the layers sheet:
Figure 5-4 Layers Sheet

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-11

By default, all the objects on the sheet are placed in the default layer, but you can add more
layers as shown, and make them visible or invisible. You can move objects from layer to
layer through their property sheets:
Figure 5-5 Property Sheet

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-12 Chapter 5 Creating Graphics and Process Mimics

Calculations and Manipulating the View


You can manipulate many of the properties of the objects on the view by associating them
with a value of tags. For example, the level shown by a gauge object can be directly linked
to a process variable (PV). More complex manipulations involving constants, ‘report times’,
and multiple tag values are also possible.
Variables
The property sheet of the view itself includes ‘Variables’. To access the View’s property
sheet, right-click on an empty area of the sheet. Clicking on the right column of ‘Variables’
displays the Variables window. There are two tabs (Local Variables and Data Variables).
You can add named local variables by right clicking in the ‘Name column’. A pop-up menu
is displayed, as shown.
Figure 5-6 Variables

Once a variable has been defined, you can refer to it in the expression editors of any of the
objects on the sheet. See Section 5.3 for a description of the Expression Editor.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-13

Report Times
Report Times are also properties of the View and may be used in a similar way to the local
variables. They are set with the dialog shown below:
Figure 5-7 Set Local Report Times

5.3 Expression Editor


Overview
Imported CS 1000/CS 3000 graphics may include Expressions. The Graphics Editor
supports these, and you may edit them or create new ones regardless of the original source of
the file. The created Expressions may include Graphics Editor Specific functionality such as
Parameterization and Report Times. This functionality is a web-based equivalent of
Exaquantum Explorer’s scripting.
You can bind an expression to an object in the same way as a constant or Data Variable. The
Expression Editor can create two basic types of expression:
 Simple Mathematical Expressions
 Conditional Expressions.
It allows the use of both Data Variables and Local variables with a number of simple
operators.
Before allowing the Expression to bind to a property, the Editor will parse the expression to
ensure that it is valid.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-14 Chapter 5 Creating Graphics and Process Mimics

Simple Expressions
A simple expression returns a result directly into a property, for example:
( [TestRootTestTag20FIC053PVValueValue] + [OFFSET] )/100

This adds an Exaquantum Tag (Data Variable) to the value of OFFSET (Local Variable), and
divides the result by 100.
An equation like this could be bound to any Text property (Top, Width, Value etc.).
For example, suppose a user wanted to control the height of an ellipse according to the value
of the expression above. Right click the ellipse and chose ‘Object Properties’ to display the
Property Sheet. Then click in the right column of ‘Height’ to display the Property Binder.
Selecting the Expression radio button then displays the interface (Figure 5-8):
Figure 5-8 Expression Editor in Simple Expression Mode

NOTE. The names of the variables are used (not their paths) and square brackets are used to
separate the operands from the operators.
Tip: The names of the data variables are automatically created from their paths and are
often cumbersome to type. If you temporarily create a text field on the work area and drag
the tag into it, you can then copy the name from the work area into the clipboard (Ctl C) and
paste it into the Property Binder text box (Ctl V). Delete the item from the work area later.
NOTE. Expressions can be evaluated once (when the View is first displayed), or on every
refresh.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-15

Valid Operators in Simple Expressions


The following table shows a list of valid operators that can be used in Simple expressions:
Table 5-2 Valid Operators for Simple Expressions

Operator Description
( ) Priority
+ Add
- Subtract
* Multiply
/ Divide
& Bit AND
| Bit OR

Conditional Expressions
A Conditional Expression returns a value to a property depending on a set of conditions. The
Property Binder provides some help in defining a Condition Expression:
1. Use the “[“ key – this displays the Select Variable dialog, containing a list of data
variables
2. Select the required data variable and press OK
3. Complete the expression
Conditional Expression examples:

FIC100.PV >50.0
FIC100.PV +FIC300.PV <=FIC400.PV
FIC100.PV >50.0 and FIC200.PV < FIC100.ALRM
FIC100.AOFS =”AOF”

These four conditions are evaluated in order. When a condition is found to be true, a
specified value (such as a color code) is returned to the property.
These types of expressions are mainly used for setting color dynamics on objects by
comparing the values of a number of different tags.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-16 Chapter 5 Creating Graphics and Process Mimics

Figure 5-9 shows an example of the Expression Editor in Conditional Expression mode.
Figure 5-9 Expression Editor in Conditional Expression Mode

Valid Operators in Conditional Expressions


The following table shows a list of valid operators that can be used in Conditional
expressions:
Table 5-3 Valid Operators for Conditional Expressions

Operator Description
= Equal
<> Not Equal
> Greater than
< Less than
>= Greater than or Equal To
<= Less than or Equal to
AND And
OR Or

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-17

5.4 Notes on Converting CS 3000 Graphics


This section provides information useful to start converting CS 3000 graphics.
Scope of conversion
The conversion tool is based on the CS 3000 feature to export CS 3000 graphics into SVG.
For more details about the restrictions this imposes, refer to 17.2.
NOTE 1 This is an optional feature that is only available when the correct license key code
has been used to install the Exaquantum software.
NOTE 2: Before starting the conversion, make sure that the pre-processing options are
properly configured. The pre-processing is to absorb commonly observed
differences between CS 3000 graphics and Exaquantum mimics. See Section 5.4
for more detail.
NOTE 3:The Graphic Conversion will only resolve tags in the Intrinsic Namespace to
dynamics on any Graphic. No resolution is done for RBNS tag paths.
Pre-processing CS 3000 Graphics Files
CS 3000 graphics are often used for operational purposes, whilst Exaquantum mimics are
meant more for managerial purposes. Due to such differences, there are usually deficiencies
between the two. The conversion program provides pre-processing to address this.
Pre-processing involves applying small changes to an input file. Each step is defined in a
file, and files are to be located in:
<Exaquantum install directory>\Graphics Editor\SVG Filters
for Graphics Editor and
<Exaquantum install directory>\Explorer\SVG Filters
for Exaquantum Explorer.
These files are applied in alphabetical order, according to their file names.
The standard Exaquantum provides these definition files in their order of application. A
number of these pre-processing files are for the standard conversion. These can be added to
by prefixing the developed style sheet with a number, e.g. O60_MyConversion, to ensure the
correct order of processing.
NOTE The definition file is a XML style sheet, and creating a style sheet requires
knowledge of the XML technology. Ask your Yokogawa representative about
adding any required changes.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-18 Chapter 5 Creating Graphics and Process Mimics

Graphics conversion logs


Because the names used for Tags in the Exaquantum database and those used in the CS3000
graphic may be different, it is possible that not all the references can be reconciled. To help
resolve these issues, whenever graphics conversion is used, two log files are created.
TAGxxxx_Mapped.log – Contains a list of all the tag names found in the graphic being
converted.
TAGxxxxMissing.log – Contains a list of all the tag names that could not be reconciled with
names in the Exaquantum database.
Where xxxx is a unique string allocated by the system.
The log files are located in the user’s temporary folder (%TEMP%), for example on
Windows7:
C:\Users\<username>\AppData\Local\Temp
Converting CS 3000 Graphics
You can import CS 3000 graphics into Exaquantum/Web using this feature.
1 Start the Graphics Editor and then from the File\Import menu select one of the following
as described in step 2, Importing graphics: Import HIS Graphic… or Import SVG File...
2 Importing graphics
 Import HIS Graphic…
Figure 5-10 Import HIS Graphic

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-19

NOTE. Before importing a HIS graphic, it is necessary to register the login user on the
CENTUM HIS computer.
This example shows how to enable HIS graphic import for the user “User1”
This user may also be a workgroup user or a domain user.
It is necessary for User1 to be member of either of the following groups, in
order to edit Exaquantum Graphics Editor Documents:
 Legacy Model: QUserGroup and QExplorerDesign Group
 Standard Model: QTM_DATA_READ and
QTM_EXPLORER_DESIGN
Register the login user to CENTUM HIS PC as follows.
1. Login on the HIS PC as a user with Administrator privileges.
2. Run the Control Panel
4. Click ‘Administrative Tools’.
5. Click ‘Computer Management’.
6. Double-click ‘Users and Passwords’.
7. Click ‘Local users and Groups’.
8. Click Users in ‘Local users and Groups’ and right click.
9. Select ‘New User’.
10. Register User name as “User1” and set a Password.
password must be the same password as for “User1” on Exaquantum PC
uncheck "User must change password at next logon" and check “Password never
expires”
11. Push create button.
Set the following:
 HIS HostName - Destination HIS computer name
 Project Name - CS3000 project name. This will be automatically populated
with the default project found on the HIS HostName computer.
 Graphic Document – The SVA or EDF graphics file to convert
 Exaquantum Server – The Exaquantum server computer name
 OPC Server – The OPC gateway name. Only used when a CENTUM tag
(e.g. T100.PV) is converted to an Exaquantum path name (e.g.
Root.Folder.T100.PV.Value:Value). This field may contain the SQL
wildcard character “%” in order to match zero or more characters. For
example, if we have two OPC servers called OPCGateway1 and
OPCGateway2, then it is possible to specify "OPCGateway%" in the OPC
Server field to find tags from both OPC servers.
Click the OK button to begin the conversion.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-20 Chapter 5 Creating Graphics and Process Mimics

 Import SVG File…


Figure 5-11 Import SVG File

Set the following:


 SVG File - Destination SVG file name. Refer to Converting SVA to SVG
 Exaquantum Server – The Exaquantum server computer name
 OPC Server – The OPC gateway name. Only used when a CENTUM tag
(e.g. T100.PV) is converted to an Exaquantum path name (e.g.
Root.Folder.T100.PV.Value:Value). This field may contain the SQL
wildcard character “%” in order to match zero or more characters. For
example, if we have two OPC servers called OPCGateway1 and
OPCGateway2, then it is possible to specify "OPCGateway%" in the OPC
Server field to find tags from both OPC servers.
Click the OK button to begin the conversion.
3 The program starts to convert the graphics into the native Graphics Editor, PXG, format.
NOTE. The time taken for the conversion process is dependent on the complexity of the
source graphics file. The progress viewer will provide an indication of the
current progress made in the conversion process.
4 On completion of the conversion process, the converted graphic may be edited as normal.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-21

Converting SVA to SVG


This tool converts a graphic file on the HIS in EDF format, to an SVG file.
Figure 5-12 SVG Convert Tool

The following steps describe the conversion process:


1. Copy the files “ToolSVGConvert.exe” and “LibToolSVGConvertRes.dll” from the
“\Tools\Graphic Converter for HIS” folder on the Exaquantum Install CD to a
location on the HIS.
2. Double-click the file to execute the application
3. Select the Project Name from the dropdown list.
4. Select the Station Name from the dropdown list.
5. Select a graphic file or graphic files to convert from the list.
6. Click on the Convert button. A dialog will be displayed in order to specify where
the converted destination file(s) will be saved. SVG files are written to the specified
folder.
NOTE. This tool can only be used on the HIS computer.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-22 Chapter 5 Creating Graphics and Process Mimics

5.5 Notes on Converting CENTUM VP Graphics


This section provides information useful to start converting CENTUM VP graphics.
Scope of conversion
The conversion tool is based on the CENTUM VP feature to export CENTUM VP graphics
into SVG. For more details about the restrictions this imposes, refer to Chapter 19 Scope of
CENTUM VP Conversion.
NOTE 1:This is an optional feature that is only available when the correct license key code
has been used to install the Exaquantum software.
NOTE 2:Before starting the conversion, make sure that the pre-processing options are
properly configured. The pre-processing is to absorb commonly observed
differences between CENTUM VP graphics and Exaquantum mimics. See Section
5.5 for more detail.
NOTE 3:The Graphic Conversion will only resolve tags in the Intrinsic Namespace to
dynamics on any Graphic. No resolution is done for RBNS tag paths.
Pre-processing CENTUM VP Graphics Files
CENTUM VP graphics are often used for operational purposes, whilst Exaquantum mimics
are meant more for managerial purposes. Due to such differences, there are usually
deficiencies between the two. The conversion program provides pre-processing to address
this.
Pre-processing involves applying small changes to an input file. Each step is defined in a
file, and files are to be located in:
<Exaquantum install directory>\Graphics Editor\SVG Filters
For Graphics Editor and
<Exaquantum install directory>\Explorer\SVG Filters
For Exaquantum Explorer.
These files are applied in alphabetical order, according to their file names.
The standard Exaquantum provides these definition files in their order of application. A
number of these pre-processing files are for the standard conversion. These can be added to
by prefixing the developed style sheet with a number, e.g. O60_MyConversion, to ensure the
correct order of processing.
NOTE. The definition file is a XML style sheet, and creating a style sheet requires
knowledge of the XML technology. Ask your Yokogawa representative about
adding any required changes.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-23

Graphics conversion logs


Because the names used for Tags in the Exaquantum database and those used in the CENTUM
VP graphic may be different, it is possible that not all the references can be reconciled. To help
resolve these issues, whenever graphics conversion is used, two log files are created.
TAGxxxx_Mapped.log – Contains a list of all the tag names found in the graphic being converted.
TAGxxxxMissing.log – Contains a list of all the tag names that could not be reconciled with
names in the Exaquantum database.
Where xxxx is a unique string allocated by the system.
The log files are located in the user’s temporary folder, for example:
C:\documents and settings\<username>\Local Settings\Temp
Converting CENTUM VP Graphics
You can import CENTUM VP graphics into Exaquantum/Web using this feature.
1 Start the Graphics Editor and then from the File\Import menu select Import SVG File...
2 Importing graphics
 Import SVG File…
Figure 5-13 Import SVG File

Set the following:


 SVG File - Destination SVG file name. Refer to Converting SVA to SVG
 Exaquantum Server – The Exaquantum server computer name
 OPC Gateway – The OPC gateway name. Only used when a CENTUM tag
(e.g. T100.PV) is converted to an Exaquantum path name (e.g.
Root.Folder.T100.PV.Value:Value). This field may contain the SQL
wildcard character “%” in order to match zero or more characters. For
example, if we have two OPC servers called OPCGateway1 and
OPCGateway2, then it is possible to specify "OPCGateway%" in the OPC
Server field to find tags from both OPC servers.
Click the OK button to begin the conversion, the OPC Gateway will be validated
automatically, and an error message displayed if the details are invalid.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-24 Chapter 5 Creating Graphics and Process Mimics

3 The program starts to convert the graphics into the native Graphics Editor, PXG, format.
NOTE. The time taken for the conversion process is dependent on the complexity of the
source graphics file. The progress viewer will provide an indication of the current
progress made in the conversion process.
4 On completion of the conversion process the converted graphic may be edited as normal.
Converting SVA to SVG
This tool converts a graphic file on the HIS in EDF format, to an SVG file.
Figure 5-14 CentumVP SVG Converter

The following steps describe the conversion process:


1. Copy the files
“Yokogawa.IA.iPCS.CENTUMVP.ENG.UTY.SVGConvertTool.exe ” and
“LibToolSVGConvertRes.dll” from the “\Tools\Graphic Converter for
CENTUMVP” folder on the Exaquantum prerequisite DVD (Disc 1) to a location
on the HIS.
2. Double-click the file to execute the application
3. Select the Folder Name from the Add Folder button.
4. Select the File Name from the Add File(s) button.
5. Select a graphic file or graphic files to convert from the list.
6. Click on the Browse button. A dialog will be displayed in order to specify where
the converted destination file(s) will be saved.
7. Click on the Convert button. SVG files are written to the specified folder.
NOTE. This tool can only be used on the HIS computer.
NOTE. When a Graphic file created by CS 3000 is to be used by the Convert tool, it is
necessary to open that graphic file on CENTUM VP graphic builder and save it
again before running the conversion to SVG.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 5-25

5.6 Notes on Importing Exaquantum/Explorer Documents


Restrictions
You can create Web mimics based on an existing Exaquantum/Explorer document. This
import does lose some Exaquantum/Explorer document features:
 Only the supported controls, lines, arcs, borders etc. will be converted. All other controls
will be lost. See the information about Palette, in Section 5.2, for the supported controls.
 All ActiveX components, including Trend, Alarms and Events, are removed from the
converted file. You have to create an html file to embed the converted mimic file (SVG)
together with other ActiveX equivalence configured in the html portion.
 All of the scripting will be removed.
 Parameterization will be available in the converted mimics, hence no need to amend
the outcome.
 Report time will be available in the converted mimics, hence no need to amend the
outcome.
 Navigation between documents will be lost. You have to wrap the SVG with an html
file that has navigation features configured.
 Inter-components manipulation will be lost. You have to configure each component
with the same condition.
 Other complex scripting will be lost. You have to re-engineer the features.
Importing Existing Exaquantum/Explorer Documents
You can start with an existing Exaquantum/Explorer document to create a Web page.
1 Start the Graphics Editor and use the File menu, Import option.
2 In the File Import dialog, select Exaquantum/Explorer document (PXD) file type and
open an Exaquantum/Explorer document file.
3 The program starts to convert the graphics into the native PXG format.
NOTE. This may take some time depending on the complexity of the source graphics
file. You can see the progress on the screen.
4 Once imported you can edit the file as in the case of a mimic created from scratch.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


5-26 Chapter 5 Creating Graphics and Process Mimics

This page intentionally left blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 6-1

Chapter 6 Creating Pre-configured Trend


NOTE. The detail in this section refers to the Legacy Exaquantum/Web only.
The trend page is an html page that consists of the Yokogawa Exaquantum/Web Trending
Control, with or without other controls or text around it.
If you just want to see a trend view, you can configure the trend control as described below.
If you want to add more features, for example to show the name of a product being produced,
you have to configure those features around the trend control using standard authoring
functions. This chapter does not cover this case. You should refer to the user manual of the
authoring tool that you are using to add these features.
6.1 Configuring the Trend Control
1 Place the control on the page.
Click on Insert Trending Control from the Exaquantum Add-in menu.
2 Modify its dimensions using its resize handles.
Right click anywhere on the control and choose ‘ActiveX Control Properties’ to get the
properties dialog.
NOTE. Most of the trend properties are the same as those in the trend control in
Exaquantum/Explorer, and you set them in the same way.
3 The ‘Attached data’ items in the Trend Template must be populated with tags that are
dragged from the Data Selector add-in.
NOTE. You always have to configure tags.
4 Save the file with File menu, Save as Web Page in the designated folder on the web
server. For example:
<Exaquantum Installation Folder>/WebRoot/Views
5 Use Publish View from the Exaquantum Add-in to add this view to the Legacy
Exaquantum/Web site. Supply the name, description and URL of this trend page.
NOTE. You do not have to supply the entire URL for the page that you have created.
Exaquantum knows the location of the web site, so you need only specify the
folder structure that you have created when you publish a view. For example:
URL /views/trend1.htm

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


6-2 Chapter 6 Creating Pre-configured Trend

This page intentionally left blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 7-1

Chapter 7 Creating Pre-configured Alarms and Events


Summary
NOTE. The detail in this section refers to the Legacy Exaquantum/Web only.
The Alarms and Events Summary page is an html page that consists of the Yokogawa
Exaquantum/Web Event Summary Control, with or without other controls or text around it.
If you want to just see an Alarms and Events Summary view, you can configure the control
as described below. If you want to add more features, for example to show the name of a
product being produced, you have to configure those features around the control using
standard authoring functions. This chapter does not cover this case. You should refer to the
user manual of the authoring tool that you are using to add these features.
7.1 Configuring the Alarm and Event Control
1 Place the control on the page.
Click on Insert Event Summary Control from the Exaquantum Add-in menu.
2 Modify its dimensions using its resize handles.
Right click anywhere on the control and choose ‘ActiveX Control Properties’ to get the
properties dialogue.
NOTE. Most of the properties are the same as those in the control in
Exaquantum/Explorer and you set them in the same way.
3 Save the file with File menu, Save as Web Page in the designated folder on the web
server.
4 Use Publish View from the Exaquantum Add-in to add this view to the Legacy
Exaquantum/Web site. Supply the name, description and URL of this page.
NOTE. You do not have to supply the entire URL for the page that you have created.
Exaquantum knows the location of the web site so you need only specify the
folder structure that you have created when you publish a view. For example:
URL /views/event1.htm

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


7-2 Chapter 7 Creating Pre-configured Alarms and Events Summary

This page intentionally left blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 8-1

Chapter 8 Moving a Web Server to a Dedicated PC


NOTE. The detail in this section refers to the Legacy Exaquantum/Web only.
As the number of web clients grows, it will become necessary to provide a web server that
runs on a dedicated PC, rather than sharing resources with the Exaquantum server.
On a system that has been running for a period of time, users will have created views and
may have set up MyList and QuickLinks to make selection of their favorite web pages as
simple as possible. This information resides in files that reside on the Legacy
Exaquantum/Web server.
To move a Web Server from a combined Exaquantum and Web server to a dedicated Web
Server follow the steps below.
8.1 Set Up the Dedicated Web Server
1 Install the Exaquantum prerequisites for a dedicated Web Server from the Exaquantum
prerequisites CD. (For more information, see the Exaquantum Installation Guide.)
2 Install the Web Server from the Exaquantum software CD. (For more information, see
the Exaquantum Installation Guide.)
NOTE. It is strongly recommended that the installation folder is identical to that of the
combined Exaquantum and Web Server.
8.2 Back Up User Views
Views are web pages that have been saved in the Legacy Exaquantum/Web site. They must
be copied to the same location in the new web server file structure if they are to continue to
be available to users.
<Exaquantum Installation Folder>/ WebRoot/......
The standard Backup function can be used to make a copy of these files. Copy the Back Up
file to the dedicated web server.
8.3 Restore User Views
Restore the views from the back up file.
8.4 Remove the Web Server from the Exaquantum Data Server
1 Uninstall Exaquantum.
2 Reinstall the Exaquantum without the Web Server option.

Caution
Do not overwrite the Exaquantum database.

3 Restart Exaquantum.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


8-2 Chapter 8 Moving a Web Server to a Dedicated PC

8.5 Adjusting Views


When Trend views and Alarm and Event views are created using Microsoft Front Page, each
instance of the control on a web page has a URL defined that specifies the location of the
Legacy Exaquantum/Web site. When the web server moves to a machine with a different
name, the location of the web site moves with it, and the URL will need to be changed.
The standard URL for the Legacy Exaquantum/Web site is <Web Server Machine
Name>:<Port Number>/Exaquantum. If the web server machine name has been changed,
the URL becomes invalid and every reference to it must be changed.
Change the URLs by loading the web page into the Web Authoring tool, making the change
and resaving the page.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 9-1

Chapter 9 Managing the Number of Users


NOTE. The detail in this section refers to the Legacy Exaquantum/Web only.
Each Exaquantum/Web client PC connected to Exaquantum must be licensed. However,
because web clients are not bound to any particular client PC, a system of user profiles is
used to manage access to Exaquantum.
When there are more users accessing a Legacy Exaquantum/Web server than are covered by
the license, a warning message will be displayed in the browser window.
To avoid this message being displayed to users, you can either:
 Contact Yokogawa to obtain a new license key code to extend the number of Legacy
Exaquantum/Web clients permitted.
 Remove some currently unused user profiles from the server.
9.1 Deleting User Profiles
User profiles can be removed from the system using the Web Administration Tool, which is
available on the Legacy Exaquantum Web server. To be able to access the Web
Administration Tool, you must be a member of one of the Exaquantum Administrators
groups:
QAdministratorsGroup (Legacy Security Model)
QTM_MAINTENANCE (Standalone and Domain Security Model)
QTM_MAINTENANCE_LCL (Standalone and Domain Security Model)
To delete User Profiles:
1 From the Windows Start menu, select Programs, Exaquantum, Web Administration Tool.
2 From the list displayed in the Web Administration Tool window, select the User Profile
to be removed.
3 Click on the Delete button.
4 Repeat the above is procedure for each unused profile that is to be removed.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


9-2 Chapter 9 Managing the Number of Users

This page intentionally left blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 10-1

Chapter 10 Introduction to Exaquantum Web


The Exaquantum Web allows users to connect to Exaquantum systems using Internet
technology. It provides a number of pre-configured, ready to use Web pages. An overview
of these web pages is shown below.
Figure 10-1 Exaquantum Web – Site Map

10.1 Content
This section introduces the content of the sections within this manual that describe the
Exaquantum website – listed in Table 10-1
Table 10-1 Content Overview

Chapter Description
Chapter 11 Overview of the Exaquantum Web
Chapter 12 Basic operation of the Exaquantum Web
Chapter 13 to The detail on how to use the Exaquantum Web key functions – see
Chapter 16 Section 10.2 for an overview
Chapter 17 Administration of the Exaquantum Web

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


10-2 Chapter 10 Introduction to Exaquantum Web

10.2 Key Functions


The Exaquantum website contains three major display functions, listed in Table 10-2. The
content varies according to the function of the page: -
Table 10-2 Key Functions

Function Chapter Description


Trends Chapter 13 Trend Web Pages contain the following: -
1. Time series plots of tag data
2. Supporting detail and any configured annotations
In addition, Alarm and Event data can be displayed in order
to concurrently analyze tag and alarm/event data: -
3. Time series table of Alarm and Event data
Mimics Chapter 14 Mimics are graphical displays of plant areas. The mimics
that can be displayed are created externally to Exaquantum
Web; they are linked to Exaquantum Web by administrator
& explorer design level users, but can be selected for display
by any user.
Reports Chapter 15 The display of an external file, initiated from Exaquantum
Web.
Reports are uploaded by administrator & explorer design
level users, but can be downloaded by all users.
XY Plots Chapter 16 XY Plot Web Pages allow the values of up to 7 tags to be
plotted against a single reference tag. The appearance of the
XY Plot is similar to a scatter chart where the data is
displayed as a collection of points rather than a continuous
line.

10.3 Intended Audience


This manual is primarily intended for website Users and Administrators.
The operation of this website is closely linked to Tag and Alarm and Event data. It is
therefore assumed that a website user is familiar with the concept of Tags, and Alarm and
Event data.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 10-3

10.4 Glossary
Item Description
Annotation Annotations are notes which can be associated with points in time on a Trend.
Application Application pools are used to separate sets of IIS worker processes that share
Pool the same configuration and application boundaries. This is for:
1. Isolation of Different Web Application
2. Individual worker process for different web application
3. More reliably web application
4. Better Performance
Data Provides storage of tag and alarm/event data; producer of both data types for
Server consumers – web clients
Historical A data value for a single point in time, for one or more tags from history; the
Spot Data value will not update live.
Historical A set of data for one or more tags, for the same time range; the time range
Trend Data defined by a start and end time.
Live Data The current data of a specific tag; this may include quality and timestamp.
The data should update automatically if new data for the tag is received.
Mimics A pictorial representation of an area of plant. This can include:
1. Alpha-numeric display of tag data
2. Dynamic graphics, where the dynamic is driven from a tag value.
Namespace The access string to a tag from a Data Server.
Data
Pen The plot (line) on a trend for one tag.
Port In computer networking a port is an application-specific or process-specific
Number software construct serving as a communications endpoint in a computer's
host operating system
Reports A file containing a set of data. The content of the file is external Exaquantum
Web.
SVG Scalable Vector Graphics. An XML format file that describes two-dimensional
graphics. Used in Mimic files for Exaquantum Web (both legacy and new)
Tag The name of an item of measurement from a plant. For example, temperature.
Tag Data The value, quality and timestamp for a tag. The tag data is stored on a Data
Server.
Trend A graph of value against time, for one or more tag values.
URL Uniform Resource Locator. A reference (an address) to a resource on a
computer network (e.g. http://webserver:8000/ExaquantumWeb/ ).
Virtual A folder in IIS which appears in a path but which is not actually a subfolder
Directory of the preceding folder in the path. This path serves as the point of access to
the application (website).

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


10-4 Chapter 10 Introduction to Exaquantum Web

Item Description
Web Client A consumer of data from a data server; uses web browsers to host the display
of the data (tag and alarm/event).
XY Plot A scatter graph of tag values plotted against a reference tag.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 11-1

Chapter 11 Overview of the Exaquantum Web


This manual concerns the configuration and use of Exaquantum web pages which are hosted
in a web browser on client machines.
Exaquantum web pages are stored in a website application, which runs on the Exaquantum
Web Server.
The following figure shows the components of a system incorporating Exaquantum web.
Figure 11-1 System Components
Exaquantum Web
Clients

Exaquantum Web
Plant OPC Servers Server

Firewall

Plant PCS, DCS, Exaquantum Data


PLCs etc. Server

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


11-2 Chapter 11 Overview of the Exaquantum Web

11.1 Page Layout


The Exaquantum website provides permitted users with the ability to view plant information
data in different web pages. The web pages on Exaquantum Web have a common layout.
This layout is shown:
 for a desktop browser in Figure 11-2 below
 for a tablet in Figure 11-3 below
Table 11-2 below describes the differences in the tablet display.
Figure 11-2 Desktop Web Page Layout

1
2

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 11-3

Figure 11-3 Tablet Web Page Layout

1
2

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


11-4 Chapter 11 Overview of the Exaquantum Web

Table 11-1 below corresponds to the features indicated in the figures above.
Table 11-1 Web Page Components

Ref Section Description

1 Top Bar Provides menus for accessing the major functions.

2 Error/Warning Error and Warning messages related to the data request for the
Messages webpage are displayed below the Top Bar.

3 Display Area Interactive content, which depends on the key function of the page
(Trend, Report or Mimic).

4 Time Bar Allows users to select the time(s) of the data to display; trends and
mimics only.

Table 11-2 below describes the differences in the tablet display.


Table 11-2 Tablet Web Page Differences

Difference Description

Button size Buttons are larger on the tablet display in order to make them easier to read
and select.

Pen settings Icons are replaced by a single action button that reveals a menu list of
actions when tapped.

Time bar 1. Buttons are increased in size


2. Period buttons are merged into a single tappable menu item whereby
periods can be selected

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 12-1

Chapter 12 Using the Exaquantum Web Website


This chapter gives general details regarding using the Exaquantum Website, and covers the
following: -
1. Opening the Exaquantum website
2. Exaquantum Web Homepage
3. Choosing a display language
4. Accessing Trends
5. Accessing Mimics
6. Accessing Reports
7. Accessing XY Plots
8. Logging out of Exaquantum Web
12.1 Opening the Exaquantum website
The Exaquantum website, (hereinafter referred to as just the ‘website’) can be opened via the
following URL, from a supported Web Browser:
http://<Exaquantum Web Server>:<Port Number>/<Virtual Directory Name>

OR for secure websites


https://<Exaquantum Web Server>:<Port Number>/<Virtual Directory Name>

Where:
<Exaquantum Web Server> denotes the name of the Exaquantum Web Server.
<Port Number> denotes the port number of the Exaquantum Web Server.
<Virtual Directory Name> denotes the Virtual Directory of Exaquantum Web.

Opening Exaquantum Web takes the user to the Exaquantum Web Homepage as described
in Section 12.2.
Depending on the User Authentication Security settings for your Web Browser, you may be
prompted for a valid Windows User Name and Password.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


12-2 Chapter 12 Using the Exaquantum Web Website

NOTE. Exaquantum Web has a maximum number of client connections set by the license
code purchased with your product. If the license limit is breached (i.e. there are too
many users trying to access Exaquantum Web) then the following error is displayed,
in which case you may not log on until other users have logged off: -

NOTE. Exaquantum Web uses Windows User Groups to control access to Exaquantum
Web. If you do not have access to Exaquantum Web then the following error
message is displayed: -

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 12-3

12.2 Website Homepage


Exaquantum Web Homepage is the default-landing page for Exaquantum Web. It provides
system information and links to product documentation as shown in Figure 12-1 below: -
Figure 12-1 Website Homepage

Tips: - The Username of the currently logged on user is shown on the right side of the
Top Bar.
- You can return to Exaquantum Web Homepage at any time by clicking on
ExaquantumDashboard in the Top Bar menu.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


12-4 Chapter 12 Using the Exaquantum Web Website

12.3 Choosing a display language


To change the display language of Exaquantum Web:
1. Click on your name at the top right corner of the screen.
2. Choose a language from the dropdown list (your chosen language will be
remembered the next time you log on): -
Figure 12-2 Choosing a display language

3. Choosing a language will also use the regional date and time formats setting of the
language, to display date and times.
12.4 Choosing a display mode
To change the display mode of Exaquantum Web:
1. Click on your name at the top right corner of the screen.
2. Choose a display mode from the dropdown list (your chosen display mode will be
remembered the next time you log on to the device): -
Figure 12-3 Choosing a display mode

12.5 Accessing Trends


From the Homepage, trends can be accessed in one of three ways: -
1. Click on Trends in the Top Bar then select Trends List from the dropdown.

2. Click on the Trends button embedded in the page.


3. Open a Trend Favorite from the Top Bar.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 12-5

Further details regarding Trends, such as adding new Trends and choosing Trend Favorites
can be found in Chapter 13.
12.6 Accessing Mimics
From the Homepage, mimics can be accessed in one of three ways: -
1. Click on Mimics in the Top Bar then select Mimics List from the dropdown.

2. Click on the Mimics button embedded in the page.


3. Open a Mimic Favorite from the Top Bar.
Further details regarding Mimics, such as adding new Mimics and choosing Mimic Favorites
can be found in Chapter 14.
12.7 Accessing Reports
From the Homepage, reports can be accessed in one of three ways: -
1. Click on Reports in the Top Bar then select Reports List from the dropdown.

2. Click on the Reports button embedded in the page.


3. Open a Mimic Favorite from the Top Bar.
Further details regarding Reports, such as adding new Reports and choosing Report
Favorites can be found in Chapter 15.
12.8 Accessing XY Plots
From the Homepage, XY plots can be accessed in one of three ways: -
1. Click on XY Plots in the Top Bar then select XY Plots List from the dropdown.

2. Click on the XY Plots button embedded in the page.


3. Open a XY Plot Favorite from the Top Bar.
Further details regarding XY Plots, such as adding new XY Plots and choosing XY Plots
Favorites can be found in Chapter 16.
12.9 Display of Time and Dates
Exaquantum Web will use the time zone and regional settings configured on the Web Server.
It is recommended that all Web Client PCs use the same time zone and regional settings as
the Web Server. If the deployment does not have Web Clients having this set-up, then the
effect is that all timestamps displayed on mimics and trends will reflect the settings on the
Web Server not the client. This also applies to the time selectors when it would be necessary
to convert to the Web Server local time in order to request data for the time required.
Reports will not be affected in this way; these may be using a different mechanism for
accessing data for example those using the Exaquantum/Explorer Excel Add-in.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


12-6 Chapter 12 Using the Exaquantum Web Website

12.10 Logging out of Exaquantum Web


To log out of Exaquantum Web, do the following: -
1. Click on your name on the right side of the top bar.
2. Click on Logout in the dropdown list: -
Figure 12-4 Logging out of Exaquantum Web

3. The following message is displayed to indicate that you have been logged out.
Figure 12-5 Logged Out Message

Tip: You can quickly log back into Exaquantum Web by clicking on the Login button on
the Logged Out Message screen (above), which will take you back to Exaquantum
Web Homepage (section 12.2).
12.11 Tablet Device Differences
This section contains details about general details that differ between using them on a
desktop PC and using them on a tablet device.
General Controls
The overall look and feel may appear slightly different. Changes include:
 Buttons have been increased in size to make them easier to press
 Some font sizes have been increased to improve legibility
Tooltips
Because tablet devices do not offer a hover function as the mouse does on a desktop PC,
tooltips are available with a short tap on the web page. An exception to this would be when
applying a short tap on a web page button, which would action the button, rather than display
the tooltip.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-1

Chapter 13 Working with Exaquantum Web Trends


This section describes the actions which can be carried out on Trend webpages on
Exaquantum Web.
The Web User Interface provides extensive trending functions. These allow the user to
visualize tag data using one or more trend charts and associated data legend. A trend
webpage can contain one or more individual trends (charts), each with a number of pens.
The Trend Webpage can display Alarm and Event data in conjunction with trend data.
The Trend Webpage can also display Annotation data in conjunction with the trend data.
13.1 Trend Web Page Features
A typical Trend web page contains the following features as described below -
Figure 13-1 Trend Web Page Features

4 5 14 6 8
3 2
11 15 7

10 12

13

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-2 Chapter 13 Working with Exaquantum Web Trends

Table 13-1 Trend Web Page Features

Ref Feature Description


1 Trend Webpage Title Trend webpage title – defined by the user when saving the trend.
2 Trend Chart Time series chart of tag data. Tool tips are shown for detail
point values (see ‘Additional Features of Trends’ below).
3 Trend Chart Y-axes Y-axes are displayed for each pen. The user can control the
display of these (see ‘Showing and Hiding Trend Features’
in section 13.20).
4 Chart Icon Hides or Displays the chart (see ‘Showing and Hiding Trend
Features’ in section 13.20).

5 Legend Hides or Displays the legend (see ‘Showing and Hiding


Trend Features’ in section 13.20).

6 Export to CSV Exports the tag data, as shown on the trend, to a .CSV file
(see ‘Exporting Trend Data to a CSV File’ in section 13.20).

7 Add Trend to webpage The user can add a new or saved trend(s) to the current trend
webpage (see section 13.12).

8 Save Trend webpage The user can save the configuration of the current trend
webpage for subsequent reuse (see section 13.14).

9 Legend The Legend shows detail information about the tags


assigned to each pen, plus allows some control over the
display for each pen. See ‘Understanding the Desktop PC
Trend Legend’ in section 13.20 for detail.
10 Add Pens Adds new pens to the current trend – see section 13.6.

11 A&E Icons Displays / Hides the Alarm and Event Grid – see ‘Alarm
and Event Features’ in section 13.2 below.

12 Time Range Shows the start and end time for the trend. The values
displayed reflect any zoom function (for details of zooming
see ‘Understanding the Tablet Device Trend Legend’ in
section 13.20).
13 Time Bar Allows the user to select the time range for the Trend and
associated Alarm and Event data - see section 13.9.
14 Show Annotations Displays annotations associated with the time period and
tags attached to the Trend

15 Show data as XY Plot Displays the data on the Trend as an XY Plot (Scatter Chart)

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-3

Additional Features of Trends


In addition to the features listed above, trends have the following additional features: -
1. Hovering the mouse (Desktop PC) or short tap (Tablet) over a point of interest
displays a tooltip, which contains information about pen values at that time.
Figure 13-2 Trend Tooltip

2. A specific pen can be highlighted by hovering the mouse over the pen.
Figure 13-3 Pen Highlight

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-4 Chapter 13 Working with Exaquantum Web Trends

3. Clicking on the trend places a vertical cursor (represented by a dashed line) on the
trend and updates the Value, Low Range and High Range columns in the Trend
Legend with the pen values at the cursor time.
Figure 13-4 Trend Cursor

13.2 Alarm and Event Features


Alarm and Event information can be displayed on Trend Webpages that are displaying a
single trend by clicking on the Alarm and Event icon (Ref 1 below). This will add the
Alarms and Events grid to the Trend webpage – see Figure 13-5. The display of Alarm and
Event data has a number of additional features; these are detailed in Table 13-2.
Figure 13-5 Alarm and Event Features

1 3
2
5

4
6

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-5

The table below corresponds to the features indicated in the Figure 13-5.
Table 13-2 Alarm and Event Features

Ref Control Description


1 Alarm and Events Hide / Show the Alarm and Events grid.
Button Display markers for Alarms and Events, that directly
correspond to the data point for the specific pen. This means
that the OPC tagname and itemname from a Process Alarm
and Event have to match the OPC tagname and item name to
which the Exaquantum tag is connected.
2 Related Alarms Only enabled when the Alarm and Event grid is shown; the
Button icon must have been first selected.
Display markers for Alarms and Events, that correspond to the
data point for the specific pen, by the OPC tagname. This
means that the OPC tagname from a Process Alarm and Event
should match the OPC tagname to which the Exaquantum tag
is connected. This means the match will include all items
attached to the OPC tagname (that has a related OPC Item).
3 Operation Alarms
Only enabled when the Alarm and Event grid is shown; the
Button
icon must first have been selected.
Display markers for Alarms and Events, that correspond to the
data point for the specific pen, by the OPC tagname. This
means that the OPC tagname from an Alarm and Event should
match the OPC tagname to which the Exaquantum tag is
connected. The Alarm and Event must belong to one of the 3
categories:
 Process Alarm
 Operations Record
 Mode Status Change
4 Alarms and Events Grid showing Alarms and Events from all event categories,
Grid between the same start and end time as the trend - ordered by
date and time descending.
5 Alarm and Event Shows that one or more Alarms / Events correspond with the
Marker data point for the specific pen. In addition, the tooltips for
these markers will also show related Alarm and Event details.
6 Alarm and Event Indicates, on the Alarm and Event Grid, rows that have OPC
Grid highlight tags (tag name + item name) that match tags on the Trend
chart. The OPC tags on the Alarm and Event grid are
highlighted in the same color as the pen assigned to the
matching tag.
7 Add pen to Trend Allows matching Exaquantum tags to be added to the Trend
chart. Detailed in ‘Using the Tag Selector’ in section 13.6.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-6 Chapter 13 Working with Exaquantum Web Trends

NOTE – in the Alarms and Events Grid, the following Event data are displayed:
 Timestamp
 OPC Server
 Source
 Message
 Event Category
 Severity
 Condition
 CENTUM message ID (Hex notation)
 Station name
 Tag name
 Item Name
13.3 Annotation Features
Annotation information can be displayed on Trend webpages that are displaying a single
trend by clicking on the Annotations icon (Ref 1 below). This will add the Annotations grid
to the Trend webpage – see Figure 13-6. The display of Annotation data has a number of
additional features; these are detailed in Table 13-3.
Figure 13-6 Annotation Features

1
2

4
6 7
5

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-7

The table below corresponds to the features indicated in Figure 13-6.


Table 13-3 Annotation Features

Ref Control Description


1 Annotations Hide / Show the Annotations grid.
Display markers for Annotations that directly correspond to the
data point for the displayed pens (tags) and system timestamps.
2 Tag Annotation Shows that one or more Annotations correspond with the data
Marker point for the specific pen. In addition, the tooltips for these
markers will also show related Annotation details.
Clicking on a marker with Direct Link configured will display
the Link configured to the annotation.
With no Direct Link configured, clicking on the marker has no
affect.
3 System Annotation Shows that one or more system Annotations correspond with
Marker the timestamp. In addition, the tooltips for these markers will
also show related Annotation details.
Clicking on a marker with Direct Link configured will display
the Link configured to the annotation.
With no Direct Link configured, clicking on the marker has no
affect.
4 Annotations Grid The Annotations grid shows detailed information about the
visible Annotations, plus allows some control over each
Annotation.
Clicking on the Link will display the Link configured to the
annotation.
5 Add Annotation Add new Annotation to the current time range – see section
Button 13.11.

6 Edit Annotation Edit the corresponding Annotation – see section 13.11.


Icon
7 Delete Annotation Delete the corresponding Annotation – see section 13.11.
Icon
NOTE. In the Annotations grid, the following Annotation data is displayed:
 Time of Annotation
 Type (Tag or System)
 Annotation Detail
 Tag
 User (who entered or last modified the Annotation information)
 Link
NOTE. Annotations added, edited or deleted using Exaquantum explorer will not be
immediately visible on a Web trend, by the user refreshing the web page. It may take up to 5
minutes, or until a parameter of the Web trend is changed.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-8 Chapter 13 Working with Exaquantum Web Trends

Additional Features of Annotations


In addition to the features listed above, Annotations have the following additional features: -
1. Hovering the mouse (Desktop PC) or tapping (Tablet) over a single Annotation
displays a tooltip, which contains information about the Annotation at that time.
Figure 13-7 Annotation Tooltip

2. Hovering the mouse (Desktop PC) or tapping (Tablet) over a group Annotation
displays a tooltip, which contains information about the Annotations around that time.
Figure 13-8 Annotation Tooltip

3. A specific Annotation can be highlighted in the Annotation grid by clicking the


mouse (Desktop PC) or tapping (Tablet) on the Annotation marker.
4. A configured direct link can be navigated to by clicking the mouse (Desktop PC) or
tapping (Tablet) on the Annotation marker.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-9

13.4 Displaying an existing Trend Webpage


To display an existing Trend Webpage, you can open the Trends List Page, which can be
accessed in one of the following ways: -

 Click on the Trends button in the Top Bar then select Trends List from the
dropdown.
Tip: If the Top Bar is not visible then click on the Menu button in the top
right hand corner of the screen to access the Top Bar Menu.

 If you are on the Homepage (see 12.2) click on the Trends button
embedded in the page.
A Trend webpage can then be opened as described in ‘Opening a Trend webpage from the
Trends List Page’ below.
 Open a Trend Favorite directly by clicking on Trends in the Top Bar then select a
Trend Favorite from the dropdown. Trend Favorites are covered in section 13.17.
Opening a Trend webpage from the Trends List Page
The Trends List page is as shown in Figure 13-9: If there are no trends in the list then you
will have to create a new Trend Webpage as described in section 13.5.
Figure 13-9 Trends List Webpage

To open a Trend webpage from the Trends List page: -


1. Filter the list as described in ‘Filtering the Trends List’ below.
2. Click on the Name of the trend in the list. The selected Trend Webpage opens: For
further details about the Trend Webpage see section Trend Web Page Features - 13.1.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-10 Chapter 13 Working with Exaquantum Web Trends

Filtering the Trends List


To locate a particular Trend webpage in the Trends List, perform one or more of the
following steps: -
1. Click on the Page Size Control beneath the Trends List in order to select the
appropriate number of items per page in the Trends List.
Figure 13-10 Trends List Page Size Control

2. If there are more items than can be displayed in a single page then the Page
Navigation Control can be used to navigate through the pages.
Figure 13-11 Trends List Page Navigation Control

3. Click on the Favorites button to toggle the display of Trend Favorites in the
Trend List on/off. (Described in section 13.17).
4. Click on the Shared button to toggle the display of Shared Trends in the
Trend List on/off. (The concept of Sharing a Trend is described in section 13.18).
5. Type a search string, including supported wildcards into the Search field. Supported
wildcards are:
* OR %- any number of characters are matched
? OR _ – any single character is matched
^ - aligns the search to string start
$ - aligns the search to string end
NOTE. In the search string area, if the * OR % wildcards have not been entered in
the string, when executing the search, wildcard * is automatically appended to the
beginning and end of the search string.
6. Click the Search button or press the Enter key on the keyboard to begin a
search on the: -
 Trend Webpage name
 Trend Webpage description
Tip: When the list is being filtered, the following information alert is displayed above
the Trend List. To quickly remove all filters from the Trend List click on the
Remove Filters Button.
Figure 13-12 Trends List Filter Active Alert

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-11

13.5 Creating a new Trend Webpage


If you are on the Trends List Page (see section 13.4) you can create a trend page from
scratch by simply clicking on the New Trend button located on the Trends List
Page.
Alternatively, perform the following steps to create a new trend page: -

1. Click on the Trends button in the Top Menu bar.


2. Click on New Trend in the dropdown list: -
Figure 13-13 Trends Dropdown

3. The Tag Selector Webpage is displayed in order to add a pen to the trend as
described in section 13.6 below.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-12 Chapter 13 Working with Exaquantum Web Trends

13.6 Adding a pen to a trend


Up to 8 pens can be added to a trend using one or both of the following methods: -
1. By using the Tag Selector Webpage
2. By adding pens from the Alarm and Event Grid.
Using the Tag Selector Webpage
The Tag Selector Webpage (Figure 13-14) provides the user with the ability to search for
required tags depending on one of two modes: -
 Tag mode - This web page provides the following means of locating tags:
o Entry of full tag path
o Search on tag name and / or description
o Search on function block name and /or description
o Search on folder name
 Event mode - Search OPC tag name, and / or alarm and event message
The Tag Selector Webpage is always displayed when a new Trend is created.
Alternatively, to display the Tag Selector Webpage from an existing trend webpage: -

1. Click on the Add Pens button from the Trend Legend.


Tip: If the Trend Legend is not visible then click on the Display Legend button
above the trend.
The following diagram and associated table describes the features of the Tag Selector
Webpage: -
Figure 13-14 Tag Selector Webpage

1 2
5 6

3 4

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-13

Table 13-4 Tag Selector Webpage Features

Ref Control Description


1 Tag Search tab Allows location of tags from the Namespace based on the
search string
2 Event Search tab Allows location of tags from the Alarm/Events based on the
search string
3 Search field For entering a search string.
4 Search Start icon Commences either Tag Search or Alarm/Event search
5 Add to Trend After a user has selected tags, clicking on Add to Trend
returns to the previous trend screen and uses the selected tags
to populate the trend with data. NOTE that this button is
disabled until at least one tag has been selected.
6 Cancel Returns to the previous trend screen without changing the
tags for the trend.
7 Tag Path check box If this box is checked, then the user can enter a full path into
the Search string field.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-14 Chapter 13 Working with Exaquantum Web Trends

Tag Search mode


In order to add a pen to a trend by using the Tag Selector Webpage to search through tag
Namespace data, the following steps should be performed: -

1. Click on the Add Pens button from the Trend Legend.


Tip: If the Trend Legend is not visible then click on the Display Legend button
above the trend.
2. A search comprises of between 1 and 4 keywords. Keywords should be separated by
the space character. Enter these in the Search field.
3. Each keyword can contain wildcards. Supported wildcards are:
* OR %- any number of characters are matched
? OR _ – any single character is matched
^ - aligns the search to the keyword start
$ - aligns the search to the keyword end
NOTE. For each keyword, if the * OR % wildcards have not been entered in the
string, when executing the search, wildcard * is automatically appended to the
beginning and end of the keyword.
4. Click the Search button or press the Enter key on the keyboard to search in: -
 Tag Name
 Tag Description
 Function Block Name
 Function Block Description
 Folder Name
5. Results are returned that match all keywords. Results are displayed alphabetically by
OPC Function Block and Tag Name as shown below, with the search string
highlighted where it appears in the tag path or description; a maximum of 1000
results can be displayed.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-15

Figure 13-15 Tag Search Results

6. If there are more items than can be displayed in a single page then the Page
Navigation Control can be used to navigate through the pages.
Figure 13-16 Page Navigation Control

7. To change the number of results shown on the page, use the Page Size Control to
select the appropriate number of items per page
Figure 13-17 Page Size Control

8. Once the appropriate Tag has been located, click on the Value button
alongside the OPC tag name to quickly add the raw tag value to the Tag Selection
List (see Figure 13-19).

9. Alternatively click on the Value Dropdown to select from a list of aggregations


to add to the trend: -
Figure 13-18 Value Dropdown Aggregations List

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-16 Chapter 13 Working with Exaquantum Web Trends

10. Newly selected tags are displayed alongside tags already plotted on the trend, where
existing tags can be distinguished from newly selected tags by their light grey color: -
Figure 13-19 Tag Selection List

11. To remove tags from the Tag Selection List (above) click on the Close icon
alongside the tag name.
12. If required, switch to Event Search mode to find more tags to add to the Tag
Selection List by clicking on the Event Search tab.
13. When you have finished selecting Tags, click on the Add to Trend Button
to return to the trend webpage and display the newly selected tags.

14. Alternatively click on the Cancel button to return to the trend webpage and
discard the newly selected tags.
Full Tag Path Search mode
The Full Tag Path Search Mode is similar to the Tag Search Mode described above with the
following differences: -
1. Check the Use Full Tag Path check box if a full tag path is to be matched. When the
check box is checked, the Search button will change to the Add button .
2. The Full Tag Path required should be entered into the Search field.
NOTE. Wildcards are not applicable to Full Tag Path searches.
3. Click the Add button button or press the Enter key on the keyboard to search
for the Full Tag Path.
4. If an exact match is found, the tag is automatically added to the Tag Selection List as
shown in Figure 13-21 below. If no match is found, the message as shown in Figure
13-20 below is displayed.
Figure 13-20 Full Tag Path Not Found

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-17

5. Newly selected tags are displayed alongside tags already plotted on the trend, where
existing tags can be distinguished from newly selected tags by their light grey color: -
Figure 13-21 Tag Selection List

6. To remove tags from the Tag Selection List (above) click on the Close icon
alongside the tag name.
7. If required, switch to Event Search mode to find more tags to add to the Tag
Selection List by clicking on the Event Search tab.
8. When you have finished selecting Tags, click on the Add to Trend button
to return to the trend webpage and display the newly selected tags.

9. Alternatively click on the Cancel button to return to the trend webpage and
discard the newly selected tags.
Event Search mode
The Event Search Mode is similar to the Tag Search Mode described above with the
following differences: -
1. To enter Event Search mode Click on the Event Search tab.
2. Limit the range of the search by entering values into the Start Date/Time and End
Date/Time fields: Only alarms that occurred between these 2 times will be
considered.
Figure 13-22 Alarm Selection Criteria

3. Click on one of the Date/Time fields or the Edit icon to open the Time Settings
dialog.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-18 Chapter 13 Working with Exaquantum Web Trends

Figure 13-23 Time Settings Dialog

4. Times can be specified by clicking one of the available quick time buttons.
5. Times can also be specified in Absolute or Relative terms:
 Specify Absolute dates by clicking on the Absolute Tab and either type into
the Date/Time fields or click on the Calendar button and select a date
from the Calendar Control. Absolute Times can be entered.
 Clicking on the Set to now button, on the Absolute Tab, will set the end time
to the current time.
Figure 13-24 Specifying Absolute Times

 Specify Relative Times by clicking on the Relative Tab:


Figure 13-25 Specifying Relative Times

6. Click OK to apply the times selected in the Time Settings Dialog.


7. A search comprises of between 1 and 4 keywords. Keywords should be separated by
the space character. Each keyword can contain supported wildcards, as described in
the Tag Search. Enter these in the Search field.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-19

8. Each keyword can contain wildcards. Supported wildcards are:


* OR %- any number of characters are matched
? OR _ – any single character is matched
^ - aligns the search to the keyword start
$ - aligns the search to the keyword end
NOTE. For each keyword, if the * OR % wildcards have not been entered in the string,
when executing the search, wildcard * is automatically appended to the
beginning and end of the keyword
9. Click the Search button or press the Enter key on the keyboard to search in: -
 OPC Tagname
 Alarm and Event Message
10. Results are returned that match all keywords. These (results) are displayed
chronologically (newest first) by Event time as shown below, with the search string
highlighted where it appears in the OPC Tagname or Itemname or Alarm and Event
message; a maximum of 1000 results can be displayed.
Figure 13-26 Event Search Results

NOTE - in the Event Search mode, only Alarms and Events with OPC tags that are
connected to Exaquantum Tags are searched.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-20 Chapter 13 Working with Exaquantum Web Trends

Adding a pen from the Alarm and Event Grid


Before a pen can be added to the trend from the Alarm and Event Grid, Alarm and Event
Data should be displayed on the Trend Webpage as described in section 13.10 – ‘Showing
Alarm & Event Data on a Trend’.
If the Alarm and Event Grid is displayed on the Trend Webpage, perform the following steps
to add a pen to the trend: -
1. Locate an alarm in the Alarm and Event Grid that has the Add Pen to Trend
button in the final column.

2. Click on the Add Pen to Trend button : The Add Pen to Trend Popup List is
displayed. This contains a list of Exaquantum tags linked to the OPC Tagname, and if
present, Itemname, in the Alarm and Event grid.
Figure 13-27 Add Pen to Trend Popup List

3. Click on an entry in the Add Pen to Trend Popup List to add it to the Trend.
4. The Tag Name is highlighted in the Alarm and Event Grid to show that is
displayed on the Trend.
Figure 13-28 Tag Name Highlight

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-21

13.7 Removing a pen from a trend


A pen can be removed from the trend in the following way: -
1. Locate the pen to be removed in the Trend Legend: If the Trend Legend is not
visible, click on the Display Legend button above the trend.
Figure 13-29 Trend Legend

2. This differs between desktop PC and tablet devices.

For desktop PC, click on the Remove Pen icon alongside the Name of the pen to
be removed.
Figure 13-30 Remove Pen Icon

For tablet devices, select the Remove Pen option by opening the Legend Action
menu as shown in Figure 13-31.

Figure 13-31 Tablet Device Trend Legend Action Menu

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-22 Chapter 13 Working with Exaquantum Web Trends

13.8 Modifying a pen on a trend


A pen that is displayed on a trend can be modified in the following way: -
1. Locate the pen to be modified in the Trend Legend (see Figure 13-29 above): If the
Trend Legend is not visible, click on the Display Legend button above the
trend.
2. This differs between desktop PC and tablet devices.

For desktop PC, click on the Edit Pen icon alongside the Name of the pen to be
modified.
Figure 13-32 Edit Pen Icon

For tablet devices, select the Edit Pen option by opening the Legend Action menu
as shown in Figure 13-33.

Figure 13-33 Tablet Device Trend Legend Action Menu

3. In the Edit Pen Dialog click on the Color swatch to change the color of the pen.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-23

Figure 13-34 Edit Pen Dialog

4. Specify the Y-Axis Label by typing into the text box.


5. By default, the Y-Axis Range scales automatically if a tag has no defined
engineering range, otherwise the default is a manual plot range. Other options
include:
a. Uncheck the Automatically scale the y-axis check box and select the
Engineering range (low to high) option. This will automatically set the low
and high range values to the current engineering range held for the Tag by
Exaquantum.
b. Uncheck the Automatically scale the y-axis checkbox, select the Manual
plot range option and input override values for the low and high range in the
left and right text boxes respectively.
6. To plot the pen in an analog form on the trend chart, as opposed to discrete form,
uncheck the Discrete Data checkbox. The pen is plotted as shown in Figure 13-35
below.
7. Click OK.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-24 Chapter 13 Working with Exaquantum Web Trends

Figure 13-35 Analog Trend Plot

13.9 Setting a Time Range for a Trend Webpage


A Trend webpage can be displayed in two modes - depending on the mode selected in the
Time Bar:-
Table 13-5 Trend Webpage Time Modes

Time Mode Description


Live Displays the latest data in the Trend. The end time is set to the current
time, and the start time changes to maintain the time period of the Trend.
The trend updates automatically (by default this is once a minute).
Historical Displays a range of historical data between a start and end time, as
specified by the user.
NOTE. When Alarm and Event Data is shown on the Trend (see section 13.10), changing
the time range of the trend using the Time Bar will also cause the time range of the
alarms and events to reload, and display data consistent with the new time range.
Setting Live Mode for a Trend

Live mode can be entered by clicking on the Live button in the Time Bar.
Figure 13-36 Desktop PC Trend Webpage Time Bar

Figure 13-37 Tablet Device Trend Webpage Time Bar

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-25

Setting a Historical Time Range for a Trend Webpage


To set a historical time range for the trend Webpage:
Either:
Use the quick select buttons to specify an Offset from the current Start Time: -
1. This differs between desktop PC and tablet devices.

For desktop PC, on the Time Bar, click on either 1h, 8h, 1d or 1w to set the End
Time to the specified number of hours, days or weeks relative to the Start Time.

For tablet device, on the Time Bar, tap the Start Time Clock icon and then
select either 1 Hour, 8 Hours, 1 Day or 1 Week to set the End Time to the
specified number of hours, days or weeks relative to the Start Time.

Or:
Use the quick select buttons to specify an Offset from the current End Time: -
1. This differs between desktop PC and tablet devices.

For desktop PC, on the Time Bar, click on either 1h, 8h, 1d or 1w to set the Start
Time to the specified number of hours, days or weeks relative to the End Time.

For tablet device, on the Time Bar, tap the End Time Clock icon and then
select either 1 Hour, 8 Hours, 1 Day or 1 Week to set the Start Time to the
specified number of hours, days or weeks relative to the End Time.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-26 Chapter 13 Working with Exaquantum Web Trends

Or:
Use the quick select buttons to move the Start Time and End Time, by half the
duration between the start and end times: -

1. On the Time Bar, click on either the Half Back or Half Forward buttons to
move the start and end times backwards or forwards by half a duration.
Or:
Use the quick select buttons to move the Start Time and End Time, by the full
duration between the start and end times: -

1. On the Time Bar, click on either the Back or Forward buttons to move the
start and end times backwards or forwards by a full duration.
Or:
Use the Now button to set the End Time to the current date and time: -

1. On the Time Bar, click on the Now button to move the End Time to the
current date and time. The Start time remains unchanged.
Or:
Specify a time in the past by using the Time Settings Dialog, as follows: -

1. On the Time Bar, click on either the Start Time, End Time or the Edit icon to
open the Time Settings dialog.

Figure 13-38 Trend Time Settings Dialog

2. Times can be specified by clicking one of the available quick time buttons.
3. Times can also be specified in Absolute or Relative terms:
 Specify Absolute dates by clicking on the Absolute Tab and either type into
the Date/Time fields or click on the Calendar button and select a date
from the Calendar Control. Absolute Times can be entered.
 Clicking on the Set to now button, on the Absolute Tab, will set the end time
to the current time.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-27

Figure 13-39 Specifying Absolute Times for a Trend

 Specify Relative Times by clicking on the Relative Tab.


Figure 13-40 Specifying Relative Times for a Trend

4. Click OK to apply the times selected in the Time Settings Dialog.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-28 Chapter 13 Working with Exaquantum Web Trends

13.10 Showing Alarm & Event Data on a Trend Webpage


A feature of Trend Webpages is the ability to link with Alarm and Event Data.
To display Alarm and Event Data on a Trend Webpage, do the following: -

1. Click on the Alarm & Event button .


NOTE. Alarm and Event data can only be displayed on a Trend Webpage that
contains a single trend.
NOTE. Displaying Alarm and Event data will reset the zoom of the Trend (see
Legend in section 13.20).
- Displaying Alarm and Event data will cancel live update mode (see section
13.9 - Setting a Time Range for a Trend Webpage).
- Alarm and Event data is displayed in the Alarm and Event Grid below the
trend as described in section 13.2 and in the form of Alarm and Event
Markers on the Trend (see Figure 13-5).
- When a row on the Alarm & Event grid is clicked, the Trend Cursor will be
move to the selected Alarm & Event Message time. (See Trend Cursor on
Additional Features of Trends.)
2. If there are more items than can be displayed in a single page of the Alarm and
Event Grid, then the Page Navigation Control can be used to navigate through the
pages.
Figure 13-41 Page Navigation Control

3. To change the number of results shown on the page, use the Page Size Control to
select the appropriate number of items per page.
Figure 13-42 Page Size Control

4. Any error or warning conditions will be displayed above the trend.


NOTE. If the request returns no alarm data, the following message will be displayed
Figure 13-43 No Alarms Found Message

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-29

13.11 Showing Annotations on a Trend Webpage


A feature of Trend Webpages is the ability to display Annotations.
To display Annotations on a Trend Webpage, do the following: -

1. Click on the Annotations button .


NOTES.
Annotations can only be displayed on a Trend Webpage that contains a single trend.
Displaying Annotations will reset the zoom of the Trend (see Understanding the Tablet
Device Trend Legend in section 13.20).
Displaying Annotations will cancel live update mode (see section 13.9 - Setting a Time
Range for a Trend Webpage).
Annotations are displayed in the Annotations Grid below the trend and in the form of
Annotation Markers on the trend.
When an Annotation Marker is clicked, the corresponding Annotation is highlighted
in the Annotation Grid.
If Annotations are displayed at the same time as Alarm & Events, the Alarm &
Events Grid will be displayed below the Annotations Grid.
2. If there are more items than can be displayed in a single page of the Annotation
Grid, then the Page Navigation Control can be used to navigate through the pages.

Figure 13-44 Page Navigation Control

3. To change the number of results shown on the page, use the Page Size Control to
select the appropriate number of items per page.

Figure 13-45 Page Size Control

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-30 Chapter 13 Working with Exaquantum Web Trends

Adding an annotation to a trend


An Annotation can be added to a trend in the following way: -
1. Optionally, click on the trend to select a time at which to add the Annotation.
2. Click on the Add Annotation button in the Annotation Grid. If the Annotation
Grid is not visible, click on the Annotations button above the trend.

Figure 13-46 Annotations Grid

3. In the Add Annotation Dialog select a Date/Time for the Annotation.

Figure 13-47 Add Annotation Dialog

4. Specify the Type by selecting from the list of either Tag or System.
5. If the Type of Tag is selected, also choose a Tag for the Annotation.
6. Type an Annotation into the box provided.
7. If you want the Annotation to link to another webpage or a file stored in a network
location, type the URL or file location (UNC only) into the Link textbox.
8. If you would like the link to open automatically when the Annotation marker is
clicked, select the Direct Link checkbox.
9. Click Save.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-31

Deleting an annotation from a trend


An Annotation can be deleted from the trend in the following way: -
1. Locate the Annotation to be removed in the Annotation Grid (see Figure 13-46
above). If the Annotation Grid is not visible, click on the Annotations button
above the trend.
2. This differs between desktop PC and tablet devices.

For desktop PC, click on the Delete Annotation icon alongside the Annotation to
be deleted.
For tablet devices, select the Delete Annotation option by opening the Annotation
Action menu as shown in Figure 13-48.

Figure 13-48 Tablet Device Annotation Action Menu

3. A Delete Annotation confirmation dialog is displayed. Click the Confirm delete


button.
Figure 13-49 Delete Annotation Confirmation Dialog

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-32 Chapter 13 Working with Exaquantum Web Trends

Modifying an annotation on a trend


An Annotation that is displayed on a trend can be modified in the following way: -
1. Locate the Annotation to be modified in the Annotation Grid (see Figure 13-46
above): If the Annotation Grid is not visible, click on the Annotations button
above the trend.
2. This differs between desktop PC and tablet devices.

For desktop PC, click on the Edit Annotation icon alongside the Annotation to
be modified.
For tablet devices, select the Edit Annotation option by opening the Annotation
Action menu as shown in Figure 13-50.

Figure 13-50 Tablet Device Annotation Action Menu

3. In the Edit Annotation Dialog select a Date/Time for the Annotation.


Figure 13-51 Edit Annotation Dialog

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-33

4. Specify the Type by selecting from the list of either Tag or System.
5. If the Type of Tag is selected, also choose a Tag for the Annotation.
6. Type an Annotation into the box provided.
7. If you want the Annotation to link to another webpage or a file stored in a network
location, type the URL or file location into the Link textbox.
8. If you would like the link to open automatically when the Annotation marker is
clicked, select the Direct Link checkbox.
9. Click Save.
13.12 Adding a Trend to a Trend Webpage
A Trend Webpage can contain one or more individual trends (charts), up to a maximum of
four trends per trend webpage.
Multiple trends can be added to a Trend Webpage in the following way: -

1. Click on the Add Trend button , then from the dropdown either: -
a. Click New Trend, and follow the instructions for Using the Tag Selector in
section 13.6.
Or:
b. Click Saved Trend and follow the instructions below.
2. If adding a Saved Trend to the Trend Webpage, the Trend Select Page is shown.
Figure 13-52 Trend Select Page

3. Locate the Trend(s) to be added by ‘Filtering the Trends List’ as described in section
13.4.
4. Click the Name of the trend to add it to the Trend Webpage or click on the Cancel
button to return without adding a trend.
NOTES.
The number of trend charts on the Saved Trend is displayed in the right hand Trends
column.
Saved trends which have too many trends to add to the Trend Webpage will be shown
greyed out; i.e. you cannot add multiple trends from a Saved Trend that would result
in the maximum number of trends on the Trend Webpage to be exceeded.
When multiple trends are added from a Saved Trend, the trends are added to the
Trend Webpage in the same order in which they appear on the Saved Trend.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-34 Chapter 13 Working with Exaquantum Web Trends

5. On the Trend Webpage, click on the 1 Column button to display the trends
vertically stacked on top of each other.
OR:

6. Click the 2 Columns button to display the trends in 2 columns as shown


below
Figure 13-53 Multiple Trend Page in 2 Columns

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-35

13.13 Removing a Trend from a Trend Webpage


To remove a trend from a Trend Webpage that contains multiple trends, do the following:-

1. Click on the Remove button in the Trend chart header.


Figure 13-54 Remove Trend

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-36 Chapter 13 Working with Exaquantum Web Trends

13.14 Saving a Trend Webpage


When modifications are made to a Trend Webpage, the Save Button becomes enabled to
indicate that the Trend can be saved.
NOTES.
Trends can only be saved by the user that owns the trend
When alarms and events are being concurrently displayed, only the trend definition is
saved; no knowledge of the alarms and events displayed is saved. Therefore, on
display of a saved trend, the AE Grid is by default not displayed.
To save a Trend Webpage: -
1. Click on the Save button .
2. In the Save Trend Dialog, specify a unique Name and a meaningful Description for
the trend.
Figure 13-55 Save Trend Dialog

3. Check the Favorite checkbox if you want to add the Trend to your Favorites List.
4. If you are a member of the groups listed in Table 13-6, you can share the trend by
checking Share with other users.
5. Check Save with time to saves the current time range of the trend. This will override
the time selector when the trend webpage is next viewed.
6. Click OK.
Table 13-6 Shared Trends – User groups

Security Model Group names


Legacy QAdministratorGroup OR QExplorerDesignGroup
Standard QTM_MAINTENANCE OR QTM_EXPLORER_DESIGN

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-37

13.15 Copying a Trend Webpage


Trend Pages can be copied in two ways:
 Copying of a trend owned by the current user
 Copying a Shared Trend owned by another user
To Copy a Trend, use the SaveAs button:
1. Click on the Save button dropdown and select the SaveAs option (Figure 13-56).
Figure 13-56 SaveAs option

2. In the SaveAs Trend Dialog, specify a unique Name and a meaningful Description
for the trend.
Figure 13-57 Save Trend Dialog

3. Check the Favorite checkbox if you want to add the Trend to your Favorites List.
4. If you are a member of the groups listed in Table 13-6, you can share the trend by
checking Share with other users.
5. Check Save with time to saves the current time range of the trend. This will override
the time selector when the trend webpage is next viewed.
6. Click OK.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-38 Chapter 13 Working with Exaquantum Web Trends

13.16 Deleting a Trend Webpage


NOTE. Shared trends can only be deleted by users who are members of
 QAdministratorGroup / QExplorerDesignGroup (Legacy mode security)
 QTM_MAINTENANCE / QTM_EXPLORER_DESIGN (Standard mode Security).
If you are not a member of either of these Windows Groups then you will only be
able to delete private trends that you have created.
Trend webpages can be deleted from Exaquantum Web in the following way: -

1. Click on the Trends button in the Top Menu bar.


2. Open the Trends List Webpage by clicking on Trends List in the dropdown list: -
Figure 13-58 Trends Dropdown

3. In the Trends List Webpage, locate the Trend(s) to be deleted by ‘Filtering the
Trends List’ as described in section 13.4.
Figure 13-59 Trends List Webpage

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-39

4. In the Trends List Webpage, put a check alongside the Name of each trend you
wish to delete. There will be no checkbox for trends that you are not allowed to
delete.
Figure 13-60 Selecting Trends for Deletion

5. Click the Delete Trends button .


13.17 Updating your Trend Favorites List
Trends can be added to your Favorites List so that they can be accessed quickly from the
Trends Dropdown (see Figure 13-61, below).
To add/remove Trends in your Favorites list, follow the steps below: -

1. Open the Trends List Webpage, by clicking on the Trends button in the
Top Menu bar.
2. Click on Trends List in the dropdown list: -
Figure 13-61 Trends Dropdown

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-40 Chapter 13 Working with Exaquantum Web Trends

3. In the Trends List Webpage, check or uncheck the Favorite checkbox to add /
remove the trend from your favorites.
Figure 13-62 Trends List Webpage

4. When you have finished, click on the Show Favorites button .


5. The Trends List displays your selected favorites, which now appear under Favorites
in the Trends Dropdown (Figure 13-64).
6. Click the Remove Filters button to display the full list of trends.
Figure 13-63 Remove Filters

13.18 Sharing a Trend


Trends can only be shared by users who are members of User Groups, as listed in Table 13-6.
If you are not a member of either of these Windows Groups then you will not be able to
share trends that you create and the resultant trend will be private.
To share a trend so that it is accessible to all users:

1. Open the Trends List Webpage, by clicking on the Trends button in the
Top Menu bar.
2. Click on Trends List in the dropdown list: -
Figure 13-64 Trends Dropdown

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-41

3. In the Trends List Webpage, check the Shared checkbox: The Trend will now be
accessible to all users.
Figure 13-65 Trends List Webpage

Similarly, to remove a Trend from the Public List and make it private, uncheck the Shared
checkbox on the Trends List Webpage.
13.19 Printing a Trend
Printing of Trends uses the standard web browser printing functionality.
Either:
 Select the print option from the browser’s menu
Or:
 Use the Ctrl+P keyboard shortcut.

The following formatting is applied to the printed page:


1. Top Bar is not printed.
2. Time Bar is not printed.
NOTE. It is not possible to print a Trend from a tablet device.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-42 Chapter 13 Working with Exaquantum Web Trends

13.20 Advanced Features of Trends


Understanding the Desktop PC Trend Legend
The desktop PC trend legend contains the following features: -
Figure 13-66 Trend Legend Features

The features referenced above are described in the following table: -


Table 13-7 Trend Legend Features

Label Feature Description


1 Name The Function block name, if present and the Tag name. Hovering
over the name displays a tooltip, showing the full path for the
tag.
2 Pen icons Modify trend pen (see section 13.8)
Remove pen from trend (see section 13.7)
Hide/Show pen Y-Axis (see ‘Showing and Hiding Trend
Features’ below)
3 Description Tag description, at the selected (clicked) time in the Trend Chart
(see Additional Features of Trends in section 13.1).
4 Value Value of the tag, at the selected (clicked) time in the Trend Chart
(see Additional Features of Trends in section 13.1).
5 Units Units of tag, at the selected (clicked) time in the Trend Chart (see
Additional Features of Trends in section 13.1).
6 Quality Data quality in color and text form
7 Low Range Engineering Range of the tag, at the selected (clicked) time in the
Trend Chart (see Additional Features of Trends in section 13.1).
8 High Range
9 Cursor time The date and time represented by the last click of the cursor line
and date on the associated Trend Chart (see Additional Features of Trends
in section 13.1).

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-43

Understanding the Tablet Device Trend Legend


The tablet device trend legend contains the same features as that of the desktop, except for:
 Item 2, the Pen icons are displayed after clicking the Legend Actions Menu button

 Item 5, the Units column of data is not displayed


 Item 7, the Low Range column header is shortened to ‘Low’
 Item 8, the High Range column header is shortened to ‘High’
Table 13-8 Tablet Device Trend Legend Features

Using Zoom on Trends


To zoom in on a trend chart: -
1. This differs between desktop PC and tablet devices.

For desktop PC, click and drag on the Trend Chart to highlight a section of the trend.

For tablet device, use the ‘pinch to zoom’ gesture.


Figure 13-67 Trend Zoom

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-44 Chapter 13 Working with Exaquantum Web Trends

2. Release the mouse button and a zoomed version of the trend is displayed. Note the
presence of the Reset Zoom button circled in the figure below.
Figure 13-68 Zoomed Trend

NOTES.
Zooming results in a fresh data request for the period of the zoom; i.e. zoom is a data zoom
rather than a graphical zoom and may result in better data resolution in the zoomed chart.
Zoom is a temporary state and does not affect the settings in the Time Bar, nor is it retained
when the page is saved.
You cannot zoom on a Trend Webpage that is in Live Mode, unless the trend is locked (see
‘Working with Locked Trends in Multiple Trend Mode’ below).
If the time range in the Time Bar is changed, the zoom state of any unlocked trends is reset.
You cannot zoom on a Trend Webpage that is displaying Alarm and Event data.
The time range of the zoomed area is displayed in the Time Label, immediately below the
Trend Chart.
Annotations display is switched off
To cancel a zoom on a trend chart you must reset the zoom: -
1. Click the Reset Zoom button , circled in Figure 13-68 above.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-45

Showing and Hiding Trend Features


The following controls allow you to show/hide features of Trend webpages in order to
maximize screen real estate thus allowing you to concentrate on the data that matters to you.
Table 13-9 Trend Feature Visibility Controls

Control Description
Toggles visibility of Trend Charts on/off. All trends are affected on a multiple
trend webpage.
The setting is not saved: By default, trends are visible.
Toggles visibility of the Trend Legend on/off. The legends for all Trend Charts
are affected on a multiple trend webpage.
The setting is not saved: By default, trend legends are visible.
Shows/Hides Alarm and Event data on the Trend Webpage in the form of Alarm
and Event markers on the Trend and an Alarm and Event Grid. For further
details see section 13.10 - ‘Showing Alarm & Event Data on a Trend’.
The setting is not saved: By default Alarm and Event Data is not shown.
Displays annotations associated with the time period and tags attached to the
Trend. For further details see section 13.11. The setting is not saved: By default,
Annotations are not displayed.
Displays the data on the Trend as an XY Plot (Scatter Chart).

Hide/Show pen Y-Axis: Removes the Y-Axis name and values for the pen,
which expands the trend display area. Only operates if more than one pen is
displayed on the trend.
Y-axes are shown by default on a new trend but the state is saved when the
Trend Webpage is saved. Therefore, the default visibility of the Y-axes will be
dependent on the saved settings.
For tablet devices, the ‘Hide Y-Axis’ option is accessible by opening the
Legend Action menu as shown in Figure 13-69.
Figure 13-69 Tablet Device Trend Legend Action Menu

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-46 Chapter 13 Working with Exaquantum Web Trends

Edit of Trend Name in Multiple Trend Mode


When multiple trends are displayed on a Trend Webpage, individual Trends can have their
name edited to allow for easier identification of data.
To edit the name of a Trend which is on a Multiple Trend Webpage:-
1. Click on the Edit Name button as illustrated in Figure 13-70 below.
Figure 13-70 Edit Name Button

2. Edit the name in the Edit Name dialog as shown in Figure 13-71 below.
Figure 13-71 Edit Name Dialog

3. Click on the OK button to make the change and close the dialog.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-47

Locating Alarms in the Alarm and Event Grid by clicking on Alarm and Event
Markers on the Trend
Alarm and Event Markers are displayed on the trend where trend data coincides with Alarm
and Event data.
 They are represented by solid circles as illustrated in Figure 13-72 below.
 The Alarm and Event Marker may represent one or more alarms that are associated
with the trend data point.
To locate the earliest Alarm and Event represented by the Alarm and Event Marker in the
Alarm and Event Grid:
1. Locate the Alarm and Event of interest by hovering the mouse (Desktop PC) or
tapping (Tablet) over an Alarm and Event Marker: A tooltip is displayed giving
details of the Alarm and Event(s) associated with the marker.
Figure 13-72 Alarm and Event Marker Tooltip

2. Click on the chosen Alarm and Event Marker. The Alarm and Event Grid pages
to the chosen Alarm / Event and highlights the appropriate row(s) as illustrated below.
Figure 13-73 Highlighted Alarm / Event

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-48 Chapter 13 Working with Exaquantum Web Trends

Locating Annotations in the Annotation Grid by clicking on Annotation Markers on


the Trend
Annotation Markers are displayed on the trend.
 They are represented by solid triangle as illustrated in Figure 13-74 below.
 The Annotation Marker may represent one or more annotations.
To locate the earliest Annotation represented by the Annotation Marker in the Annotation
Grid:
1. Locate the Annotation of interest by hovering the mouse (Desktop PC) or tapping
(Tablet) over an Annotation Marker: A tooltip is displayed giving details of the
Annotation(s) associated with the marker.
Figure 13-74 Annotation Marker Tooltip

2. Click on the chosen Annotation Marker. The Annotation Grid pages to the chosen
Annotation and highlights the appropriate row(s) as illustrated below.
Figure 13-75 Highlighted Annotation

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-49

Changing the Trend Legend and Chart Cursor by clicking on Alarm and Event row
in the Grid
By clicking on a row in the Alarm and Event grid [1], users can change the position on the
Trend Chart Cursor [2] to have a position that aligns to the timestamp of the Alarm and
Event that was clicked on. Any part of a row in the Alarm and Event grid can be clicked on,
except for the Add Trend button [3]. The cursor update is also reflected in the Trend Legend
[4].
Figure 13-76 Alarm and Event row click

1 3

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-50 Chapter 13 Working with Exaquantum Web Trends

Changing the Trend Legend and Chart Cursor by clicking on Annotation row in the
Grid
By clicking on a row in the Annotation grid [1], users can change the position on the Trend
Chart Cursor [2] to have a position that aligns to the timestamp of the Annotation that was
clicked on. Any part of a row in the Annotation grid can be clicked on, expect for the Link
column [3]. The cursor update is also reflected in the Trend Legend [4].
Figure 13-77 Annotation row click

Working with Locked Trends in Multiple Trend Mode


When multiple trends are displayed on a Trend Webpage, trends can be locked to allow for
easier comparison and analysis of data.
To lock the time of a trend which is on a Multiple Trend Webpage:-
1. Use the Time Bar to select the time for the Trend to be locked, as described in
section 13.9 – ‘Setting a Time Range for a Trend Webpage’.

2. Click on the Lock Time button on the Trend to be locked.


3. Use the Time Bar to select the time for any other trends: The locked trend is not
affected by changes to the time bar.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-51

Displaying as an XY Plot
When a single Trend is displayed with more than one pen, the user has the option of
displaying the information as an XY Plot Display web page - persisting the tags and time
duration from the Trend.
Table 13-10 Display as XY Plot Configuration

Configuration Item Description


Tags All tags will be plotted on the XY Plot Display, in the same order as
they appear on the XY Plot legend. By default, the first tag on the
trend will be the Reference tag on the resultant XY plot.
Duration The duration will be the same as the Trend, regardless of whether
the Trend is saved with time or not. This will always be a static
historical time range.
Axis The first tag will be plotted on the X-Axis; all other tags will be
plotted with respect to this tag. All other tags will be plotted against
alternating left and right sided Y-Axis.
NOTE. The Axes will show default colors and default titles (Tag
name), no modified axis configuration will be transposed to the XY
Plot Display web page.
Data Interval The Data Interval will be set to the default value of 1 minute
Maximum Number The Maximum number of points will be set to the default value of
of Points 200
To display the current configuration in an XY Plot Display web page:

1. Click on the Display as XY Plot button on the XY Plot Webpage.


2. Alternatively, on desktop PC, the new XY Plot can be displayed in a new tab by right
clicking the Display as XY Plot button and selecting ‘Open in new tab’.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-52 Chapter 13 Working with Exaquantum Web Trends

Exporting Trend Data to a CSV File


You can export the data from the current trend(s) to allow you to carry out data analysis in
an external program.
To Export data in a trend to a CSV file, do the following: -

1. Click on the Export to CSV button on the Trend Webpage.


2. Save the file do your chosen location (this varies according to browser version).
3. Open the file from your chosen location with an appropriate program like Microsoft
Office Excel. The CSV file contains the following data for each tag: Timestamp,
Value and Raw Quality as shown below:-
Figure 13-78 CSV Opened in Excel

NOTE.
The timestamp format in the CSV file depends on the web server configuration. On the client
when the file is opened in Excel, the default date time formatting will not always display the
seconds value although the value is present in the cell. To display the seconds value, format
the column cells to include seconds. e.g.: dd/mm/yyyy hh:mm:ss

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-53

13.21 Displaying Trend Data Directly from the URL


Users running applications that use Exaquantum data can directly run Exaquantum Trend
pages from their custom application.
There are two ways of displaying a trend as described in Table 13-11:
Table 13-11 Display Trend Data from URL

URL Type Description


Adhoc Creates an ad hoc trend by passing tag names in the URL.
In this case it is possible to display a single trend chart containing up to
eight pens over a specified time range.
Load Loads an existing trend by passing a trend name in the URL.
In this case it is possible to display a saved single or multiple trend chart
with either the time range as saved with the trend or as specified in the
URL.
Displaying an Ad hoc Trend
An ad hoc trend may be displayed using the URL “ExaquantumWeb/Trend/Adhoc” with one
or more arguments to describe the pens to display and the time range in the for m:
http://<servername>:<port>/ExaquantumWeb/Trend/Adhoc?tag=<tagname1>&tag=<tagnam
e2>...&tag=<tagname8>&isLive=<0/1>&startTime=<Date/Time>&endTime=<Date/Time>
The parameters available for creating an ad hoc trend are described in Table 13-12 below.
Examples
In the following examples, the initial part of the URL has been omitted for clarity. All
examples should be prefixed with the following:
http://<servername>:<port>/ExaquantumWeb

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-54 Chapter 13 Working with Exaquantum Web Trends

Example 1:
This example displays an adhoc trend:
 Containing two tags called Root.ReferenceTag and Root.ComparisonTag
 Sets the Time range to be the last hour
 Sets the trend mode to historical
/Trend/AdHoc?Tag=Root.ReferenceTag&Tag=Root.ComparisonTag&startTime=NOW-
60&EndTime=NOW&isLive=0
Example 2:
This example displays an adhoc trend:
 Containing two tags called Root.ReferenceTag and Root.ComparisonTag
 Sets the Time range to be the last 5 minutes
 Sets the trend mode to live

/Trend/AdHoc?Tag=Root.ReferenceTag&Tag=Root.ComparisonTag&StartTime=NOW-
5&isLive=1
Example 3:
This example displays an adhoc trend:
 Containing two tags called Root.ReferenceTag and Root.ComparisonTag
 Sets the start time to 2016-12-21 16:32:33
 Sets the end time to 2016-12-21 20:32:33
 Sets the trend mode to historical

/Trend/AdHoc?Tag=Root.ReferenceTag&Tag=Root.ComparisonTag&StartTime=2016-12-
21-16-32-33&endTime=2016-12-21-20-32-33&isLive=0

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-55

Displaying a Saved Trend


A saved trend may be displayed using the URL “ExaquantumWeb/Trend/Load” with one or
more arguments to describe the trend chart to display and the time range in the form:
http://<servername>:<port>/ExaquantumWeb/Trend/Load?name=<trendName>&isLive=<0/
1>&startTime=<Date/Time>&endTime=<Date/Time>
Or
http://<servername>:<port>/ExaquantumWeb/Trend/Load?id=<trendID>&isLive=<0/1>&st
artTime=<Date/Time>&endTime=<Date/Time>

The parameters available for loading a saved trend are described in Table 13-12 below.

Examples
In the following examples, the initial part of the URL has been omitted for clarity. All
examples should be prefixed with the following:
http://<servername>:<port>/ExaquantumWeb
Example 1:
This example:
 Loads an existing trend called “TrendOne”
 Sets the start time 60 minutes before the current time
 Sets the end time to the current time
 Sets the trend mode to historical
/Trend/Load?name=TrendOne&StartTime=NOW-60&EndTime=NOW

Example 2:
This example:
 Loads an existing trend called “TrendTwo”
 Sets the start time to 5 minutes before the current time
 Sets the end time to the current time
 Sets the trend mode to live
/Trend/Load?name=TrendTwo&IsLive=1&StartTime=NOW-5

Example 3:
This example:
 Loads an existing trend called “TrendThree”
 Sets the start time to 2016-12-21 16:32:33
 Sets the end time to 2016-12-21 20:32:33
/Trend/Load?name=TrendThree&StartTime=2016-12-21-16-32-33&EndTime=2016-12-21-
20-32-33

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-56 Chapter 13 Working with Exaquantum Web Trends

URL Parameters for Displaying an Ad hoc or Saved Trend


This section describes the parameters that may be specified on the URL in order to display
an ad hoc trend or a saved trend.
Table 13-12 Trend URL Parameters
Parameter Description Validation
Tag Specify tags plotted on the trend. At least one tag must be
specified and no more than 8.
(adhoc only) Tag names may be either: If more than 8 tags are
• Intrinsic specified, only the first 8 tags
e.g. Tag=Root.Folder.TagName1 are plotted
or Tag=Root.Folder.TagName1. Tag names should be URL
Aggregations.Hour.Mean encoded (see URL Encoding
for Saved Trend, XY Plot and
• RBNS Tag Names for details).
e.g. Tag=RBNS.Server1.Folder.TagName1
or Tag=RBNS.Server1.Folder.TagName1.
Aggregations.Hour.Mean
isLive isLive is a boolean value, when set to Must be
true the trend is displayed in Live mode. 0(false) or 1(true)
When false the trend is displayed in In Live mode, the end time is
Historical mode. set to the current time.
If not set, the default is false.
startTime StartTime can be configured in the The time must match the format
following ways: specified (see NOTE 2 below).
If the supplied starttime is:
Absolute Time in the future after the endtime
Relative Time or not specified
The possible formats are: then the starttime is set to one
Absolute Time: yyyy-MM-dd-HH-mm-ss hour before the endtime.
eg. starttime=2016-12-21-16-32-33
Relative Time: NOW-<minutes>
eg. starttime=NOW-60
endTime EndTime can be configured in the same The time must match the format
way as startTime except that for specified (see NOTE 2 below).
Relative Time “NOW” can be used. If the supplied endtime is:
in the future not specified
then the current time is used
Id This is the unique id of the saved trend. ID should be a number.
(load only, see If set this setting will override the Name ID should be a valid existing
saved trend ID.
NOTE 1 setting
below)
Name This is the name of the saved trend. Name should be a valid existing
saved trend name.
(load only, see Names should be URL encoded
NOTE 1 (see URL Encoding for Saved
below) Trend, XY Plot and Tag Names
for details).
NOTE 1:When the load parameter is used, one of the commands Id or Name must be specified.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 13-57

NOTE 2:The format for Absolute time parameters should match the format specified in the
web.config file for the “JsonRequestDateTimeFormat” setting. By default, this
value is “yyyy-MM-dd-HH-mm-ss”.
URL Encoding for Saved Trend, XY Plot and Tag Names
This section describes cases where names used in a URL may need to be encoded.
A Trend or XY Plot Name within ExaquantumWeb may contain any non-alphanumeric
character apart from:
 •“<” (Less than)
 •”>” (Greater than)
 •”&” (Ampersand)
 •“#” (Hash)
A Tag Name within Exaquantum can contain any non-alphanumeric character apart from:
 “.” (full stop)
 “,” (comma)
 “:” (colon).
Therefore, any name specified within the URL needs to be URL encoded in the following cases:
Table 13-13 URL Encoding Cases

Classification Included Characters Encoding Required

Safe characters Alphanumerics [0-9a-zA-Z], special No


characters $ - _ . + ! * ' ( ) , , and
reserved characters used for their
reserved purposes (e.g., question
mark used to denote a query string)

ASCII control Includes the ISO-8859-1 (ISO-Latin) Yes


characters character ranges 00-1F hex (0-31
decimal) and 7F (127 decimal.)

Non-ASCII characters Includes the entire “top half” of the Yes


ISO-Latin set 80-FF hex (128-255
decimal.)

Reserved characters ;/?:@=& Yes (if used as part of a


name and not used for
their defined, reserved
purposes)

Unsafe characters Includes the blank/empty space and " Yes


<>#%{}|\^~[]`

In order to encode a character in a URL, append its 2-character ASCII hexadecimal value to
the % character. For example, the URL encoding of a space character is %20 and the %
character itself is encoded as %25.
For further details, refer to the Internet Engineering Task Force (IETF) URI standards

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


13-58 Chapter 13 Working with Exaquantum Web Trends

RFC3986: Uniform Resource Identifier (URI): Generic Syntax


RFC1738: Uniform Resource Locators (URL).
StartTime/EndTime Processing When Loading Trend Saved With Time
Note that saved trends may already have times specified, either
1. Because the trend was saved with time or
2. The trend has multiple trends and one or more are locked with a start and end time.
If a trend with either of these cases is loaded, then the start and / or end times are calculated
according to the following rules.
1. If both start and end times are specified on the URL then these are used instead of
any saved times, including for locked trends in a multi-trend page.
2. If IsLive is set to true on the URL, then the end time is set to NOW and the time
range maintained regardless of any saved times, including for locked trends in a
multi-trend page.
3. If the trend was saved with time, then the saved times are used
4. If either the start or the end time is specified on the URL, then the supplied time is
used and the default is used as follows:
 If starttime is specified, then end time is NOW
 If endtime is specified, then start time is end time – 1 hour
5. If neither the start time nor the end time is specified on the URL, then the default
start time is NOW-60 and the default end time is NOW.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 14-1

Chapter 14 Working with Exaquantum Web Mimics


This section describes the actions that can be carried out on Mimic pages on Exaquantum
Web.
The Web User Interface provides support for displaying graphics created using any of the
following techniques that are described in section 14.4: -
 Creating a new Mimic using the Exaquantum Graphics Editor
 Importing a Mimic from CENTUM (CS3000 or VP)
 Importing a Mimic from the Exaquantum Legacy website
Mimics allow the visualization of tag data within a pictorial representation of an area of plant.
This can include:
1. Dynamic display of tag data (alpha-numeric)
2. Dynamic graphics, where the graphic is driven from a tag value (for example a bar
gauge).

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


14-2 Chapter 14 Working with Exaquantum Web Mimics

14.1 Mimic Webpage Features


A typical Mimic page can be seen below -
Figure 14-1 Mimic Webpage Features

1 2 3

4 5

6 7

Table 14-1 Mimic Webpage Features

Label Feature Description


1 Tag Discovery Toggles Tag Discovery mode (see section 14.7)
2 Tag List Displays the list of selected Tags (see section 14.7)
3 Display Trend Displays a Trend from the list of selected Tags (see section 14.7)
4 Static graphics A pictorial representation of the plant.
5 Dynamic The dynamic areas on the mimic can show data depending on
graphics which Time mode is chosen in the Time Bar: -
 Spot data mode – displays non-updating snapshot of
historical data.
 Live data mode – displays latest data values and updates
automatically.
6 Zoom control The zoom control can be used to zoom in/out on certain areas of
the mimic.
7 Time Bar The Time Bar can be used to select one of two modes: -
 Spot data mode – defined by the end time value on the Time Bar.
 Live data mode - automatic update of current data. The
default update rate is 1 minute.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 14-3

14.2 Displaying an existing Mimic Webpage


To display an existing Mimic Webpage, you can open the Mimics List Page that can be
accessed in one of the following ways: -

 Click on the Mimics button in the Top Bar then select Mimics List from the
dropdown.
Tip: If the Top Bar is not visible then click on the Menu button in the top
right hand corner of the screen to access the Top Bar Menu.

 If you are on the Homepage (see 12.2) click on the Mimics button
embedded in the page.

A Mimic can then be displayed as described in ‘Displaying a Mimic from the Mimics List
Page’ below.

 Click on Mimics in the Top Bar then select a Mimic Favorite from the Mimics
dropdown: Mimic Favorites are covered in section 13.17.
NOTE. On versions of Internet Explorer older than Version 9, the mimic will open in a new
window/tab (window or tab depending on the browser settings).
NOTE. On versions of Internet Explorer 9 and later, it is possible to display a Mimic:
 In the same Internet Explorer window / tab
 In a new Internet Explorer window / tab

To control this behavior, please see Section 17.2.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


14-4 Chapter 14 Working with Exaquantum Web Mimics

Displaying a Mimic from the Mimics List Page


The Mimics List page is as shown below: If there are no Mimics in the list then you will
have to create a new Mimic Webpage as described in section 14.3.
Figure 14-2 Mimics List Webpage

To display a Mimic from the Mimics List page: -


1. Filter the list as described in ‘Filtering the Mimics List’ below.
2. Click on the Name of the Mimic in the list.
3. If the following warning is displayed click OK to install the Adobe SVG Viewer.
Figure 14-3 Install Adobe SVG Viewer

4. The selected Mimic Webpage is displayed.


5. Set the time range for the mimic as described in section 14.5.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 14-5

Filtering the Mimics List


To locate a particular mimic in the Mimics List, perform one or more of the following steps:
-
1. Click on the Page Size Control beneath the Mimics List in order to select the
appropriate number of items per page in the Mimics List.
Figure 14-4 Mimics List Page Size Control

2. If there are more items than can be displayed in a single page then the Page
Navigation Control can be used to navigate through the pages.
Figure 14-5 Mimics List Page Navigation Control

3. Click on the Favorites button to toggle the display of Mimic Favorites in the
Mimic List on/off. (See Updating your Mimic Favorites List is described in section
14.8).
4. Type a search string, including supported wildcards into the Search field. Supported
wildcards are:
* OR %- any number of characters are matched
? OR _ – any single character is matched
^ - aligns the search to string start
$ - aligns the search to string end

NOTE. In the search string area, if the * OR % wildcards have not been entered in the
string, when executing the search, wildcard * is automatically appended to the
beginning and end of the search string.
5. Click the Search button or press the Enter key on the keyboard to begin a
search on the: -
 Mimic Webpage name
 Mimic Webpage description
Tip: When the list is being filtered, the following information alert is displayed above
the Mimic List. To quickly remove all filters from the Mimic List click on the
Remove Filters Button.
Figure 14-6 Mimics List Filter Active Alert

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


14-6 Chapter 14 Working with Exaquantum Web Mimics

14.3 Creating a new Mimic Webpage


Mimic Webpages are based on .svg files which the user can upload to Exaquantum Web
database. As such, there are two to steps to creating a new Mimic Webpage: -
1. Create an SVG file (see section 14.4)
2. Add the SVG file, as a Mimic, to Exaquantum Web
NOTE. Mimics can only be added by users who are members of the User groups defined in
Table 14-2.

The creation/uploading of Mimics is not supported on iOS tablet devices.


Table 14-2 Managing Mimics – User groups

Security Model Group names


Legacy QAdministratorGroup OR QExplorerDesignGroup
Standard QTM_MAINTENANCE OR QTM_EXPLORER_DESIGN

Item 2 in the list above can be accomplished in one of two ways: -


If you are on the Mimics List Page (see section 13.4) you can create a Mimic page from
scratch by simply clicking on the New Mimic button embedded in the Mimics List
Page.
Alternatively, perform the following steps to create a new Mimic page: -
1. Click on the Mimics option in the Top Menu bar.
2. Click on New Mimic in the dropdown list: -
Figure 14-7 Mimics Dropdown

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 14-7

3. In the New Mimic Webpage, specify a unique Name and a meaningful Description
for the mimic.
Figure 14-8 New Mimic Webpage

4. Click the Browse button and browse for the required .svg file
5. If you want the mimic to appear in your list of favorites (see section 14.6) check the
Favorite checkbox.
6. Click OK.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


14-8 Chapter 14 Working with Exaquantum Web Mimics

14.4 Creating the Graphic for a Mimic Webpage


Exaquantum Web provides support for displaying Mimics – or process graphics in the form
of .svg files. The .svg files can be created by using any of the following techniques: -
Creating a new Mimic using the Exaquantum Graphics Editor
For this technique, the user creates the SVG file using the Exaquantum Graphics Editor. The
procedure is defined in section 5.2.
Importing a Mimic from CENTUM (CS3000 or VP)
This technique also uses the Exaquantum Graphics Editor; however, the procedure uses the
import function of this tool. A summary of the procedure is:
1. Provide an SVG file from CENTUM
2. Import the file into the Graphics Editor
3. Change the tag assignments
4. Save as an SVG file from the Graphics Editor
The detail is described in section 5.4.
Importing Mimics using the Bulk Graphics Conversion Tool
Please note that information regarding the Bulk Graphics Conversion Tool can be found in
the ‘TN GMSCS0124-01E Exaquantum Bulk Graphics Conversion Tool’. This is available
to download from the YMX Support website.
Importing a Mimic from the Exaquantum Legacy website.
For this technique, the SVG file is in the correct format to use in the Web User Interface and
can be copied from the location described in ‘Setting Up a Folder to Store Web Page Files’
in section 4.4.
NOTE. For SVG files imported from the Exaquantum Legacy/Web that contain hyperlinks
to other webpages – this function is not supported in the Mimic Display. The ability to link
to other Mimic pages is described in Section 5.2.
Adding a Mimic Image
It is possible to embed images within Mimics. Such a technique can be used for including
Customer logos in Mimics. When a Mimic is saved from the Graphics Editor, the Mimic
Image is exported to the same location as the SVG file. This Mimic Image (or Images) must
be loaded into the website, independently to the loading of the Mimic SVG file.
To load a Mimic Image(s), use the command line application Exaquantum.Webservice.Cli.

Exaquantum.Webservice.Cli /file:<filename>

Where
 /file is the parameter name for the file to import, and
 <filename> is the full path and filename to the Mimic Image file

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 14-9

NOTES.
1. The ExaquantumWebserviceCli application can only be executed by users who are
members of the User groups defined in Table 14-2.
2. The ExaquantumWebserviceCli application is located in the folder <Exaquantum
install folder>\ExaquantumWebserviceCli
3. Only files of type .jpg can be loaded
4. Only one file can be loaded at a time
5. Maximum filename length including period and three-character extension is 64
characters.
6. Loading a mimic image file (by filename) on more than one occasion simply
overwrites the existing entry in the website.
7. If <filename> contains one or more space characters, it should be enclosed using
double quotation marks (“<filename>”)
8. The maximum length of the file name, including path and .jpg extension is 64
characters
9. Files containing the following characters are not processed : % & * + < > #
10. Only one file can be uploaded at a time
11. If an existing file (in the website) is uploaded again, then the existing one is
overwritten.
Figure 14-9 Command line – Importing a Mimic Image

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


14-10 Chapter 14 Working with Exaquantum Web Mimics

14.5 Setting a Spot Time for a Mimic


A mimic can display two types of spot data depending on the mode selected in the Time
Bar:-
Table 14-3 Mimic Time Modes

Time Mode Description

Live Displays the latest data in the Mimic. The data updates automatically
(by default this is once a minute).
Historical Displays a snapshot of historical data at a time specified by the user.

Setting Live Mode for a Mimic

Live mode can be entered by clicking on the Live button in the Time Bar.
Figure 14-10 Desktop PC Mimic Time Bar

Figure 14-11 Tablet Device Mimic Time Bar

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 14-11

Setting Historical Mode for a Mimic


To set a historical spot time for the mimic:
Either:
Specify the current time, thus: -

1. On the Time Bar, click on the Now button to set the spot time to the current
date and time – the values in the mimic will not update automatically.
Or:
Specify a time in the past, as follows: -

1. On the Time Bar, click on the Date/Time field or the Edit icon to open the Time
Settings dialog.
Figure 14-12 Mimic Time Settings Dialog

2. Times can be specified in Absolute or Relative terms:


 Specify Absolute dates by clicking on the Absolute Tab and either type into
the Date/Time fields or click on the Calendar button and select a date
from the Calendar Control. Absolute Times can be entered.
 Clicking on the Set to now button, on the Absolute Tab, will set the spot
time to the current time.
 Specify Relative Times by clicking on the Relative Tab.
Figure 14-13 Specifying Relative Times

3. Click OK to apply the times selected in the Time Settings Dialog.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


14-12 Chapter 14 Working with Exaquantum Web Mimics

14.6 Zooming and Panning a Mimic


Pan and Zoom functions are provided for the graphics area within a Mimic webpage. This
allows the user to focus and see more detail on a specific section of the graphic.
Zooming a Mimic
To zoom in/out of the mimic, either:
1. Click on the zoom control handle and drag it to the right to zoom in and to the left to
zoom out.
Figure 14-14 Zoom Control

Or:
1. Click on the zoom control percentage label and select a zoom level from the list of
presets in the menu.
Figure 14-15 Zoom Control Preset Menu

Panning a Mimic
For desktop PC, to pan the mimic, click and hold down the left mouse button whilst dragging
the mouse. The mimic will pan within the defined area of the webpage.

For tablet devices, tap and hold whilst dragging the finger to pan the mimic.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 14-13

14.7 Displaying a Trend from a Mimic


It is possible to display a Trend using the Tag(s) displayed on a Mimic. This is achieved by
entering Tag Discovery mode and adding the required Tag(s) to the Tag List.
To display a Trend from a Mimic:

1. Click on the Tag Discovery button

2. Click on the appropriate Tag Marker


3. Click on the Add Tag icon for the required Tag

4. Once Tags have been added, click the Display Trend button
NOTE. This functionality is not available in Internet Explorer 8.
Tag Discovery Mode

Tag Discovery mode can be entered by clicking on the Tag Discovery button in the
page header.
Whilst in Tag Discovery mode, any available Tag in the mimic graphic is highlighted by the
Tag Marker as shown in Figure 14-16.
Figure 14-16 Mimic in Tag Discovery Mode

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


14-14 Chapter 14 Working with Exaquantum Web Mimics

Tag List
The Tag List, as shown in Figure 14-17, can be viewed by clicking the Tag List button

Figure 14-17 Tag List

Tags can be added to the Tag List as follows:

1. Click on the appropriate Tag Marker


2. Click on the Add Tag icon for the required Tag from the menu as shown in
Figure 14-18.
Figure 14-18 Add Tag Menu

Tags can be removed from the Tag List as follows:

1. Open the Tag List by clicking the Tag List button


2. Click the Remove icon to remove the Tag from the list.
Displaying a Trend
Once Tags have been added to the Tag List, a Trend can be displayed by clicking the
Display Trend button

Alternatively, on desktop PC, the new Trend can be displayed in a new tab by right clicking
the Display Trend button and selecting ‘Open in new tab’.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 14-15

14.8 Updating your Mimic Favorites List


Mimics can be added to your Favorites List so that they can be accessed quickly from the
Mimics Dropdown (see Figure 14-19, below).
To add/remove Mimics in your Favorites list, follow the steps below: -

1. To open the Mimics List Webpage, click on the Mimics button in the Top
Menu bar.
2. Click on Mimics List in the dropdown list: -
Figure 14-19 Mimics Dropdown

3. In the Mimics List Webpage, check or uncheck the Favorite checkbox top add /
remove the mimic from your favorites.
Figure 14-20 Mimics List Webpage

4. When you have finished, click on the Show Favorites button .


5. The Mimics List displays your selected favorites that now appear under Favorites in
the Mimics Dropdown (Figure 14-19).
6. Click the Remove Filters button to display the full list of trends.
Figure 14-21 Remove Filters

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


14-16 Chapter 14 Working with Exaquantum Web Mimics

14.9 Modifying a Mimic


Mimics can be modified using Exaquantum Web. The following functions are available:
 Edit the Mimic Name and / or Description
 Change the favorite setting
 Upload an updated SVG file. In this case, modifications to the SVG file should be
made external to Exaquantum Web – see Section 14.4.

NOTE. Mimics can only be modified by users who are members of the User groups defined
in Table 14-2. When displaying the Mimic List, users who are members of these

groups will see the edit icon .

To modify a Mimic, the Mimic must first be selected for edit from the Mimic list. To do this,
display the Mimic list, locate the desired Mimic, and then click on the Edit icon.
Figure 14-22 Mimics List Webpage, showing the Edit icon

The mimic can be modified, using the Edit Mimic Page, Figure 14-23.
Figure 14-23 Edit Mimic Page

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 14-17

14.10 Deleting a Mimic


Mimics can only be removed by users who are members of the User groups listed in Table
14-2. If you are not a member of one of these groups you will not be able to remove a mimic
from Exaquantum Web.
Mimic webpages can be deleted from Exaquantum Web in the following way: -

1. Click on the Mimics button in the Top Menu bar.


2. Open the Mimics List Webpage by clicking on Mimics List in the Mimics
Dropdown (Figure 14-19).
3. In the Mimics List Webpage, locate the Mimic(s) to be deleted by ‘Filtering the
Mimics List’ as described in section 14.2.
Figure 14-24 Mimics List Webpage

4. In the Mimics List Webpage, put a check alongside the Name of each Mimic you
wish to delete.
Figure 14-25 Selecting Mimics for Deletion

5. Click the Delete Mimics button .

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


14-18 Chapter 14 Working with Exaquantum Web Mimics

14.11 Sharing a Mimic


All Mimics are automatically shared with all authorized users of Exaquantum Web when
added; i.e. all Mimics are public.
14.12 Printing a Mimic
Printing of Mimics uses the standard web browser printing functionality.
Either: -
 Select the print option from the browser’s menu
Or: -
 Use the Ctrl+P keyboard shortcut.

The following formatting is applied to the printed page:


1. Top Bar is not printed.
2. Time Bar is not printed.
3. Current time for the Mimic is printed (spot time or live time)

NOTE. It is not possible to print a Mimic from a tablet device.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 15-1

Chapter 15 Working with Exaquantum Web Reports


This section describes the actions that can be carried out on Report pages on Exaquantum
Web.
The Web User Interface provides support for allowing documents stored in a central
repository to be opened or downloaded to the User’s machine via Exaquantum Web.
The documents can be any of the following file types: -
 Microsoft Excel (xls and xlsx)
 PDF
 CSV
 TXT
 Microsoft Word (doc and docx)
 Image files (png, jpg/jpe/jpeg, bmp and gif)
15.1 Report Features
Unlike Mimics and Trends, a Report does not have a dedicated Webpage, nor do they
interact dynamically with the rest of Exaquantum Web.
The features of a report accessed from Exaquantum Web are defined by the content of the
report and the functionality of the application used to open it.
Some things to consider, for example: -
1. Files cannot be viewed unless there is a suitable viewer/editor installed on the User’s
machine; i.e. PDF files cannot be viewed if the user does not have a pdf viewer
installed.
2. Files which contain formulae created with the Exaquantum Excel Add-In will not
function unless the user has the Exaquantum Excel Add-In installed.
3. Files can only be printed if there is an application on the client machine that is
capable of printing them.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


15-2 Chapter 15 Working with Exaquantum Web Reports

15.2 Opening an existing Report


To open an existing Report in a new window, you can open the Reports List Page that can
be accessed in one of the following ways: -

 Click on the Reports button in the Top Bar then select Reports List from
the dropdown.
Tip: If the Top Bar is not visible then click on the Menu button in the top
right hand corner of the screen to access the Top Bar Menu.
 If you are on the Homepage (see 12.2 Website Homepage) click on the Reports
button embedded in the page.

A Report can then be opened as described in ‘Opening a Report from the Reports List Page’
below.
 Open a Report Favorite directly by clicking on Reports in the Top Bar then select a
Report Favorite from the dropdown. Report Favorites are covered in section 15.7.
Opening a Report from the Reports List Page
The Reports List page is as shown below: If there are no Reports in the list then you will
have to create a new Report as described in section 15.3.
Figure 15-1 Reports List Webpage

To open a Report from the Reports List page: -


1. Filter the list as described in ‘Filtering the Reports List’ below.
2. Click on the Name of the Report in the list.
3. Choose to Open or Save the report.
NOTE. If you choose to open the report or subsequently view the saved report and a
suitable viewer is not installed, you will be prompted to browse for a suitable
application.
The selected Report opens.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 15-3

Filtering the Reports List


To locate a particular Report in the Reports List, perform one or more of the following
steps: -
1. Click on the Page Size Control beneath the Reports List in order to select the
appropriate number of items per page in the Reports List.
Figure 15-2 Reports List Page Size Control

2. If there are more items than can be displayed in a single page then the Page
Navigation Control can be used to navigate through the pages.
Figure 15-3 Reports List Page Navigation Control

3. Click on the Favorites button to toggle the display of Report Favorites in the
Report List on/off. (See Updating your Report Favorites List is described in section
15.7).
4. Type a search string, including supported wildcards into the Search field. Supported
wildcards are:
* OR %- any number of characters are matched
? OR _ – any single character is matched
^ - aligns the search to string start
$ - aligns the search to string end

NOTE. In the search string area, if the * OR % wildcards have not been entered in the
string, when executing the search, wildcard * is automatically appended to the
beginning and end of the search string.

5. Click the Search button or press the Enter key on the keyboard to begin a
search on the: -
 Report name
 Report description
Tip: When the list is being filtered, the following information alert is displayed above
the Report List. To quickly remove all filters from the Report List click on the
Remove Filters Button.
Figure 15-4 Reports List Filter Active Alert

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


15-4 Chapter 15 Working with Exaquantum Web Reports

15.3 Adding a Report to Exaquantum Web


Report Webpages are based on files that the user can upload to Exaquantum Web database.
As such, there are two to steps to adding a new Report: -
1. Create the Report file (this is self-explanatory and will be done by using the relevant
application; Notepad, Excel, Word etc.).
2. Add the Report file to Exaquantum Web.

NOTES.
1. Reports can only be added by users who are members of the User groups defined in
Table 15-1.
2. The adding/uploading of Reports is not supported on iOS tablet devices.
Table 15-1 Managing Reports – User groups

Security Model Group names


Legacy QAdministratorGroup OR QExplorerDesignGroup
Standard QTM_MAINTENANCE OR QTM_EXPLORER_DESIGN

Item 2 in the list above can be accomplished in one of two ways: -


If you are on the Reports List Page (see section 13.4) you can create a Report page from
scratch by simply clicking on the New Report button embedded in the Reports
List Page.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 15-5

Alternatively, perform the following steps to create a new Report page: -


1. Click on the Reports menu in the Top bar.
2. Click on New Report in the dropdown list: -
Figure 15-5 Reports Dropdown

3. In the New Report Webpage, specify a unique Name and a meaningful Description
for the Report.
Figure 15-6 New Report Webpage

4. Click the Browse button and browse for the file that you want to add to Exaquantum
Web.
5. If you want the Report to appear in your list of favorites (see section 15.7) check the
Favorite checkbox.
6. Click OK.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


15-6 Chapter 15 Working with Exaquantum Web Reports

15.4 Modifying a Report


Reports can be modified using Exaquantum Web. The following functions are available:
 Edit the Report Name and / or Description
 Change the favorite setting
 Upload a report file. In this case, modifications to the report file should be made
external to Exaquantum Web.
NOTE Reports can only be modified by users who are members of the User groups defined
in Table 15-1.When displaying the Report List, users who are members of these

groups will see the edit icon .


NOTE A Report can be run; this file is downloaded onto a User’s local PC. If this file is
edited, the contents will be saved to the downloaded local file only. The Report on
the website will not be affected.

To modify a Report, the Report must first be selected for edit from the Report list. To do this,
display the Report list, locate the desired Report, and then click on the Edit icon.
Figure 15-7 Report List Webpage, showing the Edit icon

The Report can be modified, using the Edit Report Page,


Figure 15-8 Edit Report Page

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 15-7

15.5 Saving a Report


Saving a report stores a local copy of the report on the User’s machine. In other words
saving a report has no effect on the report stored in Exaquantum Web Database
15.6 Deleting a Report
NOTE. Reports can only be deleted by users who are members of the User groups defined
in Table 15-1.

Reports can be deleted from Exaquantum Web in the following way: -

1. Click on the Reports button in the Top bar.


2. Open the Reports List Webpage by clicking on Reports List in the dropdown list: -
Figure 15-9 Reports Dropdown

3. In the Reports List Webpage, locate the Report(s) to be deleted by ‘Filtering the
Trends List’ as described in section 13.4.
Figure 15-10 Reports List Webpage

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


15-8 Chapter 15 Working with Exaquantum Web Reports

4. In the Reports List Webpage, put a check alongside the Name of each Report you
wish to delete.
Figure 15-11 Selecting Reports for Deletion

5. Click the Delete Reports button .


15.7 Updating your Report Favorites List
Reports can be added to your Favorites List so that they can be accessed quickly from the
Reports Dropdown (see Figure 14-19, below).
To add/remove Reports in your Favorites list, follow the steps below: -

1. Open the Reports List Webpage, by clicking on the Reports button in


the Top Menu bar.
2. Click on Reports List in the dropdown list: -
Figure 15-12 Reports Dropdown

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 15-9

3. In the Reports List Webpage, check or uncheck the Favorite checkbox to add /
remove the report from your favorites.
Figure 15-13 Reports List Webpage

4. When you have finished, click on the Show Favorites button .


5. The Reports List displays your selected favorites that now appear under Favorites
in the Reports Dropdown (Figure 15-5).
6. Click the Remove Filters button to display the full list of reports.
Figure 15-14 Remove Filters

15.8 Sharing a Report


All Reports are automatically shared with all authorized users of Exaquantum Web when
added; i.e. all Reports are public.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


15-10 Chapter 15 Working with Exaquantum Web Reports

This page intentionally left blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-1

Chapter 16 Working with Exaquantum XY Plots


This section describes the actions that can be carried out on XY Plot webpages on
Exaquantum Web.
The Web User Interface provides extensive XY plot functions. These allow the user to
visualize tag data, plotted with respect to a single tag. An XY plot webpage can only contain
one individual XY plot (chart), with up to seven pens.
16.1 XY Plot Web page Features
A typical XY plot webpage contains the following features as described below -
Figure 16-1 XY Plot webpage Features

4 5 6 7 8 9

2
3

11 10 12

13

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-2 Chapter 16 Working with Exaquantum XY Plots

Ref Feature Description


1 XY Plot XY Plot webpage title – defined by the user when saving the XY
Webpage Title plot.
2 XY Plot Chart Scatter chart of tag data, plotted with respect to a Reference Tag.
Tool tips are shown for detail point values (see ‘Additional
Features of XY Plots’ below).
3 XY Plot Chart Y-axes are displayed for each pen. The user can control the
Y-axes display of these (see Showing and Hiding XY Plot Features in
section 16.16).
4 Chart Hides or Displays the chart (see Showing and Hiding XY Plot
Features in section 16.16).

5 Legend Hides or Displays the legend (see Showing and Hiding XY Plot
Features in section 16.16).

6 Configuration The user can change the change the configuration settings of the
XY Plot chart (see Configuring an XY Plot in section 16.4)

7 Display as Runs a Trend Display web page – using the current XY Plot
Trend configuration. (see Displaying as a Trend in section 16.16)

8 Export to Exports the tag data, as shown on the XY Plot, to a .CSV file (see
CSV Button Exporting XY Plot Data to a CSV File in section 16.16).

9 Save XY plot The user can save the configuration of the current XY plot
webpage webpage for subsequent reuse (see section 16.10).

10 Legend The Legend shows detail information about the tags assigned to
each pen, and provides some control over the display for each pen.
See Understanding the Desktop PC XY Plot Legend’ in section
16.16 for detail.
11 Add Pens Adds new pens to the current XY plot – see section 16.5.

12 Data Interval Shows the Actual Data Interval for the XY plot (see Actual Data
Interval Calculation in section 16.4)
13 Time Bar Allows the user to select the time range for the XY plot (see
Setting a Time Range for an XY Plot Webpage in section 16.9).

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-3

Additional Features of XY Plots


In addition to the features listed above, XY plots have the following features: -
1. Hovering the mouse (Desktop PC) or tapping (Tablet) over a point of interest
displays a tooltip, containing information about pen values at that time.
Figure 16-2 XY Plot Tooltip

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-4 Chapter 16 Working with Exaquantum XY Plots

16.2 Displaying an existing XY Plot Webpage


To display an existing XY Plot Webpage, open the XY Plots List Page that can be accessed
in one of the following ways: -

 Click on the XY Plots button in the Top Bar then select XY Plots List
from the dropdown.
Tip: If the Top Bar is not visible then click on the Menu button in the top
right hand corner of the screen to access the Top Bar Menu.

 If you are on the Homepage (see 12.2) click on the XY Plots button
embedded in the page.
A XY Plot webpage can then be opened as described in ‘Opening an XY Plot webpage from
the XY Plots List Page’ below.
 Open a XY Plot Favorite directly by clicking on XY Plot in the Top Bar then select
an XY Plot Favorite from the dropdown. XY Plot Favorites are covered in section
16.13.
Opening an XY Plot webpage from the XY Plots List Page
The XY Plots List page is as shown in Figure 16-3: If there are no XY plots in the list then
you will have to create a new XY Plot Webpage as described in section 16.3.
Figure 16-3 XY Plots List Webpage

To open an XY Plot webpage from the XY Plots List page: -


1. Filter the list as described in ‘Filtering the XY Plots List’ below.
2. Click on the Name of the XY plot in the list. The selected XY Plot Webpage opens:
For further details about the XY Plot Webpage see section XY Plot Web page
Features - 16.1.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-5

Filtering the XY Plots List


To locate a particular XY Plot webpage in the XY Plots List, perform one or more of the
following steps: -
1. Click on the Page Size Control beneath the XY Plots List in order to select the
appropriate number of items per page in the XY Plots List.
Figure 16-4 XY Plots List Page Size Control

2. If there are more items than can be displayed in a single page then the Page
Navigation Control can be used to navigate through the pages.
Figure 16-5 XY Plots List Page Navigation Control

3. Click on the Favorites button to toggle the display of XY Plot Favorites in the
XY Plot List on/off. (Described in section 16.13).
4. Click on the Shared button to toggle the display of Shared XY Plots in the XY
Plot List on/off. (The concept of Sharing an XY Plot is described in section 16.14).
5. Type a search string, including supported wildcards into the Search field. Supported
wildcards are:
* OR %- any number of characters are matched
? OR _ – any single character is matched
^ - aligns the search to string start
$ - aligns the search to string end
NOTE. In the search string area, if the * OR % wildcards have not been entered in the
string, when executing the search, wildcard * is automatically appended to the
beginning and end of the search string.
6. Click the Search button or press the Enter key on the keyboard to begin a
search on the: -
 XY Plot Webpage name
 XY Plot Webpage description
Tip: When the list is being filtered, the following information alert is displayed above
the XY Plot List. To quickly remove all filters from the XY Plot List click on the
Remove Filters Button.
Figure 16-6 XY Plots List Filter Active Alert

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-6 Chapter 16 Working with Exaquantum XY Plots

16.3 Creating a new XY Plot Webpage


If you are on the XY Plots List Page (see section 16.2) you can create a XY plot page from
scratch by simply clicking on the New XY Plot button located on the XY
Plots List Page.
Alternatively, perform the following steps to create a new XY plot page: -

1. Click on the XY Plots button in the Top Menu bar.


2. Click on New XY Plot in the dropdown list: -
Figure 16-7 XY Plots Dropdown

3. The Tag Selector Webpage is displayed in order to add a pen to the XY plot as
described in section 16.5 below.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-7

16.4 Configuring an XY Plot


The configuration of an XY Plot refers to setting the following settings:
1. Data Interval – The sample rate for data plotted on the XY Plot, by default, it is set
to 1 minute.
2. Maximum Number of Points- The maximum number of points allowed per pen, by
default it is set to 200
Modifying the Configuration of an XY Plot Webpage
To modify the configuration of an XY Plot:

1. Click on the Configuration button to display the Configuration Dialogue.


Figure 16-8 Configuration Dialogue

2. The Data Interval is specified as a time value in any of the following units of time:
 Seconds
 Minutes
 Hours
 Days
3. The minimum allowed Data Interval is 1 second; the maximum allowed is 365 days
that can be specified in any of the allowed units of time.
4. The Maximum Number of Points is specified as an integer.
5. The minimum allowed value for Maximum Number of Points is 1, the maximum
allowed is 2000.
6. Clicking on the OK button will change the configuration of the current XY Plot,
which will be refreshed to reflect the new settings.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-8 Chapter 16 Working with Exaquantum XY Plots

Actual Data Interval Calculation


The Actual Data Interval calculation is the value used to control the reading and display of
data on the XY Plot. It is calculated from the user specified combination of Data Interval
and Maximum Number of Points. The Actual Data Interval is the time shown on the
legend (see section to 16.16).
The following table describes the variables used to calculate the Actual Data Interval,
followed by the calculation.
Table 16-1 Actual Data Interval Calculation Variables

Variable Name Description


Data Interval User specified Data Interval setting, set in either:
1. Configuration Dialogue (see Figure 16-8)
2. via URL (see section 16.17)
Duration Time duration of XY Plot in seconds
Maximum Points User specified Maximum Number of Points setting, set in either:
1. Configuration Dialogue (see Figure 16-8)
2. via URL (see section 16.17)

The Actual Data Interval is calculated using the following equation:


If (Duration / Data Interval) <= Maximum Points Then
Actual Data Interval = Data Interval
Else
Actual Data Interval = Duration / Maximum Points
End If

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-9

Actual Data Interval Calculation Example


The following table describes an example of how an XY Plot might be configured, followed
by a worked example of the Actual Data Interval calculation.
Table 16-2 Actual Data Interval Example Settings

Variable Name Value


Data Interval 1 Minute (60 seconds)
Duration 8 Hours (28800 seconds)
Maximum Points 200
The following calculations are carried out using the time variables (Data Interval, Duration)
represented as seconds.
Duration / Data Interval = 28800 / 60 = 480 points
The required number of points to be plotted with this configuration is 480, which is greater
than the number allowed by the Maximum Points setting (200)
Therefore, the Maximum Points setting will be used to calculate the Actual Data Interval to
be used.
Duration / Maximum Points = 28800 / 200 = 144 seconds
The Actual Data Interval (as displayed in the legend, see section 16.16 section) for this
configuration, will be 144 seconds.
16.5 Adding a pen to an XY plot
Up to 8 pens (1 Reference pen plus 7 other pens) can be added to an XY plot by using the
Tag Selector Webpage.
Using the Tag Selector Webpage
The Tag Selector Webpage (Figure 16-9) provides the user with the ability to search for
required tags depending on one of two modes: -
 Tag mode - This web page provides the following means of locating tags:
o Entry of full tag path
o Search on tag name and / or description
o Search on function block name and /or description
o Search on folder name
 Event mode - Search OPC tag name, and / or alarm and event message

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-10 Chapter 16 Working with Exaquantum XY Plots

The Tag Selector Webpage is always displayed when a new XY Plot is created.
Alternatively, to display the Tag Selector Webpage from an existing XY plot webpage: -

1. Click on the Add Pens button from the XY plot Legend.


Tip: If the XY Plot Legend is not visible then click on the Display Legend
button above the XY plot chart.
The following diagram and associated table describes the features of the Tag Selector Webpage: -
Figure 16-9 Tag Selector Webpage

1 2 5 6

3 4

Ref Control Description


1 Tag Search tab Allows location of tags from the Namespace based on the search
string
2 Event Search Allows location of tags from the Alarm/Events based on the search
tab string
3 Search field For entering a search string.
4 Search Start Commences either Tag Search or Alarm/Event search
5 Add to XY After a user has selected tags, clicking on Add to XY Plot returns to
Plot the previous XY plot screen and uses the selected tags to populate
the XY plot with data.
NOTE that this button is disabled until at least two tags have been
selected (Reference tag and one comparison tag).
6 Cancel Returns to the previous XY plot screen without changing the tags
for the XY plot.
7 Tag Path If this box is checked, then the user can enter a full path into the
check box Search string field.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-11

Tag Search mode


In order to add a pen to an XY plot by using the Tag Selector Webpage to search through
tag Namespace data, the following steps should be performed: -

1. Click on the Add Pens button from the XY Plot Legend.


Tip: If the XY Plot Legend is not visible then click on the Display Legend
button above the XY Plot.
2. A search comprises of between one and four keywords. Keywords should be
separated by the space character. Enter these in the Search field.
3. Each keyword can contain wildcards. Supported wildcards are:
* OR %- any number of characters are matched
? OR _ – any single character is matched
^ - aligns the search to the keyword start
$ - aligns the search to the keyword end
NOTE. For each keyword, if the * OR % wildcards have not been entered in the
string, when executing the search, wildcard * is automatically appended to the
beginning and end of the keyword.
4. Click the Search button or press the Enter key on the keyboard to search in: -
 Tag Name
 Tag Description
 Function Block Name
 Function Block Description
 Folder Name
5. Results are returned that match all keywords. Results are displayed alphabetically by
OPC Function Block and Tag Name as shown below, with the search string
highlighted where it appears in the tag path or description; a maximum of 1000
results can be displayed.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-12 Chapter 16 Working with Exaquantum XY Plots

Figure 16-10 Tag Search Results

6. If there are more items than can be displayed in a single page then the Page
Navigation Control can be used to navigate through the pages.
Figure 16-11 Page Navigation Control

7. To change the number of results shown on the page, use the Page Size Control to
select the appropriate number of items per page
Figure 16-12 Page Size Control

8. Once the appropriate Tag has been located, click on the Value button
alongside the OPC tag name to quickly add the raw tag value to the Tag Selection
List (see Figure 16-14).

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-13

9. Alternatively click on the Value Dropdown to select from a list of aggregations


to add to the XY plot: -
Figure 16-13 Value Dropdown Aggregations List

10. Newly selected tags are displayed alongside tags already plotted on the XY plot, where
existing tags can be distinguished from newly selected tags by their light grey color: -
Figure 16-14 Tag Selection List

11. The Reference Tag is highlighted in blue and prefixed by the text
12. The Reference Tag can be changed by:
 Clicking on the colored area of another tag (excluding the Close icon) in the
Tag Selection List
 Removing the existing Reference Tag from the Tag Selection List; in this case,
the first tag in the updated Tag Selection List will become the Reference Tag.
13. To remove tags from the Tag Selection List (above) click on the Close icon
alongside the tag name.
14. If required, switch to Event Search mode to find more tags to add to the Tag
Selection List by clicking on the Event Search tab.

15. After selecting Tags, click on the Add to XY Plot button to return to the
XY plot webpage and display the newly selected tags.
NOTE. At least two tags must be selected for Add to XY Plot button to be enabled.

16. Alternatively click on the Cancel Button to return to the XY plot webpage
and discard any changes.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-14 Chapter 16 Working with Exaquantum XY Plots

Full Tag Path Search mode


The Full Tag Path Search Mode is similar to the Tag Search Mode described above with the
following differences: -
1. Check the Use Full Tag Path check box if a full tag path is to be matched. When the
check box is checked, the Search button will change to the Add button .
2. The Full Tag Path required should be entered into the Search field.
NOTE. Wildcards are not applicable to Full Tag Path searches.
3. Click the Add button button or press the Enter key on the keyboard to search
for the Full Tag Path.
4. If an exact match is found, the tag is automatically added to the Tag Selection List as
shown in Figure 16-16 below. If no match is found, the message as shown in Figure
16-15 below is displayed.
Figure 16-15 Full Tag Path Not Found

5. Newly selected tags are displayed alongside tags already plotted on the XY plot, where
existing tags can be distinguished from newly selected tags by their light grey color: -
Figure 16-16 Tag Selection List

6. The Reference Tag is highlighted in blue and prefixed by the text


7. The Reference Tag can be changed by:
 Clicking on the colored area of another tag (excluding the Close icon) in the
Tag Selection List
 Removing the existing Reference Tag from the Tag Selection List; in this case,
the first tag in the updated Tag Selection List will become the Reference Tag.
8. To remove tags from the Tag Selection List (above) click on the Close icon
alongside the tag name.
9. If required, switch to Event Search mode to find more tags to add to the Tag
Selection List by clicking on the Event Search tab.

10. After selecting Tags, click on the Add to XY Plot button to return to
the XY plot webpage and display the newly selected tags.
NOTE. At least two tags must be selected for Add to XY Plot button to be enabled.

11. Alternatively click on the Cancel button to return to the XY plot webpage
and discard the newly selected tags.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-15

Event Search mode


The Event Search Mode is similar to the Tag Search Mode described above with the
following differences: -
1. To enter Event Search mode, click on the Event Search tab.
2. Limit the range of the search by entering values into the Start Date/Time and End
Date/Time fields: Only alarms that occurred between these 2 times will be
considered.
Figure 16-17 Alarm Selection Criteria

3. Click on one of the Date/Time fields or the Edit icon to open the Time Settings
dialog.
Figure 16-18 Time Settings Dialog

4. Times can be specified by clicking one of the available quick time buttons.
5. Times can also be specified in Absolute or Relative terms:
 Specify Absolute times by clicking on the Absolute Tab and either typing
into the Date/Time fields or by clicking on the Calendar button to open
the Calendar Control. Absolute Times can be entered.
 Clicking on the Set to now button, on the Absolute Tab, will set the end time
to the current time.
Figure 16-19 Specifying Absolute Times

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-16 Chapter 16 Working with Exaquantum XY Plots

 Specify Relative Times by clicking on the Relative Tab:


Figure 16-20 Specifying Relative Times

6. Click OK to apply the times selected in the Time Settings Dialog.


7. A search comprises of between one and four keywords. Keywords should be
separated by the space character. Each keyword can contain supported wildcards, as
described in the Tag Search. Enter these in the Search field.
8. Each keyword can contain wildcards. Supported wildcards are:
* OR %- any number of characters are matched
? OR _ – any single character is matched
^ - aligns the search to the keyword start
$ - aligns the search to the keyword end
NOTE. For each keyword, if the * OR % wildcards have not been entered in the string,
when executing the search, wildcard * is automatically appended to the
beginning and end of the keyword
9. Click the Search button or press the Enter key on the keyboard to search in: -
 OPC Tagname
 Alarm and Event Message
10. Results are returned that match all keywords. These (results) are displayed
chronologically (newest first) by Event time as shown below, with the search string
highlighted where it appears in the OPC Tagname or Itemname or Alarm and Event
message; a maximum of 1000 results can be displayed.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-17

Figure 16-21 Event Search Results

NOTE. In the Event Search mode, only Alarms and Events with OPC tags that are
connected to Exaquantum Tags are searched.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-18 Chapter 16 Working with Exaquantum XY Plots

16.6 Removing a pen from an XY plot


A pen can be removed from the XY plot in the following way: -
1. Locate the pen to be removed in the XY Plot Legend: If the XY Plot Legend is not
visible, click on the Display Legend button above the XY plot.
Figure 16-22 XY Plot Legend

2. This differs between desktop PC and tablet devices.

For desktop PC, click on the Remove Pen icon alongside the Name of the pen
to be removed.
Figure 16-23 Remove Pen Icon

For tablet devices, select the Remove Pen option by opening the Legend Action
menu as shown in Figure 16-24.
Figure 16-24 Tablet Device XY Plot Legend Action Menu

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-19

16.7 Modifying a pen on a XY plot


A pen that is displayed on a XY plot can be modified in the following way: -
1. Locate the pen to be modified in the XY Plot Legend (see Figure 16-22 above): If
the XY Plot Legend is not visible, click on the Display Legend button above
the XY plot.
2. This differs between desktop PC and tablet devices.

For desktop PC, click on the Edit Pen icon alongside the Name of the pen to be
modified.
Figure 16-25 Edit Pen Icon

For tablet devices, select the Edit Pen option by opening the Legend Action menu
as shown in Figure 16-26
Figure 16-26 Tablet Device XY Plot Legend Action Menu

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-20 Chapter 16 Working with Exaquantum XY Plots

3. In the Edit Pen Dialog click on the Color swatch to change the color of the pen.
Figure 16-27 Edit Pen Dialog

4. Specify the Y-Axis Label by typing into the text box.


5. Click OK.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-21

16.8 Changing the Reference pen on an XY plot


The Reference pen can be changed on the XY plot in the following way: -
1. Locate the pen to be made the new Reference pen in the XY Plot Legend (see Figure
16-22 above): If the XY Plot Legend is not visible, click on the Display Legend
2. This differs between desktop PC and tablet devices.
For desktop PC, click on the Set as Reference icon alongside the Name of the
pen to be removed.
Figure 16-28 Set as Reference Icon

For tablet devices, select the Set as Reference option by opening the Legend
Action menu as shown in Figure 16-29.
Figure 16-29 Tablet Device XY Plot Legend Action Menu

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-22 Chapter 16 Working with Exaquantum XY Plots

16.9 Setting a Time Range for an XY Plot Webpage


An XY plot webpage can only be displayed in Historical mode; there is no Live mode for
XY plots.
Table 16-3 XY Plot Webpage Time Modes

Time Mode Description


Historical Displays a range of historical data between a start and end
time, as specified by the user.

Setting a Historical Time Range for an XY Plot Webpage


To set a historical time range for the XY plot Webpage:
Either:
Use the quick select buttons to specify an Offset from the current Start Time: -
1. This differs between desktop PC and tablet devices.

For desktop PC, on the Time Bar, click on either 1h, 8h, 1d or 1w to set the End
Time to the specified number of hours, days or weeks relative to the Start Time.

For tablet device, on the Time Bar, tap the Start Time Clock icon and then
select either 1 Hour, 8 Hours, 1 Day or 1 Week to set the End Time to the
specified number of hours, days or weeks relative to the Start Time.

Or:
Use the quick select buttons to specify an Offset from the current End Time: -
1. This differs between desktop PC and tablet devices.

For desktop PC, on the Time Bar, click on either 1h, 8h, 1d or 1w to set the Start
Time to the specified number of hours, days or weeks relative to the End Time.

For tablet device, on the Time Bar, tap the End Time Clock icon and then
select either 1 Hour, 8 Hours, 1 Day or 1 Week to set the Start Time to the
specified number of hours, days or weeks relative to the End Time.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-23

Or:
Use the quick select buttons to move the Start Time and End Time, by half the
duration between the start and end times: -

1. On the Time Bar, click on either the Half Back or Half Forward buttons to
move the start and end times backwards or forwards by half a duration.
Or:
Use the quick select buttons to move the Start Time and End Time, by the full
duration between the start and end times: -

1. On the Time Bar, click on either the Back or Forward buttons to move the
start and end times backwards or forwards by a full duration.
Or:
Use the Now button to set the End Time to the current date and time: -

1. On the Time Bar, click on the Now button to move the End Time to the
current date and time. The Start time remains unchanged.
Or:
Specify a time in the past by using the Time Settings Dialog, as follows: -

 On the Time Bar, click on either the Start Time, End Time or the Edit icon to
open the Time Settings dialog.
Figure 16-30 XY Plot Time Settings Dialog

 Times can be specified by clicking one of the available quick time buttons.
 Times can also be specified in Absolute or Relative terms:

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-24 Chapter 16 Working with Exaquantum XY Plots

 Specify Absolute dates by clicking on the Absolute Tab and either typing
into the Date/Time fields or by clicking on the Calendar button to open
the Calendar Control. Absolute Times can be typed directly into the time field.
 Clicking on the Set to now button, on the Absolute Tab, will set the end time
to the current time.
Figure 16-31 Specifying Absolute Times for an XY Plot

 Specify Relative Times by clicking on the Relative Tab.


Figure 16-32 Specifying Relative Times for an XY Plot

 Click OK to apply the times selected in the Time Settings Dialog.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-25

16.10 Saving an XY Plot Webpage


When modifications are made to an XY Plot Webpage, the Save Button becomes enabled to
indicate that the XY Plot can be saved.
NOTES.
XY Plots can only be saved by the user that owns the XY plot
To save a XY Plot Webpage: -
1. Click on the Save button .
2. In the Save XY Plot Dialog, specify a unique Name and a meaningful Description
for the XY plot.
Figure 16-33 Save XY plot Dialog

3. Check the Favorite checkbox if you want to add the XY Plot to your Favorites List.
4. If you are a member of the groups listed in Table 16-4, you can share the XY plot by
checking Share with other users.
5. Check Save with time to saves the current time range of the XY plot. This will
override the time selector when the XY plot webpage is next viewed.
6. Click OK.
Table 16-4 Shared XY Plots – User groups

Security Model Group names


Legacy QAdministratorGroup OR QExplorerDesignGroup
Standard QTM_MAINTENANCE OR QTM_EXPLORER_DESIGN

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-26 Chapter 16 Working with Exaquantum XY Plots

16.11 Copying an XY Plot Webpage


XY Plot Pages can be copied in two ways:
 Copying of a XY plot owned by the current user
 Copying a Shared XY Plot owned by another user
To Copy a XY Plot, use the SaveAs button:
1. Click on the Save button dropdown and select the SaveAs option (Figure 16-34).
Figure 16-34 SaveAs option

2. In the SaveAs XY Plot Dialog, specify a unique Name and a meaningful


Description for the XY plot.
Figure 16-35 Save XY Plot Dialog

3. Check the Favorite checkbox if you want to add the XY Plot to your Favorites List.
4. If you are a member of the groups listed in Table 16-4, you can share the XY plot by
checking Share with other users.
5. Check Save with time to saves the current time range of the XY plot. This will
override the time selector when the XY plot webpage is next viewed.
6. Click OK.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-27

16.12 Deleting an XY Plot Webpage


NOTE. Shared XY plots can only be deleted by users who are members of either:
 QAdministratorGroup / QExplorerDesignGroup (Legacy mode security)
 QTM_MAINTENANCE / QTM_EXPLORER_DESIGN (Standard mode Security).
If you are not a member of either of these Windows Groups then you will only be
able to delete private XY plots that you have created.
XY Plot webpages can be deleted from Exaquantum Web in the following way: -

1. Click on the XY Plots button in the Top Menu bar.


2. Open the XY Plots List Webpage by clicking on XY Plots List in the dropdown
list: -
Figure 16-36 XY Plots Dropdown

3. In the XY Plots List Webpage, locate the XY Plot(s) to be deleted by ‘Filtering the
XY Plots List’ as described in section 16.2.
Figure 16-37 XY Plots List Webpage

4. In the XY Plots List Webpage, put a check alongside the Name of each XY plot you
wish to delete. There will be no checkbox for XY plot that you are not allowed to
delete.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-28 Chapter 16 Working with Exaquantum XY Plots

Figure 16-38 Selecting XY Plots for Deletion

5. Click the Delete XY Plots button .

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-29

16.13 Updating your XY Plot Favorites List


XY Plots can be added to your Favorites List so that they can be accessed quickly from the
XY Plots Dropdown (see Figure 16-39).
To add/remove XY Plots in your Favorites list, follow the steps below: -

1. Open the XY Plots List Webpage, by clicking on the XY Plots button in


the Top Menu bar.
2. Click on XY Plots List in the dropdown list: -
Figure 16-39 XY Plots Dropdown

3. In the XY Plots List Webpage, check or uncheck the Favorite checkbox to add /
remove the XY plot from your favorites.
Figure 16-40 XY Plots List Webpage

4. When you have finished, click on the Show Favorites button .


5. The XY Plots List displays your selected favorites that now appear under Favorites
in the XY Plots Dropdown (Figure 16-39).
6. Click the Remove Filters button to display the full list of XY plots.
Figure 16-41 Remove Filters

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-30 Chapter 16 Working with Exaquantum XY Plots

16.14 Sharing an XY Plot


XY Plots can only be shared by users who are members of User Groups, as listed in Table
16-4.
If you are not a member of either of these Windows Groups then you will not be able to
share your own XY plots, and the resultant XY plot will be private.
To share an XY plot so that it is accessible to all users:

1. Open the XY Plots List Webpage, by clicking on the XY Plots button in


the Top Menu bar.
2. Click on XY Plots List in the dropdown list: -
Figure 16-42 XY Plots Dropdown

3. In the XY Plots List Webpage, check the Shared checkbox: The XY Plot will now
be accessible to all users.
Figure 16-43 XY Plots List Webpage

Similarly, to remove a XY Plot from the Public List and make it private, uncheck the Shared
checkbox on the XY Plots List Webpage.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-31

16.15 Printing an XY Plot


Printing of XY Plots uses the standard web browser printing functionality.
Either: -
 Select the print option from the browser’s menu
Or: -
 Use the Ctrl+P keyboard shortcut.

The following formatting is applied to the printed page:


1. Top Bar is not printed.
2. Time Bar is not printed.
3. Start and End times are printed
4. Legend is printed including the actual data interval
5. The following buttons are not printed:
 Show / Hide Chart
 Show / Hide Legend
 Configuration
 Display as Trend
 Export to CSV
 Save / Save As
 Reset Zoom
NOTE. It is not possible to print an XY Plot from a tablet device.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-32 Chapter 16 Working with Exaquantum XY Plots

16.16 Advanced Features of XY Plots


Understanding the Desktop PC XY Plot Legend
The desktop PC XY plot legend contains the following features: -
Figure 16-44 XY Plot Legend Features

1 3

The features referenced above are described in the following table Figure 16-45: -
Figure 16-45 XY Plot Legend Features

Label Feature Description


1 Name The Function block name, if present and the Tag name. Hovering
over the name displays a tooltip, showing the full path for the tag.
2 Pen icons Set as Reference (see section 16.8)
Edit Pen (see section 16.7)
Remove Pen (see section 16.6)
Hide/Show Y-Axis (see ‘Showing and Hiding XY Plot Features’
3 Description Tag description.
4 Actual Data The sample rate for data plotted on the XY Plot (see ‘Actual Data
Interval Interval Calculation’ in section 16.4)

Understanding the Tablet Device XY Plot Legend


The tablet device XY plot legend contains the same features as that of the desktop, except
for: -
Item 2, the Pen icons are displayed after clicking the Legend Actions Menu button (see
Figure 16-46)
Figure 16-46 Tablet Device XY Plot Legend

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-33

Using Zoom on XY Plots


To zoom in on an XY plot chart: -
1. This differs between desktop PC and tablet devices.

For desktop PC, click and drag on the XY Plot Chart to highlight a section of the XY plot.

For tablet device, use the ‘pinch to zoom’ gesture.


Figure 16-47 XY Plot Zoom

2. Release the mouse button and a zoomed version of the XY plot is displayed. Note the
presence of the Reset Zoom button circled in the figure below.
Figure 16-48 Zoomed XY Plot

NOTES. Zooming results in a graphical zoom as opposed to a data zoom (compared with the Trend
zoom). Therefore, more data points will not be loaded as part of the zoom. The existing data points
of a smaller area of the XY plot chart will be displayed in the full chart area.
Zoom is a temporary state and does not affect the settings in the Time Bar, nor is it retained
when the page is saved.
To cancel a zoom on a XY plot chart you must reset the zoom: -

Click the Reset Zoom button circled in Figure 16-48 above.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-34 Chapter 16 Working with Exaquantum XY Plots

Showing and Hiding XY Plot Features


The following controls allow you to show/hide features of XY Plot webpages in order to
maximize screen real estate thus allowing you to concentrate on the data that matters to you:
Table 16-5 XY Plot Feature Visibility Controls

Control Description
Toggles visibility of XY Plot Chart on/off.
The setting is not saved. By default, the XY Plot chart is visible.
Toggles visibility of the XY Plot Legend on/off.
The setting is not saved. By default, the XY Plot legend is visible.
Hide/Show pen Y-Axis: Removes the Y-Axis name and values for the pen that
expands the XY plot display area.
Y-axes are shown by default on a new XY plot but the state is saved when the
XY Plot Webpage is saved. Therefore, the default visibility of the Y-axes will
be dependent on the saved settings.
For tablet devices, the ‘Hide Y-Axis’ option is accessible by opening the
Legend Action menu as shown in Figure 16-49.
Figure 16-49 Tablet Device XY Plot Legend Action Menu

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-35

Displaying as a Trend
The current XY plot configuration can be transposed into a Trend Display web page,
persisting the current configured tags and time duration.
Table 16-6 Display as Trend Configuration

Configuration Item Description


Tags All tags will be plotted on the Trend Display, in the same order
as they appear on the XY Plot legend.
Duration The duration will be the same as the XY Plot, regardless of
whether the XY Plot is saved with time or not. This will always
be a static historical time range.
Axis Tags will be plotted against alternating left and right sided Y-
Axis, starting with the Reference Tag plotted against the inner
most left hand axis.
NOTE. The Axes will show default colors and default titles (Tag
name), no modified axis configuration will be transposed to the
Trend Display web page.
To display the current configuration in a Trend Display web page:

1. Click on the Display as Trend button on the XY Plot Webpage.


2. Alternatively, on desktop PC, the new Trend can be displayed in a new tab by right
clicking the Display as Trend button and selecting ‘Open in new tab’.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-36 Chapter 16 Working with Exaquantum XY Plots

Exporting XY Plot Data to a CSV File


Data plotted on the current XY can be exported to allow for data analysis to be carried out
externally to the Web user interface.
It is important to note that exporting data to csv file from the XY plot will produce different
results to exporting from a Trend. This is because the Trend uses filtered data, whereas the
XY plot uses re-sampled (spot aggregation) data.
To Export data in an XY plot to a CSV file, do the following: -

1. Click on the Export to CSV button on the XY Plot Webpage.


2. Save the file do your chosen location (this varies according to browser version).
3. Open the file from your chosen location with an appropriate program like Microsoft
Office Excel. The CSV file contains the following data for each tag: Timestamp,
Value and Raw Quality as shown in Figure 16-50 below:-
Figure 16-50 CSV Opened in Excel

NOTE. The timestamp format in the CSV file depends on the web server configuration. On
the client when the file is opened in Excel, the default date time formatting will not
always display the seconds value although the value is present in the cell. To
display the seconds value, format the column cells to include seconds. e.g.:
dd/mm/yyyy hh:mm:ss

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-37

16.17 Displaying XY Plot Data Directly from the URL


Users running applications that use Exaquantum data can directly run Exaquantum XY Plot
pages from their custom application.
There are two ways of displaying a XY plot as described in Table 16-7.
Table 16-7 Display XY Plot Data from URL

URL Type Description


Adhoc Creates an ad hoc XY plot by passing parameters via the URL.
In this case is it possible to display an XY plot chart containing up to eight
pens over a specified time range.
Load Loads an existing XY plot by passing an XY plot name in the URL.
In this case is it possible to display a saved XY plot chart with either the
time range as saved with the XY plot, or as specified in the URL.

Displaying an Ad hoc XY Plot


An ad hoc XY plot may be displayed using the URL “ExaquantumWeb/XYPlot/Adhoc”
with one or more arguments to describe the pens to display and the time range in the form:
Error! Hyperlink reference not valid.>
The parameters available for creating an ad hoc XY plot are described below.
Examples
In the following examples, the initial part of the URL has been omitted for clarity. All
examples should be prefixed with the following:
http://<servername>:<port>/ExaquantumWeb
Example 1:
This example displays an adhoc XY Plot:
 Containing two tags called Root.ReferenceTag and Root.ComparisonTag
 Sets the Data Interval to 5 minutes
 Sets the Maximum Points to 300
/XYPlot/AdHoc?Tag=Root.ReferenceTag&Tag=Root.ComparisonTag&DataInterval=5m&
MaxPoints=500

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-38 Chapter 16 Working with Exaquantum XY Plots

Example 2:
This example displays an adhoc XY Plot:
 Containing two tags called Root.ReferenceTag and Root.ComparisonTag
 Sets the start time to five minutes before the current time
 Sets the end time to the current time
/XYPlot/AdHoc?Tag=Root.ReferenceTag&Tag=Root.ComparisonTag&StartTime=NOW-5
Example 3:
This example displays an adhoc XY Plot:
 Containing two tags called Root.ReferenceTag and Root.ComparisonTag
 Sets the Time range to be specific dates
/XYPlot/AdHoc?Tag=Root.ReferenceTag&Tag=Root.ComparisonTag&StartTime==2016-
10-30-08-00-00&endTime=2016-10-30-12-00-00
Displaying a Saved XY Plot
A saved XY plot may be displayed using the URL “ExaquantumWeb/XYPlot/Load” with one
or more arguments to describe the XY plot chart to display and the time range in the form:
Error! Hyperlink reference not valid.>
or
Error! Hyperlink reference not valid.>
The parameters available for loading an XY plot are described in Table 16-8 below.
Examples
In the following examples, the initial part of the URL has been omitted for clarity. All
examples should be prefixed with the following:
http://<servername>:<port>/ExaquantumWeb
Example 1:
This example:
 Loads an existing XY plot called “XYPlotOne”
 Sets the start time 60 minutes before the current time
 Sets the end time to the current time
/XYPlot/Load?name=XYPlotOne&StartTime=NOW-60&EndTime=NOW

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-39

Example 2:
This example:
 Loads an existing XY plot called “XYPlotTwo”
 Sets the start time to five minutes before the current time
 Sets the end time to the current time
/XYPlot/Load?name=XYPlotTwo&StartTime=NOW-5

Example 3:
This example
 Loads an existing XY plot called “XYPlotThree”
 Sets the start time to 2016-12-21 16:32:33
 Sets the end time to 2016-12-21 20:32:33
/XYPlot/Load?name=XYPlotThree&StartTime=2016-12-21-16-32-33&EndTime=2016-12-
21-20-32-33
URL Parameters for Displaying an Ad hoc or Saved Trend
This section describes the parameters that may be specified on the URL in order to display
an ad hoc trend or a saved trend.
Table 16-8 XY Plot URL Parameters

Parameter Description Validation


Tag Specify tags plotted on the XY Plot. At least two tags must be
(adhoc Tag names may be either: specified and no more than eight.
only) • Intrinsic If more than 8 tags are specified,
only the first 8 tags are plotted
e.g. Tag=Root.Folder.TagName1
The first tag specified in the URL
or Tag=Root.Folder.Tagname1 is used as the Reference pen.
Aggregations.Hour.Mean Tag names should be URL
• RBNS encoded (see URL Encoding for
e.g. Tag=RBNS.Server1.Folder.TagName1 Saved Trend, XY Plot and Tag
or Tag=RBNS.Server1.Folder.TagName1 Names for details).
Aggregations.Hour.Mean
startTime StartTime can be configured in the The time must match the format
following ways: specified (see NOTE 2 below).
Absolute Time If the supplied starttime is:
in the future after the endtime or
Relative Time
not specified then the starttime is
The possible formats are: set to one hour before the
Absolute Time: yyyy-MM-dd-HH-mm-ss endtime.
eg. starttime=2016-12-21-16-32-33
Relative Time: NOW-<minutes>
eg. starttime=NOW-60

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-40 Chapter 16 Working with Exaquantum XY Plots

Parameter Description Validation


endTime EndTime can be configured in the same The time must match the format
way as startTime except that for specified (see NOTE 2 below).
Relative Time “NOW” can be used. If the supplied endtime is:
in the future not specified then the
current time is used
dataInterval DataInterval can be specified in the The minumum allowed value for
following ways: DataInterval is 1 second, the
• Time in Seconds: DataInterval=30s maximum allowed value is 1 year
• Time in Minutes: DataInterval=30m If not specified or specified
outside the allowed range, the
• Time in Hours: DataInterval=8h
default value of 1 minute is used
• Time in Days: DataInterval=1d
maxPoints Specifies the maximum number of The minimum allowed value for
points for the XY plot. MaxPoints is 1, the maximum
• MaxPoints=<Value> allowed is 2000.
eg. MaxPoints=500 If not specified or specified
outside the allowed range, the
default value of 200 is used
Id This is the unique id of the saved XY plot. ID should be a Number
(load only, If set this setting will override the Name ID should be a valid existing
see NOTE 1 setting saved XY plot ID
below)
Name This is the name of the saved XY plot. Name should be a valid existing
(load only, saved XY plot name
see NOTE 1 Names should be URL encoded
below) (see URL Encoding for Saved
Trend, XY Plot and Tag Names
for details).
NOTE 1. When the load parameter is used, one of the commands Id or Name must be
specified.
NOTE 2. The format for Absolute time parameters should match the format specified in the
web.config file for the “JsonRequestDateTimeFormat” setting. By default, this
value is “yyyy-MM-dd-HH-mm-ss”.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 16-41

StartTime/EndTime Processing When Loading XY Plot Saved With Time


Note that saved XY plots may already have times specified, due to being saved with time.
When an XY Plot has been saved with times, the order of processing is as follows:
1. If both start and end times are specified on the URL then these are used regardless of
any saved times.
2. If the XY plot was saved with time, and no times are specified on the URL, then the
saved times are used
3. If either the start or the end time is specified on the URL, then this time is used and
the default for the non-specified time is as follows
 If starttime is specified, then end time is NOW
 If endtime is specified, then start time is end time – 1 hour
4. If neither the start time nor the end time is specified on the URL, then the default
start time is NOW-60 and the default end time is NOW.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


16-42 Chapter 16 Working with Exaquantum XY Plots

This page intentionally left blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 17-1

Chapter 17 Administering the Exaquantum Web Website


This section contains details about functions relevant to keeping your website healthy, and
adjusting parameters to tune your system.
17.1 Granting Users Access to Exaquantum Web
Windows Authentication and the existing Exaquantum Windows groups are utilized to
control access to the Web User Interface. To gain access to Exaquantum Web, the user must
be a member of one the following groups depending on the Exaquantum Security Mode:
 QUserGroup (legacy mode security)
 QTM_DATA_READ (standard mode security – Workgroup and Domain)
If the user is not a member of either group (for the relevant security mode), then Exaquantum
Web will display a page with an access denied message.
Browser Security Settings
For Browser security, the following are supported on the client machine:
 Prompt for user name and password
 Automatic logon with current user name and password
NOTE. Automatic Logon is only supported if the User accounts requiring access to the web
site exist on both the web-server and web-client, and have the same account name
and password (Legacy security, and Standard mode Security – workgroup).

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


17-2 Chapter 17 Administering the Exaquantum Web Website

Authorization to perform specific functions


Users can be granted authorization to perform specific functions as detailed in the table
below.
Table 17-1 Website - User Permissions
Admin Design Browse
Web site access View ○ ○ ○
Create ○ ○ ○
View ○ ○ ○
Private Trend page owned by this user
Edit ○ ○ ○
Delete ○ ○ ○
Create ○ ○ -
View ○ ○ -
Shared Trend page owned by this user
Edit ○ ○ -
Trends Delete ○ ○ -
View × × ×
Private Trend page, owned by a different
Edit × × ×
user
Delete ○ × ×
View ○ ○ ○
Shared Trend page, owned by a different
Edit × × ×
user
Delete ○ ○ ×
Export to CSV (configurable) Export ○ ○ ○
Create ○ ○ ×
View ○ ○ ○
Mimics
Edit ○ ○ ×
Delete ○ ○ ×
Create ○ ○ ×
View ○ ○ ○
Reports
Edit ○ ○ ×
Delete ○ ○ ×
Create ○ ○ ○
View ○ ○ ○
Private XY Plot page owned by this user
Edit ○ ○ ○
Delete ○ ○ ○
Create ○ ○ -
View ○ ○ -
Shared XY Plot page owned by this user
Edit ○ ○ -
XY
Delete ○ ○ -
Plots
View × × ×
Private XY Plot page, owned by a
Edit × × ×
different user
Delete ○ × ×
View ○ ○ ○
Shared XY Plot page, owned by a
Edit × × ×
different user
Delete ○ ○ ×
Export to CSV (configurable) Export ○ ○ ○

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 17-3

17.2 Display Control for Mimics


For Internet Explorer versions 9 and above, it is possible to control how a Mimic is
displayed:
 Mimic opens in the same window as the current Internet Explorer
 Mimic opens in a new Window or Tab in Internet Explorer
To control this behavior, two scripts (Table 17-2) are provided on the prerequisite software
DVD (Disc 1). These should be executed on the Web Server or Combined Server, as a user
with Administration rights.
Table 17-2 Mimic Display Control Scripts

Script Description

<DVD>:\Tools\MimicDisplayNewWindowEnable.js Enable Mimic display in a new IE


Window

<DVD>:\Tools\MimicDisplayNewWindowDisable.js Disable Mimic display in a new IE


Window

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


17-4 Chapter 17 Administering the Exaquantum Web Website

This page intentionally left blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 18-1

Chapter 18 Scope of CS 3000 Conversion


18.1 CS 3000 Primitives
Limitations
The following limitations apply to the Static Primitives, Active Primitives and Functions
described in later sections of this chapter.
Table 18-1 Limitations

Limitation Description

A Centre not supported.

B Calling user-defined graphic window only.

C Fill area properties Graduation and Fill are set to solid.

D “Roundness of Edge” is not converted.

E Background is not converted.

F Bezier curves are drawn as straight lines.

G Split into independent primitives.

H Text path (D3-5) will not be converted.

I Up vector (D3-6) will not be rotated.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


18-2 Chapter 18 Scope of CS 3000 Conversion

Static Primitives
Table 18-2 Static Primitives

CS 3000 Primitives PXD/PXG Converter Support


Pen Yes (Limit-C,D)

Straight Line Yes

Polyline Yes (Limit-D,E,F)

Arc Yes (Limit-C)

Rectangle Yes (Limit-C,D)

Circle Yes (Limit-C)

Ellipse Yes (Limit-C)

Sector Yes (Limit-C)

Fill-Area Yes (Limit-C,D)

Marker Yes (Limit-G)

Text Yes (Limit-H,I)

Bitmap No

ISA Symbol Yes

Group Object Yes

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 18-3

Active Primitives
Table 18-3 Active Primitives

CS 3000 Primitives SVG Converter Support


Process data character Yes

Data Rectangle Yes(limit-A)

Data Arrow Yes

Data Circle Yes

Line-segment Graph Yes

User-defined line-segment Graph Yes

Bar Graph Yes

Step Graph Yes

Radar Graph Yes

2D-Graph Yes

Touch Target Yes (limit-B)

Push Button Yes (limit-B)

Face Plate Block Button No

Instrument Diagram No

Window No

Message No

Dialog Name No

Trend No

Control (ActiveX) No

Overview No

Soft key No

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


18-4 Chapter 18 Scope of CS 3000 Conversion

Functions
Table 18-4 Functions

CS 3000 Primitives SVG Converter Support


Calculation Yes

Graphic Modify Yes

Modify Coordinate Yes

Action Yes(limit-B)

Data Bind No

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 18-5

18.2 Properties
Static Properties
Table 18-5 Static Properties

CS 3000 Primitives SVG Converter Support


Property Item Notes

Window Panel Type No

Size Yes

Screen refresh period No

Screen BG color Yes

Window name Yes

Window Comment Yes

Common Object Name Yes

Position Yes

Size Yes

Tag Object No

Debug No

Line Line Style Yes

Line Thickness Yes

Line Color Yes

Arrow Yes

Roundness of Edge Yes All types of roundness are


converted to same roundness

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


18-6 Chapter 18 Scope of CS 3000 Conversion

CS 3000 Primitives SVG Converter Support

Fill Fill type Yes “pattern”, “gradation” => “Fill”

FG color No Data for “pattern”

BG color Yes

Pattern No Always solid fill

Gradation No Always solid fill

Text Font type Yes

Font size Yes

Font style Yes

Text color Yes

BG color Yes

Text angle Yes

Marker Marker Type Yes

Marker Size Yes

Marker Color Yes

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 18-7

Dynamic Properties
Table 18-6 Dynamic Properties

CS 3000 Primitives SVG Converter Support


CS 3000 SVG attribute Notes
Property
Modifier Change type Yes

Condition No. No Order has same meaning.

Conditional formula Yes

Color change type (*) Overview color is


Yes supported if selected
Normal colored change
Yes process tag.
Alarm color change
Yes (*)
Overview color change
Blink No

Transparent Yes

Modify X-Data Yes


Coordinates
Y-Data Yes

Last Move position Yes

Data Bind Set No. Yes

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


18-8 Chapter 18 Scope of CS 3000 Conversion

This page intentionally left blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 19-1

Chapter 19 Scope of CENTUM VP Conversion


19.1 CENTUM VP Primitives
Static Primitives
Table 19-1 Static Primitives

CENTUM VP Primitives PXD/PXG Converter Support


Pen Tool Yes (Limit-B,C,E,K)

Straight Line Yes (Limit-K)

Polyline Yes (Limit-C,D,K)

Arc Yes (Limit-K,M)

Rectangle Yes (Limit-B,C,K)

Circle Yes (Limit-B,K)

Ellipse Yes (Limit-B,K)

Sector Yes (Limit-B,K)

Fill-Area Yes (Limit-B,C,K)

Marker Yes (Limit-F,K)

Text Yes (Limit-G,H,I,L,O)

Bitmap No

ISA Symbol Yes (Limit-J,K)

Group Object Yes (Limit-J,K)

Motor Yes (Limit-J,N)

Others Yes (Limit-J,K)

Pipe Yes (Limit-J,K)

Pump Yes (Limit-J,K)

Switch Yes (Limit-J,K)

Tank Yes (Limit-J,N)

Valve Yes (Limit-J,K)

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


19-2 Chapter 19 Scope of CENTUM VP Conversion

Active Primitives
Table 19-2 Active Primitives

CENTUM VP Primitives SVG Converter Support


Data character display Yes (limit-I,N)

Rectangle bar Yes (limit-A,K)

Arrow bar No

Circle bar No

Polyline Graph No

User-defined polyline Graph No

Bar Graph No

Step Graph No

Radar Chart No

Two-Dimensional-Graph No

Touch Target No

Push Button No

Face Plate Block Button No

Instrument Diagram No

View No

Message No

Trend No

Windows Control No

Overview No

Soft key No

Product Overview No

Tab No

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 19-3

CENTUM VP Primitive Restrictions


Table 19-3 CentumVP Primitive Restrictions

Limitation Description

A Centre not supported.

B Fill area properties Gradation, Fill, texture and picture


are set to solid.

C “Roundness of Edge” is not converted.

D Background is not converted.

E Bezier curves are drawn as straight lines.

F Split into independent primitives.

G Text path (D3-5) will not be converted.

H Up vector (D3-6) will not be rotated.

I Only MS Gothic will be supported.

J Rotate Right, Rotate left, flip horizontal and flip


vertical will not be supported.

K Degrees of rotation can be supported only 90, 180, 270,


-90, -180 and -270.

L Degrees of rotation can be supported only -90.

M Arrows will not be converted.

N Rotation will not be supported.

O Rotation after grouping will not be supported.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


19-4 Chapter 19 Scope of CENTUM VP Conversion

19.2 Properties
Static Properties
Table 19-4 Static Properties

CENTUM VP Primitives SVG Converter Support


Property Item Notes

Attribute Panel Type No

Size Yes

Screen refresh period No

Window BG color Yes

Scaling Mode No

Window Name No

Window Comment No
Call Call Window No
Window
Instrument Instrument Command Operation No
Command
Operation

Generic Set No Yes (limit – a)


Name
Set No

Comment No

Generic Name No

Data Value Yes (limit – b)

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 19-5

CENTUM VP Primitives SVG Converter Support

General Object Name No

Position Yes

Size Yes

Tag Object No

Debug No

Visible Yes Always Visible valid

Enable Yes Always Enable valid

Comment No

Line Line Style Yes

Transparent No

Line Thickness Yes

Hairline Yes

Line Color Yes

Arrow Yes (limit – c)

Arrow Size No

Round Corner No

Disjoint Yes

Arc Arc Size Yes

Clockwise(Sweep Direction) Yes

Counterclockwise(Sweep Yes
Direction)

Is Large Arc Yes

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


19-6 Chapter 19 Scope of CENTUM VP Conversion

CENTUM VP Primitives SVG Converter Support

Fill Fill type Yes (limit – d)

FG color No Data for “pattern”

BG color Yes

Transparent Yes

Solid No Always solid fill

Pattern No Always solid fill

Gradient No Always solid fill

Texture No Always solid fill

Picture No Always solid fill

Font Font Yes (limit – e)

Size Yes

Style Yes

Strikeout No

Underline No

Display BorderStyle No

ForegroundBorderStyle No

Style No

Thickness No

Foreground Yes (limit – d)

Background Yes (limit – d, j)

BorderBrush No

ForegroundBorderBrush No

EngineerUnitColor No

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 19-7

CENTUM VP Primitives SVG Converter Support

Data Is Advanced Alignment No Always Is Advanced Alignment


Character valid

Type No

Date Format No

Time Format No

Number of Digits Yes (limit – f)

Decimal Points Yes (limit – f)

User Specified Alignment No

Alignment No

Leading Zeros Yes

Trailing Zeros Yes Always Trailing Zeros valid

Show Engineering Unit Yes (limit – g)

Engineering Unit No

Unit Length No

Data Bar Bar Type No

Growth Direction Yes

Reference Point No

Marker Shape Yes

Marker Size No

FG Color Yes

Transparency (FG color) No

BG color Yes

Transparency(BG color) Yes

Marker shadow No

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


19-8 Chapter 19 Scope of CENTUM VP Conversion

CENTUM VP Dynamic Properties


Table 19-5 CentumVP Dynamic Properties

CENTUM VP Primitives SVG Converter Support


CENTUM VP SVG attribute Notes
Property
Modifier Execution Mode Yes

Condition No. No

Conditional formula Yes

Continue Yes

Normal Color Change Yes

Alarm-specific Color Change No

Overview Color Change No

Blink No

Alarm-specific Blinking No

Screen Blinking No

Overview Blinking No

Transparent No

Modify String No

Invert Yes (limit – h, k)

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 19-9

CENTUM VP Primitives SVG Converter Support

Advanced data X-Axis Value No


linking
X-Axis Low Limit No

X-Axis High Limit No

Y-Axis Value No

Y-Axis Low Limit No

YX-Axis High Limit No

Last Move Position X- No


Coordinate

Last Move Position Y- No


Coordinate

Data link Property No

Value Yes (limit – i)

Low limit Yes

High limit Yes

Contents No

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


19-10 Chapter 19 Scope of CENTUM VP Conversion

CENTUM VP Property Restrictions


Table 19-6 CentumVP Property Restrictions

Limitation Description

a Tag Name of Conditional formula will be converted as data variable

b Generic Name of conditional formula will be converted to be replaced


as data Value.

c All arrows will be converted as fixed Arrow Type.

d Fill area properties Gradation, Fill, texture and picture are set to solid.

e Only MS Gothic will be supported.

f Maximum digit number will be supported fifteen.

g In case “Show Engineering Unit” is valid, another format(“Number of


digits”, “Decimal Points”, “Leading Zeros” and “Trailing Zeros” will
be converted as invalid.

h Only text and data character display will be converted.

i Only data character display and rectangle bar will be converted.

j Rectangle bar will be converted as transparency.

k In case it was set to be standard color change simultaneously, it will not


be supported.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


Exaquantum Engineering Guide – Volume 4 Web Authoring 20-1

Chapter 20 Enable Read of Large Data Volumes by Legacy


Web Client
Internet Information Services (IIS), version 6.0 and above, imposes a restriction on the
amount of data that may be returned to a web client in a single message. This may cause
problems for customers upgrading from IIS 5.0 who are accustomed to requesting large
volumes of data (for example, using the Exaquantum Excel Add-in to request data for long
periods or for many tags). The IIS limits may be increased by the following procedure.
20.1 IIS 7.0 Increase ASP Response Buffering Limit in the IIS Manager
The IIS Response Buffering Limit can be edited using the IIS Manager. After making the
changes IIS will need to be re-started.
This procedure must be run as Administrator on the web server. IIS Manager may be found
from the Control Panel\Administrative Tools menu or by running
mmc %systemroot%\system32\inetsrv\iis.msc.
To modify the ASP Response Buffering Limit in IIS Manager
1 In IIS Manager, expand the local computer, and then browse to the Exaquantum virtual
directory, e.g. <local computer>\Sites\Default Site\Exaquantum
2 Open the ASP feature
3 Expand the Limits Properties node to locate the Response Buffering Limit
4 Change the Response Buffering Limit to a higher value (the default value for Response
Buffering Limit is 4194304 – the exact value to be set will depend on the volumes of data
required), for example: Response Buffering Limit ="2147483647" (See Figure 20-1)
Figure 20-1 ASP Settings

5 Apply the changes


To restart IIS
Restart IIS by typing iisreset at a command prompt that has been run as administrator.

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020


20-2 Chapter 20 Enable read of large data volumes by Legacy Web client

This page intentionally left blank

IM 36J04A15-04E 21st Edition Issue 1 January 14th 2020

You might also like