PowerSCADA Expert 8.1 Guide
PowerSCADA Expert 8.1 Guide
1 with
Advanced Reporting and Dashboards
7EN02-0382-00
03/2016
Safety information
Important information
Read these instructions carefully and look at the equipment to become familiar with
the device before trying to install, operate, service or maintain it. The following spe-
cial messages may appear throughout this bulletin or on the equipment to warn of
potential hazards or to call attention to information that clarifies or simplifies a pro-
cedure.
The addition of either symbol to a "Danger" or "Warning" safety label indicates
that an electrical hazard exists which will result in personal injury if the instruc-
tions are not followed.
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.
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,
could result in death or serious injury.
CAUTION
CAUTION indicates a potentially hazardous situation which, if not avoided,
could result in minor or moderate injury.
NOTICE
NOTICE is used to address practices not related to physical injury. The
safety alert symbol shall not be used with this signal word.
Please note
Electrical equipment should be installed, operated, serviced and maintained only by qualified personnel.
No responsibility is assumed by Schneider Electric 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, installation, and oper-
ation of electrical equipment and has received safety training to recognize and avoid the hazards involved.
Safety precautions
During installation or use of this software, pay attention to all safety messages
that occur in the software and that are included in the documentation. The
following safety message:
WARNING
UNINTENDED EQUIPMENT OPERATION
• Do not use the software for critical control or protection applications
where human or equipment safety relies on the operation of the control
action.
• Do not use the software to control time-critical functions because com-
munication delays can occur between the time a control is initiated and
when that action is applied.
• Do not use the software to control remote equipment without securing it
with an authorized access level, and without including a status object to
provide feedback about the status of the control operation.
Failure to follow these instructions can result in death or serious injury.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software, as this can lead to inaccurate
reports and/or data results.
• Do not base your maintenance or service actions solely on messages
and information displayed by the software.
• Do not rely solely on software messages and reports to determine if the
system is functioning correctly or meeting all applicable standards and
requirements.
• Consider the implications of unanticipated transmission delays or fail-
ures of communications links.
Contents
Safety information 1
Important information 1
Please note 1
Safety precautions 1
Contents 1
Introduction 6
Assumptions 6
Prerequisites 7
Supporting Documentation 7
Server Preparation 8
Architecture 9
Software Installation 11
On the PowerSCADA Expert Server Computers 11
PowerSCADA Expert Installation 11
On the PowerSCADA Anywhere Server Computers 12
On the Advanced Reporting Module Computer 12
Add a Project to Citect 13
Add Redundant I/O Alarm, Report, and Trend Servers 13
Add Redundant NetworkTagsDev and zOL Devices 15
Configure PowerSCADA Expert to Run As a Service 15
Configuration 16
Windows Service Operation 17
Compile the Project 18
Create Device Profiles and Tags 19
Add Device Types and Tags 19
Review Default Device Types and Tags 19
Don't Find What You Need? 19
Create Custom Tags 19
Set Up Custom Tags 20
Edit a Custom Tag 22
Delete a Custom Tag 22
Edit Generic Tag Addresses 22
Create Custom Device Types 22
Create Device Profiles 23
Enable Waveforms for Onboard Alarms 23
Add an Onboard Alarm Tag 23
Create and Export a Project 24
Add I/O Devices to the Project 25
Before You Use the I/O Device Manager 25
Define One I/O Device in a Project 25
Add a TCP Device to a Project 26
Add the TCP Device 26
Add a Serial Device to a Project 28
Add the Serial Device 28
Add a DNP3 TCP Device 29
Add the DNP3-TCP Device 30
Add an IEC 61850 Device to a Project 31
Add the IEC 61850 Device 32
LDName 32
BRCBs and URCBs 32
Remove a Device From the Project 33
Use a CSV File to Define Multiple Devices 34
Create a CSV File to Add Devices 34
Can I change the %CLUSTER% name in the I/O Device Manager? 130
A device can prevent writes to its registers: how do I ensure that writes are successful? 130
How do I prevent PowerSCADA Expert from accidentally making invalid areas in memory available
to reads and writes? 130
How do I create an audit in the Event Log for user logins and logouts? 130
Why am I seeing #COM for circuit breaker status in the genie status page? 131
Why can't I acquire waveforms in the waveform viewer? 131
Why won't the Excel DBF Add-In toolbar install? 132
What causes the "First dbf record" error message? How do I keep it from happening? 132
Why is my device in comms loss? 132
How do I set up select before operate? 132
Diagnostics 133
Index 134
Introduction
The PowerSCADA Expert 8.1 with Advanced Reporting and Dashboards System
Development Guide describes the procedures involved in planning the
PowerSCADA Expert 8.1 with Advanced Reports and Dashboards project, installing
software, and creating a working system. When you have finished with the system
development process, you should have a fully installed operating system that includes:
• PowerSCADA Expert 8.1 and Power Monitoring Expert installed on separate
servers
• Citect as a service: allows you to install a remote Citect application that can then
access running Citect clients. You can view and control the client through a secure
web browser, which means you do not have to install Citect on portable devices.
• redundant servers: When you use a network, you can configure redundant I/O
devices to minimize the potential for data loss (in case a server should become
inoperative). You designate a Disk I/O device on both the primary and secondary
servers; Data is written to both Disk I/O devices. Thus, if the primary server
becomes inoperative, the standby server can be activated without interruption.
• scaled systems: Scaling provides the ability grow your system as large as it needs
to be to meet all of your monitoring needs.
• communication with devices
• alarms and trends
• Extract Transform Load (ETL): allows you to extract data from PowerSCADA Expert
and transform it into a format that loads into Power Monitoring Expert. From there, it
can be used for reports and dashboards.
Assumptions
The PowerSCADA Expert 8.1 with Advanced Reporting and Dashboards System
Development Guide is intended for application engineers, system integrators, and
other qualified personnel that understand and have experience with power monitoring
systems. Qualified personnel will:
• have received Citect SCADA training
• understand how to install the various devices used in the project, and how to install
the PowerSCADA Expert 8.1 with Advanced Reports and Dashboards software
• have completed necessary reading and will have made decisions regarding
architecture and hardware specifications
Use this guide as a reference as you prepare and develop the PowerSCADA Expert
8.1 with Advanced Reports and Dashboards project that you are installing. For related
information, or where more detail is required, references are made to existing
documentation.
The PowerSCADA Expert 8.1 with Advanced Reporting and Dashboards is a power
management system that combines PowerSCADA Expert with the Advanced Reporting
and Dashboards features of Power Monitoring Expert. The installed system is made up
of hardware, software, and communication components. All of the elements are
modular and operate with each other to provide the information that the customer
needs to view data and interact with system features.
Although this manual walks you through the development of a "typical" installation,
PowerSCADA Expert 8.1 with Advanced Reports and Dashboards provides the ability
to create very complex systems with many options. For example, you may want to
include redundant servers, or you may choose to not install ENM or ETL.
Prerequisites
Review the system development process provided in this document.
Gather the supporting documents that you may need. A list of related documents is
provided below.
Create a system architecture drawing, including the servers, devices and all
connectivity. Define the IP addressing for each gateway and device.
Order the appropriate equipment, including computers, software, and system devices.
For help in determining what you need for your system, see the PowerSCADA Expert
8.1 with Advanced Reports and Dashboards Design Guide.
Ensure that all devices that will communicate through this system are set up and
properly addressed.
Have a copy of the Example.CSV file for adding devices to the system. You will use this
file if you need to manually add multiple devices at a time to your project.
Set up the server and client computers that you need for your system.
Ensure that the IT team has opened the appropriate firewall ports.See the
PowerSCADA Expert 8.1 with Advanced Reports and Dashboards IT Infrastructure
Preparation User Guide for details.
Ensure that all license keys have been purchased and are ready to be installed.
Supporting Documentation
The following documents provide additional information that you may need to create
and run your system.
• citectscada.chm (Citect help file)
• Vijeo Citect 2015 Web Client Guide
• PowerSCADA Expert 8.1 with Advanced Reporting and Dashboards Design Guide
• StruxureWare PowerSCADA Expert 8.1 Installation Guide
• StruxureWare PowerSCADA Expert 8.1 with Advamced Reporting and Dashboards
ETL Administration Guide (7EN42-0117-00)
• PowerSCADA Expert 8.1 with Advanced Reports and DashboardsSystem
Integrator's Manual
• PowerSCADA Expert 8.1 with Advanced Reports and Dashboards IT Guide
• Event Notification Module lnstallation Guide, Version 8.3.1
• PowerSCADA Anywhere Server Installation and Configuration Guide
• PowerSCADA Anywhere Web Client User Guide
• PowerSCADA Anywhere Quick Start Guide
• IT Infrastructure Preparation for StruxureWare Power Monitoring Expert 8.1
Installation (locate this document on The Exchange)
• StruxureWare Power Monitoring Expert 8.1 Installation Guide
• (McAfee) Advanced-Parameter-EmbeddedControl-v6
• (McAfee) Installation-Guide--v6.2.0
• (McAfee) Command Line Interface Guide
• McAfee-Embedded-Control-Code-Signing-Giodev1/2
• (McAfee) Product-Guide-v6.2.0
• (Tofino) ConneXium TCSEFEA Installation Manual V1
• (Tofino) ConneXium TCSEFEA User Manual V1
Server Preparation
You need to install PowerSCADA Expert for Advanced Reporting Module on a
separate server.
For details about server requirements and preparation, see the PowerSCADA Expert
Design Guide.
Architecture
The architecture intended in the following engineering procedures combines
PowerSCADA Expert with the following add-on modules:
• Advanced Reporting and Dashboards
• Event Notification
• PowerSCADA Anywhere (or you can, as an alternative, use the PowerSCADA
Expert web client)
• McAfee Application Control
Also included as an optional step is to deploy Tofino industrial network firewalls in the
topology.
While not every customer solution will include this architecture in its entirety, it is
representative of the primary features, scaling, redundancy, and deployment
capabilities of PowerSCADA Expert and its add-on modules. The architecture diagram
below depicts the nominal scaled, redundant PowerSCADA Expert architecture.
Some customer solutions may require no redundancy. Some may require only a single
I/O server. Alternatively, some customer solutions may require more than 1 or 2
redundant I/O server pairs. The engineering procedure that follows in this manual will
apply to all of these scenarios by simply replicating or omitting the steps in the
procedure.
diagram below. For details about this option, see Install and Configure the Tofino
Firewall on page 115.
Software Installation
This section provides an overview of the general steps required to install:
• PowerSCADA Expert
• Event Notification Module (ENM): Use this module to set up notification of critical
power incidents. You set up ENM to monitor and receive alarm and event
information, and you designate users who will receive notification when defined
events occur.
• Extract, Transform, and Load (ETL): Use this module to extract historical data from
PowerSCADA Expert and transform it into a format that can be used in the
Advanced Reporting and Dashboards module.
• Advanced Reporting Module files: Advanced Reporting and Dashboards
• PowerSCADA Anywhere
• McAfee Application Control
SQL Express
• Ensure that you have the correct Internet Explorer version for your operating
system. The PowerSCADA Expert Installation Guide provides this information.
• Install .NET 4.6.
• Install ENM.
• Install SQL Express.
• If you want to have Matrikon Explorer on the computer, install Matrikon before you
install PowerSCADA Expert.
• Install PowerSCADA Expert
• On the PowerSCADA Expert primary server computer only, install ETL.
You need to install PowerSCADA Anywhere on a remote client computer. See Install
and Configure the PowerSCADA Expert Secondary Server on page 99 for directions.
On the server that you will use for the Advanced Reporting and Dashboards Module,
install software in the order shown below. Follow the instructions to install
PowerSCADA Expert in the Installation Guide.
• SQL: You must install SQL Server on the Advanced Reporting and Dashboards
server. Refer to the Power Monitoring Expert installation documentation for
information.
• Advanced Reporting Module: Use the PowerSCADA Expert 8.1 with Advanced
Reports and Dashboards installation medium and installation guide.
For instructions on creating graphics pages, seeCreate the Operator HMI on page 40.
From the Citect Explorer screen, display the project: In the upper left corner of the
screen, choose the project from the drop-down menu.
Still on the Citect Explorer screen, click Servers > Network Addresses.
You should now have four I/O servers definied in the project: two on the primary server
Network Address and two on the standby server Network Address.
6. Modify the name of the trend server to indicate the redundant standby server.
7. Choose the network address earlier created to represent the secondar PSE server
machine.
8. Click Add.
You should now havetwo trend servers defined in the project: one on the primary
server Network Address and one on the standby server Network
NOTE: When you delete a cluster, you must also click File > Pack to completely delete
it from the system.
9. Click File > Compile.
10. If there are errors and/or warnings after the page is compiled:
a. At each error, click GoTo, which opens the location where the error has
occurred.
b. Using the information in the error message, correct the error.
c. After all errors are addressed, re-compile to verify that the errors are removed.
For additional information, click Help at the error screen.
This means that PowerSCADA Expert can run unattended, with no user account
required to log in to the server. The application can also be started automatically at
system power on, minimizing downtime in the event of a system reboot or unexpected
issue. Security benefits, as well as efficiency improvements, are gained when users do
not have to log in to the operating system. Access to the server can be restricted and
locked down to suit specific security requirements.
Configuration
When you install PowerSCADA Expert 8.1, a service is automatically created. By
default, the service ‘Status’ is stopped, the ‘Startup Type’ is set to Manual and the ‘Log
On As’ is set to the Local System account:
You may need to configure dependencies with another service. In the following
example, the FlexNet Licensing Service is used for product licensing, so it needs to be
the first service that is started. The Citect Runtime Manager will have a dependency on
the FlexNet Licensing Service to acquire a valid license.
You can use the Service Controller configuration command (sc config) to modify the
service entries in the registry and in the Service Control Manager settings.
NOTE:You must insert a space character after the depend= parameter. You must also
enclose any service names in quotes, which includes spaces in their names.
In order to launch PowerSCADA Expert at Windows startup, make sure that the
“Startup Type” is set to “Automatic,” then reboot the machine to allow PowerSCADA
Expert to run as a Windows service. Alternatively, you can right click the ‘Citect
Runtime Manager’ service, and select ‘Start’ to run PowerSCADA Expert without
rebooting the machine.
You can now log in and log off without disrupting the system.
It is always a good idea to "pack" before you compile. From the Citect Project Editor,
click File > Pack. Then, from the Citect Project Editor, click File > Compile. Correct any
errors and note any warnings.
NOTE: For complete instructions on the use of each field in these screens, click the
help link (?) at the top of the page. The help file will open to instructions for the screen
you are viewing.
Open the Profile Editor and click the Define Device Type Tags tab.
From the Add/Edit Device Type tab, click Add/Edit Custom Tags. Enter the information
for the new tag.
On the Add / Edit Custom Tags screen, click the help link (?) at the top right of the
screen. The help that displays leads you through adding, editing, or deleting custom
tags
NOTE: To avoid potential communication errors, you should use the Profile Editor to
create all custom tags that will communicate with equipment.
Instructions for editing or deleting a custom tag are after the table.
Type the new tag name; Maximum 32 characters; can include any alpha or
or type the changed numeric character, as well underscore (_) and backslash
Tag Name
name for a tag you are (\). Must begin with either an alpha character of
editing. underscore.
Type the name that you You might use this field for additional information on the
want to display when Add/Edit Custom Tags screen. For example, you could
Display Name
selecting the tag and in describe the data that it logs. It does not display
other displays. anywhere else in the system.
Check to display
Displays several additional filter options on the two
Display ‘Advanced’ filter additional filter options in
“Filter” tabs. These options will be useful in the future for
selections the Real Time Filter and
reporting purposes.
Alarm Filter tabs
You can include additional filters for either real time filters or alarm filters. Though not currently used, these filters
will provide metadata for later reporting. Standard tags have some of these filters selected.
A typical usage for these filters might be: when creating a custom tag from an already existing standard tag, you
can create matching metadata by using the filters that have been built in to the standard tag.
Real Time Filters tab (dropdown lists are expanded when “Display ‘Advanced’ filter selections” is
checked)
Select a category for this This field provides metadata about the tag. It will be used
Category Type
tag. in future reports.
Utility Type Select a utility type. Metadata for future use in reporting.
Statistical Type Select a statistical type. Metadata for future use in statistical reporting.
Alarm Filters tab (dropdown lists are expanded when “Display ‘Advanced’ filter selections” is
checked)
Select the alarm Used for filtering and sorting alarm data. Also metadata
Categorization
category for future use in statistical reporting.
Select the severity level Used for filtering and sorting alarm data. Also metadata
Alarm Level
of the alarm. for future use in statistical reporting.
If the tag is associated with a device type, you must first deselect the tag:
1. Change the option to Edit Existing and display the tag you want to delete.
2. Click Display Associated Device Types to display all device types that include this
tag. Make a note of the device types.
3. Return to the Add/Edit Device Type screen. For each device type listed, deselect
the tag that you want to delete.
The variable tag properties used in this screen are described in a topic in the Citect
help file. For detailed information, see Variable Tag Properties in the
citectSCADA.chm help file (Program Files> Schneider Electric > PowerSCADA Expert
> v8.1 > bin).
protocol such as IEC 61850 or DNP3. Each protocol requires a slightly different
process.
The help file describes the process for each of these protocols:
• IEC 61850
• Modbus third party
• DNP3
• composite device type
To begin creating a new custom device type, open the Profile Editor.
From the Define Device Type Tags tab, click Add/Edit to display the Add/Edit Device
Type window. Complete the information on the screen, following instructions in the
help file for the protocol the device uses.
You can only add onboard alarms for devices using the CM4, PM8, Micrologic, or
Sepam drivers. CM4, PM8, and Micrologic unique IDs must be decimal; SEPAM
unique IDs must be hexadecimal.
1. From the device, obtain the unique identifier for this alarm. Additionally, for
MicroLogic, you need to include the unique sub-identifier.
2. You also need the file number in which alarms on stored on the device.
3. From the Profile Editor, add the onboard alarm.
where "project name" is the name used when you created the project
After you export the profile, you will add the included I/O devices into your final project.
The first three options send you to a wizard that walks you through creating, removing,
or updating
Throughout the I/O Device Manager wizard, there are fields that will only accept a valid
entry. They are marked with a red asterisk (!). The asterisk remains there until you enter
a response that is of the correct length or includes only the acceptable characters. The
asterisk disappears when you have entered a valid response.
The following link provides additional information that you need to know.
Throughout the I/O device wizard, there are fields that will only accept a valid entry.
They are marked with a red exclamation point (!). The exclamation point remains there
until you enter a response that is of the correct length or includes only the acceptable
characters. The exclamation point disappears when you have entered a valid
response.
For each device added using the I/O Device manager wizard, follow the same
redundancy steps outlined when earlier adding the NetworkTagsDev and zOL
redundant devices. Be sure to select a primary I/O server and a standby I/O server,
each from different network addresses.
For each device added using the I/O Device manager wizard follow the same
redundancy steps outlined in Add Redundant NetworkTagsDev and zOL Devices on
page 15. Be sure to select a primary I/O server and a standby I/O server, each from a
different Network Address.
Click one of these links to display instructions to add each type of protocol:
Before you begin, make sure that you have added at least one cluster and the
appropriate servers for this project (see Add Redundant I/O Alarm, Report, and Trend
Servers on page 13).
Then, make sure that you have set up each of these clusters in the I/O Device
Manager:
Cluster Setup: Before you add devices, you need to set up each cluster that was
created for the project (you must have added at least one cluster to PowerSCADA
Expert before you do this):
1. From the I/O Device Manager, under System Devices, click Cluster Setup. Click
Next.
2. At the Enter Instance Information screen, a cluster name displays. Click Next.
3. If there are multiple clusters, the Select cluster screen displays. Choose the cluster
you want to set up. Click Next.
4. If there are multiple I/O servers in the cluster, the Select I/O servers screen displays.
Check Supports Redundancy and select the I/O servers to which you want to add
the device. Click Next.
5. At the Ready to perform action screen, click Next.
If you have more than one cluster to add, repeat steps 3 through 5 for each cluster.
When you are finished adding clusters and I/O servers, you return to the I/O Device
Manager welcome screen.
5. At the Enter instance information screen, type a descriptive profile name, for
example: CM4Bay1Circuit1 (no spaces or punctuation; to allow space in
PowerSCADA Expert, the preferred limit is 16 characters). The Comment field is
stored in the equipment.dbf file.
NOTE: There are several “description” or “comment” fields throughout the product.
These fields can be used to create copy for translation purposes. If you type a
Comment in this format:
@(XXX), where XXX = the copy that is to be translated,
the copy you typed in the comment field is added to the default language, named
English.DBF. After the project is compiled, this file is located in Documents and
Settings\All Users\Application Data\Schneider Electric\PowerSCADA Expert 8.0,
Servce Release 1\User\[your project]. English.dbf contains terms that will be
translated from English.
To create another language file for translation, set the Citect.ini parameter
[Language]LocalLanguage to the specified language, then re-compile. So, for
example, if you set this parameter to French, a French.dbf file is created in the
project folder when you compile. You can then enter the translated text in the
LOCAL field of the file. Repeat this same step for each additional language file you
want in this project.
At runtime, the user will be able to choose the .dbf file that is to be used in the
display, thus changing the language used in the display.
Click Next.
6. At the Select I/O servers screen, choose the primary and standby servers. You can
only set the standby server if you check the "Supports Redundancy" box. Click
Next.
7. If you choose to add an optional sub-profile: At the Configure Sub-Profile
Communications Method screen, choose the communications method used for the
first sub-profile in this project. Click Next.
8. At the Communications Settings screen, type the gateway address and station
address for each of the servers. If you check the "Same as Primary" box for standby,
you will use the same addresses for the primary and standby. Click Next.
9. At the Port Settings screen, you can rename each of the ports. A new port will be
generated for each new name. Click Next.
10. At the Ready to perform action screen, click Next.
After the devices are added, a screen displays telling you that the project was
updated successfully.
To view a detailed list of all of the device profiles and all operations performed in
the project, check the View audit log box. The list displays after the device is added.
To continue adding or removing device profiles, click Next. Repeat steps 3 through
8.
11. When you have finished adding devices, uncheck the Add/remove more equipment
option, then click Finish.
If you checked the View audit ... box, the list displays.
If you did not check the Add/remove... box, the I/O Device Manager closes. If you
checked the Add/remove ... box, the Welcome screen displays again.
12. From any of the three PowerSCADA Expert screens, compile the project.
13. When all errors are corrected, click File > Run to view the runtime environment.
Before you begin, make sure that you have added at least one cluster and the
appropriate servers for this project (see Add Redundant I/O Alarm, Report, and Trend
Servers on page 13).
Then, make sure that you have set up each of these clusters in the I/O Device
Manager:
Cluster Setup: Before you add devices, you need to set up each cluster that was
created for the project (you must have added at least one cluster to PowerSCADA
Expert before you do this):
1. From the I/O Device Manager, under System Devices, click Cluster Setup. Click
Next.
2. At the Enter Instance Information screen, a cluster name displays. Click Next.
3. If there are multiple clusters, the Select cluster screen displays. Choose the cluster
you want to set up. Click Next.
4. If there are multiple I/O servers in the cluster, the Select I/O servers screen displays.
Check Supports Redundancy and select the I/O servers to which you want to add
the device. Click Next.
5. At the Ready to perform action screen, click Next.
If you have more than one cluster to add, repeat steps 3 through 5 for each cluster.
When you are finished adding clusters and I/O servers, you return to the I/O Device
Manager welcome screen.
Before you begin, make sure that you have added at least one cluster and the
appropriate servers for this project (see Add Redundant I/O Alarm, Report, and Trend
Servers on page 13).
Then, make sure that you have set up each of these clusters in the I/O Device
Manager:
Cluster Setup: Before you add devices, you need to set up each cluster that was
created for the project (you must have added at least one cluster to PowerSCADA
Expert before you do this):
1. From the I/O Device Manager, under System Devices, click Cluster Setup. Click
Next.
2. At the Enter Instance Information screen, a cluster name displays. Click Next.
3. If there are multiple clusters, the Select cluster screen displays. Choose the cluster
you want to set up. Click Next.
4. If there are multiple I/O servers in the cluster, the Select I/O servers screen displays.
Check Supports Redundancy and select the I/O servers to which you want to add
the device. Click Next.
5. At the Ready to perform action screen, click Next.
If you have more than one cluster to add, repeat steps 3 through 5 for each cluster.
When you are finished adding clusters and I/O servers, you return to the I/O Device
Manager welcome screen.
5. At the Select I/O servers screen, choose the primary and standby servers. You can
only set the standby server if you check the "Supports Redundancy" box. Click
Next.
6. If you choose to add an optional sub-profile: At the Configure Sub-Profile
Communications Method screen, choose: At the Configure Sub-Profile
Communications Method screen, choose the communications method used for the
first sub-profile in this project. Click Next.
7. At the Communications Settings screen, type the IP address, port number, and
device address for each of the servers.
NOTE: The DNP3 port number is by definition 20000. You must type 20000 here in
order for communications to work correctly.
If you check the "Same as Primary" box for standby, you will use the same
addresses for the primary and standby. Click Next.
8. At the Port Settings screen, you can rename each of the ports. A new port will be
generated for each new name. Click Next.
9. At the Ready to perform action screen, click Next.
After the devices are added, a screen displays telling you that the project was
updated successfully.
To view a detailed list of all of the device profiles and all operations performed in
the project, check the View audit log box. The list displays after the device is added.
To continue adding or removing device profiles, click Next. Repeat steps 3 through
8.
10. When you have finished adding devices, uncheck the Add/remove more equipment
option, then click Finish.
If you checked the View audit ... box, the list displays.
If you did not check the Add/remove... box, the I/O Device Manager closes. If you
checked the Add/remove ... box, the Welcome screen displays again.
11. From any of the three screens, compile the project.
12. When all errors are corrected, click File > Run to view the runtime environment.
There will be an additional .dbf file for each translated language. At runtime, the user
will be able to choose the .dbf file that they want to use in the display. This changes the
language in the display.
Before you begin, make sure that you have added at least one cluster and the
appropriate servers for this project (see Add Redundant I/O Alarm, Report, and Trend
Servers on page 13.
Then, make sure that you have set up each of these clusters in the I/O Device
Manager:
Cluster Setup: Before you add devices, you need to set up each cluster that was
created for the project (you must have added at least one cluster to PowerSCADA
Expert before you do this):
1. From the I/O Device Manager, under System Devices, click Cluster Setup. Click
Next.
2. At the Enter Instance Information screen, a cluster name displays. Click Next.
3. If there are multiple clusters, the Select cluster screen displays. Choose the cluster
you want to set up. Click Next.
4. If there are multiple I/O servers in the cluster, the Select I/O servers screen displays.
Check Supports Redundancy and select the I/O servers to which you want to add
the device. Click Next.
5. At the Ready to perform action screen, click Next.
If you have more than one cluster to add, repeat steps 3 through 5 for each cluster.
When you are finished adding clusters and I/O servers, you return to the I/O Device
Manager welcome screen.
LDName
In the Additional Information section at the bottom, you can change the original
logical device names for the IED. This is required only if the logical device name
was changed in the SCL file that was imported into the Profile Editor.
blocks) can be used to return data in blocks rather than in individual tags. To enter
either one, you need to have downloaded an SCL file for the device in question.
When you click the line to add data, you must browse to the SCL file and select the
BRCB/URCB you want. You will need the logical device, logical node, and RCB
names. The Help column gives examples of the formatting that is required.
Click Next.
5. At the Communications Settings screen, browse to the location where you have
saved the SCL file. If there is only one IED, it displays automatically; otherwise,
choose the correct device. Click Next.
6. At the Ready to perform action screen, click Next.
After the devices are added, a screen displays telling you that the project was
updated successfully.
To view a detailed list of all of the device profiles and all operations performed in
the project, check the View audit log box. The list displays after the device is added.
To continue adding or removing device profiles, click Next. Repeat steps 3 through
6.
7. When you have finished adding devices, uncheck the Add/remove more equipment
option, then click Finish.
If you checked the View audit ... box, the list displays.
If you did not check the Add/remove... box, the I/O Device Manager closes. If you
checked the Add/remove ... box, the Welcome screen displays again.
8. From any of the three screens, compile the project.
9. When all errors are corrected, click File > Run to view the runtime environment.
If you checked the View audit ... box, the list displays.
If you did not check the Add/remove... box, the Profile Wizard closes. If you checked
the Add/remove... box, the Welcome screen displays again.
You first need to create the .CSV file that you will use to add the devices. For help, see:
After you create the .CSV file, you use it to add multiple devices to the project. See:
NOTE: For sample CSV files, see CSV File Samples on page 38.
5. In the sample CSV worksheet, enter the following information for each device that
you want to add:
a. ProfileName: the name of the profile that has been exported from the Profile
Editor into the target PowerSCADA Expert project. Type the names of the
profiles that have been selected for this project. To view names, open the Profile
Editor utility.
b. Name: Enter the device name, limit of 32 characters; include only letters,
numbers, and underscores (_). The first character cannot be a number or
underscore. This field becomes the "Name" on the I/O Devices screen and the
"I/O Device" name on the Equipment screen.
c. Cluster: The name of the cluster to which the device will be added.
d. Equip: Enter the equipment name, limit of 40 characters; include only letters,
numbers, and periods (.). The first character cannot be a number or period. This
field becomes the "Name" on the Equipment screen. You will use this when
adding genies to drawings.
e. CommsMethod: Type the communications protocol being used, e.g.,
MODBUS/RTU via Gateway. See list below for alternate communication
connections. When using a composite device, do not use this field. You must
enter a "SubProfile1Description" (and a "SubProfile2Description" for the second
part of the composite device).
DNP3 Serial
DNP3 TCP
Modbus/RTU via Gateway
Modbus/TCP
ION
ION/Ethergate
IEC60870-5-104 TCP
IEC61850 Native
f. Primary SclFileName: For IEC61850 Native, the address where the CID (SCL)
file is stored.
g. Primary IedName: For IEC61850 Native, the name of the IED in the CID file.
This was created when the profile was added in the Profile Editor.
h. FTPHost: For IEC61850 Native, the on-board FTP. Not currently used in
PowerSCADA Expert.
i. FTPUserName/Password: For IEC61850 Native, the username and password
for FTP on the device.
j. BRCBS/URCBS: For IEC61850 Native, buffered report control blocks (BRCBs)
and unbuffered report control blocks (URCBs) can be used to return data in
blocks, rather than in tags. These two fields provide the instruction used for
each. The two examples in the example are:
BRCB: CFG/LLN0$BR$BRep01,CFG/LLN0$BR$BRep06
and
URCB: CFG/LLN0$RP$URep02
k. Primary IO Server Name: The name of the primary server I/O server for the
device..
l. PrimaryIPAddress: Type the IP address for the the primary server (required only
for MODBUS/RTU and MODBUS/RTU via Gateway).
m. PrimaryEquipmentAddress: Type the device address (required only for
MODBUS/RTU and MODBUS/RTU via Gateway).
n. PrimaryPortNumber: Type the port number of the primary server (required only
for MODBUS/RTU and MODBUS/RTU via Gateway).
o. PrimaryPortName: Type the port name of the primary server (required only for
MODBUS/RTU and MODBUS/RTU via Gateway).
p. Columns that begin with "SubProfile" followed by a number (e.g., SubProfile1,
SubProfile2, SubProfile3, etc.) are used to provide the same information as the
Primary and Standby columns for composite devices where each SubProfile is
a specific device which is part of the larger composite device.
q. Comment: This is an optional description of the device; maximum 254
characters.
6. Close the example CSV file, if it is open.
7. Go to Add Multiple Devices to the Project on page 36 to add the devices from this
.CSV file to your PowerSCADA Expert project.
Status Options
In the upper right corner of the screen, you see the following:
• Display options: Click any of the boxes to cause the corresponding message types
(such as error and warning information) to display during and after the automation
process.
• Automation status: In blue copy, the most recent activity displays, such as
"Validation Complete: data is valid".
• Clear button: Click to clear the message lines from the right pane.
To run batch changes related to a specific CSV file, follow these steps:
1. Launch the Manage I/O Devices tool (From the Citect Project Editor, click Tools
> Manage I/O Devices.
On the new screen, the Project Name field displays your project name. If there are
multiple projects, it displays the first one in alphabetic order.
2. Choose the correct project.
The Citect INI file and Equipment profile are automatically selected, based on the
project.
3. Input CSV defaults to the current directory. If you have stored the CSV elsewhere,
browse to where you have placed it.
4. Before you add, update, or remove devices and profiles, choose the action you
want to perform. To ensure that you will be successful, validate the action:
Action Description
Adding Devices Use to add devices that you have defined in the CSV file.
Action Description
Removing Use to remove devices from the project You only need the ProfileName and Equip columns
Devices for this action.
Use to update tag associations for a device if the device profile has changed. You only
need the ProfileName and Equip columns for this action. (Note: This action does not
Updating Devices
update the IP address or other device information. If these attributes are not correct, you
need to remove, and then re-add, the device.).
Use to update the tag associations for all of the devices in the specified profile(s). You only
Updating Profiles
need the ProfileName and Equip columns for this action.
If you are unable to validate or perform the desired action, read the right-hand pane.
Errors and warnings will help you troubleshoot the issue.
Launch PowerSCADA Expert and verify communication for all of the devices listed in
the spreadsheet.
If you want to export information from the project file (variable tags, clusters, and
equipment, for example), click Export at the bottom left part of the window. Choose the
location at which you want to store the files, and click OK.
After you have added devices to the project, and you make changes to the device in
the Profile Editor (e.g., add a large number of tags),you can use the I/O Device
Manager to bring the changes in the project.
NOTE: If you have made manual changes to the profile in PowerSCADA Expert
(Citect), do not use this process: you could corrupt your data. You must delete the
device from the project, re-export it from the Profile Editor, and add it back to Citect via
the I/O Device Manager.
For instructions on defining multiple devices, see Use a CSV File to Define Multiple
Devices on page 34.
IEC104.2
IEC61850
It is always a good idea to "pack" before you compile. From the Citect Project Editor,
click File > Pack. Then, from the Citect Project Editor, click File > Compile. Correct any
errors and note any warnings.
After you create the graphics page, you need to compile it. You can run the page to
review its elements and correct any errors.
6. Check Linked to maintain the link for the graphics page with the original template.
Then, if you change the template, the page will reflect the change.
7. Check Designed for showing title bar if you want to display the graphics page with
the Windows title bar visible. The Windows title bar lets you maximize, minimize
and close the window.
8. Click OK.
9. Save the page (File > Save As): Type a name, to be used for the page in the
runtime view; and choose the project to which you want to add it. Click OK.
Later, when you need to access this page, open it from the File > Open option in the
Graphics Builder.
2. From the Paste Genie screen, choose a library (to ensure that all PowerSCADA
Expert features are available, choose a library that begins with “pls”). If you want to
edit a genie or create a new one, see Enter Genie Properties on page 43 for
instructions.
3. From the available icons in the selected library, select a genie; click OK to paste the
genie on the graphics page.
4. A popup window displays for you to enter genie properties. Enter the requested
information for the appropriate object:
The following links provide information on how to configure the various genie types:
Configure a Meter
Use this option to configure meters that you add to a one-line in the graphics builder.
1. Display the meter window by pasting the meter genie on to the graphics builder
page.
2. Equipment: From the drop-down list, choose the name of the equipment
represented by the genie (this is the equipment name that you entered in the
I/O Device Manager, e.g., CM4Main). To view the equipment that is available for
this page, you must have the project selected in the Citect Explorer.
3. Meter Number: Type the number you want to use for this meter (valid entries: 1–
1000). This number must be unique within this one-line.
4. Busbar Number: Type the number for the busbar that connects to the meter. Valid
entries: 1–1000.
5. Line Active: Enter the appropriate Cicode expression (such as MyTag1 > 0) to
determine when the meter detects power on the busbar.
6. Label 1 and Label 2: Type the information that you want to appear in the upper left
corner of the genie in the runtime environment.
7. Value Type: From the drop-down list, choose the tag you want to use for this genie.
The related information displays in the lower left corner of the genie in the runtime
environment.
This tag causes real-time data (such as currents) to display on the genie status
page in the runtime environment. If you do not choose a tag here, the status page
will not display the real-time data.
8. Units: From the drop-down list, choose the unit that you would like to display on the
genie in the runtime environment. Units that display here were added in the Profile
Editor.
9. Multiplier: Enter the multiplier that is to be applied to the units chosen in step 8.
10. Click OK to save the genie to the page and to return to the graphics builder page.
Configure a Source
Use this option to configure sources (e.g., utilities and generators) that you add to a
one-line in the graphics builder.
1. Display the source window by pasting the generator or utility genie on to the
graphics builder page.
2. Source Number: Type the number you want to use for this source (valid entries: 1–
100). This number must be unique within this one-line.
The source number is used when you determine coloring for the one-line.
3. Busbar Number: Type the number for the busbar that connects to the source. Valid
entries: 1–1000.
4. Line Active: Enter the appropriate Cicode expression (such as MyTag1 > 0) to
dictate when the source powers the busbar.
5. Click OK to save the genie to the page and to return to the graphics builder page.
Configure a Transformer
Use this option to configure transformers that you add to a one-line in the graphics
builder.
1. Display the transformer window by pasting the appropriate genie on to the graphics
builder page.
2. Top and Bottom Source Number: For each source, whether top or bottom, type a
source number to control voltage-level coloring for the secondary side busbar.
Valid entries: 1–100.
There are two possible configurations:
Pass-through coloring: If you leave these fields blank, the transformer will transfer
the color that is assigned to the primary side (source) to the secondary side
(destination) busbar. For example, if Source 3 feeds the source busbar of a
transformer, and you leave this field blank, then Source 3 will also feed the
destination busbar (and the Source 3 color will be used).
Voltage-level coloring: When you enter top and bottom source numbers, the
transformer colors the one line based on this number. For example, if Source 3
feeds the top of the transformer, but you enter 5 for the bottom source, the
transformer feeds the color from Source 5 to the destination (bottom) busbar.
3. Source and Destination: When you connect to busbars, type the numbers for the
connection source and destination busbars. Valid entries: 1–1000.
4. Label 1 and Label 2: Type the information that you want to appear in the upper left
corner of the genie in the runtime environment.
5. Click OK to save the genie to the page and to return to the graphics builder page.
5. Label 1 and Label 2: Type the information that you want to appear in the upper left
corner of the genie in the runtime environment.
6. Value Type: From the drop-down list, choose the tag you want to use for this genie.
The related information displays in the lower left corner of the genie in the runtime
environment.
This tag causes real-time data (such as currents) to display on the genie status
page in the runtime environment. If you do not choose a tag here, the status page
will not display the real-time data.
7. Units: From the drop-down list, choose the unit that you would like to display on the
genie in the runtime environment. Units that display here were added in the Profile
Editor.
8. Multiplier: Enter the multiplier that is to be applied to the units chosen in step 7.
9. Click OK to save the genie to the page and to return to the graphics builder page.
NOTE: If you choose to resize a circuit breaker genie after you paste it into a page, you
must keep the relative dimensions (proportions) the same. Otherwise, the racked
in/racked out animation will not display correctly.
2. Breaker Number: Type the ID numbers you want to use for the left side and right
side of this ATS. Valid entries: 1–1000. Each number must be unique within this
one-line.
3. Busbar: Type the numbers of the left and right source busbars, and for the
destination (bottom) busbar. Valid entries: 1–1000.
4. Label: For each ATS side, type the information that you want to appear on the
switch in the runtime environment (example: Pri and Emer).
5. Closed Expression: For each side of the switch, type the information that should
display when that side is closed (example: Tag1 <> 1). Do not use "NOT" in the
expression.
Display Information
1. Label 1/Label 2: Type the descriptive information that you want to appear in the
upper left corner of the genie in the runtime environment.
2. Click OK to save the genie to the page and to return to the graphics builder page.
Configure a Busbar
Use this option to configure busbars that you add to a one-line in the graphics builder.
Using this option, you can assign a busbar number to a busbar, and ultimately, to use
busbars to connect genies on a one-line.
Busbar numbers associate devices within drawings, and they help you set up
animation for genies. The busbar entered here is also used for the associated device.
1. Display the busbar window by pasting the busbar genie on to the graphics builder
page.
2. Busbar Number: type the number you want to use for this busbar. Valid entries: 1–
1000.
3. Line Active: This field is no longer used.
4. Click OK to save the genie to the page and to return to the graphics builder page.
One-Line Colors
In previous versions of the software, line coloring was determined by the line active
state of the busbar. Driven by the busbar color, this state was then fed to all of the
components on that page.
In PowerSCADA Expert 8.1, coloring is based on the source and meter line active
states. Sources dictate the colors for each genie. Meters can only determine if a bus is
active. When the bus is live, the meter then colors based on the source that is
connected to the bus. If there is no source, the default color is used.
NOTE: Depending on how you configure transformers, you can either use this "pass-
through" coloring, or you can use "voltage-level" coloring. See Configure a
Transformer on page 44 for more information.
Assigning Colors
To assign a color to a source, open the Color Configuration tab of the One Line
Configuration Utility (Citect Editor > Tools > One-Line Configuration).
1. Choose the project for which you want to assign colors.
2. Choose the Project Color Palette. Select the project in which the project genies are
defined: usually PLS_Include.
3. For each source or transformer, choose the desired color: click the color cell for that
source/transformer; then choose the color from the dropdown list. You can also
select a color for unknown sources, off, and error. To indicate a flashing color, you
can select two colors.
4. When all colors are assigned, click Save.
It is always a good idea to "pack" before you compile. From the Citect Project Editor,
click File > Pack. Then, from the Citect Project Editor, click File > Compile. Correct any
errors and note any warnings.
To access this screen, click Tools > One-Line Configuration from the Citect Editor
screen. There are two tabs.
See Review Genie Configurations for information about using this tab.
On the Color Configuration tab, you can assign colors to sources. see One-Line
Colors on page 46 for information about using this tab.
Modify AdvOneLine.csv
After you run the One-Line Configuration Utility, open the project to verify that the
animation is working correctly. If the animation is not correct, repeat the process of
running the utility and verifying out animation until all errors are corrected.
Errors ( ) and warnings ( ). You must correct errors; otherwise, you may not
be able to compile, and the animation will not work. Although you might not need to
correct warnings, you should review them to ensure that their settings are correct. Note
that, as you hover over an error or warning icon, a tooltip tells you what is wrong with
the genie.
Field Description
Type: Information is sorted first by genie type, then by page. This option is useful
when you want to see all genies of a certain type together, regardless of where they
are in the drawing pages.
Show By:
Page: Information is sorted first by page, then by genie type. This option is useful
when you want to see all genies on a certain page.
Field Description
Check this box to view the basic information plus any additional information relevant
Advanced Properties
to that genie type.
Check the individual boxes for how you want to view information. For example, you
State Filters: might only be interested in viewing genies that have error states. This option controls
only the genie information in the right-hand pane.
Genie Types Types are: breakers, busbars, meters, sources, and transformers
Check this box to cause the repair feature to repair the entire project.
Use this feature only to upgrade projects that are earlier than PowerSCADA Expert
8.1. This option repairs the entire project, renumbering all busbars, breakers, meters,
Repair—Upgrade Project duplicate Sim sources, and sources. Additionally, busbar line active states are used
to determine meter and source line active states.
DO NOT perform Repair—Upgrade Project more than once, and do not perform it on
a PowerSCADA Expert 8.1 project.
For specific information about each type of genie, click a link below:
Communication Errors
When communication errors occur, the object that has lost communications gives an
"unknown" status, which is graphically represented in the one-line animation.
Error Logging
The most common errors in a CSV file are logged to the Run project in a file named
AdvOneLineStatusLog.txt. The file can contain several messages The table below lists
these errors and their descriptions.
The main logic loop has thrown an exception that has not been
Main Execution Loop Unexpected Failure
handled by other error messages.
You must have your project running before you execute the
PLSCADA is not in runtime
AdvOneLine.exe file.
Invalid prefix located in The CSV parser has detected an invalid component prefix. This
CSVParser.FormatCSVData error message should not occur.
ERROR: Duplicate Component Name Check the CSV file to ensure that you do not have two sources,
Encountered meters, or breakers with the same component number.
ERROR: Node Not Specified You have a component without a Bus1 and/or Bus2 specified.
CAUTION
DATA CORRUPTION
Always make a backup copy of your project before you perform a repair.
Failure to follow these instructions can result in data loss and corruption of your
project.
Follow these steps to view the One Line Configuration Utility, and to make repairs to
your projects:
1. Open the utility: From the Citect Project Editor, click Tools > One-Line
Configuration.
The first time you launch this utility, it could take several minutes for it to read all of
the project information.
The utility will read the project's graphics pages to analyse the project. If it appears
that the project is from a version prior to PowerSCADA Expert 8.1, a message
displays, telling you that the project appears to be out of date. The default "Upgrade
Project" is checked in the lower right corner.
2. Click OK.
Genie information for the selected project displays. For descriptions of the fields on
this page, see Review Genie Configurations.
3. Choose the type of repair you want to perform:
Repair option alone (Upgrade Project not checked) attempts to fix errors and
warnings in a project (used for PowerSCADA Expert 8.1).
Repair option with Upgrade Project checked is used to upgrade projects
from previous versions of the product. This option renumbers all genies in the
project. Do not perform this option on a project more than once, and do not perform
it on PowerSCADA Expert 8.1 projects.
NOTE: When two busbars have the same line active, they are assigned the same
busbar number.
The following table describes the repairs made in each option.
4. Click Repair.
You see a message that describes the degree of repair that is about to take place.
Each message says that graphics pages "will not be modified by the repair
process." This means that the repairs will not be applied to your project graphics
ATS Information
The most commonly used information about the ATS genie displays by default.
When the Advanced Properties box is checked, the table expands to include
everything that is known about the selected ATS.
Column Description
Name of the page on which the genie is found (displays only from the folder
Page
level).
This is the breaker number for the left side, assigned when adding it to a
ID
page of a one-line.
This is the breaker number for the right side, assigned when adding it to a
ID2
page of a one-line.
Source Busbar1 The number of the source busbar for the left side.
Source Busbar2 The number of the source busbar for the right side.
ATS Errors
Before you use the drawing, you must correct all errors. Otherwise the project might not
compile; and the animation will not work.
State Solution
Errors ( )
Source busbar numbers must be The source busbar numbers are missing, or they are less than or equal to 0.
a number greater than 0. Add or change the source busbar numbers.
Destination busbar number must The destination busbar number is missing, or it is less than or equal to 0. Add
be a number greater than 0. or change the destination busbar number.
Source and Destination busbars The source and destination busbars have the same number; change one
must not be equal. number.
Busbar Information
The most commonly used information about the busbar genie displays by default.
When the Advanced Properties box is checked, the table expands to include
everything that is known about the selected busbar(s).
Column Description
Name of the page on which the genie is found (displays only from the
Page
folder level).
Busbar Errors
Before you use the drawing, you must correct all errors. Otherwise the project might not
compile; and the animation will not work.
State Solution
Errors ( )
Busbar number must be a The busbar number is missing, or it is less than or equal to 0. Add or
number greater than 0. change the busbar number.
When the Advanced Properties box is checked, the table expands to include
everything that is known about the selected breaker(s).
Column Description
Name of the page on which the genie is found (displays only from the folder
Page
level).
The equipment name entered when adding the genie via the Profile Wizard or
Equipment
Automation Interface.
Before you use the drawing, you must correct all errors. Otherwise the project might not
compile; and the animation will not work.
State Solution
Errors ( )
Source busbar number must be a The source busbar number is missing, or it is less than or equal to 0. Add or
number greater than 0. change the source busbar number.
Destination busbar number must The destination busbar number is missing, or it is less than or equal to 0. Add
be a number greater than 0. or change the destination busbar number.
Source and Destination busbars The source and destination busbars have the same number; change one
must not be equal. number.
Meter Information
The most commonly used information about the meter genie displays by default.
When the Advanced Properties box is checked, the table expands to include
everything that is known about the selected breaker(s).
Column Description
Name of the page on which the genie is found (displays only from the folder
Page
level).
The equipment name entered when adding the genie via the I/O Device
Equipment
Manager.
The Cicode expression (such as MyTag1 > 0) that determines when the
Line Active
meter detects power on the busbar.
Before you use the drawing, you must correct all errors. Otherwise the project might not
compile; and the animation will not work.
Warnings indicate settings that might be incorrect. Verify that the settings indicated by
the warnings are what you want.
Errors and warnings that you might see for meters are:
State Solution
Errors ( )
Meter number must be a number The meter number is missing, or it is less than or equal to 0. Add or change
greater than 0 and unique. the meter number.
Busbar number must be a The busbar number is missing, or it is less than or equal to 0. Add or change
number greater than 0. the busbar number.
Warnings ( )
Line Active should be present. Line Active should be entered to determine when the meter detects power.
Busbars across all meters should Verify that all busbars connected to this meter have the correct, unique,
be unique. numbers.
Source Information
The most commonly used information about the source genie displays by default.
When the Advanced Properties box is checked, the table expands to include
everything that is known about the selected source(s).
Column Description
Normal ( ), Warnings ( ), or Errors ( ). See the
State
following table for explanations of errors and warnings.
Before you use the drawing, you must correct all errors. Otherwise the project might not
compile; and the animation will not work.
Warnings indicate settings that might be incorrect. Verify that the settings indicated by
the warnings are what you want.
Errors and warnings that you might see for sources are:
State Solution
Errors ( )
Warnings ( )
Line Active should be Line Active should be entered so the source can detect
present. power on the busbar.
Transformer Information
The most commonly used information about the transformer genie displays by default.
When the Advanced Properties box is checked, the table expands to include
everything that is known about the selected transformer(s).
Column Description
Normal ( ), Warnings ( ), or Errors ( ). See the following table for
State
explanations of errors.
Name of the page on which the genie is found (displays only from the folder
Page
level).
Sim. Source This is the top source number used when adding the transformer.
Sim. Source 2 This is the bottom source number used when adding the transformer.
Transformer Errors
Before you use the drawing, you must correct all errors. Otherwise the project might not
compile; and the animation will not work.
State Solution
Errors ( )
Source busbar number must be a The source busbar number is missing, or it is less than or equal to 0. Add or
number greater than 0. change the source busbar number.
Destination busbar number must The destination busbar number is missing, or it is less than or equal to 0. Add
be a number greater than 0. or change the source busbar number.
Source and Destination busbars The source and destination busbars have the same number; change one
must not be equal. number.
If a top or bottom source is The number for the top or bottom source for this transformer must be greater
identified, it must be greater than than zero (for voltage-level transformers) or must be left blank (for pass-
0. through transformers).
Add Users
This section discusses how to set up user IDs and passwords for the project. For safety
reasons, only advanced users should be given access to such features as controls and
resets. User access rights (privileges) are defined in System > Roles form, in the Citect
Project Editor.
NOTE: The Default_Starter project includes a default user, with ID/password the
same: aol/aol.
You can use single sign on (SSO) to associate passwords for different products (such
as Citect with PowerSCADA Expert and Advanced Reporting Module). SSO allows the
Citect user, when logged in to runtime, to access external applications, such as
dashboards. For information on setting up SSO, see Security: Single Sign On in:
Circuit breaker,
PL_Sec_CBControl 1 X X X X
switch control
Circuit breaker
PL_Sec_Tagging 3 X X X
tagging
Alarms
PL_Sec_AlmAck 4 X X X X X
acknowledgment
Add/remove log-in
PL_Sec_UserConfig 7 X X
users
Reset alarms in
PL_Sec_AlmReset 8 X X
device
PL_Sec_
View waveforms 10 X X X X X
ViewWaveform
NOTE: Privileges 1, 3, and 5 are currently unused. You can use them as you wish.
All of these files need to have the same level of security, as they are interrelated.
Additionally, to prevent users from accessing and changing the code responsible for
enforcing user security in the runtime environment, you need to lock down the user
rights for the Cicode files (.ci extension) in the PLS_Includes project.
NOTE: Another way to lock users out from changing an existing project is to implement
read-only projects.
We recommend that you use Windows Authentication when you create user accounts.
The Users screen controls all of the user access levels for each project. To assign user
access, follow these steps:
1. From the PowerSCADA Expert Explorer, choose the project for which you want to
assign user access.
2. From the Project Editor, click System > Roles.
3. For the first user, assign a user role, Windows group name (optional), and global
privileges. If you need additional information, click Help from that screen. For global
privileges, see the table in Default User Access Settings (Privileges) on page 57 for
the level of each type of access right.
4. After you add the first role, click Add.
5. From the Project Editor, click System > Users.
6. Assign a user account. If you need additional information, click Help from that
screen.
7. After you add the first user, click Add.
8. To add additional users, do the following: with a user displayed, click Add (which
creates a copy of the user); type the new user information in place of the old
information; then click Replace to overwrite the information.
Note that the record count increases by one with each addition. To view the users
one at a time, scroll through the list.
To link a Windows user to a PowerSCADA Expert role, add the "role" that specifies the
Windows security group of which the Windows user is a member.
The pre-existing AutoLogin capability is extended to include the client, when the user
is a Windows user, having an associated PowerSCADA Expert role. In order to invoke
this functionality for a Windows user, you need to set the [Client]AutoLoginMode
parameter in the Citect.ini file.
Instead of using auto-login when the system starts up, users can also log in to
PowerSCADA Expert using any Windows user credential that is a member of the linked
group.
When the name of a PowerSCADA Expert user also has the same name as a Windows
user, the PowerSCADA Expert user takes priority at runtime. However, if a valid
PowerSCADA Expert user login does not succeed for some reason, the Windows user
credentials will not be checked and an alert will be generated to advise that the login
was not effective.
It is always a good idea to "pack" before you compile. From the Citect Project Editor,
click File > Pack. Then, from the Citect Project Editor, click File > Compile. Correct any
errors and note any warnings.
The pagemenu.dbf file for your project is in the same User directory, in the folder that
matches your project name.
Because it takes much effort to create the items that display on a graphics page, you
can use the menu settings from the PLS_Example project as a template for your new
project template. From it, you can copy and paste settings into an individual project’s
menu configuration file.
The following illustrates a blank Menu Configuration file (see the table below for
descriptions of the numbered fields):
The relative position within the final graphics page. If you leave this field blank, the
1: Order
default value 0 is used. (64 characters maximum)
These items establish the menu levels that will display. For example, you might use
2: Levels 1 through 4 "Single Lines" for level 1, followed by the substation for level 2, and the graphic name for
level 3. (Each line: 256 characters maximum)
The Cicode expression that you want to execute. Typically, you will use the "page
display" command followed by the actual page you want to see. For example:
3: Menu Command
PLSPageDisplay("CB_IEC_1")
which displays the page CB_IEC_1.
Displays a defined image along with the description for that level.
Images must already be defined in the project/include project. They are specified in the
format <library name>,<symbol name>. For example, in PLS_Example, the symbol used
for the level 2 of Single Lines is Substation3, entered as PLS_Icons.Substation3.
4: Symbol
Different menu levels are designed to be used with different symbol sizes for optimal
display. For Level 1 items (tab), the recommended symbol size is 16 x 16 pixels. For
Level 2 items, (buttons), the recommended symbol size is 32 x 32 pixels. Symbols are
not displayed for menu items of Level 3 or beyond.
5: Comment You can use up to 128 characters to add a comment (will not display on screen).
3. In the Symbol line, type the appropriate symbol/size information. See the table
aboveAdd Pages to Project Menu Configuration on page 61for information on this
field.
For information about alarm types, see AlarmDsp in the Cicode Programming
Reference help file.
The PLS_Example project also has many good examples for how to add each alarm
page to your project. In PLS_Example, click System > Menu Configuration from the
Citect Project Editor. You will see all active alarms in a page named "Alarm Log" with
AlarmType=0.
To add the tag viewer to a project graphics page, follow these steps:
1. From the Citect Project Editor, click System > Menu Configuration.
2. In the Menu Command line, add the Cicode method that will open the page:
PLSPageDisplay("PLSTagView")
When viewing the tag viewer in runtime, as long as the screen resolution is one that
Citect supports, the view will be correct.
For information about viewing tags, see Use the Tag Viewer on page 107.
NOTE: Carefully consider how and where you display the web report root.
PowerSCADA Expert has native reports, and the customer should see as consistent
interface an as possible. When you modify the menu, you can better maintain the
experience of a single HMI if you remove certain native links (in the PLS_Example
project) and if you are selective about where the root is displayed.
About the PLS_ShowWebReportDsp Cicode: In this step, you call the PLS_
ShowWebReportDsp function from a menu configuration. This function is part of the
Cicode in the PLS_Applications.ci file, which is packaged with this document. The
code is shown below for reference.
FUNCTION PLS_ShowWebReportDsp(INT iReportID, STRING sTitle = "")
IF ("" = sTitle) THEN sTitle = "Reporting"; END
STRING sUrl = _PLS_Apps_BuildWebReporterUrl(iReportID);
IF ("" <> sUrl ) THEN
PLS_WebDsp(sUrl, sTitle, "PLS_ShowWebReportDsp",
IntToStr(iReportID) + ",^"" + sTitle + "^"");
END
END
NOTE: After you are on the Web Reporter page, you stay logged in until you close the
browser or refresh the page.
NOTE: After you are on the Web Reporter page, you stay logged in until you close the
browser or refresh the page.
1. From the Citect Project Editor, click System > Menu Configuration.
NOTE: You will later determine the ReportID that you enter below in this section:
Determine the Advanced Reports Report ID to Use In PowerSCADA on page 82. You
can repeat this procedure to add menu items for each of the saved reports that you
want to display from the PowerSCADA Expert navigation menus.
2. Enter the call to the ShowWebReportDsp function (found in the PLS_Applications.ci
file), with 0 entered for the ReportID and the page title.
3. If you have multiple reports configured, and want to display a different report for
different devices, repeat this procedure for each button, with the correct ReportID.
4. Save, compile, and run the project to test the functionality.
NOTE: Carefully consider how and where you display the web report root.
PowerSCADA Expert has native reports, and the customer should see as consistent
interface an as possible. When you modify the menu, you can better maintain the
experience of a single HMI if you remove certain native links (in the PLS_Example
project) and if you are selective about where the root is displayed.
2. If you create multiple slideshows and you want to display a different dashboard for
each slideshow, repeat these steps for each button, using the correct slideshow
name.
3. Save and compile. Then run the project to test functionality.
About the PLS_ShowDashboardDsp Cicode: In this step, you call the PLS_
ShowDashboardDsp function from a menu configuration. The code is:
FUNCTION PLS_ShowDashboardDsp(STRING sSlideShow = "", STRING sTitle
= "")
IF ("" = sTitle) THEN
IF ("" = sSlideShow) THEN
sTitle = "Dashboards";
ELSE
sTitle = "Dashboards - " + sSlideShow;
END
END
STRING sUrl = _PLS_Apps_BuildDashboardUrl(sSlideShow);
IF (sURL <> "") THEN
PLS_WebDsp(sUrl, sTitle, "PLS_ShowDashboardDsp",
"^"" + sTitle + "^"");
END
END
add a WebDiagram view in your genie equipment popup. SeeAdd Web Diagrams to
Equipment Popups on page 94 for more information.
To add a new page to the project which will display a given WebDiagram, create a new
menu configuration item which calls the PLS_WebReachDsp cicode explained below.
In the Citect Project Editor, click System > Menu Configuration. Enter the call to the
PLS_WebReachDsp function (found in the PLS_Applications.ci file), with the
slideshow (if desired), and the page title.
In the following step, you will call the WebReachDsp function from a button. This
function is part of the Cicode in the PLS_Include.ci file, which is packaged with this
document. The code is shown here for reference:
FUNCTION PLS_WebReachDsp(STRING sDeviceName, STRING sTitle = "")
STRING sPage = PLS_GetWebReachURL(sDeviceName);
IF ("" = sPage) THEN RETURN; END
If the diagram does not display, try the following troubleshooting steps:
• Enter the URL of the diagram directly into a browser window; verify that it launches
The URL is: http://[servername]/ION/default.aspx?dgm=OPEN_TEMPLATE_
DIAGRAM&node=[device name]
If this does not work, verify that the WebReachServer is correct in your citect.ini, and
the diagram appears correctly in WebReach.
• The steps above should resolve most issues. One last option is to test by putting the
web browser in a window on the calling page.
It is always a good idea to "pack" before you compile. From the Citect Project Editor,
click File > Pack. Then, from the Citect Project Editor, click File > Compile. Correct any
errors and note any warnings.
Access the Application Configuration Utility via the desktop link or the Start menu:
Start > All Programs > Schneider Electric > PowerSCADA Expert 8.1 > Config Tools >
Application Config Utility.
Click the links below to configure one-line settings and set up the Citect data platform:
One-Line Engine
One-Line Engine
There are three tabs in the One-Line Engine module. On all three tabs, two buttons at
the bottom allow you to:
Restart AOL: Click to manually restart the Advanced One Line engine.
Use this page to link a Citect user name and password to be used when the Schneider
Electric CoreServiceHost services connect with Citect runtime. Before you begin:
• Add the username/password to the Citect project.
• Have Citect running in runtime mode.
1. Citect I/O Server Address: Choose the server address for the project that is
running. (May be left blank if you use a local connection and you are running
PowerSCADA Expert as a service.)
2. Citect User Name: Type the user name of a user configured in the project.
3. Citect Password:Type the password for the Citect project user entered above.
4. Test Credentials: Click to verify these credentials. If you see an error, verify the
name and password, and that Citect runtime is running, and try again.
When your Citect project is running and the credentials are valid, you see
Connection Successful. The user name and password can be used to connect to
Citect.
Citect Licensing Details: This is a read-only field that displays the license key
currently in use on the Citect server machine.
It is always a good idea to "pack" before you compile. From the Citect Project Editor,
click File > Pack. Then, from the Citect Project Editor, click File > Compile. Correct any
errors and note any warnings.
If you are running SCADA as a Service, navigate to the PowerSCADA Expert bin
directory and launch the Service Display client shortcut.
The following illustration shows a genie and its related genie pop-up.
Use the Tag Viewer to learn the status of all project tags.
During runtime, open one of the pages that displays real time tag values. The example
below is PLSTagView. Compare the values displayed on the TagViewer page to actual
values displayed on the meter itself. If the compared values match then you have
verified communications with that device.
See also:
Use the One-Line Configuration Utility to verify that devices are connected and
animations are working.
The electrical system must be in a non-critical state so that the breakers being used will
not cause any adverse effects (such as putting a person’s safety at risk or affecting a
process). Breaker genies should be able to remotely operate the breaker.
DANGER
HAZARD OF ELECTRIC SHOCK, EXPLOSION, OR ARC FLASH
In the Graphics Builder, create a one-line diagram with breaker genies that use the
breakers you want to verify. Use the proper logic and passwords to configure the one-
line on the diagram. After the diagram is successfully created, open the graphic page
in runtime mode.
The breaker genie status indicator should mirror the current breaker state. Also, the
busbar color should accurately reflect the electrical state of the conductors connected
to the breaker.
The following illustrates the appearance of the one-line drawing with breakers first
open and then closed. Note the color change, from black to green (energized), and the
position and current changes on the breakers.
See also:
Communications Losses
When you bring your system on line, if you find that PowerSCADA Expert has lost
communications with a device, check the following:
• Verify that the physical connection is correct and secure.
• Verify the IP address.
• Verify the Modbus address.
• Check the statusRegister, statusRegistersCount, and statusRegisterType (see for
details)
Before you view LiveView templates and views, you must set up data acquisition
parameters. To do this, use the Application Configuration Utility. See Citect Data
Platform on page 69 for instructions.
NOTES:
• If you find that a predefined table does not include enough cells for the data you
want to display, use the duplicate feature to make a copy of the predefined table.
Then add the needed cells to the duplicate.
• If you install Matrikon Explorer on the same computer as PowerSCADA Expert 8.1,
the LiveView and reporting features will not launch. To prevent this, install Matrikon
before you install PowerSCADA Expert 8.1. If you install Matrikon after you install
PowerSCADA Expert 8.1, you need fix the issue in this way: Go to IIS > ISAPI
Filters, and then reset the dll that is already selected (click browse and re-select
v4.0.30319 aspnet_filter.dll). Click OK.).
You can only view data in these templates if your system is online and you are
connected to devices that provide data.
To set up LiveView real-time data tables in the operator HMI use the following
procedure:
1. Open the LiveView Viewer in your internet browser:
http://localhost/LiveViewViewer
2. Create a custom template (see Create a Template below) or choose an existing
template.
3. Select devices from which to show real-time data
4. Save the view, providing a name.
Keep track of the names of your saved views in order to later use these names in
creating menu items for displaying these views in the operator HMI.
Create a Template
To begin creating LiveView templates, click Start > Programs > Schneider Electric >
PowerSCADA Expert 8.1 > Config Tools > Table Editor. The LiveView Template Editor
screen displays.
1. Open LiveView Setup, then click New.
An empty template displays with a "New Template" name.
2. Overwrite the template name with a name of your choice, up to 100 characters
(limited to A–Z, a–z, 0–9, spaces, underscores, hyphens, and parentheses).
3. To continue setting up the template, click one of the links below.
Template Name: default: New Template (or, if an earlier New Template exists,
appended with a 1)
Single Device/Multiple Devices. The default is single device. If you want a
multiple device table, click Multiple Devices.
NOTE: Table grid lines do not display in the LiveView Viewer, but they do display in
LiveView Setup.
Formulas
Follow these instructions to add the formulas needed to include data in a Live View
template. You can add formulas to:
• add, subtract, multiply, or divide the contents of two individual cells
• add, multiply, or average the contents of a range of cells
To use this feature, click the Formulas subtab in LiveView Template Editor. Then
choose one of the following fields:
• Cell: Use this field to enable a formula for two individual cells. Then enter:
Cell 1 Address: Type the cell address. The cell address displays in this field.
Operator: Choose the operator you want to use: +, –, *, or /.
Cell 2 Address: Type the cell address. The cell address displays in this field.
• Cell Range: Use this field to enable a formula for a range of cells. Then enter:
Operation: Choose average, product, or sum.
Cell Range: Type the cell range (format C4:C20), or select the range of cells to
include in the formula. The cell range displays in this field.
• Insert Location: Type the cell number.
• Insert: Click this button to build the formula you have specified, and to add it to the
cell you added to Insert Location.
Repeat the above procedure for the rest of the formulas you want to use for this Live
View template.
NOTES:
• You must "Protect Current Sheet" in order for formulas to be maintained and visible
in the LiveView Template Editor.
• If you want to use conditional formulas ("IF" formulas), you must first create them in
Excel. To do this, you must access the template you want on the server (Program
Files > Schneider Electric > Applications > LiveView > TemplateEditor >Templates
Temp). Open the template in Excel and add the conditional formula(s) that you
want. After you save the changes, the formula(s) will function correctly in Live View.
You must copy the IF statement into every cell of the column that displays the result
of the IF statement.
• In multiple device tables that rely on formulas to display information for each
device, the results column will display zeroes when that row has no device in it. To
avoid this, use a formula that will display no result if there is no device in that row. In
the following example, when no device is in cell A2, no results will display (no
zeroes) in cell E2.
Placeholders
Placeholders provide the data (device names and tag names) to a LiveView template.
The placeholders are the identifiers that are added when setting up the template, but
are replaced with the name of the selected device or the tag value when the template
is viewed.
To use this feature, click the Placeholder subtab in LiveView Template Editor.Then
enter the appropriate information in the following fields.
1. To begin, place the cursor in a cell. Note that the Insert Location displays the cell
number for the placeholder you are setting.
2. TAG Value/Device Name:
From the drop-down field in the top left corner of the page, choose either Tag Value
or Device Name.
Tag Value: Select the tag group, such as Alarm, Current, Energy. Beneath the tag
group, select the specific tag you want. The list is filtered to include only the most
common tags that belong to the group you selected. To view all of the tags
available in this tag group, check Show Advanced.
Device Name:The list of devices is filtered to include only devices for which this
template's data is available. To display the device name in this cell of the template,
select Device Name. You will choose the actual device during runtime.
3. Insert Location: This offers a second way of inserting the placeholder location.
After choosing the device or tag, type the cell number for the placeholder cell.
4. Insert: Click to add the selected placeholder to the specified cell.
Thresholds
Use this feature to display tag readings that fall outside of the normal range. You can
apply it to an individual cell or a range of cells. You determine the tag or tags for which
you want to display out-of-normal (threshold) readings. When the value of the tag in a
cell (or any tag in a cell range) is below the minimum or above the maximum that you
set, the tag value displays in the threshold cell.
You can set both minimum and maximum values for a cell or cell range. Use different
colors to indicate the high and low readings.
To use this feature, click the Threshold subtab in LiveView Setup. To add a threshold:
1. Cell: For a single cell: Select the cell for which you want the font color to change.
The font color will change when the value for the tag in that cell goes above the
specified Max Value (or below the Min Value) for the threshold.
or
Cell Range: For a range of cells, either select the range, or type the range in the
format C4:C20.
NOTE: When setting up a multiple-device table, you should use a cell range to
ensure that threshold font colors display for each device in the table.
2. Min Value: Type the low value for the "normal" range. If the tag value drops below
this value, the cell font color will change as specified in step 3.
3. Below Min Threshold Color: Open the color palette and select the font color that
you want to indicate the "low" status.
4. Max Value: Type the high value for the "normal" range. If the tag value goes above
this value, the cell font color will change as specified in step 5.
5. Above Max Threshold Color: Open the color palette and select the font color that
you want to indicate the "high" status.
6. Insert Location: Choose an empty cell, one that is not part of the table. This cell will
be the location for the threshold definition that you are creating.
The default cell for the threshold definition is the next available cell in the template.
For example, if the tag in cell B7 has an unused cell to the right of it (C7), the
threshold definition defaults to C7. Then, when the value in B7 exceeds the
threshold defined in C7, the value in B7 displays in the font color you specified. To
override the default cell location, change it in the Insert Location field.
7. Insert: Click here to create the threshold(s).
Formatting
Use this feature to add cell formatting, such as font, font size, and color. To use this
feature, click the Formatting subtab in LiveView Template Editor. A formatting toolbar
displays on the screen. It allows you to set the appearance of the cells in the template.
NOTE: Formatting changes become visible only after you click outside of the cell that
you change.
To format a cell or range of cells, select the cell(s). When you select a format, the active
cell(s) will be set to the specified format attribute. When a cell becomes active, the
format selections on the toolbar will reflect the selections for that cell. When you select
multiple cells, the format selections will reflect those of the first cell you select.
See also:
To add data formulas to the Live View template, see Formulas on page 76.
To add data (device names and tag names) to the Live View template, see
Placeholders on page 76.
To add visual alerts (color changes) when the value of the tag associated with a cell
becomes too high or too low, see Thresholds on page 77
Refer to the ENM Installation Guide for information on installing ENM. After it is
installed, refer to the ENM Configuration and Monitoring and Diagnostics help files,
which will be installed also. It is important to note all steps/tabs must be completed in
order for ENM to work correctly. For example, you must configure a filter and schedule,
as they are not optional. Be sure to use the e-mail test function to verify that the e-mail
server is configured correctly.
Event Sources: Enter the name or IP address of the PSE Alarm Server, then detect
and select the source.
Filters: Choose the source and add a filter. It can be based on tag severity or a wide
range of conditions, such as timestamp.
Recipients: Add the identifying name of the person who will receive the notifications.
Delivery Relays: Configure the method used: either Email, GSM, or SNMP.
Schedules: Configure day of the week and start/end time for notifications.
Subscriptions: Select the source, filter, and delivery from previously configured tabs.
You can also select a test notification and health check notification.
Services: Allows you to stop and start services and see their status.
On the server that you will use for the Advanced Reporting and Dashboards Module,
,install software in the order shown below.
• SQL
• Advanced Reporting Module: Use the PowerSCADA Expert 8.1 with Advanced
Reports and Dashboards installation medium and installation guide.
At this stage of the commissioning procedure, many I/O devices have been added to
thePowerSCADA Expert system. However, in order to obtain Power Quality reports and
Branch Circuit Monitoring reports and hierarchy functionality, these types of devices
must be added again on the Advanced Reporting/Dashboards server. To do this, use
the Management Console application to add and configure these devices.
For information about the Management Console, refer to the Power Monitoring Expert
Installation and Commissioning Guide.
Determine the Device Name and Test the Direct URL for WebReach Dia-
grams
To display the diagram, you need to determine the device name using SQL and test
the URL in a browser.
1. In SQL Server Management Studio, make sure you are using the ION_Network
database.
2. Execute the following query:
SELECT Name FROM dbo.device
3. Find the device name that you want.
4. Open a browser window and enter the following URL to test the diagram display.
Replace [device name] with the name you found in the previous step, and
[servername] with the name of the Power Monitoring Expert server.
http://[servername]/Ion/default.aspx?dgm=OPEN_TEMPLATE_
DIAGRAM&node=[device name]
For example, a real URL would look like:
http://10.168.94.77/Ion/default.aspx?dgm=OPEN_TEMPLATE_
DIAGRAM&node=TVD.7650
5. The device diagram should display in the browser window, and you should be able
to navigate around the diagram, per normal WebReach function.
This will display the names and IDs of all the reports that have been configured and
saved. It is possible to have two reports with the same name, but the [SubFolder]
designation will make them unique.
We recommend, when you use single sign-on, that you maintain the components on
the same computer or on a secure network. If higher security is needed, use SSL
(https).
NOTICE
LOSS OF SYSTEM CONFIDENTIALITY/INTEGRITY/AVAILABILITY
Ensure that all single sign on information is secured, either on the same computer or
a secure network.
Failure to follow these instructions can result in unauthorized access to, modi-
fication of, and unavailability of the system.
To launch the screen you need, open the Application Configuration Utility:
Click Start > All Programs > Schneider Electric > PowerSCADA Expert 8.1 with
Advanced and Reporting > Config Tools > Application Config Utility. Click the Security
tab.
• Users: Add/modify the users to have access to the selected application. Use this
area to add users who do need to have a Citect user account.
— Citect User: the Citect username that is requesting authorization.
— SSO User:/SSO Password: The established credentials for this user, either from
PowerSCADA Expert or Power Monitoring Expert.
PowerSCADA Expert automatically detects calls that are made from a web client. The
calls are sent to an I/O server. For this to work properly, the user needs RPC privileges
for web client access. The default is False. To change this to True, access the user
account through Roles in the Citect Project Editor. (System > Roles). Change "Allow
RPC" to TRUE.
YubiKeys are not shipped with PowerSCADA Expert. Instead, you must buy them from
a third-party vendor, such as Amazon. The following table describes the various
YubiKey models that are compatible with PowerSCADA Expert.
Small form factor, designed to remain inserted in the USB port. Suitable for
YubiKey Nano
use in clients with a dedicated single user account.
Deployment Guidelines
Keep in mind these points when you are ordering or using a YubiKey.
• You must set "Allow RPC" to TRUE for all roles that are using YubiKey.
• YubiKey is compatible with all thick clients and web clients.
• YubiKey requires access to a USB port at each client (or must include NFC
capability).
• While technically compliant, NFC has not been validated for use with PowerSCADA
Expert.
• Each PowerSCADA Expert I/O server must have Application Services (Core
Service Host) running.
• Multiple I/O servers may reside on a physical machine. In this case, only one
instance of Application Services resides on the machine.
• Yubikey must be configured and synchronized across all I/O Servers (this includes
redundant pairs and distributed systems).
• YubiKey is enabled on each client independently.
• It is possible to configure YubiKey on one machine, export the configuration for all
users, and import the configuration to all remaining machines.
• It is not necessary to re-program YubiKey when changing passwords. The YubiKey
constantly changes the OTP (as it is only valid once); so it is not susceptible to
replay attacks.
• YubiKey is authenticated against all physical servers that contain at least one I/O
server. All physical servers must successfully authenticate the OTP for success. If a
single physical server does not authenticate (due to misconfiguration, etc), the user
will not be able to log in.
• If a physical machine (with an I/O Server) is not available, it is not included in the
authentication scheme (this means that, if a primary server is down, the secondary
can still successfully authenticate the OTP).
• If no physical servers (with I/O Servers) are available, the user will not be able to
log in on clients that have YubiKey enabled.
NOTES:
• This procedure requires that you have a USB port on your computer. It will not work
for virtual machines.
• An option for computers without USB ports is to autoconfigure on a local
workstation, then export the settings to a shared drive and import the settings onto
the computer where you need them. (See Import and Export One-Time Password
Settings on page 88, below.)
• You can only have one YubiKey inserted at a time.
• If Autoconfigure will not work, and you must manually program the YubiKey, see
Program the YubiKey on page 86 for instructions.
This message tells you that all settings on the key will be erased, including any key
assignments.
6. To continue, click Yes. The key will receive a new secret key.
7. Click Accept.
3. Insert the YubiKey into a USB port of your computer. Click the Yubico OTP Mode
link. At the next screen, click Advanced.
This screen displays:
If you want to use both of the key's configuration slots, download the YubiKey
documentation, found under the Support tab of the Yubico website.
To configure a single slot, follow these steps:
4. Click the checkbox for the slot you want to configure.
5. Under Yubico OTP Parameters, check Public Identity. Click Generate.
6. Leave the Public Identity Length at its default, 6.
7. Check Private Identity. Click Generate.
8. Click Generate beside Secret Key.
9. Make a note of the secret key that displays, including all characters and spaces.
You will need it when you add the key to the Application Configuration Tool.
The key is programmed. Follow the next procedure to manually configure it at the
PowerSCADA Expert computer:
1. Access the One-Time Password screen.
2. Click Assign Key.
NOTE: When you import password settings into another server, you will overwrite any
password settings that already exist there. You are not simply adding the new
password settings to the existing ones.
1. On the One-time Password screen, create the password settings that you want to
use.
2. Click Export. A file named ExportedOTPConfiguration.xml is generated. You can
rename it if you wish. Save it where you can access it from other servers, or place it
on a jump drive.
3. From a server to which you want to import the password settings, click Import. You
are prompted for a location.
4. Browse to the location where you placed the .xml file. Click Open and accept the
.xml file.
Disabling YubiKeys
To "disable" a YubiKey, use the Citect Parameter that you created for the YubiKey (see
Configure One-Time Password (Two-Factor Authentication) on page 84). Scroll to the
parameter for the Yubikey. Change the Value from true to false. Click Replace, then
compile the project.
If the device is added through the I/O Device Manager, the alarm priority will be 1,
2, and 3 for _PLSALM_HIGH, _PLSALM_MEDIUM, _PLSALM_LOW alarms
respectively.
The user can define specific wave files for the sounds. We support the following
Windows operating system sounds:
SystemAsterisk
SystemExclamation
SystemQuestion
SystemDefault
SystemHand
SystemExit
SystemStart
2. After alarms are set up: When an alarm occurs, its specified alarm sound will play
continually according to the specified interval. The alarm sound will stop when
either:
— the user clicks Silence Alarm on the alarm page
— the alarm is acknowledged
Complete each parameter with the value specified below. Then save the modified
citect.ini file:
• Hostname: The name or ip address of the computer that hosts Power Monitoring
Expert.
• SupportsVisitorDashboard: Indicates if the Power Monitoring Expert system
supports automated visitor login. Set this to 1 (which means true) as Power
Monitoring Expert v8.0 supports it. (Earlier versions did not support this option.)
• RemoteCallHandlerServer: This parameter supports SSO with the use of web
clients. The value must be an IO server configured in your project
• RemoteCallHandlerCluster: Like the above parameter, this supports SSO with the
use of web clients. Its value must be a cluster name associated with the above
IOserver.
• [Application]Area: Allows the use of the “area” field associated with Citect users. It
can be configured on a per application level including: PSEreporting, Reporting
(PME), WebReach, and Dashboards, and provides the ability to limit the use of
SSO operations to specific areas.
• [Application]Privlevel: Allows the use of the “privilege level” field associated with
Citect users: It can be configured on a per-application level including:
From the Citect Project Editor, click System > Parameters. At the Parameters screen,
type the following:
• Section Name: Security
• Name: OneTimePasswordRequired
• Value: true
To be able to use YubiKey in PowerSCADA Expert, you must set "Allow RPC" to TRUE
for all roles that include users with assigned YubiKeys. The default for PowerSCADA
Expert is False. To change this to True, access the user account through Roles in the
Citect Project Editor. (System > Roles). Change "Allow RPC" to TRUE.
[POWERLOGICCORE]
Timezone = Mountain Standard Time
The device-specific time zone specification takes precedence. In other words, if both of
the above examples are present in the Citect.ini file, the PM870_Device1 would be
located in “Singapore Standard Time” time zone, and all the other I/O devices in the
project would be located in “Mountain Standard Time” time zone.
If there is no time zone specification (or if it does not match the time zone from
Windows database), the device would be in the same time zone as the machine where
the I/O Server is running; thus, no time conversion will be done.
If only the first of the above examples is present within the Citect.ini file, the PM870_
Device1 would be located in “Singapore Standard Time,” and all the other devices use
the current local time zone.
Add the corresponding information for each saved real-time data table view you wish
to see in the HMI.
For each item, update the menu command with the respective ReportID, which was
earlier determined in this section: Determine the Advanced Reports Report ID to Use In
PowerSCADA on page 82.
For each item, update the menu command with the respective slideshow GUID, which
was earlier determined in this topic: Determine the Dashboards Slideshow ID to Use In
PSE on page 81.
For each item update the menu command with the respective DeviceName determined
in this topic: Determine the Device Name and Test the Direct URL for WebReach
Diagrams on page 81.
This method only works when Power Monitoring Expert device names are identical to
PowerSCADA Expert equipment names.
1. Open the PowerSCADA Expert Graphics Builder and navigate to the page on
which you want to insert the meter genie.
2. Click Edit > Paste Genie.
3. Under Library, click pls_meter and select the desired meter genie.
4. Near the bottom of the page, locate the “Events” fields.
5. In the "Details Pop Up" field, enter the PLS_WebReachPopup cicode method. Your
Genie Properties dialog should look similar to this:
NOTE: Unlike the other two button types (from a menu or popup page), you do not
specify the sDevice name; instead you pass #EQUIP. This value is a property of the
genie. This only works when the PowerSCADA Expertequipment anme is the same as
the Power Monitoring Expert group.devicename.
The final result is an equipment popup that contains a button that looks like this:
It is always a good idea to "pack" before you compile. From the Citect Project Editor,
click File > Pack. Then, from the Citect Project Editor, click File > Compile. Correct any
errors and note any warnings.
The backup .CTZ file is written to the location that you choose during backup. This is a
Citect Zip file; you can open it with WinZip.
Back Up ENM
By default, ENM runs a database backup daily as part of SQL scripts that run in a
Windows scheduled task. If you need to change the directory for database backup, see
the DBMaintenance directory on the ENM computer.
Save the .aes file to a secure location, such as a secure network drive or a flash drive.
Also, back up the AdvOneLine.INI file. You will copy this to the PowerSCADA Expert
secondary server after accessing the .aes file from that server during the restore
process.
NOTICE
LOSS OF SYSTEM CONFIDENTIALITY/INTEGRITY/AVAILABILITY
Do not save the .aes encryption file to the local computer. Always export it to a
secure site, such as a secure network or to the target computer.
Failure to follow these instructions can result in unauthorized access to, modi-
fication of, and unavailability of the system.
You will paste this file to the same location on the secondary PowerSCADA Expert
server during the restore process.
The following illustration shows a genie and its related genie pop-up.
Use the Tag Viewer to learn the status of all project tags.
During runtime, open one of the pages that displays real time tag values. The example
below is PLSTagView. Compare the values displayed on the TagViewer page to actual
values displayed on the meter itself. If the compared values match then you have
verified communications with that device.
See also:
Use the One-Line Configuration Utility to verify that devices are connected and
animations are working.
The electrical system must be in a non-critical state so that the breakers being used will
not cause any adverse effects (such as putting a person’s safety at risk or affecting a
process). Breaker genies should be able to remotely operate the breaker.
DANGER
HAZARD OF ELECTRIC SHOCK, EXPLOSION, OR ARC FLASH
• Do not rely solely on the display of the genie on the one-line.
• Use this procedure only during development, and not on a live deployed sys-
tem.
• Before energizing or de-energizing any equipment from this software, verify that
all personnel are at a safe distance from all energized equipment.
• Before testing, verify that the proper lock out/tag out procedure is followed, to
ensure that the equipment is in an electrically safe condition.
• Ensure that all safety regulations and procedures have been followed before
you work on the equipment.
Failure to follow these instructions will result in death or serious injury.
In the Graphics Builder, create a one-line diagram with breaker genies that use the
breakers you want to verify. Use the proper logic and passwords to configure the one-
line on the diagram. After the diagram is successfully created, open the graphic page
in runtime mode.
The breaker genie status indicator should mirror the current breaker state. Also, the
busbar color should accurately reflect the electrical state of the conductors connected
to the breaker.
The following illustrates the appearance of the one-line drawing with breakers first
open and then closed. Note the color change, from black to green (energized), and the
position and current changes on the breakers.
See also:
Communications Losses
When you bring your system on line, if you find that PowerSCADA Expert has lost
communications with a device, check the following:
• Verify that the physical connection is correct and secure.
• Verify the IP address.
• Verify the Modbus address.
• Check the statusRegister, statusRegistersCount, and statusRegisterType (see for
details)
When you first click the Diagnostics tab, a short description and help link display on the
right-hand side. The basic steps you follow are below. See the section after the steps
for the logic behind how data displays.
1. To begin viewing data, click the Diagnostics link on the left. The I/O Device Settings
link displays. Click that link. Notice that the right-hand pane displays a link for the
project name.
2. Click the Project Name drop-down box and choose the project for which you want
to view data. PowerSCADA Expert loads the server information for this project. Note
that you could have multiple servers: I/O, alarm, and trend.
3. From the View pane, click a cluster and then a server.
4. (I/O servers only): From the Protocol column, choose a protocol and then the port
and device.
5. View the data for that device:
— The top row of the Settings are a "breadcrumb," showing the device information
from cluster to device.
— The second row, just above Effective Settings, displays details about the device,
equipment name, number of tags, address, priority, memory mode and startup
mode.
— The remaining sections display information only if there have been changes
made to the default settings.
I/O servers alone display a separate column: When you select an I/O server, the
Protocol column displays beside it. You will select protocol, port and device.
Data is retrieved in this manner: protocol settings are retrieved from the Param.dbf file
and then from the citect.ini file. These two lists of settings are merged. If there are
duplicate settings, the citect.ini file changes take precedence. Finally, device settings
are retrieved and merged. If there are duplicate settings, the device settings take
precedence.
The Effective Setting uses the CacheRefreshTime of 1000 from the Port Setting.
You can filter the tags that you view by individual equipment included in the project.
You can also filter on strings that are part of the tag description or tag name. The tag
viewer will work in all supported Citect screen resolutions.
To view tags:
Click the tab for the page that was used when setting up the tag viewer, then select the
tag viewer. The viewer displays in a screen similar to this:
Use the Previous and Next links at the bottom right of the page to scroll through
multiple pages.
This is due to the difference between way the two alarm types are handled:
When an alarm is enabled, the system processes alarms for that tag. If the alarm
is disabled, the system cannot process alarms for that tag.
For the PC-Based alarm, the condition for this is, for example, IA > 80; if the tag
value for IA is > 80, the appearance will show. The tag is constantly scanned, so
PC-based and onboard
the condition triggers the alarm once it is enabled.
alarms do not appear or
disappear as expected. For the Onboard alarm, the condition for this is a digital tag, which is set by the
driver when a new alarm record on the device is read. If the alarm was disabled,
the driver cannot set the digital tag. When the alarm is enabled, nothing happens
because the alarm was already "processed" by the driver and will never get
reprocessed.
Thus, there is no resolution.
The number of alarms that This happens when the Set alarm filtering in the alarm viewer to reduce the
display is fewer than the number of alarms exceeds number of alarms that can display.
limit set by Alarm Summary 1000 and the system has Only support a one-cluster system.
length parameter. multiple clusters.
If a multiple-cluster system is necessary, display a
separate alarm page for each cluster.
The new categories do not Use Custom Filter 8 instead. Currently, it is the
Cannot filter on categories
display in the list when you only means available for adding custom filtering to
for alarms.
want to select them. alarms.
Install Application Control on the PowerSCADA Expert primary and secondary servers,
as well as the Advanced Reports and Dashboards server. For detailed information
about installing Application Control on each server, see the McAfee Installation Guide
located on the PowerSCADA Expert installation disk (McAfee Embedded Control >
Documents > Installation-Guide-v6.2.0).
NOTE: Allow the install to add a desktop shortcut; you need it for all interaction with
Application Control. Also, before you run Application Control, make sure that you have
installed all other software that you want on the computer.
To begin using Application Control, right click the desktop icon and select the Run As
Administrator option.
You can review information for failed attempts to identify updater rules to allow
legitimate applications to run successfully. To do this:
1. Enter the command sadmin dia
2. To add the suggested updaters to the authorized list, use the command sadmin
diag fix.
When you deploy Application Control to protect a system, it scans the system and
creates a whitelist of all executable binaries and scripts present on the system. The
whitelist also includes hidden files and folders.
The whitelist lists all authorized files and determines trusted or known files. In Enabled
mode, only files that are present in the whitelist are allowed to execute. All files in the
whitelist are protected; you cannot change or delete them. An executable binary or
script that is not in the whitelist is said to be "unauthorized," and it is prevented from
running.
You can also use Application Control to write protect files, directories, drives or registry
entries. Additionally, you can use it to Read Protect Files, Directories, or Drives. For
more information about these applications, see the Product Guide.
PowerSCADA Anywhere allows a remote desktop session via a web browser to the
PowerSCADA server. It is accessible only in the PowerSCADA runtime mode.
To use PowerSCADA Anywhere, you must first install the PowerSCADA Anywhere
Server (required).
For detailed instructions on installing and using the PowerSCADA Anywhere Server,
see the following documents, which are located in the PowerSCADA Anywhere
Installer folder:
• PowerSCADA Anywhere Quick Start Guide.pdf
• PowerSCADA Anywhere Installation and Configuration Guide.pdf
3. Accept the license agreement and click Next on each screen of the installation. If
there is a pre-requisite missing, it will be installed for you.
4. When installation is complete, you see a confirmation screen. Click Finish to close
the install.
Post-Installation Configuration
5. Configure Remote Desktop settings to allow remote access:
a. From the Control Panel, open the System Properties window and click the
Remote tab:
7. Ensure that the Citect Anywhere service is started. To confirm this, use the
ServerConfiguration for Citect Anywhere:
Log in with Windows user credentials from the Citect Anywhere server. This user
needs to belong to the VjcaView or VjcaControl group on the Citect Anywhere server.
The Schneider Electric Tofino is an industrial firewall designed for use in industrial
control system networks. The firewall offers deep packet inspection of Modbus TCP,
allowing restriction at the Modbus command level as defined by the network designer.
It is highly configurable using software called Connexium Tofino Configurator
(included with Tofino purchase). The software allows a user to define entire networks,
referred to as projects, which can have multiple Tofino firewalls protecting a myriad of
devices (referred to as Assets) at different points in the network.
You configure the rules for the network that define the traffic that can pass through
which firewall.
We recommend that you begin with the firewalls in test mode so you can see what
would have been blocked and make adjustments accordingly. The firewall
configurations should be then loaded onto a USB drive that is used to upload the
configuration to each firewall.
Detailed information about the setup and configuration of the Tofino architecture is
provided in the ConneXium TCSEFEA User Manual V1.You should not use this firewall
as an “edge” device, bridging the Control Network with public networks.
The following is an example architecture that can serve as reference for how one of the
networks might be constructed. It is a small network that can be scaled out to fit a much
larger system.
The one-time password is generated. The key and software communicate behind the
scenes to verify the uniqueness of the one-time password and to click OK.
Close Runtime
To close the runtime environment, do one of the following:
• Click the "X" in the upper right corner of the screen. Then enter a valid user name
and password. (It is important that you have defined at least one new user in your
project.)
• From the computer taskbar, click the Runtime manager:
In the upper left corner of the screen, the project name is listed. Your logon name is
below that. At the top of the page, there are left and right navigation arrows that allow
you to go to previously visited pages.
These two arrows allow you to go back and forward one page in your navigation
history. To see the history of visited pages, click the small down arrow next to the right
arrow. This displays a listing of visited pages (the current page is checked). To jump to
a page in this list, click it in the menu.
Just beneath the left and right arrows is the alarm banner. It lists the last five active
alarms.
Beneath the alarm banner is a tabbed-style menu. Its contents are determined by the
information entered in the Menu Configuration tool: Add Pages to Project Menu
Configuration on page 61. These tabs display in two rows:
• The upper row is typically used for organizing pages into several topics (or tabs). A
typical system would include topics for single lines, alarms/events, analysis (for
trends), and system supervision (allows you to view the network connection topics).
• The lower row lists the links/pages under the topic that is currently selected in the
upper row. If you select the single lines topic on the upper row, the lower row
displays all of the links to individual single line pages.
If there are more links available than the ones that fit on the page, a small arrow
displays at the right hand side of the row. Click the arrow to display a pop-up menu of
the remaining links. Click a link in the menu to shift the contents of the row to make it
visible for selection.
NOTE: When viewing the single lines: if the busbars and circuit breakers do not display
as expected, it could be that a custom genie is not set up correctly. See Create New
Genies for details on customizing genies.
Troubleshooting
This section contains hints and instructions for correcting issues with your project.
• CSV file format errors: see One-Line Errors and Warnings on page 48
• Use the One-Line Configuration Utility to repair problems with equipment on
graphics pages: see Perform Repairs for One-Lines on page 49
• General troubleshooting questions: see Frequently Asked Questions (FAQs) on
page 120
The integration team can choose which Input to which they will wire circuit breaker
status and position. In this case, the tags for circuit breaker status and position would
have different addressing, based on how that particular circuit breaker is wired. We
recommend a new device type in this case.
• On the source PC: From the OS-specific Data/Profile Editor/ Vx.x directory, copy the
entire OS-specific Data/Profile Editor/ Vx.x directory to the corresponding directory
on the destination machine.
If you use a naming convention that incorporates location, you will be able to do
filtering on alarm location.
• For example, Site_Building_Panel_device would be named Sx_Bx_Px_Device.
(Site1_Building1_Panel1_CM41 — S1_B1_P1_CM41).
• The fewer levels you have, the more characters you can have in each level.
Device Comment:
This comment will be placed in the Equipment database, which is accessible from
Cicode.
MODBUS TCPIP: Use this for any device that can speak TCP/IP natively. This includes
CM4 or PM8 devices that have an ECC card installed.
If the automation spreadsheet attempts to add a device that is already present in the
project, an error will be thrown.
In the event that an error is thrown (for invalid profiles, communication parameters,
etc), the row containing the error will display in Excel. To prevent duplicate device
entries from being attempted, you must remove any rows above the row indicated
in the error message.
If you need to keep a record of the devices added to the system, then keep each of the
spreadsheets that was used to install devices in a known location for that customer.
The Setup Sheet needs to be modified for each project. Specify the entire path for each
file.
Each team should come up with a naming convention for the servers and clusters. If
the team is consistent, it will make it easier to edit/create the automation spreadsheet
used for device addition.
The default graphics objects (such as circuit breakers and alarm pages) are
constructed using a pre-defined set of user privileges the security grid). During
development, you must have users of various privilege levels for testing purposes.
Create users for each of the various levels according to the security grid. To make the
best use of these privileges, we recommend that you use this security grid when
adding users as you create new projects.
See Default User Access Settings (Privileges) on page 57. For additional information,
see Using Security in the citectSCADA.chm help file (Program Files> Schneider
Electric > PowerSCADA Expert > v8.1 > bin).
All objects on the page contain one or more Animation Numbers (ANs). Symbols take
one AN while genies may take tens to hundreds of ANs. Placeholder ANs allow you to
add objects to a template that is used on existing pages.
Some default templates contain ANs that have associated Cicode functions that rely on
the animation number to remain a fixed number. For this reason, we have pre-
allocated a set of ANs for the default templates. The base normal template uses ANs
1–263, and it has placeholder ANs from 264–500. When customizing this template,
you should use the placeholder ANs as required.
You can place an AN (or a placeholder AN) on the page by using the “System 3.x/4.x
tools available in the Graphics Builder under Tools< Options.
The default template uses ANs 1–263 and it has placeholder ANs from 264–500.
New objects added to a page or template will take the next available ANs. Any
previously used (and now abandoned) ANs will be reused.
3. Determine how many ANs the new object requires. (You can place the new object
on a blank page and then view the object in the object browser.)
4. Remove exactly the amount of ANs to allow the new object to be placed on the
template. Remove ANs beginning with the lowest available placeholder AN (in the
default template, this would be 264).
5. Place the object on the template.
6. Save the template.
7. Create a new page based on this template.
To change globally:
This text may be changed by configuring INI parameters in the citect.ini file. For
more information, see the PowerSCADA Expert System Integrator’s Manual
(Grahics Library Parameters)
This is the global fallback text that will be used in the event that pickup/dropout text
is not specific on a per-alarm basis in the Device Profile. You can specify the per-
alarm pickup/drop-out text on the profile tab in the Profile Editor.
Events Accessible at runtime: By default, 5000 events are accessible (view, filter,
print) during runtime. Additional events are logged to disk. The number of events
accessible at runtime may be changed by the [Alarm] SummaryLength parameter in
the INI file.
Event fields that are logged to disk may be configured by adjusting the AlarmFormat
parameter.
There is no automatic maintenance performed on the log files. It is important that the
log/waveform data be cleared out periodically (to prevent the hard drive from filling up;
this does not affect performance).
Parameter: [PowerLogicCore]
DebugCategory = All
DebugLevel = All (or Error)
LogFileArchive = Deprecated; no longer used. Use [Debug]SysLogArchive instead.
Parameter Details:
DebugCategory defines which message categories to log. (See table below).
DebugLevel defines debug levels of messages to be logged. (See table below).
Debug Levels
The following debug levels are accepted by PowerLogic driver core library:
WARN: log all warning level messages
ERROR: log all error messages
TRACE: log all trace messages
DEBUG: log all debug messages
ALL: include all level messages
Debug Categories
PowerLogic core library and drivers messages are grouped in categories. Each of
these categories can be enabled independently from others in any combination.
MISC: miscellaneous messages that do not all into any other category
ALARM: messages related to alarms, regarding collection and detection
WAVE: messages related to waveforms -- waveforms download, processing
REAL: messages related to real-time data collection
STATE: messages related to internal object-state changes
CORE: core events that do not fall into driver-specific logic
MODBUS: TCP/MODBUS messages
ENTRY: trace messages produced when driver API entry points are called
PORT: traces related to the port events
UNIT: traces related to specific unit events
WAVETOALARM: not used
DATAPOINT: debug messages related to data points
STATISTICS: enables driver statistics data output
COMMAND: messages related to commands
REPLICATION: messages produced by replication subsystem
ALL: enables all categories
Parameter: [Debug]
Menu = 1
Parameter Details:
The Menu parameter determines whether the Kernel option is displayed on the control
menu of the runtime menu. This can also be enabled using the Computer Setup Editor.
Driver-tuning parameters:
Parameter (Back Polling Rate): [SEPAM40]
CacheRefreshTime = 1000
InitUniCheckTime = 120
Retry = 3
Timeout = 1000
Parameter Details:
The CacheRefreshTime parameter controls the maximum rate at which the driver
will attempt to repopulate its cache. If the driver cannot refresh its cache within the
time period specified, it will collect data as fast as the network allows.
This back polling rate can be global to all devices or tuned up to a specific I/O
device.
The InitUniCheckTime parameter controls how long the driver will wait before
attempting to bring a device online after it has gone offline. This value can be
decreased to bring offline devices back into service in a shorter period of time. In a
multi-drop scenario, this time should be relatively long, to prevent init unit requests
from stalling communications to the rest of the devices on that port.
The Retry parameter defines the number of retry attempts for specific MODBUS
requests. Retries will only occur in response to the MODBUS errors which are
defined below.
The Timeout parameter controls how long the driver will wait for a response from a
device before setting that device as offline. This value should be greater than the
device/gateway timeout period.
Parameter: [Device]
WatchTime = 5000
Parameter Details:
Device WatchTime is the frequency that PowerSCADA Expert checks devices for
history files and flushes logging data to disk.
Default: 5000
Range: 1000–3600000 milliseconds.
Miscellaneous Parameters
Parameter: [Kernel]
Task = 20000
Parameter Details:
Kernel Task is the number of tasks. Increasing the number of kernel tasks is used
when “Out of Kernel Task” message is received. The change will be likely for large
systems.
Default Value: 256
Range: 50–32767
Parameter: [Page]
ScanTime = 250
Parameter Details:
Page ScanTime determines how often the Animator refreshes a graphics page at
runtime.
Default: 250
Range: 1–60000 milliseconds
Parameter: [ALARM]
ScanTime = 500
Parameter Details:
Alarm ScanTime determines the rate at which alarms are scanned and processed.
Default: 500
Range: 0–60000 milliseconds
The ModNet driver polls real-time tags on a user demand basis (when a user opens a
page with the tags on it). Therefore, the time to retrieve data will vary, depending not
only on the communications bandwidth, but on the amount of data being requested.
This can vary significantly, depending on which pages are displayed by the operators
at any particular time.
The PWRMODBUS driver polls all configured tags; however, different types of tags can
be polled at different relative rates, and the available communications bandwidth is
carefully managed. This approach means that tag update rates are not subject to the
scalability issues associated with operator actions (as is the case for the ModNet
driver). It is also advantageous in that performance issues associated with
communications bandwidth or IODevice response times can be determined at
SAT/time of implementation and are not subject to significant change during operation.
The different tag types can be allocated relative importance in data requests,
expressed as a percentage. (See Bandwidth Allocation Parameters in Performance
Tuning Parameters, in the PowerSCADA Expert System Integrators Manual.) Keep in
mind that any unused bandwidth allocation (from, for example, events retrieval) is
made available for other data types to use. If the event does not need the default 25%
allocation, it will be made available to the other parameters (real-time tag retrieval, etc).
This potentially increases the update rate of real-time tags.
Additionally, the real-time tag relative scan rate based on priority can be set to three
different levels. (See "Tag Scan Rate Parameters" in Permance Tuning Parmeters, in
the POwerSCADA Expert System Integrators Manual) This means that, if some real-
time tags are more important that others, you can set their relative priorities. For
example, configuration tags vs. important real-time tags vs. normal real-time tags.
Section: Page
Default = 48. The problem will occur with a larger font or if the window is resized. The
default value of 48 can be changed or the window and associated genies can be
resized.
A device can prevent writes to its registers: how do I ensure that writes are suc-
cessful?
PowerSCADA Expert cannot provide feedback about whether a write to a device
register is successful. If a device is capable is preventing (blocking) writes to its
registers (for example, Sepam), you need to verify that its “block” feature is not
enabled. Do this at the device.
NOTE: In Cicode, you can also use the tagwrite function in blocking mode, i.e., bSync
parameter = true; Check the return code: 0 = success, anything else = error. For more
information, see the Cicode Programming Reference help file.
How do I create an audit in the Event Log for user logins and logouts?
//LOGOUT
FUNCTION
PLSLoginUser()
Why am I seeing #COM for circuit breaker status in the genie status page?
If this is a Micrologic P device, and it does not have a CCM, you will not be able to view
data referring to circuit breaker status, e.g. racked in/racked out. When there is no
CCM, the device profile should not have tags that refer to the CCM.
You can click "ignore" at this error, and the install will finish. The next time you open
Excel, the DBF toolbar will display.
What causes the "First dbf record" error message? How do I keep it from hap-
pening?
The error message "First dbf record" tells you that a project is not found. This happens
when you add a project, and then rename it or delete it. Then, when you try to create a
new project, you see this error message.
To resolve this issue, simply shut down and then restart the Citect Explorer.
To do this:
1. Locate the Select Before Operate tag in the variable tags.
2. Append \str to the end of the tag name.
3. Change the data type to STRING.
4. Click Add.
This creates the SBOw tag for the IEC 61850 advanced control screen. For more
information about advanced control, see "Set Up IEC 61850 Advanced Control" in the
PowerSCADA Expert System Integrators Manual.
Diagnostics
Logging Level:
This feature turns on extra diagnostic information that can be useful when diagnosing
problems that occur in application services or its hosted applications (such as
LiveView). Choose the level of logging to be used in all applications. Debug and
Verbose increase the amount of information that is logged during runtime for
applications such as Basic Reports and LiveView.
• Normal: Use when the project is live.
• Debug: includes additional logging statements (in the Windows event log named
PowerLogic). This logging should not affect performance in the system during
runtime.
• Verbose: releases additional diagnostic information, such as large lists, that could
affect system performance.
Service Inventory:
Index busbar
creating and configuring 126
A
C
advanced reports
CacheRefreshTime parameter 127
setup 82
category/subcategory
advanced reports root page menu item
managing 120
add 63
citecitect.ini
aes password
final edits 89
import 100
Citect
alarm
add project 13
changing pickup/dropout text 125
citect.ini
issues 108
add one-time password 91
alarm log
add single sign-on settings 90
problem with alarms not displaying 108
cluster
alarm pages
adding 13
add to the graphics page 63
CLUSTER name (%CLUSTER%)
alarm servers 13
changing 130
Allow RPC
cluster setup
YubiKey 84
in the I/O Device Manager 26, 28, 30-31
animation numbers (ANs)
redundantI/O servers 15
used in objects 124
color
architecture 9
active
ATS 51
busbars 126
autoconfigure 85
colors
automatic transfer switch 51
assigning to one-lines 46
B
comms loss
backup
troubleshooting 132
Application Configuration Utility settings 98
communication
ENM 97
verify 72, 102
one-line engine encryption 97
communications loss
one-time password 97
troubleshooting 132
PSE and ENM 97
compile the project 18, 39, 46, 60, 68, 96
before you use the I/O Device Manager 25
compile the project and launch runtime 71
BRCB
CoreServiceHost
entering for IEC 61850 device 33
Schneider Electric 69
entering for IEC61850 device 32
deleting 22 create 19
deleting when associated with a device device type defaults 19
type 22
device types
editing 22
custom 22
custom tag
device types and tags
adding 20
add 19
custom tags
Device Wizard
create 19
before you use it 25
D
devices
dashboards page menu item
add multiple 36
add 65
devices in the project
dashboards slideshow
edit 37
setup 81
diagnostics 133
DBF Add-In toolbar will not install 132
DNP3-TCP device
debugging
add 29
INI parameters to use 126
DNP3_serial
default
add to project 28
device types and tags 19
E
default user account 56
English.dbf
device
used in translation 27, 29-30, 32
add individual to project 25
English.dbf file
adding multiple 122
used for translation 27-28, 30, 32
name
ENM
requirements 121
backup 97
popup
set up on PowerSCADA server 80
overlapping fields 129
entering copy for translation 27-28, 30, 32
profile
Excel DBFAdd-In toolbar will not install 132
removing from a PowerSCADA Expert pro-
ject 33
creating and configuring busbars 126 associated with new genie 124
instalation backup 97
web client 101 importing 100
installation procedures 11 log in with YubiKey 117
L P
LiveView pack
formatting 78 after deleting a cluster 15
formulas 76 page menu
placeholders 76 adashboards 65
real-time data tables 75 add advanced reports 63
temeplates 75 add taag viewer 63
thresholds 77 Page Menu
LiveView tables add WebDiagram launch 66
add menu items 92 Pagemenu.dbf
M editing 61
McAfee whitelisting 109 parameters
Menu Configuration performance tuning 127
used to edit Graphics page menu password
information 61
one-time 84
menu item
performance tuning parameters 127
add for dashboards 65
pickup/dropout text
menu items
changing for alarms 125
add for LiveView 92
placeholders
MODBUS communications methods 122
LiveView 76
N
PM5000
network address
device profiles for the I/O Device Manager 26
adding 13
PM5000S 26
O
PM5000S1 26
one-line
PME server properties
coloring 46
add to citect.ini 91
one-line engine and Citect data platform
settings 69 polling rules for tags 129
back up 97 serial 28
add 62 renaming
configuration 83 redundant 13
privileges servers/clusters
user naming conventions 122
PowerSCADA Expert 57 single sign-on
Profile Wizard add settings to citect.ini 90
removing a device 33 configure 83
project single sign on
add to Citect 13 guest user 83
cannot add 132 synchronize new PC with master PC 120
create and export 24 system startup 102
managing in PowerSCADA Expert 123 T
project menu tag
final edits 92 custom
R adding 20
real-time data tables tag-polling rules 129
LiveView 75 tag addresses
redundant I/O servers editing
default settings 57
users
creating in Runtime environment 122
V
validation
system 102
W
waveform
why can't Iacquire? 131
web client
installation 101
Schneider Electric This product must be installed, connected, and used in compliance with prevailing standards and/or
35, rue Joseph Monier installation regulations. As standards, specifications, and designs change from time to time, always
CS 30323 ask for confirmation of the information given in this publication.
F - 92506 Rueil Malmaison Cedex 7EN02-0382-00MN03/2016
www.schneider-electric.com © 2016 Schneider Electric. All Rights Reserved.