Citect SCADA 2018
ReadMe
(Updated 28/05/2018)
Please refer to the Installation and Configuration Guide for information on the installation of the product, and the upgrade process for existing projects.
1. Disclaimers
2. Features
3. Known Issues
4. Requirements
1.1. Disclaimer of All Warranties
As detailed in paragraph 9 of the End User Licence Agreement, SCHNEIDER ELECTRIC excludes all warranties and liabilities to the fullest extent permitted by law.
CITECT SCADA and all documentation are provided "AS IS" and your company understands that it assumes all risks pertaining to your use of CITECT SCADA.
YOUR COMPANY AGREES AND ACKNOWLEDGES THAT SCHNEIDER ELECTRIC SHALL HAVE NO LIABILITY WHATSOEVER TO YOUR COMPANY FOR ANY PROBLEMS IN OR CAUSED BY CITECT SCADA OR THE RELATED DOCUMENTATION, WHETHER DIRECT, INDIRECT, INCIDENTAL, SPECIAL, OR CONSEQUENTIAL (INCLUDING LOSS OF PROFITS).
2.1. New Features
The following features have been added in Citect SCADA 2018 and are available in this release.
1. Situational Awareness Starter Project
The Situational Awareness Starter Project can be used to create a project that is designed to support abnormal situation management for operators. It provides accurate information to an operator in a way that can be perceived and acted upon quickly, without overwhelming their cognitive abilities.
This objective is achieved through:
· A consistent look and feel for all graphical content.
· The use of standardized color settings, optimized for perceiving process data and alarms.
· The inclusion of operational focused library objects.
· Support for runtime updates based on navigational or contextual changes.
· The inclusion of navigation aids and an operator dashboard.
Workspace
Situational Awareness projects differ to other pure template-based projects as they use "Workspace" technology to manage the content of a Master Page that appears on each configured client screen. Each pane in a Master Page displays a page that can be updated independently at runtime based on navigational or contextual changes.
The Workspace is responsible for managing contextual updates to those panes by using the association between the hierarchical location of a detected change, and the type of content each pane is configured to display.
Situational Awareness Object Library
A set of objects are also available via an included library project (named "SA_Library"). The included objects (and associated faceplates) support the autofill functionality at runtime and maintain a consistent look and feel across a project's display pages.
2. Alarm Management
Citect SCADA 2018 includes the following enhancements to the way operators can manage alarms at runtime.
Alarm Cause and Response
You can associate cause and response information with an alarm tag. This means you can describe the circumstances that are likely to cause the alarm, and the appropriate course of action required to address the alarm. This information can then be presented to an operator at runtime.
To specify cause and response information for an alarm tag, you need to use the new Alarming > Cause and Response view in the Setup activity.
Alarm Shelving
When you shelve an alarm, it is disabled for a specified period of time, or until a specified time is reached. This allows an operator to temporarily disable alarms that are causing an unnecessary distraction.
Shelving is available in a Situational Awareness project via the Default Alarm pages and the Alarm Tab in the Information Zone.
If your project uses the StruxureWare or Tab Style templates (accessible via a starter project), you can shelve alarms during runtime from the Active Alarms and Alarm Summary page.
You can also shelve alarms by setting the EndTime argument for the following Cicode functions:
· AlarmDisable
· AlarmDisableRec
· AlarmDisableTag
· AlmBrowseDisable
· AlmSummaryDisable
· AlmTagsDisable.
Alarm Indicators
Citect SCADA 2018 allows you to use alarm indicators. Consisting of an alarm border and flag that appear around the extent of an object group or Genie, an alarm indicator provides a prominent visual indication of alarm occurrences at runtime.
To configure an alarm indicator for an object group or Genie, there are two tasks you need to consider:
1. You need to define display properties for the alarm priorities that an indicator will represent (see below).
2. For each object group or Genie, you need to define the Alarm Indicator properties in Graphics Builder.
Alarm Priority Display Properties
You can configure optional display properties for an alarm priority that allow you to:
· Specify a name for a priority value to provide a meaningful representation of its purpose.
· Define background and foreground colors that support a visual representation of priority on a graphics page.
· Define a Large and Small genie to visually represent the priority on the Alarm Indicator and Alarm Lists.
These additional properties are configured in the Setup activity.
3. Graphics Enhancements
Citect SCADA 2018 includes the following enhancements to graphics and the Graphics Builder.
Name a Graphic Object
In Citect SCADA 2018 you can now name graphics objects (for example, a Polyline, Rectangle, Text and Genie). Use this name to reference a graphics object via expressions and Cicode at runtime.
Configure the animation name when defining the general access properties of a graphics object.
Animated Polygon Vertices
Citect SCADA now allows you to associate a tag or Cicode expression with the vertices in a polygon. This means the shape of a polygon can be manipulated at runtime in response to values generated by a production system.
This is achieved by applying offset values to each vertex that define a path along which the vertex can move. As the return value for an expression changes, a vertex will move along the path defined for it, altering the shape of the polygon.
Pinned Windows
Windows can now be "pinned" at specified locations within a main window or within other pinned windows. A new Cicode function WinNewPinAt() has been added that when configured opens a new display window at a specified location, relative to the current active window, with a selected page displayed. The window can later be removed with the WinFree() function.
Activate/Deactivate Events
You can now configure events to run when a window is activated or deactivated. This is useful when using pinned windows on a page. For example, the activate event can be used to run an event if the user clicks on the pinned window.
Dynamically Display Symbols
In Citect SCADA 2018 you can use the DspSym Cicode function with a Genie to dynamically display content that is only generated at runtime.
Runtime Cursor
The runtime input focus cursor’s color can now be set to transparent. Also, a new function DspSetCurColor() has been added to allow simpler dynamic setting of the cursor color.
4. Screen Profiles
Screen profiles specify the physical characteristics of one or more workstation screens and how these screens are arranged with respect to each other. Screen profiles allow you to set up multiple displays. If you are running a Situational Awareness project, you can set up screen profiles for independent or linked contexts.
You can create, manage and configure screen profiles with the Screen Profile Editor, which is displayed below the Screen Profile table in the Setup.
A screen profile can also be set up for your project through the Setup Wizard.
5. Equipment References
Citect SCADA 2018 allows you to link a piece of equipment to items, or tags belonging to another piece of equipment in your project. This means you can establish a relationship with equipment or equipment.items outside the equipment hierarchy. With equipment reference browse functions, you can then track, group and display all information for the equipment and referenced equipment in one interface at runtime.
Add equipment references in the System Model > Equipment References view.
6. Composite Genies
Citect SCADA 2018 provides several Composite Genies for use on graphics pages. A Composite Genie is a collection of individual Genies assembled to form a single object based on parameters/options chosen by the Engineer. The individual objects and their parameters/options are defined in an XML template file along with layouts for the collection, that is, the Composite Genie.
You can insert multiple instances of the composite object on to a graphics page, and specify different parameter settings including values, alignment and display options for each instance to tailor the Composite Genie to suit your requirements.
For example, you want to build a mirrorable compressor object that is capable of optionally displaying a label, a mode indicator and a meter alongside the symbol. With Composite Genies, you can simply select the XML template for a compressor, which presents a set of presentation options for you to configure label, orientation, etc. All you need to do is set values for these options and insert the object on to a page. You can change parameters/options at any time.
7. Refresh Super Genie Associations
A new Cicode function called AssWinReplace allows you to update the associations for a Super Genie without the need to reload the entire page. The function removes the associations on a specified Super Genie window, and applies any pending associations.
8. Grid Column Resizing
You can now re-size the columns in the Citect Studio Grid Editor according to their content.
To do this, select Size Columns to Content from the menu on the left side of the Grid Editor header. Alternatively, you can double-click the divider of a specific column to automatically resize it.
9. Display Name for Equipment
Equipment definitions now support a Display Name property. This allows you to specify a meaningful name that can identify a piece of equipment at runtime.
The Display Name is used in the faceplates, and the new tree control also supports displaying the equipment hierarchy by equipment or display name.
10.Arrays Functions
Citect SCADA 2018 now includes a set of functions that allow you to create arrays that use up to three dimensions (x,y,z). This can offer performance benefits when handling large amounts of data, for example, when generating an alarms list.
11.Indirect Tag Value Lookups in Foreground Code
A new function TagGetValue() has been added that allows values of tags to be automatically looked up in foreground Cicode expressions. This function automatically sets up and maintains the subscriptions for the referenced tag / equipment.item.
12.OPCUA Driver
The OPCUA Driver is included with this release. It enables Citect SCADA to communicate with a system that implements the OPC UA server standard for data access. The driver supports binary OPC.TCP protocol. The OPCUA driver is not installed by default. You will need to select it from the list of available drivers when the Citect Driver installer is launched towards the end of the installation process.
These features are documented in the Citect SCADA Help. For more information, see the topic “What’s New in Citect SCADA 2018” in the “Getting Started” section.
3.1. What are the known issues for Citect SCADA 2018?
1. Windows® DPI settings / Text Scaling
The appearance of Composite Genies can be affected by different DPI settings. It is recommended that all engineers working on your project use 100% Scaling option in the Windows Display Settings when running Graphics Builder. After changing the Scaling setting for a computer, you should reboot Windows.
2. ExampleSA intended for English-only use
If you log in to the ExampleSA project at runtime, it is recommended that you select “English” in the Language field on the login form. If you log in as a non-English user, there will be some text in the interface that is not translated.
3. Switching between Example and ExampleSA
If you run the Example project and then run ExampleSA, the ExampleSA project will not start up correctly, and vice versa. You need to manually run the Computer Setup Wizard between switching active projects as if you run Example first, it sets its own startup page.
4. Device history files may be duplicated on rollover
Device history files may be duplicated on rollover when running as a service and using a service display client. During the Citect SCADA process initialization, the external display client "/x client" may be incorrectly evaluated as single-process. If [Device]AlwaysCreateHistory is enabled, the rule that determines which process should log to a Citect SCADA device does not apply.
5. Installation error on Windows® 8.1 and Windows Server 2012 R2 if the required Windows updates are not installed
Citect SCADA 2018 may not install correctly on Windows Server 2012 R2 if the required Windows updates have not been installed, stopping .NET 4.7 from being installed. Check Programs and Features in Control Panel, then go to View installed updates and look for hotfix KB2919355. If this hotfix does not exist, then download this hotfix from Microsoft website and install it manually. Then restart the computer.
6. Installation of .NET 4.7 may be blocked by Windows®
For Windows 7 SP1, Windows Server 2008 R2 SP1 and Windows Server 2012, you need to follow this KB from Microsoft to allow .NET 4.7 to install.
7. Computer Setup Wizard may not show all available window options when run path is empty and run/copy project option is selected
If the run path in the citect.ini file is
empty when launching the Computer Setup Wizard, certain screens will not be
available to configure. For example, selecting Run\Copy Project Option will not
display the Screen Setup window. Another issue is that the Profile file will
not be loaded. To work around these issues, simply set a value for the Run
parameter.
8. [Code]Threads default value has changed
The [Code]Threads parameter determines the number of Cicode threads (tasks) that can run concurrently. For this release, the default value has been changed from 64 to 128. If you have changed this value on your system, make sure it is set to at least 128 to run a Situational Awareness project.
4. Requirements
4.1. Software
Citect SCADA 2018 can be run on:
· Windows® 7 SP1 (64 bit only)
· Windows® 8.1 (64 bit only)
· Windows® 10 version 1607 and later (64 bit only)
· Windows® 10 LTSB version 1607 (64 bit only)
· Windows® Server 2008 R2 SP1
· Windows® Server 2012
· Windows® Server 2012 R2
· Windows® Server 2016
Notes:
· Internet Explorer Version 9 or later is the minimum requirement when using the Process Analyst, the Citect SCADA Web Client, or the Citect SCADA Web Server. However, in line with Microsoft advice, we recommend you use the latest version of Internet Explorer with these products.
· Extended Memory mode for an alarm server can only be run on a 64-bit operating system.
· The requirements for Microsoft .NET Framework are 4.0, 4.5.1, 4.6.1 and 4.7 (installed with Citect SCADA if not already installed).
· Microsoft .NET Framework 2.0 (x64) is required by "Schneider Electric License Manager" and "Schneider Electric Software Update" if using Windows Server 2012.
4.2. Hardware
Selecting hardware is dependent upon a number of factors such as:
· The role of the hardware in your SCADA system
· The amount of I/O, Alarms, Trends and the frequency of change
· Number of Clients (for Servers)
· Server Clustering
· Complexity of your user interface
· Degree of customization
The requirements below have been tested using a simulated SCADA system with 10 clients connected maintaining a server CPU load of less than 25% and should be used as a guideline only due to the impact of the factors listed earlier.
PC Performance
General PC performance will be affected by the major elements of CPU, RAM, Bus, and HDD speed.
The clock speed no longer defines how powerful a CPU is; the required processor is defined according to an average CPU mark given by PassMark® Software. To check CPU performance, for example for a Core i3 CPU, type "PassMark Core i3" in the search engine of your internet browser. This will give you the CPU's calculated performance as compared to other similar well-known processors.
In general, it is recommended that computers in your SCADA network utilize no more than ~25% CPU in normal state. This allows the system to be responsive, and handle abnormal situations better.
Client Recommendations
|
CPU |
Cores |
RAM |
HDD |
Graphics |
Screen
|
Network |
|
|
2000 |
2 |
4 GB |
10 GB |
DirectX
9 or later with WDDM 1.0 Driver, |
1920 x 1080 |
100 Mb |
|
1. The complexity of your pages such as the number of graphical animations and Cicode running in the background will impact your client CPU choice. It is recommended to use a higher performing PC with high clock speed when building complex user interfaces. As a guidance, the following will require high clock speed to maintain a Client CPU load of less than 25% on a single core:
a. HD user interface with 50 complex genies
b. UHD4K user interface with 100 complex genies
2. If the Deployment feature is being used, the HDD needs to have the required space for the number of configured version+2 of the project.
3. Citect SCADA supports lower and higher resolutions including 4K UHD Resolution (3840 x 2160). A 4K UHD will require a high clock speed CPU.
4. A multi-monitor client will typically require a higher clock speed CPU and more memory.
Server Recommendation
|
I/O
per |
CPU |
Cores |
RAM |
HDD *2 *3 |
Graphics |
Screen
|
Network |
|
|
Compact |
1800 |
1 |
4 GB |
10 GB |
DirectX
9 or later with WDDM 1.0 Driver, |
1920 x 1080 |
100 Mb |
|
|
Small
|
4500 |
4 |
8 GB |
20 GB |
DirectX
9 or later with WDDM 1.0 Driver, |
1920 x 1080 |
100 Mb |
|
|
Medium
|
8000 |
4 |
8 GB |
100 GB |
DirectX
9 or later with WDDM 1.0 Driver, |
1920 x 1080 |
100 Mb |
|
|
Large
|
10000 |
8 |
16 GB |
500 GB |
DirectX
9 or later with WDDM 1.0 Driver, |
1920 x 1080 |
1 Gb |
|
1. This is a recommendation for a single server only running I/O, alarms, trends and reports. For larger systems, services can be distributed to their own PC and/or clustering can be used to add additional servers. System resources of CPU and Memory should be increased when:
· Using clustering
· There is high rate of change of data (I/O or Alarms)
2. If the Deployment feature is being used, the HDD needs to have the required space for the number of configured versions+ 2 of your project.
3. Disk space is an estimate only and includes:
· Runtime components
· Compiled project
· 20% of the I/O trending with a change on average every 10 seconds, 24 x 7 for 3 months.
· Alarm changes equal to the number of I/O changing per day
Notes:
1. The exception to the 10-client simulation is the HMI role, with a Server/Client combination operating without networking.
2. Refer to the detailed Hardware Requirements in the Citect SCADA 2018 Installation Guide to better gauge hardware recommendations specific to the size of your SCADA system.
Engineering Workstation Recommendation
|
Total |
CPU PassMark® |
Cores |
RAM |
HDD
*1 |
Graphics |
Screen |
Network |
|
Compact
|
2000 |
2 |
8 GB |
10 GB |
DirectX 9 or later with WDDM 1.0 Driver, 128 MB of dedicated VRAM |
1920 x 1080 |
100 Mb |
|
Small
|
2000 |
2 |
8 GB |
20 GB |
DirectX 9 or later with WDDM 1.0 Driver, 128 MB of dedicated VRAM. |
1920 x 1080 |
100 Mb |
|
Medium
|
4250 |
4 |
8 GB |
50 GB |
DirectX 9 or later with WDDM 1.0 Driver, 128 MB of dedicated VRAM. |
1920 x 1080 |
100 Mb |
|
Large
|
4250 |
4 |
8 GB |
50 GB |
DirectX 9 or later with WDDM 1.0 Driver, 128 MB of dedicated VRAM. |
1920 x 1080 |
100 Mb |
|
Huge
|
8000 |
4 |
8 GB |
100 GB |
DirectX 9 or later with WDDM 1.0 Driver, 128 MB of dedicated VRAM. |
1920 x 1080 |
100 Mb *5 |
1. SSD is recommended for Engineering machines for a smoother and faster experience. If a non-SSD is used, select a minimum RPM of 7200.
2. If the Engineering machine is being used as a Deployment Server, the size of the HDD will determine how many versions of the system you can retain.
3. Disk space is an estimate only and includes:
· Full Citect SCADA installation including optional components and documentation
· Project Assets for the specified system size
4. Citect Studio is designed for a minimum desktop resolution of 1920 x 1080.
5. If the Engineering machine is being used as a Deployment Server, a 1Gb network connection is recommended.
HMI Recommendation
|
System |
CPU
|
Cores |
RAM |
HDD |
Graphics |
Screen |
Network |
|
Compact
|
1400 |
1 |
8 GB |
10 GB |
DirectX 9 or later with WDDM 1.0 Driver, 64 MB of dedicated VRAM |
1920 x 1080 |
n/a |
1. HMI Client/Server combination.
5.1. Update pages has changed
Citect SCADA Update Pages process has changed in this release. The ability to toggle "Fast Update Pages" from within Graphics Builder has been deprecated. Update Pages only supports incremental updating of graphics. It is recommended that you do not delete pg*.dbf/ndx files. You should instead use the Pack command in Citect Studio regularly to ensure the database files are optimized. If you do delete these files, or replace them with empty files, you will need to use the Graphics Builder Automation Interface to Open and Save each page individually in your project(s) to rebuild the expression data into those files. The Pack Libraries command should also be used regularly to keep your graphic library files optimized, especially if you are using Composite Genies.
5.2. Version Control recommendations
If you wish to add your project(s) to a version control system, it is recommended that you use a system that can efficiently store binary files. Do not directly add the project folder under the Citect SCADA User folder to version control. Instead, you should create a copy of your project hierarchy under a different folder, and use a third-party comparison tool to determine which files have changed after a set of modifications. It is also recommended that you only add configuration files to version control, not runtime files and other compiler-generated files. For more information, refer to Citect SCADA Knowledge Base article 10026.
5.3. DriverWeb
For up-to-date information on drivers and related information, please visit DriverWeb at http://www.citect.schneider-electric.com/scada/citectscada/downloads-updates/driverweb. It is recommended that you subscribe to the forums for the drivers that you use so that you are alerted to any updates that occur.