Citect Anywhere Web Client User Guide

Citect AnywhereWeb Client User Guide

Legal Information

DISCLAIMER

AVEVA Group plc makes no representations or warranties with respect to this manual and, to themaximum extentpermitted by law, expressly limits its liability for breach of any warranty that may be implied to the replacement ofthis manual with another. Further, AVEVA Group plc reserves the right to revise this publication at any timewithout incurring an obligation to notify any person of the revision.

COPYRIGHT

© 2019 AVEVA Group plc. All rights reserved.

No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted by any means,electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of AVEVA. Noliability is assumedwith respect to the use of the information contained herein.

Although precaution has been taken in the preparation of this documentation, AVEVA assumes no responsibilityfor errors or omissions. The information in this documentation is subject to change without notice and does notrepresent a commitment on the part of AVEVA. The software described in this documentation is furnished under alicense agreement. This softwaremay be used or copied only in accordance with the terms of such licenseagreement.

ArchestrA, Aquis, Avantis, Citect, Citect HMI, Citect SCADA, DYNSIM, eDNA, EYESIM, InBatch, InduSoft,InStep, IntelaTrac, InTouch, PIPEPHASE, PRiSM, PRO/II, PROVISION, ROMeo, SIM4ME, SimCentral,SimSci, Skelta, SmartGlance, Spiral Software, Termis, WindowMaker, WindowViewer, andWonderware aretrademarks of AVEVA and/or its subsidiaries. An extensive listing of AVEVA trademarks can be found at:https://sw.aveva.com/legal.

All other brands may be trademarks of their respective owners.

Publication date: August 2019

CONTACT INFORMATION

AVEVA Group plcHigh Cross Madingley RoadCambridge CB3OHB. UKhttps://www.aveva.com/

For information on how to contact sales, customer training, and technical support seehttps://sw.aveva.com/contact.

https://www.aveva.com/

https://sw.aveva.com/contact

Validity Note

The present documentation is intended for qualified technical personnel responsible for the implementation,operation andmaintenance of the products described. It contains information necessary for the proper use of theproducts. However, those who wish tomake amore "advanced" use of our products may find it necessary toconsult our nearest distributor in order to obtain additional information.

The contents of this documentation are not contractual and in no way constitute an extension to, orrestriction of, the contractual warranty clauses.

Contents

Legal Information 2

Contents 4

Safety Information 6

Chapter 1: Using AVEVA Citect Anywhere 8

About Citect Anywhere 8

Supported Browsers 9

Browsers Tested with Citect Anywhere 9

Important Notes 9

Chapter 2: Viewing a Citect SCADA Client with Citect Anywhere 10

Logging on to Citect Anywhere 10

Configuring Advanced Settings 11

Securely Connecting to Citect Anywhere 13

Checking Connectivity 14

Viewing a Citect Anywhere Session 15

Citect Anywhere Toolbar 16

4

Citect Anywhere Web Client User Guide

Ending a Citect Anywhere Session 17

Session Auto-logoff 18

Automatic Reconnect 18

Chapter 3: Using Citect Anywhere on Portable Devices 20

Tablet and Smartphones 20

Gestures Support 21

Automatic Display Resize 22

Running Citect Anywhere on Different Web Browsers 23

Android Operating System 23

Google Chromebooks 23

Chromebook Keyboard 24

iOS 24

5


Safety Information

Read these instructions carefully, and familiarize yourself with Citect Anywhere before trying toinstall, operate, or maintain your system. The following special messages may appear throughout thisdocumentation or on the Citect Anywhere application to warn of potential hazards or to call attention toinformation that clarifies or simplifies a procedure.

This is the safety alert symbol. It is used to alert you to potential personal injury hazards.Obey all safety messages that follow this symbol to avoid possible injury or death.

The addition of this symbol to a Danger orWarning safety label indicates that an electricalhazard exists, which will result in personal injury if the instructions are not followed.

DANGER

DANGER indicates an imminently hazardous situation which, if not avoided, will result in death or

serious injury.

