CitectSCADA Web Client Users Guide
CitectSCADA Web Client Users Guide
3 Fitzsimons Lane
PO Box 174
Pymble NSW 2073
Australia
COPYRIGHT
© Copyright 2004 Citect Corporation. All rights reserved.
TRADEMARKS
Citect Pty. Limited has made every effort to supply trademark information about company names, products and services mentioned in this manual.
Trademarks shown below were derived from various sources.
IBM, IBM PC and IBM PC AT are registered trademarks of International Business Machines Corporation.
MS-DOS, Windows, Windows 95, Windows NT, Windows 98, Windows 2000, Windows for Workgroups, LAN Manager, Microsoft Windows XP, Excel
and MSMAIL are trademarks of Microsoft Corporation.
Novell, Netware and Netware Lite are registered trademarks of Novell Inc.
GENERAL NOTICE
Some product names used in this manual are used for identification purposes only and may be trademarks of their respective companies.
Printed in Australia.
Contents
General issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
CitectSCADA Web Client
The CitectSCADA Web Client allows you to view a live CitectSCADA project
within a Web browser. It provides easy access to CitectSCADA Runtime for
LAN‐connected users requiring read/write access to current production
information.
For example, a senior manager could monitor a facility and access current
production information from any computer on the LAN. This is achieved
without requiring extensive downloads or software installation.
See Also System architecture
Getting Started
What’s been installed?
The following diagram shows further details of how these components interact.
CitectSCADA Web Client communications architecture.
Once the Web Client has connected to the Runtime servers, steps two and three
become an ongoing process, with the required content being called upon as the
user navigates through the various pages of a project.
Note that this diagram has the system components set up on different
computers purely for the sake of explaining the communications model. In
reality, the flexibility of the architecture will allow these components to be
distributed in any required arrangement; they can even share a common
location.
See Also Installation
Installation The only component of the Web Client system that requires software installation
is the Web Server. The Web Server can be located on any computer on the LAN.
Note: If the CitectSCADA Web server and CitectSCADA server are set up on
different machines, the two machines must be on the same domain so that the
4 CitectSCADA Web Client
CitectSCADA Web server can access the directory on the CitectSCADA server
that contains the web deployment files.
Requirements
If you have not yet installed the Web Server software, ensure the computer meets
the following requirements.
Hardware requirements
Minimum: Pentium II 500MHz, 256MB RAM, 25MB HD (free)
Recommended: Pentium IV 1GHz, 512MB RAM, 1GB HD (free)
Note: The memory requirements are dependent upon how many simultaneous
Web Client connections are expected.
Software requirements
Web Server 1. Windows 2000 Pro, XP Pro, 2000 Server, or 2003 Server
2. Microsoft Internet Information Services (IIS) (Version 5 or later)
3. Microsoft Internet Explorer (Version 6.0 or later)
4. NTFS file system
Note: The target drive for the Web Server software must use an NTFS file system,
otherwise you won’t have full access to the required Windows security settings (i.e. the
Folder Properties dialog will not have a Security tab). If you are currently using a FAT/
FAT32 system, ensure you convert the drive to NTFS before installion of the Web Server
software.
Web Client 1. Windows 2000 Pro, XP Pro, 2000 Server, 2003 Server or NT 4 (Service Pack 6)
2. Microsoft Internet Explorer (Version 6.0 or later)
Note: By default, CitectSCADA uses NetBIOS to facilitate communications over a network.
To use the Web Server, you need to switch your system over to TCP/IP. For more
information, see Using TCP/IP for network communications.
To install CitectSCADA Web Server:
1 Launch the Web Server installer on the host computer.
2 Select the destination folder for the installation. By default, this will be
“C:\Program Files\Citect\CitectSCADA\WebServer”. (See the Note
above.)
3 The installer allows you to choose a Complete or Custom installation.
Choose Custom if you would like to install specific components of the Web
Server system, for example, just the Web Client component.
4 Click Install to run the installation.
See Also What’s been installed?
The WebServer directory primarily hosts the administrative pages that are
displayed by a Web Server.
The cgi‐bin and images directories contain the content required to display
these pages.
The client folder contains the client components (.cab files) that are
delivered to a remote computer to run a deployment. Any subdirectories
includes the components associated with the a particular release (in this
case, Version 6.00).
The Deploy folder includes the files associated with any deployments
(CitectSCADA projects) that have been configured on the Web Server.
The #DisplayClient folder (located in the Deploy folder) plays a key role in
the Web Server security, as the permissions defined for this folder determine
the access rights for each user.
The locales folder contains the files required to support different languages
for the client interface. See also Implementing multiple language support.
menu. The CitectSCADA virtual directory should appear under the list of
default web sites.
You can view the properties for the directory by selecting Properties from the
right‐click menu.
The Virtual Directory will inherit all security settings from the computer’s
default web site, with the following exceptions:
Directory Browsing is enabled
Script Source Access is disabled
The default document is set to default.htm only
Anonymous access is disabled
Integrated Authentication is disabled
Basic Authentication is enabled
These security settings, including integrated authentication, anonymous access
and SSL Encryption, may be customized by the local administrator. However,
proper configuration will require some experience with IIS and an
understanding of the implications of adjusting its settings.
CitectSCADA Web Client 7
Security
Security on the CitectSCADA Web Server is handled by IIS security, which is
tightly integrated with Windows’ user‐based authentication.
Note: While the Web Client security architecture controls access to your projects
on the Web Server, it is important to note that CitectSCADA’s system security
(privilege/area settings) still manages protection of the control system,
maintaining a primary level of security.
The installation and initial configuration of the Web Server must be performed
by a Windows user with local administrator permissions; that is, they must be
able to add and edit Windows’ User accounts, and modify file/folder protection.
This capability is required to set up Web Client user accounts and manage
security settings.
See Also Web Client user account types
Setting up Security
Configuring client account user groups
Preparing the Web Server folder
Setting up access rights for client accounts
Testing the Web Server security settings
The Web Server tests the access rights for each user when they log in and then
displays or hides the appropriate buttons on the home page accordingly.
Note: It is important to understand the distinction between the role of the
Windows Local Administrator, and the Web Client’s Administrator users. The
Windows Administrator configures security on the Web Server and sets up
client accounts. A Web Client Administrator is an end user with the capability to
modify and manage the projects deployed on the Web Server. The two roles
draw parallels to a Citect configuration engineer, and a runtime operator.
In the table, read means Read & Execute, List Folder Contents and Read user
permissions are allowed, read and write means Full Control is allowed, and
access denied means Full Control is denied.
Installed directory ADMINISTRATOR DISPLAY MANAGER
WebServer read read read
WebServer \ cgi-bin read read read
WebServer \ client read read read
WebServer \ deploy read and write read read
WebServer \ deploy \ #DisplayClient read read access denied
WebServer \ images read read read
For example, an administrator client needs to be able to read all the installed
folders to fully access the components of the home page. Additionally, they need
write access to the Deploy subdirectory to facilitate the creation of new
deployments.
By comparison, a manager client must be denied access to the #DisplayClient
folder to prevent the ability to write back to a CitectSCADA project.
Therefore, when setting up security on the Web Server, you need to make sure
your user accounts align appropriately with the permissions outlined in the
table above.
The easiest way to do this is through the use of Windows User Groups. If you
create a user group for each type of client, you can then add or remove
individuals from the groups as required instead of dealing with the security
settings for each on an individual basis.
See Also Setting up Security
3 Right click on the Groups folder and select New Group. This will call up the
New Group dialog.
4 In the Group Name type “Web Client Administrator” (or something
appropriate), and provide a description of the group’s purpose.
5 Click the Create button.
The group you have just created should now appear in the list of groups
presented in the Computer Management console.
6 Repeat steps three to five to create Display Client and Manager Client user
groups.
10 CitectSCADA Web Client
7 To eventually test your security settings, you should add at least one user to
each group.
You are now ready to start Preparing the Web Server folder.
5 It is likely there will be a number of groups already defined in this folder.
The two you need to pay particular attention to are the Administrators
group and the Everyone group.
The Administrators group represents all the Windows users recognized
by the Web Server computer with Local Administrator rights. This
group has Full Control permissions on the folder, facilitating the ability
to adjust the Web Server security settings. If this is the case, there should
be no reason to modify this group.
The Everyone group represents all other users recognized by the local
machine. It is recommended that you provide this group with “read”
access to the WebServer folder; that is, allow Read & Execute, List
Folders Contents, and Read permissions. This will provide all local
users on the Web Server machine with the equivalent of Display Client
permissions.
12 CitectSCADA Web Client
If there are any other groups defined for the Web Server folder, for example
” Power Users”, you may want to remove these groups to simplify the
management of your Web Client accounts.
6 You then need to add the three groups you have created to the WebServer
folder.
To do this, go to the Security tab of the WebServer folder properties, and
select Add. Using the dialog that appears, locate the user groups you created
on the local machine. The Advanced button allows you to search for defined
groups.
Note: The Select Users or Groups dialog appears differently in Windows
2000 to the Windows XP version pictured above. In Windows 2000, you can
simply select a user or group from the list of those available and click Add.
7 Next, confirm the security settings for the three newly created groups. Each
should have the same read access as the Everyone group, which is allow
Read & Execute, List Folders Contents, and Read permissions.
8 You then need to ensure all the sub‐directories inherit the permissions set for
the WebServer folder. This ensures consistent security settings across all the
installed directories.
To do this, click on the folder properties’ Advanced button, and select
Replace permission entries on all child objects..., then OK.
Note: With Windows 2000, this option will read Reset permissions on all
child objects and enable propagation....
A Security dialog may appear warning that this will “remove explicitly
defined permissions on child objects”. Select Yes to continue.
CitectSCADA Web Client 13
The Web Server’s installed directories should now have consistent security
settings for all the required user groups.
Next, you will need to modify the security setting for two specific folders to
implement the required permissions for the different client account types.
See Also Setting up access rights for client accounts.
A Security dialog will appear warning “Deny entries take priority over all
Allow entries”. Select Yes to continue.
Note: If you want to delete a user account from the Web Server and security is a
concern, you should set the user’s access rights to Deny Full Control before you
remove them from a group. This avoids a known problem where the operating
system doesn’t immediately acknowlege that a user account has been deleted,
creating a short period where a deleted user can still log on. With all access
denied, they will not be able to take any action even if they are able to gain
access.
You have now successfully configured the security settings for the client groups
on the Web Server. Next, you should commence Testing the Web Server security
settings.
http://<machine IP address>/CitectSCADA
If they are logging on to the Web Server computer, the address is:
http://localhost/CitectSCADA
User name and password
Once the browser has arrived at the Web Server, the end user will be asked
to provide a user name and password. Typically, you will just need to inform
them that their Windows user name and password will provide appropriate
access. If you had to create a new user profile for a particular person, you
will have to provide them with the details.
[DNS]
<SCADA I/O server name>=<IP address>
<alarm server name>Alarm=<IP address>
<report server name>Report=<IP address>
<trend server name>Trend=<IP address>
Note: If the project is set up for redundancy, both servers must appear in the
[DNS] section of the Citect.ini file.
16 CitectSCADA Web Client
See the topic Using TCP/IP for network communications in the CitectSCADA
User Guide for more information on setting your DNS parameters.
Feature Limitations
The following features are not supported:
Cicode Debugger
Remote shutdown
Fuzzy Logic
Cluster functionality
Kernel windows
Web Client is unable to act as a CitectSCADA Server
Pages based on the default Menu Page template will only show buttons for
pages previously visited
The Page Select button on the default Normal template will only list pages
previously visited
The CSV_Include project’s Update Page List menu item will not work
Note: If your project is based on the CSV_Include template, you will need to
create a customized menu to access pages from the menu bar.
Note: If you’re project has any included projects that use ActiveX objects,
you need to ensure they are also zipped up in an Activex.zip file within the
included project’s directory.
The files are now ready for deployment on the Web Server.
To prepare any included ActiveX objects for deployment:
1 Identify all the ActiveX object associated with the project you would like to
deploy.
2 Use a compression tool to zip these files up into a single file called
ActiveX.zip.
3 Place ActiveX.zip in the main folder for the project. For example, in the case
of the CSV_Include project, this would be:
C:\Program Files\Citect\CitectSCADA\User\CSV_Include
Note: If an ActiveX object has an associated data source, you need to ensure the
data source can be located by the computer hosting the Web Client. See the topic
Managing associated data sources under the section on ActiveX objects in the
CitectSCADA User Guide Help.
See Also Running the Web Deployment Preparation tool
4 A progress indicator will appear. The size of the project will significantly
affect how long this process will take; a very large project with many files
may take well over ten minutes to process, depending on the hardware
available. Note you have the option to abort the process.
CitectSCADA Web Client 19
5 When complete, a dialog will appear informing you the preparation was
successful. Click OK.
The project is now ready for deployment on the Web Server.
Hint: You also have the option to automatically run the Web Deployment
Preparation tool every time you compile a project. To do this, go to the Citect
Project Editor Tools menu and select Options. Select the Prepare for Web
Deployment option and click OK. Note, however, that this will dramatically
increase the amount of time taken for each compile, particularly for large
projects.
See Also Configuring a deployment
Configuring a deployment
A deployment represents the implementation of a CitectSCADA project on the
Web Server. It incorporates the files and components required to display a
project, and then stores the location of the servers where CitectSCADA Runtime
data is generated.
The deployments configured on a Web Server are listed on the Web Client home
page, which is the page that appears when you initially log in. The configuration
details for a deployment can be displayed by clicking the small plus icon to the
left of the deployment name.
The type of action you can implement for a deployment depends on the
permissions granted by your log in. For example, if you log in as a Manager
Client, you will only be able to view a deployment. If you are an administrator,
you will be able to edit deployments and create new ones.
20 CitectSCADA Web Client
The following list describes the functionality associated with each of the icons
presented on the home page.:
Add New Deployment - takes you to the Deployment Configuration page
where you can create a new deployment (Administrator Clients only).
Help - launches a PDF file explaining how to configure and use the Web
Client.
Start Display Client - Displays the selected deployment with Display Client
permissions (Display Client and Administrator Client only)
Additionally, the System Messages panel provides notification of events that
impact the current status of the Web Server.
See Also Preparing a CitectSCADA project for deployment
Creating a new deployment
Deploying a project from within CitectSCADA
Displaying a deployment
Editing an existing deployment
Updating a deployment to reflect project changes
Deleting a deployment
This will take you to the Deployment Configuration page.
2 Key in a name in the Deployment field, and include a Description if
required.
Note: A deployment name cannot contain any of the following characters:
\ * ? | . / " ' : ; < > # &
3 Identify the source of the CitectSCADA project’s content in the Project Path
field.
If the project is located locally on the Web Server computer, you can use a
normal path address. The path must point directly to the project within the
CitectSCADA User directory. For example, the location of the Example
project would be:
C:\Program Files\Citect\CitectSCADA\User\Example
Note: If you are remotely administering the Web Server and you use a local
path address, make sure it relates to the Web Server computer, not the
computer you are currently using.
If you need to address a computer on a network, you need to share the path
of the Example project. For example, if the project resides on the
CitectSCADA server (Program Files\Citect\CitectSCADA\User\Example),
you would create a share (called WebShare, for example) and then use the
following project path:
\\ComputerName\WebShare
4 Identify the CitectSCADA servers associated with the deployment. You have
the option to provide a name in the Server field (as defined in your
CitectSCADA project), the IP Address of the server, and the Port number.
There are, however, two scenarios you need to consider here:
Have the IP addresses for the project servers already been identified in
the [DNS] section of the Citect.ini file? If you have already done this in
the process of setting up TCP/IP, you don’t need to identify any servers
as the IP addresses can be retrieved from the Citect.ini file. See Using
22 CitectSCADA Web Client
TCP/IP for network communications in the CitectSCADA User Guide
Help for information on using the [DNS] parameters.
Note: If you include an IP address for a server in the configuration of
your deployment, it will take precedence over a different address
identified for the same server in the [DNS] section of your Citect.ini file.
Are your CitectSCADA servers protected behind a firewall? If so, with
each server name you will need to provide the public address and port
number for your firewall. The firewall should be configured to handle
the mapping to private IP address and port number for each Citect
server.
5 Add any additional servers to your deployment by clicking the Add New
Server button, and repeating step four for each server.
Typically, a CitectSCADA project will incorporate an I/O server, alarms
server, trends server and report server. You must identify each of the servers
associated with the project.
6 Use the Client Control field to specify the use of a particular version of the
Web Client component when the deployment is displayed.
The drop‐down menu includes a list of all the different versions of the Web
Client control currently installed on the Web Server. Typically, you should
select the version of the control that coincides with the version of
CitectSCADA your project was compiled on.
7 Once you have finished configuring the deployment, click on the Apply
Changes button.
This is important, as your changes will be lost if you jump straight back to
the home page.
This triggers a process where all the project files are retrieved from the path
indicated, and copied to the Web Server ready for access by the Web Clients.
A dialog will pop up to indicate how this process is progressing.
Once this is complete, information about the size of the project will appear
in the File Paths banner above the Project Path field. The number to the left
indicates how many files are included in the project, the number to the right
indicates the total size of the project.
CitectSCADA Web Client 23
The deployment will have now been saved. When you return to the Web Client
home page, by clicking on the home icon, your new deployment will be among
those listed.
See Also Deploying a project from within CitectSCADA
Displaying a deployment
Note: You also have the option to automatically run the Web Deployment
Preparation process every time you compile a project. To do this, go to the
Citect Project Editor Tools menu and select Options. Select the Prepare for
Web Deployment option and click OK. Be aware, however, that this may
signifcantly increase the amount of time required for a project to compile.
Your project should now appear as a deployment within the Web Client home
page next time you log in.
See Also Displaying a deployment
Displaying a When you display a deployment, you trigger the process of downloading the
required Web Client component file from the Web Server, enabling you to run
deployment
the associated CitectSCADA project in your Web browser.
To display a deployment:
1 Locate the deployment you would like to display in the list of available
deployments.
2 Click on the relevant icon (Start Display Client or Start Manager Client) to
display the deployment.
The display options available to you will depend on your log in permissions.
If you select the Manager Client icon (the one with the gold lock), you will
only be able to read the current values for the CitectSCADA project.
Once the required project files and components have been downloaded, the
CitectSCADA project will appear. You can now navigate through the project
pages as required.
Note: An error message may appear if the current user on the client machine
does not have Windows administrator rights when a new or updated
component file (.cab file) is downloaded. Ensure the current Windows user has
administrator rights if a new deployment is run or an updated .cab file needs to
be downloaded.
See Also Editing an existing deployment
To edit an existing deployment
1 Locate and select the deployment you need to edit in the list of available
deployments.
2 Click on the Edit Deployment icon.
This will take you to the Deployment Configuration page.
Make adjustments to the fields as required. If you require an explanation of
any of the fields, see Creating a new deployment.
Note: If you give a deployment a new Name, it will be duplicated instead
being updated and overwritten. This allows you to easily make a copy of an
existing deployment, however, you will have to delete the original
deployment with the old name if it’s no longer required.
3 Once you have finished making your changes, click on the Apply Changes
icon.
This is important, as your changes will be lost if you jump straight back to
the home page.
The Web Server will retrieve a fresh set of pages and components for the
CitectSCADA project, which will include any recent changes.
See Also Updating a deployment to reflect project changes
This will take you to the Deployment Configuration page.
CitectSCADA Web Client 27
3 Click on the Apply Changes icon.
The Web Server will retrieve a fresh set of pages and components for the
CitectSCADA project, which will include any recent changes.
See Also Editing an existing deployment
Deleting a deployment
A dialog will ask you to confirm that you want to Delete the deployment.
Click OK.
See Also Configuring a deployment
Using a language different to the current system locale setting
Implementing a non‐default language
Having failed to exactly match ʺzh‐cnʺ, the script will try to load Simplified
Chinese language, ʺzhʺ, as an appropriate match. The interface will
automatically display in Chinese.
See Also Using a language different to the current system locale setting
2 Use a URL query to indicate which language you’d like to use for the Web
Client deployment pages. For example, if the address field on your browser
currently reads the following:
http://localhost/CitectSCADA
add a ʺ/?lang=" query to the end of the address. For example, Chinese
would be:
http://localhost/CitectSCADA/?lang=zh
Note: If you use a code that represents a regional variation of one of the
default languages, and that specific code cannot be exactly matched, the
Web Server will only be able to implement the available default version of
the language. For example, using the language code for Chinese (PRC), ʺzh‐
cnʺ, will result in the Simplified Chinese being used, ʺzhʺ.
Your Web Browser will now display the Web Client’s deployment configuration
pages with the appropriate language displayed.
See Also Implementing a non‐default language
to use the Taiwanese variation of Chinese, you should call the file zh‐
twmsg.xml.
3 You’re now ready to make the required changes to the content of the file.
Firstly, you’ll need to set the correct encoding format.
The encoding format is defined in the top line of the file, which appears as
follows:
<?xml version="1.0" encoding="iso-8859-1" ?>
If the language uses English characters, the format you would use is ANSI,
which is defined as “iso‐8859‐1” (see example above).
If the language uses non‐English characters, you would use Unicode, which
is defined as “UTF‐8” (see example below).
<?xml version="1.0" encoding="UTF-8" ?>
4 You can now start translating the text that appears on the Web Client
interface.
The content that needs to be translated is divided across two sections within
the file: “labels” and “messages”. The labels section includes the content
used to describe and identify the elements of the interface, the messages
section includes the notifications that appear in the system messages panel.
To translate these sections, simply alter the text between the enclosing XML
tags. Do not alter the tags themselves.
Note: Make sure you maintain any ʺ%ʺ characters, as these are used to insert
system information.
For example, the English file:
<!-- Labels -->
<span id="TITLE">CitectSCADA Web Client Deployment</span>
<span id="SYSMSG">System Messages</span>
<span id="DEP">Deployment</span>
<span id="DESC">Description</span>
<span id="ACTION">Action</span>
<!-- Messages -->
<sysmsg id="DELOK">% deleted.</sysmsg>
<sysmsg id="DELCAN">% will NOT be deleted.</sysmsg>
<sysmsg id="DEPNULL">You can't % an empty deployment.</sysmsg>
...
would appear as follows in Spanish:
<!-- Labels -->
CitectSCADA Web Client 31
Once you have completed translating the file and saved it with the appropriate
name to the locales folder, your Web Server will be able to support the language.
Note: When you save your file, make sure the text editor you used saves the file
in the appropriate format, i.e. ANSI or Unicode (UTF‐8).
4 In the Application Server dialog box, select Internet Information Services
(IIS) and click Details.
5 In the Internet Information Services (IIS) dialog box, select World Wide Web
Service and click Details.
6 In the World Wide Web Service dialog box, make sure Active Server Page is
selected.
On Windows 2003 Server, the default setting is to have all the web locations
except localhost as an untrusted site. Consequently you must modify your
browser’s security settings.
To update your Trusted Sites settings for Winodws 2003 Server:
1 Choose Tools|Internet Options.
2 Click the Security tab and then Trusted Sites|Sites.
3 In Add this Web site to the zone field, add the web serverʹs IP address as
follows:
http://<ip address>
Note: If you experience further problems on your Web Client pages, you may
want to verify your security settings even if you are not running Windows 2003
Server.
Q: When I try to start the Web Client, I get the error message “Starting Citect
Web Client Failed: Can not initialize citect system”, and then the Web Client
fails. How do I correct this?
A: You should firstly check that you haven’t accidentally deleted the
#DisplayClient folder from the installed Web Server directory, as this will cause
this error. By default, this directory will be located at:
C:\Program
Files\Citect\CitectSCADA\WebServer\Deploy\#DisplayClient
If this is not the case, this issue is due to a MIME configuration problem: the
initialization files are not being recognized in Windows 2003 as registered file
extensions. To correct this, you must add the correct MIME type extension by
doing the following:
1 Run the IIS manager and go to Web Sites|Default Web Site|Citect
SCADA|deploy|(Deployed project directory).
2 Choose Properties from the folder’s right‐click menu.
3 Go to HTTP Headers|MIME types.
4 Add the MIME type (File Extension) “.*”
5 Restart your Web server and client.
CitectSCADA Web Client 33
General issues
This section describes general issues relating to the Web Client product.
Q. When I try to run a deployment in Internet Explorer, I get the following
error: “Problems with this page might prevent it from being displayed
properly...”. What is the problem?
A. The actual cause of this problem stems from the process of downloading the
client component (the .cab file) associated with the deployment. If the current
user on the client computer does not have Windows’ local administrator rights
when the download takes place, this error message will appear.
The solution is to ensure that the person who runs a deployment for the first
time is a Windows local administrator on the client machine. Once the
components have been downloaded, the problem will not reoccur and any user
can access the deployment; unless the .cab file is updated and a newer version
must be downloaded.
Q. I deployed a project from within CitectSCADA using the appropriate
Citect.ini [WebServer] parameters, but the project has not appeared in the list
of deployments on the Web Server. A dialog informed me that the deployment
was successful, what has happened?
A. This problem can occur if you make an error with the syntax for the
[WebServer]DeployRoot parameter. If, for example, you use a curly bracket
instead of a square bracket, i.e.“[WebServer}DeployRoot”, the compiler cannot
read the parameter and deployment files are sent to the CitectSCADA project
directory instead:
C:\Program Files\Citect\CitectSCADA\User\<Project Name>
The deployment is flagged as successful, but it cannot be located by the Web
Server.
You should check the location above for evidence of this problem, as a subfolder
called ʺWeb Deployʺ will have appeared. If this is the case, you should review
the syntax used in your Citect.ini file.
Q. I deleted a user from the list of users configured for access to the Web
Server, but they were still able to log in. How do I deny them access?
A. In certain circumstances, a user can connect to the Web Server even after the
user account has been deleted. This is due to the operating system failing to
acknowledge that a user has been deleted for a period of around half an hour.
The solution to this problem is to ensure you deny full access to the user before
you delete them. That way, they won’t be able to gain access.
Q. When I try to run the Web Client component for the first time, I get a
“System Settings Change” message instructing me to restart my computer.
What should I do?
34 CitectSCADA Web Client
A. This is a known problem affecting computers that contain old versions of
some system files required by the Web Client Control. If these files are in use by
another application during installation, this System Settings Change message
will appear. Simply click the OK button to restart your machine, and this will
allow the newer versions of the required files to be installed during system
reboot. The problem will no longer occur.
Q. One of the ActiveX Object’s included in my project cannot locate its
associated data source. Where is it?
A. If an ActiveX object has an associated data source, you need to ensure the
data source can be located by the computer hosting the Web Client. See the topic
Managing associated data sources for more information.
Q. The Process Analyst interface normally displays in a foreign language as I
translated the language resource DLL, but it displays in English on the Web
Client platform. How do I correct this?
A. A Process Analyst running inside a CitectSCADA Web Client supports run
time language switching, but you must configure which languages the Web
Client will download to the client machine.
To configure the languages to download:
1 Create a zip file in the CitectSCADA \bin folder called bin.zip.
2 Add to the zip file all the language resource DLL files that you want the
client to download and use. (You can find these files in your \Program
Files\Common Files\Citect folder.)
Note: The bin.zip file and its contents are not version‐checked. This means
you must manually remove the bin.zip from the Web Client machines if
your server contains a more recent bin.zip file. To do this:
1 Find the installation directory of the Analyst.dll file on your Web Client
machines and look for a file called bin.zip in this directory.
2 Delete this file.
3 Reconnect to the Web server to download the latest bin.zip file.
Q. I have keyboard shortcuts configured in my CitectSCADA project, but they
do not work properly when the project is deployed in the Web Client. What’s
wrong?
A. The keyboard shortcuts configured for Internet Explorer (IE) take precedence
over any keyboard shortcuts configured within your CitectSCADA projects. For
example, the CSV_Example project has F11 assigned to call up help on a selected
animation point on a graphics page. If the project is run as a Web Client
deployment, F11 will toggle the view to full screen, as is the case normally with
IE.
CitectSCADA Web Client 35
This is unfortunately a limitation of using Internet Explorer as a host to
CitectSCADA projects. The easiest solution to the problem is to return to the
CitectSCADA configuration environment and assign your shortcuts so that no
clashes occur. See the Internet Explorer Help for details of preconfigured
keyboard shortcuts.
Q. I can’t print from the Web Client. Why not?
A. You can print from the Web Client, but not by using your browser’s File |
Print command. Instead, in your CitectSCADA project, create a Print control
that uses the Cicode WinPrint() function to print the page you want.
Q. The new page that I added to my CitectSCADA project does not appear in
the Page Select list or the default menu page in the Web Client. How can I
correct this?
A: If the page you added to your CitectSCADA project does not appear in Web
Client, you can manually type in the page name in the Page Select list to view
this new page. In this version of the Web Client, the new page is not added to the
default menu page.
Q. How does the Web Client deal with ActiveX controls (for example,
CiMeterX.ocx) and user files (Recipes.dbf, for example) that are required by a
user project?
A. If your user project requires files such as these, you need to create special zip
files to contain them. Create an ActiveX.zip file to contain the ActiveX files
required by your project, and a Misc.zip file to contain other files that your
project needs; for example, recipes.dbf, Chinese.dbf, Japan.dbf, and so on.
Add these files under the main project path (for example, C:\Program
Files\Citect\CitectSCADA\User\Example).
Note: You can have subfolders within the zip files, but your project must be
configured to use the same relative path structure.
During compilation, any zip files that contain supporting files required by a
CitectSCADA project are copied to the Webdeploy subfolder. During startup,
the Web Client will check the timestamp of any zip files to determine if the zip
files have been updated; if the files have been updated, the zip files will be
downloaded.
Q. The Web Client Deployment Page displays incorrectly on Windows 2000
Advanced Server. ʹShow Server Detailsʹ is missing, and the icons for Start
Display Client, Delete Deployment and Edit Deployment are also missing.
What is wrong?
A. This appears to be caused by Windows Automatic Update installing a
number of components at the same time after a fresh install of the operating
system. Even though Internet Explorer may have been upgraded to the latest
version (for example, 6.0.2800.1106) it may still behave as a version 5 browser;
36 CitectSCADA Web Client
for example, it offers limited support for ʺiframesʺ. If you call up About Internet
Explorer from the Help menu, and a Version 5‐style dialog appears with a
version 6 release number, then your computer is affected in this way.
A complete uninstall/reinstall of Internet Explorer will correct the problem.
Appendix A: Windows Language Codes
code Windows locale setting code Windows locale setting
af Afrikaans hu Hungarian
sq Albanian is Icelandic
ar-sa Arabic (Saudi Arabia) id Indonesian
ar-iq Arabic (Iraq) it Italian (Standard)
ar-eg Arabic (Egypt) it-ch Italian (Switzerland)
ar-ly Arabic (Libya) ja Japanese
ar-dz Arabic (Algeria) ko Korean
ar-ma Arabic (Morocco) ko Korean (Johab)
ar-tn Arabic (Tunisia) lv Latvian
ar-om Arabic (Oman) lt Lithuanian
ar-ye Arabic (Yemen) mk FYRO Macedonian
ar-sy Arabic (Syria) ms Malaysian
ar-jo Arabic (Jordan) mt Maltese
ar-lb Arabic (Lebanon) no Norwegian (Bokmal)
ar-kw Arabic (Kuwait) no Norwegian (Nynorsk)
ar-ae Arabic (U.A.E.) pl Polish
ar-bh Arabic (Bahrain) pt-br Portuguese (Brazil)
ar-qa Arabic (Qatar) pt Portuguese (Portugal)
eu Basque rm Rhaeto-Romanic
bg Bulgarian ro Romanian
be Belarusian ro-mo Romanian (Moldavia)
ca Catalan ru Russian
zh-tw Chinese (Taiwan) sz Sami (Lappish)
zh-cn Chinese (PRC) sr Serbian (Cyrillic)
zh-hk Chinese (Hong Kong SAR) sr Serbian (Latin)
zh-sg Chinese (Singapore) sk Slovak
hr Croatian sl Slovenian
cs Czech sb Sorbian
da Danish es Spanish (Traditional)
nl Dutch (Standard) es-mx Spanish (Mexico)
nl-be Dutch (Belgium) es-gt Spanish (Guatemala)
en English es-cr Spanish (Costa Rica)
en-us Englsih (United States) es-pa Spanish (Panama)
en-gb English (United Kingdom) es-do Spanish (Dominican Republic)
38 Appendix A: Windows Language Codes
A M
Manager Client
ActiveX.zip, 17
Web Client, 7
Administrator
Misc.zip file, 17
Web Client, 7
multiple language support for Web Client, 27
non‐default languages, 29
C
configuring
Web Client deployment, 19
P
creating preparing a project for Web Client deployment, 15
Web Client deployment, 20
S
D security
configuring Web Client user groups, 9
default languages for Web Client, 28
preparing the Web Server folder, 10
deployment for Web Client
settting up Web Client accounts, 13
configuring, 19
testing Web Client settings, 14
creating, 20
Web Client, 7
deleting, 27
Web Client setup, 8
displaying, 25
software requirements
editing, 25
Web Client, 4
from CitectSCADA, 23
updating, 26
Display Client U
Web Client, 7 unsupported functionality, 16
users
F Web Client, 7
FAQs
Web Client, 31 W
frequently asked questions Web Client, 1
Web Client, 31 ActiveX.zip file, 17
functionality limitations, 16 Administrator, 7
client account access rights, 13
I configuring a deployment, 19
configuring client account user groups, 9
installation
creating a deployment, 20
Web Client, 3
default languages, 28
deleting a deployment, 27
L Deploy folder, 4
languages deploying a project from CitectSCADA, 23
Web Client, 27 Display Client, 7
limitations DisplayClient folder, 4
Cicode functions, 16
40 Index
displaying a deployment, 25 preparing user files for delivery, 17
editing a deployment, 25 security, 7
frequently asked questions, 31 setting up a system, 1
functionality limitations, 16 setting up access rights, 13
Getting Started, 1 setting up security, 8
implementing non‐default langauges, 29 system architecture, 2
installed directories, 4 testing security, 14
installing, 3 updating a deployment, 26
introduction, 1 user account types, 7
logging on to Web Server, 14 using a different language to the locale setting, 28
Manager Client, 7 Web Deployment Preparation tool, 18
minimum requirements, 3 Web Server address, 14
Misc.zip file, 17 Web Deployment Preparation tool, 18
multiple language support, 27 Web Server
preparing a project for deployment, 15 address, 14
preparing the Web Server folder, 10