Exaquantum Engineering Guide Vol 4
Exaquantum Engineering Guide Vol 4
IM 36J04A15-04E
th
© Yokogawa January 14 2020
21st Edition Issue 1
Exaquantum Engineering Guide – Volume 4 Web Authoring i
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
Table of Contents
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.
Web Server
Long-term
OLE DB, etc Archive
Administration Tools
Exaquantum/PIMS
(Server)
Exaquantum/PIMS
(Server)
OPC Servers
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.
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.
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.
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.
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>');
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" ;
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.
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.
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
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).
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.
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
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
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
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.
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
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.
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.
Figure 5-9 shows an example of the Expression Editor in Conditional Expression mode.
Figure 5-9 Expression Editor in Conditional Expression Mode
Operator Description
= Equal
<> Not Equal
> Greater than
< Less than
>= Greater than or Equal To
<= Less than or Equal to
AND And
OR Or
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.
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
Caution
Do not overwrite the Exaquantum database.
3 Restart Exaquantum.
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
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).
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.
Exaquantum Web
Plant OPC Servers Server
Firewall
1
2
1
2
Table 11-1 below corresponds to the features indicated in the figures above.
Table 11-1 Web Page Components
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.
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.
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.
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: -
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
ExaquantumDashboard in the Top Bar menu.
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
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.
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.
4 5 14 6 8
3 2
11 15 7
10 12
13
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).
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)
2. A specific pen can be highlighted by hovering the mouse over the pen.
Figure 13-3 Pen Highlight
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
1 3
2
5
4
6
The table below corresponds to the features indicated in the Figure 13-5.
Table 13-2 Alarm and Event Features
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
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
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
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
3. The Tag Selector Webpage is displayed in order to add a pen to the trend as
described in section 13.6 below.
1 2
5 6
3 4
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).
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
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.
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
NOTE - in the Event Search mode, only Alarms and Events with OPC tags that are
connected to Exaquantum Tags are searched.
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
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.
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.
3. In the Edit Pen Dialog click on the Color swatch to change the color of the pen.
Live mode can be entered by clicking on the Live button in the Time Bar.
Figure 13-36 Desktop PC Trend Webpage Time Bar
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.
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.
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.
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
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.
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.
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.
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.
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.
5. On the Trend Webpage, click on the 1 Column button to display the trends
vertically stacked on top of each other.
OR:
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
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.
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
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
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
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
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
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.
For desktop PC, click and drag on the Trend Chart to highlight a section of the trend.
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.
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
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.
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
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
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
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
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
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
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
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
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
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
1 2 3
4 5
6 7
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
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
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.
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
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
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.
Live mode can be entered by clicking on the Live button in the Time Bar.
Figure 14-10 Desktop PC Mimic Time Bar
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
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.
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
Tag List
The Tag List, as shown in Figure 14-17, can be viewed by clicking the Tag List 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’.
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
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
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
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
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
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
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
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.
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
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
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
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 5 6 7 8 9
2
3
11 10 12
13
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).
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
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
3. The Tag Selector Webpage is displayed in order to add a pen to the XY plot as
described in section 16.5 below.
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.
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 2 5 6
3 4
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).
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.
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
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.
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
NOTE. In the Event Search mode, only Alarms and Events with OPC tags that are
connected to Exaquantum Tags are searched.
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
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
3. In the Edit Pen Dialog click on the Color swatch to change the color of the pen.
Figure 16-27 Edit Pen Dialog
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
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.
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:
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
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
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.
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.
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
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.
1 3
The features referenced above are described in the following table Figure 16-45: -
Figure 16-45 XY Plot Legend Features
For desktop PC, click and drag on the XY Plot Chart to highlight a section of the XY plot.
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: -
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
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
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
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
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
Script Description
Limitation Description
Static Primitives
Table 18-2 Static Primitives
Bitmap No
Active Primitives
Table 18-3 Active Primitives
2D-Graph Yes
Instrument Diagram No
Window No
Message No
Dialog Name No
Trend No
Control (ActiveX) No
Overview No
Soft key No
Functions
Table 18-4 Functions
Action Yes(limit-B)
Data Bind No
18.2 Properties
Static Properties
Table 18-5 Static Properties
Size Yes
Position Yes
Size Yes
Tag Object No
Debug No
Arrow Yes
BG color Yes
BG color Yes
Dynamic Properties
Table 18-6 Dynamic Properties
Transparent Yes
Bitmap No
Active Primitives
Table 19-2 Active Primitives
Arrow bar No
Circle bar No
Polyline Graph No
Bar Graph No
Step Graph No
Radar Chart No
Two-Dimensional-Graph No
Touch Target No
Push Button No
Instrument Diagram No
View No
Message No
Trend No
Windows Control No
Overview No
Soft key No
Product Overview No
Tab No
Limitation Description
19.2 Properties
Static Properties
Table 19-4 Static Properties
Size Yes
Scaling Mode No
Window Name No
Window Comment No
Call Call Window No
Window
Instrument Instrument Command Operation No
Command
Operation
Comment No
Generic Name No
Position Yes
Size Yes
Tag Object No
Debug No
Comment No
Transparent No
Hairline Yes
Arrow Size No
Round Corner No
Disjoint Yes
Counterclockwise(Sweep Yes
Direction)
BG color Yes
Transparent Yes
Size Yes
Style Yes
Strikeout No
Underline No
Display BorderStyle No
ForegroundBorderStyle No
Style No
Thickness No
BorderBrush No
ForegroundBorderBrush No
EngineerUnitColor No
Type No
Date Format No
Time Format No
Alignment No
Engineering Unit No
Unit Length No
Reference Point No
Marker Size No
FG Color Yes
BG color Yes
Marker shadow No
Condition No. No
Continue Yes
Blink No
Alarm-specific Blinking No
Screen Blinking No
Overview Blinking No
Transparent No
Modify String No
Y-Axis Value No
Contents No
Limitation Description
d Fill area properties Gradation, Fill, texture and picture are set to solid.