WARNING

WARNING indicates a potentially hazardous situation which, if not avoided, can result in death or

serious injury.

CAUTION

CAUTION indicates a potentially hazardous situation which, if not avoided, can result in minor or

moderate injury.

Sa fe t y I n f o rma t i o n • 6


CAUTION

CAUTION, used without the safety alert symbol, indicates a potentially hazardous situation which, if

not avoided, can result in equipment damage.

Please Note

Electrical equipment should be installed, operated, serviced, andmaintained only by qualified personnel. Noresponsibility is assumed by AVEVA for any consequences arising out of the use of this material.

A qualified person is one who has skills and knowledge related to the construction and operation of electricalequipment and the installation, and has received safety training to recognize and avoid the hazardsinvolved.

7 • S a fe t y I n f o rma t i o n


Chapter 1: Using AVEVA Citect Anywhere

This guide describes how to use AVEVA Citect Anywhere to remotely connect to a Citect SCADA client bymeans of an HTML5-compatible web browser.

About Citect Anywhere

Citect Anywhere enables you to remotely access a running Citect SCADA client with amobile deviceincluding tablets and smartphones, and laptop computers. You can view and control the client through aweb browser without needing to install it on your portable device. You can interact with the Citect SCADAclient from anywhere in real-time.

Citect Anywhere provides the following features:

l Provides user access and interaction with Citect SCADA clients from any device that has an HTML5-compatible web browser

l Provides access without the need to install, configure, update, or patch any software on a portabledevice

l Works on platforms that support only web applications such as the Google Chrome operating system.

Citect Anywhere Secure Gateway provides the following alternative functions with Citect Anywhere Server:

l Provides access without the need to purchase, install, configure, andmanage a VPN

l Accesses internal resources using a single Secure Gateway that is installed in a perimeter network,while other resources reside securely behind an internal firewall

l Installs a single Secure Socket Layer (SSL) digital certificate on the Secure Gateway node instead ofinstalling on every host that needs to be accessed.

C h a p te r 1 : U s i n g AVEVA C i t e c t A n yw h e r e • 8


Supported Browsers

With Citect Anywhere, users can access remote Citect SCADA from HTML5 compatible web browsers onany device including smartphones, tablets, and laptop computers. To start a session, navigate to thestart.html file that is installed on the Citect Anywhere Server. To do this, point a browser to the CitectAnywhere Server URL:

https://computer name or IP address:8080

Browsers Tested with Citect Anywhere

l Microsoft Internet Explorer 11

l Microsoft Edge

l Google Chrome

l Safari on Apple iOS

Note: Browser extensions and toolbars may inject JavaScript code into web pages, which can adverselyimpact the behavior of certain web pages. If Citect Anywhere is not working properly, disable or uninstallany active browser extensions or tool bars. Restart the web browser after uninstalling or disabling anextension to confirm that it is no longer active.

Important Notes

Certain versions of the above listed browsers, such as Safari and Chrome, are in theory functionallycompatible with Citect Anywhere. Youmay be able to use them, but specific behaviors are unknownbecause different browser versions have not been tested with Citect Anywhere. We strongly recommendthat you upgrade to themost recent version.

Although Citect Anywhere supports the listed browsers, you should review the Running Citect Anywhere onDifferent Web Browsers section of this guide on page 23 for behaviors and alternatives specific to eachbrowser.

Multiple Citect Anywhere sessions may be opened in different tabs within the web browser, or in differentbrowser windows. When a session is not in use (its tab or window is not displayed), it will reduce its CPUandmemory utilization on the server.

9 • S u p p o r t e d B r o w se r s


Chapter 2: Viewing a Citect SCADA Client withCitect Anywhere

This chapter describes how to log on to Citect Anywhere from any device with an HTML5-compatible webbrowser. It includes a step-by-step procedure to log on, advanced connection settings, and how to securelyconnect to Citect Anywhere.

Logging on to Citect Anywhere

To log on to the Citect Anywhere ConnectionWeb Page, follow these steps:

Note: If you have any trouble remotely connecting to the Citect Anywhere environment, see CheckingConnectivity on page 14 for help.

1. Navigate to https://<Citect Anywhere Server Node Name>:8080/. The Logon dialog appears.

2. Enter the connection parameters.


10

CONNECTION

PARAMETERSDESCRIPTION

User NameCredentials to log on to the RDP host. If the Secure Gateway is in a differentdomain to the Authentication Server/Citect Anywhere Server, the domainneeds to be specified (for example, domain\user).

PasswordCorresponding password for the user name. This value should not be savedfor future connections.

3. Tap or click Connect to initiate the connection. The progress indicator is displayed before connection isestablished.

Configuring Advanced Settings

To configure advanced settings:

1. Click . The following tabs appear as shown below:

2. Click on each tab to view the settings available for configuration. For example, to view Display settings,click theDisplay tab.

To return to the Settings dialog, click the following icon.

To close the Settings dialog and return to the Logon dialog, click the close icon.

1 1 • C o n f i g u r i n g Ad v a n c e d Se t t i n g s


3. Complete the required settings.

Security Settings

OPTION(S) DESCRIPTION

Enable SSL encryptionfor remote session

Select this option to allow the client to use Secure Socket Layer (SSL)encryptedWebSocket communication to the Citect Anywhere Server.As a default, this option is selected.

Language & Audio Options


DisplayLanguage

Select the language in which you wish to view the Citect Anywhere interface. The DisplayLanguage only applies to the logon web page, and is not propagated to the Citect SCADAclient.

KeyboardLocale

Select the keyboard region to be used in the session (keyboard_locale). If you select a non-English keyboard locale, your computer will need to be configured to use amatchingkeyboard in theWindows Region & Language settings. Some keyboards may not workcorrectly with Internet Explorer or Edge browsers.

Usekeyboardscan-codes

Enables scan codes. Certain applications use scan codes and will require this setting to beenabled.

RemoteAudioPlayback

Configure where the session’s sound will play: local computer, remote computer, or do notplay. Audio playback is not supported with Internet Explorer version 11.

Display Options


Acceleration/ Quality

The acceleration, or degree of quality can be specified by selecting options from a dropdown list. Faster acceleration will result in lower quality images.

C o n f i g u r i n g Ad v a n c e d Se t t i n g s • 1 2



ScreenResolution

Sets the resolution size of the Citect Anywhere session. Select a value from the dropdown list of values. For example: "800 x 600". Select a screen resolution that matchesyour Citect project. The default may be configured by the administrator to already matchyour Citect Project.

Automaticsessionresize

Enables/disables automatic display resizing. By default, automatic resizing is selected(enabled). This means whenever the browser window is resized, the Citect Anywheresession will automatically adjust itself to the new dimensions. See "Automatic DisplayResize" in the Citect Anywhere Server Install Guide for more information.

Note: For details about the version of Citect Anywhere you are running, click theAbout tab in the Settingsdialog.

Click theReset All Settings tab to revert to the default settings.

Depending upon the privileges your administrator has assigned, a Citect SCADA view-only client or controlclient will be launched. A view-only client is a computer configured with view-only access to the CitectSCADA runtime system. No control of the system is possible, but access to datamonitoring is available. Acontrol client is the interface between the Citect SCADA runtime system and an operator. If you are usingCitect SCADA on a network, every Citect SCADA computer (on the network) is a control client.

Access to either client depends upon the permissions granted to you by your administrator. For moreinformation, refer to the Citect Anywhere Installation and Configuration Guide.

Note: Click theHelp tab in the Settings dialog to view theCitect AnywhereWebClient User Guide.

Securely Connecting to Citect Anywhere

Citect Anywhere is compatible with most VPNs. SSL and VPNs that will not support WebSockets requirethe Secure Gateway as well. Juniper IVE version 7.4 (and later) supports WebSockets, so the SecureGateway is not required.

Citect Anywhere has been tested with Juniper's SA SSL VPNs. For more information about Juniper’sVPNs, see theSSL VPN Configuration section in the Citect Anywhere Server Installation and Configuration

1 3 • S e c u r e l y C o n n e c t i n g to C i t e c t A n yw h e r e


Guide. Configuration with other third-party SSL VPN appliances will be similar to the procedures describedhere (differences aremostly in terminology).

Checking Connectivity

If you have any trouble connecting remotely to Citect Anywhere, you can connect to a Citect Anywheredemonstration on the following site:

https://sw.aveva.com/web-visualization-demos

After registration, locate the Citect SCADA demonstration page and use the Citect Anywhere link tonavigate to the demo site. Before you login, you will need to go to the Citect Anywhere client settings andturn off Enable SSL encryption for remote session.

If the demo site appears and you can successfully launch Citect SCADA, the browser is compatible withCitect Anywhere.

If the demo site works, verify that the following are true for your own system:

l You can locally connect at the Citect Anywhere node itself by using a browser listed in the SupportedBrowsers section.

l The Citect Anywhere service is running.

l Windows Firewall is configured correctly.

C h e c k i n g C o n n e c t i v i t y • 1 4


https://sw.aveva.com/web-visualization-demos

l The Citect Anywhere port between your browser and the Citect Anywhere environment is available. Thedefault port is 8080.

l A trusted certificate may be required for the Citect Anywhere Secure Gateway or the Citect AnywhereServer.

l Verify network connectivity.

l Verify that the client device can reach the Citect Anywhere Server or the Citect Anywhere SecureGateway node. ThePing and Traceroute commands are useful in aWindows-based system. Thirdparty tools exist for certain mobile devices to provide equivalent functionality. If you cannot reach anode by name, try using its IP address.

Viewing a Citect Anywhere Session

After successfully logging on, an RDP session is launched and Citect SCADA starts at the remotemachine. The Citect SCADA client appears within a browser window as shown below.

While it is connected, Citect Anywhere intercepts themouse, button, and keyboard events, and transmitsthem to the RDP host. As a result, various keyboard keys andmouse buttons that are usually handled bythe browser will behave differently. For example, clicking the F5 button normally causes the browser toreload the current page, but when using Citect Anywhere F5 will not reload the page. Instead, the keyboardcommandwill be transmitted to and handled by the remote Citect SCADA client.

1 5 • V i e w i n g a C i t e c t A n yw h e r e Se s s i o n


Note: In most browsers, clicking theBack, Forward, orReload browser buttons will cause CitectAnywhere Server to display amessage asking if you wish to leave the current page. If you decide toproceed, the remote session will be disconnected. (Some browsers may not prompt for confirmation).

When accessed by Citect Anywhere, a Citect SCADA client cannot beminimized. If the remote CitectSCADA client is shut down at the server end, your session will be terminated automatically inapproximately three seconds. Closing the browser in your remote session will end the RDP session, closethe client and return a Citect Anywhere license that can be used by another user.

Citect Anywhere Toolbar

After connection to a Citect SCADA client is established, click to view the Citect Anywhere

toolbar.

You can show or hide the branches of the toolbar by clicking the arrows at the end of each branch.

The Citect Anywhere toolbar includes the following buttons:

BUTTON DESCRIPTION

Closes the Citect SCADA client

Navigates to the next element in the tab order

Ends the Citect Anywhere session

C i t e c t A n yw h e r e To o l b a r • 1 6


If the toolbar appears on amobile device (such as an Android tablet or iPad), it will include additionalbuttons.

BUTTON DESCRIPTION

Displays instructions for using gestures

Allows you to copy text to the remote clipboard

Displays the on-screen keyboard

Changes the cursor operation from tapmode to drag-and-select mode.

Ending a Citect Anywhere Session

To log out or disconnect, click the following:

A message appears prompting you to confirm the action.

1 7 • E n d i n g a C i t e c t A n yw h e r e Se s s i o n


The browser returns to the connection dialog after you click Yes.

No trace of a session remains on your device after ending a session. For additional protection, close thebrowser tab or window that previously ran the Citect Anywhere Server session.

Session Auto-logoff

A session is logged off when you close the Citect SCADA client. Citect Anywhere Server includes an auto-logoff feature that automatically logs off the session if nothing is displayed on the screen for a specifiedperiod.

Automatic Reconnect

Active Citect Anywhere sessions automatically attempt to recover from temporary network outages byreconnecting to your session. Youmay experience a slight delay during the reconnect attempt, but after thesession is re-established, you can continue working without having to log back on to the session.

Se s s i o n Au to - l o g o f f • 1 8


19


Chapter 3: Using Citect Anywhere on PortableDevices

This chapter describes the behavior and functionality of Citect Anywhere on different mobile devices, webbrowsers, and operating systems.

Tablet and Smartphones

Citect Anywhere can operate on portable devices with an HTML5-compliant browser (for example, Safari oniPad). For the list of supported browsers, see Browsers Tested with Citect Anywhere.

Note: Citect Anywhere is supported on Android versions 4.2.2 and higher.

Mobile devices enable you to remotely access and interact with Citect SCADA clients. Touch gestures areused to perform the tasks normally done by amouse using a desktop or laptop computer. Built-in softwarekeyboards are used instead of physical keyboards. Certain mouse events will not have an equivalent on atouch device. Software keyboards in mobile devices will not have F1-F12, CTRL, or ALT keys. In addition,mouse hover and tool tips are not supported on touch devices.

Be aware of these differences when using Citect Anywhere to remotely view the Citect SCADA client.Also, become familiar with the way your device implements touch interfaces. Keep this in mind for thedesign of Citect SCADA projects for use with Citect Anywhere. For example, Input animations should notneed to invoke a Citect SCADA orWindows keyboard as mobile devices have their own.

For existing Citect SCADA clients that make use of mouse events, keys, and/or key combinations withouta supported equivalent in a touch environment, youmay want to modify your client to use alternate eventsthat will work in a touch environment.


20

The following list provides tips on using Citect Anywhere on a tablet or smartphone device without aphysical keyboard or mouse. Functionality will vary across different devices and some commands may notbe available.

l Single Tap performs a left click.

l Single long Tap performs a right-click.

l Tap + Hold + Drag performs a select then drag/scroll function.

l Double Tap, or tapping once with two fingers, performs double-click.

l Tap with three fingers sends Back command to a remote browser.

l Swipe downwith three fingers is Page Up.

l Swipe up with three fingers is Page Down.

l Drag left or right with three fingers performs a left arrow and right arrow respectively.

l Tap the keyboard icon (upper right-hand corner of window) to open/close the virtual keyboard.

l Swipe and pinch gestures will apply to the Citect Anywhere session (i.e. zoom in with pinch in).

Note: (For iOS only) when saving a Citect Anywhere icon to the iOS desktop, the shortcut will open theCitect Anywhere session in full-screenmode. The browser’s toolbar will be hidden and there will bemoreremote desktop area available.

Gestures Support

Citect Anywhere supports many different gestures when used on a touch device, such as a tablet. Tap theGestures help icon in the Toolbar to see the complete list of supported gestures.

2 1 • Ge s tu r e s Su p p o r t


Automatic Display Resize

Citect Anywhere supports automatic display re-size. Whenever a browser window is re-sized, the CitectAnywhere session automatically adjusts itself to the new dimensions (assuming the Citect SCADARuntime window is set to full screen).

To re-size a browser window, drag any corner of the browser window and release it when the desireddimensions are reached. If a browser is placed into full screenmode, the Citect Anywhere session willautomatically expand to the full screen. Be aware that resizing is subject to the display limitations of theCitect runtime system.

You can enable/disable automatic resizing via theDisplay settings for the Citect AnywhereWebClient.See Logging on to Citect Anywhere.

Au toma t i c D i s p l a y R e s i z e • 2 2


Running Citect Anywhere on Different Web Browsers

This section describes browser-specific behaviors in Citect Anywhere. The behaviors are grouped byoperating systems. Alternative solutions are provided when available.

Android Operating System

This table shows the behavior of different Android browsers.

BROWSER(S) BEHAVIOR TYPE DESCRIPTION

All Drag and drop

Youmay experience difficulty dragging and droppingpop-up windows on the Android operating system. As aworkaround, using a stylus to perform the drag and dropoperations may improve the functionality.

Chrome Scroll bars

Scroll bars in Citect SCADA cannot be scrolled bytapping or pressing and dragging the scroll button.Tapping on the gray area of the scroll bar itself willprovide scroll functionality.

Chrome Text display

When an Android tablet runs low onmemory, text in awindow can appear blurred. As a workaround, youshould close the running applications and restart thedevice.

Chrome Text input

Typing double-byte language characters using the nativeAndroid software keypad are rendered as the questionmark character (?) in a Citect SCADA data entry field.As a workaround, configure Citect Anywhere Server touse theWindows Keyboard option. Double-bytelanguage characters can be entered correctly from theAndroid keypadOR by using a paired Bluetoothhardware keyboard.

Google Chromebooks

Citect Anywhere operates onGoogle Chromebook and Chromebox just like it does with a Google Chromebrowser. Here are some tips to keep inmind when using Citect Anywhere with a Chromebook orChromebox.

2 3 • R u n n i n g C i t e c t A n yw h e r e o n D i f f e r e n t We b B r o w se r s


FUNCTION DESCRIPTION

Mouse Left-click Click the Chromebook trackpad with one finger.

Mouse Right-click Click the Chromebook trackpad with two fingers

Scrolling a document or websiteDrag two fingers on the Chromebook trackpad up or down toscroll

Configure Chromebook In the address field: chrome://settings

Chromebook Keyboard

The Chromebook keyboard lacks several keys that are used by Windows. ChromeOS provides standardmappings that use existing keys with theALT key to represent certain missing keys. Citect Anywheresupports these key combinations:

COMMAND KEY COMBINATION

Delete (DEL) ALT+Backspace

Page Up ALT+Up

Page Down ALT+Down

Home CTRL+ALT+Up

End CTRL+ALT+Down

In addition, Citect Anywhere provides special non-standardmappings for additional key combinations onChromeOS.

COMMAND KEY COMBINATION

F1 CTRL+1

F2, … CTRL+2, …

ALT+TAB ALT+`

ALT+SHIFT+TAB ALT+SHIFT+`

CTRL+Home CTRL+ATL+Left

CTRL+End CTRL+ALT+Right

iOS

This table shows the specific behavior of Safari browsers running on the iOS operating system.

C h r ome b o o k Ke y b o a r d • 2 4


BEHAVIOR DESCRIPTION

AccessingCitectAnywhere

Youmay experience difficulty accessing Citect Anywhere. This can occur if the PrivateBrowsing option is left in Enabled state. Private browsing is enabled if Safari bars appearblack or dark instead of blue or gray. As a workaround, navigate to Settings, then Safari,and disable private browsing.

Refreshcurrentpage

When you click to refresh or navigate away from the current page while connected to theCitect Anywhere server, you will not be prompted to confirm your action, whichmay resultin unwanted page navigation. There is no workaround.

InvokingCitectSCADAkeyboard

A user input animationmay not bring up the Citect SCADA keyboard and the alphabetic re-sizeable keyboard is not functional. The recommended workaround is to use the device'sbuilt-in keyboard.

Movingbetweentext boxes

The Next and Previous buttons are not enabled tomove between text boxes on dialogboxes with multiple text boxes. As a workaround, use a touch gesture to transfer focus.

Certificates

When connecting through the Secure Gateway, self-signed certificates are not supportedon iOS. They will result in the error message "Gateway: HTTP sessions are disabled".

This error message will also be shownwhen using domain-issued certificates if the domainroot certificate is not installed on your device. Contact your system administrator to installthe root certificate.

2 5 • i OS


Citect Anywhere Web Client User Guide

Documents

Transcript of Citect Anywhere Web Client User Guide