Está en la página 1de 755

Reference Manual

ECS Document Map

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 5
$Modtime:: 12/05/01 3:29p
gf
$Author:: Ngb
$Workfile:: SDRDocumentMap30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS Document Map................................................................................... 1
Introduction ................................................................................................................................... 1
ECS System Installation & Setup.......................................................................................... 1
Control System Configuration............................................................................................... 1
Operator Interface.................................................................................................................. 2
ECS System Installation & Setup................................................................................................. 2
Control System Configuration...................................................................................................... 4
Operator Interface ......................................................................................................................... 5

Index............................................................................................................ 7

Reference Manual ECS Document Map

ECS Document Map i

ECS Document Map

Introduction
The ECS Document Map provides an overview of the manuals available to the
ECS NTech user and a description of each. The document is used to identify the
manuals required to install, configure and operate the system.
The ECS documentation is divided into three volumes: ECS System Installation
& Setup, Control System Configuration, and Operator Interface. These volumes
have been organized into two separate manuals: the SDR Reference Manual
grouping the volumes: ECS System Installation & Setup and Control System
Configuration, and the ECS User Manual holding the Operator Interface
volume.
The information in each volume is presented in a format that is compatible with
OnLine Help and paper copy. In most cases, the OnLine Help and paper copy
present the same information. The major difference between the two formats is
that OnLine Help minimizes the use of screen captures since the screens are
normally available at the time OnLine Help is used.

ECS System Installation & Setup


The manuals included in the SDR System Installation & Setup volume are used
for the installation of the Microsoft Windows 2000 operating system and the
FLSA ECS system. The system configuration assignments that are typically
done only at installation time are also described in this section.
These manuals are intended for engineers who are experienced with the
Microsoft Windows 2000 operating system, the ECS NTech system and the
process application. Personnel responsible for workstation installation, system
parameter modifications, and user account maintenance would refer to this
volume set.

Control System Configuration


The Control System Configuration volume defines the procedures used to
configure the process system. This includes point database creation, point
algorithm assignments, report configuration, graphic generation, etc.
These manuals are intended for system engineers responsible for the interface to
the process application.

Reference Manual ECS Document Map

ECS Document Map 1

Operator Interface
The Operator Interface volume set describes the procedures used to access and
manipulate the ECS displays. These manuals are used by anyone responsible for
monitoring and controlling the plant operation.

ECS System Installation & Setup


This volume set is used to prepare and configure a personal computer to be used
in an FLSA process application. The manuals provide an introduction to the
system, and a step by step description of the installation and setup procedure.
During the installation and setup process, the manuals are used in the following
sequence.

2 ECS Document Map

1.

Before starting the installation and setup process, review the SDR
Concepts manual for an introduction to the ECS system. The manual
describes the point database, point-treatment, alarm handling, data
archiving, and the report system. The manual also defines the
terminology used in subsequent manuals.

2.

The Installation & setup process assumes that the user is starting with a
personal computer and no operating system. The process begins with
the installation of the Microsoft Windows 2000 operating system
described in the Windows 2000 Installation manual. The manual
describes the installation procedure and addresses the specifics that
apply to the ECS system.

3.

The Windows 2000 operating system is now installed and the Windows
2000 security can be changed according to desired needs. This is
described in the ECS Windows 2000 Security manual.

4.

After Windows 2000 is installed on the PC, the FLSA ECS system CDROM is installed using the procedure described in the ECS W2K
Installation manual.

5.

After the installation of Windows 2000 and ECS systems, the user must
log into the ECS system as described in the Starting the SDR
System manual. The manual also describes the maintenance and run
modes, startup and shutdown procedures, and login and logout
procedures.

6.

At this point in the installation and setup process, the SDR licenses
installed during the ECS installation can be modified, if desired. The
procedure is described in the SDR Maintenance manual. The manual
also describes, SDR subsystem synchronization, and database backup /
restore procedures.

7.

While in the maintenance mode, Server partners (for dual systems


only), Client/Server relationships, and subsystem assignments are made.
These assignments are described in the SDR Partner Configuration
manual.

8.

While in the maintenance mode, other system parameters such as


system and factory names, the database backup period, the number of
database points, and the languages used for ECS displays are assigned.

Reference Manual ECS Document Map

These parameters are described in the Point System Configuration


manual.
9.

The system parameter assignments are now complete. The system is


booted to the ECS Run Mode as described in the Starting the SDR
System manual.

10. The control system can now be configured using the procedures
described in the Control System Configuration volume set.

Reference Manual ECS Document Map

ECS Document Map 3

Control System Configuration


This volume set includes the manuals used to configure the ECS control system.
The control system configuration parameters can be assigned or modified in any
order. Therefore, the following manuals can be referenced as needed.
The SDR User Access Control Configuration manual describes how to
grant access rights to new and existing users for the ECS system. System
administrators can control access to the point, I/O, log, event, etc systems for an
individual user or a group of users.
The Point System Configuration manual describes the configuration
parameters associated with the point system. The point system is configured by
assigning the following:

number of points and point treatment period

shift definitions and report hour assignment

control actions to be logged and contol action definitions

point state definitions

alarm reset scope

engineering units for the local and default language

department names

The procedures used to create, modify, copy and delete database points are
described in the SDR Point Configuration manual. The manual also provides
a description of the point configuration parameters, event algorithms, and report
algorithms. The conversion algorithms that are assigned to A-points are
identified and described in the A-Point Algorithms manual. The conversion
algorithms assigned to B-points are created, modified, or reviewed using the
editor described in the B-Point Algorithms Editor manual.
The Point System Configuration manual describes the configuration
parameters associated with the alarm system. These parameters include:

general alarm parameters such as alarm silence scope, alarm reset


scope, alarm philosophy, etc.

department horn assignments

alarm log/department allocation

alarm entry in alarm list color

alarm entry in alarm header color

alarm header department button colors

The SDR Report Configuration describes the procedures used to configure


plant reports and create and schedule report collections.
The ECS OpStation Editor manual describes the OpStation Editor details
specific to FLSA. The standard functions are described in the SL-GMSDraw
Users Guide (SL Corporation Part Number: DRAW-300519) which comes as a
.PDF file located on the ECS Ntech Cdrom.
I/O Interface Manuals are specific to the DCS or PLC system used with the
ECS system. Each manual describes the required configuration assignments to
interface the I/O system with the SDR system.
After the control system is configured, the user can access the SDR applications
and utilities to monitor and control the plant operation. The applications are
described in the manuals contained in the Operator Interface volume set.

4 ECS Document Map

Reference Manual ECS Document Map

Operator Interface
This volume set includes the manuals that describe the applications, utilities and
displays used to monitor and control the process application.
The first time user may want to review the information presented in the SDR
User Interface manual. This document provides an introduction to the ECS
workstation and describes the workstation environment and the details associated
with display windows and mouse operation. The manual includes the procedures
to log into the SDR system and start and stop applications. The manual also
provides a description of the operations and functions common to all SDR
application windows and dialog boxes.
After logging into the SDR system, the operator may wish to see what languages
are available. One of two languages (local or default) can be selected. The
selected language is then used to present information in the display windows and
dialog boxes. The language selection is described in the SDR Language
Selection manual.
The SDR Point List manual describes the procedure used to access and
interface with the Point List display.
The SDR Point Parameters manual describes the procedure used to access
and interface with the Point Parameters and Statistics display.
The SDR Alarm Header manual describes the details associated with alarm
notification and response. The alarm header toolbar commands and department
buttons are also described.
The Alarm List manual describes the procedure used to access and interface
with the Alarm List display.
The SDR Trend manual describes the procedure used to access the Trend
display and review and analyze historical data.
The SDR Plant Reports manual describes the procedure used to generate
plant reports and report collections.
The ECS OpStation manual describes the procedures used to access process
graphics and navigate the display hierarchy. The manual also describes the
details associated with graphic elements (sliders, thermometers, faceplates, etc.).
The manual includes a description of the display hierarchy and how the displays
are accessed.
The ECS Opstation manual provides a description of the device group display
and the procedures used to start and stop plant equipment using the display and
the alarm header Start, Stop, Qstop, and Mstop commands.
The ECS Note Pad manual describes the functionallity of ECS Note Pad
display.

Reference Manual ECS Document Map

ECS Document Map 5

Glossary of
Terms

6 Glossary of Terms

Reference Manual ECS Document Map

Index
A

alarm header............................................................ 45
alarm list ................................................................. 4, 5
alarm philosophy ........................................................ 4
alarm reset scope ........................................................ 4
alarm silence scope..................................................... 4
A-Point Algorithms .................................................... 4

Operator Interface .......... 12, 12, 12, 45, 45, 45


OpStation Editor ......................................................... 4

B-Point Algorithms .................................................... 4

Partner Configuration ................................................. 2


Plant Reports...................................................45, 4, 5
Point Configuration..................................................... 4
point state definitions.................................................. 4
Point System Configuration........................................ 4

Control System Configuration ...........1, 34, 34, 34

Qstop ........................................................................... 5

default ..................................................................... 4, 5
department button colors ............................................ 4
department names ....................................................... 4

SDR Alarm Header..................................................... 5


SDR Concepts.............................................................2
SDR Language Selection............................................ 5
SDR Partner Configuration ........................................ 2
SDR Point List ............................................................ 5
SDR Point Parameters ................................................ 5
SDR Reference Manual .............................................. 1
SDR Report Configuration ......................................... 4
SDR System Configuration ........................................ 3
SDR System Installation & Setup .............................. 1
Security ....................................................................... 2
shift definitions ........................................................... 4
SL-GMSDraw Users Guide ...................................... 4
Start 5
Starting..................................................................23
Stop 5

language selection....................................................... 5
local 4, 5

E
ECS Note Pad ............................................................. 5
engineering units......................................................... 4

I
I/O 4
I/O Interface Manuals................................................. 4
Installation & Setup........................................ 12, 1, 2

Trend Display.............................................................. 5

M
Mstop .......................................................................... 5

W
W2K ............................................................................ 2
Windows 2000 Installation......................................... 2

Reference Manual ECS Document Map

Index 7

Reference Manual

ECS/SDR Concepts

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 3
$Modtime:: 7/11/01 9:36a
gf
$Author:: Ngb
$Workfile:: SDRConcepts30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS/SDR Concepts ................................................................................... 3
System Overview .......................................................................................................................... 3
Runtime Environment............................................................................................................ 3
PLC Interface......................................................................................................................... 3
Hierarchy Objects ......................................................................................................................... 4
Departments ........................................................................................................................... 4
Groups.................................................................................................................................... 4
Routes .................................................................................................................................... 4
Master points.......................................................................................................................... 4
Point Processing............................................................................................................................ 5
Database Point ....................................................................................................................... 5
Point Configuration Parameters ............................................................................................ 5
Point Algorithms.................................................................................................................... 5
Point Types ............................................................................................................................ 5
Point Values........................................................................................................................... 6
Point Status ............................................................................................................................ 6

A Point Status ..................................................................................................... 6


B Point Status...................................................................................................... 6
Point Processing Sequence.................................................................................................... 6
Alarm and Report Suppression.............................................................................................. 8

Point Alarm Suppression................................................................................... 8


Report Suppression ............................................................................................ 8
Hierarchical Alarm Suppression....................................................................... 8
Alarm System................................................................................................................................ 9
Alarm Types .......................................................................................................................... 9
Process Alarm Handling........................................................................................................ 9
System Alarm Handling ........................................................................................................ 9
Event Algorithm .................................................................................................................... 9
Alarm Notification................................................................................................................. 9
Alarm Response................................................................................................................... 11
Alarm Philosophy ................................................................................................................ 11
Alarm Priorities ................................................................................................................... 11
Event System............................................................................................................................... 11
Control Action ..................................................................................................................... 11
Data Log System......................................................................................................................... 12
Trend Value Logs ................................................................................................................ 12
Statistical Logs..................................................................................................................... 12
Log Data Access .................................................................................................................. 12

Glossary of Terms ................................................................................... 13


Index.......................................................................................................... 15

Reference Manual for SDR Concepts

Contents i

ECS/SDR Concepts

System Overview
The ECS/SDR system is a software environment developed to support
monitoring and control of industrial plants. It realises a set of basic facilities like
data processing, alarm and event management, as well as data logging and report
generation that are required to complement the services provided by a typical
PLC control level. In that way the ECS/SDR system will act as a kind of
interface between the PLC control level and the MMI (Man Machine Interface).
Further, the ECS/SDR system will support the operation of some of the
specialised control packages belonging to the ECS (Expert Control and
Supervision) and QCX (Quality control by Computer and X-ray) product
families.

Runtime Environment
The ECS/SDR system is designed for running on a personal computer under the
Microsoft Windows 2000 operating system. This computer can be part of a
network environment where each node is assigned the role of Server computer
(previously termed MOP computer) or Client computer (previously termed DOP
computer). Here, a Server can establish and maintain communication with the
PLC control level while a Client needs an associated Server through which it can
receive data and excert its control actions. A special facility will enable a
computer to be configured both as a Server and a Client whereby it can serve
several purposes at the same time.
Normally, a network only requires one Server, however two may be used in a
redundant configuration. In redundant applications, both Servers maintain
communication with the PLC control level. When changes are made to common
data administrated by one of the Servers, the database in the redundant Server is
automatically updated.

PLC Interface
The PLC interface enables the ECS/SDR system to interact with the plant. This
is done by communicating data to and from the PLC's. The ECS/SDR system
facilitates communication with the most common PLC families.

Reference Manual for SDR Concepts

ECS/SDR Concepts 3

Hierarchy Objects
The hierarchy objects in the system are Departments, Groups, Routes, Master
points and Points. These are detailed below.

Departments
Departments are plant divisions usually defined by operational boundaries. For
example, in a cement plant, the kiln would be one department and clinker
handling would be another. A single PLC can control several departments, but in
typical applications, one PLC controls one department. Points do not belong
directly to a department, they belong to a group. A PLC horn point can be
associated with a department. Points are indirectly, through groups, members of
departments.

Groups
A department is further divided into groups. Groups are used to increase
department granularity. Points are members of one and only one group. A group
consists of equipment that controls a specific function within a department. A
group can include motors and gates and different types of each. Devices that
interact during the process operation and have common interlocks are often
assigned to the same group. A B-point can be associated with a group. This point
is called the "Group Point". The Group Point can be used to suppress the alarms
of group member points, if the Group Point is in a "suppressing" state, eg
stopped. The point value for the Group Point are normally read from the PLC,
and reflects the state of the group. It is normally the operator who controls the
Group Point. The Group Point must be a member of the group it controls.

Routes
A route is a transport path. The route hierarchyobject is expedient because often
there are multiple routes to deliver a material. Most often only one of these
routes is used at a time. A group can have zero or more routes. A point can be a
member of zero or more of these routes. Similar to groups, a B-point can be
associated with a route. This point is called the "Route Point". The Route Point
can be used to suppress the alarms of route member points, if the Route Point is
in a "suppressing" state, eg stopped. The Route Point must be a member of the
route it controls. The point value for the Route Point are normally read from the
PLC, and reflects the state of the route. It is normally the operator who controls
the Route Point.

Master points
A Master Point is a parent point to one or more child points. A child point cannot
be a Master Point. Master Points also provide increased point granularity. The
Master Point can be used to suppress the alarms of master member points, if the
Master Point is in a "suppressing" state, eg stopped.

4 ECS/SDR Concepts

Reference Manual for SDR Concepts

Point Processing
Database Point
A point is a record within the ECS/SDR database that represents an analog
measurement point (A-point), digital measurement point (B-point), and
internally calculated A-point or B-point. A point is identified by a unique
pointcode also referred to as a point name or tag name.

Point Configuration Parameters


The database point record includes information that enables the ECS/SDR
system to locate the point, evaluate alarm conditions, log data, and post the
current value and status on process graphics and other displays. The database
record also includes processing details for value conversions and calculations.
This information is referred to as the point configuration parameters.

Point Algorithms
Point algorithms are used to convert raw input values (Conversion Algorithms),
process point alarms (Event Algorithms), and perform statistical calculations
(Report Algorithms). The user selects the algorithms to perform the desired
functions when the database point is created.
When a point is processed, the values from the associated device or the value of
another point is applied to the algorithm along with the point configuration
parameters. The algorithm that is used depends on the point type (A or B) and
the desired result.

Point Types
A-points are used to interface with analog input and output devices, perform
calculations, or connect to an analog controller located in a PLC. B-points are
used to interface with digital input and output devices connected to the PLC.
Points can also be configured to accept a value from the operator. These points
are called operator-inserted points. The algorithm in this case obtains the input
value from the operator instead of the PLC or another point.

Reference Manual for SDR Concepts

ECS/SDR Concepts 5

Point Values
A point value is the result of the A or B-point conversion algorithm. After points
are processed, their values are maintained in the memory resident database and
posted in display lists, process graphics, and saved to disk for data archiving
purposes. The result of an A-point algorithm is presented as a numeric value to
represent temperatures, pressures, setpoints, etc.
B-point values are represented as a text string (Run, Stop, Open, etc.). These
values are derived from a 16 bit Machine Status Word (MSW) received from the
PLC and applied to the B-point conversion algorithm.

Point Status
Point status defines the condition of a point value when it is processed. The
status is determined by the point value, point configuration parameters, parent
point status, and various suppression conditions.

A Point Status
Normal Point value is within defined limits
Alarm High Point value has reached or exceeded the assigned Alarm High
limit
Alarm Low Point value has reached or exceeded the assigned Alarm Low limit
PalmSu Point alarms are suppressed by parent point
OalmSu Point alarms are suppressed by operator
PrepSu Point report algorithm is suppressed by parent point
HAlmSu Hierarchical alarm suppressed. The point is alarm suppressed by a
Group Point, Route Point, and/or Master Point

B Point Status
Normal Current MSW value has been defined as a normal condition.
Alarm Current MSW value has been defined as an alarm condition.
Error MSW value not defined
Local MSW local bit is set
PalmSu Point alarms are suppressed by parent point
OalmSu Point alarms are suppressed by operator
PrepSu Point report algorithm is suppressed by parent point
HAlmSu Hierarchical alarm suppressed. The point is alarm suppressed by a
Group Point, Route Point, and/or Master Point

Point Processing Sequence


1.

6 ECS/SDR Concepts

Database point values are obtained from the PLCs or internal variables on a
periodic basis. The frequency is determined by system configuration
parameters.

Reference Manual for SDR Concepts

2.

The value obtained from the PLC is then applied to the conversion
algorithm assigned to the point.

3.

The value of the point and the current parameter assignments are reviewed
to determine the point status.

4.

If the point is in an alarm state, the scan sequence must then determine if
alarms for this point are suppressed.

5.

If alarms are not suppressed, the points event algorithm is executed.


Otherwise, the alarm state is ignored.

6.

If a report algorithm is assigned and reports are not suppressed, the report
algorithm is executed to obtain statistical information.

Reference Manual for SDR Concepts

ECS/SDR Concepts 7

Alarm and Report Suppression


During system operation, a specific process condition may cause nuisance
alarms or cause invalid data to be calculated and logged. For example, a motor
stop condition may cause another point to report an alarm condition. During
normal operation, alarms must be processed for this point. For this motor stop
condition however the alarms are expected and notification is not necessary. In
addition, the motor stop condition may also cause invalid data to be used in the
points report algorithm. In this case, it would be desirable to disable the points
event and report algorithms. There are two types of alarm suppression
techniques, (1) Point Alarm and Report suppression and (2) Hierarchical Alarm
suppression. Both are point based.
The ECS system enables Point Alarm and Report suppression for individual
points by assigning a parent point. Whenever the parent point status is not
normal, alarms or reports for the child point are disabled. A parent point can be
specified for alarm suppression and/or report suppression.
Reports and alarms for individual points can also be permanently suppressed.

Point Alarm Suppression


During processing, if a parent point is specified for alarm suppression, alarms
for the child point are not processed if any of the following are true:

The status of the parent point is not Normal

The parent point is point alarm suppressed (PAlmSu)

The parent point is operator alarm suppressed (OAlmSu)

Report Suppression
During processing, if a parent point is specified for report suppression, The
report algorithm is not executed for the child point if any of the following are
true:

The status of the parent point is not Normal

The parent point report algorithm is suppressed (PRepSu)

Hierarchical Alarm Suppression


Hierarchical Alarm Suppression is associated with Group, Route and Master
point objects as mentioned earlier. A group and route can be assigned a B-point,
the so-called Group Point and Route Point respectively. These points can then be
used to suppress alarms from a group or route if the value of the group or route is
"alarm suppressing", as defined by the B-point algorithm used by the Group or
Route point. Group or route member points are thus alarm suppressed if their
parent point is "alarm suppressing". The degree of hierarchical alarm
suppression is configurable. For each of the object types (groups, routes and
master points) you can choose three hierarchical suppression modes: 0 - no
logging and no annunciation, 1 logging and no annunciation, and 2 logging
and annunciation. For example is (0) is chosen then a point which goes into an
alarm state, but which is hierarchical suppressed, then this will not be logged and
not annunciated. If (1) is chosen it will be logged, but not annunctiated, and if
(2) is chosen it will we logged and annunciated (another words hierarchical
suppression is turned off).

8 ECS/SDR Concepts

Reference Manual for SDR Concepts

Alarm System
The ECS/SDR system encompasses an enhanced alarm system which decouples
point state, event logging and alarm annunciation. The decoupling is
configurable. A point value is the foundation to determine the point state. If the
state is an alarm state this can lead to annunciation and event logging. Alarm
annunciation consists of the Alarm Header, workstation acoustics, mimic
color/blink, PLC horn, and standing alarm list. Eventing consists of logging the
alarm/event in the event data base, viewing alarms/events in the alarm list,
output on the alarm printer, and third party notification. Many aspects of
annunciation and eventing are configurable.
The ECS/SDR alarm system
handles process and system alarms. When an alarm occurs, the date and time of
the alarm is logged and the operator is notified of the condition.

Alarm Types
Process alarms are generated when A-points exceed assigned limits or B-points
report a value that has been defined as an alarm state. Alarm can be suppressed
using a number of techniques as mentioned above.
System alarms are reported when problems such as communication errors, disk
full, file not found, etc. occur within the ECS/SDR system.

Process Alarm Handling


1.

If a point value has changed since the last poll, the current value is
compared to the defined alarm state or alarm limits. If an alarm condition
exists, alarm suppression is verified.

2.

If the point is alarm suppressed, alarm annunciation and event logging can
end depending on how this is configured.

3.

The alarm system records the occurrence into the alarm log. The log entry
includes the point tag, the point text, the type of alarm, the value exceeded,
and the time of the alarm (alarm on time).

4.

When the point returns to a normal state, or another alarm state is entered,
the alarm off time is written to the alarm entry.

System Alarm Handling


1.

If a system type alarm condition exists, the alarm system records the
occurrence into the alarm log. The log entry includes the type of alarm and
the time of the alarm.

2.

The operator is notified of the system alarm.

Event Algorithm
An Event algorithm is assigned to a point when it is created. The algorithm
assigned determines if the alarm/event condition is logged and/or annunciated.
For B-points the associated B-point algorithm also determines what B-point
value changes are annunciated and whether or not these changes are information,
warning or error events.

Alarm Notification
When an alarm is reported, the operator is notified if alarms are enabled and an
Event algorithm is assigned to the point. Several alarm annunciation techniques

Reference Manual for SDR Concepts

ECS/SDR Concepts 9

are available. The system can be configured to audibly notify the user with
display beeps and/or PLC horns. Different horns can be associated with each
alarm priority in each department.
Visual indications can also be utilized. Different colors and flashing colors can
be used to annunciate alarms and indicate the alarm in graphic displays,
department buttons, and alarm lists.
The notification method used by the system can be configured by the user.

10 ECS/SDR Concepts

Reference Manual for SDR Concepts

Alarm Response
The operator responds to the alarm condition using the workstation Alarm
Silence and Alarm Reset commands. The effect these commands have on display
elements and audible alarms can be defined by the user to meet the specific
needs of the process application.

Alarm Philosophy
The alarm philosophy defines the details associated with alarm notification and
response. This determines colors used to indicate alarms and the effect the Alarm
Silence and Reset commands have on:

PLC Horns

Display Colors

PLC Messages

The scope of the effect can also be configured. These commands can affect the
entire process (global) or individual departments (local).

Alarm Priorities
Each point in the alarm system is assigned an alarm priority (1 5), where 1 is
the highest priority and 5 is the lowest. The priority assignment is used to filter
alarms in alarm list displays.

Event System
A system event is generated when a user performs a control action. When a
system event is reported, the occurrence is logged into the event log. The log can
be reviewed from the ECS alarm list display. An event log report can also be
generated on demand or scheduled on a periodic basis.

Control Action
A control action is an action initiated by a user such as changing point
parameters, resetting an alarm, or starting and stopping plant equipment. The
actions to be logged are defined by the user during system configuration.

Reference Manual for SDR Concepts

ECS/SDR Concepts 11

Data Log System


The ECS/SDR Data Log system periodically saves point values and statistical
information to historical data files. The historical data files are organized into
two groups Trend Value Logs and Statistical Logs. The log files are accessed
by other ECS/SDR utilities to generate point value trend displays, and plant,
shift, and production reports.

Trend Value Logs


The Trend Value Logs contain A-point values for a time period configured by
the user. A log entry consist of the point name, the point value, and the date and
time of the entry.

Statistical Logs
The Statistical Logs include a Hourly Log, a Shift Log, and a Daily Log. These
logs are used to save statistical data for each A and B-point at the end of the
respective interval. A log entry consists of the point name, the date and time of
the entry, and the following information for the specified point type:
A & B-Points
Alarm Count The number of alarms reported by the point for the hour,
shift, or day.
Alarm Time The amount of time the point was in alarm for the hour, shift,
or day.
Error Count The number of errors reported by the point for the hour, shift,
or day.
A-Points only
Maximum Value The maximum value recorded for the hour, shift, or day.
Minimum Value The minimum value recorded for the hour, shift, or day.
Average Value The average of all point values recorded for the hour,
shift, or day.
Calc. by Report Alg. The result of the report algorithm. Samples the
number of samples for the hour, shift, or day.
B-Points only
Operating Hours The accumulated amount of time the point has been
"ON" for the hour, shift, or day.

Log Data Access


The ECS/SDR log data can be reviewed and analyzed from the ECS/SDR trend
displays or by generating plant reports.

12 ECS/SDR Concepts

Reference Manual for SDR Concepts

Glossary of Terms

Client
Client computer. A Microsoft Windows 2000 computer configured as an
ECS/SDR client.

ECS
Expert Control and Supervision. A suite of software packages providing
advanced MMI and other process control facilities.

Server
Server computer. A Microsoft Windows 2000 computer configured as an
ECS/SDR server. A Server maintains the ECS point database and the link to the
PLC control level.

Server partners
Server pair configured for redundancy.

MSW
Machine Status Word. 16-Bit word transferred between the ECS/SDR system
and PLC to process digital values.

operator-inserted point
A point whose value is supplied by an operator.

parent point
A point used for alarm and report suppression of another point.

PLC
Programmable Logic Controller. A computer developed particularly to interface
and control industrial plants. Makes up a key item in the interface between the
ECS/SDR system and the plant instrumentation.

ECS/SDR
Expert Control System/System Development and Runtime. A software package
providing a set of basic facilities for control of industrial plants like, for example
data processing, alarm and event management, data logging and report
generation. No process MMI has been included.

Reference Manual for SDR Concepts

Glossary of Terms 13

14 Glossary of Terms

Reference Manual for SDR Concepts

L
Log Data Access, 11

Index

M
Machine Status Word, 6
Maximum Value, 11
Minimum Value, 11
MOP, 3
MSW, 6

O
OalmSu, 6, 8

Accumulated Value, 11
Alarm Annunciation, 9
Alarm Count, 11
alarm on time, 9
alarm philosophy, 10
alarm priority, 910
Alarm Priority, 10
Alarm Processing, 9
Alarm Suppression, 89
Alarm System, 910
Alarm Time, 11
Alarm Types, 9
Average Value, 11

PalmSu, 6, 8
Point Algorithms, 5
Point Configuration Parameters, 56
point name, 5
Point Processing, 56
Point Status, 6, 8
Point Types, 5
Point Values, 6, 11
pointcode, 5, 11
PrepSu, 6, 8
Process alarm, 9

Report Algorithms, 5, 8
Report Suppression, 8

B-points, 5, 9, 11

C
child point, 8
Control Action, 10
Conversion Algorithms, 5

D
Daily Log, 11
Data Log System, 11
Departments, 10
DOP, 3

S
SDR, 34, 5, 9
SDR/PLC Interface, 4
Shift Log, 11
Spot Value Log, 11
statistical data, 11
Statistical Logs, 11
Status, 56, 8
System alarm, 9
System Overview, 3

T
tag name, 5

ECS Database Point, 5


ECS Workstation, 3
Error Count, 11
Event Algorithm, 6, 9
Event Algorithms, 5
event log report, 10

H
Hourly Log, 11

Reference Manual for SDR Concepts

Index 15

Reference Manual

Windows 2000 Installation

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 6
$Modtime:: 19-07-01 13:04
MBH
$Author:: Mbh
$Workfile:: W2KInstallation30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
Windows 2000 Installation ........................................................................ 1
Introduction ................................................................................................................................... 1
Preparation .................................................................................................................................... 1
Hardware................................................................................................................................ 1
Software Media...................................................................................................................... 2
Configuration Information..................................................................................................... 2
Windows 2000 Installation Procedure.......................................................................................... 3
How to create a Windows 2000 Domain...................................................................................... 3
Introduction............................................................................................................................ 3
Creating a Domain................................................................................................................. 3
Making a computer member of a Domain.................................................................................... 3
Adding an additional Domain Controller..................................................................................... 3
Introduction............................................................................................................................ 3
Adding a Domain Controller................................................................................................. 3
Service Pack Installation............................................................................................................... 3
Printer Installation......................................................................................................................... 3
Installing a Local Printer ....................................................................................................... 3
Installing a Network Printer .................................................................................................. 3

Glossary of Terms ..................................................................................... 3


Index............................................................................................................ 3

Reference Manual Windows 2000 Installation

Contents i

Windows 2000 Installation

Introduction
The procedures used to install the Microsoft Windows 2000 operating system on
a personal computer are described in the following sections:

Preparation

Windows 2000 Installation Procedure

How to create a Windows 2000 Domain

Adding an additional Domain Controller

Service Pack Installation

Printer Installation

Preparation
Hardware
Verify the following before starting the Windows 2000 installation.
1.

The personal computer is in the Microsoft Windows 2000 HW


Compatibility List

2.

The computer includes:


- A minimum of 128/256 Mbytes of RAM (Professional/Server)
- A minimum of 4/8 Bytes of system disk space (Professional/Server)
- A bootable CDROM drive
- A floppy drive

3.

The computer is properly connected to the network (10/100 Mbit twisted


pair).

Reference Manual Windows 2000 Installation

Windows 2000 Installation 1

Software Media
Locate the following before starting the Windows 2000 installation.

For Windows 2000 Professional installation:


1.

The following compact disks:


-

Microsoft Windows 2000 professional

Microsoft Windows 2000 Service Pack


Refer to the ECS SW product for the required level of Windows
2000 Service Pack

For Windows 2000 Server installation:


2.

The following compact disks:


-

Microsoft Windows 2000 Server

Microsoft Windows 2000 Service Pack


Refer to the ECS SW product for the required level of Windows
2000 Service Pack

Configuration Information
Obtain the following information from your network administrator:

Computer name

Workgroup or Domain name

TCP/IP address

TCP/IP subnet mask

In order to browse network resources the following information is also required:

2 Windows 2000 Installation

TCP/IP address for DNS server

Reference Manual Windows 2000 Installation

Windows 2000 Installation Procedure


The following describes the Microsoft Windows 2000 installation procedure
used by FLS Automation.
The installation procedure depends on the recommendation suggested by FLS
Automation for your specific site.
During the installation procedure, the user is prompted for specific
information. Enter the default response unless instructed to do
otherwise in the following steps.
1.

Insert the Windows 2000 CD and reboot the system. (Make sure the BIOS of
the computer are set to boot from the CD-rom.)

2.

If your computer is equipped with a special hard disk controller e.g. a


special SCSI or RAID controller, press the <F6>key when the Windows
2000 Setup screen appears. You will be prompted for a support disk from
the hardware supplier. Refer to the documentation for the computer.

3.

When the Welcome to Setup screen appears, press the <Enter>key. (To
setup Windows 2000 now, press Enter.)

4.

To accept the licensing terms, press the <F8>key.

5.

Delete any old partitions and create a new one of a least 4 GB for a
Windows 2000 professional and 8 GB for Windows 2000 Server.

6.

Select Format the partition using the NTFS file system.


The file system must be formatted using NTFS to take advantage of all
NT security features.

7.

Enter the following directory for the installation.


\\WINNT

8.

After the partition is formatted and the setup has copied files to the hard
disk, the computer restarts by itself.

9.

At the Regional Settings prompt, select Customize for the keyboard layout.
Select Add and choose your current Input locale: e.g. French. Click Set
as default for your new Keyboard layout.

10. Enter a friendly name of the administrator and a friendly company or plant
name.
Name: <Administrator > For example: Administrator
Organization: <Company Name> For example: FLS Automation
11. For Windows 2000 Server Setup only.
Set licensing Mode to: Per Server. Number of concurrent connections:
Enter the number of connections that your license allows.
12. Enter Your Product Key.
The Product Key is included in the Windows 2000 kit, either on the CD
cover or a label on the computer.
13. Enter the computer name, e.g. ECS755SVR1
14. Enter the Administrator account password
15. For Windows 2000 Server Set-up only.
Windows 2000 Components choose default and Next.
16. Adjust Date & Time and Time Zone.

Reference Manual Windows 2000 Installation

Windows 2000 Installation 3

The Time Zone must be the same on all computers, and there must be a
checkmark in Automatically adjust clock for daylight saving changes.
17. Networking Settings choose Custom Settings.
18. In Networking Components the following components must be installed and
there must be a checkmark with each component:
Client for Microsoft Networks
File and Printer Sharing for Microsoft Networks
Internet Protocol (TCP/IP)
19. Mark Internet Protocol (TCP/IP) and click Properties
Click Use the following IP address: and enter an appropriate IP address,
Subnet mask and Default gateway. If there is a DNS server on your network
enter the IP address in Preferred DNS server.
20. If the computer is member of a workgroup click No, this computer is not on
a network, or is on a network without a domain. Type a workgroup name in
the following box.
Workgroup or computer domain: <Workgroup>For example: ECS755
If the computer is member of a Domain click Yes, make this computer a
member of the following domain:
Workgroup or computer domain: <Domain> For example: ECS755
Enter the User Name and Password, for a user that has the ability to add
computers to the domain.
User Name <User name> For example: Administrator
Password <password> For example: password
21. Click Finish to reboot the computer
22. The Network Identification Wizard starts.
Click Next
Choose Users must enter a user name and password to use this computer.
Click Next
Click Finish.
23. Login to Windows 2000 as Administrator and install additional device
drivers not recognised by Windows 2000 setup, e.g. Video adapters, Sound
Cards, ATA-100 IDE controllers etc.
Refer to the documentation for the computer.

4 Windows 2000 Installation

Reference Manual Windows 2000 Installation

How to create a Windows 2000 Domain


Introduction
Due to the complexity of installing, configuring and maintaining a Windows
2000 Domain we highly recommend to use a Workgroup installation for a
ECS system instead of a Domain installation.
When you install a Window 2000 server you install it as a stand-alone server in
a workgroup or as Member server in a domain. After the installation you
promote the server to a Domain Controller (DC) and create the domain if it does
not exist. If there is no other domain on the network, or the Domain will not be a
child to an existing domain, the domain you create is called a Root Domain. The
DNS (Domain Name System) name of a Root Domain must contain a . (dot),
e.g. ecs755.flsa . Furthermore there must be at least one DNS Server on the
network.
To create a Domain and Domain Controller you must:

Set the computer to use itself as the DNS server

Set the primary suffix to the DNS

Install and configure a DNS server

Run dcpromo.exe to create the domain and promote the computer to a


Domain Controller

Creating a Domain
Set the computer to use itself as the DNS server
1.

Right click My Network Places and select Properties.

2.

Right click Local Area Connection and select Properties

3.

Select Internet Protocol (TCP/IP) and click Properties

4.

Under Preferred DNS server: type the IP address of the computer

Reference Manual Windows 2000 Installation

Windows 2000 Installation 5

6 Windows 2000 Installation

5.

Click Advanced and DNS

6.

In DNS suffix for this connection: type the name of the domain you are
about to create, e.g. ecs755.flsa

Reference Manual Windows 2000 Installation

Set the primary suffix to the DNS


7.

Right click My Computer and select Properties

8.

Under Network Identification click Properties and More

9.

In Primary DNS suffix of this computer: type the name of the domain you
are about to create, e.g. ecs755.flsa

10. Reboot the computer when asked


Install and configure a DNS server
11. Start Add/Remove Programs and click Add/Remove Windows Components
12. Select Networking Services and click Details

Reference Manual Windows 2000 Installation

Windows 2000 Installation 7

13. Set a checkmark in Domain Name System and click OK


14. Select Start/Programs/Administrative Tools/DNS
15. Right click the computer and select Configure the server
16. Select This is the first DNS server on the network
17. Select Yes, create a forward lookup zone
18. Select Standard Primary
19. In Zone Name type the name of the domain, e.g. ecs755.flsa

20. Check Create a new file and click Next


21. Check Yes, create a reverse lookup zone, and click Next
22. Check Standard primary and click Next
23. In Network ID: type the first part of the subnet and click Next.
If your subnet mask is 255.0.0.0 you type the first number e.g. 10, if
your subnet mask is 255.255.0.0 you type the first 2 numbers e.g. 10.26
etc.

8 Windows 2000 Installation

Reference Manual Windows 2000 Installation

24. Check Create a new file with this file name: and click Next
25. A summary will be displayed and click Finish to complete the installation.
26. In the DNS MMC expand the Forward Lookup Zones, right click the
domain and select Properties
27. Under General set Allow dynamic updates? to Yes and click OK
28. Expand Reverse Lookup Zones and right click the subnet and select
Properties
29. Under General set Allow dynamic updates? to Yes and click OK
Run dcpromo.exe to create the domain and promote the computer to a
Domain Controller
30. Select Start/Run, type dcpromo and click OK

31. Click Next to start the wizard and check Domain controller for a new
domain. Click Next
32. Check Create a new domain tree, and click Next
33. Check Create a new forest of domain trees, and click Next
34. In New Domain Name type the full name for the domain, e.g. ecs755.flsa,
and click Next

Reference Manual Windows 2000 Installation

Windows 2000 Installation 9

35. In NetBIOS Domain Name choose default and click Next


The NetBIOS name is used later when you add a computer to the
domain. In this example the NetBIOS name of domain ecs755.flsa is
ECS755.
36. In Database and Log Locations click Next
37. In Shared System Volume click Next
38. Check Permissions compatible only with Windows 2000 servers and click
Next
39. In Directory Services Restore Mode Administrator Password type the
password of the administrator account
Password: <password> For example: password
40. Click Finish to the summary window to complete the creation of the domain
and promotion of the computer to a Domain Controller
41. Click Restart Now
42. You are now ready to make other computers member of the newly created
domain.

Making a computer member of a Domain


If you did not make the computer a member of an existing domain during
installation you can join the computer to a domain after the installation of
Windows 2000 is complete.

10 Windows 2000 Installation

1.

Right My Network Places on the desktop and click Properties

2.

Double click Local Area Connection and click Properties

3.

Mark Internet Protocol(TCP/IP) and click Properties

4.

Ensure that the correct DNS server(s) are listed

Reference Manual Windows 2000 Installation

5.

Right click My computer on the desktop and click Properties

6.

Choose Network Identification and Properties

7.

In Member of click Domain and type the NetBIOS name of the domain.
The NetBios name of a domain is the default name you choose during
creation of the domain, e.g. the NetBIOS name of domain ecs755.flsa is
ECS755.

8.

Click OK

9.

Enter the User Name and Password, for a user that has the ability to add
computers to the domain
User Name <User name> For example: Administrator
Password <password> For example: password

10. Click OK and OK to reboot the computer.


11. At the Log on to Windows expand Options
12. In Log on to: choose the domain e.g. ECS755, type the password for the
account and click OK

Adding an additional Domain Controller


Introduction
In a Windows 2000 Domain there is no Backup Domain Controllers, all Domain
Controllers are Primary. To install an additional Domain Controller you join
the computer to the Domain and then promote the computer to a Domain
Controller. In order to gain full redundancy you have to install a DNS server on
the second Domain Controller as well.

Reference Manual Windows 2000 Installation

Windows 2000 Installation 11

To add an additional Domain Controller to a Domain you must:

Join the computer to the domain.

Set the computer itself as Alternate DNS server

Install and configure a DNS server

Run dcpromo.exe to promote the computer to a Domain Controller

Adding a Domain Controller


Join the computer to the Domain
1.

If the computer was not joined the Domain during installation do it now.
See earlier chapter

2.

Right click My Network Places and select Properties.

3.

Right click Local Area Connection and select Properties

4.

Select Internet Protocol (TCP/IP) and click Properties

5.

Under Alternate DNS server: type the IP address of the computer

Install and configure a DNS server


6.

Start Add/Remove Programs and click Add/Remove Windows Components

7.

Select Networking Services and click Details

8.

Set a checkmark in Domain Name System and click OK

9.

Select Start/Programs/Administrative Tools/DNS

10. Right click the computer and select Configure the server
11. Select Yes, create a forward lookup zone

12 Windows 2000 Installation

Reference Manual Windows 2000 Installation

12. Select Standard Primary


13. In Zone Name, type the name of the Domain, e.g. ecs755.flsa
14. In Zone File click Next
15. In Reverse Lookup Zone select Yes, create a reverse lookup zone
16. Select Standard Primary
17. In Network ID: type the first part of the subnet and click Next.
If your subnet mask is 255.0.0.0 you type the first number e.g. 10, if
your subnet mask is 255.255.0.0 you type the first 2 numbers e.g. 10.26
etc.
Run dcpromo.exe to promote the computer to a Domain Controller
18. Select Start/Run, type dcpromo and click OK
19. Click Next to start the wizard and check Additional domain controller for an
existing domain. Click Next
20. In Network Credentials type the user name and password of the
administrator
User Name <User name> For example: Administrator
Password <password> For example: password

21. In Additional Domain Controller click Next


22. In Database and Log Locations click Next
23. In Shared System Volume click Next
24. In Directory Services Restore Mode Administrator Password type the
administrator password, e.g. <password>
25. In the Summary window click Next
26. Click Reboot to complete the installation of an additional domain
controller.

Reference Manual Windows 2000 Installation

Windows 2000 Installation 13

Service Pack Installation


After installation of Windows 2000 you have to apply the current service pack.
If you after the installation install additional Windows 2000 components you
also have to apply the service pack.
1.

Locate the service pack, either on a CD-Rom, on your local hard disk or on
the network

2.

Open Windows Explorer and browse to locate the service pack directory
\i386\update

3.

Double click update.exe

4.

Select Accept the License Agreement and click Install

5.

Click Restart when asked

Printer Installation
A printer can be installer either as a Local printer or as a Network printer. A
Local printer is connected directly to a port on the computer (LPT or COM) or
to a Standard TCP/IP Port you create. A Network Printer is connected to a
shared printer on another computer.

Installing a Local Printer


Installing a Plug and Play printer only works if the printer is connected directly
to a LPT or COM port on the computer.
1.

Run Start/Settings/Printers

2.

Double click Add Printer

3.

Select Local Printer and Next

4.

If no Plug and Play printers found click Next

5.

Choose the port the printer is connected to and click Next


a) If the printer is connected to a print server on the network select
Create a new port:
b) In the dropdown select Standard TCP/IP Port and click Next
c)

14 Windows 2000 Installation

Type the IP address of the print server and a port name.

Reference Manual Windows 2000 Installation

d) Click Next and Finish


6.

Choose a printer from the list. If the printer is not listed you must have a
driver from the printer manufacturer and click Have DiskClick Next

7.

Type a friendly name for the printer. Click Next

8.

Select Do not share this printer and Click Next

9.

Click yes to Do you want to print a test page? Click Next

10. Click Finish to the summary window.

Installing a Network Printer


Before you can connect to a network printer, you must have an account on
the computer sharing the printer and have the proper privileges to use the
printer. Furthermore you must be logged in with that account on your
computer to access the printer.
1.

Run Start/Settings/Printers

2.

Double click Add Printer

3.

Select Network Printer and Next

4.

Select Type the printer name, or click Next to browse for a printer

5.

Browse for the printer you want to install and click Next.

6.

Click Finish to the summary window

Reference Manual Windows 2000 Installation

Windows 2000 Installation 15

Glossary of Terms

Reference Manual Windows 2000 Installation

Glossary of Terms 17

Index

Error! No index entries found.

Reference Manual Windows 2000 Installation

Index 19

Reference Manual

SDR W2K Security

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 2
$Modtime:: 20-09-01 16:19

$
$

$Author:: Mbh
$Workfile:: SdrNtSecurity30_English.doc
0-1000

$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
SDR W2K Security ..................................................................................... 1
Introduction ................................................................................................................................... 1
SDR W2K groups and user accounts ........................................................................................... 1
SDR W2K user account creation .......................................................................................... 4
W2K policy editor......................................................................................................................... 5
Setting up user policies.......................................................................................................... 5
Control panel, Display........................................................................................................... 6
Desktop .................................................................................................................................. 6
Shell, Restrictions.................................................................................................................. 7
System, Restrictions .............................................................................................................. 8
Windows NT Shell, user interface ........................................................................................ 8
Windows NT Shell, Custom folders ..................................................................................... 8
Windows NT Shell, Restrictions........................................................................................... 9
Windows NT System........................................................................................................... 10
Special user restrictions .............................................................................................................. 11
Change the system time....................................................................................................... 11
Program groups.................................................................................................................... 11
Active Directory.......................................................................................................................... 11
Introduction.......................................................................................................................... 11
Example 1. ........................................................................................................................... 12
Example 2. ........................................................................................................................... 13

Appendix A ............................................................................................... 15
Set up locally-based system policies .......................................................................................... 15

Glossary of Terms .........................................Error! Bookmark not defined.


Index................................................................Error! Bookmark not defined.

Reference Manual SDR W2K Security

Contents i

SDR W2K Security

Introduction
SDR W2K security is based on the following:
Windows 2000 security, including Users and Passwords, Local Security Policy
DCOM security.
Windows 2000 Active Directory, including Active Directory Users and Computers
Windows 2000 policy editor.
SDR User Access Control (UAC).
In a workgroup installation you use the Local Security Settings mmc snap-in to control
the settings for the computer e.g. who can change the system time. With Local Security
Settings you can only set security settings for one user. To control security for different
user on one computer you use the policy editor (poledit.exe), e.g. restrict access to the
desktop
In a Windows 2000 Domain you use the Active Directory Users and Computers to control
the security settings for the computer and different users.
The SDR user access control (SDR-UAC) system is used to edit access rights to SDR
control functions. Procedures for performing these operations are given below.

SDR W2K groups and user accounts


When SDR is installed user groups and default user accounts are created.
The W2K groups and default user accounts are explained below. Please note that the
settings described below are accurate at the time of this writing. However, the settings
made by the installation program are the most up to date, and should not be tampered
with.

Local Groups
The following local groups are defined, "Flsa Users" and "Flsa Administrators".
The "Flsa Users" group allows access to SDR-NT COM servers, shares, registry,
etc. The "Flsa Administrators" is used for grouping Flsa administrator accounts.
The attributes of the "Flsa Users" group are:

Rights: No special rights.

The attributes of the "Flsa Administrators" group are:

Reference Manual SDR W2K Security

Rights: No special rights.

SDR W2K Security 1

Global Groups
Two global groups are defined when installing the ECS/SDR system in a
domain.
Global groups can only be created in a domain. The groups are added to Active
Directory Users and Computers.
Domain members that need access to ECS/SDR product are added to the global
groups. The global groups gain access to the secure objects through their
membership of the local groups.
Do not directly add the global groups to any secure objects ACL. Route their
access through the local group. No special rights are set for global groups.
"Flsa Domain Admins"
This global group is used for grouping Flsa administrator accounts. A user does
not get administrator rights by being added to this group.
The attributes of the Flsa Domain Admins global group are:

Member of: Local group "Flsa Administrators".

"Flsa Domain Users"


This global group is used for grouping Flsa user accounts
The attributes of the Flsa Domain Users global group are:

Member of: Local group "Flsa Users" and local group Server Operators.
Server Operators is needed to allow access to shares.

User accounts
The following default user accounts are created when SDR-NT is installed:
FlsaServer
The FlsaServer account is used for SDR COM servers, which run in the
FlsaServer security context. The attributes of the FlsaServer account are:

W2K workgroup: Member of: "Flsa Users", Power Users and Users.
Power Users is needed to allow access to shares.

W2K domain: Member of: "Flsa Domain Users" and Domain Users.

Password: Hard coded by SDR-NT installation program to 918273645".

Rights: Log on as batch job. Log on as service.

Flags: UF_SCRIPT,UF_PASSWD_NOTREQD, UF_PASSWD_CANT_CHANGE,


UF_DONT_EXPIRE_PASSWD, UF_NORMAL_ACCOUNT.
FlsaMain
The FlsaMain account (main for maintenance) is used by the SDR-NT manager to perform
SDR maintenance functions.
The attributes of the FlsaMain account are:
W2K workgroup: Member of: "Flsa Users", "Flsa Administrators" and "Administrators".

2 SDR W2K Security

Reference Manual SDR W2K Security

W2K domain: Member of: "Flsa Domain Users", Flsa Domain Admins, "Domain
Users" and Domain Admins.
Password: User given at SDR W2K installation, but defaulted to password.
Rights: No special rights.
Flags: UF_SCRIPT, UF_DONT_EXPIRE_PASSWD, UF_NORMAL_ACCOUNT.
Profile type: Can be roaming if domain account. Profile path =
"%LOGONSERVER%\NETLOGON\FlsaMain".

Flsa
The Flsa account is the default user account created during SDR W2K installation, and the
template to create other user accounts.
The attributes of the Flsa account are:

W2K workgroup: Member of: "Flsa Users", Power Users and Users.. Power Users
is needed to allow access to shares.

W2K domain: Member of: "Flsa Domain Users" and Domain Users.
Password: SDR installation sets to blank.
Rights: Domain member accounts needs the right "Log on locally" to log on at the
Active Directory.
Flags: UF_SCRIPT,UF_PASSWD_NOTREQD, UF_PASSWD_CANT_CHANGE,
UF_DONT_EXPIRE_PASSWD, UF_NORMAL_ACCOUNT.
Profile type: Can be roaming if domain account. Profile path =
"%LOGONSERVER%\NETLOGON\Flsa".

Reference Manual SDR W2K Security

SDR W2K Security 3

SDR W2K user account creation


The steps for creating a SDR W2K user account are described in detail below.
There are two scenarios when creating user accounts, one for a domain
environment and one for a workgroup environment.
Creating a new workgroup account.
Normally the procedure must be repeated for each client PC (DOP) that the user
must access, as well as each server PC (MOP).
With the Users and Passwords do the following:

The
Users and Passwords
can be found in Start
menu, Settings Control
Panel.

Login as Administrator.

Invoke the User Manager.

Add a new user. (In W2K workgroup you cant copy a user)

Include the new user in the following groups: FlsaUsers, Power Users
and Users.

Do not change the default rights.

Repeat this procedure for each client PC (DOPs) that the user must access,
as well as each server PC (MOP).

Creating a new domain account.


With the Active Directory Users and Computers do the following:

The
Active
Directory
Users and Computers
can be found in Start
menu,
Programs,
Administrative Tools.

Login as Administrator.

Invoke the Active Directory Users and Computers.

Right click User and select New/User.

Or expand Users and right-click a user and select Copy.

Include the new user in the following groups: Flsa Domain Users and
Domain Users.

Do not change the default rights.

Tailoring the new account's ECS Start Menu..


The administrator should log into the new account.
The ECS NTech start menu is automatically created at first login. If not, or if
it has been deleted, a copy of the start menu is found in flsadev\profiles\Start
menu.
Use Start/Settings/Taskbar to customise the default ECS NTech start menu.
Logoff.
Using the Policy editor (described in next section) to customise the
new accounts desktop.
Login as administrator.
Invoke the Policy Editor. The Policy Editor is described latter.
Logoff
The new account is now ready for use. Remember to repeat the procedures for
each client PC (DOP) that the user need to access, as well as each server PC
(MOP).

4 SDR W2K Security

Reference Manual SDR W2K Security

W2K policy editor


The W2K Policy editor can be used to tailor the W2K desktop in a workgroup
installation. For example it can be configured so that a user account is denied
access to the Run dialog in the Start menu, or to the Control Panel. This
section will describe the procedures setting users policies, and setting locally
based system policies.

Setting up user policies


To enable Locally Based system policies on a Windows 2000 professional or
standalone server refer to Appendix A.
Use the Windows 2000 policy editor to create user policies.
Start the Policy
Editor by typing poledit.exe at
Run

If poledit is not installed, run the ADMINPAK.MSI found in


\FLSADev\ToolsNT\SvrTools
If first time select, New policy.
Note! Be careful when editing Default Computer or Default Users.
You might get a situation where you cannot enter with administrative rights.
To enter a policy for a user, click on add user and add the user in question.
Note! Group policies do not work for local groups.
After the user has been added, the properties for the user can be set. Double click
on the user to get the Properties window.

Figure 1. Windows 2000 Policy Editor, Poledit.exe, here shown is Default Computer and
Default Users.

Once the properties window appears, the Policies tab with an expandable list
becomes available. This list contains different desktop control mechanisms. By
expanding the structure, desktop control restriction selection boxes will appear.
For example, by expanding Control Panel, Display, there is a Restrict display
box, selecting this box will prevent the Control Panel from displaying.
Some policies have detailed restrictions; these policies can have specific
restrictions, which the administrator can choose from in the lower list. For
example, the Control Panel, Display, Restrict display can have selective
restrictions concern the display of different tabs.
After you have edited the policies, save your policy to:
Winnt\sysvol\Scripts\Ntconfig.pol.
The following pictures show an example of an flsa user setup.

Reference Manual SDR W2K Security

SDR W2K Security 5

Control panel, Display


Do not display the control panel.

Figure 2. Properties window for the flsa user, in this figure we have configured the policy such that
the flsa user will have no access to the Control Panel.

Desktop
The user can select wallpaper and Color scheme.

Figure 3. Properties window for user flsa, controlling desktop properties such as Wallpaper and
Color scheme.

6 SDR W2K Security

Reference Manual SDR W2K Security

Shell, Restrictions
Remove Run command from Start menu, prevents the user from running
programs directly.
Remove folders from Settings on Start menu, prevents the user from access to
printer configuration.
Remove Taskbar from settings menu, prevents the user from changing the
taskbar layout and from changing the Start Menu Programs setting.
Remove Find command from Start menu, prevent the user from finding and
running programs.
Hide drives in My computer, prevents the user from accessing drives.
Hide Network Neighbourhood, prevents the user from accessing the network
neighbourhood.
No entire Network in Network neighbourhood prevents the user from browsing
the network neighbourhood.
No workgroup contents in Network Neighbourhood, prevents the user from
browsing the workgroup.
Hide all items on the desktop, prevents the user access to desktop icons.
Disable Shut Down command, prevents the user from shutting down the
computer.
Don't save settings at exit, changes made by the user will not be saved at exit.

Figure 4. In this figure, more restrictions can be applied to the Start menu, and etc

Reference Manual SDR W2K Security

SDR W2K Security 7

System, Restrictions
Disable Registry editing tools, prevents the user from altering the contents of the registry.
Run only allowed Windows applications, prevents the user from running any programs
other than allowed. Note if this entry is selected the program Systray.exe must be
included or the user will get an error at logon.

Figure 5. Access to applications can also be controlled as seen in this figure. Use the Show
button to see a list of allowed applications as seen in the figure 6.

Windows NT Shell, user interface


The user interface can be defined.

Windows NT Shell, Custom folders


The user access to folders and content of folders can be defined here.

8 SDR W2K Security

Reference Manual SDR W2K Security

Windows NT Shell, Restrictions


Only use approved shell extensions, prevents user from use of other shell
extensions than defined.
Remove File menu from explorer, prevents the user from use of the file menu in
the explorer.
Remove common program groups from Start menu, prevents the user from
access to the common program group in the Start menu.
Disable context menus from the taskbar, prevents the user from access to the
taskbar context menu.
Disable Explorer's default context menu, prevents the user from access to
explorer's default context menu.
Remove the "Map Network Drive" and "Disconnect Network Drive", prevents
the user from mapping and disconnecting network drives.
Disable link files tracking, prevents links to files from being tracked.

Figure 7. Windows NT Shell, Restrictions for flsa user, some restriction selection boxes
are filled, e.g. Only use approved shell extensions, this indicate that there is partial
restriction, select the restriction to see more details in the lower list.

Reference Manual SDR W2K Security

SDR W2K Security 9

Windows NT System
Parse Autoexec.bat, environments parameters from autoexec.bat to be included.
Run logon scripts synchronously, wait for logon script to complete before starting the
shell.
Disable Task Manager prevents the user from access to the task manager.
Show welcome tips at logon, the user will get welcome tips at logon.

Figure 8. Restrictions of the Windows NT System for the flsa user.

10 SDR W2K Security

Reference Manual SDR W2K Security

Special user restrictions

Change the system time


To restrict users from changing the system time open the Local Security Settings /Local Policies/
User Rights Assignment and remove the right "Change the system time" from the group where the
user is member.
For restricting "Flsa" users remove the right "Change the system time" from the group "Power
Users" where "Flsa" users are members.

Program groups
To remove programs from the users programs folder, edit the "Programs" folder for the user in
question.
Use the explorer and in the folder "Document and settings\flsa\Start Menu\Programs\" remove
unwanted programs, substitute "flsa" with the user in question.

Active Directory
Introduction
In a domain installation all user rights and security settings are managed through
the Active Directory Users and Computers. During installation several groups
and users are added to the active directory. These users and groups are default
located at Users in Active Directory Users and Computers. If you want to assign
special rights or restrictions to a user or a group you create an Organizational
Unit (OU) and assign it a specific Group policy. Then you move the user to the
new OU and the user will inherit the group policy from the OU.
1.

Open the Active Directory Users and Computers

2.

Right click the domain and select new/Organizational Unit

3.

Type a name for the new OU, e.g. Operators

4.

Right click the new OU and select Properties

5.

Click the Group Policy tab.

Reference Manual SDR W2K Security

SDR W2K Security 11

6.

Click New and type a name for the new group policy, e.g. Operator

7.

Select the new policy and click Edit

8.

Make the changes to the policy you want and close the Group Policy and the
Properties window.

9.

In Users right click the user you want to assign the new policy and click
Move

10. Select the newly created OU and click Ok.


11. The user will now inherit the Group Policy from the OU.

Example 1.
How to remove all icons from a users desktop.

12 SDR W2K Security

Reference Manual SDR W2K Security

1.

Select Properties/Group Policy/Edit for the OU, which contains the user for
who you want to remove all the icons on the desktop.

2.

Expand User Configuration/Administrative Templates and select Desktop.

3.

Right click Hide all icons on Desktop and click Properties.

4.

Click Enabled and Ok.

Example 2.
How to remove the Run command from a users start menu.
1.

Select Properties/Group Policy/Edit for the OU, which contains the user for
who you want to remove all programs in the start menu.

2.

Expand User Configuration/Administrative Templates and select Start Menu


& Taskbar.

3.

Right click Remove Run menu from Start menu.

4.

Click Enabled and Ok.

Reference Manual SDR W2K Security

SDR W2K Security 13

Appendix A

Set up locally-based system policies


To enable Locally Based system policies on a Windows 2000 professional or standalone
server (not a domain controller), follow the following procedure:
1.

Create a folder winnt\sysvol\script and share it as NETLOGON with permissions


everyone read and administrator full access.

2.

Open System Policy Editor (poledit.exe)

3.

On the File menu click New Policy

4.

On the Edit menu click New User

5.

Click Browse to select a user to add.

6.

Double-click the new user and make the changes you want.

7.

Save the policy in the folder created earlier ( winnt\sysvol\script )

8.

On the File menu click Open Registry

9.

Double-click Local Computer, double-click Network, double-click System Policies


Update, and then click Remote Update so that it is selected. (Checkmark)

10. In the Update Mode box, click Manual (Use Specific Path).
11. In the Path for manual update box type the path to the shared directory where you
saved the policy file, \\computername\netlogon\Ntconfig.pol

TIP: Every person or computer that logs on after a policy is in place is subject to
the policy. Therefore, it is a good idea to not edit the default user or computer
until you are familiar with System Policies. A good idea to use is to make a test
user/group account in "Users and Passwords" and then make a specific policy for
this user/group in System Policy Editor. After you have the policy working
properly you can then transfer the policy to the production environment.
You can save the policy file to a netlogon share on a SDR server and type the
path in registry settings for the local computer. In this way you only have to
make one policy file for more than one computer.

Reference Manual SDR W2K Security

Appendix A 15

Reference Manual SDR W2K Security

Appendix A 17

Reference Manual

ECS/SDR Installation

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 8
$Modtime:: 12/03/01 12:43p
Mus
$Author:: Mle
$Workfile:: SdrW2KInstallation30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS/SDR Installation................................................................................. 3
Introduction ................................................................................................................................... 3
Hardware Requirements ........................................................................................................ 3
Installation Preparation.......................................................................................................... 3
Installation Procedure ................................................................................................................... 4
Installation from CD-ROM ................................................................................................... 4
Installation from FLSA Dev Support Web ........................................................................... 4
ECS/SDR Customization.............................................................................................................. 7
Display Settings ..................................................................................................................... 7
Power Options ....................................................................................................................... 8
Server Setting......................................................................................................................... 9
Domain Setup.............................................................................................................................. 10
Netlogon Share on DC (Domain Controller) ...................................................................... 10
Policy ................................................................................................................................... 10
User Roaming Profiles................................................................................................................ 10
Activation of Roaming Profiles........................................................................................... 10
ECS/SDR Un-Install ................................................................................................................... 13
Un-Install Procedure............................................................................................................ 13

ECS/SDR Installation

Introduction
This help document describes the procedure used to install the ECS/SDR process
system software.

Hardware Requirements
The host system must meet or exceed the following requirements:
Computer Personal Computer must be member of the Microsoft Windows
2000 HW Compatibility List.
Memory Minimum 128 MB RAM for a professional and 256 MB RAM for a
server
Disk Space Minimum 6 GB for a professional and 8 GB for a server.
Display Resolution 1280 x 1024 pixels or better, minimum 32768 colors.
Operating System Microsoft Windows 2000. The following operating
system variants are supported:

Professional

Server

Domain Controller

Application Software No additional software is required.

Installation Preparation
Before the ECS/SDR installation is started, verify the following:
1.

Networked host system must have correct network settings. It is


important to ensure that a networked host has been given a computer
name that is unique within the associated workgroup.

2.

Any previous ECS/SDR installation has been properly un-installed.

3.

If installing the ECS/SDR system in a Domain environment, the


Domain Controller must be installed and configured.

Reference Manual ECS/SDR Installation

ECS/SDR Installation 3

Installation Procedure
An ECS/SDR system can be installed either from a CD-ROM supplied by FLS
Automation A/S or from a file obtained through the FLSA Dev Support Web.
The installation procedure for either source is provided below.
Please observe that an ECS/SDR system is a licensed product. The
software cannot execute in a Server (MOP) configuration without
the installation of a hardware dongle and a license file. FLS
Automation A/S supplies these items. The license file can be added
either during the installation of the ECS/SDR system or after the
installation has completed.

Installation from CD-ROM


1.

Logon to the host system as Administrator.

2.

Insert a CD-ROM with the ESC system and wait for the installation program
to auto start. If the auto start fails, open the Explorer and display the
contents of the CD-ROM root directory. Double-click the Setup.exe file to
start the installation program.

3.

Follow the instructions presented by the installation program. In particular,


be aware of the following topics:

A license is only needed when the system will be configured as a


Server.

When the Sentinel Driver Installation starts choose default and Next.
Remember to remove the dongle during installation.

In the Enter Account Name window, do not modify the default user
name - flsa.

When the View log file option is offered, make a careful examination of
the installation log to identify any errors. (This file will also be
available after the installation).

Accept the option: Yes, I want to restart my computer now when


posted by the installation program. Upon request, logon as user
FlsaMain.

When the installation program completes successfully, the ECS/SDR system


starts up in the Maintenance mode ready for configuration.

Installation from FLSA Dev Support Web

4 ECS/SDR Installation

1.

Logon to the host system as Administrator.

2.

Open an Internet Explorer and connect to the FLSA Dev Support Web:
http://www.flsadev.dk. Find the desired version of the ECS/SDR system and
follow the instructions on how to download the corresponding selfextracting exe file. Wait for the download to complete.

Reference Manual ECS/SDR Installation

3.

When the download has completed the ECS NTech Release Installation
window is displayed automatically, if you had selected Open. If you had
selected Save as you must double click on the file to get the Unzip dialog.

Accept the proposed temporary folder in which the system files will be
unzipped or add a subfolder with the same name as the system to be
installed. If the folder defined already exists, delete its contents. Enable the
Overwrite Files Without Prompting and when Done Unzipping Run:
.\setup\setup.exe check boxes.
4.

Click on the Unzip button and wait for the unzip operation to complete.
When the completion message is acknowledged the installation program
will start automatically if the When Done Unzipping Run checkbox is
enabled. Otherwise, the installation program must be started manually by
opening the Explorer and double clicking on the Setup.exe file in the
temporary folder.

5.

Follow the instructions generated by the installation program. In particular,


be aware of the following topics:

A license is only needed when the system will be configured as a


Server.

When the Sentinel Driver Installation starts choose default and Next.
Remember to remove the dongle during installation.

In the Enter Account Name window, do not modify the default user
name - flsa.

When the View log file option is offered, make a careful examination of
the installation log to identify any errors. (This file will also be
available after the installation).

Accept the option: Yes, I want to restart my computer now when


posted by the installation program. Upon request, logon as user
FlsaMain .

When the installation program completes successfully, the ECS/SDR system


starts up in the Maintenance mode ready for configuration.

Reference Manual ECS/SDR Installation

ECS/SDR Installation 5

ECS/SDR Customization
After a successful installation, the system needs to be customized for proper
performance.

Display Settings
In order to operate the ECS/SDR system successfully the following display
settings should be made.
1.

Open the Display Properties window by right clicking on the desktop and
selecting Properties from the menu displayed.

2.

Select the Settings tab.

3.

Set the Screen Area to 1280 by 1024 pixels and the Color Palette to 32768
Colors or greater.

4.

Click Advanced and the Monitor tab. Set Refresh Frequency to the
highest value for the actual Desktop Area setting. Reduce this value if the
screen tilts or appears in reduced size.

5.

Select the Effects! tab.

Reference Manual ECS/SDR Installation

ECS/SDR Installation 7

6.

Disable the Show window contents while dragging option.

Power Options

8 ECS/SDR Installation

1.

Open the Display Properties window by right clicking on the desktop and
selecting Properties from the menu displayed.

2.

Select the Screen Saver tab.

3.

Click the Power button.

4.

Select the Power Schemes tab.

5.

Under Power schemes select Presentation.

Reference Manual ECS/SDR Installation

Server Setting
In order to operate the ECS/SDR system successfully the following server
settings must be made.
1.

Right click My Network Places on the desktop and select Properties.

2.

Right click Local Area Connection and select Properties.

3.

Select File and Printer Sharing for Microsoft Networks and click
Properties

4.

In Server Optimization: set Maximize data throughput for network


applications

5.

Click OK and Yes to restart your computer now.

Reference Manual ECS/SDR Installation

ECS/SDR Installation 9

Domain Setup
Due to the complexity of installing, configuring and maintaining a
Windows 2000 Domain we highly recommend to use a Workgroup
installation for a ECS/SDR system instead of a Domain installation.
In a dual ECS/SDR system installed as a Domain you must configure both
the servers as Domain Controllers and for a truly redundant system both
servers must host a DNS server.

Netlogon Share on DC (Domain Controller)


For installing and configuring
W2KInstallation30_English.doc

Windows

2000

domain,

refer

to

The domain users use the Netlogon share when they are validated in the domain.
The netlogon share contains the policy files and the roaming profiles.
The Netlogon share replicates among all domain controllers:
C:\winnt\sysvol\sysvol\ "domainname"\scripts
In a Windows 2000 domain you don't have to configure the replication, this is
done automatically by Windows 2000.

Policy
To assign policies to the user and system, refer to the online help document for
SDR W2K Security.

User Roaming Profiles


Roaming profiles can be used both in a workgroup or domain installation. If the
roaming profile is not available at login W2K gives a warning and uses the local
profile instead. When you log out from a roaming profile, W2K saves the profile
both as a roaming profile and a local profile.
Flsa roaming profiles are located in the c:\FlsaDev\Profiles folder on the
ECS/SDR Server. In order to use these profiles you must share this directory as
FlsaProfiles. Set the permissions to Everyone read and Administrator to full
control. In this manner users are not able to save changes to their profile when
they log out.

Activation of Roaming Profiles


Workgroup
To activate roaming profiles for a user open My Computer, System Tools,
Local Users and Groups. Double-click the user, select the profile tab and enter
the profile path.
Path : \\<Server Name>\FlsaProfiles\%USERNAME%
Click OK to accept the changes and then close the Local Users and Groups.

10 ECS/SDR Installation

Reference Manual ECS/SDR Installation

Domain
In a domain you open the Active Directory Users and Computers. Doubleclick the user, select the profile tab and enter the profile path.

Reference Manual ECS/SDR Installation

ECS/SDR Installation 11

If you want the roaming profiles to be replicated among the domain controllers
you have to copy the profiles to the Netlogon share on the domain controllers.
Right click My computer and select Properties. Select the User Profiles tab
and click the user you want to copy. Click Copy to and enter the path to the
NETLOGON share. In the profiles tab for the user you have to type the new
path to where the profile is located.

12 ECS/SDR Installation

Reference Manual ECS/SDR Installation

ECS/SDR Un-Install
This section describes the procedure used to remove an existing ECS/SDR
installation from a host system.

Un-Install Procedure
It will be necessary to have Administrator privileges before performing the
following procedure.
1.

From the Maintenance utility, restart the computer in maintenance mode.


When the logon prompt appears, log on as FlsaMain.

2.

From the Maintenance window, select the Backup tab, enable all data sets
listed and make a backup to the backup folder. Examine the backup log to
ensure that the backup process completed successfully. This action only
applies to a Server system.

3.

From Computer Management start the Services utility. Select the SDR
Starter (System) service and click on Stop.

4.

Open the Windows NT Task Manager utility and click on the Processes
tab. Locate and select SdrWatchDogUi30. Click on the End Process
command.

5.

From the Explorer, open the \FLSADev\Bin\Sys folder and double-click


on the PtaReg30.exe file. Type DevUnReg SDR at the PtaReg> prompt
and press the keyboard <Enter> key. This will unregister all SDR services.

6.

From the Start menu, select Run.... Type RegEdit in the Open field and
press OK. This will start the Registry Editor. Select the
HKEY_LOCAL_MACHINE\SOFTWARE\FLS Automation A/S entry
and delete it.

7.

Rename the \FLSADevBackup folder to (For example:C:\ECSBackUp).


This action only applies to a Server system where data has been backed up
as described in step 2.

8.

Copy the license file located in ...\FLSADev\Bin\License to a temporary


location (For example: C:\ECSBackUp). This action only applies to a
Server system where the license file will be used in the new ECS/SDR
installation.

9.

Logon as Administrator.

10. Delete the following folders: ...\FLSADev and ...\FLSALog


11. From Computer Management start the Local Users and Groups. Expand
Users and delete the Flsa, FlsaMain and FlsaServer users. Expand Groups
and delete the Flsa Administrators and Flsa Users groups.
12. Open c:\Document and Settings and delete the Flsa, FlsaMain and
FlsaServer folders.
13. Delete the following files, if present:
...\Document and Settings\ Administrator\Local Settings\ Temp\
SdrRegisterErr.txt
...\...\Document
and
Settings\
Settings\Temp\SdrRegisterOut.txt

Reference Manual ECS/SDR Installation

Administrator\Local

ECS/SDR Installation 13

Reference Manual ECS/SDR Installation

ECS/SDR Installation 15

Reference Manual

Starting the SDR System

FLS Automation A/S


Hffdingsvej 77
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 2
$Modtime:: 6/06/01 3:25p
hct
$Author:: Ngb
$Workfile:: StartingSDR30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
Starting the SDR System ..............................Error! Bookmark not defined.
Introduction .................................................................................Error! Bookmark not defined.
Startup Mode........................................................................Error! Bookmark not defined.
Starting in the SDR Maintenance Mode.....................................Error! Bookmark not defined.
Starting in the SDR Run Mode...................................................Error! Bookmark not defined.
SDR Current Mode .....................................................................Error! Bookmark not defined.
SDR System Login .....................................................................Error! Bookmark not defined.
Current User.........................................................................Error! Bookmark not defined.
Changing Your Password ....................................................Error! Bookmark not defined.

Glossary of Terms .........................................Error! Bookmark not defined.


Index................................................................Error! Bookmark not defined.

Starting the SDR system

Contents i

Starting the SDR System

Introduction
This manual describes the procedure used to startup and log into the SDR system
at an ECS workstation.
When multiple SDR workstations are connected to the network, Servers (MOPs)
must be started before Clients (DOPs). This is due to the fact that a Client
obtains process information from a designated Server.

Startup Mode
When a workstation is booted, the SDR system is initialized to the SDR
Maintenance mode or the SDR Run mode. The startup mode is determined by
the status of internal startup flags. These flags are set or reset by the SDR
Maintenance utility.
If the startup flags are set for the run mode, the SDR applications and services
are automatically started after the boot sequence is completed. By the time the
logon prompt appears the SDR system is collecting data from the process
interface. The run mode is the normal operating mode.
If the startup flags are set for the maintenance mode, the NT operating system
completes a normal boot sequence, but the SDR applications and services are not
started. The maintenance mode is used to perform system functions that can not
be initiated while the SDR system is running.
The functions performed in the maintenance mode include:
Data Synchronization between Servers and other FLSA subsystems (CEM,
Fuzzy, QCX, etc.)
Backup graphic, log, and database files to disk or tape.
Restore graphic, log, and database files from disk or tape.
SDR License keys assignments.
SDR System Configuration, which includes System and Factory name
assignments, database backup period assignment, SDR Language
configuration, and Point database size configuration.

Doc-To-Help Standard Manual

Starting the SDR System 1

Starting in the SDR Maintenance Mode


While in the SDR Run mode, locate and select SDR Maintenance from the
desktop Start menu.

After the Maintenance mode utility starts select the Shutdown tab and choose
the desired Maintenance Mode option.
Restart the computer in maintenance mode The SDR and NT systems
shut down and a reboot to the maintenance mode is initiated. When the logon
prompt appears, log into the FlsaMain account. Refer to System Login. The
maintenance utility starts and the Maintenance display appears.
Shut down the computer for maintenance mode The SDR and NT
systems shut down. After the shutdown is executed, power can be removed from
the system. After power is restored, a reboot to the maintenance mode is
initiated. When the logon prompt appears, log into the FlsaMain account.
(Refer to System Login). The maintenance utility starts and the Maintenance
display appears.
After choosing the maintenance mode option, click on the OK command.

2 Starting the SDR System

Doc-To-Help Standard Manual

Starting in the SDR Run Mode


While in the SDR Maintenance mode, locate and select SDR Maintenance
from the desktop Start menu.

After the Maintenance mode utility starts, select the Shutdown tab and choose
the desired Run Mode option.
Restart the computer in run mode The SDR and NT systems shut down
and a reboot to the run mode is initiated. When the logon prompt appears, log
into the flsa account. Refer to System Login.
Shut down the computer for run mode The SDR and NT systems shut
down. After the shutdown is executed, power can be removed from the system.
After power is restored, a reboot to the run mode is initiated. When the logon
prompt appears, log into the flsa account. Refer to System Login.
After choosing the run mode option, click on the OK command.

Doc-To-Help Standard Manual

Starting the SDR System 3

SDR Current Mode


To determine the current SDR mode, locate and select SDR Maintenance
from the desktop Start menu.

After the Maintenance window appears, select the Shutdown tab. The
Current mode field indicates the SDR mode: Run or Maintenance.

SDR System Login


To log into the SDR system, simultaneously press the keyboard <Ctrl>, <Alt>
and <Delete> keys at the logon message prompt.
The default user account is
flsa - no password is
required.

When the login window appears, enter your assigned User name and Password.
Complete the login process by moving the mouse pointer to the OK command and
pressing the left mouse button.

Current User
To determine the user currently logged into a workstation, simultaneously press
the keyboard <Ctrl>, <Alt> and <Delete> keys. A Windows NT Security
window appears and displays the user currently logged into the workstation and
the login time and date.

Changing Your Password


Do not change the password associated to the FLSASERVER account. The
system will not function properly.

4 Starting the SDR System

Doc-To-Help Standard Manual

Doc-To-Help Standard Manual

Starting the SDR System 5

Glossary of Terms

ECS
Expert Control System. A term denoting an FLS Automation A/S supplied
application comprising the SDR system enhanced with one ore more dedicated
(intelligent) software systems.

Partner Configuration
An installation consists of at least one Server. If there are any Client(s) included
in the installation, each Client has a Server partner. In the case of a dual system
two Servers have each other as partners.

SDR
Software Development and Runtime system. This term is a synonym for the
basic system delivered by FLS Automation A/S. Using the SDR as a foundation
various FLS Automation A/S supplied software components can be installed

Doc-To-Help Standard Manual

Glossary of Terms 7

Doc-To-Help Standard Manual

Reference Manual

ECS/SDR Maintenance

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 9
$Modtime:: 12/14/01 1:53p

$
$

$Author:: Mle
$Workfile:: SDRMaintenanceUI30_English.doc
0-1000

$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS/SDR Maintenance .............................................................................. 1
Introduction ................................................................................................................................... 1
ECS/SDR System Modes.............................................................................................................. 1
Run Mode .............................................................................................................................. 1
Maintenance Mode ................................................................................................................ 2
Current Mode......................................................................................................................... 4
Data Synchronization.................................................................................................................... 5
Data Synchronization Procedure........................................................................................... 5
Backup Operation ......................................................................................................................... 6
Backup Procedure.................................................................................................................. 6
Restore Operation ......................................................................................................................... 8
Restore Restrictions............................................................................................................... 8
Restore Procedure.................................................................................................................. 8
SDR Licensing ............................................................................................................................ 10
Personalized Settings .................................................................................................................. 11

Glossary of Terms ................................................................................... 13


Index.......................................................................................................... 15

Reference Manual ECS/SDR Maintenance

Contents i

ECS/SDR Maintenance

Introduction
The ECS/SDR Maintenance manual describes the Maintenance utility and the details
associated with the Maintenance mode. The information is provided in the following
sections:

System Modes

Data Synchronization

Backup Operation

Restore Operation

Licensing

Per user settings is described in the follwing section:

Personalized Settings

The Maintenance utility can also be used to shutdown the ECS workstation in an
orderly manner.

ECS/SDR System Modes


The ECS/SDR system operates in either a maintenance mode or a run mode. The
run mode defines the ECS/SDR system state when all applications responsible for data
collection, logging , and processing are started and operational.
The maintenance mode defines the ECS/SDR system state prior to application
initialization. The maintenance mode is used to perform system functions that can not
be executed while the ECS/SDR system is running.

Run Mode
When the Windows 2000 workstation is booted, the ECS/SDR system is automatically
started. All applications required to collect, log, and process application data are
operational at about the same time the Begin Logon window appears. This is the
normal operating mode.

Reference Manual ECS/SDR Maintenance

ECS/SDR Maintenance 1

Maintenance Mode
When the ECS/SDR system is booted to the maintenance mode, the ECS/SDR system
is not started. The ECS/SDR system automatically enters the maintenance mode
immediately after the ECS/SDR-NT software is installed. This enables the user to
assign system parameters and perform system functions prior to booting to the run
mode for the first time.
At all other times, the maintenance mode must be requested while in the ECS/SDR run
mode. When the maintenance mode is requested, the workstation is configured to
restart in the maintenance mode the next time it is booted.
After the system is booted to the maintenance mode, the user must then log into the
maintenance mode account (FlsaMain) or the FLSA administrator account
(FLSAAdmin) to perform maintenance functions.
The functions performed in the maintenance mode include:
Data Synchronization between dual Servers.
Backup graphic, log, and database files to disk or tape.
Restore graphic, log, and database files from disk or tape.
SDR License keys assignments. (Future)
SDR System Configuration which includes System and Factory name
assignments, database backup period assignment, ECS/SDR Language
configuration, and Point database size configuration.

Booting to the Maintenance Mode


1.

While in the ECS/SDR Run mode, locate and select Maintenance from the
desktop Start menu.

2.

After the Maintenance mode utility starts, select the Shutdown tab and
choose the desired Maintenance Mode option.
Restart the computer in maintenance mode The ECS/SDR and
Windows 2000 systems shut down and a reboot to the maintenance mode is

2 ECS/SDR Maintenance

Reference Manual ECS/SDR Maintenance

initiated. When the logon prompt appears, log into the FlsaMain account.
The maintenance utility starts and the Maintenance display appears.
Shut down the computer for maintenance mode The ECS/SDR and
Windows 2000 systems shut down. After the shutdown is executed, power can
be removed from the system. After power is restored, a reboot to the
maintenance mode is initiated. When the logon prompt appears, log into the
FlsaMain account. The maintenance utility starts and the Maintenance
display appears.
3.

After choosing the maintenance mode option, click on the OK command.

Booting to the ECS/SDR Run Mode


1.

While in the Maintenance mode, locate and select Maintenance from the desktop
Start menu.

2.

After the Maintenance mode utility starts, select the Shutdown tab and
choose the desired Run Mode option.
Restart the computer in run mode The ECS/SDR and Windows 2000
systems shut down and a reboot to the run mode is initiated. When the logon
prompt appears, log into the flsa account.
Shut down the computer for run mode The ECS/SDR and Windows
2000 systems shut down. After the shutdown is executed, power can be
removed from the system. After power is restored, a reboot to the run mode is
initiated. When the logon prompt appears, log into the flsa account.

3.

Reference Manual ECS/SDR Maintenance

After choosing the run mode option, click on the OK command.

ECS/SDR Maintenance 3

Current Mode
To determine the current ECS/SDR mode, locate and select Maintenance from the
desktop Start menu.

After the Maintenance window appears, select the Shutdown tab. The Current
mode field indicates the ECS/SDR mode: Run or Maintenance.

4 ECS/SDR Maintenance

Reference Manual ECS/SDR Maintenance

Data Synchronization
In dual Server system configurations, data synchronization normally occurs
automatically. However, if one of the Server partners is down for any period of time,
data must be synchronized manually. This data synchronization is performed in the
Maintenance mode.
Please note that large data synchronizations on non SCSI disk systems can impede the
performance of the computer system. This can for example happen when log files are
synchronized.

Data Synchronization Procedure


When a dual Server is down for any period of time, it must be synchronized with its
Server partner before being placed in ECS/SDR Run mode.
1.

Restart the Server. This automatically starts the Server in ECS/SDR Run mode.

2.

Restart the Server in Maintenance mode. Refer to Maintenance Mode.

3.

After the Maintenance window appears, select the Data synchronization tab.

4.

Select the items to synchronize by clicking on the Enabled checkbox. The


Description column identifies the type of data to synchronize. The Subsystem
column identifies the subsystem to which the data is associated (ECS/SDR, CEM,
Fuzzy, etc.).

5.

Click on the Run command. The items with a check in the Enabled field are
synchronized with the Server partner.

Reference Manual ECS/SDR Maintenance

ECS/SDR Maintenance 5

6.

A window appears to indicate the completion of the data synchronization. Click on


the Close command to return to the Maintenance display. Click on the View Log
command to review any messages that were generated during the synchronization.

Backup Operation
This section describes the procedure used to backup ECS/SDR system files to disk or
tape. The backup procedure can be performed in the Run or Maintenance mode.
Please note that large backups on non SCSI disk systems can impede the performance
of the computer system. This can for example happen when log files are backed up.

Backup Procedure

6 ECS/SDR Maintenance

1.

Locate and select Maintenance from the desktop Start menu.

2.

When the Maintenance window appears, select the Backup tab.

Reference Manual ECS/SDR Maintenance

3.

Select each item to backup to the backup directory by clicking on its Enabled
checkbox. The Description column identifies the file. The Subsystem column
identifies the subsystem to which the file is associated (ECS/SDR, CEM, Fuzzy,
etc.).

4.

Opstation picture files are all files stored in gmspc\ops. Log files are trend an
statistical logs. These files can be very large, and can present problems for some
PC configurations. ProDb files are very important. The Prodb folder contains the
very important point configuration and other configuration data. The Nlsdb files
contain static data files that are not updated by the system unless ECS/SDR service
packs or hotfixes are applied. The Nlsdb folder mostly contains language
translation data base files.

5.

Select the type of backup to be performed:


Backup to backup folder Saves the files whose Enabled field is checked to
the backup directory, FlsaDevBackup.
Backup to tape from backup folder Copies the files from the backup
directory, FlsaDevBackup, to tape using the standard Windows 2000 tape backup
program.
A backup from the system to tape must be performed in two steps:
- Backup from system to the backup folder
- Backup from the backup folder to the tape unit

6.

Click on the OK command to start the backup process. A window appears and
indicates the progress of the backup operation.

Reference Manual ECS/SDR Maintenance

ECS/SDR Maintenance 7

Restore Operation
This section describes the procedure used to restore ECS/SDR system files. A restore
operation consists of two steps:

Restore from tape to the backup folder (Can be performed in the Run or
Maintenance mode).

Restore from the backup folder to the system files (Must be performed in
the Maintenance mode)

Please note that large restores on non SCSI disk systems can impede the performance
of the computer system. This can for example happen when log files are restored.

Restore Restrictions
The Maintenance program relies upon the existence of the database files
SdrSystem30.mdb (ProDb) and SdrMaintenanceUI30.mdb, Install_SDRCommon.mdb,
Install_SDRServer.mdb (NlsDB). Restoring of NlsDB files will thus result in errors
being reported in the log file. Restoring of ProDb files might result in a different
subsystem layout for the next invocation of the Maintenance program.
In order to make a full restore of the NlsDB and ProDb directories the database files
must be copied from the proper subdirectories under FLSADevBackup to the proper
directories under FLSADev using the Windows Explorer program.
Note: Restoring files from tape to disk folders will result in the following errror
message: Unable to set NT compression state for <directory>. There will be one
error message for each directory being restored. These messages can safely be ignored.

Restore Procedure

8 ECS/SDR Maintenance

1.

If a restore from the backup folder to the system is to be performed, verify that the
system is in the Maintenance mode. Refer to SDR Current Mode. Change to the
Maintenance mode if necessary. Refer to Booting to the Maintenance Mode.

2.

Locate and select Maintenance from the desktop Start menu.

3.

When the Maintenance window appears, select the Restore tab.

Reference Manual ECS/SDR Maintenance

4.

Select each item to be restored from tape to the backup folder by clicking on its
Enabled checkbox. The Description column identifies the file. The
Subsystem column identifies the subsystem to which the file is associated
(ECS/SDR, CEM, Fuzzy, etc.).

5.

Select the type of restore to be performed and click on the OK command.


Restore backup folder to destination Copies the files in the backup folder to
the system files. The system must be in the Maintenance mode to use
this option.
Restore tape to backup folder Copies the files from the tape to the backup
directory, FlsaDevBackup. This option can be used in either mode - Maintenance
mode or ECS/SDR Run mode. In Run mode the Restore tab appears as follows.

6.

After the OK command is issued, locate and select the backup folder. Click on the
Restore command. A window appears and indicates the progress of the restore
operation.

Reference Manual ECS/SDR Maintenance

ECS/SDR Maintenance 9

SDR Licensing
The License tab is shown below. Use this tab to copy a license file from floppy to the
flsadev\bin\license directory. Insert the floppy and press OK.

10 ECS/SDR Maintenance

Reference Manual ECS/SDR Maintenance

Personalized Settings
The Personalized dialog shown below has an insert displaying and controlling the
actual desktop style.

Desktop Style:
Desktop style set to Windows NT implies that whenever a new interactive application
is started it will be the active application and it will brought on top of all interactive
applications (if allowed by Windows 2000 at all).
Desktop style set to Windows 2000 implies that the application that requires the
users attention will have an flashing icon in the task bar.
Press Apply or OK to activate the selection.
Start Menu Program Group
Selecting Startup implies that the Maintenance and WatchDog programs will be
inserted into Startup groups for the current user.
Selecting Desktop will add the ECS Documentation map icon to the desktop.
Selecting XXX NTech adds the XXX NTech program folder to the Start Menu.
In order to active the selection click OK
Show this dialog again.
Checkeng this box implies that the Personalized Settings will be inserted into the
Startup group for the current user., i.e. the program will be invoked on the next login to
the currennt user account.
Press OK in order to make the selection.

Reference Manual ECS/SDR Maintenance

ECS/SDR Maintenance 11

Glossary of Terms

Reference Manual ECS/SDR Maintenance

Glossary of Terms 13

Index

Error! No index entries found.

Reference Manual ECS/SDR Maintenance

Index 15

Reference Manual

SDR Partner Configuration

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 5
$Modtime:: 8/30/01 10:13a

$
$

$Author:: Mle
$Workfile:: SDRPartnerCfgUI30_English.doc
0-1000

$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
SDR Partner Configuration ....................................................................... 3
Introduction ................................................................................................................................... 3
Partner Configuration Utility........................................................................................................ 4
Server Configuration..................................................................................................................... 5
Single Server.......................................................................................................................... 5
Dual Server ............................................................................................................................ 6
Time service........................................................................................................................... 6
Client Configuration ..................................................................................................................... 8
Client Partner Change............................................................................................................ 9
System Restart............................................................................................................................. 10

Glossary of Terms .........................................Error! Bookmark not defined.


Index................................................................Error! Bookmark not defined.

Reference Manual SDR Partner Configuration

Contents i

SDR Partner Configuration

Introduction
The SDR Partner Configuration utility is used at a Server workstation to assign
the type of Server configuration (single or dual) and the Server partner in a dual
configuration is utilized. The utility is also used at a Client workstation to
associate a Server.

Reference Manual SDR Partner Configuration

SDR Partner Configuration 3

Partner Configuration Utility


The Partner Configuration utility is accessed from the desktop Start menu. The
top portion of the display window is used to select the FLSA subsystem (SDR,
CEM, Fuzzy) and to identify this workstation type (Server/Client). Each
subsystem type can have a different configuration.

Assign the workstation type by enabling the appropriate option choice - Client
or Server. After the workstation type is selected, the related tab at the bottom of
the screen is enabled.

4 SDR Partner Configuration

Reference Manual SDR Partner Configuration

Server Configuration
When the computer is identified as a Server, the Server tab at the bottom of the
Partner configuration window is enabled. Server configuration
assignments can only be made in the SDR Maintenance mode.

Single Server
If a single Server configuration is used, disable the Dual option and click on the
Apply command.

After the Apply command is issued, the user receives a prompt to restart the
system. Refer to System Restart for additional information.

Reference Manual SDR Partner Configuration

SDR Partner Configuration 5

Dual Server
If a dual Server configuration is used, enable the Dual option. This action
reveals additional fields.
First, identify the system as Server1 or Server2, then enter the name of the
Server partner in the Computer name of dual partner text field.

Time service
In the field Computer name of Timeserver the name of the computer running
the time service is given. The timeservice synchronizes the time across all
computers of the system. Usually one computer is defined to run the time
service. Then all other computers will periodically fetch the time from this
computer. If no name is given or my computer name is given, then this computer
will not fetch the time from any other computer. Even if possible, having two
Servers that fetch the time from one another is not recommended, because this
will lead to incorrect time increments. Currently it is required that the computer
defined as the timeserver defines itself as the Timeserver.
Clients will always fetch the time from their current partner computer.
At the moment the time is synchronized each 5 minutes.
After the Apply command is issued, the user receives a prompt to restart the
system. Refer to System Restart for additional information.

6 SDR Partner Configuration

Reference Manual SDR Partner Configuration

Note:
Timesynchroniztion is maintained automatically by the Active
Directory Service in domains. The frame Computer name of Timeserver is
accordingly dimmed (disabled).

Reference Manual SDR Partner Configuration

SDR Partner Configuration 7

Client Configuration
When the computer is identified as a Client, the Client tab at the bottom of the
Partner configuration window is enabled.

A Client functions as a client in the ECS environment and must connect to a


Server. The Server is selected from the is current partner list box. Enter the
node name of Server1 in the Server1 text field. If a dual Server configuration is
utilized, enter the node name of Server2 in the Server2 text field.
Enable the Low speed connection to Server option if the Client is
connected to the Server through a modem. This causes the Client programs to
poll the Server at a lower frequency.
After the Apply command is issued, the user receives a prompt to restart the
system. Refer to System Restart for additional information.

8 SDR Partner Configuration

Reference Manual SDR Partner Configuration

Client Partner Change


A Client can not function within the SDR system without a Server assigned. If
the current partner fails or is shut down for maintenance, the Client can not
access process information. In dual Server configurations, the current Server
assigned to the Client can be changed.
To change the current assignment, locate and click on the Client Partner
Change selection in the desktop Start menu.
When the utility is started, the Partner configuration window appears. The
Subsystem selection list is used to select the FLSA subsystem (SDR, CEM,
Fuzzy). Each subsystem type can have a different configuration. At
this time however, only the SDR subsystem selection is supported.
Select the Server (Server1 or Server2) to be assigned as the Client partner.

Enable the Low speed connection to Server option if the Client is


connected to the Server through a modem. This causes the Client programs to
poll the Server at a lower frequency.
After the assignments are made, click on the Apply command. At this time, the
current login session is terminated and the Begin Logon window appears. Log
into the system using your assigned username and password. The login account
must be valid on the new Server.

Reference Manual SDR Partner Configuration

SDR Partner Configuration 9

System Restart
After Server and Client configuration changes are made and the Apply
command is pressed, the following message appears.

If other configuration changes that require a restart are to be made, click on the
No button. Make the additional changes then restart the system by using the
Maintenance utility located in the Start menu.
If all configuration changes have been made, click on the Yes command. The
system is restarted to the SDR Run mode.

10 SDR Partner Configuration

Reference Manual SDR Partner Configuration

Reference Manual SDR Partner Configuration

11

Reference Manual

SDR System Configuration

Reference Manual for SDR Systems Configuration

Error! No text of specified style in document. i

FLS Automation A/S


Hffdingsvej 77
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 1
$Modtime:: 2/05/01 2:26p
hb
$Author:: Ngb
$Workfile:: SdrSysCfgUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further
and future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.
Contents

ii Error! No text of specified style in document.

Reference Manual for SDR Systems Configuration

System Configuration ...................................Error! Bookmark not defined.


Introduction .............................................................................. Error! Bookmark not defined.
System Parameters ................................................................... Error! Bookmark not defined.

Glossary of Terms.........................................Error! Bookmark not defined.


Index...............................................................Error! Bookmark not defined.

Reference Manual for SDR Systems Configuration

Error! No text of specified style in document. iii

System Configuration

Introduction
The SDR System Configuration utility is used to assign the system name, factory
name, and specify the frequency of the database backup. To start the utility,
locate and select the SDR System Settings entry in the SDR portion of the
desktop Start menu.

Reference Manual for SDR Systems Configuration

System Configuration 1

System Parameters
The General tab includes the fields for system parameter assignments.

Factory Name The information in this field is used to identify the factory or
company name in report footers and other parts of the system.
System Name The information in this field is used to identify the system in
report headers and other parts of the system. If the plant includes a QCX and
SDR system, this field can be used to identify each.
Auto backup period Specifies how often the memory resident process
database is backed up to disk. The entry is in minutes. backup in minutes.
backup of the runtime database from memory to disk. Predefined increments
from 15 minutes to 240 minutes are available in the pull down list.

2 System Configuration

Reference Manual for SDR Systems Configuration

Reference Manual for SDR Systems Configuration

Reference Manual

ECS/SDR User Access


Control Configuration

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 2
$Modtime:: 7/17/01 10:46a

$
$

$Author:: Ngb
$Workfile:: SdrUacCfgUi30_English.doc
0-1000

$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS/SDR User Access Control Configuration ....................................... 1
Introduction ................................................................................................................................... 1
User Configuration........................................................................................................................ 2
Group Configuration..................................................................................................................... 5
Displaying Rights.......................................................................................................................... 7
Displaying User's Rights ....................................................................................................... 7
Displaying Group Rights....................................................................................................... 9
Displaying Rights Owners................................................................................................... 10
General Configuration ................................................................................................................ 11

Glossary of Terms ................................................................................... 13


Index.......................................................................................................... 15

Reference Manual ECS/SDR User Access Control Configuration

Contents i

ECS/SDR User Access Control


Configuration

Introduction
The ECS/SDR User Access Control (UAC) Configuration is used to grant access
rights to new and existing users for the ECS/SDR system. System administrators
can control access to the point, I/O, log, event, etc systems for an individual user
or a group of users.
Rights are granted to users, either explicitly or by groups. Rights can be simple
rights, such as Point: Resize of database or Point: Change of B-point
algorithms. Rights can also be department dependent, such as Ios: Reset
events and Ios: Silence events.
Users are usually members of groups. Users can be added to or removed from
groups.
Groups are usually a collection of granted rights.
ECS/SDR UAC Configuration contains the following three tabs:

Users, this tab is used to add a new user. It is also used to delete, copy or
modify rights for an existing user.

Groups, this tab is used to add a new group. It is also used to delete, copy
or modify rights for an existing group.

Rights, this tab is used to display rights for individual users or groups.

General, this tab is used to enable or disable user access control, and to
update the runtime database.

The main window contains the following three buttons:

Apply, is used to apply changes to the database.

Reset can be used to recover settings since last Apply.

Help is used to retrieve the on-line help.

Reference Manual ECS/SDR User Access Control ConfigurationECS/SDR User Access Control Configuration 1

User Configuration
A system administrator might wish to add a new user to the system, such as an
operator. First enter a user login in New UserName. It is important to note
that this user name must be the same as the Windows login for the user. Anyone
logging into Windows with an unknown user name will have no rights to the
system. It is not necessary to create a Windows login before creating an user
name.
Default users cannot
modified or deleted.

be

To simply add a new user


without any rights, click the
Add button.

The following is a set of default users supplied with ECS/SDR:

Flsa, includes guests and operators rights.

FlsaMain, includes guests, operators and administrators rights. Standard


engineer rights.

FlsaServer, gives all rights to the system.

To add a new user with the same rights as an existing or default user, choose an
existing or default user from the pull-down box, then use the Copy button to
copy the rights of the selected user to the user in the New UserName box.
Use the Delete button to remove the selected user shown in the pull-down box.
If an user is accidentally deleted, it can be recovered using the Reset button, as
long as the Apply button has not been pressed.
In the Group membership section, the left panel shows the groups the selected
user is currently a member of, while the right panel shows available groups. Use
the Add -> or Remove -> buttons to add or remove group to and from the
selected user.

Figure 1. A new user called OperatorXX is created with rights from default user Flsa,
using the Copy button.

2 ECS/SDR User Access Control ConfigurationReference Manual ECS/SDR User Access Control Configuration

Since a user receives all the


rights from his groups, an
existing right can only be
removed if he belongs to a
new group.

The User Rights button is used to grant specific rights to the selected user. It
is important to note that User Rights is inclusive, meaning that rights inherited
from a group cannot be removed using the User Rights button. So a user
receives all the rights of the groups in which he is a member. When the User
Rights button is pressed a new window called Rights configuration will
appear.

Figure 2. Granting special rights to OperatorXX, and selecting which departments the department
related right, Ios: Reset events, will be active.

The Rights configuration window contains three panels:

the top-left panel displays the specifically granted rights,

the top-right panel shows all available rights and

the bottom panel indicates which departments the currently selected right is
active. This panel is only relevant for department related rights.

By default, a department related right will be active in all departments. By deselecting the All departments check box, the administrator will be allowed to
select the departments which will be active for the user, as seen in the above
figure.
By using the Add-> button, rights can be given to the user. By using the
Remove-> button, rights previously given can be removed. Remember User
rights is inclusive.
The following buttons are found on the bottom of the window:

OK, applies changes to the user, but not to the database, and closes window.

Apply, same as OK, but does not close window.

Reset, restores to last setting since last OK or Apply was pressed.

Reference Manual ECS/SDR User Access Control ConfigurationECS/SDR User Access Control Configuration 3

Cancel, cancels changes and closes window.

4 ECS/SDR User Access Control ConfigurationReference Manual ECS/SDR User Access Control Configuration

Group Configuration
A group can be simply added
with no rights by using the
Add button.

A new group might be required when there is a group of new users who share
similar rights of an existing group. First enter a group name in New
groupname. Similar to the previous section, a group can copy the rights from
an existing group by selecting an existing group from the pull-down box and by
using the Copy button.

Default groups cannot be


modified or deleted.

The following are default groups available for copying:

Guests, have no rights.

Operators, have typical operator rights, e.g. access to many point and I/O
systems.

Administrators, standard engineering rights, e.g. access to point, I/O, log,


event and right systems.

Figure 3. A new group called "Privileged Operators" was added using the Copy button
to copy the rights from default group Operators.

Once a new group has been added, groups rights can be modified using the
Group rights button. The Rights configuration window will appear.

Reference Manual ECS/SDR User Access Control ConfigurationECS/SDR User Access Control Configuration 5

Figure 4. Right settings for a new group called "Privileged Operators", similar to User rights
configuration, the department related rights can be selected to be active in certain departments.

This window is the same as the User configuration's Rights configuration


window.
For group configuration there are three scenarios:

A right has been added to the group, this right will be granted to users who
are members of this group. If a right has been removed from the group.
The removed right will not exist for users who are members only to this
group.

For a user belonging to multiple groups. If a right appears in any group, but
not in others, the right will be granted.

For users belonging to multiple groups and containing multiple occurrences


of a department related right; the active departments in the department
related right will be given from the group appearing first on the membership
list found in User tab.

Therefore it is usually better to create groups will no similar rights.

6 ECS/SDR User Access Control ConfigurationReference Manual ECS/SDR User Access Control Configuration

Displaying Rights
The Rights tab consists of the following three main sections:

Show user, is used mainly to display user's rights.

Show group, is used to display group's rights.

Show right, is used to display owners of a specified right.

Displaying User's Rights

Figure 5. In this example, OperatorXX is selected in the Rights Tab, Show user section.
If the All rights button is pressed, window in next figure will appear.

It is also possible to see which


group the selected user is a
member of by clicking
Member of groups.

User Rights can be listed using the Rights Tab. In the Show user section,
select a user from the pull-down box, and press the All rights button to see
rights associated with this selected user. The Rights query results window
will appear.

Reference Manual ECS/SDR User Access Control ConfigurationECS/SDR User Access Control Configuration 7

Figure 6. All rights displayed for OperatorXX. The department related right, Ios: Reset
events right, was selected previously in the Users Tab with the User rights button.

Appearing beside each right is a bracket containing the group name where the
right was inherited. If no group name is visible, this means the right was
specifically given to this user using the User rights button in User tab. In the
above figure, Point: Alarm limits, was inherited from the Operators group,
while Ios: Reset events was specifically given to this user.
Click Close to return to Rights Tab.

8 ECS/SDR User Access Control ConfigurationReference Manual ECS/SDR User Access Control Configuration

Displaying Group Rights

Figure 7. In this example, a new group called "Privileged Operators" was created for a
new type of user called "Point Operator".

The most efficient way to look at group rights is to use the Rights tab, Show
group section and the All rights button. The Member of group button can
be used to show members of the selected group.

Figure 8. The left panel shows a list of rights selected for the group Privileged
Operators.

Reference Manual ECS/SDR User Access Control ConfigurationECS/SDR User Access Control Configuration 9

Displaying Rights Owners

Figure 9. In this figure the Ios: Reset events right has been selected in the Show right
section, to view a list of users with this right, click the Granted to users button.

A different method of viewing rights is to select a specific right from the Show
right section pull-down box. To view a list of users who has been granted this
right, click the Granted to users button. To view a list of groups who has
been granted this right, click the Granted to groups button.

Figure 10. The right Ios: Reset events has been granted to OperatorXX, since this is a
department related right it is only effective in certain departments.

10 ECS/SDR User Access Control ConfigurationReference Manual ECS/SDR User Access Control Configuration

General Configuration

Figure 11., The General Tab contains a section for enabling or disabling the UAC and a
button to Refresh the runtime database

By default the Enable UAC checkbox is unchecked, this means UAC is disable.
Disabling the UAC means that access is not controlled. To enable UAC, check
the checkbox Enable UAC and press immediately Apply underneath the
checkbox. The ability to enable or disable UAC is only given to users, who have
the Windows administrator rights (i.e. are members of the Windows usergroup
Administrators). Any other users cannot operate this function.
The Refresh Database Table button found in the Rights tab is used to Update
the Runtime Database by non-destructively reading the Static Configuration.
This function is not normally used, and only used during maintenance.

Reference Manual ECS/SDR User Access Control ConfigurationECS/SDR User Access Control Configuration 11

Glossary of Terms

Reference Manual ECS/SDR User Access Control Configuration

Glossary of Terms 13

Index

Refresh Database Table 10


removed right 5
Reset 13
Rights configuration 1, 3, 45
Rights configuration window 3, 5

S
Show rights 9
Show user 6, 8

U
A

Update the Runtime Database 10


User Rights 3, 58

Add 13, 4
Administrators 2, 4
All departments 3

C
Copy 12, 4

D
Delete 12

F
Flsa 2
FlsaMain 2
FlsaServer 2

G
Granted to users 5
Group membership section 2
Group rights 48
Guests 2, 4

M
Member of group 8
Member of groups 6
multiple groups 5

N
New groupname 4
New UserName 2
NT login 2

O
occurrence of the same right 5
Operators 2, 48

Reference Manual ECS/SDR User Access Control Configuration

Index 15

Reference Manual

ECS OpStation Editor

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 10
$Modtime:: 10/18/01 1:29p
StN
$Author:: Hb
$Workfile:: SdrGmsDrawUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS OpStation Editor................................................................................ 1
Introduction ................................................................................................................................... 1
ECS OpStation Editor Reference Manual............................................................................. 1
SL-GMS Draw User's Guide................................................................................................. 2
Picture Directories ........................................................................................................................ 2
Directory Structure ................................................................................................................ 2
Picture Files ........................................................................................................................... 2
Picture Location..................................................................................................................... 3
New Picture................................................................................................................................... 3
Default Settings ..................................................................................................................... 3
Model Owner ......................................................................................................................... 3
Palettes .......................................................................................................................................... 4
Classic Dynamics.......................................................................................................................... 5
Assigning Object Owner ....................................................................................................... 5
PointVal Object ..................................................................................................................... 5
PointValEnt Object................................................................................................................ 6
Color Symbol Objects ........................................................................................................... 6
Changing Symbol Objects..................................................................................................... 7
Filling Symbol Objects.......................................................................................................... 9
Trend Object ....................................................................................................................... 10
Buttons ........................................................................................................................................ 11
Picture Select Button ........................................................................................................... 12
Picture PopUp Button.......................................................................................................... 13
Picture PopUp Floating Button ........................................................................................... 13
Faceplate PopUp Button...................................................................................................... 14
Bit Control Button ............................................................................................................... 14
Bit Set Button ...................................................................................................................... 15
Bit Pulse Button................................................................................................................... 15
Bit Toggle Button ................................................................................................................ 16
Bit Toggle Check................................................................................................................. 17
Mode Control Button........................................................................................................... 17
Percent Change Button ........................................................................................................ 18
Sdr Trend Button ................................................................................................................. 19
Start Process Button............................................................................................................. 19
Toolbar buttons.................................................................................................................... 20
Generel action button........................................................................................................... 20
Using OpenGMS Dynamics ....................................................................................................... 21
Renaming Variables ............................................................................................................ 21
Fonts..................................................................................................................................... 22
PointNo Variable ................................................................................................................. 22
PntCode Object.................................................................................................................... 22
PntCodeVis Object .............................................................................................................. 23
PntText Object ..................................................................................................................... 23
PntVal Object....................................................................................................................... 24
PntValText Object ............................................................................................................... 24
PntValEnt Object ................................................................................................................. 24
PntMSWInt Object .............................................................................................................. 25
PntMSWHex Object ............................................................................................................ 25
PntMSWBit Object.............................................................................................................. 26

Reference Manual ECS OpStation Editor

Contents i

PntMSWBitText Object.......................................................................................................26
PntThermoVer Object..........................................................................................................27
PntThermoDev Object .........................................................................................................27
PntThermoSca Object ..........................................................................................................28
PntSlider Object ...................................................................................................................28
PlcVal Object .......................................................................................................................29
PlcValEnt Object..................................................................................................................29
PlcInt Object.........................................................................................................................29
PlcIntEnt Object...................................................................................................................30
PlcParName Object..............................................................................................................30
LangText Object ..................................................................................................................31
AbbreviationText Object .....................................................................................................31
FlsDateTime Object .............................................................................................................32
Generic route property text object .......................................................................................32
Generic group property text object......................................................................................33
Generic department property text object .............................................................................33
Generic point property text object .......................................................................................33
Creating OpenGMS Dynamics ...................................................................................................34
GMS Dynamic Properties....................................................................................................34
OpenGMS Functions ...........................................................................................................36
Information Functions..........................................................................................................37

Pointno Function ............................................................................................. 37


Pntfloat Function ............................................................................................. 37
Pntint Function................................................................................................. 38
Pnttext Function............................................................................................... 39
Pntbit Function................................................................................................. 39
Pntvalue Function ............................................................................................ 40
Pntunit Function .............................................................................................. 41
Plctext Function ............................................................................................... 42
Plcdouble Function .......................................................................................... 42
Plcint Function ................................................................................................. 43
Plcunit Function ............................................................................................... 43
Langtext Function ............................................................................................ 44
Abbreviationtext Function.............................................................................. 44
Datetime Function ........................................................................................... 45
extxxx functions ............................................................................................... 46
colv7getgeneric functions................................................................................ 47
Colv7format function ...................................................................................... 47
Colv7uacright function .................................................................................... 47
Action functions...................................................................................................................48

Pntselect Function............................................................................................ 48
Pntedit Function............................................................................................... 48
Pntupdownpercent Function.......................................................................... 49
Iosbitaction Function....................................................................................... 50
Iosbittoggle Function....................................................................................... 51
Iosbitpulse Function ........................................................................................ 51
Iosbitsetcond Function.................................................................................... 52
Iospbsetpoint Function ................................................................................... 53
Plcbitset Function............................................................................................. 53
Plcbitsetcond Function.................................................................................... 53
Plcbittoggle Function....................................................................................... 54
Plcedit Function................................................................................................ 54
ExtSetxxx function........................................................................................... 55
Extedit function................................................................................................ 56

ii Contents

Reference Manual ECS OpStation Editor

ExtActivate function........................................................................................56
ExtMenu function ...........................................................................................57
ColModelInvoke Function..............................................................................57
ColNewWindowInvoke Function..................................................................57
ColGenPopUpInvoke Function.....................................................................57
Facepopupio(FacePlateNameSuffix, lPointNo ) .........................................58
StartProcess function. ......................................................................................58
ShowTrend function. .......................................................................................58
Showbrowser function.....................................................................................58
Colv7executecommand function ...................................................................59
Making Dynamics in Editor ................................................................................................ 60
PntFloat Example................................................................................................................. 64
Faceplates .................................................................................................................................... 68
Creating Faceplates.............................................................................................................. 68
Assigning Faceplates ........................................................................................................... 68
PIDFace Example ................................................................................................................ 68
Bitmaps........................................................................................................................................ 71
Converting Pictures From VMS ................................................................................................. 71

Glossary of Terms ................................................................................... 73


Index.......................................................................................................... 75

Reference Manual ECS OpStation Editor

Contents iii

ECS OpStation Editor

Introduction
The ECS OpStation Editor is the tool for creation and modification of graphical
mimic pictures for display by the ECS OpStation application. These pictures are
also called models. The graphical system employed is GMS by SL.

Figure 1 - OpStation Editor

ECS OpStation Editor Reference Manual


This document is a supplement to the SL-GMS DRAW USER'S GUIDE. In the
present manual special functions for OpStation pictures, such as linking SDR
database points to dynamic graphical objects, are described.
The manual is available as a word document for reading and printout in
following directory:

Reference Manual ECS OpStation Editor

ECS OpStation Editor 1

FLSADev\Help\Sdr\Ref\SdrGmsDrawUI30\English\SdrGmsDrawUI30_English.
doc

SL-GMS Draw User's Guide


The original User's Guide supplied by SL describes the fundamentals of the
editor.
This manual is available as an Adobe Acrobat Reader document for reading and
printout in the following directory:
FLSADev\Help\Sdr\Ref\SdrGmsDrawUI30\English\GmsDraw.pdf
To access the file (by double click) you must first install the acrobat reader as
follows:

Double click FLSADev\ToolsNT\Acroread\Setup.exe

Follow installation procedure and choose destination directory


FLSADev\ToolsNt\Acroread

Picture Directories
Directory Structure
FlsaGmsPic is the name of the share directory for OpStation pictures.
This directory is born with the following subdirectories.
.\Faceplates for library of popup pictures called faceplates.
.\Demo demo picture.
.\SdrTestOps test pictures.
.\Submods for library of static ready made sub models that may be used in
pictures.
.\Gismos for library of dynamic objects (gismos) that may be used in pictures.
.\Palettes for library of pictures with sub models and gismos to use in picture
editing.
.\Bitmaps for bitmaps used in pictures, sub models, and gismos.
The user can make directories for models, gismos, submodels, faceplates, and
bitmaps. This is done in ECS Opstation Configuration.

Picture Files
Pictures are stored in two files:
Picture_name.g is a source file in ASCII format. Can be read by a text editor.
This file is useful if you have to move pictures from one platform to another (e.
g. NT and VMS).
Picture_name.m1 is a binary file. It is the file used by the application to display
the picture.
There is a utility SDR_Setup_Tools->GMS Conversion for converting .g files
to .m1 files and vice versa.

2 ECS OpStation Editor

Reference Manual ECS OpStation Editor

You normally do not have to bother with this as the editor always automatically
will save both files.

Picture Location
In a distributed system the ECS OpStation Editor runs on the local machine.
However, pictures are loaded from and saved to the Server (MOP) partner. In
this way changes apply globally in the system. The OpStation application will
make sure that the newest version on the Server will be copied and displayed on
the local machine.

New Picture
Default Settings
A new picture will have the following default settings:
Model width 100
Model height 75
Background enabled
Background color 31 (Flsa_Background_Color)
This can be changed from menu Model->Properties.
Note that pictures displayed in the same window should have the same size.
Pictures displayed in separate window, like faceplates, need not.

Model Owner
Each main picture may be assigned a department. When a picture is selected in
the OpStation application, the department of the picture becomes the selected
department and the name is displayed in the status bar pane. The assignment of a
department to a picture is done as follows.

Select Model->Owner from the menu.

Select a department from the box shown below.

Figure 2 - Owner model box

Open Picture
When a picture is open the open picture dialog is displayed.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 3

The models and gismos delivered by FLSA can be found in the folder FLSA and
a given sub folder.
If there has been defined directories for Models, Faceplates etc. these will be
displayed under Models, Faceplates etc directly. If no directories have been
defined, the user should place the models in the root folder.

Palettes
A number of palette pictures offer predesigned sub models and gismos to use in
pictures. A palette is selected from menu Palette->Palettes.. . Or if the user has
defined own palettes Palette->Local Palettes.. . A window with the available
palettes will appear. Selecting the palette will make the palette appear as a
picture in a separate window. An object is selected from palette by:

Click on object in palette

Click on position in your work area to place object

Right click and done finishes the action

All objects in palettes are also reachable by file name from subdirectories.
Objects are selected this way by:

Palette->Submodels or Palette->Gismos

Click on filename

Click on position in your work area to place object

Right click and done finishes the action

Local sub models and gismos defined by the user can be fetches
correspondingly.

4 ECS OpStation Editor

Palette->Local Submodels or Palette->Local Gismos

Reference Manual ECS OpStation Editor

Classic Dynamics
Classic dynamics is the easiest and most efficient form of dynamic objects to
use. However it has some limitations. For advanced dynamics you should use
OpenGMS dynamics as described later. Classic dynamics is used in the main
mimic pictures wherever the needs are sufficient. OpenGMS dynamics is
especially used on faceplates.

Assigning Object Owner


The basic way of making objects dynamic is by assigning an owner to the object.
The owner is a database point that will control the dynamic behavior. The owner
is assigned as follows:

Right click the selected object

Select Owner object

Fill in the owner box

Dynamics created in this way (by menu item Owner object) is called classic
dynamics.
Palettes Flsa_symbols_dynamic,
prepared for classic dynamics.

flsa_symbols_dynamic1

contain

objects

In the following frequently used classic objects are described.

PointVal Object
This object displays an analog value. Value, color and blink are dynamically
updated according to the owner point. The format of the value and the unit is as
defined for the owner point in the database.

Figure 3 - Gismo PointVal

The owner is assigned as follows:

Right click the selected object

Select Owner

Fill in the owner box

Reference Manual ECS OpStation Editor

ECS OpStation Editor 5

Figure 4 - Owner box for PointVal

Pointcode may be typed in directly, or better, may be copied from the point list
using the toolbar buttons.
Faceplate is used to assign a faceplate to the object. The name of the faceplate is
selected from the dropdown list. Note that all objects by default are assigned the
faceplate associated the point algorithm. However, this may be overruled by
assigning a faceplate in the owner box.

PointValEnt Object
Similar to PointVal but allows data entry.

Figure 5 - Gismo PointValEnt

Color Symbol Objects


These are objects where color and blink are dynamically updated according to
the owner point. The object may be a symbol representing a fan, a pump, an
interlocking or other device as found on palette flsa_symbols_dynamic, but it
may also be any directly drawn primitive or grouped symbol or sub model
created by user.

Figure 6 - Fan color symbol

The owner is assigned as follows:

6 ECS OpStation Editor

Right click the selected object

Reference Manual ECS OpStation Editor

Select Owner

Fill in the owner box

Figure 7 - Owner box for Color symbols

Pointcode is typed in or copied from point list via toolbar buttons.


Color symbol is selected as dynamic behavior
Edge-, Text-, Fill-color (one or more) is selected as the color attribute to control
Faceplate is selected if special faceplate shall overrule default as assigned the
point algorithm.
The disabled option FUS item is not used but kept for backwards compatibility.
It is only relevant for old pictures from VMS platform to inspect how the setting
was.

Changing Symbol Objects


These are objects whose shape and color may change dynamically according to
the value of the owner point. The owner must be a B-point.
Examples of changing symbols are flsa_dividing_gate and flsa_louvre_damper
found on palette flsa_symbols_dynamic1

Reference Manual ECS OpStation Editor

ECS OpStation Editor 7

Figure 8 - flsa_dividing_gate two-layer symbol unfolded

Figure 9 - flsa_louvre_damper two-layer symbol unfolded

Changing symbols are made of several layers (sub models) on top of each other
but of the same size. Only one layer is visible at a time. There may be up to 8
layers in a changing symbol. The above shown examples have two layers. Which
layer is visible is controlled by the B-point owner of the symbol. The B-point
algorithm has a definition of the MSW interpretation for the point (see B-point
Algorithm Editor) where a symbol offset is defined (0 .. 7) for each MSW value.
This symbol offset defines which symbol layer should be visible for the
corresponding MSW value.
The user may define own changing symbols.
The owner is assigned as follows:

8 ECS OpStation Editor

Right click the selected object

Select Owner

Fill in the owner box

Reference Manual ECS OpStation Editor

Figure 10 - Owner box for Changing symbols

Pointcode is typed in or copied from point list via toolbar buttons.


Changing symbol is selected as dynamic behavior
Edge-, Text-, Fill-color (one or more) may be selected if additional color
control is needed.
Faceplate is selected if special faceplate shall overrule default as allocated the
point algorithm.

Filling Symbol Objects


These are objects whose filling and color may change dynamically according to
the value of the owner point. The owner must be an A-point. The current filling
will be a percentage calculated from the graphical limits and the actual value of
the point.
Examples of filling symbols are thermometers and tanks. The user may define
own filling symbols.

Figure 11 - Tank filling symbol

Reference Manual ECS OpStation Editor

ECS OpStation Editor 9

The owner is assigned as follows:

Right click the selected object

Select Owner

Fill in the owner box

Figure 12 - Owner box for Filling symbols

Pointcode is typed in or copied from point list via toolbar buttons.


Filling symbol is selected as dynamic behavior
Fill-, Edge-color (one or more) may be selected if additional color control is
needed.
Faceplate is selected if special faceplate shall overrule default as allocated the
point algorithm.

Trend Object
This object displays up to 4 trend curves as real time trends, i.e. when set up the
3/4 of the area displays the most recent historical trends. The curves are then
dynamically updated with real time values to the right. When right border is
reached curves are scrolled left 1/4.

10 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Figure 13 - Trend object

A trend object has up to 4 owner points, one for each trend curve. The owners
are assigned as follows:
The owner is assigned as follows:

Right click the selected object

Select Owner

Fill in the owner box

Figure 14 -Owner box

Pointcodes are typed in or copied from point list via toolbar buttons.
Horizon is the time span on x-axis
Update period is the frequency of updating the trend with real time data

Buttons
Buttons are objects where the dynamic behavior is activated by clicking on the
button with the mouse.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 11

A number of buttons are available for various purposes. These are found on
palette flsa_buttons.
The parameters for a button instance are specified as follows by Rename
variables.

Right click the selected object

Select Rename Variables

Fill in the Value part of the Rename variables box

Figure 15 - Rename variables box for fls_m_scrn button

The Name - Value list depends on the object. The user has to supply actual
values for the named variables.
Get point as is only relevant as an aid when point information is needed.
Get Color may be used to select a color code from a color palette.
In the following the most frequently used buttons will be described.

Picture Select Button


The button fls_m_scrn is used to set up a new mimic picture in the same
window.

Figure 16 - Button fls_m_scrn

12 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label Text (in double quotes) on the button face.


Fillcol Color code for the button face
Model_name Filename (in double quotes, without extension) of the picture to
set up.

Picture Popup Button


The button fls_m_popup is used to set up a mimic picture in a popup window.
The popup window will be contained within the main window.

Figure 17 - Button fls_m_popup

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label Text (in double quotes) on the button face.


Fillcol Color code for the button face
Model_name Filename (in double quotes, without extension) of the picture to
set up.

Picture Popup Floating Button


The button fls_m_newwindow is used to set up a mimic picture in a new popup
window. The popup window will be a free-floating window independent of the
main window.

Figure 18 - Button fls_m_newwindow

Parameters are set by:

Reference Manual ECS OpStation Editor

Right click the selected button

Select Rename Variables

ECS OpStation Editor 13

Fill in the Value part of the Rename variables box

Button_label Text (in double quotes) on the button face.


Fillcol Color code for the button face
Model_name Filename (in double quotes, without extension) of the picture to
set up.

Faceplate Popup Button


The button fls_m_facepopup is used to set up a faceplate. This is used in special
cases only. Normally a faceplate is set up by right click on a point object.

Figure 19 - Button fls_m_facepopup

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label Text (in double quotes) on the button face.


FacePlateName Name of the faceplate (in double quotes)
Fillcol Color code for the button face
PointNo Point number of faceplate owner. Set Get point as Point number and
use toolbar buttons to get a point.

Bit Control Button


The button fls_m_bitcontrol is used to send a bit set or bit clear output command
to a point in a Plc.

Figure 20 - Button fls_m_bitcontrol

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

BitNo Number of bit (0 .. 15) to control

14 ECS OpStation Editor

Reference Manual ECS OpStation Editor

BitVal Value to send (0 = clear, 1 = set)


Button_label Text (in double quotes) on the button face.
Confirm 1 = confirmation box on output, 0 = no confirmation
EventText Text (in double quotes) for the generated event line. At most 24
characters.
Extent_height Height of button (e.g. 4)
Extent_width Width of button (e.g. 8)
Font True type font. Use 1 .. 13
PointNo Point number of output point

Bit Set Button


The button fls_m_bitset is used to send a bit set or bit clear output command to a
point in a Plc.
The function is the same as the bit control button but the appearance is different.
While fls_m_bitcontrol is a pushbutton, fls_m_bitset is a mode button i.e. it will
appear in the pressed-in state if a configurable InBit has value 1.

Figure 21 - Button fls_m_bitset

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

OutBitNo Number of bit (0 .. 15) to control


OutBitVal Value to send (0 = clear, 1 = set)
InBitNo Number of MSW bit to control appearance (value 0 = out, value 1 = in)
Button_label Text (in double quotes) on the button face.
Button_label_color Text color of the label
Confirm 1 = confirmation box on output, 0 = no confirmation
EventText Text (in double quotes) for the generated event line. At most 24
characters.
Extent_height Height of button (e.g. 4)
Extent_width Width of button (e.g. 8)
Font True type font. Use 1 .. 13
PointNo Point number of output point

Bit Pulse Button


The button fls_m_bitpulse is used to send a pulsed bit command to a point in a
Plc. Upon button click the value 1 is sent out and when the corresponding MSW
read bit is 1 the value 0 is sent out.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 15

Figure 22 - Button fls_m_bitpulse

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label Text (in double quotes) on the button face.


Confirm 1 = confirmation box on output, 0 = no confirmation
EventText1 Text (in double quotes) for the generated event line for control 1. At
most 24 characters.
EventText0 Text (in double quotes) for the generated event line for control 0. At
most 24 characters.
OutBitNo Number of bit (0 .. 15) to control
InBitNo Number of bit (0 .. 15) to check for 1-state before sending 0.
Extent_height Height of button (e.g. 4)
Extent_width Width of button (e.g. 8)
Font True type font. Use 1 .. 13
PointNo Point number of output point
Note: The timeout for the value 1 to be read back from MSW is 15 seconds
Another button fls_m_bitpulse1 has a configurable timeout value TimeOutSecs
set by rename variables.

Bit Toggle Button


The button fls_m_bittoggle is used to change a bit to its opposite value i.e. if bit
is set send a bit clear output command and if bit is cleared send a bit set output
command.
The toggle button is a mode button i.e. the appearance is controlled by the
current value of an InBit of the MSW. If the bit is set, the button shows pressedin, if the bit is cleared, the button shows pressed-out.

Figure 23 - Button fls_m_bittoggle

Parameters are set by:

16 ECS OpStation Editor

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Reference Manual ECS OpStation Editor

Button_label Text (in double quotes) on the button face.


Button_label_color Text color of button label.
Confirm 1 = confirmation box on output, 0 = no confirmation
EventText Text (in double quotes) for the generated event line. At most 24
characters.
OutBitNo Number of bit (0 .. 15) to control
InBitNo Number of bit (0 .. 15) to control button appearance
Extent_height Height of button (e.g. 4)
Extent_width Width of button (e.g. 8)
Font True type font. Use 1 .. 13
PointNo Point number of output point

Bit Toggle Check


The gismo fls_m_bitcheck has the same function as fls_m_bittoggle, but
displays a checkmark if the InBit is set and blank if cleared. Click in the gismo
toggles the OutBit value.

Figure 24 - gismo fls_m_bitcheck

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

CheckBackColor Background color of the gismo.


CheckColor Color of the checkmark.
Confirm 1 = confirmation box on output, 0 = no confirmation
EventText Text (in double quotes) for the generated event line. At most 24
characters.
OutBitNo Number of bit (0 .. 15) to control
InBitNo Number of bit (0 .. 15) to control gismo appearance
Font True type font. Use 1 .. 13
PointNo Point number of output point

Mode Control Button


The button fls_m_mode_diamon is used to change the mode of a PID controller,
but behaves in the same way as the Bit Control button. It can be used to send a
bit set or bit clear command to any point the Plc.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 17

Figure 25 - Button fls_m_mode_diamon

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

BitNo Number of bit (0 .. 15) to control


BitVal Value to send (0 = clear, 1 = set)
Confirm 1 = confirmation box on output, 0 = no confirmation
Edge_width width of the button edge (1 .. 5)
EventText Text (in double quotes) for the generated event line. At most 24
characters.
PointNo Point number of mode point

Percent Change Button


The buttons fls_m_percent_up, fls_m_percent_upsmall, fls_m_percent_down,
fls_m_percent_downsmall are used for percent wise change of an analog value.
The buttons behave in a special way when applied to a set point because the
change will affect the output point related to the set point if the mode related to
the set point is manual.

Figure 26 - Buttons fls_m_percent_up and fls_m_percent_down

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label text (in double quotes) associated the button.


Confirm 1 = confirmation box on output, 0 = no confirmation
Edge_width width of the button edge (1 .. 5)
ManModeMaskBits mask bits of MSW for manual mode given as an integer
(may be hex). e.g. 10 (or 0x000a) means bit 1 and bit 3 defines manual mode.
Defines the bits that must be tested to determine manual mode.
ManModeValueBits value bits of MSW for manual mode given as integer (may
be hex). Defines the values of the bits given by the mask that determines manual

18 ECS OpStation Editor

Reference Manual ECS OpStation Editor

mode. e.g. 2 (or 0x0002) means that with the above mask given manual mode is
defined as bit 1 = 2 and bit 3 = 0.
PercentChange percentage of the points system range to raise or lower the
current value
PointNo Point number of controlling point
Text_align_x horizontal alignment of button label. 1 = left, 2 = mid, 3 = right
Text_height height of button label (e.g. 2.0)

Sdr Trend Button


The button fls_m_sdrtrend is used to activate the Sdr Trend application with a
specific trend package.

Figure 27 - Button fls_m_sdrtrend

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label text (in double quotes) associated the button.


Extent_height Height of button (e.g. 4)
Extent_width Width of button (e.g. 8)
Font True type font. Use 1 .. 13
TrendPackNo Trend pack number to display

Start Process Button


The button fls_m_startprocess is used to start any external application with
specified parameters. For example you may start Excel with a specific
spreadsheet.

Figure 28 - Button fls_m_startprocess

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label text (in double quotes) associated the button.


Confirm 1 = confirmation box, 0 = no confirmation
Extent_height Height of button (e.g. 4)
Extent_width Width of button (e.g. 8)

Reference Manual ECS OpStation Editor

ECS OpStation Editor 19

Font True type font. Use 1 .. 13


ProgramFile Name of the application file (.exe) to start (in double quotes). If
not in standard path, include full path.
ParamTexti i = 1..5 Name of the i-th parameter to pass to the application (in
double quotes). Leave blank if not applicable.

Toolbar buttons
All toolbar buttons in OpStation is available in the toolbar palette, and can be
added to any picture. They work exactly the same way as the OpStation toolbar
buttons.

General action buttons


The button flsa_call is used to make a generic call to any action function in
OpStation except for the edit functions. The action functions should be called
with Ignore = 0.

Button_label text (in double quotes) associated the button.


Button_state should not be renamed
Edge_width width of the button edge (1 .. 5)
flsfunction one of the action function with all parameters.
Text_align_x horizontal alignment of button label. 1 = left, 2 = mid, 3 = right
Text_height height of button label (e.g. 2.0)
The button flsa_twocalls makes one call to any action function on mouse press
and another call to any action function on mouse release if the first call does not
put another application on top of the button.

Button_label text (in double quotes) associated the button.


Button_state should not be renamed
Edge_width width of the button edge (1 .. 5)
Text_align_x horizontal alignment of button label. 1 = left, 2 = mid, 3 = right
Text_height height of button label (e.g. 2.0)
PressCall one of the action functions with all parameters to be called on mouse
press.
ReleaseCall one of the action functions with all parameters to be called on
mouse release.

20 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Using OpenGMS Dynamics


OpenGMS dynamics is a supplement to classic dynamics, providing enhanced
flexibility. You can make your own special objects referencing all kinds of
attributes in the database. Further you can make use of the graphical features
offered by GMS, which are not available in classic dynamics.
A number of OpenGMS objects have been made. The use of these is described in
the following. The classic dynamic objects also exist in an OpenGMS version
with enhanced flexibility.
You should use OpenGMS objects when:

Classic dynamics does not fulfill your needs

Making faceplates (see section Faceplates)

Palettes
opengms_dynamic_1,
opengms_dynamic_2
plc_parameter_dynamic contain objects made with OpenGMS.

and

Renaming Variables
After instantiating an OpenGMS object in a picture, parameters are specified as
follows by rename variables.

Right click the selected object

Select Rename Variables

Fill in the Value part of the Rename variables box

As an example the rename variables box for the PntVal object (used to display a
point value) is shown below.

Figure 29 - Rename variables box

AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right


FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13

Reference Manual ECS OpStation Editor

ECS OpStation Editor 21

PointNo Point number of the controlling point.

Fonts
The fonts available are the following true type fonts:
Font index

Font Description

Arial

Courier New-Bold

Courier New

Times New Roman

Courier New-Italic

Times New Roman-Bold

Arial-Bold

Arial-Italic

Times New Roman-Bold-Italic

10

Times New Roman-Italic

11

Arial-Bold-Italic

12

Courier New-Bold-Italic

13

Symbol

PointNo Variable
As for above example all OpenGMS objects will have a variable PointNo.
If the object is part of a faceplate the PointNo is entered as $ (dollar sign) which
means that the actual pointno will refer to the point selected when the faceplate
is activated.
If the object is part of a normal mimic picture PointNo is the point number of the
controlling point. As the user knows only point codes and not point numbers, a
conversion function must be used. This function pointno("<pointcode>")
converts a point code to a point number. Instead of entering e.g.
pointno("J4P12") as plain text you may set Get point as Point number and
then use the toolbar buttons to get a point code from the point list. The point will
then automatically be entered as pointno("<pointcode>").
The use of Special Point related Get and Special PLC related Get is explained
in section "Creating OpenGMS Dynamics"
The following describes the ready-made OpenGMS objects.

PntCode Object
This object displays the point code for a point.

Figure 30 - Gismo PntCode

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right

22 ECS OpStation Editor

Reference Manual ECS OpStation Editor

FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

PntCodeVis Object
This object displays the point code for a point with visibility control. If a
controlling B-point is set, the point code will be visible, if cleared the point code
will be invisible.
A picture may thus have hidden point codes, which becomes visible when a
toggle button in the picture is pushed to set the controlling B-point value.

Figure 31 - Gismo PntCodeVis

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
BackColor Color of the background when point code is invisible.
ControlBitNo Bit number of the controlling B-point for visibility check.
ControlPointNo Point number of controlling B-point.
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the point.

PntText Object
This object displays the point text of a point.

Figure 32 - Gismo PntText

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13

Reference Manual ECS OpStation Editor

ECS OpStation Editor 23

PointNo Point number of the controlling point.

PntVal Object
This object displays the point value for an A-point. Value, color and blink are
dynamically updated according to the controlling point. The format of the value
and the unit is as defined for the point in the database. The object is selectable,
i.e. click on object will behave as for classic object PointVal.

Figure 33 - Gismo PntVal

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

PntValText Object
This object displays the point value text for a B-point (e.g. "run", "stop"). Value,
color and blink are dynamically updated according to the controlling point. The
object is selectable, i.e. click on object will behave as for classic object PointVal.

Figure 34 - Gismo PntValText

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

PntValEnt Object
This object displays the point value of an A-point. Similar to PntVal but allows
data entry by left click on point.

Figure 35 - Gismo PntValEnt

Variables to rename:

24 ECS OpStation Editor

Reference Manual ECS OpStation Editor

AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right


FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

PntMSWInt Object
This object displays the machine status word (MSW) for a B-point. The 16-bit
value is displayed as an integer.

Figure 36 - Gismo PntMSWInt

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

PntMSWHex Object
This object displays the machine status word (MSW) for a B-point. The 16-bit
value is displayed as a hexadecimal integer.

Figure 37 - Gismo PntMSWHex

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 25

PntMSWBit Object
This object displays the value of a single bit of the machine status word (MSW)
for a B-point. The value is displayed as 0 or 1.

Figure 38 - Gismo PntMSWBit

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
BitNo Number of bit in MSW to display. 0 .. 15
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

PntMSWBitText Object
This object displays the value of a single bit of the machine status word (MSW)
for a B-point. The value is displayed as text.

Figure 39 - PntMSWBitText

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
BitNo Number of bit in MSW to display. 0 .. 15
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.
TextColor0 Color text for value 0 given as GMS color index
TextColor1 Color text for value 1 given as GMS color index
ValueText0 Text for value 0
ValueText1 Text for value 1

26 ECS OpStation Editor

Reference Manual ECS OpStation Editor

PntThermoVer Object
This object displays the value of an A-point as a percentage fill of a vertical
thermometer. The fill percent is calculated from the actual value and the operator
graphical limits. Red lines mark the high- and low alarm limits. A green line
marks the normal value. The fill color and blink is that of the controlling point.
The thermometer is dynamically updated.

Figure 40 - Gismo PntThermoVer

Variables to rename:
PointNo Point number of the controlling point.

PntThermoDev Object
This object displays the value of an A-point as a percentage fill of a deviation
thermometer. A green line in center marks the normal value. Plus- and minus
deviation from normal value is displayed as percentage fill. Behavior is as for
PntThermoVer.

Figure 41 - Gismo PntThermoDev

Variables to rename:
PointNo Point number of the controlling point.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 27

PntThermoSca Object
This object displays the value of an A-point as a percentage fill of a
thermometer. The Thermometer is equipped with a scale indicating highmedium- and low- limits. Limits are operator graphical limits. Behavior is as for
PntThermoVer.

Figure 42 - Gismo PntThermoSca

Variables to rename:
PointNo Point number of the controlling point.

PntSlider Object
This object displays the value of an A-point as a percentage fill of a
thermometer. The behavior is as for PntThermoVer, but this object also permits
data entry by dragging the slider knob. A small window displays the actual
numerical value while dragging. Upon release of the slider knob the new value is
sent out to the IO system.

Figure 43 - Gismo PntSlider

Variables to rename:
Confirm 1 = confirmation box on output, 0 = no confirmation
PointNo Point number of the controlling point.

28 ECS OpStation Editor

Reference Manual ECS OpStation Editor

PlcVal Object
This object displays a PLC-parameter value with unit. Plc parameters are located
in a parameter block associated a point address in the PLC. The parameters are
described according to a block algorithm. The format of the value and the unit is
as defined in the block algorithm associated the parameter.

Figure 44 - Gismo PlcVal

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
ParameterKey Text string (in double quotes) identifying the PLC parameter in
the block algorithm.
PointNo Point number of the controlling point.
TextColor Text color given as GMS color index.

PlcValEnt Object
This object displays a PLC parameter value and allows data entry by clicking on
the object. The entered value is sent to the PLC to change the parameter. The
value display is as for PlcVal.

Figure 45 - Gismo PlcValEnt

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
ParameterKey Text string (in double quotes) identifying the PLC parameter in
the block algorithm.
PointNo Point number of the controlling point.
TextColor Text color given as GMS color index.

PlcInt Object
This object displays a PLC parameter value of type unsigned, integer or bit
pattern without unit.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 29

Figure 46 - Gismo PlcInt

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
ParameterKey Text string (in double quotes) identifying the PLC parameter in
the block algorithm.
PointNo Point number of the controlling point.
TextColor Text color given as GMS color index.

PlcIntEnt Object
This object displays a PLC parameter value of type unsigned, integer or bit
pattern without unit. Data entry is allowed by click on the object. The entered
value is sent to the PLC and the parameter is changed.

Figure 47 - Gismo PlcIntEnt

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
ParameterKey Text string (in double quotes) identifying the PLC parameter in
the block algorithm.
PointNo Point number of the controlling point.
TextColor Text color given as GMS color index.

PlcParName Object
This object displays the name of a PLC parameter in current language. The name
is defined in the block algorithm.

Figure 48 - Gismo PlcParName

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right

30 ECS OpStation Editor

Reference Manual ECS OpStation Editor

FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
ParameterKey Text string (in double quotes) identifying the PLC parameter in
the block algorithm.
PointNo Point number of the controlling point.
TextColor Text color given as GMS color index.

LangText Object
This object displays a text constant in the current language. The texts constants
are
defined
in
the
table
LanguageTexts
of
the
database
FlsaDev\ProDb\SdrOpsSpecial
Text10.mdb.
Note. LangText is intended for FLSA use only. Some of the standard faceplates
provided by FLSA uses these objects for text constants. The end customer
should use plain text or text rectangle primitives in his native language when he
makes new pictures.

Figure 49 - Gismo LangText

Variables to rename:
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
Text_align_x Horizontal alignment of text in the box. 1 = left, 2 = mid, 3 = right
Text_height Size of the text (e.g. 2.5)
TextColor Color of text given as GMS color index.
TextKey String (in double quotes) identifying the database key for the text
constant.

AbbreviationText Object
This object displays a text abbreviation according to a currently selected set of
abbreviations. The texts constants are defined in the table AbbreviationTexts of
the database FlsaDev\ProDb\SdrOpsSpecialText10.mdb.
Note. AbbreviationText is intended for FLSA use only. The ACESYS faceplates
use different abbreviations for different applications (FLSA, FLS, HTC, etc. ).
The set to use for a specific project is selected through the ECS OpStation
Configuration utility under Abbreviations sub function.

Figure 50 - Gismo AbbreviationText

Reference Manual ECS OpStation Editor

ECS OpStation Editor 31

Variables to rename:
AlignX Horizontal alignment of text in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Color of text given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
Text_height Size of the text (e.g. 2.5)
TextKey String (in double quotes) identifying the database key for the text
constant

FlsDateTime Object
This object displays the current date and/or time. The time is dynamically
updated every second. The format conforms to the current users locale setting.
The locale setting is changed through the Regional Settings function of Windows
NT.

Figure 51 - Gismo FlsDataTime

Variables to rename:
AlignX Horizontal alignment of text in the box. 1 = left, 2 = mid, 3 = right
DateOnly Display only current date (omit time).
TimeOnly Display only current time (omit date).
NoSecs Display only hours and minutes of time part (omit seconds).
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Color of text given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13

Generic route property text object


This object displays generic information for a route.

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
Property The route property. Use __Routexxx where xxx is the property.

32 ECS OpStation Editor

Reference Manual ECS OpStation Editor

RouteCode the code of the route.


SampleFreq number of seconds between update of value. 0 for every scan. 1
for static. (update only first time and on refresh all)

Generic group property text object


This object displays generic information for a group.

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
Property The group property. Use __Groupxxx where xxx is the property.
GroupCode the code of the Group.
SampleFreq number of seconds between update of value. 0 for every scan. 1
for static. (update only first time and on refresh all)

Generic department property text object


This object displays generic information for a group.

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
Property The department property. Use __Depxxx where xxx is the property.
DepCode the code of the department.
SampleFreq number of seconds between update of value. 0 for every scan. 1
for static. (update only first time and on refresh all)

Generic point property text object


This object displays generic information for a group.

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 33

EdgeColor Edge color of the box given as GMS color index.


TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
Property The point property. Use __Pointxxx where xxx is the property.
PointCode the code of the point.
SampleFreq number of seconds between update of value. 0 for every scan. 1
for static. (update only first time and on refresh all)

Creating OpenGMS Dynamics


OpenGMS dynamics is based upon the standard GMS concept of dynamic
properties associated an object. Dynamic properties are then enhanced by
functions, which provide data from the ECS database to drive the dynamics.

GMS Dynamic Properties


Dynamic properties (dynprop) are scripts that may be associated any object
drawn in the editor.
The basic elements are actions:
Action argument
The actions are fixed keywords and the argument is an expression containing
constants, variables or one of our OpenGMS functions.
Examples:
"fcolor 3" means that the fill color of the object shall be green (which is 3)
"fcolor FillColor" means that the fill color of the object is determined by the
value of a variable called FillColor. The actual value of this variable is defined
by rename variables when the object is instantiated in a picture.
"fcolor pntint(__COLOR, PointNo)" means that the fill color of the object is
determined by the OpenGMS function call pntint, which in this case will return
the actual color of the point PointNo as defined in the database. Again PointNo
is a variable the value of which is defined by rename variables when the object
is instantiated in a picture.
The following table lists the actions available in dynamic properties:
Action and argument type

34 ECS OpStation Editor

Description

ecolor int

edge color

estyle int

edge style 0 - no edge, 1 - solid, 2..4 - dotted

ewidth float

edge width

fcolor int

fill color

fstyle int

fill pattern 1..6 only relevant if finter = 2 or 3

finter int

fill interior 0 - hollow, 1 - solid, 2 - opaque, 3 - transp.

fdir int

fill direction 0 - up, 1 - right, 2 - down, 3 - left

fpercent float

fill percentage 0 .. 100

filled int

filled object 0 - not filled, 1 - filled

mcolor int

marker color

mstyle int

marker style 1 - period, 2 - +, 3 - *, 4 - o, 5 - x

tcolor int

text color

Reference Manual ECS OpStation Editor

theight float

text height

tpath int

text path (direction) 1 - right, 2 - down

tfont int

text font 1..13

tprec int

text precision 0 - TrueType, 1 - Hershey (not avail)

talign x (int) y(int)

text alignment x col - 1..3, y row - 1..5 ( center is 2 3)

stext int/float/string format

text content.
format:
"%d"

integer

"%5.2f" float with 5 digits before and 2 after dec. sep.


"%s"

string

detect int

detectability 0 - not detectable, 1 - detectable

vis int

visibility 0 - invisible, 1 - visible, 3 - forced update

move x(float) y(float)

move relative x - 0..100, y - 0..75

movex float

move relative in x direction

movey float

move relative in y direction

rotate float

rotate relative 0 .. 360 degrees

scale float

scale evenly

scalex float

scale horizontally

scaley float

scale vertically

radius float

radius of circles, pies and sectors

arclength float

angle for size of sectors or pies

startangle float

starting angle of sectors and pies

redraw

redraw without erasure

call function

call function (i.e. OpenGms function)

userword string

must not be used (reserved for classic dynamics)

userdata int

must not be used (reserved for classic dynamics)

There are three types of dynamic properties:


Unconditional
*
action argument

The actions are executed when the picture is loaded and then whenever any
variable in an argument changes. Furthermore, the use of an OpenGMS function
will automatically cause periodical execution of the action.
Conditional
1.
Variable expression
condition value
action argument

condition is one of =, !=, <=, >=, <, >


Example:
pntbit(__BIT_MSW, PointNo, 2)

Reference Manual ECS OpStation Editor

ECS OpStation Editor 35

=0
stext "OFF" "%s"
=1
stext "ON" "%s"
Above will set a text to "OFF" if bit 2 of MSW for PointNo is 0 and to "ON" if
0
2.
Variable expression
= *
action argument

The actions are executed whenever any variable in variable expression argument
changes. Using for example __VALUE as variable expression will ensure an
update at every scan. Using __COLV7STATIC will update the action when the
picture is loaded or refreshed.
3.
Variable expression
= value1:value2
action argument

The actions are executed if the variable expression lies in the range value1 to
value2
Input (click)
#
call function

The functions are called when clicking on the object.


Example:
#
call gms_push_btn_select())
call iosbitaction(PointNo, BitNo, BitVal, EventText, Confirm)
Above has two function calls. The first is a GMS function to change the look of
a button when pressed. The second is a FLSA function to send out a bit control
command to a PLC. The values of the variables in the function call are specified
by rename variables when the object is instantiated in a picture.

OpenGMS Functions
OpenGMS functions are functions that interact with the SDR system. They can
return data from the database or send an IO command to a PLC. These functions
may be used in expressions as part of dynamic properties.
Note that the function names are case sensitive.
The functions are described in the following.

36 ECS OpStation Editor

Reference Manual ECS OpStation Editor

The functions can be split into function returning information and action
functions.

Information Functions
Pointno Function
int pointno( PointCode )
returns the point number given the point code for a point. The function is used as
an auxiliary function when supplying point number arguments to the other
OpenGMS functions.
PointCode is point code as a text string (in double quotes)
Example:
pointno("j4p12")

Pntfloat Function
float pntfloat( ValueId, PointNo )
returns a floating point (real) value.
ValueId specifies the point attribute as shown in the following table
PointNo is point number of the controlling point.
Value Id

Description

__VALUE

Analog point value

__SYSHIGH

Analog point system high limit

__SYSLOW

Analog point system low limit

__GRAHIGH

Analog point operator high limit

__GRALOW

Analog point operator low limit

__HYSTERES

Analog point hysteresis

__INTERVAL

Analog point alarm interval size

__ALARMHIGH

Analog point alarm high limit

__ALARMLOW

Analog point alarm low limit

__NORMVALUE

Analog point normal value

__GAIN

Analog point gain

__OFFSET

Analog point offset

__CONST1

Analog point constant C1

__CONST2

Analog point constant C2

__CONST3

Analog point constant C3

__CONST4

Analog point constant C4

__CONST5

Analog point constant C5

__CONST6

Analog point constant C6

__CONST7

Analog point constant C7

__CONST8

Analog point constant C8

__CONST9

Analog point constant C9

__CONST10

Analog point constant C10

Examples:

Reference Manual ECS OpStation Editor

ECS OpStation Editor 37

__VALUE
=*
stext pntfloat(__ALARMHIGH, pointno("j4p12")) "%5.2f"
writes the high alarm limit for point j4p12 as text

Pntint Function
int pntint( ValueId, PointNo )
returns an integer value.
ValueId specifies the point attribute as shown in the following table
PointNo is point number of the controlling point.
Value Id

Description

__DEPARTMENT

Point-associated department number

__CONV_ALG

Point conversion algorithm

__EVENT_ALG

Point alarm algorithm

__REP_ALG

Point report algorithm

__EVENT_PNT

Alarm treatment suppression point

__REPORT_PNT

Report treatment suppression point

__INTERFACE

Interface (IO) type

__PRIORITY

Alarm priority

__COLOR

Point color number

__SYMBOLOFF

GMS symbol offset

__INT_STATUS

Point status word

__INT_STAAUX

Point aux status word

__INT_VALREF

Point value text number

__INT_STAREF

Point status text number

__ALARMLEVEL

Point alarm level

__MSW

Point Machine Status Word

__FILTER

Point filter time constant (seconds)

__FORMAT

Point format number

__REF_PNT1

Reference point 1

__REF_PNT2

Reference point 2

__REF_PNT3

Reference point 3

__REF_PNT4

Reference point 4

__REF_PNT5

Reference point 5

__REF_PNT6

Reference point 6

__REF_PNT7

Reference point 7

__REF_PNT8

Reference point 8

__REF_PNT9

Reference point 9

__REF_PNT10

Reference point 10

__UNITNO

Engineering unit number

Examples:

38 ECS OpStation Editor

Reference Manual ECS OpStation Editor

__VALUE
=*
tcolor pntint(__COLOR, pointno("j4p12"))
sets the text color to that of point j4p12.
__VALUE
=*
tcolor pntint(__COLOR, pntint(__REF_PNT2, pointno("j4p12")))
sets the text color to that of reference point 2 of point j4p12.

Pnttext Function
char* pnttext( ValueId, PointNo )
returns a text string.
ValueId specifies the point attribute as shown in the following table
PointNo is point number of the controlling point.
Value Id

Description

__DEP_NAME

Point department name

__POINTCODE

Point code

__POINTTEXT

Point text

__STATUSTEXT

Point status text

__VALUETEXT

Point value text

__UNITTEXT

Point engineering unit

Examples:
__COLV7STATIC
=*
stext pnttext(__POINTTEXT, pointno("j4p12")) "%s"
writes the point text (descriptor) for point j4p12. Will only be updated when the
picture is loaded or refreshed.

Pntbit Function
int pntbit( ValueId, PointNo, BitNo )
returns 0 or 1 as integer value.
ValueId specifies the point attribute as shown in the following table
PointNo is point number of the controlling point.
BitNo specifies the bit (0..15), the value of which is returned.
Value Id

Description

__BIT_MSW

Bit value in machine status word

Examples:
__VALUE

Reference Manual ECS OpStation Editor

ECS OpStation Editor 39

=*
stext pntbit(__BIT_MSW, pointno("j4p03"), 2) "%d"
writes the value of bit 2 in MSW for point j4p03 as text.

Pntvalue Function
pntvalue( ValueId, Object, PointNo )
This function sets an object to the current point value. The object must be a text
or text rectangle object. The value is formatted according to point format and the
color of the value is the point color. The function is a more powerful alternative
to pntfloat(__VALUE, PointNo).
ValueId must be the constant __VALUE.
Object must be the constant __self.
PointNo is point number of the controlling point.
Example:
__VALUE
=*
call pntvalue(__VALUE, __self, PointNo)
The value of the variable PointNo is determined by rename variables when the
object is instantiated.
Below is the full ..\gismos\pntval.g file for the ready-made pntval object. This
object uses openGMS functions pntvalue, pntunit and pntselect.
mtran0
vis 1
detect 1
pntval: model
. dynprop \
(# \
(call pntselect(__self, PointNo)))
unit: model
fcolor 22
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 7
estyle 0
ewidth 1
tcolor 7
height 1
path 1
font 1
prec 0
align 1 3
size 0 0
tconstraint 0
unittext: ftrect 3 0 0 2.5 "un"
. refpoint 0 0
vis 0
estyle 1
divide: line 0.3 1.25 2.5 1.25
. refpoint 0.119995 1.25
endm
vis 1
estyle 0
height 1.5
align 2 3
ftrect 0 2.5 8 0 "PntVal"
. dynprop
\
(__VALUE \
(= *
\
(call pntvalue(__VALUE, __self, PointNo))))
(AlignX \

40 ECS OpStation Editor

Reference Manual ECS OpStation Editor

(= *
\
(talign AlignX 3))) \
(FillColor \
(= *
\
(fcolor FillColor))) \
(Font \
(= *
\
(tfont Font)))
. refpoint 0 0
unit: inst unit 0 0
. dynprop
\
(__VALUE \
(= *
\
(call pntunit(__VALUE, __self, PointNo))))
(FillColor \
(= *
\
(fcolor FillColor))) \
(Font \
(= *
\
(tfont Font)))
. move 8 0
endm

Pntunit Function
pntunit( ValueId, Object, PointNo )
This function sets the engineering unit to that of the controlling point. The unit
will be shown as special GMS text as for the classic dynamic object pointval.
e.g. kg/m3 will be displayed as 3 lines in small size font to minimize the space
required for the unit. The color of the unit will be the point color. The object
must be like the gismo called unit with a text rectangle called unittext and a
line called divide (see below).
The function is a more sophisticated alternative to pnttext(__UNITTEXT,
PointNo), the latter writing the unit as single line plain text.
ValueId must be the constant __VALUE.
Object must be the constant __self.
PointNo is point number of the controlling point.
Example:
__VALUE
=*
call pntunit(__VALUE, __self, PointNo)
The object to which the function applies is shown below as an external gismo
unit (file ..\gismos\unit.g):
mtran0
vis 1
detect 1
unit: model
fcolor 22
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 7
estyle 0
ewidth 1
tcolor 7
height 1
path 1
font 1
prec 0
align 1 3
size 0 0

Reference Manual ECS OpStation Editor

ECS OpStation Editor 41

unittext: ftrect 3. 0. 0. 2.5 "un"


. refpoint 0 0
vis 0
estyle 1
divide: line 0.3 1.25 2.5 1.25
. refpoint 0.12 1.25
endm

For a full example see description of function pntvalue.

Plctext Function
char* plctext( ValueId, PointNo, ParameterKey )
Returns a PLC parameter as a text string.
ValueId is as specified in the table below.
PointNo is point number of the controlling point. This identifies address of the
PLC parameter block and the block algorithm that holds the description of the
parameter.
ParameterKey is the key identifying the PLC parameter (string) in the block
algorithm.
Value Id

Description

__PLCTXTPAR

Plc parameter is returned as ready


formatted string according to block
algorithm

__PLCCAPTEXT

The name of the PLC parameter is


returned

__PLCUNIT

Engineering unit from block algorithm

in the current language


returned as plain text

Examples:
__VALUE
=*
stext plctext( __PLCCAPTEXT, PointNo, Gain) %s
Above writes the name of the PLC parameter Gain as defined in the block
algorithm. The value of PointNo is determined by rename variables when the
object is instantiated.
__VALUE
=*
stext plctext( __PLCTXTPAR, PointNo, Gain) %s
Above writes the PLC parameter Gain in the format specified in the block
algorithm. The value of PointNo is determined by rename variables when the
object is instantiated.

Plcdouble Function
double plcdouble( ValueId, PointNo, ParameterKey )
Returns a double floating point PLC parameter.
ValueId must be the constant __PLCDBLPAR
PointNo is point number of the controlling point. This identifies address of the
PLC parameter block and the block algorithm that holds the description of the
parameter.

42 ECS OpStation Editor

Reference Manual ECS OpStation Editor

ParameterKey is the key identifying the PLC parameter (string) in the block
algorithm.
Example:
*
stext plcdouble( __PLCDBLPAR, PointNo, Gain) %5.2f
Above will get the floating point PLC parameter with key Gain as a double
and write it as a text string in format xxxxx.yy. The actual value of PointNo is
determined by rename variables when the object is instantiated.
Note. The function plctext can return the value as a text string formatted as
specified in the block algorithm.

Plcint Function
int plcint( ValueId, PointNo, ParameterKey )
Returns a PLC parameter as an integer. The parameter must be of type bit
pattern.
ValueId must be the constant __PLCINTPAR
PointNo is point number of the controlling point. This identifies address of the
PLC parameter block and the block algorithm that holds the description of the
parameter.
ParameterKey is the key identifying the PLC parameter (string) in the block
algorithm.
Example:
__VALUE
=*
stext plcint( __PLCINTPAR, PointNo, ParKey) %d
Above will get a PLC parameter identified by variable ParKey and write it as a
string. The value of PointNo and ParKey is determined rename variables when
the object is instantiated.

Plcunit Function
plcunit( Object, PointNo, ParameterKey )
This function sets the engineering unit to that of the block algorithm parameter.
The unit will be shown as special GMS text as for the classic dynamic object
pointval. e.g. kg/m3 will be displayed as 3 lines in small size font to minimize
the space required for the unit. The object must be like the gismo called unit
with a text rectangle called unittext and a line called divide (see below).
The function is a more sophisticated alternative to plctext(__PLCUNIT,
PointNo, ParameterKey), the latter writing the unit as single line plain text.
Object must be the constant __self
PointNo is point number of the controlling point. This identifies address of the
PLC parameter block and the block algorithm that holds the description of the
parameter.
ParameterKey is the key identifying the PLC parameter in the block algorithm.
Example:
__COLV7STATIC
=*
call plcunit( __self, PointNo, ParKey )

Reference Manual ECS OpStation Editor

ECS OpStation Editor 43

The value of PointNo and ParKey is determined rename variables when the
object is instantiated.
The object to which the function applies is shown below as an external gismo
unit (file ..\gismos\unit.g):
mtran0
vis 1
detect 1
unit: model
fcolor 22
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 7
estyle 0
ewidth 1
tcolor 7
height 1
path 1
font 1
prec 0
align 1 3
size 0 0
unittext: ftrect 3. 0. 0. 2.5 "un"
. refpoint 0 0
vis 0
estyle 1
divide: line 0.3 1.25 2.5 1.25
. refpoint 0.12 1.25
endm

For a full example see description of function plcedit.

Langtext Function
char* langtext( TextKey )
This function returns a text constant in current language. The functions apply to
a text or text rectangle object. The language texts are defined in the database
Flsadev\ProDb\
SdrOpsSpecialText10.mdb table LanguageTexts.
The function is used in the standard gismo LangText.
The purpose of the function is to allow text constants, which automatically will
be displayed, in the current language. The function is intended for FLSA use
only. The end customer should write text constants in his native language only.
An example using the function is the PidFace where all text constants are made
with langtext.
TextKey is text string identifying the text in the LanguageText table.
Example:
__COLV7STATIC
=*
stext langtext( "lngManual" ) "%s"

Abbreviationtext Function
char* abbreviationtext( TextKey )
This function returns a text abbreviation according to a currently selected set of
abbreviations. The functions apply to a text or text rectangle object. The
abbreviation
texts
are
defined
in
the
database
Flsadev\ProDb\SdrOpsSpecialText10.mdb table AbbreviationTexts.
The function is used in the standard gismo AbbreviationText.

44 ECS OpStation Editor

Reference Manual ECS OpStation Editor

The purpose of the function is to allow text, which will be displayed according to
a certain type of application. For a specific project the type is selected via ECS
OpStation Configuration utility sub function Abbreviations. The function is
intended for FLSA use only.
An example using the function is the ACESYS faceplates where all text
abbreviations are made with this function.
TextKey is text string identifying the text in the AbbreviationsTexts table.
Example:
__COLV7STATIC
=*
stext abbreviationtext( "GRP_GSEL" ) "%s"

Datetime Function
char* datetime( ValueId, DateOnly, TimeOnly, NoSecs )
Returns the current date and/or time in format defined by current users locale
setting.
The function is used in the standard gismo FlsDataTime.
ValueId is the constant that drives the updating of the time. Must be equal
__VALUE.
DateOnly =1 if only current date is returned, =0 otherwise
TimeOnly =1 if only current time is returned, =0 otherwise
NoSecs =1 if seconds shall be omitted from the time, =0 otherwise
example:
__VALUE
=*
stext datetime(__VALUE, 0, 0, 1)
will display date and time without seconds.
char* colv7datetime( cFormat )
Returns the time according to format specifiation where
cFormat Format specifikation
%a Abbreviated weekday name
%A Full weekday name
%b Abbreviated month name
%B Full month name
%c Date and time representation appropriate for locale
%d Day of month as decimal number (0131)
%H Hour in 24-hour format (0023)
%I Hour in 12-hour format (0112)
%j Day of year as decimal number (001366)
%m Month as decimal number (0112)
%M Minute as decimal number (0059)
%p Current locales A.M./P.M. indicator for 12-hour clock

Reference Manual ECS OpStation Editor

ECS OpStation Editor 45

%S Second as decimal number (00 59)


%U Week of year as decimal number, with Sunday as first day of week (0053)
%w Weekday as decimal number (0 6; Sunday is 0)
%W Week of year as decimal number, with Monday as first day of week (00-53)
%x Date representation for current locale
%X Time representation for current locale
%y Year without century, as decimal number (00 99)
%Y Year with century, as decimal number
%z,%Z Time-zone name or abbreviation; no characters if time zone is unknown
%% Percent sign
example:
__VALUE
=*
stext colv7datetime(%H:%M:%S )

extxxx functions
long extlong (Server, Type, Key1, Key2)
double extdouble (Server, Type, Key1, Key2)
char *exttext (Server, Type, Key1, Key2)
These functions return a long, double or a text from an external server
respectively.
Server server name configured in OpStation Configuration.
Type value type. See table below.
Key1 first part of the parameter key.
Key2 second part of the parameter key.
Function

46 ECS OpStation Editor

Type

Sample frequency

Extlong

__EXTLONG

Sample every 4 seconds

extlong

__EXTLONG1

Sample every second

extlong

__EXTLONG2

Sample every 2 seconds

extlong

__EXTLONG3

Sample every 3 seconds

extlong

__EXTLONG4

Sample every 4 seconds

extlong

__EXTLONG5

Sample every 5 seconds

extdouble

__EXTDOUBLE

Sample every 4 seconds

extdouble

__EXTDOUBLE1

Sample every second

extdouble

__EXTDOUBLE2

Sample every 2 seconds

extdouble

__EXTDOUBLE3

Sample every 3 seconds

extdouble

__EXTDOUBLE4

Sample every 4 seconds

extdouble

__EXTDOUBLE5

Sample every 5 seconds

exttext

__EXTTEXT

Sample every 4 seconds

exttext

__EXTTEXT1

Sample every second

exttext

__EXTTEXT2

Sample every 2 seconds

exttext

__EXTTEXT3

Sample every 3 seconds

Reference Manual ECS OpStation Editor

exttext

__EXTTEXT4

Sample every 4 seconds

exttext

__EXTTEXT5

Sample every 5 seconds

exttext

__EXTTEXT

Sample every 4 seconds

All

__SAMPLEFAST

Every time the picture is updated.

All

__SAMPLESLOW

Sample every 10 seconds

All

__STATICVALUE

First time and then on Refresh All.

colv7getgeneric functions
char* colv7getgenericstrlkey(ObjectType, lKey, Property, SampleFreq)
char* colv7getgenericstr(ObjectType, strKey, Property, SampleFreq)
double colv7getgenericdouble(ObjectType, strKey, Property, SampleFreq)
long colv7getgenericlong(ObjectType, strKey, Property, SampleFreq)
These function raps the PointAuto interface to get any value return as a char,
long, or double
ObjectType One of the four object types in the Point Auto.
__DepartmentObject, __GroupObject, __RouteObject, or
__PointObject.
lKey long key. Number of object.
sKey String key. Code of object.
Property Property in object. All relevant properties from PointAuto.
flsSomething is replaced with __Something. I.e. the property flsGroupColor
will be __GroupColor.
SampleFreq The update rate in number of seconds. 0 means every update. 1
means that it is static, and the value will only be updated on refresh all in
OpStation.

Colv7format function
char * colv7format(dValue, lFormat)
This function returns a string format of the value with the current regional
settings.
dValue Double value.
lFormat number of decimal points
__VALUE
=*
stext colv7format(pntfloat(__VALUE, PntNo1), pntint(__FORMAT,PntNo2))
Will print the value of PntNo1 formatted as PntNo2.

Colv7ConCat function
char * colv7concat(sString1, sString2)
This function returns a concatenated string of sString1 and sString2.

Colv7uacright function
long colv7uacright(Right)
This function returns 1 if the user has this particular right else it returns zero.
The prefix in the rights table needs to be Ops

Reference Manual ECS OpStation Editor

ECS OpStation Editor 47

Right the right key.

Action functions
Action functions are normally called Upon input, but the new version 7
functions can also be called on parameter change. The version 6 functions have a
filter so they only react on left mouse button release.

Pntselect Function
pntselect( Object, PointNo )
This function makes the object and the point the selected object and point when
clicked upon.
The object is surrounded by a white rectangle and point information is set in the
status bar panes. When right clicking on the object a popup menu will appear.
Object identifies the object. This argument must be the constant __self.
PointNo is point number of the controlling point.
Example:
#
call pntselect(__self, PointNo)
The value of the variable PointNo is determined by rename variables when the
object is instantiated.

Pntedit Function
pntedit( Object, PointNo )
This function allows for entering and sending an output value to IO system. The
function must be part of input dynamics of an object. This object must have two
text rectangles of same size on top of each other. First must be called
valuefield and displays the current value. The second must be called
editfield and is used when entering a value. A click on the main object will
make the edit field visible. The user enters a value and press of return on
keyboard will send the entered value to IO system. The value field then again
becomes visible.
Object must be __self.
PointNo is point number of the controlling point.
Example:
#
call pntedit( __self, PointNo )
Below is the full ..\gismos\pntvalent.g file for the ready-made pntvalent object.
This object uses openGMS function pntedit.
mtran0
vis 1
detect 1
pntvalent: model
. dynprop \
(# \
(call pntselect(__self, PointNo))
(call pntedit(__self, PointNo)))
unit: model

48 ECS OpStation Editor

Reference Manual ECS OpStation Editor

fcolor 22
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 7
estyle 0
ewidth 1
tcolor 7
height 1
path 1
font 1
prec 0
align 1 3
size 0 0
tconstraint 0
unittext: ftrect 3 0 0 2.5 "un"
. refpoint 0 0
vis 0
estyle 1
divide: line 0.3 1.25 2.5 1.25
. refpoint 0.119995 1.25
endm
vis 1
estyle 0
height 1.5
align 2 3
value: ftrect 0 2.5 8 0 "PntValE"
. dynprop
\
(__VALUE \
(= *
\
(call pntvalue(__VALUE, __self, PointNo)))) \
(AlignX \
(= *
\
(talign AlignX 3))) \
(FillColor \
(= *
\
(fcolor FillColor))) \
(Font \
(= *
\
(tfont Font)))
unit: inst unit 0 0
. dynprop
\
(__VALUE \
(= *
\
(call pntunit(__VALUE, __self, PointNo)))) \
(FillColor \
(= *
\
(fcolor FillColor))) \
(Font \
(= *
\
(tfont Font)))
. move 8 0
vis 0
edit: ftrect 0 2.5 8 0 ""
. dynprop
\
(AlignX \
(= *
\
(talign AlignX 3))) \
(__EDITFINISH \
(= *
\
(call editfinish(__EDITFINISH, __self))))
. refpoint 0 0
endm

Pntupdownpercent Function
pntupdownpercent(PointNo, PercentChange, ManModeMask,
ManModeValue, Confirm)
pntupdownpercentv7(PointNo, PercentChange, ManModeMask,
ManModeValue, Confirm, Ignore)

Reference Manual ECS OpStation Editor

ECS OpStation Editor 49

Change a point value with a given percentage. This function behave in a special
way when applied to a set point because the change will affect the output point
related to the set point if the mode related to the set point is manual.
PointNo Point number of controlling point
PercentChange percentage of the points system range to raise or lower the
current value
ManModeMaskBits mask bits of MSW for manual mode given as a integer
(may be hex). e.g. 10 (or 0x000a) means bit 1 and bit 3 defines manual mode.
Defines the bits that must be tested to determine manual mode.
ManModeValueBits value bits of MSW for manual mode given as integer (may
be hex). Defines the values of the bits given by the mask that determines manual
mode. e.g. 2 (or 0x0002) means that with the above mask given manual mode is
defined as bit 1 = 2 and bit 3 = 0.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Iosbitaction Function
iosbitaction( PointNo, BitNo, BitVal, EventText, Confirm )
iosbitactionv7( PointNo, BitNo, BitVal, EventText, Confirm , Ignore)
This function sends a bit control action to IO system. Iosbitaction only reacts on
left mouse release action, while the iosbitactionv7 reacts on any call if ignore is
set to 1.
PointNo is point number for point to which action applies
BitNo specifies the output bit number (0..15)
BitVal specifies the output value (0 or 1)
EventText a text string (in double quotes) for the event line generated by the
action
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)
Example:
#
call iosbitaction( PointNo, BitNo, BitVal, EventText, Confirm)
Above function will be called when user clicks on the object with the left mouse
button when the mouse button is released. The values of the variables PointNo,
BitNo, BitVal, EventText, Confirm are determined by rename variables when
the object is instantiated.
Example v7.
#
call gms_flash()
(__button_hilite == 0) && (__locator != 0)
!= 0
iosbitactionv7( PointNo, BitNo, BitValRelease,
EventTextRelease, 0, 1)
(__button_hilite == 1) && (__locator != 0)
!= 0
iosbitactionv7( PointNo, BitNo, BitValPress,
EventTextPress, 0, 1)

50 ECS OpStation Editor

Reference Manual ECS OpStation Editor

In the above v7 example the action will be called with the value of BitValPress
when the user clicks on the object and with the value BitValRelease when the
mouse button is released. The values of the variables PointNo, BitNo,
BitValPress, BitValRelease, EventTextRelease, EventTextPress are determined
by rename variables when the object is instantiated.

Iosbittoggle Function
iosbittoggle ( PointNo, OutBitNo, InBitNo, EventText, Confirm)
iosbittogglev7 ( PointNo, OutBitNo, InBitNo, EventText, Confirm, Ignore)
This function sends a bit control action to IO system. It sets the output bit to the
opposite of what is read in the input bit. iosbittoggle only reacts on left mouse
release action, while the iosbittogglev7 reacts on any call if ignore is set to 1.
PointNo is point number for point to which action applies
OutBitNo specifies the output bit destination (0..15)
InBitNo specifies the input bit to toggle. (0..15)
EventText a text string (in double quotes) for the event line generated by the
action.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Iosbitpulse Function
iosbitpulse (IdType, Object, PointNo, OutBitNo, InBitNo, First, EventText,
Confirm,)
iosbitpulse1 (IdType,
Object,
PointNo, OutBitNo, InBitNo, First,
EventText, Confirm, TimeOutSecs)
iosbitpulsev7 (IdType, Object, PointNo, OutBitNo, InBitNo, First,
EventText, Confirm, TimeOutSecs , Ignore)
This function is used as a two-step function. The first action is to set the output
bit to 1 and start the timer. If the input bit has changed to 1 within the timeout
period the output bit is set to 0. If the first two version 6 functions are used it
demands a call Upon input where first is set to 1 and an Unconditional
action. In order make the back action. Iosbitpulse has a timeout of 15 seconds.
IdType Used to force update for supervision. (Use __VALUE)
Object must be the constant __self.
PointNo is point number for point to which action applies
OutBitNo specifies the output bit destination (0..15)
InBitNo specifies the input bit to toggle. (0..15)
First , 1 = first call, 0 = supervision call
EventText , Text for event log
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
TimeOutSecs, No of seconds to wait for 1 to be set before give up
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)
The fls_m_bitpulse uses this function and looks as follows:

Reference Manual ECS OpStation Editor

ECS OpStation Editor 51

mtran0
vis 1
detect 1
fls_m_bitpulse: model
. dynprop \
(# \
(call gms_push_btn_select()) \
(call iosbitpulse(__VALUE, __self, PointNo, OutBitNo,
InBitNo, 1, EventText1, Confirm))) \
(* \
(call iosbitpulse(__VALUE, __self, PointNo, OutBitNo,
InBitNo, 0, EventText0, 0)))
. batcherase 1
. refpoint 0 0
frame: group
. dynprop
\
(extent_width \
(= *
\
(call gms_rect_size(extent_width, extent_height, 2, 0.0))))
fcolor 13
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 14
estyle 0
ewidth 0
tcolor 7
height 1.5
path 1
font 1
prec 1
align 2 3
size 0 0
plate: ftrect 10 4 0 0 "BitPulse"
. dynprop \
(button_label \
(= * \
(stext button_label "%s"))) \
(font \
(= * \
(tfont font)))
fcolor 12
ecolor 15
estyle 1
lower: line 0 0 10 0 10 4
fcolor 15
ecolor 12
upper: line 0 0 0 4 10 4
endg
vis 0
fcolor 13
fstyle 8
finter 3
ecolor 13
estyle 0
shield: frect 1 1 0 0
endm

Iosbitsetcond Function
iosbitsetcond (PointNo, OutBitNo, OutBitVal, InBitNo, InBitVal,
EventText, Confirm)
iosbitsetcondv7 (PointNo, OutBitNo, OutBitVal, InBitNo, InBitVal,
EventText, Confirm, Ignore)
Send a bit action to OutBitNo if value of current InBitNo is InBitVal.
PointNo is point number for point to which action applies
OutBitNo specifies the output bit destination (0..15)
OutBitVal output value (0 or 1)
InBitNo specifies the input bit to toggle. (0..15)

52 ECS OpStation Editor

Reference Manual ECS OpStation Editor

InBitVal conditional input value (0 or 1)


EventText , Text for event log
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Iospbsetpoint Function
iospbsetpoint(PointNo, Value)
iospbsetpointv7(PointNo, Value, Ignore)
This function requests the value of PointNo to be changed to value.
PointNo is point number for point to which action applies
Value new value of the point.
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Plcbitset Function
plcbitset( PointNo, ParameterKey, BitVal, Confirm)
plcbitsetv7( PointNo, ParameterKey, BitVal, Confirm, Ignore)
This function sends a request to set the bit corresponding to the parameter key of
the block algorithm for the point.
PointNo is point number for point to which action applies
ParameterKey is the block table entry key.
Bitval the value of the bit to set.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Plcbitsetcond Function
plcbitsetcond(PointNo, ParameterKey, OutBitVal, InBitVal, Confirm)
plcbitsetcondv7(PointNo, ParameterKey, OutBitVal, InBitVal, Confirm,
Ignore)
Sends OutBitVal to PLC parameter if read bit value = InBitVal.
PointNo is point number for point to which action applies
ParameterKey is the block table entry key.
OutBitVal output value (0 or 1)
InBitVal conditional input value (0 or 1)
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Reference Manual ECS OpStation Editor

ECS OpStation Editor 53

Plcbittoggle Function
plcbittoggle(PointNo, ParameterKey, Confirm)
plcbittogglev7(PointNo, ParameterKey, Confirm, Ignore)
This function sends a request to toggle the bit corresponding to the parameter
key of the block algorithm for the point.
PointNo is point number for point to which action applies
ParameterKey is the block table entry key.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Plcedit Function
plcedit( ValueId, Object, PointNo, ParameterKey )
This function allows for entering and sending an output PLC parameter to IO
system. The function must be part of input dynamics of an object. This object
must have two text rectangles of same size on top of each other. First must be
called valuefield and displays the current value. The second must be called
editfield and is used when entering a value. A click on the main object will
make the edit field visible. The user enters a value and press of return on
keyboard will send the entered value to IO system. The valuefield then again
becomes visible.
Note. plcedit requires that the 'allow write' is set in the block algorithm for the
PLC parameter.
ValueId is as specified in the table below
PointNo is point number of the controlling point. This identifies address of the
PLC parameter block and the block algorithm that holds the description of the
parameter.
ParameterKey is the key identifying the PLC parameter (string) in the block
algorithm.
Value Id

Description

__PLCDBLPAR

Edit a Plc parameter of type double

__PLCINTPAR

Edit a Plc parameter of type integer,


unsigned or bit pattern

Example:
#
call plcedit(__PLCDBLPAR, __self, PointNo, ParKey )
Above allows edit of a floating point PLC parameter when clicking on the
object. The value of PointNo and ParKey is determined rename variables when
the object is instantiated.
Below is the full ..\gismos\plcvalent.g file for the ready-made plcvalent object.
This object uses openGMS function plcedit.
mtran0
vis 1
detect 1

54 ECS OpStation Editor

Reference Manual ECS OpStation Editor

plcvalent: model
. dynprop \
(# \
(call
plcedit(__PLCDBLPAR,
ParameterKey)))
unit: model
fcolor 22
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 7
estyle 0
ewidth 1
tcolor 7
height 1
path 1
font 1
prec 0
align 1 3
size 0 0
tconstraint 0
unittext: ftrect 3 0 0 2.5 "un"
. refpoint 0 0
vis 0
estyle 1
divide: line 0.3 1.25 2.5 1.25
. refpoint 0.119995 1.25
endm
vis 1
estyle 0
height 1.5
align 2 3
value: ftrect 0 2.5 8 0 "PlcValE"
. dynprop
\
(__PLCTXTPAR \
(= *
\

__self,

PointNo,

(stext plctext(__PLCTXTPAR, PointNo, ParameterKey) "%s")))

(AlignX \
(= *
\
(talign AlignX 3))) \
(FillColor \
(= *
\
(fcolor FillColor))) \
(Font \
(= *
\
(tfont Font))) \
(TextColor \
(= *
\
(tcolor TextColor)))
unit: inst unit 0 0
. dynprop
\
(__PLCTXTPAR \
(= *
\
(call plcunit(__self, PointNo, ParameterKey))))
(FillColor \
(= *
\
(fcolor FillColor))) \
(Font \
(= *
\
(tfont Font))) \
(TextColor \
(= *
\
(tcolor TextColor)))
. move 8 0
vis 0
edit: ftrect 0 2.5 8 0 ""
. refpoint 0 0
endm

ExtSetxxx function
extsetlong(Server, Type, Key1, Key2, lValue, Confirm)
extsetdouble(Server, Type, Key1, Key2, dValue,Confirm)

Reference Manual ECS OpStation Editor

ECS OpStation Editor 55

extsettext(Server, Type, Key1, Key2, Text,Confirm)


extsetlongv7( Server , Type, Key1, Key2, lValue, Confirm, Ignore)
extsetdoublev7( Server, Type, Key1, Key2, dValue, Confirm, Ignore)
extsettextv7( Server, Type, Key1, Key2, sText, Confirm, Ignore)
These function is used to set values in an external server.
Key1 is concatenated with Key2 to form the key parameter in the external server.
Server server name configured in OpStation Configuration.
Type value type irrelevant in this case.
Key1 first part of the parameter key.
Key2 second part of the parameter key.
lValue long value to set.
dValue double value to set.
sText text value to set.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Extedit function
extedit (Server, Type, Object, Key1, Key2)
This function is allows the user to edit an external parameter.
Server server name configured in OpStation Configuration.
Type value type __EXTLONG, __EXTDOUBLE, __EXTTEXT
Object must be __self.
Key1 first part of the parameter key.
Key2 second part of the parameter key.

ExtActivate function
extactivate( DbName, TableName, Param, MenuItem, Confirm)
extactivatev7( DbName, TableName, Param, MenuItem, Confirm, Ignore)
This function activates an external program defined in database DbName in
table TableName as entry number MenuItem with one text parameter given as
Param.
DbName name of database where to find classID of external program.
TableName name table where to find definition.
Param text parameter to pass to the external program.
MenuItem numbered ID in table.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

56 ECS OpStation Editor

Reference Manual ECS OpStation Editor

ExtMenu function
ExtMenu (Object, DbName, sTableName, Param, P1, P2, P3, P4, P5,
P6, P7, P8, P9, P10, P11, P12, P13, P14, P15 )
This function activates a menu on right click release, where the menu items can
activate an external function. The menu is defined by entries in table
TableName.
DbName name of database where to find classID of external program.
TableName name table where to find definition.
Param text default parameter to pass to the external program.
P1 P15 individual arguments for each function, if specified overrides Param.

ColModelInvoke Function
ColModelInvoke( ModelName )
This function will replace the current picture with a new one. The function is
normally used as an input function in response to a button click. React only to
left mouse button release.
ColModelInvokeV7(ModelName, Ignore)
Same as above but with Ignore = 1 react to any input.
ModelName is name (double quoted string) of new picture
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)
Example:
#
call ColModelInvoke( "raw_mill")

ColNewWindowInvoke Function
ColNewWindowInvoke( ModelName )
ColNewWindowInvokeV7(ModelName, Ignore)
This functions handles invocation of a new free-floating window.
ModelName is name (double quoted string) of new picture
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

ColGenPopUpInvoke Function
ColGenPopUpInvoke( ModelName, PointNo )
This function pops up a new window with a given picture. It may also popup a
faceplate for a given point. The function is normally used as an input function in
response to a button click. React only to left mouse button release.
ColGenPopUpInvokeV7( ModelName, PointNo , Ignore)
Same as above but with Ignore = 1 react to any input.
ModelName is name (double quoted string) of picture or faceplate to pop up.
PointNo is point number of activation point in sake of a faceplate. Must be = 0
for an ordinary popup picture.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 57

Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)
Example:
#
call ColGenPopUpInvoke( "raw_mill_popup", 0)

Facepopupio(FacePlateNameSuffix, lPointNo )
facepopupio( FacePlateNameSuffix, PointNo )
facepopupiov7(FacePlateNameSuffix, PointNo, Ignore )
This function popup a faceplate prefixed with the IO system prefix.
FacePlateNameSuffix is name to append to the prefix of the IOsys (double
quoted string) of picture or faceplate to pop up.
PointNo is point number of activation point in sake of a faceplate. Must be = 0
for an ordinary popup picture.
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

StartProcess function.
startprocess( Program, P1, P2, P3, P4, P5, Confirm)
startprocessv7( Program, P1, P2, P3, P4, P5, Confirm, Ignore)
This program starts a program.
Program full program path and name of program.
P1..P5 text parameters to pass to the program.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

ShowTrend function.
showtrend (TrendPackNo)
showtrendv7 (TrendPackNo, Ignore)
Shows a trend package.
TrendPackNo number of trend package to show.
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Showbrowser function.
showbrowser( Function, Code, View, Ignore )
showbrowserbyno( Function, No, View, Ignore )
This function shows the SdrBrowserUI either starting out with a department,
point, group, or route, and one of the three possible views.
Function telling what kind of Code or number is passed. __ShowDepartment,
__ShowPoint, __ShowRoute or __ShowGroup.
Code the code of the point, department, group, or route.
No the number of the point, department, group, or route.

58 ECS OpStation Editor

Reference Manual ECS OpStation Editor

View "EVENTLIST" , "POINTLIST" or "POINTGRID"


Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Colv7executecommand function
colv7executecommand(CommandID, Ignore)
This functions emulates a toolbar button press.
CommandID See the table
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)
CommandID

Action

__ID_FILE_TOPMODEL

Open Top model

__ID_FILE_OPEN

Open Graphic

__ID_FILE_PRINT_CLIENT

Print Graphic

__ID_CONTROL_SELECT

Send select command to PLC for selected


group or device. The devices selected in
this manner are affected by a subsequent
start or stop command.

__ID_CONTROL_START

Send start command for all selected


groups and devices

__ID_CONTROL_STOP

Send stop command for all selected


groups and devices

__ID_CONTROL_QUICKSTOP

Send quick stop command for the current


department. All equipment will be stopped
immediately

__ID_CONTROL_MASTERSTOP

Send master stop command for the current


department. All equipment will be stopped
in a manner described by the PLC
program

__ID_ALARM_SILENCE

Turn off the audible alarm for the current


department

__ID_ALARM_RESET

Reset all alarms for the current department

__ID_ALARM_DEPLIST

Open the alarm list for the current


department

__ID_ALARM_POINTLIST

Open the alarm list for the selected point

__ID_ALARM_GROUP_POINTSTATUS

Open the alarm status list for the selected


points owner group.

__ID_TREND_PACKAGE

Open the SDR Trend display

__ID_TREND_POINT

Open the SDR Trend display with the


selected point assigned to the trend group

__ID_POINT_LIST

Open the SDR Point List

__ID_POINT_LIST_ADD_FAVOURITE

Add the selected point to the favorite


points

__ID_POINT_PARAMETERS

Open the SDR Point Parameter display for


the selected point

__ID_POINT_CONFIG

Open the SDR Point Configuration


display for the selected point

__ID_NOTEPAD

Open the ECS Note Pad and display notes


for the selected point

__ID_HELP

Open the online help file

Reference Manual ECS OpStation Editor

ECS OpStation Editor 59

Making Dynamics in Editor


It is possible to program picture objects in order to obtain the desired dynamic
visualization. After selecting an object in the editor, dynamic properties can be
added in two ways:
1. Object dynamics properties
Selecting pull down menu Dynamics -> Object dynamics properties or right
clicking and selecting Edit Dynamics in the popup menu will bring up a box
where there are buttons to guide you through the process of defining dynamics.
In the Edit Raw tab is possible to enter or correct dynamics directly.

To be guided through, use the tabs to enter the different types of dynamics. The
box is used to enter dynamic properties of the three types Unconditional,
Conditional and Upon input, the window outlook depends on the dynamic type
selected.
Unconditional action.

60 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Figure 52 - Enter dynamics box for unconditional action

Enter information as follows:

Select dynamic type as Unconditional action

For each new action press

Action. Select the dynamic action from the drop down list

Argument. Click the empty argument field (text edit field). Fill in
the argument by typing or better use Special Get button for
entering an point related OpenGMS function, a PLC related
OpenGMS function or a GMS color index. For an action with two
arguments (like stext) make sure to enter both arguments ( for stext
type in format as second argument).

Press OK to evaluate and accept the entered dynamic properties.

To delete a dynamic action press


To navigate among multiple actions use buttons

and

Pressing Get Point related will bring up the following box:

Reference Manual ECS OpStation Editor

ECS OpStation Editor 61

Figure 53 - Get point related function box

Fill in as follows:

Controlling point. If this shall be a variable to be renamed upon


instantiation then check Use as variable and type the name of the
variable in the text edit field. If controlling point shall be an actual
point, then uncheck Use as variable, click the text edit field and
use the tool bar buttons

to enter a point code.

Reference point. If the point shall be one of the 10 reference


points of the controlling point, select one from the drop down list.

Value type Select one of the types (resulting in one of the four
functions pntfloat, pntint, pnttext, pntbit).

Value Select the attribute (Value id) from the drop down list. The
list of available attributes depends on the Value type.

Press OK to enter the information in the argument text field of the


Edit Dynamics box. The example shown will generate the
argument text "pntfloat(__ALARMHIGH, PointNo)"

Conditional action

62 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Figure 54 - Enter dynamics box for conditional action

Enter information as follows:

Select Dynamic type as Conditional action

For each new Variable expression press outermost

Variable expression. Click text field and fill in by typing or use


Special Get

For each new Condition press middle

Condition. Select condition from drop down list

Condition expression. Click text field and fill in by typing or use


Special Get

For each new Action press innermost

Action. Select action from drop down list

Action expression. Click text field and fill in by typing or use


Special Get

Press OK to evaluate and accept the entered information.

To delete an item press corresponding


To navigate among multiple items use buttons

Reference Manual ECS OpStation Editor

and

ECS OpStation Editor 63

Upon input

Figure 55 - Enter dynamics box for input action

Enter information as follows:

Select Dynamic type as Upon input

For each new input action press

Input action. Click the text field and type in a function call. See
the section on OpenGMS functions for available input function
calls.

Press OK to evaluate and accept the entered information.

To delete an item press corresponding


To navigate among multiple items use buttons

and

PntFloat Example
In this example we will create a new dynamic sub model (gismo), which can
display the value of any of the floating-point attributes of a point.

64 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Figure 56 - Gismo PntFloat

The following variables shall be determined by Rename variables when the sub
model is instantiated in a picture:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
EdgeColor Edge color of the box
FillColor Fill color of the box
TextColor Text color
Font Text font
PointNo Point number of the controlling point.
ValueId Floating point attribute of point to display (e.g. __ALARMHIGH)

Creating pntfloat
The sub model is created as follows:
In the editor select menu File -> new
Model properties. The default model properties are with dark blue background
enabled and model size 100 * 75. As we want our model to be a text rectangle of
size 10 * 2.5 we must change the model properties as follows:

Select menu Model -> Properties ..

In the model properties box displayed uncheck Background on (to


have the background removed) and press Apply and Close.

If the blue background does not disappear (GMS error), click in the
background and press delete on keyboard. Now you should have a
white working area.

Create statics. We now create the static part of the sub model as follows:

Click the toolbar button for text rectangle

Select menu Point -> Enter Point ..

In the Enter Point box displayed type 0 0 and press Apply. Then
type 10 2.5 and press Apply again and the Close. You should now
have a text rectangle in the lower left part of the working area.

Type the text "PntFloat" in the text rectangle, then right click and
select Done from popup menu. The object should now be selected
indicated by a frame.

Right click and select Graphic Properties from the popup menu.

In the graphics properties box select the fill color 22 and close the
box.

Create dynamics. We now add dynamic properties to the object as follows:

Select menu Dynamics -> Enter Dynamics

Using the Enter Dynamics box create the following Conditional


actions (and close the box by OK):

ValueID
=*

Reference Manual ECS OpStation Editor

ECS OpStation Editor 65

stext pntfloat(ValueId, PointNo) "%s5.2f"


EdgeColor
=*
ecolor EdgeColor
FillColor
=*
fcolor FillColor
TextColor
=*
tcolor TextColor
Font
=*
tfont Font
AlignX
=*
talign AlignX 3
Save model. We now save the model as a gismo as follows:

Select menu File -> Save

In the file save box displayed select directory FlsaGmsPic\Gismos


Then enter file name pntfloat and press Save. The sub model
should now automatically be saved as two files pntfloat.g (source
file) and pntfloat.m1(runtime file).

The source file generated now looks as follows:


mtran0
vis 1
detect 1
pntfloat: model
fcolor 22
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 7
estyle 1
ewidth 1
tcolor 7
height 2
path 1
font 1
prec 0
align 2 3
size 0 0
ftrect 0 0 10 2.5 "PntFloat"
. dynprop \
(ValueId \
(= * \
(stext pntfloat(ValueId, PointNo) "%5.2f")))
(AlignX \
(= * \
(talign AlignX 3))) \
(FillColor \
(= * \
(fcolor FillColor))) \
(EdgeColor \
(= * \
(ecolor EdgeColor))) \
(TextColor \
(= * \
(tcolor TextColor))) \
(Font \
(= * \
(tfont Font)))

66 ECS OpStation Editor

Reference Manual ECS OpStation Editor

endm

Using pntfloat
We may now use the new sub model in a picture to display the low and high
alarm limits for the point j4p12.
In the editor create a new picture or load an existing one.
Instantiate sub model:
Select menu Palette -> Submodels ..
In the Sub model List box displayed locate and click on pntfloat, then click on
first position in picture where pntfloat shall be displayed, then on second
position, then right click and select Done from popup menu.
Close the sub model list by OK. You should now have two instances of pntfloat.
Rename Variables:
Left click the first instance to select it, then right click and select Rename
Variables from the popup menu. fill in the variables as follows (and close the
box by OK):
AlignX 3
EdgeColor 7
FillColor 22
Font 1
PointNo pointno("j4p12")
TextColor 7
ValueId __ALARMLOW
Left click the second instance to select it, then right click and select Rename
Variables from the popup menu. fill in the variables as follows (and close the
box by OK):
AlignX 3
EdgeColor 7
FillColor 22
Font 1
PointNo pointno("j4p12")
TextColor 7
ValueId __ALARMHIGH
Save the picture.
The picture will now display the low alarm limit for the point j4p12 in the first
object and the high alarm limit in the second object. The values will be right
aligned black text in Arial normal font, the text rectangle will have a black edge
and a gray fill color. The values will be displayed in floating point format
xxxxx.yy.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 67

Faceplates
Faceplates are sub models where all the dynamics are related to an activation
point. In OpStation a faceplates is activated by right click on a point and then
selecting Faceplate from the popup menu. A window with the faceplate will
then pop up. The dynamics on the faceplate will relate to the point you clicked
upon. An example of a faceplate is the PIDFace, which is discussed in the
section "PIDFace example".

Creating Faceplates
When creating new faceplates the following guidelines should be observed.:
Location of faceplates files.
Faceplates must reside in directory
FlsaGmsPic\Faceplates So when saving a faceplate in the editor make sure to
select this directory.
Model properties of faceplates. Faceplates do not have the standard model size
and background color. So when starting a new faceplate select menu Model ->
Properties .. and change background color and rectangle size in the model
properties box. If the size of the work area does not change after this, save the
model and reload it again (GMS peculiarity).
Dynamics. Preferably use OpenGms dynamics (palettes opengms_dynamics_1
and opengms_dynamics_2). This will allow you also to instantiate a faceplate
directly in a standard mimic picture. For such an imbedded faceplate you use
Rename variables to assign a point number for the variable $. You may use
classic dynamics in a faceplate, but in that case you will not be able instantiate
the faceplate directly in a mimic, but only use it as a popup faceplate.
PointNo use $. When binding variables by rename variables The point number
variable should be set to $ as a placeholder for the activation point. The correct
point number will then be substituted upon activation of the faceplate. If you use
classic dynamics, the object owner should also be set to $ for the same reason.

Assigning Faceplates
Once a faceplate has been created you must determine to which class of
activation points the faceplate shall be assigned. There are two ways of doing
this.
Assign faceplate to point algorithm. This is done using the ECS OpStation
Configuration utility. Here you assign the name of the faceplate to one or more
A- or B-point algorithms. All points having one of these algorithms will then by
default use the assigned faceplate.
Assign faceplate to picture object owner. When you assign an owner to a
classic dynamic object in a mimic picture you may in the same box assign a
faceplates (select one from dropdown list). If you do so the assigned faceplate
will apply to that specific object in the picture. This kind of assignment will
overrule the assignment by point algorithm.

PIDFace Example
In the following we will illustrate how the PIDFace is constructed. The figures
below show the PIDFace as it looks in the editor and as it looks at runtime in
OpStation. The PIDFace is exclusively made of OpenGMS dynamics. We go
through the dynamics an explain the Rename variables setting for Point
Numbers.

68 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Figure 57 - PIDFace left in editor and right in application

The activation points for the PIDFace are points with a set point algorithm. The
PIDFace not only shows information directly for the set point, but also for points
related to the set point (reference points). Therefore it is required that the set
points have the following reference points attributes defined (see Point
Configuration):
Reference point 1: Process point

Reference Manual ECS OpStation Editor

ECS OpStation Editor 69

Reference point 2: Output point


Reference point 4: Control mode point
Reference point 7: Auxiliary point (optional)
Point number setting for the instantiated objects are as follows:
PntText is the point text for the set point. PointNo = $
First PntCode is point
pntint(__REF_PNT1, $)

code

for

the

proc.

point.

PointNo

Second PntCode is point code for the set point. PointNo = $


Third PntCode is point
pntint(__REF_PNT2, $)

code

Fourth PntCode is point


pntint(__REF_PNT7, $)
Fifth PntCode is point
pntint(__REF_PNT4, $)
First PntVal is point
pntint(__REF_PNT1, $)

for

code

for

the
the

outp.

point.

PointNo

aux

point.

PointNo

code

for

the

mode

point.

PointNo

value

for

the

proc.

point.

PointNo

First PntValEnt is point value entry for the set point. PointNo = $
Second PntValEnt is point value entry for the outp. point. PointNo =
pntint(__REF_PNT2, $)
Second PntVal is point
pntint(__REF_PNT7, $)
Third PntVal is point
pntint(__REF_PNT4, $)

value
value

for
for

the
the

aux.

point.

PointNo

mode

point.

PointNo

LangText (LT) are text constants in current language. For the manual mode
button TextKey = "lngManual". Similarly for the other instances.
PntThermoVer is thermo value for the process point.
pntint(__REF_PNT1, $)

PointNo =

First PntSlider is Thermo val entry for the set point. PointNo = $
Second PntSlider is Thermo val entry for the outp. point. PointNo =
pntint(__REF_PNT2, $)
fls_m_mode_diamon. is mode switch button for the mode point. PointNo =
pntint(__REF_PNT4, $). BitVal = 1. The BitNo variable is in range 0..4 the
down most button having BitNo = 0 and the topmost BitNo = 4.
fls_m_percent_up,
fls_m_percent_up_small,
fls_percent_down,
fls_percent_down_small are percent change buttons. They apply to the output
point if the mode is manual otherwise to the set point. PointNo = $.
ManModeMaskBits = 1, ManModeValueBits = 1 (bit 0 is 1 for manual
mode).
Left fls_m_facepopup button shall popup up plcparameterface for set point.
PointNo = $. FaceplateName = "plcparamface".
Right fls_m_facepopup button shall popup up pidtrend for set point. PointNo =
$. FaceplateName = "pidtrend".

70 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Bitmaps
Bitmaps may be inserted in a picture as static objects. The bitmaps are full
scalable.
To insert a bitmap in a picture do as follows:

Make sure the bitmap exists as a file <filename>.bmp ( or


<filename>.i) on directory FlsaGmsPic\Bitmaps

Open the picture into which you want to insert a bitmap.

Select menu File -> Import -> Bitmap

From the bitmap name list select your bitmap file and click at
position in picture where the bitmap shall be placed followed by
right click and Done

Note that the bitmap file must reside on the Server. If OpStation is started on a
Client all mimic pictures and bitmaps will be copied from the Server to the
Client (if not already there). However, this implies that if you create a new
bitmap you must restart OpStation to view it on a Client, or you must copy the
bitmap file by hand to the Client.

Converting Pictures From VMS


Old pictures made for a VMS system may be transferred to an NT system. As
the internal format for classic dynamics has changed it is necessary to convert
the VMS pictures before they can be used on NT.
The utility GMS Convert does this. The utility can also be used for other picture
file manipulation such as converting .g files to .m1 and vice versa.
See the description of GMS Conversion utility for further details.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 71

Glossary of Terms

MSW
Machine Status Word. Contains the actual bit values for a B-point

gismo
Graphical Interactive State Management Object. Any object with dynamics
behavior

Faceplate
Popup window with dynamics related to activation point (point clicked upon)

SL
Sherrill Lubinski Corporation. Supplier of the GMS product

GMS
Graphical Modeling System by SL

Reference Manual ECS OpStation Editor

Glossary of Terms 73

Index

S
symbol offset 7, 36

Reference Manual ECS OpStation Editor

Index 75

Reference Manual

SDR Point System


Configuration

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 4
$Modtime:: 10/08/01 8:40a
Torben stradsson
$Author:: Taa
$Workfile:: SdrPointSysCfgUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
SDR Point System Configuration............................................................. 1
Introduction ................................................................................................................................... 1
Application Overview................................................................................................................... 1
General .......................................................................................................................................... 2
Eventing ........................................................................................................................................ 4
Control Action............................................................................................................................... 5
Control Action Definitions.................................................................................................... 6
Point states .................................................................................................................................... 7
Point State Definitions........................................................................................................... 8
Alarm Reset................................................................................................................................... 9
Alarm condition reset mode .................................................................................................. 9
Silence and Reset................................................................................................................. 10
Measurement units ...................................................................................................................... 11
Categories.................................................................................................................................... 12
Alarm Printer............................................................................................................................... 13

Glossary of Terms ................................................................................... 15


Index.......................................................................................................... 17

Reference Manual SDR Point System Configuration

Contents i

SDR Point System Configuration

Introduction
The Point System Configuration utility is used to configure the general parameters
associated with the process point system and the event system.
The application can be started from the Windows Start menu.

Application Overview

The Point System Configuration is a multi-tab application, with the following pages :
General - The general system settings, such as SiteName, point treatment and shift
definitions.
Eventing - The definition and coloring of events and alarms.
Control Action - Control logging features
Point status - Defines the color and alarm behavior for all possible startes.
Alarm Reset - definitions of actions to take, when the Alarm/Silences buttons are
pressed.
Measurements units - Unit definitions
Categories - Event categories definitions.
Alarm Printer - Alarm printer set-up.

Reference Manual SDR Point System Configuration

SDR Point System Configuration 1

To Apply changes, press the Apply button on the appropriate page.


The Reset button will course the current page to be refreshed with the last applied
values.
Close - closes the application.
Help - starts the help system.

General

The General tab contains the general system settings :

System
Release : Shows the ECS version
SiteName : The name of the plant. This name is used on printouts and as the top level
item in system tree views.
System Name : The name of the running system.

Point treatment period


The Analog Period and the Digital period, determines how many times per minute the
points are processed for statistical values and alarms. The entry is in seconds. Valid
entries are 1 through 60 seconds.
The interval between the dynamic points values being written to the disk, can be
controlled by changing the value in Backup period. Valid entries are from 1 minute to
60 minute.

2 SDR Point System Configuration

Reference Manual SDR Point System Configuration

Point system information


Show the available number of points (licensed points) and the actual number of points.
The current number of departments, group and route are displayed below.
These value are for information purposes only, and cannot be changed.

Report hour
The report hour identifies the time daily accumulated values are reset. The hour can be
typed into the text field or entered by moving the horizontal scroll element. Values
from 0 to 23 are acceptable.

Shift definitions
Number of Shifts
Change the number of shifts (1-4). Press Apply after changing the value.
Shift Name
Identifies the shift in reports.
Start of shift
Start time for each shift. The start hours must be sequential from top to bottom in the
table and specified using 24-hour format.

Reference Manual SDR Point System Configuration

SDR Point System Configuration 3

Eventing

System events
The category can be chosen from the categories defined in the Categories tab. The
default value for system events is "System"
For each event type (Error, Warning and Information) the priority and the event
algorithm can be set. Priorities can be from 1 (highest) to 5 Lowest, there are three
possible event algorithms selectable from the drop down:
Algorithm 0 - No logging, No annunciating
Events (Error, Warning, Information) , will not be logged nor annunciated.
Algorithm 1 - Logging, no annunciating
Events (Error, Warning, Information), will be logged, but not annunciated.
Algorithm 2 - Logging and annunciating
Events (Error, Warning, Information), will be logged and annunciated.

Event algorithm of points


This property controls what event algorithm to use when a hierarchy suppressed point
goes into alarm.
The Event Algorithm can be set for each Hierarchy level, Group, Route and Master
point.
Algorithm 0 - No logging, No annunciating
Alarm suppressed by the hierarchy are completely skipped.
Algorithm 1 - Logging, no annunciating
Suppressed alarms are event-logged.
Algorithm 2 - Logging and annunciating

4 SDR Point System Configuration

Reference Manual SDR Point System Configuration

Suppressed alarms are logged and annunciated. e.g. the hierarchal suppression does not
apply.

Coloring
This is the definitions of the event colors used in the SDR/ECS system. The color of
different types of events (Error, Warning and Information) can be changed using the
drop down to the right of each setting. This will change the appearance of alarms in
e.g. the Alarm Header and the Alarm list.
FGround is foreground color and BGround is background color.

Control Action
Control action logging is the ability to log operator or process actions tp PLCcontrolled equipment.

Control Action Log Enable


Yes Enables the logging of control actions
No Disables the logging of control actions

Event Priority
Select the priority for control actions events from the pull down menu (1 - Priority 1 to
5 - Lowest priority). priorities are used for filtering purposes in alarm lists.

Reference Manual SDR Point System Configuration

SDR Point System Configuration 5

Control Actions
The scroll list includes the control actions that can be logged. The Action Name
column identifies the control action (see definitions below). A control action can be
initiated by an operator or a system program. To log actions initiated by the operator
enable the Operator checkbox for the particular control action. To log actions
initiated by the system, enable the Demon checkbox for the particular control action.

Control Action Definitions


Stop dispatching Internal message.
Alarm silence Alarm silence message sent to PLC. (Should only be enabled in
debug situations)
Alarm reset Alarm reset message sent to PLC. (Should only be enabled in debug
situations)
Alarm clear Alarm silence and reset message sent to PLC. (Should only be enabled
in debug situations)
Group start Group start message sent to PLC.
Group stop Group stop message sent to PLC.
Master stop Master stop message sent to PLC.
Quick stop Quick stop message sent to PLC.
Toggle select status Request sent to PLC to toggle select status.
Bit set or clear Set or reset indicated bit in PLC.
Controller mode Obsolete. Replaced by Bit set or clear.
Controller setpoint Set controller setpoint of controller in PLC.
Controller output Set controller output of controller in PLC.
Genr. Digital output B-point algorithm output sent to PLC.
Genr. Analog output For future use.
Set Time Not applicable.
Ext. Float parameter write Write numerical parameter to PLC.
Ext. Binary parameter write Write bit pattern parameter to PLC.

6 SDR Point System Configuration

Reference Manual SDR Point System Configuration

Point states
The Point states tab contains the definitions of the properties and alarm actions for each
state a point can have. The columns are described below.

Name - The name of the state (displayed in various applications)


Color - The color used to visualize the state, when ever a point enter this state.
Alert Color - The color used to visualized the state, when the point have not yet been
silenced.
Alarm - Determine whether the state is an alarm annunciated state or not.
Annunciation - Should a change to the state course annunciation.
Event type - The type of alarm/event to produce (Error, warning, information or no
event at all)
Category - The category of the alarm/event produced.

Reference Manual SDR Point System Configuration

SDR Point System Configuration 7

Point State Definitions


Normal Defines color for A-points in normal state.
Alarm Defines the alarm state for A-points
Local Defines the local state for B-points
PRepSu The A- or B-point is "Point report suppressed". This State occurs when the
point's "Report treatment suppression point" (see point configuration) is in alarm.
When a point is "point report suppressed", its statistical calculations are suspended.
OAlmSu The A- or B-point is Operator alarm suppressed. The operator has
suppressed alarms from the point. When a point is "operator alarm suppressed" no
alarms appear for this point regardless of its point state.
PAlmSu The A- or B-point is Point alarm suppressed. The point's "Alarm
suppression point" is in alarm. Therefore this point is "point alarm suppressed", in
another words no alarms appear for this point regardless of its point state.
HAlmSu Hierarchy alarm suppressed. When the point is suppressed by an above
Department, Group, Route or Master point. Still the point will only take the HAlmSu
color, when it is in an alarm state. Otherwise appear as "Normal"
No Algorithm The A- or B-point has no algorithm assigned.
Arithmetic fault The calculation of an A-point value gave a computer arithmetic
fault, e.g. division by zero.
Illegal expression A-point value calculation resulted in an illegal floating point
value.
Internal error A-point value calculation cannot be performed.
Fault state B-point MSW (machine status word) is not included in the B-point
algorithm.
Undefined value A-point with an undefined value.
Not updated A- or B- point value has not been received from a device (PLC) within
the time-out value defined by the IO system.
Bank Not applicable.
Open loop Open loop state (e.g. wire is cut in a 4-20 mA circuit) for an A-point
Short circuit Short circuit state (e.g. current is greater than 20 mA in a 4-20 mA
circuit) for an A-point
Force A-point value in PLC interactively forced to a specific value.
Signal fault Non specific fault is reported by IO device (PLC) for an A-point
Value change Not applicable.
Out of range Illegal A-point alarm level.
A-High1 to A-High10 Alarm high 1 to 10 states (A-points).
A-Low1 to A-Low10 Alarm low 1 to 10 states(A-points).
Ext A-High1 to Ext A-High10 PLC generated high alarm limit for an A-point.
Ext A-Low1 to Ext A-Low10 PLC generated low alarm limit for an A-point.

8 SDR Point System Configuration

Reference Manual SDR Point System Configuration

Alarm Reset
The Alarm Reset tab contains the policy for resting events and alarms.

Alarm condition reset mode


Select the desired alarm reset condition from the pull down menu.
1 - Auto reset
Alarm reset is not required, the point state is not effected by a reset.
2 - Unconditional reset with latch of reset
Alarm reset is accepted regardless of the current alarm state. The reset is latched until
the point is in a normal state or changes to a worse state.
E.g. if point is in high10 and a reset is done, all point value changes resulting in states
from high10 down to normal do not require further resets
3 - Conditional reset
Alarm reset is only accepted when the points current state is better than the alarm
state, otherwise it is skipped. A new reset is required for each transition towards a
normal state, such as high5 -> high4.
E.g. if the point is in high10 and the current point value still results in high10, a reset
has no effect. However if the current point value would result in high9, the point state
changes to high9 upon a reset. Further state changes to better states require new resets.
4 - Conditional reset with latch of reset
Alarm reset is only accepted when the points current state is better than the alarm
state, otherwise it is skipped. An accepted reset is latched until the point is in a normal
state or changes to a worse state.
E.g. as 3, but further value changes resulting in better states do not require new resets.

Reference Manual SDR Point System Configuration

SDR Point System Configuration 9

Silence and Reset


These settings describe how the system should handle the Silence and Reset command
issued by the user. The user issues the Silence or Reset commands by pressing the
Silence or Reset button found in the OpStation and Alarm list applications.

Alarm Silence button

Alarm Reset Button

Silence and Reset scopes


Department - Issues Silence/Reset on department level only. Disables plant Silence /
Reset.
Plant - Also Silence/Reset on plant level is allowed.
Global - Silence/Reset will always be performed on Plant level.
Philosophy
The Silence/Reset philosophy states what the system should do when the user presses
Silence the first time, the second time and when the user presses Reset.
The Philosophies have four template settings, and the current (user) setting. Chose a
template from the dropdown below the Philosophy table and modify it. After pressing
Apply, this Philosophy will then become the current setting.
Columns
Actions - The action to be taken (Described below)
Silence 1 - Alarm Silence command 1st time
Silence 2 - Alarm Silence command 2nd time
Reset - Alarm Reset command
Actions
Silence of horn - Set horn points for the selected scope to the horn off value.
Silence of local annunciation - Silence sound from the local computer
Show header line as silenced - Alarm header line appears in silenced color
Remove header line - Empty the alarm header for the selected scope.
Show button as silenced - Alarm header buttons no longer shown in alerted color.
Clear alert status (points) / Ready for Reset - Analog points in the selected scope
have their alert status removed, e.g. blinking colors switch to steady colors. (Point
system only.) This action enables a following Reset command.
Send Silence command to PLC - Sends the silence command to the PLC
Show button as Reset - Alarm header buttons may be shown in "normal" color.
Reset points for analog points in the selected scope try to reset the points, i.e. try to set
point into normal state. (Point system only.)
Send reset command to PLCs for the selected scope send reset command(s) to the
PLC(s).

10 SDR Point System Configuration

Reference Manual SDR Point System Configuration

Measurement units
The units shown in the ECS/SDR system are defined in this dialog. The first column
shows the unit number. The second column shows the unit text in local language and
the third shows the unit in the default language.

To add a new unit press the Add button and enter a new (unique) number in the first
field. Enter the local unit text in middle field and the default unit text in the bottom
field.
Press OK to save the unit or Cancel for canceling the new unit.
To delete a unit, select the unit in the list and press delete.
To modify a unit, click in the list, modify the text and press Apply.

Reference Manual SDR Point System Configuration

SDR Point System Configuration 11

Categories
Categories are used to group the alarms/events that have some conditions in common.

To add a new category press the Add button and enter a new (unique) number in the
first field. Enter the local unit text in the middle field and the default unit text in the
bottom field. Please use a number that is not reserved for system purposes.
Press OK to save the unit or Cancel for canceling the new category.
To delete a category, select the unit in the list and press delete.
To modify a category, click in the list, modify the text and press Apply.

12 SDR Point System Configuration

Reference Manual SDR Point System Configuration

Alarm Printer
The Alarm Printer tab contains the setup for all alarm printers connected to the server
or auxiliary units, shown in a master-detail view. First select the printer port from the
left table, when change the properties in the right table.

Enable alarm printer


Generally enables / disables all alarm printers.

Alarm Printer table


Port - The physical or logical printer port.
Enable - Enable / disable each printer.
Server - The computer that has the connection.
Initialization string - An "Escape code" sequence that is typed in as decimal
character codes, separated with spaces. e.g. 23 128 211 7
Consult the printer user manual to obtain the codes if needed.

Printer Output
Department - All departments in the system.
Error - From what priority level (and above) are the Errors in the selected department
to be printed. Selecting Priority 3, will cause the printer to print all Error alarms with
priority 1, 2 and 3, for that department.
Warning - From what priority level (and above) are the Warnings in the selected
department to be printed. Selecting Priority 3, will cause the printer to print all
Warnings with priority 1, 2 and 3, for that department.
Info - From what priority level (and above) are the Information events in the selected
department to be printed. Selecting Priority 3, will cause the printer to print all
Information events with priority 1, 2 and 3, for that department.

Reference Manual SDR Point System Configuration

SDR Point System Configuration 13

Glossary of Terms

A-point
Analog point

B-point
Binary point.

Department
A department can contain one or more groups.

Group
A group can conrain Routes, Master points and points.

Master point
The Master point is an alarm suppression point with one or more child points.

Plant
The plant is the top item in the system.

Route
A transport path that can contain Master points and points. A point can be a member
of several routes.

Reference Manual SDR Point System Configuration

Glossary of Terms 15

R
Release 2
Reset 1, 3, 6, 910

Index

S
shifts 3
Silence 6, 10
SiteName 12
System 12, 45, 8, 1013

U
units 1, 11, 13

A
Alarm 1, 410, 13

B
Bank 8
BGround 5

C
Categories 1, 4, 12
Coloring 1, 5
colors 5, 10

E
Eventing 1, 4

F
FGround 5
Force 8

H
HAlmSu 8

L
Local 8, 1012

N
Normal 810

O
OAlmSu 8

P
PAlmSu 8
Philosophy 10
PRepSu 8

Reference Manual SDR Point System Configuration

Index 17

Reference Manual

SDR Point Configuration

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 7
$Modtime:: 9/25/01 4:30p
Torben stradsson
$Author:: Taa
$Workfile:: SdrPointCfgUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
Point Configuration ................................................................................... 1
Introduction ................................................................................................................................... 1
Application Overview................................................................................................................... 1
The Toolbar............................................................................................................................ 2
The System Tree .................................................................................................................... 4
The Search Function.............................................................................................................. 5
Configuration Dialogs................................................................................................................... 6
Configuring a Department..................................................................................................... 7
Configuring a Group.............................................................................................................. 8
Configuring a Route .............................................................................................................. 9
Configuring a Point ............................................................................................................. 10

Glossary of Terms ................................................................................... 21


Index.......................................................................................................... 23

Reference Manual SDR Point Configuraton

Contents i

Point Configuration

Introduction
The Point Configuration utility is used to maintain the ECS/SDR point database.
Departments, Groups, Routes, Master Points and Points can be created and
viewed in an explorer-like master/detail environment.
To launch the utility, select Point Configuration in the desktop Start menu or
press on the Point Configuration button in an open ECS application.
Point Configuration
If a point is selected, the application will start with the point configuration dialog
open and the full (list) view hidden. To toggle between these two modes press
the "LIST" button on the point configuration dialog.

Application Overview
Point Configuration application :

Reference Manual SDR Point Configuraton

Point Configuration 1

The application has three major elements: Toolbar, System Tree (left pane),
detail view (right pane)
For all selections in the detail view, a configuration dialog will be shown when a
department, group, route or point is double-clicked.
The application can run in to modes :
1. Full view - as shown above
2. Dialog view - when a Department, Group, Route or point is being configured.
To toggle between these two modes press the "LIST" button on the point
configuration dialog.

The Toolbar

Tree Menu
This menu applies only to the selection in the tree. If you have selected
something in the list, use the list Menu.
New A-point - creates a new A-point at the current position
New B-point - creates a new B-point at the current position
New Route - creates a new Route at the current position
New Group - creates a new Group in the current department
New Department - creates a new department
Delete - deletes the selected item
Properties - Show Properties for the selection

List Menu
This menu applies only to the selection in the list. If you have selected something
in the tree, use the Tree Menu.
Copy - copies the point, show the new point dialog with the values for the
selected point
Child of - Sets the master point of the current point
Select as Masterpoint - Makes the selected B-point into a Masterpoint. To
make a new master point, first use New B-point and configure the point. Then
use this function.
After making a B-point into a master point it is important to create at least one
child point. Failing to do so will cause the master point reappear as a normal
point, the next time the Point Configuration Utility is opened.
An existing point can be moved below the master point by dragging it from the
list and releasing the mouse on top of the master point or by using the Child of
Entry in this menu.

2 Point Configuration

Reference Manual SDR Point Configuraton

Add to Route(s) - Add the selected point to one of the shown routes
Remove from Route(s) Removes the selected point from the shown route
Delete - deletes the selected item.
Properties - Show the properties dialog for the selected item.
This menu is also available when right clicking an element in the right side list.

Toolbar buttons

Reset Column size


Show IO address dialog
Refresh
Show IO column in list
Previous - Move to previous tree element
Next - Moves to next tree element
Properties - Show properties for the selected element
Move up - move one element up in the list
Move Down - moves one element down in the list
Copy element
Delete element
Help
Find - searches for a point with the point code typed in the "Find
combobox"
Find Combobox - type a point code here and press Find

Reference Manual SDR Point Configuraton

Point Configuration 3

The System Tree


The tree contains the entire system divided into departments, groups, routes,
master points. When an element is selected, all sub elements (including points)
will be shown in the left pane.

Plant

Department

Group

Route

Master
Point

A-point

B-point

Navigation is done thru the keyboard,


with the mouse or with the two
toolbar buttons.
Mouse
Single-click: Selects item. sub items
are shown in the right list view.
Double-click: expand/collapse
element. The "+" and "-" to the left of
the element can also be used for this.
Points can be dragged from the list to
a new location in the tree.
Departments, Groups and routes
cannot be dragged.

Keyboard
Up - Moves one element up.
Down - Moves one element down.
Left - Expand element and moves one level down
Right - Collapse element and navigate one level up in the tree.
Page Up - Navigate one page up
Page Down - Navigate on page down
Home - To plant
End - To last element
In the Toolbar there is three buttons for navigating the tree:
- navigate one element up
- navigate on element down

4 Point Configuration

Reference Manual SDR Point Configuraton

The Search Function

The search function allows a detailed search


for points, knowing only a part the names or
properties.
The wildcard "*" can be used before and/or
after one or more characters.
To search for a known part of the point text
property, type it in the "Containing text" field.
Wildcards can be used.
Look in: narrows the search down by selecting
a department.
The search options can be used if some of the
properties are known or e.g. all points with a
certain conversion algorithm is wanted.
Point Type : A, B or blank (not known)
Conversion Algorithm : Choose an algorithm
or blank for not known.
Interface type : Choose interface or blank for
not known.

Reference Manual SDR Point Configuraton

Point Configuration 5

Configuration Dialogs
There is four different configuration dialogs in the point configuration
application.
Department
Group
Route
Point
A dialog are shown when an element in the list are double clicked or "properties"
is chosen, either from the menus or by pressing the properties button.
The dialogs have the following buttons in common:

Reset
Will fetch the old values in the fields of the dialog (since last "Apply")
List
All the dialogs can run with or without the Application frame described in
Application Overview. This is toggled by the "LIST" button on each dialog.
Cancel
Closes the dialog without saving the values.
Apply
Saves the values
The up and down buttons, moves to the next element in the list and
show the configuration dialog for that element.

6 Point Configuration

Reference Manual SDR Point Configuraton

Configuring a Department

To create a new Department or change an existing, enter an unique text that


identifies the department in the Dep. code field having in mind that this text will
be used in trees and list together with the other departments. Up to 25 characters
can be used.
For a more describing text use Dep. Text default, and use Dep. text local for a
description in the local language. The maximum length of these fields are 32
characters.
For annunciation through a PLC Horn Point, type the point code in the "Horn
Point Code" field or drag it in from the list. The Point Code will be verified, so
the point must be present
Event Algorithm possibilities:
Available algorithms:
Algorithm 0 - No logging, No annunciating
Events (error, warning, information) assigned to this department, will not be
logged or annunciated.
Algorithm 1 Logging, no annunciating
Events (error, warning, information) assigned to this department, will be logged,
but not annunciated.
Algorithm 2 Logging and annunciating
Events (error, warning, information) assigned to this department, will be logged
and annunciated.

Reference Manual SDR Point Configuraton

Point Configuration 7

Configuring a Group

The group is used to increase department granularity. The group can contain
routes, points and master points.
To create a new Group or change an existing, enter an unique Group code that
identifies the Group (Unique Group codes are recommended). Up to 25
characters can be used.
For a more describing text use Group Text default, and use Group text local for a
description in the local language. The maximum length of these fields are 32
characters.
A Group Point can be associated with the group for suppression purposes. Enter
the point code of the Group Point in the "Group point code" field or drag it to the
field from the list.
The point code is verified and therefore has to exists and be a member of this
group.

8 Point Configuration

Reference Manual SDR Point Configuraton

Configuring a Route

The route is a transport path containing one or more points or master points. The
route can share several points with other routes
To create a new Route or change an existing, enter an unique Route code that
identifies the Route (Unique Route codes are recommended). Up to 25
characters can be used.
For a more describing text use Route Text default, and use Route text local for a
description in the local language. The maximum length of these fields are 32
characters.
A Route Point can be associated with the group for suppression purposes. Enter
the point code of the Route Point in the "Route point code" field or drag it to the
field from the list.
The point code is verified and therefore has to exists and be a member of this
Route.

Reference Manual SDR Point Configuraton

Point Configuration 9

Configuring a Point
The Point configuration dialog is a common dialog for both A and B-points.
However it differs in the "Conversion" and "Statistic" tabs and the "Analog
settings" tab are invisible for B-points.

The General tab


Identification
Point code
Unique point name. Any combination of numbers and letters can be used.
Identifies the point within the ECS point database. Up to 24 characters can be
used.
Point text
A description of the point that appears on graphic popup windows, in point lists
and in the alarm header. The point text provides additional information about the
points location and or function. Up to 32 characters can be used.
Local point text
Point text in the local language. When the ECS workstation language selection
is set to local, this information in this field is displayed as the point text. Up to
32 characters can be used.

10 Point Configuration

Reference Manual SDR Point Configuraton

Interface type
Identifies the kind of external device associated with the point, e.g. PLC system,
DCS system, CEM scanner etc. Points not connected to any external device has
interface type SDRI.

Eventing
Alarm Suppression point
The ECS system enables Point Alarm and Report suppression for individual
points by assigning a parent point. Whenever the parent point status is not
normal, alarms or reports for the child point are disabled. The point code is
verified and therefore has to exist. The point code can be retrieved by dragging it
from the list or by typing it by hand.
During processing, if a parent point is specified for alarm suppression, alarms for
the child point are not processed if any of the following are true:

The status of the parent point is not Normal

The parent point is point alarm suppressed (PAlmSu)

The parent point is operator alarm suppressed (OAlmSu)

Event Algorithm
Available algorithms:
Algorithm 0 - No logging, No annunciating
Events (error, warning, information) assigned to this point, will not be logged or
annunciated.
Algorithm 1 Logging, no annunciating
Events (error, warning, information) assigned to this point, will be logged, but
not annunciated.
Algorithm 2 Logging and annunciating
Events (error, warning, information) assigned to this point, will be logged and
annunciated.

Reference Manual SDR Point Configuraton

Point Configuration 11

Priority
To show the importance of an event assigned to this point, a priority level can be
defined here. The priority of an event can be from 1 (highest) to 5 (lowest).
Category
The category of an event is system specific, but the first 10 are : None, Point
Specific, Process, Electrical, Mechanical, System, Communication, Operator,
Fuz, Qcx or Cem.

Reporting
Report suppression point
The point code of a parent point used for Report Suppression. Whenever the
parent point status is not normal, alarms or reports for the child point are
disabled. The point code is verified and therefore must be present. The point
code can be entered by dragging it from the list or by typing it by hand.
During processing, if a parent point is specified for report suppression, The
report algorithm is not executed for the child point if any of the following are
true:

The status of the parent point is not Normal

The parent point report algorithm is suppressed (PRepSu)

Report Algorithm
For A-points the reporting algorithm defines a special calculation that the point
value is continuously subjected to during point treatment. The hour, shift and
day results of this calculation are printed in plant reports, and the value is used
for long term statistical logging. The resulting value is referred to as report value
or calculated value. See e.g. the Statistical tab of Point Parameters utility
0-No algorithm
the report value is undefined and never calculated.
1-Simple mean value
continuously calculates the mean value.
2-Accm. per hour
increments continuously by the current pointvalue*timeincrement, the
timeincrement is a portion of an hour, fx. 10secs./3600. (Integration at each point
treatment time.)
3-Accm. per minute
similar to 2, but based on the portion of a minute.
4-Accm. per fullhour
just takes the value at the hour and stores it, and adds it with respect to shift and
day values. (Integration each hour.)
8-Mean (full hour val.)
just takes the value at the hour, but averages the value with respect to shift and
day values.

12 Point Configuration

Reference Manual SDR Point Configuraton

9-Stan.dev (point val.)


continuously calculates the standard deviation of the point.
10-Sampling, report hour
saves the value at report hour time, e.g. only once a day.
11-Stan.dev(Operat. Ins)
same as 9, but only calculated, when a new value is entered for the point.
For B-points the reporting algorithm determines if "Total operating hours"
property of the B-point as eg reported by the "Total Operating hours" of the
Statistical tab of Point Parameters utility, is reset a Report hour or continues to
accumulate.
0-No reporting - Nothing is done.
1-Operating hours - "Total Operating hours" is reset at report hour.
2-Continuous operating hours - "Total Operating hours" accumulates.
"Total operating hours" can be reset using the General tab of Point Parameters
utility.

The Conversion tab


Conversion (A-Points)

Conversion (B-points)

IF Type
Choose the kind of external device associated with the point. e.g. PLC system,
DCS system, CEM scanner etc. Points not connected to any external device can
be assigned the interface type SDRI.

Reference Manual SDR Point Configuraton

Point Configuration 13

Conversion algorithm
The conversion algorithm executed when this point is processed. The algorithm
determines how the point value obtained from the interface is manipulated
before it is presented to displays and other points within the ECS system. Refer
to the online help documents for A-Point Conversion Algorithms and B-Point
Conversion Algorithms.
Value Algorithm (Value Calculation algorithm)
(B-points only)
The purpose of B-point value calculation algorithms is internally to calculate an
MSW value of a B-point, and thereafter applying this value to the B-point
Algorithm. So the MSW is generated internally and not coming from the PLCs
when the algorithm number is > 0.
Please notice that these algorithms should not be used on points with an PLC
input address, the result will be unpredictable.
For algorithm definitions, refer to the online help documents for B-Point
Calculations Algorithms, found in the ApointAlgorithms document and help file.

Block algorithm
Choose a block algorithm depending on the points function.

14 Point Configuration

Reference Manual SDR Point Configuraton

Reference points
A-points
These entries are used to specify the point code of any point associated with the
A-point conversion algorithm assigned to the point or in other ways referenced
from/related to this point. The calculation of an A-point value is usually based
on the point value of a number of input points.
B-points
For B-points the reference points and constants can be used for two purposes:
1. The entries can be used to refer to points used in face-plates. The reference
points can be of any type.
2. Entries can be required depending on the selected Value (calculation)
algorithm.

Analog Settings
The analog settings are only available for A-points

Alarm constants
High alarm limit
This entry is used to specify the upper alarm limit in engineering units. The
value is displayed on gauges in the OpStation screen as a red line.

Reference Manual SDR Point Configuraton

Point Configuration 15

Low alarm limit


This entry is used to specify the lower alarm limit in engineering units. The
value is displayed on gauges in the OpStation screen as a red line.
Normal value
This entry may be used to specify a normal value of the point value.
Filter Constants
This entry contains the time constant of a digital exponential filter (in the
following named TC). The new point value P is calculated on the basis of the old
point value Pold and the just measured value Pmes by using the formula:
P = FC*Pold + (1-FC)*Pmes

where the Filter Constant FC is calculated as:


FC = (2TC/TS - 1) / (2TC/TS + 1)
TS = Sampling period.
TC must be within the limits TS/2 <= TC <= 3600 sec, or TC must be
0.

Hysteresis
This entry is used to specify the hysteresis in engineering units, which is
employed in connection with alarm off announcement. If, e.g., the high alarm
limit is called HL, and the hysteresis is called Y, then the condition for alarm off
announcement is that the point value is less than HL-Y.
0 <= Y <= Interval

<= 99999

Interval
This entry is used to specify the size in engineering units between the repetition
of high/low alarms.
If, e.g., the high alarm limit is called HH and the interval size is called Y, then
alarms are detected when the point value exceeds HH (status = A-high1), HH+Y
(status = A-high2), HH+2Y (status = A-high3), until HH+9Y (status =
A-high10).

Graphical presentation
Graphical high
This entry is used to specify the upper limit for the display of the point value on
gauges and trends in OpStation.
Graphical low
This entry is used to specify the lower limit for the display of the point value on
gauges and trends in OpStation.

16 Point Configuration

Reference Manual SDR Point Configuraton

Signal high
This entry is used to specify the upper alarm limit in engineering units. The
value is used to evaluate percentage change in OpStation.
Signal low
This entry is used to specify the lower alarm limit in engineering units. The
value is used to evaluate percentage change in OpStation.
Measurement unit
This entry is used to define the engineering unit of the point, e.g. degC, ton/hr,
etc. Select a unit from the drop down list.
Format
This entry defines the display format of the point value, i.e. the number of digits
after the decimal point. Note that the format you enter is overruled if the field
size is not sufficient to display the desired number of decimals.

Statistics
A-points

Minimum
The Minimum value within the given interval
Average
The Average value within the given interval

Reference Manual SDR Point Configuraton

Point Configuration 17

Maximum
The Maximum value within the given interval
Calc. by report alg.
The calculation done with selected Report Algorithm within the given interval.
Alarm time
The time that the point has been in alarm for the given interval
Alarm count
The number of times that the point has been in alarm for the given interval
Error count
The number of error occurred in the given interval. The error occurs when the bpoint enters an illegal state, not defined in the MSW.
Last entered
A new value can be entered here, depending on the conversion algorithm, e.g.
"41-Operator inserted" will allow insertion of a new value.
If the field is shaded a new value can not be entered.
The right value field contains the old value at the time displayed in the above
field.
Alarm Suppressed
Toggle Operator alarm suppression on/off.

18 Point Configuration

Reference Manual SDR Point Configuraton

B-points

Current and Previous times and counts


Operating hours
The operating time for the given intervals
Total operating hours
The total operating time
Alarm time
The time that the point has been in alarm for the given interval
Alarm count
The number of times that the point has been in alarm for the given interval
Error count
The number of error occurred in the given interval. The error occurs when the bpoint enters an illegal state, not defined in the MSW.
Last entered
Here it is possible to change the value of the B-point, depending on the
conversion algorithm. The last value and the time are displayed to the right.

Reference Manual SDR Point Configuraton

Point Configuration 19

Alarm Suppressed
Toggle Operator alarm suppression on/off.
Total operating hours
The same as the "Total operating hours" field in the Current Statistics grid.

Hierarchy
The Hierarchy tab can only show data for points already created.

All values are "read only" and for information purposes only.
Point location
The department and group that the point belongs to.
Point Binding
The active route and if the point belong under a master point, the master point
code are shown.
All routes that has this point has a member are listed in the "Member of route(s)"
field.

20 Point Configuration

Reference Manual SDR Point Configuraton

Glossary of Terms

A-point
Analog point

B-point
Binary point

Department
A Department can contain one or more groups.

Group
A group can contain Routes, Master points and points.

Group Point
Suppression point for a group.

Master Point
The Master point is an alarm suppression point with one or more child points. A
Master points can not be a child to an other Master point.

Plant
The Plant is the top item in the system.

Route
A transport path that can contain Master points and points.

Route Point
Suppression point for a Route

Wildcard
The wildcard is used when only a fraction of a search text is known.
A search on *int* could result in Point, APoint1012 and IntegerValue01A.

Reference Manual SDR Point Configuraton

Glossary of Terms 21

Index

Hierarchy 20
High alarm limit 15
Horn Point 7
Hysteresis 16

I
Identification 10
Interface type 5, 11
Introduction 1

K
Keyboard 4

A
active route 20
Analog Settings 10, 15
Apply 6

B
Block algorithm 14

C
Category 12
child point 11, 12
configuration dialog 12, 12, 6, 10
Configuring a Department 7
Configuring a Group 8
Configuring a Point 10
Configuring a Route 9
Conversion algorithm 5
Conversion tab 13

D
Delete 23, 23, 23
Department 24, 24, 20
detail view 2
Dialog view 2

E
Event algorithm 7, 11
Eventing 11

F
Format 17
Full view 2

G
General tab 10, 13
Graphical presentation 16
Group Point 8

Reference Manual SDR Point Configuraton

L
launch 1
List 13, 13, 13, 611, 611, 17
List Menu 2
Local point text 10
Low alarm limit 16

M
major elements 2
Master Point 24
Measurement unit 17
Mouse 4

N
Navigation 4
New A-point 2
New B-point 2
New Department 2, 7
New Group 2, 8
New Route 2, 9
Normal value 16

O
OalmSu 11
Overview 1, 6

P
PalmSu 11
Point Binding 20
Point code 3, 15, 20
Point location 20
Point Status 11, 12
Point text 5, 10
PrepSu 12
Previous 3, 19
Priority 12

Index 23

R
Reference points 15
Report algorithm 12, 18
Report suppression point 12
Reporting 12
Reset 3, 6, 13
Route Point 9

S
Search 5
Statistics 17, 20
Status 11, 12
System Tree 2, 4

T
Toolbar 2, 34, 34, 34
tree 4
Tree Menu 2

V
Value Algorithm 14

W
wildcard 5

24 Index

Reference Manual SDR Point Configuraton

Reference Manual

SDR A-Point Algorithms

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 10
$Modtime:: 2/14/02 10:00a
hct
$Author:: Taa
$Workfile:: ApointAlgorithms30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further
and future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
SDR A-Point Algorithms .......................................................................... 1
Introduction ................................................................................................................................ 1
Algorithm Legend ............................................................................................................... 2
IO Algorithms ............................................................................................................................ 3
Algorithm 0 - No Algorithm ............................................................................................... 3
Algorithm 1 - Linear Input.................................................................................................. 3
Algorithm 2 - Counter, Accm. Value.................................................................................. 3
Algorithm 3 - PID Controller Setpoint................................................................................ 4
Algorithm 4 - Manual Output Controller ............................................................................ 5
Internal Algorithms .................................................................................................................... 5
Algorithm 11 - Linear Conversion...................................................................................... 5
Algorithm 12 - Weighted Summation................................................................................. 5
Algorithm 13 - Multiplication............................................................................................. 5
Algorithm 14 - Division...................................................................................................... 5
Algorithm 15 - Exponential ................................................................................................ 5
Algorithm 16 - Sampler ...................................................................................................... 6
Algorithm 17 - Unit Delay .................................................................................................. 6
Algorithm 18 - Integration .................................................................................................. 6
Algorithm 19 - Differentiation ............................................................................................ 7
Algorithm 20 - Dual system identification.......................................................................... 7
Algorithm 21 - SDR - ON................................................................................................... 8
Algorithm 22 - Relay .......................................................................................................... 8
Algorithm 23 - %-Subtraction............................................................................................. 8
Algorithm 24 - Get Statistical Data..................................................................................... 8
Algorithm 25 - Maximum Value......................................................................................... 9
Algorithm 26 - Minimum Value ......................................................................................... 9
Algorithm 27 - Linear Regression....................................................................................... 9
Algorithm 28 - Get Run state of B points ......................................................................... 10
Algorithm 29 - Get Point Parameters................................................................................ 11
Algorithm 30 - Minute Delay............................................................................................ 11
Algorithm 31 - Flow Measurement................................................................................... 11
Algorithm 32 - 15/30 Mean Max Value............................................................................ 11
Algorithm 33 - Run Factor................................................................................................ 12
Algorithm 34 - Normal State Counter............................................................................... 12
Algorithm 35 - P1/Normal, P2/Alarm............................................................................... 12
Algorithm 36 - Copy B point value................................................................................... 12
Algorithm 37 - Standard Deviation................................................................................... 12
Algorithm 38 - Average Value.......................................................................................... 12
Algorithm 39 - FUZZY STORE Point.............................................................................. 13
Algorithm 40 - Kiln Ramp Generator ............................................................................... 13
Algorithm 41 - Operator Inserted...................................................................................... 13
Algorithm 42 - Logarithm................................................................................................. 13
Algorithm 50 - Set value as constant ................................................................................ 14
Algorithm 51 - Multiplication of multiply points ............................................................. 14
Algorithm 92 - Test Time Ramp Function........................................................................ 14
Algorithm 93 - Test Ramp Function ................................................................................. 15
Algorithm 94 - Point server status information................................................................. 15
Alarm algorithms...................................................................................................................... 16

Reference Manual for A-Point Algorithms

Contents i

Algorithm 0 - No logging, No annunciating..................................................................... 16


Algorithm 1 - Logging, no annunciating .......................................................................... 16
Algorithm 2 - Logging and annunciating ......................................................................... 16
Report algorithms for A-points................................................................................................ 17
Algorithm 0 - No reporting............................................................................................... 17
Algorithm 1 - Simple mean value..................................................................................... 17
Algorithm 2 - Accum. per hour ........................................................................................ 17
Algorithm 3 - Accum. per minute..................................................................................... 17
Algorithm 4 - Accum. full hour........................................................................................ 17
Algorithm 8 - Mean(full hour val.)................................................................................... 17
Algorithm 9 - Stan. dev(point val.)................................................................................... 17
Algorithm 10 - Sampling, report hour .............................................................................. 18
Algorithm 11 - Stan. dev(Operat ins) ............................................................................... 18
B-point calculation algorithms................................................................................................. 19
Algorithm 0 - No algorithm.............................................................................................. 19
Algorithm 1 - Copy B point msw ..................................................................................... 19
Algorithm 2 - Bit mask, move right.................................................................................. 19
Algorithm 3 - Unpack single bit ....................................................................................... 19
Algorithm 4 - Pack single bits .......................................................................................... 19
Algorithm 5 - Pack bits with mask ................................................................................... 19
Algorithm 6 - Copy A point value.................................................................................... 20
Algorithm 7 - A point status ............................................................................................. 20
Algorithm 8 - A point Alarm level ................................................................................... 20
Algorithm 9 - Make constant............................................................................................ 21
Algorithm 10 - Watchdog pulse ....................................................................................... 21
Algorithm 11 - Pulse trigger............................................................................................. 21
Algorithm 12 - Pack multiple bits .................................................................................... 21
Algorithm 13 - Runhour test min ..................................................................................... 21
Algorithm 14 - Runhour test date ..................................................................................... 21
Algorithm 15 - MSW range test ....................................................................................... 22
Algorithm 16 - Stat flags test............................................................................................ 22
Algorithm 17 - Dual block point ...................................................................................... 22
Report algorithms for B-points ................................................................................................ 23
Algorithm 0 - No reporting............................................................................................... 23
Algorithm 1 - Operating hours ......................................................................................... 23
Algorithm 2 - Continuous Oper. hrs................................................................................. 23

Glossary of Terms ..................................................................................25


Index ..............................................................Error! Bookmark not defined.

ii Contents

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms

Introduction
A-point conversion algorithms are programs that generate an A-point value
based on a raw value obtained from the I/O system or another point. After
processing the raw value, the A-point value is saved to log files, posted in
graphics, or used by other points.
The A-point algorithms are divided into two categories - I/O Algorithms and
Internal Algorithms. The I/O algorithms are used to process A-point values from
the process interface. The internal algorithms are used to calculate point values
for control or display purposes or to provide a means to accept values from an
operator.
When an algorithm is assigned to a point, it is applied each time the point value
is processed. The result of this processing is determined by the algorithm type
and various configuration parameters assigned to the point.
The configuration parameters include constant values specified by the user and
the values from up to 10 reference points.

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms 1

Algorithm Legend
The following describes the expressions used in the I/O and internal algorithm
desriptions.
pcal: calculated value - not filtered
aiv analog input value
p point value in engineering units
p[-i] The point value established i sampling periods ago
Pn where n = 1 to 10. The point value of the ten input points specified in
the point record.
PAn where n = 1 to 3. The 3 database fields (Parameter 1, Parameter 2, and
Parameter 3) located in the point record.
Cn where n = 1 to 10. One of the 10 Constant fields located in the point
record.
TS Point treatment period[in seconds].
TC Filters time constant[in seconds].
The filter is defined as follows:
Pnew = Pold + (Pmes - Pold)/f
where:
f = TC/TS + 0.5
Pmes = latest sampled point-value.
Pold = old filtered point-value.
Pnew = new filtered point-value.
TS/2 <= TC <= 3600

2 SDR A-Point Algorithms

Reference Manual for A-Point Algorithms

IO Algorithms
The I/O algorithms are used to process A-point values obtained from the process
interface.

Algorithm 0 - No Algorithm
No conversion.

Algorithm 1 - Linear Input


p = C1*aiv + C2
C1 = Gain
C2 = Offset

Algorithm 2 - Counter, Accm. Value


This algorithm is used in connection with totalizing counters residing in the
process interface
pcal = C1 * (C3*P1 + aiv) + C2
aiv = Counter value in the process interface (low word).
P1 = Point code of optional point with high counter value.
C3 = Multiplier. As default set to 10000 if C3 is zero.
No filter treatment.

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms 3

Algorithm 3 - PID Controller Setpoint


PID control is implemented in the PLC program. Algorithm 3 is used to connect
to the controller in order to display and modify the controller setpoint, the
controller mode, and if algorithm 4 is used, the controller output. Also refer to
Algorithm 4 - Manual Output Controller. The following identifies the
parameters for Algorithm 3.
P1 = Process Value (PV) - controlled variable
P2 = Controller output Manual Setpoint point. A-point with algorithm 4.
P3 = B-point used for Cascade Control (Blocking Point). The value specified in
the P6 point is sent to the PID setpoint if this point is Normal and has a value of
ON.
P4 = Controller Mode B-point. B-point with algorithm 17.
P5 = Optional A-point for actual setpoint value for I/O drivers that can not
read-back the actual setpoint value in this A-point.
P6 = Desired setpoint value from another point or the Fuzzy or QCX system
options.
P7 = Optional A-point that holds the actual position of the controlled device
(damper or valve).
C1 = Gain (Same as PV Gain)
C2 = Offset (Same as PV Offset)
C3 = New setpoint Deadband. If P6 is used, the difference between the current
setpoint value and the P6 value must be greater than C3 before a new setpoint is
sent to the PID.
C4 = Internal counter used for dead time
C5 = Dead time in seconds. The amount of time that must elapse before a new
setpoint is sent.
The PID setpoint can also be supplied by the Desired Setpoint point (P6). This
can be a value from another point or another SDR subsystem (Fuzzy, QCX,
etc.). If an optional B-point (Cascade Control) is specified in the P3 field, the
Desired Setpoint is only passed to the PID if the Cascade Control point is
Normal and has a point value of ON.
C9 and C10 = Limits for setpoint output. C9 is the low limit and C10 the high
limit. So if C9 = 0 and C10 = 100 and an attempt is made to set the setpoint to
50 then this will be accepted. However a value of 101 will be rejected. C9 and
C10 are also used as low and high range for PID faceplate sliders.

4 SDR A-Point Algorithms

Reference Manual for A-Point Algorithms

Algorithm 4 - Manual Output Controller


Also refer to Algorithm 3 - PID Controller Setpoint.
P1 = Automatic Setpoint point. A-point with algorithm 3.
P2 = Process Value (PV) - controlled variable
P3 = B-point used for Cascade Control (Blocking Point)
P4 = Controller Mode B-point. B-point with algorithm 17.
P6 = Desired setpoint value from another point or the Fuzzy or QCX system
options.
C1 = 100
C9 and C10 = Limits for output. C9 is the low limit and C10 the high limit. So
if C9 = 0 and C10 = 100 and an attempt is made to set the setpoint to 50 then
this will be accepted. However a value of 101 will be rejected. C9 and C10 are
also used as low and high range for PID faceplate sliders.

Internal Algorithms
The internal algorithms are used to calculate point values for control or display
purposes or to provide a means to accept values from an operator.

Algorithm 11 - Linear Conversion


pcal = C1*P1 + C2 if abs(pcal) >= C3
pcal = 0 if abs(pcal) < C3
C3 = Deadband, must be >= 0

Algorithm 12 - Weighted Summation


pcal = C1*P1 + C2*P2 + C3*P3 + C4*P4 + C5*P5+ C6*P6 + C7*P7 +
C8*P8 + C9*P9 + C10*P10

Algorithm 13 - Multiplication
pcal = C1*P1*P2

Algorithm 14 - Division
Pcal = C1*P1/P2
If C3 = 0 pcal = C1*P1/P2
If C3 = > 0 then C3 gives the limit for pcal, i.e.
If abs(C1*P1/C3) < abs(P2)
pcal = C1*P1/P2
else
pcal = Sign(C1*P1/P2) * abs(C3)

Algorithm 15 - Exponential
pcal = C1*(P1 raised to the exponent C2)

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms 5

Algorithm 16 - Sampler
The point value of this algorithm will be set equal to the specified sampling
period each time the period expires, else the point value is 0. For example if C1
is 60 seconds, then pcal equals 60 every 60 seconds, else 0.
C1 The sampling period in seconds. C1 must not be smaller than the point
treatment period.
C2 Internal counter used to count down C1 every point treatment period.
if C2 > 0
pcal = 0
else
pcal = C1
See Algorithm 27 - Linear Regression for an example.

Algorithm 17 - Unit Delay


pcal = P1[-1] if P2 <> 0
pcal = unchanged if P2 = 0
Where P1[-1] is the old point value of P1 that was present the last time P2 was
different from 0. Therefore, by specifying an Analog point with the Sampler
algorithm as P2, the point value is constant during the sample period, and the
value is the point value of P1 delayed one sampling period. C1 is used to save
P1.

Algorithm 18 - Integration
If point is report treatment suppressed, PrepSu, then pcal = unchanged
pcal = P[-1] + (P2/C1)*P1 if -C2 < pcal < C2
pcal = C2 if pcal >= C2
pcal = -C2 if pcal <= -C2
If P1 is not specified, P1 = 1.0 in the formula. If P2 is not specified, P2 = the
integration works on the constant value of 0.0 for P2.
Reset of the integration is done through Input P3, i.e.:
1.

If P3 = 0, then integration will take place.

2.

If 0 < P3 < the time in sec. since the last reset, the reset will take place,
i.e. pcal = 0.

3.

If P3 >= the time in sec. since the last reset, then integration will take
place.

4.

If P3 < 0 then reset at Minute = abs(P3)

If the scan time is 10 sec. and if Input P3 is a sampler of 60 sec., then P1 is


integrated every 10 sec. and reset to 0 every minute. If, on the other hand, P3 is a
constant value of 3600, then P1 is integrated every 10 sec. and reset to 0 once
every hour.

6 SDR A-Point Algorithms

Reference Manual for A-Point Algorithms

Algorithm 19 - Differentiation
This algorithm does a slope calculation of input point P1 every time input point
P2 is different from 0. This is achieved by defining P2 with conversion
algorithm sampler (Algorithm 16).
pcal = unchanged if P2 = 0
pcal = C1*(P1-P1[-1])/P2 if P2 <> 0
C2 = Saves P1[-1]. C2 is set equal to P1 every time P2 <> 0.
P2 = Normally a point with sampler algorithm (Algorithm 16).

Algorithm 20 - Dual system identification


This algorithm identifies which Server (Mop) this is;
pcal = 0 if not a dual system
pcal = 1 if Server1 (Mop1) on dual system.
pcal = 2 if Server2 (Mop2) on dual system.

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms 7

Algorithm 21 - SDR - ON
pcal = decimal days since start-up of system.

Algorithm 22 - Relay
pcal = C2*P2 if P1 >= C1
pcal = C3*P3 if P1 < C1

Algorithm 23 - % Subtraction
pcal = (100 - C2*P2 - C3*P3 - C4*P4 - C5*P5)*C1*P1*0.01

Algorithm 24 - Get Statistical Data


This algorithm is used to fetch the statistical data for P1. This is the same data
used in daily reports. The contents of C1 determines which statistical value is
supplied by the algorithm. The algorithm can retrieve statistical data from both
A and B points.
If P1 is an Analog point:
If C1 = 1, pcal = Max value
If C1 = 2, pcal = Min value
If C1 = 3, pcal = Mean value
If C1 = 4, pcal = Report value
C2 determines from which buffer the statistical data is taken
DAY

if C2 = 0

HOUR if C2 = 1
SHIFT if C2 = 2
If P1 is a B-point:
If C1 = 1, pcal = Runhour now
If C1 = 2, pcal = Previous Run hour
C2 determines from which buffer the statistical data is taken
DAY

if C2 = 0

HOUR if C2 = 1
SHIFT if C2 = 2
TOTAL if C2 = 3

8 SDR A-Point Algorithms

Reference Manual for A-Point Algorithms

Algorithm 25 - Maximum Value


pcal = maximum value of n samples of P1
For the number of samples specified in C1, the maximum value of P1 is saved in
C3. C2 is used as a counter. When C2 reaches the value of C1, the point value is
updated, and the comparison is restarted.
P1 Input point
C1 Number of samples "n" to be used.
C2 Internal counter.
C3 Internal storage of maximum value.

Algorithm 26 - Minimum Value


pcal = minimum value of n samples of Point P1.
Same as Algorithm 25, but minimum value of samples is determined.

Algorithm 27 - Linear Regression


pcal = ALFA*C1 + BETA
where ALFA and BETA are the slope and the offset respectively of the
calculated regression line.
The purpose of this conversion algorithm is to approximate a varying signal by a
straight line, as the signal is considered for a given period back in time.
The basis for this calculation is the data stored for trend curve plot of the time
varying signal referred by Input P1. This sequence of data is called:
P1, P1[-1], P1[-2],
From this sequence of data the conversion algorithm takes out a new sequence:
Xi, Xi[-1], Xi[-2],...
where the time interval between successive values is given by Point P2, which
refers to a sampler point (Algorithm 16).
The number of values in the sequence X is specified in C1. Every sampling
instant (from Point P2) the following quantities are evaluated:
A = Sum(Xi) for i = 1,2,...,C1
B = Sum(Xi*Xi) for i = 1,2,...,C1
C = Sum(i) for i = 1,2,...,C1
D = Sum(i*i) for i = 1,2,...,C1
E = Sum(Xi*i) for i = 1,2,...,C1
After that the point value is given by:
P = ALFA*C1 + BETA
where the slope ALFA of the approximating line is given by:
ALFA = (C1*E - C*A)/(C1*D - C2)
and the offset BETA is given by:
BETA = (A - ALFA*C)/C1
The point value thus evaluated is the value on the approximating line
corresponding to the actual time.

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms 9

Finally, the correlation coefficient CORC is calculated, expressing how well the
straight line approximates the time varying signal:
CORC = ALFA * SQRT( (C1*D - C2)/(C1*B - A2) )
where SQRT is square root.
The quantities ALFA, BETA, and CORC are stored in C2, C3, and C4
respectively.
To summarize:
P1 = Point for which linear approximation is desired.
P2 = Sampler point (A-point with Algorithm 16)
C1 = Number of values
C2 = Slope of approximating line (ALFA)
C3 = Offset of approximating line (BETA)
C4 = Correlation coefficient (CORC)

Algorithm 28 - Get Run state of B points


This algorithm is used for setting the pcal value to 1.0 or 0.0 depending on the
Run status of one or more B points. The value in C1 defines whether to AND or
OR the B points.
C1 : If 0.0 => AND the B points, if 1.0 => OR the B points
P1 - P10 : B points

10 SDR A-Point Algorithms

Reference Manual for A-Point Algorithms

Algorithm 29 - Get Point Parameters


pcal = C1, C2, C3, C4, C5, C6, C7, C8, C9 or C10 of P1.
This algorithm is used to read the value of one of the constants C1 - C10 of
another Analog point.
P1 The A-point from where the constant should be read.
C1 Number of the constant to be read, (1 - 10).

Algorithm 30 - Minute Delay


The delay time in minutes is specified in C1.
pcal = P1[-C1 minutes]
where P1[-C1 minutes] is the old point value of Point P1 that was present C1
minutes before. Hence, this algorithm is used to establish a delayed signal of
Point P1.

Algorithm 31 - Flow Measurement


pcal = C1*(1+C2*(10E-6)*(P1-20))*(1+C3*P2/P3)*(SQRT(P2/P3))

Algorithm 32 - 15/30 Mean Max Value


This algorithm calculates the maximum value of Point P1 on
day/week/10day/month base. The calculation takes place every 15/30 minutes,
using the mean value of P1 in this period.
P1: Input point to get value from.
PA1 = 1 Day base.
PA1 = 2 Week base.
PA1 = 3 10 day base.
PA1 = 4 Month base.
PA2 = 1 Point value is the Time for the higest value so far. Eg. 1985 oct 25
13:15 gives: pcal = 1025.1315.
PA2 = 2 Point value is Max value until now.
PA2 = 3 Point value is Mean from last period.
PA3 = 1 15 min Mean.
PA3 = 2 30 min Mean.
C1: MMDD.HHMM for the end of todays Max value period.
C2: Number of values for period.
C3: Last period mean value.
C4: Max value of the day.
C5: Summation for period.

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms 11

Algorithm 33 - Run Factor


This algorithm calculates the run factor in percent of equipment
configured with a B-point.
pcal = 100 * (Run_hours_for_P1)/(Run_hours_for_P2)
P1 = B-point for sub equipment.
P2 = B-point for main equipment.
C1 = 1, Run hours used in calculation are based on 24-hour-base (those which
are reset every 24 hours).
C1 = 2, Run hours used in calculation are based on continuous run hour
accumulation (those which are not automatically reset).

Algorithm 34 - Normal State Counter


This algorithm is used to supervise another point's status.
The output is a ramp beginning when point P1 enter normal state and
ends when the normal state ends. The value of the ramp is elapsed
minutes.
pcal = p-i + delta_time if P1 in normal state.
pcal = p[-i] + delta_time if P1 in normal state.
pcal = 0 if P1 changes state from not normal to normal.
pcal = p-I if P1 in NOT normal state.
pcal = p[-i] if P1 in NOT normal state.
The time is in format MM.SS

Algorithm 35 - P1/Normal, P2/Alarm


Select the pointvalue from value of P1 or P2 depending on the state of P3 which
must be a B-point:
pcal = P1 If P3 is in normal state.
pcal = P2 If P3 is NOT normal.

Algorithm 36 - Copy B point value


Copy of B point value, C1 decides whether to copy the MSW or Text number.
C1 : 0.0 => MSW used for copy. 1.0 => Text number used for copy.

Algorithm 37 - Standard Deviation


pcal = sqrt(((P12+P22+..)*Np-(P1+P2+..)2)/(Np * (Np -1)))
Where Np is number of point values.

Algorithm 38 - Average Value


pcal = ( P1 + P2 + ... ) / Np
Where Np is number of point values.

12 SDR A-Point Algorithms

Reference Manual for A-Point Algorithms

Algorithm 39 - FUZZY STORE Point


This conversion algorithm is used for updating the point value by the
STORE-declaration of the Fuzzy Control Language, refer to the FLS-FCL
REFERENCE MANUAL.
C9 and C10 = Limits for input. C9 is the low limit and C10 the high limit. So if
C9 = 0 and C10 = 100 and an attempt is made to set the setpoint to 50 then this
will be accepted. However a value of 130 will be rejected. If C9=0 and C10=0
then no limit checking is done.

Algorithm 40 - Kiln Ramp Generator


cal = C1 + C5 * C4 while Ramp is 'running', i.e. C4 < C3.
pcal = C2 when end value has been reached, i.e. C4 = C3.
This algorithm is used to generate a Ramp signal.
The start and end values of the Ramp and the duration (in minutes) are specified
in C1, C2 and C3 respectively.
C4 is used by the algorithm as a counter and equals the number of minutes since
the Ramp was started. The Ramp is started by setting C4 equal to -1.
C5 is the slope of the Ramp, calculated by the algorithm, using the values of C1,
C2 and C3.
If Point P1 and/or Point P2 are specified, the current values of these points when
the Ramp is started, are used as start and end value respectively. The points
specified as Point P1 and/or Point P2 must be Analog points.
Constant C1: Start value.
Constant C2: End value.
Constant C3: Time duration of Ramp.
Constant C4: Running counter.
Constant C5: Slope.

Algorithm 41 - Operator Inserted


pcal = operator_inserted_value
The point value is supplied by the operator. Values outside the alarm limits are
not accepted, if the point's configuration.
C9 and C10 = Limits for input. C9 is the low limit and C10 the high limit. So if
C9 = 0 and C10 = 100 and an attempt is made to set the setpoint to 50 then this
will be accepted. However value of 130 will be rejected. If C9=0 and C10=0
then no limit checking is done.

Algorithm 42 - Logarithm
pcal = Log10(P1) or Log(P1)
P1 : Analog value to get logarithm of.
C1 : If 10.0 use Log10, otherwise natural Log.

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms 13

Algorithm 50 - Set value as constant


This algorithm creates a point as a constant.
pcal = C1
C1 : Constant value to place in point value.

Algorithm 51 - Multiplication of multiply points


pcal = P1*C1 * P2*C2 * P3*C3 * .P10*C10
P1- P10 : Points to multiply together.
C1 - C10 : Constants to multiply together.

Algorithm 92 - Test Time Ramp Function


If C5 = 0, not decimal time:
Algorithm used to test the SDR log system. The point value is set equal to an
element of the current time depending on the value of C1. Times are not
decimal, eg if C1 = 2, pcal is in the range 0 to 59.59. If C1 = 3, pcal is in the
range 0 to 23.5959.
C1 = 1, pcal = <current_second>
C1 = 2, pcal = <current_minute> + <current_second>/100
C1 =
3,
pcal
=
<current_second>/10000

<current_hour>

<current_minute>/100

C1 = 4, pcal = <current_day> + current_hour>/100 + <current_minute>/10000


+ <current_second>/1000000
C1 = 5, pcal = < current_day>
C1 = 6, pcal = <current_month> + <current_day>/100
If C5 = 1, decimal time:
Algorithm used to test the SDR log system. The point value is set equal to an
element of the current time depending on the value of C1. All times are decimal,
eg if C1 = 2, pcal is in the range 0 to 59.99.
C1 = 1, pcal = <current_second>
C1 = 2, pcal = <current_minute> + <current_second>/60
C1 = 3,
pcal =
<current_second>/3600

<current_hour>

<current_minute>/60

C1 = 4, pcal = <current_day> + current_hour>/24 + <current_minute>/1440


+ <current_second>/86400
C1 = 5, pcal = < current_day>
If C5 = 2, hour value:

14 SDR A-Point Algorithms

Reference Manual for A-Point Algorithms

Algorithm used to test SDR log system. The point value is set equal to the
current integer hour value minus C1. If C1 = 0 then pcal is in the range 0 to
23.
pcal = HOUR - C1
If C5 = 3, day value:
Algorithm used to test SDR log system. The point value is set equal to the
current integer value day of month minus C1. If C1 = 0 then pcal is in the
range 1 to 31.
pcal = DAY_OF_MONTH - C1
Note that this algorithm can be used to transfer the current date or time to an Apoint for display in e.g. Opstation.

Algorithm 93 - Test Ramp Function


Algorithm used to test various SDR functions. The trend of the point value will
be a sawtooth function between C2 and C3, incremented by C1 every point
treatment period.
Constant C1:

Point value increment.

Constant C2:

Low limit of ramp.

Constant C3:

High limit of ramp.

Algorithm 94 - Point server status information


Algorithm used to show different status counters from the point server, mainly
used for system performance evaluation. The C1 constant will determine which
figure will be placed in the pcal value;
Constant C1 =
1: A point treat cycle in msec
2: B point treat cycle in msec
3: A point treat time used in msec
4: B point treat time used in msec
5: Dynamic data to Jet, time used in msec
6: Statistical data to Jet for A points, time used in msec
7: Statistical data to Jet for B points, time used in msec
8: Call to doIosPointTreat pr. Sec, reset by cyclic treat
9: Call to doIosBlockTreat pr. Sec, reset by cyclic treat
10: Call to Aptrt pr. Sec, reset by cyclic treat
11: Call to BpTrt pr. Sec, reset by cyclic treat
12: Number of active A points
13: Number of active B points

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms 15

Alarm algorithms
This is a list of the available alarm algorithms in the ECS/SDR system. An
alarm/event algorithm can be specified when configuring points and
departments.

Algorithm 0 - No logging, No annunciating


Events (error, warning, information) will not be logged or annunciated.

Algorithm 1 - Logging, no annunciating


Events (error, warning, information) will be logged, but not annunciated.

Algorithm 2 - Logging and annunciating


Events (error, warning, information) will be logged and annunciated.

16 SDR A-Point Algorithms

Reference Manual for A-Point Algorithms

Report algorithms for A-points


The report algorithm is used to calculate an additional statistical value, which is
normally called calculated value. The value calculated is in plant reports under
the name Calc (Calculated by report algorithm). Note that a report day is from
report hour to the next report hour.

Algorithm 0 - No reporting
No specific report calculation.

Algorithm 1 - Simple mean value


CalcVn+1 = (n*CalcVn + p)/(n+1)
The algorithm calculates the current mean value of the pvalue. The value is
adjusted on each scan. After the daily reporting n is reset at the specified report
hour, which means that a new accumulation starts.

Algorithm 2 - Accum. per hour


CalcVn+1 = CalcVn + p/(3600/scan period)
Example: The point value is given in ton/h and thus CalcV will have the unit
ton.

Algorithm 3 - Accum. per minute


CalcVn+1 = CalcVn + p/(60/scan period)
As algorithm 2, but for signals on minutes basis. Example: The point value is
given in L/min. acv will have the unit L.

Algorithm 4 - Accum. full hour


CalcVn+1 = CalcVn + p n=1, where n = full hour
The advantage of this algorithm is that the reported full hour values will add to
this accumulated value. The value logged is taken from the and of the hour, thus
for 13:00 to 14:00, the value is taken at 13:59.
Notice that this calculation is not an accurate reflection of the process flow.
(Management report)

Algorithm 8 - Mean(full hour val.)


As algorithm 1, but only for the full hour values.
Notice that this calculation is not an accurate reflection of the process flow.
(Management report)

Algorithm 9 - Stan. dev(point val.)


CalcVn = SQRT([mean(X2) - (mean(X))2] * N/(N-1))
= SQRT([suma(X2) - (suma(X))2]/N]/N/(N-1))
Where X is the point value, and N the number of values since report hour.

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms 17

Calculation is performed at every cycle of the point treatment.

Algorithm 10 - Sampling, report hour


The accumulated value is set equal to the point value at report hour. The value
for a report hour day is taken at the end of the day.
CalcVn = pn, where n = report hour
Note that the mean value for the previous 24-hour period is also set to the point
value at report hour.

Algorithm 11 - Stan. dev(Operat ins)


The deviation calculation is as report algorithm 9.
Calculation is performed whenever a new value is entered.

18 SDR A-Point Algorithms

Reference Manual for A-Point Algorithms

B-point calculation algorithms


The purpose of B point calculation algorithms is internally to calculate an MSW
value of a B point, and thereafter applying this value to the B point Algorithm.
So the MSW is generated internally and not coming from the PLCs when the
algorithm number is > 0.
Please notice that these algorithms should not be used on points with an PLC
input address, the result will be unpredictable.

Algorithm 0 - No algorithm
No internal calculation performed.

Algorithm 1 - Copy B point msw


msw = msw of P1

Algorithm 2 - Bit mask, move right


msw = (P1 AND C1) >> C2, where >> means shift right.
Example:
P1 msw = 0110
C1= 4, which is 0100 binary
C2 = 1
msw = 0010 bianry.

Algorithm 3 - Unpack single bit


msw = (P1 >> C1) AND 1, where >> means shift right.
C1 is the number of bites to shift right, (0 to 15).
Example:
P1 msw = 0110
C1= 2
msw = 0001 bianry.

Algorithm 4 - Pack single bits


This alg packs up to 10 B points MSWs into one B point. Only bit 0 is used from
each of the reference points. Bit 0 is set to bit 0 of reference point 1, bit 1 is set
to bit 0 of reference point 2, etc.

Algorithm 5 - Pack bits with mask


msw = (P1 AND C1 << 0) OR (P2 AND C2 << 1) OR (P3 AND C3 << 2) |
OR (P4 AND C4 << 3) OR . OR (P10 AND C10 << 9)
Where << means shift left.

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms 19

Algorithm 6 - Copy A point value


msw = A point value

Algorithm 7 - A point status


msw = 1 if A point normal and not alarm suppressed
msw = 0 if A point in alarm or suppressed

Algorithm 8 - A point Alarm level


msw = C1 if A point in high alarm
msw = C2 if A point in normal range
msw = C3 if A point in low alarm

20 SDR A-Point Algorithms

Reference Manual for A-Point Algorithms

Algorithm 9 - Make constant


Creates a B point as a constant
msw = C1

Algorithm 10 - Watchdog pulse


msw = 1 or 0, pulse signal
C1 : Seconds in On condition, msw = 1
C2 : Seconds in Off condition, msw = 0

Algorithm 11 - Pulse trigger


msw = 1 or 0, depending on constants
C1 : Seconds in On condition, msw = 1
C2 : Seconds in Off condition, msw = 0
C3 : Seconds after midnight when to start cycle with On

Algorithm 12 - Pack multiple bits


msw = P1 .. P10 packed into bit positions equal to the ref position. All 16 bits
will be filled, using bits from previous Px ref.
P1..P10 : B points
Example.: P1, P4 and P7 contain B point references;
Bit 0-2 equal to bit 0-2 from P1
Bit 3-5 equal to bit 0-2 from P4
Bit 6-15 equal to bit 0-9 from P7

Algorithm 13 - Runhour test min


Algorithm used for test of Log system statistics.
msw = 1 if minute <= C1
msw = 0 if minute > C1
C1 : limit for minute, 0 - 60
Example.: If C1 set to 20, the different statistics should show a Runhour count
of 1/3 of the time; i.e. Daily Runtime = 8 hours.

Algorithm 14 - Runhour test date


Algorithm used for test of Log system statistics.
msw = 1 if hour <= date (day in month)
msw = 0 if hour > date
This will course the Daily Runhours to show a number equal to the date of the
month, and for date > 24, the number is 1 - 7.

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms 21

Algorithm 15 - MSW range test


This alg will cycle through the MSW range defined via C1 and C2, and increase
the msw by one every point treat cycle.
msw = msw + 1 if within range
C1 : Lower range for MSWs
C2 : Upper range for MSWs

Algorithm 16 - Stat flags test


Alg sets MSW to 1 for one point treat cycle, when one of the 4 statistical flags
are set in the Point Server;
msw = 1 if flag
C1 : 1 = Full Day, 2 = Full Shift, 3 = Full Hour, 4 = Full Minute
When any of these flags are set, it is a signal to the Log server to retrieve
statistical data from the point server.

Algorithm 17 - Dual block point


The purpose of this algorithm is to be used to determine which server in a dual
system the associated B-point is running on. This can be server1 or server2
(MOP1 or MOP2).
The following point parameters can be used,
following 3 possibilities:

Ref1 and C1. There are the

Ref1 = A-point and C1 not used. If the Ref1 A-point value equals the server
number that the Ref1 A-point is running on (1 or 2) then the B-point MSW is set
to 1, else 0.
Ref1= B-point and C1 not used. If the Ref1 B-point MSW equals the server
number that the Ref1 B-point is running on (1 or 2) then the B-point MSW (this
point) is set to 1, else 0.
Ref1 not used and C1 = 1 or 2. If C1 equals the server number that this B-point
is running on (1 or 2) then the B-point MSW is set to 1, else 0.

22 SDR A-Point Algorithms

Reference Manual for A-Point Algorithms

Report algorithms for B-points


Algorithm 0 - No reporting
No reporting.

Algorithm 1 - Operating hours


The time (decimal hour) the point state has been normal. The value is reset at
report hour.

Algorithm 2 - Continuous Oper. hrs


The same as algorithm 1, but values are summed (not reset automatically).

Reference Manual for A-Point Algorithms

SDR A-Point Algorithms 23

Glossary of Terms

Reference Manual for A-Point Algorithms

Glossary of Terms 25

Reference Manual

ECS/SDR B-Point
Algorithm Editor

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 5
$Modtime:: 11/27/01 11:33a
Herlev Chr. Thomsen
$Author:: Ngb
$Workfile:: SdrBpeUi30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further
and future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS/SDR B-Point Algorithm Editor ........................................................ 1
Introduction ................................................................................................................................ 1
B-Point Algorithm Description .................................................................................................. 2
Input Operation ................................................................................................................... 2
Output Operation ................................................................................................................ 3
B-Point Algorithm Editor........................................................................................................... 4
B-Point Algorithms .................................................................................................................... 5
Edit Algorithm .................................................................................................................... 5
Delete Algorithm................................................................................................................. 6
Create Algorithm................................................................................................................. 6
Copy Algorithm .................................................................................................................. 6
Print Algorithm ................................................................................................................... 7
B-Point Algorithm Properties..................................................................................................... 8
Property Descriptions.......................................................................................................... 8
Property Assignments ......................................................................................................... 9
Machine Status Words ............................................................................................................. 10
MSW Attributes ................................................................................................................ 10
Editing MSWs................................................................................................................... 12
Value Text................................................................................................................................ 13
Value Text Strings ............................................................................................................ 13
Library...................................................................................................................................... 15
Open an Existing Library File........................................................................................... 16
Create a New Library File................................................................................................. 19

Glossary of Terms.........................................Error! Bookmark not defined.

Reference Manual for SDR B-Point Algorithm Editor

Contents i

ECS/SDR B-Point Algorithm


Editor

Introduction
The information required to create and edit B-Point algorithms is presented in
the following sections:

B-Point Algorithm Description

B-Point Algorithm Editor

B-Point Algorithms

B-Point Algorithm Properties

Machine Status Words

Value Text

B-Point Algorithm Library

Reference Manual for SDR B-Point Algorithm Editor

ECS/SDR B-Point Algorithm Editor 1

B-Point Algorithm Description


The purpose of the B-point algorithm is to process digital values between the
ECS/SDR and PLC systems. The digital values are transferred as a 16 bit word
called a Machine Status Word (MSW). When the word is read from the PLC, the
algorithm establishes a B-point value and other attributes based on the MSW bit
combination. The algorithm also sends information to the PLC by setting a bit
combination in the MSW. The PLC memory location of the MSW for input and
output is assigned in the B-point Address field.
When the algorithm is created, an input mask is specified to identify the bits that
are to be analyzed. An output mask is also specified to identify the bits to be
processed by the PLC.

Input Operation
In the following example, the user has created an algorithm to interpret 2 bits of
the PLC MSW. The input mask is created by setting each bit location to be
processed to a one (1). The input mask in this case is: 0000000000000011
Input

Value

Color

00

Stop

brown

01

Local

yellow

10

Run

green

11

Fault

red

The value and color of the B-point is determined by the state of the two bits. For
example, when both bits are zero (0), the B-point value is Run and graphical
elements associated with the B-point change to brown.
When the MSW is read from the PLC, the following rules apply:
1.

A maximum of 16 bits are processed by a B-point.

2.

The bits must reside in the same word within the PLC memory.

3.

A maximum of 16 bits can be affected by output actions.

4.

Up to 65,768 bit combinations can be represented by the 16-bit MSW.


The combination with all 16 bits set however can not be used.

Each bit combination identified in the algorithm has an associated Value, Status,
Color, Symbol Offset, and Alarm State.

Value
The Value is assigned by entering a Text #. This number identifies the text to use
when presenting the B-point value in reports, value lists, and graphics. The
number selects the text from a predefined list that can be modified by the user.

Status
Identifies the B-point status (Normal or Alarm)

Color
Graphic elements owned by the point change to the assigned color.

2 Contents

Reference Manual for SDR B-Point Algorithm Editor

Symbol Offset
This field is used in conjunction with a symbol offset graphic element that
contains up to 8 stacked objects (0 - 7) arranged in such a way that only the top
object is visible. This field specifies the graphic object (0 - 7) to be associated
with the bit combination. When the B-point is equal to this bit combination, the
associated object is placed on the top of the stack.
Alarm State
Determines if the bit combination indicates an alarm state (Yes or No).

Output Operation
A B-point algorithm can initiate an output action in one of two ways. The first
method requires an output mask and an output bit combination to be specified.
These elements have been added to the previous example:
Input Mask = 0000000000000011
Output Mask = 0000000000000001
Input

Value

Color

Output Enabled

00

Stop

brown

No

01

Local

yellow

No

10

Run

green

No

11

Fault

red

Yes

Output

0000000000000001

When the MSW input bit combination is equal to Fault (11),


0000000000000001 is sent to the PLC memory location specified in the output
portion of the points Address field.
The second method requires that the algorithms Prg. Select Enable field to be
set to Yes. This causes the Bit specified in the output portion of the points
Address field to be set to one (1) whenever a graphic element owned by the
point is clicked with the middle mouse button.
Warning. Be very careful with output action. Bad algorithms can cause a point
MSW to oscillate. It is strongly recommeded to use output actions with
command bits requesting the PLC to set or clear something, and then using other
bits on input to see if it has been done. For example the Computer Control
Ready algorithm looks like this, where the input mask is 1100 0001 and the
output mask is 0000 0001:
Input

Value

Output Action

0000 0000

Off

0000 0001

On

1100 0000

Clear

0000 0000

1100 0001

Set

0000 0001

For very complex situations it is recommended not to use identical input and
output addresses so as to avoid oscillations by accident.

Reference Manual for SDR B-Point Algorithm Editor

ECS/SDR B-Point Algorithm Editor 3

B-Point Algorithm Editor


The B-point algorithm editor is used to create, modify, review and delete Bpoint algorithms and create and modify the text strings used to represent MSW
values. The editor is started by selecting B-Point Alg Edit in the ECS/SDR
portion of the desktop Start menu.

Click on the Algorithms tab to create, edit, copy, delete or print B-point
algorithms.
Click on the Texts tab to create or modify the text strings used to represent
MSW values.
Click on the Library tab to open, create, or populate a B-point algorithm library
file.
To close the B-point algorithm editor, click on the Close button in the upperright corner of the window.

4 Contents

Reference Manual for SDR B-Point Algorithm Editor

B-Point Algorithms
To access the B-Point algorithms, click on the editor Algorithms tab.

Select the algorithm to manipulate by clicking on the algorithm Number, and


then click on the desired command. To display the actual contents of the B-point
algorithm database (which might be accessed by several users), click on the
Refresh button. Click on the Close button in the upper-right corner of the
window to exit the B-Point Algorithm Editor.

Edit Algorithm
Select the algorithm to modify by clicking on the algorithm Number. The
algorithm master data appears at the bottom of the dialog. Click on the Edit
MSWs button to edit the algorithm detail data, MSWs (Machine Status Words).

Reference Manual for SDR B-Point Algorithm Editor

ECS/SDR B-Point Algorithm Editor 5

Delete Algorithm
Select the algorithm to delete by clicking on the algorithm Number then click
on the Delete command. When the dialog form appears, click on the OK
command to delete the selected algorithm. Click on the Cancel command to
abort the deletion.

Create Algorithm
To create a new algorithm, click on the Add command. When the dialog form
appears, enter a unique number to be assigned to the algorithm. Numbers from 1
through 500 are acceptable. If the number is currently assigned to another
algorithm, a dialog message appears.

Click on the OK command. The algorithm properties window appears. Refer to


Algorithm Properties.

Copy Algorithm
To create a new algorithm with the properties of an existing algorithm, select the
existing algorithm by clicking on the algorithm Number. Click on the Copy
command. When the dialog form appears, enter a unique number to be assigned
to the new algorithm. Numbers from 1 through 200 are acceptable. If the number
is currently assigned to another algorithm, a dialog message appears.

6 Contents

Reference Manual for SDR B-Point Algorithm Editor

Click on the OK command. The algorithm properties window appears. Refer to


Algorithm Properties.

Print Algorithm
Select the algorithm to print by clicking on the algorithm Number. Click on the
Print command to print the selected algorithm. Click on the Print All command
to print all B-point algorithms.

Reference Manual for SDR B-Point Algorithm Editor

ECS/SDR B-Point Algorithm Editor 7

B-Point Algorithm Properties


The details associated with a B-point algorithm are contained in the algorithm
properties. The properties are listed in the window that appears when an
algorithm is created or modified.

Property Descriptions
Algorithm name <primary language> The descriptive name of the B-point in
the primary language
Algorithm name <secondary language>The descriptive name of the B-point
in the secondary language
Algorithm number A unique number identifying the algorithm. This number
is referenced when assigning a Conversion Algorithm to a B-point.
Input mask, 16 bits Used to assign the MSW input mask. Only the bits
specified in the mask are processed by the algorithm. The mask is entered as
binary number. The bit locations with a one (1) are processed.
Output mask, 16 bits Used in connection with output actions. Only the bits
specified by a 1 in this mask can be modified in the PLC memory. .
Local bit, 15-0 Specifies the bit number betrween 0 and 15 that is used as the
local bit. When the local bit is equal to 1, the status of the B-point is Local and
the point does not generate alarms. If the local bit option is not used, enter a -1
in this field.
Operator inserted mode Flag specifying if the B-point can be used as an
operator inserted point. Setting this flag does not affect the operation of the
algorithm.
Action bit, 15-0 (-1=none) If between 0 and 15, defines the bit offset relative
to the B-point's output address that is sent to the PLC when the point is selected.
For example if the Output address is Register 200, bit 2, and the Action bit is 3,
then bit 5 (2 + 3) will be used for selection. The function is disabled when the bit
number is set to -1. This flag is only applicable to systems with an OpStation.
The Machine Status Words (MSWs) associated with the B-point algorithm are
defined and configured or modified by clicking on the Edit MSWs. Refer to
Machine Status Words.

8 Contents

Reference Manual for SDR B-Point Algorithm Editor

Property Assignments
Properties are assigned or modified by clicking in the field and typing or
selecting the new or modified information. Refer to the ECS/SDR User
Interface manual for additional information.
The following commands are used to save the property assignments:
Apply Saves the modifications made since the property window was opened.
The property window remains open.
Update Saves the modifications made since the property window was opened.
The property window closes.

Reference Manual for SDR B-Point Algorithm Editor

ECS/SDR B-Point Algorithm Editor 9

Machine Status Words


The algorithm Machine Status Word (MSW) bit values and associated attributes
are revealed by clicking on the Edit MSWs command in the algorithm
properties window. A window appears listing the defined MSWs in a data grid.
Each row in the grid represents one MSW. The data grid columns identify the
MSW attributes.

MSW Attributes
The following describes the MSW attributes identified by the data grid column
labels.
MSWs The MSW bit combination (0000 0000 0000 0000 through 1111 1111
1111 1111). An x can be used to identify a dont care state. For example 0000
0000 0000 x111.
Value The text string that represents the B-point value for this MSW bit
combination
State Identifies the status for this B-point value - Normal or Alarm.
Color When the B-Point reports this value, display elements associated with the
point change to the color specified in this column.
S-Off Symbol Offset. This field is used in conjunction with a symbol offset
graphic element that contains up to 8 stacked objects (0 7) arranged in such a
way that only the top object is visible. This field specifies the graphic object (0
7) to be associated with this bit combination. When the B-point is equal to value,
the associated object is placed on the top of the stack.
OS Operating state. Determines if operating hours are counted or not for this
MSW - Yes or No
AS Alarm State. Determines if this B-point value indicates an alarm state, Yes
or No.
AA Alarm Annunciation. Determines if this B-point value should result in an
alarm annunciation, Yes or No.
SS Suppression State. Used by Group and Route points (Group/Route
suppression points), to specify if the associated MSW should alarm suppress
child points in Group or Route.
Event type Specifies if the transition to the associated MSW should be alarm
logged as a 1-Error, 2-Warning, 3-Info, or not at all 0-none.

10 Contents

Reference Manual for SDR B-Point Algorithm Editor

Category Specifies the event category, 0-None, 1-Point Specifies, 2-Process,


etc.
Output Action When the B-point value is equal to this MSW bit combination,
the bit combination specified in this field is sent to the PLC location specified in
the B-points address field.

Reference Manual for SDR B-Point Algorithm Editor

ECS/SDR B-Point Algorithm Editor 11

Editing MSWs
Add Appends a new line at the bottom of the MSW list and selects the field for
editing. All attributes for the new MSW are set to the default values. The default
values are the attributes assigned to the MSW at the top of the list. The
maximum number of MSWs per algorithm is 299.
Delete Deletes the selected MSW
Insert Inserts a new MSW in the line below the selected MSW
Move Up Moves the selected MSW up one line in the list of MSWs
Move Down Moves the selected MSW down one line in the list of MSWs
Apply Saves modifications. The Edit MSW window remains open for
additional changes.
Update Saves modifications and closes the Edit MSW window.
Cancel Discards changes made since the last Apply was issued.

12 Contents

Reference Manual for SDR B-Point Algorithm Editor

Value Text
The text strings available for assignment to B-point values can be reviewed or
modified by clicking on the Texts tab located in the B-Point Algorithm Editor
display followed by activation of the Edit button.

Value Text Strings


Modifying Text Strings
To modify a value text string, click in the text field and press the keyboard <F2>
key. Enter the desired information. Value text strings 1 through 20 are
reserved for the ECS/SDR system. Do not modify.
Apply Saves modifications. The Value Text window remains open for
additional changes. You MUST press Apply after you have modified texts.
Update Saves modifications and closes the Value Text window.

Reference Manual for SDR B-Point Algorithm Editor

ECS/SDR B-Point Algorithm Editor 13

Adding Text Strings


To add a new value text string, click on the Add command. Enter the Text No.
when the prompt appears. Acceptable values are 21 through 2000. Value text
strings 1 through 20 are reserved for the ECS/SDR system.

A text string can be up to 20 characters long, but only the first 10 characters
appear on OpStation displays. You MUST press Apply after you have added
texts.

Deleting Text Strings


To delete a value text string, select the entry and press the Delete key. Press
OK to delete the value text. Click on the Cancel command to abort the deletion.
You MUST press Apply after you have deleted texts.

Show Algorithms
The algorithms that use a particular value text can be listed by selecting the
value text entry and pressing the Show algs. command.

14 Contents

Reference Manual for SDR B-Point Algorithm Editor

Library
To open an existing B-point algorithm library file or create a new one, click the
Library tab.

Reference Manual for SDR B-Point Algorithm Editor

ECS/SDR B-Point Algorithm Editor 15

Open an Existing Library File


Type in the full path to the desired B-point algorithm library file and click on the
Open command. In response to this action a window is opened showing the
contents of the library file together with the actual contents of the runtime
database.

16 Contents

Reference Manual for SDR B-Point Algorithm Editor

Now, it is possible to transfer B-point algorithms in both directions between the


runtime database and the library.

Transfer Data from the Library to the Runtime Database


Select the algorithm to be copied by clicking on its number in the Library field
and activate the "<" button. (When sub numbering is applied there can be
several algorithms with the same number. If that is the case, select the algorithm
with the desired number/sub number combination.)
An attempt to copy a library algorithm will initiate a request for information
about where to deliver the algorithm.

Type in the desired destination (Runtime Database) number and click OK,
alternatively cancel the operation by clicking Cancel. In response to clicking
OK, a message will appear.

Reference Manual for SDR B-Point Algorithm Editor

ECS/SDR B-Point Algorithm Editor 17

Activate OK to start the copy process or Cancel to abort the whole operation.

Transfer Data from the Runtime Database to the Library


Select the algorithm to be copied by clicking on its number in the Runtime
Database field and activate the ">" button.
An attempt to copy a runtime database algorithm will initiate a request for
information about where to deliver the algorithm.

Type in the desired destination (Library) number and sub number and click OK,
alternatively cancel the operation by clicking Cancel. In response to clicking
OK, a message will appear.

Activate OK to start the copy process or Cancel to abort the whole operation.

18 Contents

Reference Manual for SDR B-Point Algorithm Editor

Create a New Library File


Type the full path to the new library file and click the Create command. A
message will announce whether the command was completed successfully or
failed. For example, an error may occur if the specified file exists.
When a new library file has been created it can be opened and populated by
copying data from the Runtime Database.

Reference Manual for SDR B-Point Algorithm Editor

ECS/SDR B-Point Algorithm Editor 19

Reference Manual

ECS/SDR Block Algorithm


Configuration

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 3
$Modtime:: 7/17/01 4:16p

$
$

$Author:: Ngb
$Workfile:: SdrBlkAlgCfgUI30_English.doc
0-1000

$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS/SDR Block Algorithm Configuration ............................................... 1
Introduction ................................................................................................................................... 1
Block Algorithms.......................................................................................................................... 1
Block Algorithm Configuration.................................................................................................... 2
Block Algorithm Selection .................................................................................................... 2
Buttons ................................................................................................................................... 2
Block Algorithm Creation ..................................................................................................... 3
Block Algorithm Editing .............................................................................................................. 3
Parameter Properties.............................................................................................................. 4
Record Navigation ................................................................................................................. 5
Record Editing ....................................................................................................................... 6
Record Creation and Removal .............................................................................................. 6

Glossary of Terms ..................................................................................... 9


Index.......................................................................................................... 11

Reference Manual ECS/SDR Block Algorithm Configuration

Contents i

ECS/SDR Block Algorithm


Configuration

Introduction
Block Algorithm Configuration is a utility for defining block algorithms used for
interpretation of PLC parameters.
PLC parameters are subject to special object oriented IO where parameters in the
PLC may be displayed and modified directly from an OpStation mimic or
faceplate. There are no database points involved as the parameters are requested
by direct IO from the source (PLC) to the sink (Picture).
The use of PLC parameters in OpStation pictures is described in the ECS
OpStation Editor Reference Manual.
The Block Algorithm Configuration utility is activated from the Start menu
selecting ECS NTech -> Administration Tools -> Block Alg. Configuration

Block Algorithms
A block algorithm describes the internal layout of a parameter block in a PLC.
A block algorithm is uniquely determined by

Point type (A or B)

Conversion algorithm

IO system

For a given point the address of the parameter block in the PLC is defined as part
of the IO address specification.
Each PLC parameter described in the block algorithm is identified by a
Parameter key which is unique within the block algorithm.
Given a point and a parameter key the PLC parameter is fully accessible. The
points PLC parameter IO address defines start address of the parameter block.
The point attributes Point type, Conversion algorithm and IO system identifies
the block algorithm and the Parameter key identifies the parameter description
in the block algorithm.
The detailed layout of block algorithms is described in section "Block Algorithm
Editing".

Reference Manual ECS/SDR Block Algorithm Configuration

ECS/SDR Block Algorithm Configuration 1

Block Algorithm Configuration


Upon activation of the Block Algorithm Configuration utility the form Block
Algorithm Configuration is displayed.
The grid shows a list of the currently defined block algorithms.
Note that each algorithm is uniquely defined by Point type, Conversion
Algorithm and IO System and has a unique name.
A number of functions apply to the algorithms.
To activate a function do:

Select one or more algorithms

Press a function button

Figure 1 - Block algorithm configuration form

Block Algorithm Selection


A block algorithm is selected by single click anywhere on the grid line
describing the algorithm.
A contiguous sequence of algorithms may be selected by Shift down, Click
first, Click last, Shift up.
A non contiguous sequence of algorithms may be selected by Ctrl down, Click
first, Click second, Click third , Ctrl up.
The selected lines are highlighted.

Buttons
Edit - Displays the selected algorithm for editing (see section "Block Algorithm
Editing"). A single algorithm must be selected. The function may also be
activated by double click on a line.
Print - Generates a print out of the selected algorithms. Multiple algorithms may
be selected.

2 ECS/SDR Block Algorithm Configuration

Reference Manual ECS/SDR Block Algorithm Configuration

Add - Create a new algorithm and start editing it. No selection applicable.
Copy - Create a new algorithm with content copied from the selected one. A
single algorithm must be selected.
Delete - Delete the selected algorithms. For each algorithm actual deletion has to
be confirmed. Multiple algorithms may be selected.
Help - Display help information.
Close - Close down the utility.

Block Algorithm Creation


Add or Copy function will prompt the user for information to define a new
block algorithm on the following form.

Figure 2 - Create new algorithm form

Fill in the form as follows:

Enter a nonexistent Block algorithm number

Enter Block algorithm name in text edit box. The name MUST be
unique.

Press OK to create new algorithm or Cancel to quit the operation.

Note that Point Type, Conversion algorithm and IO System together must be
different from any existing algorithm. If this is not the case an error message is
shown.

Block Algorithm Editing

Reference Manual ECS/SDR Block Algorithm Configuration

ECS/SDR Block Algorithm Configuration 3

Figure 3 - Block algorithm edit form

The Block Algorithm Edit form is displayed when block algorithm editing is
activated.
The top text field shows the block algorithm name.
The Record Edit grid shows one record of the algorithm describing one PLC
parameter.
Close - Will terminate editing the algorithm and return to the algorithm
configuration form.
Help - Will display help information for the Block Algorithm Edit form

Parameter Properties
A PLC parameter is described by the following properties:
1. Parameter key - Text string identifying the parameter. Must be unique within
the algorithm.
2. Parameter name local - Text string in local language describing the
parameter.
3. Parameter name default - Text string in default language describing the
parameter.
4. Parameter type - Type of parameter as one of (drop down list):
1.

Integer

2.

Unsigned

4 ECS/SDR Block Algorithm Configuration

Reference Manual ECS/SDR Block Algorithm Configuration

3.

Bit Pattern

4.

IEEE Float

5.

Special Float 1

6.

Special Float 2

7.

BCD

Parameter size - The size in bits of the parameter in the PLC.


Normalize - If enabled the parameter value will be normalized
Conversion - Type of conversion applied to the parameter value (drop down
list):
0.

Use raw value

1.

Use gain, offset from point

2.

Use gain ,offset from table

8. Read Offset - Word offset in parameter block for read address of parameter
value.
9. Read bit number - Bit number within read offset for read address of
parameter value.
10. Allow write - If enabled the parameter value may be modified, otherwise
not.
11. Write offset - Word offset in parameter block for write address of parameter
value.
12. Write bit number - Bit number within write offset for write address of
parameter value.
13. Gain - Floating point scaling factor. Applicable for conversion type 2.
14. Offset - Floating point offset. Applicable for conversion type 2.
15. Format - Value format as one of (drop down list):
0.

1234567

1.

123456.7

2.

12345.67

3.

1234.567

4.

123.4567

5.

12.34567

16. Unit - Engineering unit for the parameter value (drop down list).
17. Minimum write value - Floating point low limit for acceptable write value.
18. Maximum write value - Floating point high limit for acceptable write value.

Record Navigation
Individual records in the block algorithm is selected using the record navigation
bar shown below.

Figure 4 - Record navigation bar

Reference Manual ECS/SDR Block Algorithm Configuration

ECS/SDR Block Algorithm Configuration 5

Sequential navigation
The arrow buttons from left to right select first, previous, next and last record
respectively.
Random navigation
The drop down list contains parameter keys for all defined records in the
algorithm. Selecting a key from the list will select the corresponding record and
display its properties in the grid.

Record Editing
Parameter properties (except parameter key) are set or modified by editing the
value fields in the grid.
Text fields are edited by click in the field followed by typing in the value. Inline
editing is initiated by F2 key.
Check fields are edited by click in the field.
Text select fields are edited by click in the field followed by selection of an item
from the drop down box.
Note that some fields may be insensitive to editing because the values of other
fields makes them irrelevant. If for example parameter type is Bit Pattern, then
the properties Normalize, Conversion, Gain, Offset, Format, Unit can not be
edited.
The following buttons apply to record editing:
Clear - Sets the properties to default values
Reset - Sets the properties to the latest stored (applied) values
Apply - Save the current properties.

Record Creation and Removal


New records may be created and existing records removed.
This is accomplished by the following buttons:
Add - Create a new record preset with default values.
Copy - Create a new record preset with property values of the current record.
Delete - Delete the current record.
When creating a new record the user will be prompted to enter a parameter key
on the following form:

Figure 5 -Create new record form

The parameter key entered must be different from the ones which already exists
for the algorithm. If this is not the case an error message is shown.

6 ECS/SDR Block Algorithm Configuration

Reference Manual ECS/SDR Block Algorithm Configuration

Reference Manual ECS/SDR Block Algorithm Configuration

ECS/SDR Block Algorithm Configuration 7

Glossary of Terms

Block Algorithm
Table describing PLC parameter block layout

Reference Manual ECS/SDR Block Algorithm Configuration

Glossary of Terms 9

Index

Error! No index entries found.

Reference Manual ECS/SDR Block Algorithm Configuration

Index 11

Reference Manual

SDR Report Configuration

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 3
$Modtime:: 7/16/01 9:30a
Henrik Brabrand
$Author:: Ngb
$Workfile:: SdrRepCfgUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further
and future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
Report Configuration ............................................................................... 3
Introduction ................................................................................................................................ 3
Plant Reports Tab....................................................................................................................... 4
Report Collection Tab ................................................................................................................ 5
Report General Tab .................................................................................................................... 6
Plant Report Configuration Form............................................................................................... 7
Buttons ................................................................................................................................ 7
Tool Bar .............................................................................................................................. 8
Value Types for A-points.................................................................................................... 8
Value Types for B-points .................................................................................................... 8
Value Types for A- and B-points ........................................................................................ 8
Report Collection Configuration Form ...................................................................................... 9
Buttons .............................................................................................................................. 10

Glossary of Terms.................................................................................. 13
Index........................................................................................................ 15

Reference Manual for SDR Report Configuration

Contents i

Report Configuration

Introduction
SDR Report Configuration is used to configure plant and shift reports, and
report collections, and general setup for time based report collection scheduling
The main form contains three tabs. One tab for selections of a report, one tab
for selection of a collection of reports and the general tab.
From these tabs two different sub forms can be invoked. One for configuration
of a report and one for configuration of a collection of reports.
Plant reports will always give statistical data based on the report hour of the
system, whereas shift reports always span the defined shifts of the system.
In order to get comparable results from shift and plant reports the first shift
should start at the report hour of the system.

Reference Manual for SDR Report Configuration

Report Configuration 3

Plant Reports Tab

The plant reports tab display a list of the reports in a scroll box. It is possible to
configure 250 different reports. The scroll box has two columns. One indicating
the number of the report, the other indicating the name of the report.
By clicking in the scroll box a report can be selected.
Double clicking in the scroll box will pop up the Plant Report Configuration
form for the report selected.
Pressing the edit button will also pop up the Plant Report Configuration form
for the report selected.
Pressing the help button inside the tab will invoke the help for the tab. Pressing
help outside the tab will invoke the general help for this application.

4 Report Configuration

Reference Manual for SDR Report Configuration

Report Collection Tab

The report collection tab displays a list of the report collections in a scroll box.
It is possible to configure 20 different report collectios. The scroll box has to
columns. One indicating the number of the report collection, the other indicating
the name of the report collection.
By clicking in the scroll box a report collection can be selected.
Double clicking in the scroll box will pop up the Report Collection
Configuration form for the report collection selected.
Pressing the edit button will also pop up the Report Collection Configuration
form for the report collection selected.
Pressing the help button inside the tab will invoke the help for the tab. Pressing
help outside the tab will invoke the general help for this application.

Reference Manual for SDR Report Configuration

Report Configuration 5

Report General Tab

The general report tab displays data relevant for time based report collection
scheduling. For dual systems the Print node frame indicates, whether Server1
or Server2 is the printing node. Toggling in the frame immediately applies.
The Schedule all button should only be used to reinitialize the NT schedulers
job queue in case it is not correct. This should rarely be the case.

6 Report Configuration

Reference Manual for SDR Report Configuration

Plant Report Configuration Form

Frame Caption
Displays the report number of the report edited.
Name Text box
Here the name of the report is entered. The current name is displayed.
Scroll Box
Here the points to showed in the report can be entered and are shown together
with the value type that are use for the point. A report consist of 15 points.
Point Code Column
Here the point code is entered or fetched with the point list using the toolbar
Value Type Column
Here the value type is entered by selection in a scroll box.

Buttons
Clear Will clear the report.
OK - Applies the changes made to the report and exits the form.
Cancel - Cancel the changes made to the report and exits the form.
Apply - Applies the changes made to the report.
Help - Invokes the help for this form.

Reference Manual for SDR Report Configuration

Report Configuration 7

Tool Bar
Invoke Point List
Get previous point from Point List and insert into selected Point Code
field.
Get current point from Point List and insert it into selected Point Code
field.
Get next point from Point List and insert it into selected Point Code field.

Value Types for A-points


Spot
The actual value at a given sample time.
Average
The average value of the point.
Calculated
Determined by the report algorithm for the point.
Minimum
The minimum value of the point.
Maximum
The maximum value of the point.

Value Types for B-points


OpHours
The operating hours of the point.

Value Types for A- and B-points


AlarmCounter
The number of alarms of the point.
AlarmTime
The time the point was in an alarm state.
ErrorCounter
The number of errors of the point.

8 Report Configuration

Reference Manual for SDR Report Configuration

Report Collection Configuration Form

Frame Caption
Displays the report collection number of the report collection edited.
Name Text box
Here the name of the report collection is entered. The current name is displayed.
Scroll Box
Here either all 96 reports are shown or the reports selected into the collection
depending on the option selected. The user has the possibility to add any report
into to the report collection, either as a plant report or as shift report or as both.
Report Name Column
Here the report name is displayed.

Reference Manual for SDR Report Configuration

Report Configuration 9

Plant Column
Here a check box is used to indicated whether or not this report is a part of the
report collection as a plant report.
Shift Column
Here a check box is used to indicated whether or not this report is a part of the
report collection as a shift report.
Show Report All option
If this option is selected all reports with defined report name are displayed in the
scroll box. Used to add new reports to the report collection.
Show Report Selected option
If this option is selected, only reports of the collection are displayed in the scroll
box, for which either plant or shift is enabled. Used to view the reports in report
collection and to remove reports from the collection.

Schedule information
Displays schedule information about this report collection. Generally scheduled
reports are printed to the default printer.
Scheduled report
If the checkbox is checked in, the report collection is to be printed periodicly at
a desired time of day.
Schedule time
Here the time is entered, at which the collection has to be printed, the time must
be between 00:00 and 23:59, and is given as HH:MM, where MM=10 is
recommended. IT IS VERY IMPORTANT THAT THE Schedule Time is set to
around 10 minutes past the hour. This is because the statistical values must be
logged to disk before the automatic reports fetch these values. Logging of
statistical values to disk is commenced on the hour.
Days of week
Here the days of the week are given, when the collection has to be printed. For
each checked day the collection will be printed periodicly at schedule time.
Days of month
Here the days of the month are given, when the collection has to be printed. For
each checked day the collection will be printed periodicly at schedule time.
Days of week and days of month can be combined. If neither has a checked day,
the collection is printed, next time the given schedule time is reached. This may
be today or tomorrow.
Number of days to be printed
This textbox holds the number of days to be printed, when the collection is
scheduled for printing. The number of days is relative to the time, when the
collection printing is activated.

Buttons
Clear - Clears the report collection.
OK - Applies the changes made to the report collection and exits the form
Cancel - Cancel the changes made to the report collection and exits the form
Apply - Applies the changes made to the report collection

10 Report Configuration

Reference Manual for SDR Report Configuration

Help - Invokes the help for this form.

Reference Manual for SDR Report Configuration

Report Configuration 11

Glossary of Terms

Shift report
Daily reports with data from each hour but split into shift periods.

Plant report
Daily report with data from each hour, starting with the report hour.

Reference Manual for SDR Report Configuration

Glossary of Terms 13

Index

A
Accumulated 8
Apply 7, 10
Average 8

C
Cancel 7, 10
check box 10

F
Frame Caption 7, 9

N
Name Text box 7, 9

O
OK 7, 10

P
Plant Column 10
Plant Reports 4, 7, 9
Point List 78

R
Report Name Column 9

S
Scroll Box 47, 910
Shift Column 10
Show All Report 10
Show Selected Report 10
Spot 8

V
Value Type 7

Reference Manual for SDR Report Configuration

Index 15

Reference Manual

SDR Log Configuration

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 8
$Modtime:: 14-12-01 14:41
Torben stradsson
$Author:: Mbh
$Workfile:: SdrLogCfgUi30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
SDR Log Configuration ............................................................................. 1
Introduction ................................................................................................................................... 1
General Settings ............................................................................................................................ 2
Common Log Setting.................................................................................................................... 3

Glossary of Terms ..................................................................................... 7


Index............................................................................................................ 9

Reference Manual SDR Log Configuration Ui

Contents i

SDR Log Configuration

Introduction
The SDR Log Configuration is used to create and configure historical point value and
point statistical log files used by other application.
The following are three types of point values available for logging:
Analog Point Value, value received directly from the PLCs.
Statistical A-point Value, analog points values containing the following:
Minimum, Average, Maximum, Calculated, Alarm time, Alarm count and Error count.
Statistical B-point Value, digital point values containing the following:
Operating hours, Total operating hours, Alarm time, Alarm count, and Error count.
The Application is started from the Windows Start menu :

Reference Manual SDR Log Configuration Ui

SDR Log Configuration 1

General Settings
The General tab contains information concerning the log system.

Suppress Logging of report suppressed values


If selected, logging of points which are report suppressed, will be suppressed.
Log Directory
Shows the path to the current log directory. This field is for information purposes only
and cannot be edited.
Points
These fields show the number of points, in the current log, the current number of points
defined in the system and the licensed (available) number of point, for both A- and Bpoints. These fields are for information purposes only and cannot be edited.

2 SDR Log Configuration

Reference Manual SDR Log Configuration Ui

Common Log Setting


The Common Log tab contains the Log Configuration Table.

The followings are columns within the Log Configuration


Table.
Log ID
Used to identify log files. It is used with the Source column. When a new log file has
been created using the Add button, a new Log ID will be assigned. Deleting an log
file entry using the Delete button will not disturb other Log IDs.
Type
log files are categorized into the different types which will effect their period :
1.

Spot - Logs analog point values. Minimum period is 1 second and 10 seconds is
recommended. Smaller values depend on the number of licensed points and type of
PC used.

2.

Average - logs analog point values using an averaging algorithm. Minimum


period is two seconds.

3.

Hourly Analog Statistics - log statistical A-point values, with period at one
sample per 3600 seconds.

4.

Shiftly Analog Statistics - log statistical A-point values, user defined period.
Depends on shift definitions.

5.

Daily Analog Statistics - log statistical A-point values, with a period value at
one sample per 86400 seconds.

6.

Hourly Digital Statistics - log statistical B-point values, with a period value at
one sample per 3600 seconds.

7.

Shiftly Digital Statistics - log statistical B-point values, user defined period.
Depends on shift definitions.

Reference Manual SDR Log Configuration Ui

SDR Log Configuration 3

8.

Daily Digital Statistics - log statistical B-point values, with a period value at
one sample per 86400 seconds.

Period
Described in seconds and depended on log file type. The user can define the period if
type is Spot or Average. Otherwise must have same frequency as type, if log file type
is Hourly Analog Statistics, frequency must be 3600 seconds.
Samples
The total number of samples to be taken. Is combined with the period column to
produce the horizon column. The maximum number of samples is depended on the size
of the log file created, witch must not exceed 2 Gigabytes (approx. 2 billion bytes). To
calculate the maximum value use the following equation:
FileSize = Samples * NoOfLogPoints * LogTypeSize ,
where LogType and NoOfPoint are depended of the selected log type.
Log Type Selected

NoOfLogPoints

LogTypeSize

(Total number of)


Spot

A-points

4 bytes

Average

A-points

4 bytes

Hourly Analog Statistics

A-points

32 bytes

Shiftly Analog Statistics

A-Points

32 bytes

Daily Analog Statistics

A-points

32 bytes

Hourly Digital Statistics

B-points

16 bytes

Shiftly Digital Statistics

B-points

16 bytes

Daily Digital Statistics

B-points

16 bytes

Example: A system with 20,000 A-points can produce a maximum of :


2,147,483,648 / (32 * 20,000) = 3,355 Hourly Analog Statistics samples.
So this log will go about 139 days back.
Horizon, a product of period (in seconds) and samples, is displayed in standard time,
days hours: minutes: seconds. For example, if the period is defined as every 20
seconds and samples as 500, the horizon will be 10 000 seconds or 02:46:20
Source, is used with average log files to take samples from other log files. User
enters a Log ID here. For example: source for Log ID: 3 is 2, and then log file 3 will
take values from log file 2. It is important to note that the log file's source must have a
smaller or same period as the log file.
File Path, defines the location of the log file. A directory path can be typed in this
field, e.g. C:\FLSAlog. Type "Log Directory" in this field to save the log file in the
default log file location.

4 SDR Log Configuration

Reference Manual SDR Log Configuration Ui

File Name, this is where you define the file name of the log file. The name of the file
specifies which of the tree log types the file contains.
Spot logs :

*spot*.log

Average logs:

*avg*.log

Statistics logs:

*stat*.log

The wildcard (*) symbolizes any text or numbers.


The filename will be rejected if these rules are not followed.
Size, is the log file size in KB. A '-1' represents that the log file has not been
committed.
The maximum log file size is 2 Gigabytes (2,147,483 Kbytes). Please ensure this limit
by reducing the number of samples.

Under the table are the following information:


Free disk space, shows the amount of free space on the disk where the log files are
located.
Required space, shows the disk space required in order to apply changes (added
logs / extended logs).
Required for copy, shows the disk space temporary required in order to keep data
for extended logs.
On the bottom of the Common Log Tab, are the following buttons:
Reset, cancel changes and return to settings since last Apply.
Check, is used to ensure there is enough disk space for the new log file.
Apply, becomes available only after the Check button has been pressed, is used to
accept changes to the log file configuration.
Help, is used to retrieve the on-line help.

Reference Manual SDR Log Configuration Ui

SDR Log Configuration 5

Glossary of Terms

B-point
A binary point.

A-point
An analog point.

Reference Manual SDR Log Configuration Ui

Glossary of Terms 7

Index

Shiftly Analog Statistics 3


Shiftly Digital Statistics 3
Size 5
Source 3
Suppress Logging of report suppressed values 2

T
Type 3

A
Alarm count 1
Alarm time 1
Apply 5
Average 1, 3

C
Calculated 1
Check 5
Commit 5

D
Daily Analog Statistics 3
Daily Digital Statistics 4

E
Error count 1

F
File Name 5
File Path 4

H
Horizon 4
Hourly Analog Statistics 3
Hourly Digital Statistics 3

M
Maximum 1
Minimum 1

R
Reset 5

S
Samples 4

Reference Manual SDR Log Configuration Ui

Index 9

Reference Manual

ECS OpStation
Configuration

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 5
$Modtime:: 10/18/01 1:36p
HB
$Author:: Hb
$Workfile:: SdrOpsCfgUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS OpStation Configuration .................................................................. 3
Introduction ................................................................................................................................... 3
General Configuration .................................................................................................................. 4
Faceplate Displays ........................................................................................................................ 5
A-Point Algorithm Faceplates............................................................................................... 5
B Point Algorithm Faceplates ............................................................................................... 6
Home pictures ............................................................................................................................... 7
Department Home pictures.................................................................................................... 7
Point Home pictures .............................................................................................................. 8
External Servers .......................................................................................................................... 12
Abbreviations .............................................................................................................................. 16
Picture directories ....................................................................................................................... 16

Glossary of Terms ................................................................................... 17


Index.......................................................................................................... 19

Reference Manual ECS Opstation Configuration

Contents i

ECS OpStation Configuration

Introduction
The OpStation Configuration utility is used to assign
The start-up model display
The background color to be used for all graphic displays
The faceplates to be associated with A and B-point algorithms
The home pictures to be associated with departments and points
The external data servers employed and there locations
The set of abbreviation texts employed by the system
Locating and selecting ECS OpStation Configuration from the desktop START
menu access the utility.
All settings configured apply globally to the whole system independent of the
machine where the utility is run from.

Reference Manual ECS Opstation Configuration

ECS OpStation Configuration 3

General Configuration
After the OpStation Configuration display appears, the General tab will be in
focus.

Host name The Default entry will always be in the list. Specified the computer
name for which the setting is applied. If nothing is specified for a computer the
default settings are used.
TopModel Name Enter the name of the model that is displayed when ECS
OpStation is started. This setting is the computer default. On the local machine
selecting a local top model applicable to that machine may overwrite it. Local
top model is selected from the Options menu of ECS OpStation.
Background color The selected color is used on all model displays on the
particular computer.

Buttons
Add To add a computer host to the list.
Modify To modify the settings for a computer.
Delete To delete the settings for a computer and revert to default.

4 ECS OpStation Configuration

Reference Manual ECS Opstation Configuration

Faceplate Displays
During operation, a faceplate display associated with a graphic object can be
opened to review additional or more detailed information. The type of faceplate
display that appears depends on the following:
1.

If a faceplate is assigned to the object, the assigned faceplate is opened.

2.

If no faceplate is assigned to the object, the conversion algorithm


assigned to the object owner is determined. The faceplate assigned to
the algorithm is then opened.

3.

If neither 1 nor 2 is true, no faceplate is opened.

Faceplates are assigned to conversion algorithms using the ECS OpStation


Configuration utility.

A-Point Algorithm Faceplates


To associate faceplates with A-Point conversion, start the ECS OpStation
Configuration utility and click on the A-point algorithm faceplates tab.

A-point algorithm This column lists the number and name of each A-point
algorithm.
Faceplate The faceplate that is displayed for an object owned by an A point
with this algorithm. This faceplate is displayed only if no faceplate has been
assigned to the object.

Selecting faceplates
Click on the field first to select a faceplate. This enables a drop down list. Then
select a faceplate name from the list.

Reference Manual ECS Opstation Configuration

ECS OpStation Configuration 5

Deleting faceplates
Delete a single faceplate by a click on a faceplate field followed by press on the
Delete key.
Delete a range of faceplates by multiple selections (click and drag) followed by
press on Delete key.
Delete the whole table by a click in the faceplate column header followed by
press on the Delete key.

Buttons
Apply - Commit all the changes to the table
Reset - Reset values to the latest applied

B Point Algorithm Faceplates


To associate faceplates with B-Point conversion, start the ECS OpStation
Configuration utility and click on the B point algorithm faceplates tab.

B point algorithm This column lists the number and name of each B-point
algorithm.
Faceplate Name The faceplate that is displayed for an object owned by a Bpoint with this algorithm. This faceplate is displayed only if no faceplate has
been assigned to the object.

Selecting faceplates
Click on the field first to select a faceplate. This enables a drop down list. Then
select a faceplate name from the list.

6 ECS OpStation Configuration

Reference Manual ECS Opstation Configuration

Deleting faceplates
Delete a single faceplate by a click on a faceplate field followed by press on the
Delete key.
Delete a range of faceplates by multiple selections (click and drag) followed by
press on Delete key.
Delete the whole table by a click in the faceplate column header followed by
press on the Delete key.

Buttons
Apply - Commit all the changes to the table
Reset - Reset values to the latest applied

Home pictures
A home picture is used for fast navigation from alarm list and other applications
to the OpStation picture where the current point is visualized.
The Alarm List, Alarm Header and Point Parameter applications have an
OpStation home picture button in the toolbar. Pressing this button will activate
OpStation and set-up the home picture for the current point.
Home pictures may be assigned to departments and to individual points. When
the OpStation home picture function is activated, the point home picture table is
searched for a matching home picture. If none is found the department home
picture table is searched for a home picture matching the points department.

Department Home pictures


To associate home pictures with departments, click on the Dep homepictures
tab.
This table defines default home pictures for points where no home picture is
defined in the point home picture table.

Reference Manual ECS Opstation Configuration

ECS OpStation Configuration 7

Department This column lists the number and code of the departments.
Homepicture The home picture assigned to the department.

Selecting home pictures


Click on the field first to select a home picture. This enables a drop down list.
Then select a picture name from the list.

Deleting home pictures


Delete a single home picture by a click on a homepicture field followed by press
on the Delete key.
Delete a range of home pictures by multiple selections (click and drag) followed
by press on Delete key.
Delete the whole table by a click in the homepicture column header followed by
press on the Delete key.

Buttons
Apply - Commit all the changes to the table
Reset - Reset values to the latest applied

Point Home pictures


To associate home pictures with points, click on the Point homepictures tab.
This table defines home pictures for individual points. When activating the home
picture function a match on point in this table will override a match on the points
department in the department home picture table.

8 ECS OpStation Configuration

Reference Manual ECS Opstation Configuration

Pointcode This column shows the allocated point codes in the table. The point
code must be unique.
Homepicture This column shows corresponding home pictures.
Note that this table is not a fixed length table. Therefore the manipulation of the
table is different from the other tables in this utility. The tab shows the actual
content of the committed table.

Buttons
Add - Add a new record to the table
Modify - Modify one or more record in the table
Delete - Delete one or more records in the table.

Adding new records


Click the Add button to add a new record. This will pop up the Add Record
form.

Reference Manual ECS Opstation Configuration

ECS OpStation Configuration 9

Pointcode can be entered by typing or, better, selecting from point list using
the toolbar buttons. First click the pointcode field, and then press the toolbar
button.
Show point list
Get current point from list
Get next point from list
Get previous point from list
Homepicture is selected from the drop down list
Pointcode and homepicture must be selected and OK button clicked. This will
add and commit the record to the database.
OK - Add and commit the record to the database
Cancel - Regret and return

Modifying records
To modify a single record, click the row in the table and press the Modify
button.
To modify a range of records use multiple select (click and drag) and press the
Modify button.
This will pop up the Modify Record form.

The pointcode field cannot be edited (database key).


Homepicture is selected from the drop down list
OK - Commit the modified record to the database
Cancel - Regret this record
Quit - Skip remaining modifies and return. This button is only visible for
multiple select
For multiple selected records the form will stay up and do one record at a time
unless Quit is pressed.

10 ECS OpStation Configuration

Reference Manual ECS Opstation Configuration

Deleting records
To delete a single record, click the row in the table and press the Delete button.
To delete a range of records use multiple select (click and drag) and press the
Delete button.
This will pop up the Delete Record form for confirmation.

OK - Delete the record shown in the database


Cancel - Skip this record
OK All - Delete all remaining selected records without confirmation and return.
This button is only visible for multiple select
Quit - Skip remaining deletes and return. This button is only visible for multiple
select
For multiple selected records the form will stay up and do one record at a time
unless OK All or Quit is clicked.

Reference Manual ECS Opstation Configuration

ECS OpStation Configuration 11

External Servers
OpStation mimics may request data originating from sources outside the Sdr
subsystem. Examples are display of data from a Qcx- or a Fuzzy subsystem.
Such data sources are called external servers. The picture elements have a
reference to an external server via a ServerId, which is a text short name,
identifying the server. External servers may reside on hosts different from the
one where OpStation is running.
The actual hosts for the external servers are specified from the ECS OpStation
Configuration utility.
Note that the host settings specified here from any Sdr Client or Server are
global for the entire Sdr system.
Activate the tab External servers to bring the hostname table up.
Note that this table is not a fixed length table. Therefore the manipulation of the
table is different from most other tables in this utility. The tab shows the actual
content of the committed table.
After modifying the table OpStation must be restarted for modifications to take
effect.

Server id This column lists the external server ids known to the system.
ServerIds are referenced in the Gms picture elements. The ServerIds in this
column must be unique.

Server name Identifies the external server to use. This is selected from a
dropdown box (see Add, Modify)

Hostname Name of the host where the external server resides. Blank means
that the host is the local machine, i.e. the machine where OpStation is running.

12 ECS OpStation Configuration

Reference Manual ECS Opstation Configuration

In the example shown Ext identifies a local test server, Fuz1 and Fuz2 identify
fuzzy servers running on different machines (HNT83 and HNT84). Picture
elements referencing Fuz1 will get data from HNT83 whereas pictures
referencing Fuz2 will get data from HNT84.

Buttons
Add - Add a new record to the table
Modify - Modify one or more record in the table
Delete - Delete one or more records in the table.

Adding new records


Click the Add button to add a new record. This will pop up the Add Record
form.

Server id is entered by text edit


Server name is selected from the drop down box
Home name is entered by text edit. If left blank, local host is used.
OK - Add and commit the record to the database
Cancel - Regret and return

Modifying records
To modify a single record, click the row in the table and press the Modify
button.
To modify a range of records use multiple select (click and drag) and press the
Modify button.
This will pop up the Modify Record form.

Reference Manual ECS Opstation Configuration

ECS OpStation Configuration 13

The Server id field cannot be edited (database key).


Server name is modified by select from the drop down list
Host name is modified by text edit
OK - Commit the modified record to the database
Cancel - Regret this record
Quit - Skip remaining modifies and return. This button is only visible for
multiple select
For multiple selected records the form will stay up and do one record at a time
unless Quit is pressed.

Deleting records
To delete a single record, click the row in the table and press the Delete button.
To delete a range of records use multiple select (click and drag) and press the
Delete button.
This will pop up the Delete Record form for confirmation.

OK - Delete the record shown in the database

14 ECS OpStation Configuration

Reference Manual ECS Opstation Configuration

Cancel - Skip this record


OK All - Delete all remaining selected records without confirmation and return.
This button is only visible for multiple select
Quit - Skip remaining deletes and return. This button is only visible for multiple
select
For multiple selected records the form will stay up and do one record at a time
unless OK All or Quit is clicked.

Reference Manual ECS Opstation Configuration

ECS OpStation Configuration 15

Abbreviations
Abbreviated texts are used in ACE faceplates. The abbreviated text differs for
the type of application (e.g. FLSA, FLSH, HTC). Therefore a set of
abbreviations is defined for each type of application. The faceplates display
abbreviations for the selected set.
FLSA staff maintains the abbreviation text database.
The selection to use is set by ECS OpStation Configuration.
Click on tab Abbreviations.

Abbreviation selection shows the actual abbreviation set selected. Select


another set from the dropdown list.

Buttons
Apply - Commit the change to the table
Reset - Reset value to the latest applied

Picture directories
In order to avoid mixing models, faceplates, sub models, gismos, palettes, and
bitmaps with the models, faceplates, sub models, gismos, palettes, and bitmaps
delivered by FLSA, the user has the possibility to define own directories for
these files. These directories have the preference whenever OpStation is using a
model or a sub model.

16 ECS OpStation Configuration

Reference Manual ECS Opstation Configuration

Directory Type:
Bitmaps The directory for user bitmaps.
Faceplates The directory for user faceplates.
Gismos The directory for user gismos.
Models The directory for user models.
Palettes The directory for user palettes.
Submods the directory for user sub models.
Directory:
The name will be the physical name of a directory placed as a
subdirectory under the share FlsaGmsPic. It would be smart to organize
the directories. I.E. give the Models the plant name and then the other
directories the name <plant name>\Faceplates, <plant name>\Gismos
etc.

Buttons
Apply - Commit the change to the table
Reset - Reset value to the latest applied

Glossary of Terms

Reference Manual ECS Opstation Configuration

Glossary of Terms 17

Homepicture
Home pictures are used for fast navigation from other applications where the
point is displayed. I.e. alarm list.

A point algorithm
See A-Point Algorithms reference manual help file.

B point algorithm
See SDR B-Point Algorithm Editor reference manual help file.

Faceplate
A faceplate is a popup MIMIC diagram that displays relevant information for a
point and its reference points.

18 Glossary of Terms

Reference Manual ECS Opstation Configuration

Index

A
A point algorithm faceplates 7

B
Background color 2

F
Faceplate 78

T
TopModel Name 2

Reference Manual ECS Opstation Configuration

Index 19

Reference Manual

SDR Language Edit

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 4
$Modtime:: 7/06/01 12:59p

$
$

$Author:: Ngb
$Workfile:: SdrLangEditXUI30_English.doc
0-1000

$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
SDR Language Edit ................................................................................... 1
Introduction ................................................................................................................................... 1
Language Databases...................................................................................................................... 2
Process Database........................................................................................................................... 3
User Interface Database ................................................................................................................ 5

Glossary of Terms ..................................................................................... 6


Index............................................................................................................ 7

Reference Manual SDR Language Edit

Contents i

SDR Language Edit

Introduction
The SDR Language Edit system can be used to add a new local language into the
process and user interface databases. It can also be used to backup these databases, so
that when a new database is installed or updated, the local language from the old
database can be inserted into the new database. Thus translation work is not lost. SDR
Language Edit will also check for any modifications or newly created entries in the
new database which are not found in the backup databases and notify the user.
There are five default languages supported by FLSA. They are English, French,
Spanish German, and Danish
Use the SDR Language Configuration to switch between the different languages.
SDR Language Edit is only used to modify individual language databases.

Reference Manual SDR Language Edit

SDR Language Edit 1

Language Databases
Language databases are stored as Access *.mdb files in the following directories:

\ProDb Process Databases

\ProDBBackup Backup of the Language Dependent Process Databases

\NlsDb User Interface Databases

\NlsDbBackup Backup of the Language Dependent User Interface


Databases

SDR Language Edit allows the user to edit the language dependent part of the process
and user interface databases. When SdrLangEditXUi is started, there are two sections
to choose from and they correspond to the above list of databases. On the bottom of the
window is two pull-down boxes for selecting the local language and the local script.
Click OK to edit the selected database.

2 SDR Language Edit

Reference Manual SDR Language Edit

Process Database
When a language database has been selected for editing, an Access table will be shown.
A language database can have multiple language tables which can be selected for
editing. All language tables start with a CaptionKey column followed by the English,
French, Spanish, German and Danish columns. Each column is a translation of the
English text to the local language.

Click the Add Field button below the table to add a new local language column to the
table. Press Add Field All, if you wish to add a new local language column to all the
language tables in all the databases. The name of the new column will be the same as
the local language selected in the previous window.

Once a new local language column has been created, use the Copy All button if you
want to copy texts from the English column to the newly created local language
column.
Use the Edit button to edit the local language column.
The Find button is used to search a string in the English column. You might wish to
find a string in the English column if a similar translation is needed elsewhere in other
databases. Use Find Next to continue search.

Reference Manual SDR Language Edit

SDR Language Edit 3

The Backup button is used to create *.mdb backup files for the all language
databases. For the process database, the backup databases will be stored in the
\ProDBBackup directory. Click OK to confirm backup operation when the message
box appears.

The CopyX button is used to copy the texts in the local language column from the
backup to the current database.

The Sync button is used to compare the backup database against the current database.
If an entry in the English column is found in the current database table which is

4 SDR Language Edit

Reference Manual SDR Language Edit

different from the same entry in the backup database table, the search will pause and
the user is prompted to edit the table.
The Missing button is used to search for tables which does not contain the new local
language column.
Close the window when editing has been completed.

User Interface Database


The NlsDb User Interface Database is a required database for all SDR User Interfaces.
When an application starts, it will search for text in the NlsDb User Interface Database.
For example, the SDR Alarm List user interface requires texts from the
\NlsDb\SdrAlarmList10.mdb database.
User Interface Database editing is accessed by clicking the OK button in the NlsDb
section in the entry window.
The features of the User Interface window is similar to the Process Language window.

Since NlsDb is maintained by FLSA, when a new database is available, a backup is


needed to preserve the local language. The steps in replacing the old database with a
new database is as follow:

Create a backup of the old database using the Backup button.

Replace the old database with the new database.

Add the local language into the new database using the Add Field button

Use the Copy X button to copy the local language from the backup to the new
database.

Use the Sync button to synchonize the local language to the new database.

Reference Manual SDR Language Edit

SDR Language Edit 5

When the Backup operation is completed, a new table will appear on the bottom of the
window. Backup Tables are not editable.

Glossary of Terms

NlsDb
User Interface Database

ProDb
Process Database

6 Glossary of Terms

Reference Manual SDR Language Edit

ProDBBackup 2, 4

Index

replacing the old database with a new database 5

S
SDR Language Configuration 1
Sync 46

T
table 35

A
Add Field 3, 5
Add Field All 3

B
Backup 12, 46

C
CaptionKey 3
Copy All 3
CopyX 4

D
default languages 1

E
Edit 14

F
Find 3
Find Next 3

L
local script 2

M
Missing 5
Missing button 5

N
NlsDb 2, 5
NlsDbBackup 2

P
ProDb 23

Reference Manual SDR Language Edit

Index 7

Reference Manual

ECS OpStation Editor

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 10
$Modtime:: 10/18/01 1:29p
StN
$Author:: Hb
$Workfile:: SdrGmsDrawUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS OpStation Editor................................................................................ 1
Introduction ................................................................................................................................... 1
ECS OpStation Editor Reference Manual............................................................................. 1
SL-GMS Draw User's Guide................................................................................................. 2
Picture Directories ........................................................................................................................ 2
Directory Structure ................................................................................................................ 2
Picture Files ........................................................................................................................... 2
Picture Location..................................................................................................................... 3
New Picture................................................................................................................................... 3
Default Settings ..................................................................................................................... 3
Model Owner ......................................................................................................................... 3
Palettes .......................................................................................................................................... 4
Classic Dynamics.......................................................................................................................... 5
Assigning Object Owner ....................................................................................................... 5
PointVal Object ..................................................................................................................... 5
PointValEnt Object................................................................................................................ 6
Color Symbol Objects ........................................................................................................... 6
Changing Symbol Objects..................................................................................................... 7
Filling Symbol Objects.......................................................................................................... 9
Trend Object ....................................................................................................................... 10
Buttons ........................................................................................................................................ 11
Picture Select Button ........................................................................................................... 12
Picture PopUp Button.......................................................................................................... 13
Picture PopUp Floating Button ........................................................................................... 13
Faceplate PopUp Button...................................................................................................... 14
Bit Control Button ............................................................................................................... 14
Bit Set Button ...................................................................................................................... 15
Bit Pulse Button................................................................................................................... 15
Bit Toggle Button ................................................................................................................ 16
Bit Toggle Check................................................................................................................. 17
Mode Control Button........................................................................................................... 17
Percent Change Button ........................................................................................................ 18
Sdr Trend Button ................................................................................................................. 19
Start Process Button............................................................................................................. 19
Toolbar buttons.................................................................................................................... 20
Generel action button........................................................................................................... 20
Using OpenGMS Dynamics ....................................................................................................... 21
Renaming Variables ............................................................................................................ 21
Fonts..................................................................................................................................... 22
PointNo Variable ................................................................................................................. 22
PntCode Object.................................................................................................................... 22
PntCodeVis Object .............................................................................................................. 23
PntText Object ..................................................................................................................... 23
PntVal Object....................................................................................................................... 24
PntValText Object ............................................................................................................... 24
PntValEnt Object ................................................................................................................. 24
PntMSWInt Object .............................................................................................................. 25
PntMSWHex Object ............................................................................................................ 25
PntMSWBit Object.............................................................................................................. 26

Reference Manual ECS OpStation Editor

Contents i

PntMSWBitText Object.......................................................................................................26
PntThermoVer Object..........................................................................................................27
PntThermoDev Object .........................................................................................................27
PntThermoSca Object ..........................................................................................................28
PntSlider Object ...................................................................................................................28
PlcVal Object .......................................................................................................................29
PlcValEnt Object..................................................................................................................29
PlcInt Object.........................................................................................................................29
PlcIntEnt Object...................................................................................................................30
PlcParName Object..............................................................................................................30
LangText Object ..................................................................................................................31
AbbreviationText Object .....................................................................................................31
FlsDateTime Object .............................................................................................................32
Generic route property text object .......................................................................................32
Generic group property text object......................................................................................33
Generic department property text object .............................................................................33
Generic point property text object .......................................................................................33
Creating OpenGMS Dynamics ...................................................................................................34
GMS Dynamic Properties....................................................................................................34
OpenGMS Functions ...........................................................................................................36
Information Functions..........................................................................................................37

Pointno Function ............................................................................................. 37


Pntfloat Function ............................................................................................. 37
Pntint Function................................................................................................. 38
Pnttext Function............................................................................................... 39
Pntbit Function................................................................................................. 39
Pntvalue Function ............................................................................................ 40
Pntunit Function .............................................................................................. 41
Plctext Function ............................................................................................... 42
Plcdouble Function .......................................................................................... 42
Plcint Function ................................................................................................. 43
Plcunit Function ............................................................................................... 43
Langtext Function ............................................................................................ 44
Abbreviationtext Function.............................................................................. 44
Datetime Function ........................................................................................... 45
extxxx functions ............................................................................................... 46
colv7getgeneric functions................................................................................ 47
Colv7format function ...................................................................................... 47
Colv7uacright function .................................................................................... 47
Action functions...................................................................................................................48

Pntselect Function............................................................................................ 48
Pntedit Function............................................................................................... 48
Pntupdownpercent Function.......................................................................... 49
Iosbitaction Function....................................................................................... 50
Iosbittoggle Function....................................................................................... 51
Iosbitpulse Function ........................................................................................ 51
Iosbitsetcond Function.................................................................................... 52
Iospbsetpoint Function ................................................................................... 53
Plcbitset Function............................................................................................. 53
Plcbitsetcond Function.................................................................................... 53
Plcbittoggle Function....................................................................................... 54
Plcedit Function................................................................................................ 54
ExtSetxxx function........................................................................................... 55
Extedit function................................................................................................ 56

ii Contents

Reference Manual ECS OpStation Editor

ExtActivate function........................................................................................56
ExtMenu function ...........................................................................................57
ColModelInvoke Function..............................................................................57
ColNewWindowInvoke Function..................................................................57
ColGenPopUpInvoke Function.....................................................................57
Facepopupio(FacePlateNameSuffix, lPointNo ) .........................................58
StartProcess function. ......................................................................................58
ShowTrend function. .......................................................................................58
Showbrowser function.....................................................................................58
Colv7executecommand function ...................................................................59
Making Dynamics in Editor ................................................................................................ 60
PntFloat Example................................................................................................................. 64
Faceplates .................................................................................................................................... 68
Creating Faceplates.............................................................................................................. 68
Assigning Faceplates ........................................................................................................... 68
PIDFace Example ................................................................................................................ 68
Bitmaps........................................................................................................................................ 71
Converting Pictures From VMS ................................................................................................. 71

Glossary of Terms ................................................................................... 73


Index.......................................................................................................... 75

Reference Manual ECS OpStation Editor

Contents iii

ECS OpStation Editor

Introduction
The ECS OpStation Editor is the tool for creation and modification of graphical
mimic pictures for display by the ECS OpStation application. These pictures are
also called models. The graphical system employed is GMS by SL.

Figure 1 - OpStation Editor

ECS OpStation Editor Reference Manual


This document is a supplement to the SL-GMS DRAW USER'S GUIDE. In the
present manual special functions for OpStation pictures, such as linking SDR
database points to dynamic graphical objects, are described.
The manual is available as a word document for reading and printout in
following directory:

Reference Manual ECS OpStation Editor

ECS OpStation Editor 1

FLSADev\Help\Sdr\Ref\SdrGmsDrawUI30\English\SdrGmsDrawUI30_English.
doc

SL-GMS Draw User's Guide


The original User's Guide supplied by SL describes the fundamentals of the
editor.
This manual is available as an Adobe Acrobat Reader document for reading and
printout in the following directory:
FLSADev\Help\Sdr\Ref\SdrGmsDrawUI30\English\GmsDraw.pdf
To access the file (by double click) you must first install the acrobat reader as
follows:

Double click FLSADev\ToolsNT\Acroread\Setup.exe

Follow installation procedure and choose destination directory


FLSADev\ToolsNt\Acroread

Picture Directories
Directory Structure
FlsaGmsPic is the name of the share directory for OpStation pictures.
This directory is born with the following subdirectories.
.\Faceplates for library of popup pictures called faceplates.
.\Demo demo picture.
.\SdrTestOps test pictures.
.\Submods for library of static ready made sub models that may be used in
pictures.
.\Gismos for library of dynamic objects (gismos) that may be used in pictures.
.\Palettes for library of pictures with sub models and gismos to use in picture
editing.
.\Bitmaps for bitmaps used in pictures, sub models, and gismos.
The user can make directories for models, gismos, submodels, faceplates, and
bitmaps. This is done in ECS Opstation Configuration.

Picture Files
Pictures are stored in two files:
Picture_name.g is a source file in ASCII format. Can be read by a text editor.
This file is useful if you have to move pictures from one platform to another (e.
g. NT and VMS).
Picture_name.m1 is a binary file. It is the file used by the application to display
the picture.
There is a utility SDR_Setup_Tools->GMS Conversion for converting .g files
to .m1 files and vice versa.

2 ECS OpStation Editor

Reference Manual ECS OpStation Editor

You normally do not have to bother with this as the editor always automatically
will save both files.

Picture Location
In a distributed system the ECS OpStation Editor runs on the local machine.
However, pictures are loaded from and saved to the Server (MOP) partner. In
this way changes apply globally in the system. The OpStation application will
make sure that the newest version on the Server will be copied and displayed on
the local machine.

New Picture
Default Settings
A new picture will have the following default settings:
Model width 100
Model height 75
Background enabled
Background color 31 (Flsa_Background_Color)
This can be changed from menu Model->Properties.
Note that pictures displayed in the same window should have the same size.
Pictures displayed in separate window, like faceplates, need not.

Model Owner
Each main picture may be assigned a department. When a picture is selected in
the OpStation application, the department of the picture becomes the selected
department and the name is displayed in the status bar pane. The assignment of a
department to a picture is done as follows.

Select Model->Owner from the menu.

Select a department from the box shown below.

Figure 2 - Owner model box

Open Picture
When a picture is open the open picture dialog is displayed.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 3

The models and gismos delivered by FLSA can be found in the folder FLSA and
a given sub folder.
If there has been defined directories for Models, Faceplates etc. these will be
displayed under Models, Faceplates etc directly. If no directories have been
defined, the user should place the models in the root folder.

Palettes
A number of palette pictures offer predesigned sub models and gismos to use in
pictures. A palette is selected from menu Palette->Palettes.. . Or if the user has
defined own palettes Palette->Local Palettes.. . A window with the available
palettes will appear. Selecting the palette will make the palette appear as a
picture in a separate window. An object is selected from palette by:

Click on object in palette

Click on position in your work area to place object

Right click and done finishes the action

All objects in palettes are also reachable by file name from subdirectories.
Objects are selected this way by:

Palette->Submodels or Palette->Gismos

Click on filename

Click on position in your work area to place object

Right click and done finishes the action

Local sub models and gismos defined by the user can be fetches
correspondingly.

4 ECS OpStation Editor

Palette->Local Submodels or Palette->Local Gismos

Reference Manual ECS OpStation Editor

Classic Dynamics
Classic dynamics is the easiest and most efficient form of dynamic objects to
use. However it has some limitations. For advanced dynamics you should use
OpenGMS dynamics as described later. Classic dynamics is used in the main
mimic pictures wherever the needs are sufficient. OpenGMS dynamics is
especially used on faceplates.

Assigning Object Owner


The basic way of making objects dynamic is by assigning an owner to the object.
The owner is a database point that will control the dynamic behavior. The owner
is assigned as follows:

Right click the selected object

Select Owner object

Fill in the owner box

Dynamics created in this way (by menu item Owner object) is called classic
dynamics.
Palettes Flsa_symbols_dynamic,
prepared for classic dynamics.

flsa_symbols_dynamic1

contain

objects

In the following frequently used classic objects are described.

PointVal Object
This object displays an analog value. Value, color and blink are dynamically
updated according to the owner point. The format of the value and the unit is as
defined for the owner point in the database.

Figure 3 - Gismo PointVal

The owner is assigned as follows:

Right click the selected object

Select Owner

Fill in the owner box

Reference Manual ECS OpStation Editor

ECS OpStation Editor 5

Figure 4 - Owner box for PointVal

Pointcode may be typed in directly, or better, may be copied from the point list
using the toolbar buttons.
Faceplate is used to assign a faceplate to the object. The name of the faceplate is
selected from the dropdown list. Note that all objects by default are assigned the
faceplate associated the point algorithm. However, this may be overruled by
assigning a faceplate in the owner box.

PointValEnt Object
Similar to PointVal but allows data entry.

Figure 5 - Gismo PointValEnt

Color Symbol Objects


These are objects where color and blink are dynamically updated according to
the owner point. The object may be a symbol representing a fan, a pump, an
interlocking or other device as found on palette flsa_symbols_dynamic, but it
may also be any directly drawn primitive or grouped symbol or sub model
created by user.

Figure 6 - Fan color symbol

The owner is assigned as follows:

6 ECS OpStation Editor

Right click the selected object

Reference Manual ECS OpStation Editor

Select Owner

Fill in the owner box

Figure 7 - Owner box for Color symbols

Pointcode is typed in or copied from point list via toolbar buttons.


Color symbol is selected as dynamic behavior
Edge-, Text-, Fill-color (one or more) is selected as the color attribute to control
Faceplate is selected if special faceplate shall overrule default as assigned the
point algorithm.
The disabled option FUS item is not used but kept for backwards compatibility.
It is only relevant for old pictures from VMS platform to inspect how the setting
was.

Changing Symbol Objects


These are objects whose shape and color may change dynamically according to
the value of the owner point. The owner must be a B-point.
Examples of changing symbols are flsa_dividing_gate and flsa_louvre_damper
found on palette flsa_symbols_dynamic1

Reference Manual ECS OpStation Editor

ECS OpStation Editor 7

Figure 8 - flsa_dividing_gate two-layer symbol unfolded

Figure 9 - flsa_louvre_damper two-layer symbol unfolded

Changing symbols are made of several layers (sub models) on top of each other
but of the same size. Only one layer is visible at a time. There may be up to 8
layers in a changing symbol. The above shown examples have two layers. Which
layer is visible is controlled by the B-point owner of the symbol. The B-point
algorithm has a definition of the MSW interpretation for the point (see B-point
Algorithm Editor) where a symbol offset is defined (0 .. 7) for each MSW value.
This symbol offset defines which symbol layer should be visible for the
corresponding MSW value.
The user may define own changing symbols.
The owner is assigned as follows:

8 ECS OpStation Editor

Right click the selected object

Select Owner

Fill in the owner box

Reference Manual ECS OpStation Editor

Figure 10 - Owner box for Changing symbols

Pointcode is typed in or copied from point list via toolbar buttons.


Changing symbol is selected as dynamic behavior
Edge-, Text-, Fill-color (one or more) may be selected if additional color
control is needed.
Faceplate is selected if special faceplate shall overrule default as allocated the
point algorithm.

Filling Symbol Objects


These are objects whose filling and color may change dynamically according to
the value of the owner point. The owner must be an A-point. The current filling
will be a percentage calculated from the graphical limits and the actual value of
the point.
Examples of filling symbols are thermometers and tanks. The user may define
own filling symbols.

Figure 11 - Tank filling symbol

Reference Manual ECS OpStation Editor

ECS OpStation Editor 9

The owner is assigned as follows:

Right click the selected object

Select Owner

Fill in the owner box

Figure 12 - Owner box for Filling symbols

Pointcode is typed in or copied from point list via toolbar buttons.


Filling symbol is selected as dynamic behavior
Fill-, Edge-color (one or more) may be selected if additional color control is
needed.
Faceplate is selected if special faceplate shall overrule default as allocated the
point algorithm.

Trend Object
This object displays up to 4 trend curves as real time trends, i.e. when set up the
3/4 of the area displays the most recent historical trends. The curves are then
dynamically updated with real time values to the right. When right border is
reached curves are scrolled left 1/4.

10 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Figure 13 - Trend object

A trend object has up to 4 owner points, one for each trend curve. The owners
are assigned as follows:
The owner is assigned as follows:

Right click the selected object

Select Owner

Fill in the owner box

Figure 14 -Owner box

Pointcodes are typed in or copied from point list via toolbar buttons.
Horizon is the time span on x-axis
Update period is the frequency of updating the trend with real time data

Buttons
Buttons are objects where the dynamic behavior is activated by clicking on the
button with the mouse.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 11

A number of buttons are available for various purposes. These are found on
palette flsa_buttons.
The parameters for a button instance are specified as follows by Rename
variables.

Right click the selected object

Select Rename Variables

Fill in the Value part of the Rename variables box

Figure 15 - Rename variables box for fls_m_scrn button

The Name - Value list depends on the object. The user has to supply actual
values for the named variables.
Get point as is only relevant as an aid when point information is needed.
Get Color may be used to select a color code from a color palette.
In the following the most frequently used buttons will be described.

Picture Select Button


The button fls_m_scrn is used to set up a new mimic picture in the same
window.

Figure 16 - Button fls_m_scrn

12 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label Text (in double quotes) on the button face.


Fillcol Color code for the button face
Model_name Filename (in double quotes, without extension) of the picture to
set up.

Picture Popup Button


The button fls_m_popup is used to set up a mimic picture in a popup window.
The popup window will be contained within the main window.

Figure 17 - Button fls_m_popup

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label Text (in double quotes) on the button face.


Fillcol Color code for the button face
Model_name Filename (in double quotes, without extension) of the picture to
set up.

Picture Popup Floating Button


The button fls_m_newwindow is used to set up a mimic picture in a new popup
window. The popup window will be a free-floating window independent of the
main window.

Figure 18 - Button fls_m_newwindow

Parameters are set by:

Reference Manual ECS OpStation Editor

Right click the selected button

Select Rename Variables

ECS OpStation Editor 13

Fill in the Value part of the Rename variables box

Button_label Text (in double quotes) on the button face.


Fillcol Color code for the button face
Model_name Filename (in double quotes, without extension) of the picture to
set up.

Faceplate Popup Button


The button fls_m_facepopup is used to set up a faceplate. This is used in special
cases only. Normally a faceplate is set up by right click on a point object.

Figure 19 - Button fls_m_facepopup

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label Text (in double quotes) on the button face.


FacePlateName Name of the faceplate (in double quotes)
Fillcol Color code for the button face
PointNo Point number of faceplate owner. Set Get point as Point number and
use toolbar buttons to get a point.

Bit Control Button


The button fls_m_bitcontrol is used to send a bit set or bit clear output command
to a point in a Plc.

Figure 20 - Button fls_m_bitcontrol

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

BitNo Number of bit (0 .. 15) to control

14 ECS OpStation Editor

Reference Manual ECS OpStation Editor

BitVal Value to send (0 = clear, 1 = set)


Button_label Text (in double quotes) on the button face.
Confirm 1 = confirmation box on output, 0 = no confirmation
EventText Text (in double quotes) for the generated event line. At most 24
characters.
Extent_height Height of button (e.g. 4)
Extent_width Width of button (e.g. 8)
Font True type font. Use 1 .. 13
PointNo Point number of output point

Bit Set Button


The button fls_m_bitset is used to send a bit set or bit clear output command to a
point in a Plc.
The function is the same as the bit control button but the appearance is different.
While fls_m_bitcontrol is a pushbutton, fls_m_bitset is a mode button i.e. it will
appear in the pressed-in state if a configurable InBit has value 1.

Figure 21 - Button fls_m_bitset

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

OutBitNo Number of bit (0 .. 15) to control


OutBitVal Value to send (0 = clear, 1 = set)
InBitNo Number of MSW bit to control appearance (value 0 = out, value 1 = in)
Button_label Text (in double quotes) on the button face.
Button_label_color Text color of the label
Confirm 1 = confirmation box on output, 0 = no confirmation
EventText Text (in double quotes) for the generated event line. At most 24
characters.
Extent_height Height of button (e.g. 4)
Extent_width Width of button (e.g. 8)
Font True type font. Use 1 .. 13
PointNo Point number of output point

Bit Pulse Button


The button fls_m_bitpulse is used to send a pulsed bit command to a point in a
Plc. Upon button click the value 1 is sent out and when the corresponding MSW
read bit is 1 the value 0 is sent out.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 15

Figure 22 - Button fls_m_bitpulse

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label Text (in double quotes) on the button face.


Confirm 1 = confirmation box on output, 0 = no confirmation
EventText1 Text (in double quotes) for the generated event line for control 1. At
most 24 characters.
EventText0 Text (in double quotes) for the generated event line for control 0. At
most 24 characters.
OutBitNo Number of bit (0 .. 15) to control
InBitNo Number of bit (0 .. 15) to check for 1-state before sending 0.
Extent_height Height of button (e.g. 4)
Extent_width Width of button (e.g. 8)
Font True type font. Use 1 .. 13
PointNo Point number of output point
Note: The timeout for the value 1 to be read back from MSW is 15 seconds
Another button fls_m_bitpulse1 has a configurable timeout value TimeOutSecs
set by rename variables.

Bit Toggle Button


The button fls_m_bittoggle is used to change a bit to its opposite value i.e. if bit
is set send a bit clear output command and if bit is cleared send a bit set output
command.
The toggle button is a mode button i.e. the appearance is controlled by the
current value of an InBit of the MSW. If the bit is set, the button shows pressedin, if the bit is cleared, the button shows pressed-out.

Figure 23 - Button fls_m_bittoggle

Parameters are set by:

16 ECS OpStation Editor

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Reference Manual ECS OpStation Editor

Button_label Text (in double quotes) on the button face.


Button_label_color Text color of button label.
Confirm 1 = confirmation box on output, 0 = no confirmation
EventText Text (in double quotes) for the generated event line. At most 24
characters.
OutBitNo Number of bit (0 .. 15) to control
InBitNo Number of bit (0 .. 15) to control button appearance
Extent_height Height of button (e.g. 4)
Extent_width Width of button (e.g. 8)
Font True type font. Use 1 .. 13
PointNo Point number of output point

Bit Toggle Check


The gismo fls_m_bitcheck has the same function as fls_m_bittoggle, but
displays a checkmark if the InBit is set and blank if cleared. Click in the gismo
toggles the OutBit value.

Figure 24 - gismo fls_m_bitcheck

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

CheckBackColor Background color of the gismo.


CheckColor Color of the checkmark.
Confirm 1 = confirmation box on output, 0 = no confirmation
EventText Text (in double quotes) for the generated event line. At most 24
characters.
OutBitNo Number of bit (0 .. 15) to control
InBitNo Number of bit (0 .. 15) to control gismo appearance
Font True type font. Use 1 .. 13
PointNo Point number of output point

Mode Control Button


The button fls_m_mode_diamon is used to change the mode of a PID controller,
but behaves in the same way as the Bit Control button. It can be used to send a
bit set or bit clear command to any point the Plc.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 17

Figure 25 - Button fls_m_mode_diamon

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

BitNo Number of bit (0 .. 15) to control


BitVal Value to send (0 = clear, 1 = set)
Confirm 1 = confirmation box on output, 0 = no confirmation
Edge_width width of the button edge (1 .. 5)
EventText Text (in double quotes) for the generated event line. At most 24
characters.
PointNo Point number of mode point

Percent Change Button


The buttons fls_m_percent_up, fls_m_percent_upsmall, fls_m_percent_down,
fls_m_percent_downsmall are used for percent wise change of an analog value.
The buttons behave in a special way when applied to a set point because the
change will affect the output point related to the set point if the mode related to
the set point is manual.

Figure 26 - Buttons fls_m_percent_up and fls_m_percent_down

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label text (in double quotes) associated the button.


Confirm 1 = confirmation box on output, 0 = no confirmation
Edge_width width of the button edge (1 .. 5)
ManModeMaskBits mask bits of MSW for manual mode given as an integer
(may be hex). e.g. 10 (or 0x000a) means bit 1 and bit 3 defines manual mode.
Defines the bits that must be tested to determine manual mode.
ManModeValueBits value bits of MSW for manual mode given as integer (may
be hex). Defines the values of the bits given by the mask that determines manual

18 ECS OpStation Editor

Reference Manual ECS OpStation Editor

mode. e.g. 2 (or 0x0002) means that with the above mask given manual mode is
defined as bit 1 = 2 and bit 3 = 0.
PercentChange percentage of the points system range to raise or lower the
current value
PointNo Point number of controlling point
Text_align_x horizontal alignment of button label. 1 = left, 2 = mid, 3 = right
Text_height height of button label (e.g. 2.0)

Sdr Trend Button


The button fls_m_sdrtrend is used to activate the Sdr Trend application with a
specific trend package.

Figure 27 - Button fls_m_sdrtrend

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label text (in double quotes) associated the button.


Extent_height Height of button (e.g. 4)
Extent_width Width of button (e.g. 8)
Font True type font. Use 1 .. 13
TrendPackNo Trend pack number to display

Start Process Button


The button fls_m_startprocess is used to start any external application with
specified parameters. For example you may start Excel with a specific
spreadsheet.

Figure 28 - Button fls_m_startprocess

Parameters are set by:

Right click the selected button

Select Rename Variables

Fill in the Value part of the Rename variables box

Button_label text (in double quotes) associated the button.


Confirm 1 = confirmation box, 0 = no confirmation
Extent_height Height of button (e.g. 4)
Extent_width Width of button (e.g. 8)

Reference Manual ECS OpStation Editor

ECS OpStation Editor 19

Font True type font. Use 1 .. 13


ProgramFile Name of the application file (.exe) to start (in double quotes). If
not in standard path, include full path.
ParamTexti i = 1..5 Name of the i-th parameter to pass to the application (in
double quotes). Leave blank if not applicable.

Toolbar buttons
All toolbar buttons in OpStation is available in the toolbar palette, and can be
added to any picture. They work exactly the same way as the OpStation toolbar
buttons.

General action buttons


The button flsa_call is used to make a generic call to any action function in
OpStation except for the edit functions. The action functions should be called
with Ignore = 0.

Button_label text (in double quotes) associated the button.


Button_state should not be renamed
Edge_width width of the button edge (1 .. 5)
flsfunction one of the action function with all parameters.
Text_align_x horizontal alignment of button label. 1 = left, 2 = mid, 3 = right
Text_height height of button label (e.g. 2.0)
The button flsa_twocalls makes one call to any action function on mouse press
and another call to any action function on mouse release if the first call does not
put another application on top of the button.

Button_label text (in double quotes) associated the button.


Button_state should not be renamed
Edge_width width of the button edge (1 .. 5)
Text_align_x horizontal alignment of button label. 1 = left, 2 = mid, 3 = right
Text_height height of button label (e.g. 2.0)
PressCall one of the action functions with all parameters to be called on mouse
press.
ReleaseCall one of the action functions with all parameters to be called on
mouse release.

20 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Using OpenGMS Dynamics


OpenGMS dynamics is a supplement to classic dynamics, providing enhanced
flexibility. You can make your own special objects referencing all kinds of
attributes in the database. Further you can make use of the graphical features
offered by GMS, which are not available in classic dynamics.
A number of OpenGMS objects have been made. The use of these is described in
the following. The classic dynamic objects also exist in an OpenGMS version
with enhanced flexibility.
You should use OpenGMS objects when:

Classic dynamics does not fulfill your needs

Making faceplates (see section Faceplates)

Palettes
opengms_dynamic_1,
opengms_dynamic_2
plc_parameter_dynamic contain objects made with OpenGMS.

and

Renaming Variables
After instantiating an OpenGMS object in a picture, parameters are specified as
follows by rename variables.

Right click the selected object

Select Rename Variables

Fill in the Value part of the Rename variables box

As an example the rename variables box for the PntVal object (used to display a
point value) is shown below.

Figure 29 - Rename variables box

AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right


FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13

Reference Manual ECS OpStation Editor

ECS OpStation Editor 21

PointNo Point number of the controlling point.

Fonts
The fonts available are the following true type fonts:
Font index

Font Description

Arial

Courier New-Bold

Courier New

Times New Roman

Courier New-Italic

Times New Roman-Bold

Arial-Bold

Arial-Italic

Times New Roman-Bold-Italic

10

Times New Roman-Italic

11

Arial-Bold-Italic

12

Courier New-Bold-Italic

13

Symbol

PointNo Variable
As for above example all OpenGMS objects will have a variable PointNo.
If the object is part of a faceplate the PointNo is entered as $ (dollar sign) which
means that the actual pointno will refer to the point selected when the faceplate
is activated.
If the object is part of a normal mimic picture PointNo is the point number of the
controlling point. As the user knows only point codes and not point numbers, a
conversion function must be used. This function pointno("<pointcode>")
converts a point code to a point number. Instead of entering e.g.
pointno("J4P12") as plain text you may set Get point as Point number and
then use the toolbar buttons to get a point code from the point list. The point will
then automatically be entered as pointno("<pointcode>").
The use of Special Point related Get and Special PLC related Get is explained
in section "Creating OpenGMS Dynamics"
The following describes the ready-made OpenGMS objects.

PntCode Object
This object displays the point code for a point.

Figure 30 - Gismo PntCode

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right

22 ECS OpStation Editor

Reference Manual ECS OpStation Editor

FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

PntCodeVis Object
This object displays the point code for a point with visibility control. If a
controlling B-point is set, the point code will be visible, if cleared the point code
will be invisible.
A picture may thus have hidden point codes, which becomes visible when a
toggle button in the picture is pushed to set the controlling B-point value.

Figure 31 - Gismo PntCodeVis

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
BackColor Color of the background when point code is invisible.
ControlBitNo Bit number of the controlling B-point for visibility check.
ControlPointNo Point number of controlling B-point.
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the point.

PntText Object
This object displays the point text of a point.

Figure 32 - Gismo PntText

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13

Reference Manual ECS OpStation Editor

ECS OpStation Editor 23

PointNo Point number of the controlling point.

PntVal Object
This object displays the point value for an A-point. Value, color and blink are
dynamically updated according to the controlling point. The format of the value
and the unit is as defined for the point in the database. The object is selectable,
i.e. click on object will behave as for classic object PointVal.

Figure 33 - Gismo PntVal

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

PntValText Object
This object displays the point value text for a B-point (e.g. "run", "stop"). Value,
color and blink are dynamically updated according to the controlling point. The
object is selectable, i.e. click on object will behave as for classic object PointVal.

Figure 34 - Gismo PntValText

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

PntValEnt Object
This object displays the point value of an A-point. Similar to PntVal but allows
data entry by left click on point.

Figure 35 - Gismo PntValEnt

Variables to rename:

24 ECS OpStation Editor

Reference Manual ECS OpStation Editor

AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right


FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

PntMSWInt Object
This object displays the machine status word (MSW) for a B-point. The 16-bit
value is displayed as an integer.

Figure 36 - Gismo PntMSWInt

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

PntMSWHex Object
This object displays the machine status word (MSW) for a B-point. The 16-bit
value is displayed as a hexadecimal integer.

Figure 37 - Gismo PntMSWHex

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 25

PntMSWBit Object
This object displays the value of a single bit of the machine status word (MSW)
for a B-point. The value is displayed as 0 or 1.

Figure 38 - Gismo PntMSWBit

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
BitNo Number of bit in MSW to display. 0 .. 15
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.

PntMSWBitText Object
This object displays the value of a single bit of the machine status word (MSW)
for a B-point. The value is displayed as text.

Figure 39 - PntMSWBitText

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
BitNo Number of bit in MSW to display. 0 .. 15
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
PointNo Point number of the controlling point.
TextColor0 Color text for value 0 given as GMS color index
TextColor1 Color text for value 1 given as GMS color index
ValueText0 Text for value 0
ValueText1 Text for value 1

26 ECS OpStation Editor

Reference Manual ECS OpStation Editor

PntThermoVer Object
This object displays the value of an A-point as a percentage fill of a vertical
thermometer. The fill percent is calculated from the actual value and the operator
graphical limits. Red lines mark the high- and low alarm limits. A green line
marks the normal value. The fill color and blink is that of the controlling point.
The thermometer is dynamically updated.

Figure 40 - Gismo PntThermoVer

Variables to rename:
PointNo Point number of the controlling point.

PntThermoDev Object
This object displays the value of an A-point as a percentage fill of a deviation
thermometer. A green line in center marks the normal value. Plus- and minus
deviation from normal value is displayed as percentage fill. Behavior is as for
PntThermoVer.

Figure 41 - Gismo PntThermoDev

Variables to rename:
PointNo Point number of the controlling point.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 27

PntThermoSca Object
This object displays the value of an A-point as a percentage fill of a
thermometer. The Thermometer is equipped with a scale indicating highmedium- and low- limits. Limits are operator graphical limits. Behavior is as for
PntThermoVer.

Figure 42 - Gismo PntThermoSca

Variables to rename:
PointNo Point number of the controlling point.

PntSlider Object
This object displays the value of an A-point as a percentage fill of a
thermometer. The behavior is as for PntThermoVer, but this object also permits
data entry by dragging the slider knob. A small window displays the actual
numerical value while dragging. Upon release of the slider knob the new value is
sent out to the IO system.

Figure 43 - Gismo PntSlider

Variables to rename:
Confirm 1 = confirmation box on output, 0 = no confirmation
PointNo Point number of the controlling point.

28 ECS OpStation Editor

Reference Manual ECS OpStation Editor

PlcVal Object
This object displays a PLC-parameter value with unit. Plc parameters are located
in a parameter block associated a point address in the PLC. The parameters are
described according to a block algorithm. The format of the value and the unit is
as defined in the block algorithm associated the parameter.

Figure 44 - Gismo PlcVal

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
ParameterKey Text string (in double quotes) identifying the PLC parameter in
the block algorithm.
PointNo Point number of the controlling point.
TextColor Text color given as GMS color index.

PlcValEnt Object
This object displays a PLC parameter value and allows data entry by clicking on
the object. The entered value is sent to the PLC to change the parameter. The
value display is as for PlcVal.

Figure 45 - Gismo PlcValEnt

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
ParameterKey Text string (in double quotes) identifying the PLC parameter in
the block algorithm.
PointNo Point number of the controlling point.
TextColor Text color given as GMS color index.

PlcInt Object
This object displays a PLC parameter value of type unsigned, integer or bit
pattern without unit.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 29

Figure 46 - Gismo PlcInt

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
ParameterKey Text string (in double quotes) identifying the PLC parameter in
the block algorithm.
PointNo Point number of the controlling point.
TextColor Text color given as GMS color index.

PlcIntEnt Object
This object displays a PLC parameter value of type unsigned, integer or bit
pattern without unit. Data entry is allowed by click on the object. The entered
value is sent to the PLC and the parameter is changed.

Figure 47 - Gismo PlcIntEnt

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
Font Text font as GMS True Type font index. 1 .. 13
ParameterKey Text string (in double quotes) identifying the PLC parameter in
the block algorithm.
PointNo Point number of the controlling point.
TextColor Text color given as GMS color index.

PlcParName Object
This object displays the name of a PLC parameter in current language. The name
is defined in the block algorithm.

Figure 48 - Gismo PlcParName

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right

30 ECS OpStation Editor

Reference Manual ECS OpStation Editor

FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
ParameterKey Text string (in double quotes) identifying the PLC parameter in
the block algorithm.
PointNo Point number of the controlling point.
TextColor Text color given as GMS color index.

LangText Object
This object displays a text constant in the current language. The texts constants
are
defined
in
the
table
LanguageTexts
of
the
database
FlsaDev\ProDb\SdrOpsSpecial
Text10.mdb.
Note. LangText is intended for FLSA use only. Some of the standard faceplates
provided by FLSA uses these objects for text constants. The end customer
should use plain text or text rectangle primitives in his native language when he
makes new pictures.

Figure 49 - Gismo LangText

Variables to rename:
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
Text_align_x Horizontal alignment of text in the box. 1 = left, 2 = mid, 3 = right
Text_height Size of the text (e.g. 2.5)
TextColor Color of text given as GMS color index.
TextKey String (in double quotes) identifying the database key for the text
constant.

AbbreviationText Object
This object displays a text abbreviation according to a currently selected set of
abbreviations. The texts constants are defined in the table AbbreviationTexts of
the database FlsaDev\ProDb\SdrOpsSpecialText10.mdb.
Note. AbbreviationText is intended for FLSA use only. The ACESYS faceplates
use different abbreviations for different applications (FLSA, FLS, HTC, etc. ).
The set to use for a specific project is selected through the ECS OpStation
Configuration utility under Abbreviations sub function.

Figure 50 - Gismo AbbreviationText

Reference Manual ECS OpStation Editor

ECS OpStation Editor 31

Variables to rename:
AlignX Horizontal alignment of text in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Color of text given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
Text_height Size of the text (e.g. 2.5)
TextKey String (in double quotes) identifying the database key for the text
constant

FlsDateTime Object
This object displays the current date and/or time. The time is dynamically
updated every second. The format conforms to the current users locale setting.
The locale setting is changed through the Regional Settings function of Windows
NT.

Figure 51 - Gismo FlsDataTime

Variables to rename:
AlignX Horizontal alignment of text in the box. 1 = left, 2 = mid, 3 = right
DateOnly Display only current date (omit time).
TimeOnly Display only current time (omit date).
NoSecs Display only hours and minutes of time part (omit seconds).
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Color of text given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13

Generic route property text object


This object displays generic information for a route.

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
Property The route property. Use __Routexxx where xxx is the property.

32 ECS OpStation Editor

Reference Manual ECS OpStation Editor

RouteCode the code of the route.


SampleFreq number of seconds between update of value. 0 for every scan. 1
for static. (update only first time and on refresh all)

Generic group property text object


This object displays generic information for a group.

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
Property The group property. Use __Groupxxx where xxx is the property.
GroupCode the code of the Group.
SampleFreq number of seconds between update of value. 0 for every scan. 1
for static. (update only first time and on refresh all)

Generic department property text object


This object displays generic information for a group.

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.
EdgeColor Edge color of the box given as GMS color index.
TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
Property The department property. Use __Depxxx where xxx is the property.
DepCode the code of the department.
SampleFreq number of seconds between update of value. 0 for every scan. 1
for static. (update only first time and on refresh all)

Generic point property text object


This object displays generic information for a group.

Variables to rename:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
FillColor Fill color of the box. Color given as GMS color index. Use Special
Color Get to select the color from a palette.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 33

EdgeColor Edge color of the box given as GMS color index.


TextColor Text color of the box given as GMS color index.
Font Text font as GMS True Type font index. 1 .. 13
Property The point property. Use __Pointxxx where xxx is the property.
PointCode the code of the point.
SampleFreq number of seconds between update of value. 0 for every scan. 1
for static. (update only first time and on refresh all)

Creating OpenGMS Dynamics


OpenGMS dynamics is based upon the standard GMS concept of dynamic
properties associated an object. Dynamic properties are then enhanced by
functions, which provide data from the ECS database to drive the dynamics.

GMS Dynamic Properties


Dynamic properties (dynprop) are scripts that may be associated any object
drawn in the editor.
The basic elements are actions:
Action argument
The actions are fixed keywords and the argument is an expression containing
constants, variables or one of our OpenGMS functions.
Examples:
"fcolor 3" means that the fill color of the object shall be green (which is 3)
"fcolor FillColor" means that the fill color of the object is determined by the
value of a variable called FillColor. The actual value of this variable is defined
by rename variables when the object is instantiated in a picture.
"fcolor pntint(__COLOR, PointNo)" means that the fill color of the object is
determined by the OpenGMS function call pntint, which in this case will return
the actual color of the point PointNo as defined in the database. Again PointNo
is a variable the value of which is defined by rename variables when the object
is instantiated in a picture.
The following table lists the actions available in dynamic properties:
Action and argument type

34 ECS OpStation Editor

Description

ecolor int

edge color

estyle int

edge style 0 - no edge, 1 - solid, 2..4 - dotted

ewidth float

edge width

fcolor int

fill color

fstyle int

fill pattern 1..6 only relevant if finter = 2 or 3

finter int

fill interior 0 - hollow, 1 - solid, 2 - opaque, 3 - transp.

fdir int

fill direction 0 - up, 1 - right, 2 - down, 3 - left

fpercent float

fill percentage 0 .. 100

filled int

filled object 0 - not filled, 1 - filled

mcolor int

marker color

mstyle int

marker style 1 - period, 2 - +, 3 - *, 4 - o, 5 - x

tcolor int

text color

Reference Manual ECS OpStation Editor

theight float

text height

tpath int

text path (direction) 1 - right, 2 - down

tfont int

text font 1..13

tprec int

text precision 0 - TrueType, 1 - Hershey (not avail)

talign x (int) y(int)

text alignment x col - 1..3, y row - 1..5 ( center is 2 3)

stext int/float/string format

text content.
format:
"%d"

integer

"%5.2f" float with 5 digits before and 2 after dec. sep.


"%s"

string

detect int

detectability 0 - not detectable, 1 - detectable

vis int

visibility 0 - invisible, 1 - visible, 3 - forced update

move x(float) y(float)

move relative x - 0..100, y - 0..75

movex float

move relative in x direction

movey float

move relative in y direction

rotate float

rotate relative 0 .. 360 degrees

scale float

scale evenly

scalex float

scale horizontally

scaley float

scale vertically

radius float

radius of circles, pies and sectors

arclength float

angle for size of sectors or pies

startangle float

starting angle of sectors and pies

redraw

redraw without erasure

call function

call function (i.e. OpenGms function)

userword string

must not be used (reserved for classic dynamics)

userdata int

must not be used (reserved for classic dynamics)

There are three types of dynamic properties:


Unconditional
*
action argument

The actions are executed when the picture is loaded and then whenever any
variable in an argument changes. Furthermore, the use of an OpenGMS function
will automatically cause periodical execution of the action.
Conditional
1.
Variable expression
condition value
action argument

condition is one of =, !=, <=, >=, <, >


Example:
pntbit(__BIT_MSW, PointNo, 2)

Reference Manual ECS OpStation Editor

ECS OpStation Editor 35

=0
stext "OFF" "%s"
=1
stext "ON" "%s"
Above will set a text to "OFF" if bit 2 of MSW for PointNo is 0 and to "ON" if
0
2.
Variable expression
= *
action argument

The actions are executed whenever any variable in variable expression argument
changes. Using for example __VALUE as variable expression will ensure an
update at every scan. Using __COLV7STATIC will update the action when the
picture is loaded or refreshed.
3.
Variable expression
= value1:value2
action argument

The actions are executed if the variable expression lies in the range value1 to
value2
Input (click)
#
call function

The functions are called when clicking on the object.


Example:
#
call gms_push_btn_select())
call iosbitaction(PointNo, BitNo, BitVal, EventText, Confirm)
Above has two function calls. The first is a GMS function to change the look of
a button when pressed. The second is a FLSA function to send out a bit control
command to a PLC. The values of the variables in the function call are specified
by rename variables when the object is instantiated in a picture.

OpenGMS Functions
OpenGMS functions are functions that interact with the SDR system. They can
return data from the database or send an IO command to a PLC. These functions
may be used in expressions as part of dynamic properties.
Note that the function names are case sensitive.
The functions are described in the following.

36 ECS OpStation Editor

Reference Manual ECS OpStation Editor

The functions can be split into function returning information and action
functions.

Information Functions
Pointno Function
int pointno( PointCode )
returns the point number given the point code for a point. The function is used as
an auxiliary function when supplying point number arguments to the other
OpenGMS functions.
PointCode is point code as a text string (in double quotes)
Example:
pointno("j4p12")

Pntfloat Function
float pntfloat( ValueId, PointNo )
returns a floating point (real) value.
ValueId specifies the point attribute as shown in the following table
PointNo is point number of the controlling point.
Value Id

Description

__VALUE

Analog point value

__SYSHIGH

Analog point system high limit

__SYSLOW

Analog point system low limit

__GRAHIGH

Analog point operator high limit

__GRALOW

Analog point operator low limit

__HYSTERES

Analog point hysteresis

__INTERVAL

Analog point alarm interval size

__ALARMHIGH

Analog point alarm high limit

__ALARMLOW

Analog point alarm low limit

__NORMVALUE

Analog point normal value

__GAIN

Analog point gain

__OFFSET

Analog point offset

__CONST1

Analog point constant C1

__CONST2

Analog point constant C2

__CONST3

Analog point constant C3

__CONST4

Analog point constant C4

__CONST5

Analog point constant C5

__CONST6

Analog point constant C6

__CONST7

Analog point constant C7

__CONST8

Analog point constant C8

__CONST9

Analog point constant C9

__CONST10

Analog point constant C10

Examples:

Reference Manual ECS OpStation Editor

ECS OpStation Editor 37

__VALUE
=*
stext pntfloat(__ALARMHIGH, pointno("j4p12")) "%5.2f"
writes the high alarm limit for point j4p12 as text

Pntint Function
int pntint( ValueId, PointNo )
returns an integer value.
ValueId specifies the point attribute as shown in the following table
PointNo is point number of the controlling point.
Value Id

Description

__DEPARTMENT

Point-associated department number

__CONV_ALG

Point conversion algorithm

__EVENT_ALG

Point alarm algorithm

__REP_ALG

Point report algorithm

__EVENT_PNT

Alarm treatment suppression point

__REPORT_PNT

Report treatment suppression point

__INTERFACE

Interface (IO) type

__PRIORITY

Alarm priority

__COLOR

Point color number

__SYMBOLOFF

GMS symbol offset

__INT_STATUS

Point status word

__INT_STAAUX

Point aux status word

__INT_VALREF

Point value text number

__INT_STAREF

Point status text number

__ALARMLEVEL

Point alarm level

__MSW

Point Machine Status Word

__FILTER

Point filter time constant (seconds)

__FORMAT

Point format number

__REF_PNT1

Reference point 1

__REF_PNT2

Reference point 2

__REF_PNT3

Reference point 3

__REF_PNT4

Reference point 4

__REF_PNT5

Reference point 5

__REF_PNT6

Reference point 6

__REF_PNT7

Reference point 7

__REF_PNT8

Reference point 8

__REF_PNT9

Reference point 9

__REF_PNT10

Reference point 10

__UNITNO

Engineering unit number

Examples:

38 ECS OpStation Editor

Reference Manual ECS OpStation Editor

__VALUE
=*
tcolor pntint(__COLOR, pointno("j4p12"))
sets the text color to that of point j4p12.
__VALUE
=*
tcolor pntint(__COLOR, pntint(__REF_PNT2, pointno("j4p12")))
sets the text color to that of reference point 2 of point j4p12.

Pnttext Function
char* pnttext( ValueId, PointNo )
returns a text string.
ValueId specifies the point attribute as shown in the following table
PointNo is point number of the controlling point.
Value Id

Description

__DEP_NAME

Point department name

__POINTCODE

Point code

__POINTTEXT

Point text

__STATUSTEXT

Point status text

__VALUETEXT

Point value text

__UNITTEXT

Point engineering unit

Examples:
__COLV7STATIC
=*
stext pnttext(__POINTTEXT, pointno("j4p12")) "%s"
writes the point text (descriptor) for point j4p12. Will only be updated when the
picture is loaded or refreshed.

Pntbit Function
int pntbit( ValueId, PointNo, BitNo )
returns 0 or 1 as integer value.
ValueId specifies the point attribute as shown in the following table
PointNo is point number of the controlling point.
BitNo specifies the bit (0..15), the value of which is returned.
Value Id

Description

__BIT_MSW

Bit value in machine status word

Examples:
__VALUE

Reference Manual ECS OpStation Editor

ECS OpStation Editor 39

=*
stext pntbit(__BIT_MSW, pointno("j4p03"), 2) "%d"
writes the value of bit 2 in MSW for point j4p03 as text.

Pntvalue Function
pntvalue( ValueId, Object, PointNo )
This function sets an object to the current point value. The object must be a text
or text rectangle object. The value is formatted according to point format and the
color of the value is the point color. The function is a more powerful alternative
to pntfloat(__VALUE, PointNo).
ValueId must be the constant __VALUE.
Object must be the constant __self.
PointNo is point number of the controlling point.
Example:
__VALUE
=*
call pntvalue(__VALUE, __self, PointNo)
The value of the variable PointNo is determined by rename variables when the
object is instantiated.
Below is the full ..\gismos\pntval.g file for the ready-made pntval object. This
object uses openGMS functions pntvalue, pntunit and pntselect.
mtran0
vis 1
detect 1
pntval: model
. dynprop \
(# \
(call pntselect(__self, PointNo)))
unit: model
fcolor 22
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 7
estyle 0
ewidth 1
tcolor 7
height 1
path 1
font 1
prec 0
align 1 3
size 0 0
tconstraint 0
unittext: ftrect 3 0 0 2.5 "un"
. refpoint 0 0
vis 0
estyle 1
divide: line 0.3 1.25 2.5 1.25
. refpoint 0.119995 1.25
endm
vis 1
estyle 0
height 1.5
align 2 3
ftrect 0 2.5 8 0 "PntVal"
. dynprop
\
(__VALUE \
(= *
\
(call pntvalue(__VALUE, __self, PointNo))))
(AlignX \

40 ECS OpStation Editor

Reference Manual ECS OpStation Editor

(= *
\
(talign AlignX 3))) \
(FillColor \
(= *
\
(fcolor FillColor))) \
(Font \
(= *
\
(tfont Font)))
. refpoint 0 0
unit: inst unit 0 0
. dynprop
\
(__VALUE \
(= *
\
(call pntunit(__VALUE, __self, PointNo))))
(FillColor \
(= *
\
(fcolor FillColor))) \
(Font \
(= *
\
(tfont Font)))
. move 8 0
endm

Pntunit Function
pntunit( ValueId, Object, PointNo )
This function sets the engineering unit to that of the controlling point. The unit
will be shown as special GMS text as for the classic dynamic object pointval.
e.g. kg/m3 will be displayed as 3 lines in small size font to minimize the space
required for the unit. The color of the unit will be the point color. The object
must be like the gismo called unit with a text rectangle called unittext and a
line called divide (see below).
The function is a more sophisticated alternative to pnttext(__UNITTEXT,
PointNo), the latter writing the unit as single line plain text.
ValueId must be the constant __VALUE.
Object must be the constant __self.
PointNo is point number of the controlling point.
Example:
__VALUE
=*
call pntunit(__VALUE, __self, PointNo)
The object to which the function applies is shown below as an external gismo
unit (file ..\gismos\unit.g):
mtran0
vis 1
detect 1
unit: model
fcolor 22
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 7
estyle 0
ewidth 1
tcolor 7
height 1
path 1
font 1
prec 0
align 1 3
size 0 0

Reference Manual ECS OpStation Editor

ECS OpStation Editor 41

unittext: ftrect 3. 0. 0. 2.5 "un"


. refpoint 0 0
vis 0
estyle 1
divide: line 0.3 1.25 2.5 1.25
. refpoint 0.12 1.25
endm

For a full example see description of function pntvalue.

Plctext Function
char* plctext( ValueId, PointNo, ParameterKey )
Returns a PLC parameter as a text string.
ValueId is as specified in the table below.
PointNo is point number of the controlling point. This identifies address of the
PLC parameter block and the block algorithm that holds the description of the
parameter.
ParameterKey is the key identifying the PLC parameter (string) in the block
algorithm.
Value Id

Description

__PLCTXTPAR

Plc parameter is returned as ready


formatted string according to block
algorithm

__PLCCAPTEXT

The name of the PLC parameter is


returned

__PLCUNIT

Engineering unit from block algorithm

in the current language


returned as plain text

Examples:
__VALUE
=*
stext plctext( __PLCCAPTEXT, PointNo, Gain) %s
Above writes the name of the PLC parameter Gain as defined in the block
algorithm. The value of PointNo is determined by rename variables when the
object is instantiated.
__VALUE
=*
stext plctext( __PLCTXTPAR, PointNo, Gain) %s
Above writes the PLC parameter Gain in the format specified in the block
algorithm. The value of PointNo is determined by rename variables when the
object is instantiated.

Plcdouble Function
double plcdouble( ValueId, PointNo, ParameterKey )
Returns a double floating point PLC parameter.
ValueId must be the constant __PLCDBLPAR
PointNo is point number of the controlling point. This identifies address of the
PLC parameter block and the block algorithm that holds the description of the
parameter.

42 ECS OpStation Editor

Reference Manual ECS OpStation Editor

ParameterKey is the key identifying the PLC parameter (string) in the block
algorithm.
Example:
*
stext plcdouble( __PLCDBLPAR, PointNo, Gain) %5.2f
Above will get the floating point PLC parameter with key Gain as a double
and write it as a text string in format xxxxx.yy. The actual value of PointNo is
determined by rename variables when the object is instantiated.
Note. The function plctext can return the value as a text string formatted as
specified in the block algorithm.

Plcint Function
int plcint( ValueId, PointNo, ParameterKey )
Returns a PLC parameter as an integer. The parameter must be of type bit
pattern.
ValueId must be the constant __PLCINTPAR
PointNo is point number of the controlling point. This identifies address of the
PLC parameter block and the block algorithm that holds the description of the
parameter.
ParameterKey is the key identifying the PLC parameter (string) in the block
algorithm.
Example:
__VALUE
=*
stext plcint( __PLCINTPAR, PointNo, ParKey) %d
Above will get a PLC parameter identified by variable ParKey and write it as a
string. The value of PointNo and ParKey is determined rename variables when
the object is instantiated.

Plcunit Function
plcunit( Object, PointNo, ParameterKey )
This function sets the engineering unit to that of the block algorithm parameter.
The unit will be shown as special GMS text as for the classic dynamic object
pointval. e.g. kg/m3 will be displayed as 3 lines in small size font to minimize
the space required for the unit. The object must be like the gismo called unit
with a text rectangle called unittext and a line called divide (see below).
The function is a more sophisticated alternative to plctext(__PLCUNIT,
PointNo, ParameterKey), the latter writing the unit as single line plain text.
Object must be the constant __self
PointNo is point number of the controlling point. This identifies address of the
PLC parameter block and the block algorithm that holds the description of the
parameter.
ParameterKey is the key identifying the PLC parameter in the block algorithm.
Example:
__COLV7STATIC
=*
call plcunit( __self, PointNo, ParKey )

Reference Manual ECS OpStation Editor

ECS OpStation Editor 43

The value of PointNo and ParKey is determined rename variables when the
object is instantiated.
The object to which the function applies is shown below as an external gismo
unit (file ..\gismos\unit.g):
mtran0
vis 1
detect 1
unit: model
fcolor 22
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 7
estyle 0
ewidth 1
tcolor 7
height 1
path 1
font 1
prec 0
align 1 3
size 0 0
unittext: ftrect 3. 0. 0. 2.5 "un"
. refpoint 0 0
vis 0
estyle 1
divide: line 0.3 1.25 2.5 1.25
. refpoint 0.12 1.25
endm

For a full example see description of function plcedit.

Langtext Function
char* langtext( TextKey )
This function returns a text constant in current language. The functions apply to
a text or text rectangle object. The language texts are defined in the database
Flsadev\ProDb\
SdrOpsSpecialText10.mdb table LanguageTexts.
The function is used in the standard gismo LangText.
The purpose of the function is to allow text constants, which automatically will
be displayed, in the current language. The function is intended for FLSA use
only. The end customer should write text constants in his native language only.
An example using the function is the PidFace where all text constants are made
with langtext.
TextKey is text string identifying the text in the LanguageText table.
Example:
__COLV7STATIC
=*
stext langtext( "lngManual" ) "%s"

Abbreviationtext Function
char* abbreviationtext( TextKey )
This function returns a text abbreviation according to a currently selected set of
abbreviations. The functions apply to a text or text rectangle object. The
abbreviation
texts
are
defined
in
the
database
Flsadev\ProDb\SdrOpsSpecialText10.mdb table AbbreviationTexts.
The function is used in the standard gismo AbbreviationText.

44 ECS OpStation Editor

Reference Manual ECS OpStation Editor

The purpose of the function is to allow text, which will be displayed according to
a certain type of application. For a specific project the type is selected via ECS
OpStation Configuration utility sub function Abbreviations. The function is
intended for FLSA use only.
An example using the function is the ACESYS faceplates where all text
abbreviations are made with this function.
TextKey is text string identifying the text in the AbbreviationsTexts table.
Example:
__COLV7STATIC
=*
stext abbreviationtext( "GRP_GSEL" ) "%s"

Datetime Function
char* datetime( ValueId, DateOnly, TimeOnly, NoSecs )
Returns the current date and/or time in format defined by current users locale
setting.
The function is used in the standard gismo FlsDataTime.
ValueId is the constant that drives the updating of the time. Must be equal
__VALUE.
DateOnly =1 if only current date is returned, =0 otherwise
TimeOnly =1 if only current time is returned, =0 otherwise
NoSecs =1 if seconds shall be omitted from the time, =0 otherwise
example:
__VALUE
=*
stext datetime(__VALUE, 0, 0, 1)
will display date and time without seconds.
char* colv7datetime( cFormat )
Returns the time according to format specifiation where
cFormat Format specifikation
%a Abbreviated weekday name
%A Full weekday name
%b Abbreviated month name
%B Full month name
%c Date and time representation appropriate for locale
%d Day of month as decimal number (0131)
%H Hour in 24-hour format (0023)
%I Hour in 12-hour format (0112)
%j Day of year as decimal number (001366)
%m Month as decimal number (0112)
%M Minute as decimal number (0059)
%p Current locales A.M./P.M. indicator for 12-hour clock

Reference Manual ECS OpStation Editor

ECS OpStation Editor 45

%S Second as decimal number (00 59)


%U Week of year as decimal number, with Sunday as first day of week (0053)
%w Weekday as decimal number (0 6; Sunday is 0)
%W Week of year as decimal number, with Monday as first day of week (00-53)
%x Date representation for current locale
%X Time representation for current locale
%y Year without century, as decimal number (00 99)
%Y Year with century, as decimal number
%z,%Z Time-zone name or abbreviation; no characters if time zone is unknown
%% Percent sign
example:
__VALUE
=*
stext colv7datetime(%H:%M:%S )

extxxx functions
long extlong (Server, Type, Key1, Key2)
double extdouble (Server, Type, Key1, Key2)
char *exttext (Server, Type, Key1, Key2)
These functions return a long, double or a text from an external server
respectively.
Server server name configured in OpStation Configuration.
Type value type. See table below.
Key1 first part of the parameter key.
Key2 second part of the parameter key.
Function

46 ECS OpStation Editor

Type

Sample frequency

Extlong

__EXTLONG

Sample every 4 seconds

extlong

__EXTLONG1

Sample every second

extlong

__EXTLONG2

Sample every 2 seconds

extlong

__EXTLONG3

Sample every 3 seconds

extlong

__EXTLONG4

Sample every 4 seconds

extlong

__EXTLONG5

Sample every 5 seconds

extdouble

__EXTDOUBLE

Sample every 4 seconds

extdouble

__EXTDOUBLE1

Sample every second

extdouble

__EXTDOUBLE2

Sample every 2 seconds

extdouble

__EXTDOUBLE3

Sample every 3 seconds

extdouble

__EXTDOUBLE4

Sample every 4 seconds

extdouble

__EXTDOUBLE5

Sample every 5 seconds

exttext

__EXTTEXT

Sample every 4 seconds

exttext

__EXTTEXT1

Sample every second

exttext

__EXTTEXT2

Sample every 2 seconds

exttext

__EXTTEXT3

Sample every 3 seconds

Reference Manual ECS OpStation Editor

exttext

__EXTTEXT4

Sample every 4 seconds

exttext

__EXTTEXT5

Sample every 5 seconds

exttext

__EXTTEXT

Sample every 4 seconds

All

__SAMPLEFAST

Every time the picture is updated.

All

__SAMPLESLOW

Sample every 10 seconds

All

__STATICVALUE

First time and then on Refresh All.

colv7getgeneric functions
char* colv7getgenericstrlkey(ObjectType, lKey, Property, SampleFreq)
char* colv7getgenericstr(ObjectType, strKey, Property, SampleFreq)
double colv7getgenericdouble(ObjectType, strKey, Property, SampleFreq)
long colv7getgenericlong(ObjectType, strKey, Property, SampleFreq)
These function raps the PointAuto interface to get any value return as a char,
long, or double
ObjectType One of the four object types in the Point Auto.
__DepartmentObject, __GroupObject, __RouteObject, or
__PointObject.
lKey long key. Number of object.
sKey String key. Code of object.
Property Property in object. All relevant properties from PointAuto.
flsSomething is replaced with __Something. I.e. the property flsGroupColor
will be __GroupColor.
SampleFreq The update rate in number of seconds. 0 means every update. 1
means that it is static, and the value will only be updated on refresh all in
OpStation.

Colv7format function
char * colv7format(dValue, lFormat)
This function returns a string format of the value with the current regional
settings.
dValue Double value.
lFormat number of decimal points
__VALUE
=*
stext colv7format(pntfloat(__VALUE, PntNo1), pntint(__FORMAT,PntNo2))
Will print the value of PntNo1 formatted as PntNo2.

Colv7ConCat function
char * colv7concat(sString1, sString2)
This function returns a concatenated string of sString1 and sString2.

Colv7uacright function
long colv7uacright(Right)
This function returns 1 if the user has this particular right else it returns zero.
The prefix in the rights table needs to be Ops

Reference Manual ECS OpStation Editor

ECS OpStation Editor 47

Right the right key.

Action functions
Action functions are normally called Upon input, but the new version 7
functions can also be called on parameter change. The version 6 functions have a
filter so they only react on left mouse button release.

Pntselect Function
pntselect( Object, PointNo )
This function makes the object and the point the selected object and point when
clicked upon.
The object is surrounded by a white rectangle and point information is set in the
status bar panes. When right clicking on the object a popup menu will appear.
Object identifies the object. This argument must be the constant __self.
PointNo is point number of the controlling point.
Example:
#
call pntselect(__self, PointNo)
The value of the variable PointNo is determined by rename variables when the
object is instantiated.

Pntedit Function
pntedit( Object, PointNo )
This function allows for entering and sending an output value to IO system. The
function must be part of input dynamics of an object. This object must have two
text rectangles of same size on top of each other. First must be called
valuefield and displays the current value. The second must be called
editfield and is used when entering a value. A click on the main object will
make the edit field visible. The user enters a value and press of return on
keyboard will send the entered value to IO system. The value field then again
becomes visible.
Object must be __self.
PointNo is point number of the controlling point.
Example:
#
call pntedit( __self, PointNo )
Below is the full ..\gismos\pntvalent.g file for the ready-made pntvalent object.
This object uses openGMS function pntedit.
mtran0
vis 1
detect 1
pntvalent: model
. dynprop \
(# \
(call pntselect(__self, PointNo))
(call pntedit(__self, PointNo)))
unit: model

48 ECS OpStation Editor

Reference Manual ECS OpStation Editor

fcolor 22
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 7
estyle 0
ewidth 1
tcolor 7
height 1
path 1
font 1
prec 0
align 1 3
size 0 0
tconstraint 0
unittext: ftrect 3 0 0 2.5 "un"
. refpoint 0 0
vis 0
estyle 1
divide: line 0.3 1.25 2.5 1.25
. refpoint 0.119995 1.25
endm
vis 1
estyle 0
height 1.5
align 2 3
value: ftrect 0 2.5 8 0 "PntValE"
. dynprop
\
(__VALUE \
(= *
\
(call pntvalue(__VALUE, __self, PointNo)))) \
(AlignX \
(= *
\
(talign AlignX 3))) \
(FillColor \
(= *
\
(fcolor FillColor))) \
(Font \
(= *
\
(tfont Font)))
unit: inst unit 0 0
. dynprop
\
(__VALUE \
(= *
\
(call pntunit(__VALUE, __self, PointNo)))) \
(FillColor \
(= *
\
(fcolor FillColor))) \
(Font \
(= *
\
(tfont Font)))
. move 8 0
vis 0
edit: ftrect 0 2.5 8 0 ""
. dynprop
\
(AlignX \
(= *
\
(talign AlignX 3))) \
(__EDITFINISH \
(= *
\
(call editfinish(__EDITFINISH, __self))))
. refpoint 0 0
endm

Pntupdownpercent Function
pntupdownpercent(PointNo, PercentChange, ManModeMask,
ManModeValue, Confirm)
pntupdownpercentv7(PointNo, PercentChange, ManModeMask,
ManModeValue, Confirm, Ignore)

Reference Manual ECS OpStation Editor

ECS OpStation Editor 49

Change a point value with a given percentage. This function behave in a special
way when applied to a set point because the change will affect the output point
related to the set point if the mode related to the set point is manual.
PointNo Point number of controlling point
PercentChange percentage of the points system range to raise or lower the
current value
ManModeMaskBits mask bits of MSW for manual mode given as a integer
(may be hex). e.g. 10 (or 0x000a) means bit 1 and bit 3 defines manual mode.
Defines the bits that must be tested to determine manual mode.
ManModeValueBits value bits of MSW for manual mode given as integer (may
be hex). Defines the values of the bits given by the mask that determines manual
mode. e.g. 2 (or 0x0002) means that with the above mask given manual mode is
defined as bit 1 = 2 and bit 3 = 0.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Iosbitaction Function
iosbitaction( PointNo, BitNo, BitVal, EventText, Confirm )
iosbitactionv7( PointNo, BitNo, BitVal, EventText, Confirm , Ignore)
This function sends a bit control action to IO system. Iosbitaction only reacts on
left mouse release action, while the iosbitactionv7 reacts on any call if ignore is
set to 1.
PointNo is point number for point to which action applies
BitNo specifies the output bit number (0..15)
BitVal specifies the output value (0 or 1)
EventText a text string (in double quotes) for the event line generated by the
action
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)
Example:
#
call iosbitaction( PointNo, BitNo, BitVal, EventText, Confirm)
Above function will be called when user clicks on the object with the left mouse
button when the mouse button is released. The values of the variables PointNo,
BitNo, BitVal, EventText, Confirm are determined by rename variables when
the object is instantiated.
Example v7.
#
call gms_flash()
(__button_hilite == 0) && (__locator != 0)
!= 0
iosbitactionv7( PointNo, BitNo, BitValRelease,
EventTextRelease, 0, 1)
(__button_hilite == 1) && (__locator != 0)
!= 0
iosbitactionv7( PointNo, BitNo, BitValPress,
EventTextPress, 0, 1)

50 ECS OpStation Editor

Reference Manual ECS OpStation Editor

In the above v7 example the action will be called with the value of BitValPress
when the user clicks on the object and with the value BitValRelease when the
mouse button is released. The values of the variables PointNo, BitNo,
BitValPress, BitValRelease, EventTextRelease, EventTextPress are determined
by rename variables when the object is instantiated.

Iosbittoggle Function
iosbittoggle ( PointNo, OutBitNo, InBitNo, EventText, Confirm)
iosbittogglev7 ( PointNo, OutBitNo, InBitNo, EventText, Confirm, Ignore)
This function sends a bit control action to IO system. It sets the output bit to the
opposite of what is read in the input bit. iosbittoggle only reacts on left mouse
release action, while the iosbittogglev7 reacts on any call if ignore is set to 1.
PointNo is point number for point to which action applies
OutBitNo specifies the output bit destination (0..15)
InBitNo specifies the input bit to toggle. (0..15)
EventText a text string (in double quotes) for the event line generated by the
action.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Iosbitpulse Function
iosbitpulse (IdType, Object, PointNo, OutBitNo, InBitNo, First, EventText,
Confirm,)
iosbitpulse1 (IdType,
Object,
PointNo, OutBitNo, InBitNo, First,
EventText, Confirm, TimeOutSecs)
iosbitpulsev7 (IdType, Object, PointNo, OutBitNo, InBitNo, First,
EventText, Confirm, TimeOutSecs , Ignore)
This function is used as a two-step function. The first action is to set the output
bit to 1 and start the timer. If the input bit has changed to 1 within the timeout
period the output bit is set to 0. If the first two version 6 functions are used it
demands a call Upon input where first is set to 1 and an Unconditional
action. In order make the back action. Iosbitpulse has a timeout of 15 seconds.
IdType Used to force update for supervision. (Use __VALUE)
Object must be the constant __self.
PointNo is point number for point to which action applies
OutBitNo specifies the output bit destination (0..15)
InBitNo specifies the input bit to toggle. (0..15)
First , 1 = first call, 0 = supervision call
EventText , Text for event log
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
TimeOutSecs, No of seconds to wait for 1 to be set before give up
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)
The fls_m_bitpulse uses this function and looks as follows:

Reference Manual ECS OpStation Editor

ECS OpStation Editor 51

mtran0
vis 1
detect 1
fls_m_bitpulse: model
. dynprop \
(# \
(call gms_push_btn_select()) \
(call iosbitpulse(__VALUE, __self, PointNo, OutBitNo,
InBitNo, 1, EventText1, Confirm))) \
(* \
(call iosbitpulse(__VALUE, __self, PointNo, OutBitNo,
InBitNo, 0, EventText0, 0)))
. batcherase 1
. refpoint 0 0
frame: group
. dynprop
\
(extent_width \
(= *
\
(call gms_rect_size(extent_width, extent_height, 2, 0.0))))
fcolor 13
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 14
estyle 0
ewidth 0
tcolor 7
height 1.5
path 1
font 1
prec 1
align 2 3
size 0 0
plate: ftrect 10 4 0 0 "BitPulse"
. dynprop \
(button_label \
(= * \
(stext button_label "%s"))) \
(font \
(= * \
(tfont font)))
fcolor 12
ecolor 15
estyle 1
lower: line 0 0 10 0 10 4
fcolor 15
ecolor 12
upper: line 0 0 0 4 10 4
endg
vis 0
fcolor 13
fstyle 8
finter 3
ecolor 13
estyle 0
shield: frect 1 1 0 0
endm

Iosbitsetcond Function
iosbitsetcond (PointNo, OutBitNo, OutBitVal, InBitNo, InBitVal,
EventText, Confirm)
iosbitsetcondv7 (PointNo, OutBitNo, OutBitVal, InBitNo, InBitVal,
EventText, Confirm, Ignore)
Send a bit action to OutBitNo if value of current InBitNo is InBitVal.
PointNo is point number for point to which action applies
OutBitNo specifies the output bit destination (0..15)
OutBitVal output value (0 or 1)
InBitNo specifies the input bit to toggle. (0..15)

52 ECS OpStation Editor

Reference Manual ECS OpStation Editor

InBitVal conditional input value (0 or 1)


EventText , Text for event log
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Iospbsetpoint Function
iospbsetpoint(PointNo, Value)
iospbsetpointv7(PointNo, Value, Ignore)
This function requests the value of PointNo to be changed to value.
PointNo is point number for point to which action applies
Value new value of the point.
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Plcbitset Function
plcbitset( PointNo, ParameterKey, BitVal, Confirm)
plcbitsetv7( PointNo, ParameterKey, BitVal, Confirm, Ignore)
This function sends a request to set the bit corresponding to the parameter key of
the block algorithm for the point.
PointNo is point number for point to which action applies
ParameterKey is the block table entry key.
Bitval the value of the bit to set.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Plcbitsetcond Function
plcbitsetcond(PointNo, ParameterKey, OutBitVal, InBitVal, Confirm)
plcbitsetcondv7(PointNo, ParameterKey, OutBitVal, InBitVal, Confirm,
Ignore)
Sends OutBitVal to PLC parameter if read bit value = InBitVal.
PointNo is point number for point to which action applies
ParameterKey is the block table entry key.
OutBitVal output value (0 or 1)
InBitVal conditional input value (0 or 1)
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Reference Manual ECS OpStation Editor

ECS OpStation Editor 53

Plcbittoggle Function
plcbittoggle(PointNo, ParameterKey, Confirm)
plcbittogglev7(PointNo, ParameterKey, Confirm, Ignore)
This function sends a request to toggle the bit corresponding to the parameter
key of the block algorithm for the point.
PointNo is point number for point to which action applies
ParameterKey is the block table entry key.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Plcedit Function
plcedit( ValueId, Object, PointNo, ParameterKey )
This function allows for entering and sending an output PLC parameter to IO
system. The function must be part of input dynamics of an object. This object
must have two text rectangles of same size on top of each other. First must be
called valuefield and displays the current value. The second must be called
editfield and is used when entering a value. A click on the main object will
make the edit field visible. The user enters a value and press of return on
keyboard will send the entered value to IO system. The valuefield then again
becomes visible.
Note. plcedit requires that the 'allow write' is set in the block algorithm for the
PLC parameter.
ValueId is as specified in the table below
PointNo is point number of the controlling point. This identifies address of the
PLC parameter block and the block algorithm that holds the description of the
parameter.
ParameterKey is the key identifying the PLC parameter (string) in the block
algorithm.
Value Id

Description

__PLCDBLPAR

Edit a Plc parameter of type double

__PLCINTPAR

Edit a Plc parameter of type integer,


unsigned or bit pattern

Example:
#
call plcedit(__PLCDBLPAR, __self, PointNo, ParKey )
Above allows edit of a floating point PLC parameter when clicking on the
object. The value of PointNo and ParKey is determined rename variables when
the object is instantiated.
Below is the full ..\gismos\plcvalent.g file for the ready-made plcvalent object.
This object uses openGMS function plcedit.
mtran0
vis 1
detect 1

54 ECS OpStation Editor

Reference Manual ECS OpStation Editor

plcvalent: model
. dynprop \
(# \
(call
plcedit(__PLCDBLPAR,
ParameterKey)))
unit: model
fcolor 22
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 7
estyle 0
ewidth 1
tcolor 7
height 1
path 1
font 1
prec 0
align 1 3
size 0 0
tconstraint 0
unittext: ftrect 3 0 0 2.5 "un"
. refpoint 0 0
vis 0
estyle 1
divide: line 0.3 1.25 2.5 1.25
. refpoint 0.119995 1.25
endm
vis 1
estyle 0
height 1.5
align 2 3
value: ftrect 0 2.5 8 0 "PlcValE"
. dynprop
\
(__PLCTXTPAR \
(= *
\

__self,

PointNo,

(stext plctext(__PLCTXTPAR, PointNo, ParameterKey) "%s")))

(AlignX \
(= *
\
(talign AlignX 3))) \
(FillColor \
(= *
\
(fcolor FillColor))) \
(Font \
(= *
\
(tfont Font))) \
(TextColor \
(= *
\
(tcolor TextColor)))
unit: inst unit 0 0
. dynprop
\
(__PLCTXTPAR \
(= *
\
(call plcunit(__self, PointNo, ParameterKey))))
(FillColor \
(= *
\
(fcolor FillColor))) \
(Font \
(= *
\
(tfont Font))) \
(TextColor \
(= *
\
(tcolor TextColor)))
. move 8 0
vis 0
edit: ftrect 0 2.5 8 0 ""
. refpoint 0 0
endm

ExtSetxxx function
extsetlong(Server, Type, Key1, Key2, lValue, Confirm)
extsetdouble(Server, Type, Key1, Key2, dValue,Confirm)

Reference Manual ECS OpStation Editor

ECS OpStation Editor 55

extsettext(Server, Type, Key1, Key2, Text,Confirm)


extsetlongv7( Server , Type, Key1, Key2, lValue, Confirm, Ignore)
extsetdoublev7( Server, Type, Key1, Key2, dValue, Confirm, Ignore)
extsettextv7( Server, Type, Key1, Key2, sText, Confirm, Ignore)
These function is used to set values in an external server.
Key1 is concatenated with Key2 to form the key parameter in the external server.
Server server name configured in OpStation Configuration.
Type value type irrelevant in this case.
Key1 first part of the parameter key.
Key2 second part of the parameter key.
lValue long value to set.
dValue double value to set.
sText text value to set.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Extedit function
extedit (Server, Type, Object, Key1, Key2)
This function is allows the user to edit an external parameter.
Server server name configured in OpStation Configuration.
Type value type __EXTLONG, __EXTDOUBLE, __EXTTEXT
Object must be __self.
Key1 first part of the parameter key.
Key2 second part of the parameter key.

ExtActivate function
extactivate( DbName, TableName, Param, MenuItem, Confirm)
extactivatev7( DbName, TableName, Param, MenuItem, Confirm, Ignore)
This function activates an external program defined in database DbName in
table TableName as entry number MenuItem with one text parameter given as
Param.
DbName name of database where to find classID of external program.
TableName name table where to find definition.
Param text parameter to pass to the external program.
MenuItem numbered ID in table.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

56 ECS OpStation Editor

Reference Manual ECS OpStation Editor

ExtMenu function
ExtMenu (Object, DbName, sTableName, Param, P1, P2, P3, P4, P5,
P6, P7, P8, P9, P10, P11, P12, P13, P14, P15 )
This function activates a menu on right click release, where the menu items can
activate an external function. The menu is defined by entries in table
TableName.
DbName name of database where to find classID of external program.
TableName name table where to find definition.
Param text default parameter to pass to the external program.
P1 P15 individual arguments for each function, if specified overrides Param.

ColModelInvoke Function
ColModelInvoke( ModelName )
This function will replace the current picture with a new one. The function is
normally used as an input function in response to a button click. React only to
left mouse button release.
ColModelInvokeV7(ModelName, Ignore)
Same as above but with Ignore = 1 react to any input.
ModelName is name (double quoted string) of new picture
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)
Example:
#
call ColModelInvoke( "raw_mill")

ColNewWindowInvoke Function
ColNewWindowInvoke( ModelName )
ColNewWindowInvokeV7(ModelName, Ignore)
This functions handles invocation of a new free-floating window.
ModelName is name (double quoted string) of new picture
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

ColGenPopUpInvoke Function
ColGenPopUpInvoke( ModelName, PointNo )
This function pops up a new window with a given picture. It may also popup a
faceplate for a given point. The function is normally used as an input function in
response to a button click. React only to left mouse button release.
ColGenPopUpInvokeV7( ModelName, PointNo , Ignore)
Same as above but with Ignore = 1 react to any input.
ModelName is name (double quoted string) of picture or faceplate to pop up.
PointNo is point number of activation point in sake of a faceplate. Must be = 0
for an ordinary popup picture.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 57

Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)
Example:
#
call ColGenPopUpInvoke( "raw_mill_popup", 0)

Facepopupio(FacePlateNameSuffix, lPointNo )
facepopupio( FacePlateNameSuffix, PointNo )
facepopupiov7(FacePlateNameSuffix, PointNo, Ignore )
This function popup a faceplate prefixed with the IO system prefix.
FacePlateNameSuffix is name to append to the prefix of the IOsys (double
quoted string) of picture or faceplate to pop up.
PointNo is point number of activation point in sake of a faceplate. Must be = 0
for an ordinary popup picture.
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

StartProcess function.
startprocess( Program, P1, P2, P3, P4, P5, Confirm)
startprocessv7( Program, P1, P2, P3, P4, P5, Confirm, Ignore)
This program starts a program.
Program full program path and name of program.
P1..P5 text parameters to pass to the program.
Confirm specifies whether operator must confirm action in a confirmation box
(0 - no confirm, 1 - confirm)
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

ShowTrend function.
showtrend (TrendPackNo)
showtrendv7 (TrendPackNo, Ignore)
Shows a trend package.
TrendPackNo number of trend package to show.
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Showbrowser function.
showbrowser( Function, Code, View, Ignore )
showbrowserbyno( Function, No, View, Ignore )
This function shows the SdrBrowserUI either starting out with a department,
point, group, or route, and one of the three possible views.
Function telling what kind of Code or number is passed. __ShowDepartment,
__ShowPoint, __ShowRoute or __ShowGroup.
Code the code of the point, department, group, or route.
No the number of the point, department, group, or route.

58 ECS OpStation Editor

Reference Manual ECS OpStation Editor

View "EVENTLIST" , "POINTLIST" or "POINTGRID"


Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)

Colv7executecommand function
colv7executecommand(CommandID, Ignore)
This functions emulates a toolbar button press.
CommandID See the table
Ignore specifies that the input action filter is off. The function always is always
executed when called. (0 only on left mouse button, 1 always)
CommandID

Action

__ID_FILE_TOPMODEL

Open Top model

__ID_FILE_OPEN

Open Graphic

__ID_FILE_PRINT_CLIENT

Print Graphic

__ID_CONTROL_SELECT

Send select command to PLC for selected


group or device. The devices selected in
this manner are affected by a subsequent
start or stop command.

__ID_CONTROL_START

Send start command for all selected


groups and devices

__ID_CONTROL_STOP

Send stop command for all selected


groups and devices

__ID_CONTROL_QUICKSTOP

Send quick stop command for the current


department. All equipment will be stopped
immediately

__ID_CONTROL_MASTERSTOP

Send master stop command for the current


department. All equipment will be stopped
in a manner described by the PLC
program

__ID_ALARM_SILENCE

Turn off the audible alarm for the current


department

__ID_ALARM_RESET

Reset all alarms for the current department

__ID_ALARM_DEPLIST

Open the alarm list for the current


department

__ID_ALARM_POINTLIST

Open the alarm list for the selected point

__ID_ALARM_GROUP_POINTSTATUS

Open the alarm status list for the selected


points owner group.

__ID_TREND_PACKAGE

Open the SDR Trend display

__ID_TREND_POINT

Open the SDR Trend display with the


selected point assigned to the trend group

__ID_POINT_LIST

Open the SDR Point List

__ID_POINT_LIST_ADD_FAVOURITE

Add the selected point to the favorite


points

__ID_POINT_PARAMETERS

Open the SDR Point Parameter display for


the selected point

__ID_POINT_CONFIG

Open the SDR Point Configuration


display for the selected point

__ID_NOTEPAD

Open the ECS Note Pad and display notes


for the selected point

__ID_HELP

Open the online help file

Reference Manual ECS OpStation Editor

ECS OpStation Editor 59

Making Dynamics in Editor


It is possible to program picture objects in order to obtain the desired dynamic
visualization. After selecting an object in the editor, dynamic properties can be
added in two ways:
1. Object dynamics properties
Selecting pull down menu Dynamics -> Object dynamics properties or right
clicking and selecting Edit Dynamics in the popup menu will bring up a box
where there are buttons to guide you through the process of defining dynamics.
In the Edit Raw tab is possible to enter or correct dynamics directly.

To be guided through, use the tabs to enter the different types of dynamics. The
box is used to enter dynamic properties of the three types Unconditional,
Conditional and Upon input, the window outlook depends on the dynamic type
selected.
Unconditional action.

60 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Figure 52 - Enter dynamics box for unconditional action

Enter information as follows:

Select dynamic type as Unconditional action

For each new action press

Action. Select the dynamic action from the drop down list

Argument. Click the empty argument field (text edit field). Fill in
the argument by typing or better use Special Get button for
entering an point related OpenGMS function, a PLC related
OpenGMS function or a GMS color index. For an action with two
arguments (like stext) make sure to enter both arguments ( for stext
type in format as second argument).

Press OK to evaluate and accept the entered dynamic properties.

To delete a dynamic action press


To navigate among multiple actions use buttons

and

Pressing Get Point related will bring up the following box:

Reference Manual ECS OpStation Editor

ECS OpStation Editor 61

Figure 53 - Get point related function box

Fill in as follows:

Controlling point. If this shall be a variable to be renamed upon


instantiation then check Use as variable and type the name of the
variable in the text edit field. If controlling point shall be an actual
point, then uncheck Use as variable, click the text edit field and
use the tool bar buttons

to enter a point code.

Reference point. If the point shall be one of the 10 reference


points of the controlling point, select one from the drop down list.

Value type Select one of the types (resulting in one of the four
functions pntfloat, pntint, pnttext, pntbit).

Value Select the attribute (Value id) from the drop down list. The
list of available attributes depends on the Value type.

Press OK to enter the information in the argument text field of the


Edit Dynamics box. The example shown will generate the
argument text "pntfloat(__ALARMHIGH, PointNo)"

Conditional action

62 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Figure 54 - Enter dynamics box for conditional action

Enter information as follows:

Select Dynamic type as Conditional action

For each new Variable expression press outermost

Variable expression. Click text field and fill in by typing or use


Special Get

For each new Condition press middle

Condition. Select condition from drop down list

Condition expression. Click text field and fill in by typing or use


Special Get

For each new Action press innermost

Action. Select action from drop down list

Action expression. Click text field and fill in by typing or use


Special Get

Press OK to evaluate and accept the entered information.

To delete an item press corresponding


To navigate among multiple items use buttons

Reference Manual ECS OpStation Editor

and

ECS OpStation Editor 63

Upon input

Figure 55 - Enter dynamics box for input action

Enter information as follows:

Select Dynamic type as Upon input

For each new input action press

Input action. Click the text field and type in a function call. See
the section on OpenGMS functions for available input function
calls.

Press OK to evaluate and accept the entered information.

To delete an item press corresponding


To navigate among multiple items use buttons

and

PntFloat Example
In this example we will create a new dynamic sub model (gismo), which can
display the value of any of the floating-point attributes of a point.

64 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Figure 56 - Gismo PntFloat

The following variables shall be determined by Rename variables when the sub
model is instantiated in a picture:
AlignX Horizontal alignment of value in the box. 1 = left, 2 = mid, 3 = right
EdgeColor Edge color of the box
FillColor Fill color of the box
TextColor Text color
Font Text font
PointNo Point number of the controlling point.
ValueId Floating point attribute of point to display (e.g. __ALARMHIGH)

Creating pntfloat
The sub model is created as follows:
In the editor select menu File -> new
Model properties. The default model properties are with dark blue background
enabled and model size 100 * 75. As we want our model to be a text rectangle of
size 10 * 2.5 we must change the model properties as follows:

Select menu Model -> Properties ..

In the model properties box displayed uncheck Background on (to


have the background removed) and press Apply and Close.

If the blue background does not disappear (GMS error), click in the
background and press delete on keyboard. Now you should have a
white working area.

Create statics. We now create the static part of the sub model as follows:

Click the toolbar button for text rectangle

Select menu Point -> Enter Point ..

In the Enter Point box displayed type 0 0 and press Apply. Then
type 10 2.5 and press Apply again and the Close. You should now
have a text rectangle in the lower left part of the working area.

Type the text "PntFloat" in the text rectangle, then right click and
select Done from popup menu. The object should now be selected
indicated by a frame.

Right click and select Graphic Properties from the popup menu.

In the graphics properties box select the fill color 22 and close the
box.

Create dynamics. We now add dynamic properties to the object as follows:

Select menu Dynamics -> Enter Dynamics

Using the Enter Dynamics box create the following Conditional


actions (and close the box by OK):

ValueID
=*

Reference Manual ECS OpStation Editor

ECS OpStation Editor 65

stext pntfloat(ValueId, PointNo) "%s5.2f"


EdgeColor
=*
ecolor EdgeColor
FillColor
=*
fcolor FillColor
TextColor
=*
tcolor TextColor
Font
=*
tfont Font
AlignX
=*
talign AlignX 3
Save model. We now save the model as a gismo as follows:

Select menu File -> Save

In the file save box displayed select directory FlsaGmsPic\Gismos


Then enter file name pntfloat and press Save. The sub model
should now automatically be saved as two files pntfloat.g (source
file) and pntfloat.m1(runtime file).

The source file generated now looks as follows:


mtran0
vis 1
detect 1
pntfloat: model
fcolor 22
fstyle 1
finter 1
fdir 0
fpercent 100
ecolor 7
estyle 1
ewidth 1
tcolor 7
height 2
path 1
font 1
prec 0
align 2 3
size 0 0
ftrect 0 0 10 2.5 "PntFloat"
. dynprop \
(ValueId \
(= * \
(stext pntfloat(ValueId, PointNo) "%5.2f")))
(AlignX \
(= * \
(talign AlignX 3))) \
(FillColor \
(= * \
(fcolor FillColor))) \
(EdgeColor \
(= * \
(ecolor EdgeColor))) \
(TextColor \
(= * \
(tcolor TextColor))) \
(Font \
(= * \
(tfont Font)))

66 ECS OpStation Editor

Reference Manual ECS OpStation Editor

endm

Using pntfloat
We may now use the new sub model in a picture to display the low and high
alarm limits for the point j4p12.
In the editor create a new picture or load an existing one.
Instantiate sub model:
Select menu Palette -> Submodels ..
In the Sub model List box displayed locate and click on pntfloat, then click on
first position in picture where pntfloat shall be displayed, then on second
position, then right click and select Done from popup menu.
Close the sub model list by OK. You should now have two instances of pntfloat.
Rename Variables:
Left click the first instance to select it, then right click and select Rename
Variables from the popup menu. fill in the variables as follows (and close the
box by OK):
AlignX 3
EdgeColor 7
FillColor 22
Font 1
PointNo pointno("j4p12")
TextColor 7
ValueId __ALARMLOW
Left click the second instance to select it, then right click and select Rename
Variables from the popup menu. fill in the variables as follows (and close the
box by OK):
AlignX 3
EdgeColor 7
FillColor 22
Font 1
PointNo pointno("j4p12")
TextColor 7
ValueId __ALARMHIGH
Save the picture.
The picture will now display the low alarm limit for the point j4p12 in the first
object and the high alarm limit in the second object. The values will be right
aligned black text in Arial normal font, the text rectangle will have a black edge
and a gray fill color. The values will be displayed in floating point format
xxxxx.yy.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 67

Faceplates
Faceplates are sub models where all the dynamics are related to an activation
point. In OpStation a faceplates is activated by right click on a point and then
selecting Faceplate from the popup menu. A window with the faceplate will
then pop up. The dynamics on the faceplate will relate to the point you clicked
upon. An example of a faceplate is the PIDFace, which is discussed in the
section "PIDFace example".

Creating Faceplates
When creating new faceplates the following guidelines should be observed.:
Location of faceplates files.
Faceplates must reside in directory
FlsaGmsPic\Faceplates So when saving a faceplate in the editor make sure to
select this directory.
Model properties of faceplates. Faceplates do not have the standard model size
and background color. So when starting a new faceplate select menu Model ->
Properties .. and change background color and rectangle size in the model
properties box. If the size of the work area does not change after this, save the
model and reload it again (GMS peculiarity).
Dynamics. Preferably use OpenGms dynamics (palettes opengms_dynamics_1
and opengms_dynamics_2). This will allow you also to instantiate a faceplate
directly in a standard mimic picture. For such an imbedded faceplate you use
Rename variables to assign a point number for the variable $. You may use
classic dynamics in a faceplate, but in that case you will not be able instantiate
the faceplate directly in a mimic, but only use it as a popup faceplate.
PointNo use $. When binding variables by rename variables The point number
variable should be set to $ as a placeholder for the activation point. The correct
point number will then be substituted upon activation of the faceplate. If you use
classic dynamics, the object owner should also be set to $ for the same reason.

Assigning Faceplates
Once a faceplate has been created you must determine to which class of
activation points the faceplate shall be assigned. There are two ways of doing
this.
Assign faceplate to point algorithm. This is done using the ECS OpStation
Configuration utility. Here you assign the name of the faceplate to one or more
A- or B-point algorithms. All points having one of these algorithms will then by
default use the assigned faceplate.
Assign faceplate to picture object owner. When you assign an owner to a
classic dynamic object in a mimic picture you may in the same box assign a
faceplates (select one from dropdown list). If you do so the assigned faceplate
will apply to that specific object in the picture. This kind of assignment will
overrule the assignment by point algorithm.

PIDFace Example
In the following we will illustrate how the PIDFace is constructed. The figures
below show the PIDFace as it looks in the editor and as it looks at runtime in
OpStation. The PIDFace is exclusively made of OpenGMS dynamics. We go
through the dynamics an explain the Rename variables setting for Point
Numbers.

68 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Figure 57 - PIDFace left in editor and right in application

The activation points for the PIDFace are points with a set point algorithm. The
PIDFace not only shows information directly for the set point, but also for points
related to the set point (reference points). Therefore it is required that the set
points have the following reference points attributes defined (see Point
Configuration):
Reference point 1: Process point

Reference Manual ECS OpStation Editor

ECS OpStation Editor 69

Reference point 2: Output point


Reference point 4: Control mode point
Reference point 7: Auxiliary point (optional)
Point number setting for the instantiated objects are as follows:
PntText is the point text for the set point. PointNo = $
First PntCode is point
pntint(__REF_PNT1, $)

code

for

the

proc.

point.

PointNo

Second PntCode is point code for the set point. PointNo = $


Third PntCode is point
pntint(__REF_PNT2, $)

code

Fourth PntCode is point


pntint(__REF_PNT7, $)
Fifth PntCode is point
pntint(__REF_PNT4, $)
First PntVal is point
pntint(__REF_PNT1, $)

for

code

for

the
the

outp.

point.

PointNo

aux

point.

PointNo

code

for

the

mode

point.

PointNo

value

for

the

proc.

point.

PointNo

First PntValEnt is point value entry for the set point. PointNo = $
Second PntValEnt is point value entry for the outp. point. PointNo =
pntint(__REF_PNT2, $)
Second PntVal is point
pntint(__REF_PNT7, $)
Third PntVal is point
pntint(__REF_PNT4, $)

value
value

for
for

the
the

aux.

point.

PointNo

mode

point.

PointNo

LangText (LT) are text constants in current language. For the manual mode
button TextKey = "lngManual". Similarly for the other instances.
PntThermoVer is thermo value for the process point.
pntint(__REF_PNT1, $)

PointNo =

First PntSlider is Thermo val entry for the set point. PointNo = $
Second PntSlider is Thermo val entry for the outp. point. PointNo =
pntint(__REF_PNT2, $)
fls_m_mode_diamon. is mode switch button for the mode point. PointNo =
pntint(__REF_PNT4, $). BitVal = 1. The BitNo variable is in range 0..4 the
down most button having BitNo = 0 and the topmost BitNo = 4.
fls_m_percent_up,
fls_m_percent_up_small,
fls_percent_down,
fls_percent_down_small are percent change buttons. They apply to the output
point if the mode is manual otherwise to the set point. PointNo = $.
ManModeMaskBits = 1, ManModeValueBits = 1 (bit 0 is 1 for manual
mode).
Left fls_m_facepopup button shall popup up plcparameterface for set point.
PointNo = $. FaceplateName = "plcparamface".
Right fls_m_facepopup button shall popup up pidtrend for set point. PointNo =
$. FaceplateName = "pidtrend".

70 ECS OpStation Editor

Reference Manual ECS OpStation Editor

Bitmaps
Bitmaps may be inserted in a picture as static objects. The bitmaps are full
scalable.
To insert a bitmap in a picture do as follows:

Make sure the bitmap exists as a file <filename>.bmp ( or


<filename>.i) on directory FlsaGmsPic\Bitmaps

Open the picture into which you want to insert a bitmap.

Select menu File -> Import -> Bitmap

From the bitmap name list select your bitmap file and click at
position in picture where the bitmap shall be placed followed by
right click and Done

Note that the bitmap file must reside on the Server. If OpStation is started on a
Client all mimic pictures and bitmaps will be copied from the Server to the
Client (if not already there). However, this implies that if you create a new
bitmap you must restart OpStation to view it on a Client, or you must copy the
bitmap file by hand to the Client.

Converting Pictures From VMS


Old pictures made for a VMS system may be transferred to an NT system. As
the internal format for classic dynamics has changed it is necessary to convert
the VMS pictures before they can be used on NT.
The utility GMS Convert does this. The utility can also be used for other picture
file manipulation such as converting .g files to .m1 and vice versa.
See the description of GMS Conversion utility for further details.

Reference Manual ECS OpStation Editor

ECS OpStation Editor 71

Glossary of Terms

MSW
Machine Status Word. Contains the actual bit values for a B-point

gismo
Graphical Interactive State Management Object. Any object with dynamics
behavior

Faceplate
Popup window with dynamics related to activation point (point clicked upon)

SL
Sherrill Lubinski Corporation. Supplier of the GMS product

GMS
Graphical Modeling System by SL

Reference Manual ECS OpStation Editor

Glossary of Terms 73

Index

S
symbol offset 7, 36

Reference Manual ECS OpStation Editor

Index 75

Reference Manual

Allen-Bradley
Configuration

FLS Automation A/S


Hffdingsvej 77
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 4
$Modtime:: 1/21/02 2:24p
Niels G. Bruun
$Author:: Taa
$Workfile:: AllenBradleyCfgUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
Allen-Bradley Configuration ..................................................................... 1
Introduction ................................................................................................................................... 1
Network Protocol Installation ............................................................................................... 1
System Configuration ............................................................................................................ 1
Address Configuration........................................................................................................... 1
Network Protocol Installation....................................................................................................... 2
RSLinx Installation................................................................................................................ 2
Driver Configuration ............................................................................................................. 2
Backup of Driver Configuration ........................................................................................... 4
System Configuration ................................................................................................................... 5
General Configuration ........................................................................................................... 5
PLC Configuration ................................................................................................................ 6
Department Configuration................................................................................................... 12
Address Configuration ................................................................................................................ 13
AB PLC-5 Address Configuration ...................................................................................... 14
AB PLC-2 Address Configuration ...................................................................................... 16
AB PLC-3 Address Configuration ...................................................................................... 18
AB SLC-500 Address Configuration .................................................................................. 20
AB PLC-5 addresses and Pmove profile............................................................................. 22
AB PLC-2 addresses and Pmove profile............................................................................. 25
AB PLC-3 addresses and Pmove profile............................................................................. 27
AB SLC-500 addresses and Pmove profile......................................................................... 29

Glossary of Terms ................................................................................... 33


Index.......................................................................................................... 35

Reference Manual Allen-Bradley Configuration

Contents i

Allen-Bradley Configuration

Introduction
This manual describes the procedures used to configure the Allen-Bradley I/O
System. The major configuration steps include:

Network Protocol Installation


Network protocol defines the structure of the software used to communicate
between the PLCs and the Servers (MOPs). This step installs the network
protocol on the Server workstation to match the protocol used in the network
PLCs.

System Configuration
The Allen-Bradley I/O System driver supplied by FLSA must be configured
before it can be used to interface with the AB PLCs. This procedure describes
I/O polling parameters, the parameters associated with individual PLCs, the
details related to PLCdepartments, and the PLC memory locations used to
process start, stop, and alarm resetcommands.

Address Configuration
When ECS database points are created, the interface driver associated with the
point must be specified. This section describes the procedure used to associate a
database point with the Allen-Bradley I/O System.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 1

Network Protocol Installation


It is recommended to have
RSLinx installed before the
SDR installation. If you are
installing RSLinx after the
SDR
installation,
the
workstation must be in
maintenance mode before the
installation.

The network protocol required by the Allen-Bradley I/O system is installed


using Rockwell Software's RSLinx. For each ECS server communicating with
Allen Bradley PLCs the following product must be purchased from Rockwell:
9355 WABOEMENE RSLinx OEM
Before starting the installation, locate the following items:

Installation CDs included with the software distribution

Installation disks included in the RSLinx software distribution

Master Disk included in the RSLinx software distribution

Windows 2000 Installation CD

Windows 2000 Service Pack CD

RSLinx Installation
Insert the Rockwell Software RSLinx Disk 1.
a:\setup.exe.

From Start Menu, Run

Follow the installation program instructions, and install RSLinx with the default
settings.
In the Registration Information window, enter your name, your company, and
the serial number found on the label of the Master Disk.
When the installation is complete, restart the workstation.

Driver Configuration
The specific configuration of RSLinx drivers depends on the type of PLC and
the type of communication link to the PLC. The example below shows how to
configure Ethernet communication to a PLC-5.
Once the workstation is ready, start the RSLinx program by selecting Rockwell
Software RSLinx in the desktop Start menu.
Select the Communications menu and then select Configure Drivers.

In the Available Drivers drop-down list, choose Ethernet Ethernet to PLC5 or 5820-El and click Add New

2 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

The Configure Ethernet-to-AB Communication window appears, Press Add


New and type the PLC station, and enter the PLC IP Address or hostname.
Note that the Station entry (shown in decimal notation) must match the PLC
DH+ address.

Click Apply to accept the mapping. Perform this step for all Allen-Bradley
PLCs. When finished, click OK.
From the Configure Drivers window, click on the Close command. The
network protocol is now installed.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 3

Backup of Driver Configuration


The example below shows how to backup the driver configuration.
Click on the desktop Start command and select Programs Rockwell
Software RSLinx Backup & Restore Utility. Click on the Backup
command when the screen appears.

Save the *.RSX in the FLSADev\ProDb directory.

4 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

System Configuration
The Allen-Bradley I/O system driver supplied by FLSA is configured by
selecting Allen-Bradley Config in the desktop Start menu

General Configuration
The General Config form is used to define the details related to network
communication between the SDR system and the Allen Bradley PLCs.
Default Poll Period The defult update period for points associated with the
Allen Bradley PLCs. Valid entry range: 200 to 60000 milliseconds.
Default timeout The default amount of time the ECS system will wait for a
reply from a PLC. Valid entry range: 100 to 60000 milli seconds.
Scan between check spare links
Specifies how often redundant
communication links will be checked for availability. Specified in units of PLC
update periods. Valid entry range: 1 to 100.
Max Data Definitions per PLC Specifies the maximum number of data
definitions per PLC. A PLC requires up to 8 data definitions, a data definition
per file polled, and a data definition per pending write. Valid entry range: 10 to
1000.
Max time no update The amount of time the ECS system will wait before a
point that doesnt receive any updates is marked as Not Updated. Valid entry
range: 1 to 60 seconds.
Min. time between link switch This parameter specifies how many seconds
must pass after a network switch before another switch can be initiated. Valid
entry range: 1 to 60 seconds.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 5

Cache write definitions timeout The time write definitions are kept for
possible reuse in a new write operation to the same destination. Valid entry
range: 1 to 60 seconds.
Set time in PLCs If enabled, the ECS system will set the time in connected
PLC5s. In a dual system the time can be set from Server1 (MOP1), from Server2
(MOP2) or from both servers.
Map bit parameters from F-file If checked reading and writing of external bit
parameters (for faceplate display) from F-files in PLC-5's will be redirected to
N-files.
Mapping of bit parameters from F-file to N-file This is used to configure the
redirection of bit parameters.
F-file The F-file specified in the point 's parameter address.
Block Size The size of the parameter block in the F-file (in elements).
Offset The offset to the first parameter block in the F-file (in elements).
N-file The N-file where bit parameters are redirected to.
Block Size The size of the parameter block in the N-file (in elements).
Offset The offset to the first parameter block in the N-file (in elements).

PLC Configuration
The PLC Config form is used to assign or review configuration parameters
associated with individual PLCs. The choice menu labelled PLC is used to select
the PLC to configure or review. The PLCs are numbered from 1. A name
appears with the PLC number if a name has been assigned. The field to the right
of the PLC choice indicates the current communication status with the selected
PLC (Passive, Polling OK, or No Communication).

6 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

General Parameters
The General form is used to assign general configuration parameters to the
selected PLC. The selected PLC appears in the Name field.
Name Enter the display name for the PLC.
Active Must be checked in order to enable communication with the selected
PLC
ControlLogix PLC Must be checked in order to communicate with a
ControlLogix PLC. Communication only work in PLC5 emulation mode.
PLC Type The type of PLC. Possible choices are: PLC-5, PLC-2, PLC-3, SLC500, PI-RM, PLC-5/250.
Polling Period The update interval to be used for the PLC. All points from the
PLC will be updated at the frequency determined by this time interval. Valid
entry range: 200 to 60000 milli seconds.
Timeout The amount of time the ECS system will wait for a reply from the
PLC. Valid entry range: 100 to 60000 milli seconds.
Department The department name associated with the PLC. Communication
alarms for the PLC will be logged in the selected department.
Redundant Link Enable if the PLC has a redundant communication link
PI Module Number The module number of a PI-RM or PLC-5/250 in a
Pyramid Integrator. Entries: 0 for PI-RM, 1 to 4 for PLC-5/250, not applicable
for other PLC types.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 7

Use protected write When enabled, writes to PLC-2s that requires access to
rungs in the PLC are sent as protected writes . Only applicable to PLC-2s.
Redundant PLC Enabled for redundant PLC-5s. Only applicable to PLC-5s.
BCM Address The address of the BCM status block in redundant PLC-5s.
Enter file number (N-file) and start word. Only applicable to redundant PLC-5s.
Watchdog period Determines how often the ECS system will write a watchdog
bit to the PLC to indicate that the ECS system is operational. Valid entry range:
5 to 3600 seconds. If set to 0 the watchdog function is disabled.
Watchdog address 1 The address of the bit that will be set by the watchdog
function. Specified as type, file number, word, and bit. (File number is not used
for PLC-2). Applicable to standalone Servers (MOPs) and Server1 (MOP1) in
dual Server configurations.
Watchdog address 2 The address of the bit that will be set by the watchdog
function. Specified as type, file number, word, and bit. (File number is not used
for PLC-2) Applicable to Server2 (MOP2) in dual Server configurations.
PLC status point The ECS database point that will be updated with status on
the active link for this PLC. The point must be a B-point with the same IO-type
as the PLC (e.g. AB-PLC5), but with no IO addresses assigned. The conversion
algorithm for the point has to be "Interface Status".
If the status of Link A is Passive and the status of Link B is Polling OK, then the
value of the PLC status point will be Polling OK, if Link B is selected active.
Secondary PLC status point As above, but only applicable for redundant PLC5s.
New Button Add a PLC by pressing this button. Then select the number in the
PLC drop-down and write a PLC name. Press Apply to insert the PLC in the list.
Please note that inserted PLC's cannot be deleted.

8 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

Link Configuration
The Links form is used to configure the details related to the PLC
communication links. Up to four communication links must be configured
depending on the assignments made in the General form, The communication
links are labelled Link A, Link B and if redundant PLC5s are used, Sec. PLC Link
A and Sec. PLC Link B.

Link x Driver ID Select the RSLinx Driver Identifier from the drop down list.
Link x Port ID A string that gives further details about the communication path
to the PLC. For PLCs connected directly to the selected driver enter
AB:LOCAL
The general format of the port id string is:
AB:keyword/B:b/L:l/G:g/P:p/M:m/C:c/E:e/KA
Where:
keyword =

LOCAL, OFFLINK,PIGATEWAY,or DF1MASTER.

Bridge address, 1 to 376 octal.

Destination link id, 0 to 177777 octal.

Gateway to final DH-485 link, 1 to 376 octal.

Thumbwheel number, 0 to 8 decimal.

Module type, KA, KT, RM.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 9

Channel number, 0, 2, 3

Ethernet interface station number, 0 to 77 octal.

KA
DH

Used when communicating through a 1785-KA from DH+ to

Example:
For a PLC connected to channel 3 on an RM in a Pyramid Integrator mapped to
station 1 in the Ethernet driver use:
AB:PIGATEWAY/P:0/M:RM/C:3/E:1
Link x Station Number The PLC station number in octal or decimal notation.
Link x Status Point
Apply a point code of a B-point with the same IO-type as the PLC (e.g. ABPLC5), but with no IO addresses assigned. The conversion algorithm for the
point has to be "Interface Status".
The value of this point will then be the status of link x, regardless of the link
selected as active.

Network Status
The Status form provides ECS/PLC communication status for each PLC.

PLC Mode Shows the PLC operating mode.

10 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

PLC Status Word Shows the PLC status word if applicable.


BCM Status Word Shows the BCM status word if applicable.
Link x Shows the currently activecommunication link and the state of all
communication links.
Mean Poll time The average time for polling all connected points.
Current Poll time The time for polling all connected points (last measuring).
Max. Poll time The maximum time it has taken for polling all connected points.
Min. Poll time The minimum time it has taken for polling all connected points.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 11

Department Configuration
The Department Config form is used to associate a department with a PLC and
identify the PLC memory locations that will receive the start, stop, and alarm
commands issued from the SDR/ECS system. The department to be reviewed or
configured is selected from the Department choice menu.

Active Enables or disables the selected department.


Address set Selects one of the four address sets that can be configured for the
department.
PLC Select the PLC where the commands for this department are to be sent.
Command Each command in the left column must be assigned to the
appropriate File, Element, and Bit within the PLC. The Type selection defines
the type of data stored at the PLC location. (For PLC2s, File is not used and
Element is labelled as Word).

12 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

Address Configuration
I/O locations in the Allen Bradley I/O system are connected to the SDR/ECS
system by creating database points. To interface with the I/O system, create a
point using the Point Configuration utility. Assign the point configuration
parameters including the interface type and the PLC address location as
described below..

Interface Type Select 2 - AB-PLC5 or 9 - AB-PLC2 or 10 - AB-PLC3 or 11 AB-SLC5 from the choice menu
Interface Command Click on the Interface command button to associate the
point with an address location in the PLC. Refer to AB PLC-x Address
Configuration.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 13

AB PLC-5 Address Configuration


The AB Address Configuration window is used to assign the current ECS
database point to a location within the Allen Bradley PLC. The point is used to
read a location within the PLC or write to a location within the PLC.
After assigning an interface type of 2 - AB-PLC5 to the point in the Point
Configuration utility and pressing the Interface command button, enter the
following information in the AB Address Configuration window.

Pointcode Identifies the ECS database point being configured.


PLC Select the PLC where the memory location resides.
Input If this is a point location that is read by the ECS system, enter the data
location Type, File, Element, and Bit in the Input frame.
Output If this is a point location that is written to by the ECS system, enter the
data location Type, File, Element, and Bit in the Output frame.
Parameter If this point has a parameter block in the PLC that can be read on
request enter the block start address as Type, File, and Element.

Possible input types for analog points are:


None Not used.
N - 12 bit Input from 12 bit A/D converter from N-file.
N - 16 bit Signed Integer, one element from N-file.
N - 32 bit Signed Integer, two elements from N-file.
L - 32 bit Signed Integer, one elements in L-file. (PI-RM or PLC5/250).
F - Float Floating point value from F-file.
N - 12 bit/status/time Input from 12 bit A/D converter , status word, time
stamp in three elements from N-file.
N - Float/status/time Floating point value, status word, time stamp in four
elements from N-file.
F - Float/status/time Floating point value, status word, time stamp in two
elements from F-file.

14 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

Possible output types for analog points are:


None Not used.
N - 12 bit Output to 12 bit D/A converter in N-file.
N - 16 bit Signed Integer, one element in N-file.
N - 32 bit Signed Integer, two elements in N-file.
L - 32 bit Signed Integer, one elements in L-file. (PI-RM or PLC5/250).
F - Float Floating point value in F-file.

Possible input types for digital points are:


None Not used.
B - 16 bit Machine Status Word (1 to 16 bits) from B-file.
N - 16 bit Machine Status Word (1 to 16 bits) from N-file.
B - 32 bit Machine Status Word (1 to 32 bits) from B-file.
N - 32 bit Machine Status Word (1 to 32 bits) from N-file.
L - 32 bit Machine Status Word (1 to 32 bits) from L-file. (PI-RM or
PLC5/250).
N - 16 bit/Time Machine Status Word , time stamp in two elements of N-file.
N - 32 bit/Time Machine Status Word, time stamp in three elements of N-file.

Possible output types for digital points are:


None Not used.
B - 16 bit Set up to 16 bits in B-file.
N - 16 bit Set up to 16 bits in N-file.
B - 32 bit Set up to 32 bits in B-file.
N - 32 bit Set up to 32 bits in N-file.
L - 32 bit Set up to 32 bits in L-file. (PI-RM or PLC5/250).

Possible parameter types are:


None Not used.
N-file Read parameter block from N-file.
L-file Read parameter block from L-file. (PI-RM or PLC5/250).
F-file Read parameter block from F-file.
PD-file Read parameter block from PD-file.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 15

AB PLC-2 Address Configuration


The AB Address Configuration window is used to assign the current ECS
database point to a location within the Allen Bradley PLC. The point is used to
read a location within the PLC or write to a location within the PLC.
After assigning an interface type of 9 - AB-PLC2 to the point in the Point
Configuration utility and pressing the Interface command button, enter the
following information in the AB Address Configuration window.

Pointcode Identifies the ECS database point being configured.


PLC Select the PLC where the memory location resides.
Input If this is a point location that is read by the ECS system, enter the data
location Type, Word, and Bit in the Input frame.
Output If this is a point location that is written to by the ECS system, enter the
data location Type, Word, and Bit in the Output frame.
Parameter If this point has a parameter block in the PLC that can be read on
request enter the block start address as Type and Word.

Possible input types for analog points are:


None Not used.
BCD Binary Coded Decimal value.

Possible output types for analog points are:


None Not used.
BCD Binary Coded Decimal value.

Possible input types for digital points are:


None Not used.
Word Machine Status Word (1 to 16 bits.

16 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

Possible output types for digital points are:


None Not used.
Word Set up to 16 bits.

Possible parameter types are:


None Not used.
Word Read parameter block.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 17

AB PLC-3 Address Configuration


The AB Address Configuration window is used to assign the current ECS
database point to a location within the Allen Bradley PLC. The point is used to
read a location within the PLC or write to a location within the PLC.
After assigning an interface type of 10 - AB-PLC3 to the point in the Point
Configuration utility and pressing the Interface command button, enter the
following information in the AB Address Configuration window.

Pointcode Identifies the ECS database point being configured.


PLC Select the PLC where the memory location resides.
Input If this is a point location that is read by the ECS system, enter the data
location Type, File, Element, and Bit in the Input frame.
Output If this is a point location that is written to by the ECS system, enter the
data location Type, File, Element, and Bit in the Output frame.
Parameter If this point has a parameter block in the PLC that can be read on
request enter the block start address as Type, File, and Element.

Possible input types for analog points are:


None Not used.
N - 12 bit Input from 12 bit A/D converter from N-file.
N - 16 bit Signed Integer, one element from N-file.
N - 32 bit Signed Integer, two elements from N-file.
H - 32 bit Signed Integer, one elements in H-file.
F - Float Floating point value from F-file.

Possible output types for analog points are:


None Not used.
N - 12 bit Output to 12 bit D/A converter in N-file.
N - 16 bit Signed Integer, one element in N-file.
N - 32 bit Signed Integer, two elements in N-file.
H - 32 bit Signed Integer, one elements in H-file.
F - Float Floating point value in F-file.

18 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

Possible input types for digital points are:


None Not used.
B - 16 bit Machine Status Word (1 to 16 bits) from B-file.
N - 16 bit Machine Status Word (1 to 16 bits) from N-file.
B - 32 bit Machine Status Word (1 to 32 bits) from B-file.
N - 32 bit Machine Status Word (1 to 32 bits) from N-file.
H - 32 bit Machine Status Word (1 to 32 bits) from H-file.

Possible output types for digital points are:


None Not used.
B - 16 bit Set up to 16 bits in B-file.
N - 16 bit Set up to 16 bits in N-file.
B - 32 bit Set up to 32 bits in B-file.
N - 32 bit Set up to 32 bits in N-file.
H - 32 bit Set up to 32 bits in H-file.

Possible parameter types are:


None Not used.
N-file Read parameter block from N-file.
H-file Read parameter block from H-file.
F-file Read parameter block from F-file.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 19

AB SLC-500 Address Configuration


The AB Address Configuration window is used to assign the current ECS
database point to a location within the Allen Bradley PLC. The point is used to
read a location within the PLC or write to a location within the PLC.
After assigning an interface type of 11 - AB-SLC5 to the point in the Point
Configuration utility and pressing the Interface command button, enter the
following information in the AB Address Configuration window.

Pointcode Identifies the ECS database point being configured.


PLC Select the PLC where the memory location resides.
Input If this is a point location that is read by the ECS system, enter the data
location Type, File, Element, and Bit in the Input frame.
Output If this is a point location that is written to by the ECS system, enter the
data location Type, File, Element, and Bit in the Output frame.
Parameter If this point has a parameter block in the PLC that can be read on
request enter the block start address as Type, File, and Element.

Possible input types for analog points are:


None Not used.
N - 12 bit Input from 12 bit A/D converter from N-file.
N - 16 bit Signed Integer, one element from N-file.
N - 32 bit Signed Integer, two elements from N-file.
F - Float Floating point value from F-file.

Possible output types for analog points are:


None Not used.
N - 12 bit Output to 12 bit D/A converter in N-file.
N - 16 bit Signed Integer, one element in N-file.
N - 32 bit Signed Integer, two elements in N-file.
F - Float Floating point value in F-file.

20 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

Possible input types for digital points are:


None Not used.
B - 16 bit Machine Status Word (1 to 16 bits) from B-file.
N - 16 bit Machine Status Word (1 to 16 bits) from N-file.
B - 32 bit Machine Status Word (1 to 32 bits) from B-file.
N - 32 bit Machine Status Word (1 to 32 bits) from N-file.

Possible output types for digital points are:


None Not used.
B - 16 bit Set up to 16 bits in B-file.
N - 16 bit Set up to 16 bits in N-file.
B - 32 bit Set up to 32 bits in B-file.
N - 32 bit Set up to 32 bits in N-file.

Possible parameter types are:


None Not used.
N-file Read parameter block from N-file.
F-file Read parameter block from F-file.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 21

AB PLC-5 addresses and Pmove profile


The AB PLC5 and Pmove Address profile must consist of :
plc1

PLC number

plc2

Input type

plc3

Input file

plc4

Input element

plc5

Input bit

plc6

Output type

plc7

Output file

plc8

Output element

plc9

Output bit

plc10

Parameter type

plc11

Parameter file

plc12

Parameter element

Legal values for plc1 are 0 to number of defined plcs.


Legal values for plc2 are:
Analog points:
None Not used.
0
N - 12 bit Input from 12 bit A/D converter from N-file.
771
N - 16 bit Signed Integer, one word from N-file.
772
N - 32 bit Signed Integer, two word from N-file.
773
L - 32 bit Signed Integer, one elements in L-file. (PI-RM or PLC5/250). 1541
F - Float Siemens floating point value, two word from F-file.
1030
N - 12 bit/Status/Time 12 bit value , status word and time stamp.
778
N - Float/Status/Time Floating point value, status word and time stamp 779
F - Float/Status/Time Floating point value, status word and time stamp 1035

Digital points:
None Not used.
B - 16 bit Machine Status Word (1 to 16 bits) from B-file.
N - 16 bit Machine Status Word (1 to 16 bits) from N-file.
B - 32 bit Machine Status Word (1 to 32 bits) from B-file.
N - 32 bit Machine Status Word (1 to 32 bits) from N-file.
L - 32 bit Machine Status Word (1 to 32 bits) from L-file.
N - 16 bit/Time Machine Status Word and time stamp.
N - 32 bit/Time Machine Status Word and time stamp.

0
513
769
514
770
1538
776
777

Legal values for plc3 are depending of input type:


3 to 999 for N-files, B-files and F-files.
3to 9999 for L-files.

22 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

Legal values for plc4 are depending of input type:


3 to 1999 for N-files, B-files and F-files.
3 to 9999 for L-files.
Legal values for plc5 are depending of input type:
Analog points - no meening.
Digital points:
B - 16 bit Legal values 0 - 15
N - 16 bit Legal values 0 - 15
B - 32 bit Legal values 0 - 31
N - 32 bit Legal values 0 - 31
N - 16 bit/Time Legal values 0 - 15
N - 32 bit/Time Legal values 0 - 31
L - 32 bit Legal values 0 - 31
Legal values for plc6:
Analog points:
None Not used.
N - 12 bit Output to 12 bit D/A converter in N-file.
N - 16 bit Signed Integer, one word in N-file.
N - 32 bit Signed Integer, two word in N-file.
L - 32 bit Signed Integer, two word in L-file.
F - Float Siemens floating point value, two word in F-file.

0
771
772
773
1541
1030

Digital points:
None Not used.
B - 16 bit Set some or all (1 to 16 bits) in B-file.
N - 16 bit Set some or all (1 to 16 bits) in N-file.
B - 32 bit Set some or all (1 to 32 bits) in B-file.
N - 32 bit Set some or all (1 to 32 bits) in N-file.
L - 32 bit Set some or all (1 to 32 bits) in L-file.

0
513
769
514
770
1538

Legal values for plc7 are depending of output type:


3 to 999 for N-files, B-files and F-files.
3to 9999 for L-files.

Legal values for plc8:


3 to 1999 for N-files, B-files and F-files.
3 to 9999 for L-files.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 23

Legal values for plc9 are depending of output type:


Analog points - no meening.
Digital points:
B - 16 bit Legal values 0 - 15
N - 16 bit Legal values 0 - 15
B - 32 bit Legal values 0 - 31
N - 32 bit Legal values 0 - 31
L - 32 bit Legal values 0 - 31
Legal values for plc10 are:
None Not used.
N-file Read parameter block from N-file.
L-file Read parameter block from L-file. (PI-RM or PLC5/250).
F-file Read parameter block from F-file.
PD-file Read parameter block from PD-file.

0
775
1543
1031
1287

Legal values for plc11 are depending of input type:


3 to 999 for N-files, PD-files and F-files.
3to 9999 for L-files.
Legal values for plc12 are depending of input type:
3 to 1999 for N-files, PD-files and F-files.
3 to 9999 for L-files.

24 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

AB PLC-2 addresses and Pmove profile


The AB PLC2 and Pmove Address profile must consist of :
plc1

PLC number

plc2

Input type

plc3

Input word

plc4

Input bit

plc5

Output type

plc6

Output word

plc7

Output bit

plc8

Parameter type

plc9

Parameter word

Legal values for plc1 are 0 to number of defined plcs.


Legal values for plc2 are:
Analog points:
None Not used.
BCD Binary Coded Decimal value.

0
268

Digital points:
None Not used.
Word Machine Status Word (1 to 16 bits).

0
257

Legal values for plc3 are 0 to 17777


Legal values for plc4 are depending of input type:
Analog points - no meening.
Digital points - 0 to 15
Legal values for plc5:
Analog points:
None Not used.
BCD Binary Coded Decimal value.

0
268

Digital points:
None Not used.
Word Set some or all (1 to 16 bits).

0
257

Legal values for plc6 are 0200 to 17777


Legal values for plc7 are depending of input type:
Analog points - no meening.
Digital points - 0 to 15

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 25

Legal values for plc8 is:


None Not used.
Word Read parameter block.

0
263

Legal values for plc9 are 0200 to 17777

26 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

AB PLC-3 addresses and Pmove profile


The AB PLC3 and Pmove Address profile must consist of :
plc1

PLC number

plc2

Input type

plc3

Input file

plc4

Input element

plc5

Input bit

plc6

Output type

plc7

Output file

plc8

Output element

plc9

Output bit

plc10

Parameter type

plc11

Parameter file

plc12

Parameter element

Legal values for plc1 are 0 to number of defined plcs.


Legal values for plc2 are:
Analog points:
None Not used.
N - 12 bit Input from 12 bit A/D converter from N-file.
N - 16 bit Signed Integer, one word from N-file.
N - 32 bit Signed Integer, two word from N-file.
H - 32 bit Signed Integer, one elements in H-file.
F - Float Siemens floating point value, two word from F-file.

0
771
772
773
1541
1030

Digital points:
None Not used.
B - 16 bit Machine Status Word (1 to 16 bits) from B-file.
N - 16 bit Machine Status Word (1 to 16 bits) from N-file.
B - 32 bit Machine Status Word (1 to 32 bits) from B-file.
N - 32 bit Machine Status Word (1 to 32 bits) from N-file.
H - 32 bit Machine Status Word (1 to 32 bits) from H-file.

0
513
769
514
770
1538

Legal values for plc3 are 0 to 999.


Legal values for plc4 are 0 to 9999.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 27

Legal values for plc5 are depending of input type:


Analog points - no meening.
Digital points:
B - 16 bit Legal values 0 - 15
N - 16 bit Legal values 0 - 15
B - 32 bit Legal values 0 - 31
N - 32 bit Legal values 0 - 31
H - 32 bit Legal values 0 - 31
Legal values for plc6:
Analog points:
None Not used.
N - 12 bit Output to 12 bit D/A converter in N-file.
N - 16 bit Signed Integer, one word in N-file.
N - 32 bit Signed Integer, two word in N-file.
H - 32 bit Signed Integer, two word in H-file.
F - Float Siemens floating point value in F-file.

0
771
772
773
1541
1030

Digital points:
None Not used.
B - 16 bit Set some or all (1 to 16 bits) in B-file.
N - 16 bit Set some or all (1 to 16 bits) in N-file.
B - 32 bit Set some or all (1 to 32 bits) in B-file.
N - 32 bit Set some or all (1 to 32 bits) in N-file.
H - 32 bit Set some or all (1 to 32 bits) in H-file.

0
513
769
514
770
1538

Legal values for plc7 are 0 to 999.


Legal values for plc8 are 0 to 9999.
Legal values for plc9 are depending of input type:
Analog points - no meening.
Digital points:
B - 16 bit Legal values 0 - 15
N - 16 bit Legal values 0 - 15
B - 32 bit Legal values 0 - 31
N - 32 bit Legal values 0 - 31
H - 32 bit Legal values 0 - 31
Legal values for plc9 are depending of output type:
Legal values for plc10 are:
None Not used.
N-file Read parameter block from N-file.
H-file Read parameter block from H-file.
F-file Read parameter block from F-file.

0
775
1543
1031

Legal values for plc11 are 0 to 999.


Legal values for plc12 are 0 to 9999.

28 Allen-Bradley Configuration

Reference Manual Allen-Bradley Configuration

AB SLC-500 addresses and Pmove profile


The AB SLC-500 and Pmove Address profile must consist of :
plc1

PLC number

plc2

Input type

plc3

Input file

plc4

Input element

plc5

Input bit

plc6

Output type

plc7

Output file

plc8

Output element

plc9

Output bit

plc10

Parameter type

plc11

Parameter file

plc12

Parameter element

Legal values for plc1 are 0 to number of defined plcs.


Legal values for plc2 are:
Analog points:
None Not used.
N - 12 bit Input from 12 bit A/D converter from N-file.
N - 16 bit Signed Integer, one word from N-file.
N - 32 bit Signed Integer, two word from N-file.
F - Float Siemens floating point value, two word from F-file.

0
771
772
773
1030

Digital points:
None Not used.
B - 16 bit Machine Status Word (1 to 16 bits) from B-file.
N - 16 bit Machine Status Word (1 to 16 bits) from N-file.
B - 32 bit Machine Status Word (1 to 32 bits) from B-file.
N - 32 bit Machine Status Word (1 to 32 bits) from N-file.

0
513
769
514
770

Legal values for plc3 are 3 to 255.


Legal values for plc4 are depending of input type:
N - 12 bit legal values are 3 to 255
N - 16 bit legal values are 3 to 255
N - 32 bit legal values are 3 to 254
F - Float legal values are 3 to 255
B - 16 bit legal values are 3 to 255
B - 32 bit legal values are 3 to 254

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 29

Legal values for plc5 are depending of input type:


Analog points - no meening.
Digital points:
B - 16 bit Legal values 0 - 15
N - 16 bit Legal values 0 - 15
B - 32 bit Legal values 0 - 31
N - 32 bit Legal values 0 - 31
Legal values for plc6:
Analog points:
None Not used.
N - 12 bit Output to 12 bit D/A converter in N-file.
N - 16 bit Signed Integer, one word in N-file.
N - 32 bit Signed Integer, two word in N-file.
F - Float Floating point value in F-file.

0
771
772
773
1030

Digital points:
None Not used.
B - 16 bit Set some or all (1 to 16 bits) in B-file.
N - 16 bit Set some or all (1 to 16 bits) in N-file.
B - 32 bit Set some or all (1 to 32 bits) in B-file.
N - 32 bit Set some or all (1 to 32 bits) in N-file.

0
513
769
514
770

Legal values for plc7 are 0 to 255.


Legal values for plc8 are depending of output type:
N - 12 bit legal values are 3 to 255
N - 16 bit legal values are 3 to 255
N - 32 bit legal values are 3 to 254
F - Float legal values are 3 to 255
B - 16 bit legal values are 3 to 255
B - 32 bit legal values are 3 to 254
Legal values for plc9 are depending of output type:
Analog points - no meening.
Digital points:
B - 16 bit Legal values 0 - 15
N - 16 bit Legal values 0 - 15
B - 32 bit Legal values 0 - 31
N - 32 bit Legal values 0 - 31
Legal values for plc10 are:
None Not used.
N-file Read parameter block from N-file.
F-file Read parameter block from F-file.

30 Allen-Bradley Configuration

0
775
1031

Reference Manual Allen-Bradley Configuration

Legal values for plc11 are 0 to 255.


Legal values for plc12 are 0 to 255.

Reference Manual Allen-Bradley Configuration

Allen-Bradley Configuration 31

Glossary of Terms

Reference Manual Allen-Bradley Configuration

Glossary of Terms 33

Link x Port ID 9
Link x Station Number 10
LOCAL 9

Index

M
Master Disk 2

O
OFFLINK 9

A
Active 11, 12
Address set 12
Alarm commands 12
Alarm Reset 1
Allen-Bradley Config 5
Available Drivers 2

PIGATEWAY 9
PLC 12
PLC 1
PLC Mode 10
PLC Status Word 10

R
Rockwell Software's RSLinx 2
RSLinx drivers 2

BCM Status Word 11


Bit 12

serial number 2
Station 3, 10

Command 12
Configure Ethernet-to-AB Communication window 3

Type 12

D
DF1MASTER 9
DH+ address 3

E
Element 12
Ethernet communication to a PLC-5 2

F
File 12

I
IP Address or hostname 3

K
KEYWORD 9

L
Link x 9, 11
Link x Driver ID 9

Reference Manual Allen-Bradley Configuration

Index 35

Reference Manual

Control Logix
Configuration

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 6
$Modtime:: 1/21/02 2:09p
Henrik D. S. Holme
$Author:: Taa
$Workfile:: CLXCfgUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
Control Logix Configuration..................................................................... 1
Introduction ................................................................................................................................... 1
System Configuration ............................................................................................................ 1
Address Configuration........................................................................................................... 1
System Configuration ................................................................................................................... 2
General Config....................................................................................................................... 2
PLC Config ............................................................................................................................ 3
Department Config ................................................................................................................ 8
Address Configuration .................................................................................................................. 9
Control Logix Address Configuration ................................................................................ 10
Control Logix addresses and Pmove profile ....................................................................... 12

Glossary of Terms ................................................................................... 15


Index.......................................................................................................... 17

Reference Manual Control Logix Configuration

Contents i

Control Logix Configuration

Introduction
This manual describes the procedures used to configure the Control Logix I/O system.
The major configuration steps include:

System Configuration
The Control Logix I/O system driver supplied by FLSA must be configured before it
can be used to interface with the PLCs. This procedure describes I/O polling
parameters, the parameters associated with individual PLCs, the details related to PLC
departments, and the PLC memory locations used to process start, stop, and alarm reset
commands.

Address Configuration
When ECS database points associated with the Control Logix I/O system are created,
the location of the point (PLC memory location) must be identified. This section
describes the procedure used to associate database points with the Control Logix I/O.

Reference Manual Control Logix Configuration

Control Logix Configuration 1

System Configuration
The Control Logix I/O system driver supplied by FLSA is configured by selecting
Control Logix Config in the desktop Start menu.

General Config

Scan between check spare links Specifies how often redundant communication
links will be checked for availability. Specified in units of PLC update periods. Valid
entry range: 1 to 100.
Max time no update The amount of time the ECS system will wait before a point
that doesnt receive any updates is marked as Not Updated. Valid entry range: 1 to 60
seconds.
Min. time between link switch This parameter specifies how many seconds must
pass after a network switch before another switch can be initiated. Valid entry range: 1
to 60 seconds.
Set time in PLCs If enabled, the ECS system will set the time in connected PLC5s.
In a dual system the time can be set from MOP1, from MOP2 or from both servers.

2 Control Logix Configuration

Reference Manual Control Logix Configuration

Block read timeout This parameter specifies how many seconds must pass after
close of faceplates before stop of polling. Valid entry range: 2 to 60 seconds.

PLC Config
PLC Select the PLC to be configured or modified. The current status (Passive, Polling
Ok, No Communication) of the selected PLC appears to the right of the pull down
menu.

General Tab

Name The name of the PLC


Active This checkbox determines whether the communication to the selected PLC
will be active or passive.
CPU slot number The number of the slot in the rack where the CPU is placed.

Reference Manual Control Logix Configuration

Control Logix Configuration 3

Redundant Link If the PLC is connected to two communication links (two networks
- A/B), enable this checkbox.
Link A Type Select the type of communication link used for link A.

None No communication link

TCP/IP TCP/IP connection to PLC

Link B Type Select the type of communication link used for link B. The possible
choices are as described in the Link A Type field.
Redundant PLC Enabled for redundant CLXs.
SCM slot number The number of the slot in the rack where the SRM module of a
redundant system is placed.
Poll frequency Defines how often the ECS system collects data from the PLC.
Legal entries: 200 to 60000 milli seconds.
Department The department name associated with this PLC. Communication alarms
for the PLC will be logged in the selected department.
Watchdog period Determines how often the ECS system will write a watchdog bit
to the PLC to indicate that the ECS system is operational. Legal entries: 5 to 3600
seconds. If set to 0 the watchdog function will be disabled.
Watchdog address The address of the bit that will be set by the watchdog function.
PLC status point The ECS database point will be updated with the status on the
active link for this PLC. The point must be a B-point with the CLX IO-type, but with
no IO addresses assigned. The conversion algorithm for the point has to be "Interface
Status".
If the status of Link A is Passive and the status of Link B is Polling OK, then the value
of the PLC status point will be Polling OK, if Link B is selected active.
Secondary PLC status point As above, but only applicable for redundant CLXs.
New Press this button when a new PLC needs to be inserted. Then select the number
in the PLC drop-down and write a PLC name. Press the Apply button to insert the
PLC.
Once inserted, the PLC cannot be deleted.

4 Control Logix Configuration

Reference Manual Control Logix Configuration

Links, CLX TCP/IP

Link Type Displays the link type for the selected link.
IP Addr. / Node Name Enter the IP address or the node name for the PLC.
Timeout (milli seconds) The amount of time the ECS system will wait for a reply
from the PLC. Legal entries: 500 to 60000 milli seconds.
Max pending requests The maximum number of requests that the ECS system will
issue concurrently to one PLC. Legal entries: 2 to 20.
Link status point The value of this point will be the status of the link (Aor B),
regardless of the link selected as active.
Apply a point code of a B-point with the IO-type CLX, but with no IO addresses
assigned. The conversion algorithm for the point has to be "Interface Status".
Use CN routing If the Controller is present a remote rack, accessible on ControlNet
check this field.
CN Slot No. The number of the slot in the rack where the ControlNet Card is placed.
CN Port No. The number of the port on the ControlNet Card. 2 for Channel A and 3
for Channel B.
CN MAC Id The MAC Id of the ControlNet Card in the remote rack.

Reference Manual Control Logix Configuration

Control Logix Configuration 5

Status Tab

PLC Mode Shows the mode of the PLC (Run or Stop).


PLC Status Word Machine state word of the PLC.
Bit 15-12..................................................................................... Reserved
Bit 11............................................................... Major Unrecoverable Fault
Bit 10...................................................................Major Recoverable Fault
Bit 9................................................................. Minor Unrecoverable Fault
Bit 8.....................................................................Minor Recoverable Fault
Bit 4-7 .......................................................................................See below
Bit 3............................................................................................ Reserved
Bit 2........ Configured (Defined to do something different than "out-of-box"
Bit 1............................................................................................ Reserved
Bit 0................................................................................................ Owned
PLC Status Word Bit 7 to 4
0000..................................................................... Self-Testing (power-up)
0001............................................................. Firmware update in progress
0010.......................................................................... Communication fault
0011.......................................................... Unkeyed, Awaiting Connection
0100..........................................................Non-Volatile Configuration Bad
0101........................ Major Fault (see bit 10 and 11 for fault classification)
0110............................................................................. Connected, Active

6 Control Logix Configuration

Reference Manual Control Logix Configuration

0111 ......................................................................... Idle (Program Mode)


1000 .......................................................................................... Reserved
1001 .......................................................................................... Reserved
1010 .................................................Reserved for Product specific states
1011 .................................................Reserved for Product specific states
1100 .................................................Reserved for Product specific states
1101 .................................................Reserved for Product specific states
1110 .................................................Reserved for Product specific states
1111 .................................................Reserved for Product specific states
SRM Status Word .
Bit 15-8 ..................................................................... RackNo (See below)
Bit 7-0 .........................................................Secondary Status(See below)
SRM Status Word Bit 15 to 8
00000000 ................................................................................... Unknown
00000001 ...................................................................................... Rack A
00000010 ...................................................................................... Rack B
SRM Status Word Bit 7 to 0
00000000 ................................................................................... Unknown
00000010 .............................................................. Secondary disqualified
00000100 ............................................................... Secondary is qualified
Active Link Shows which link (A or B) is currently used for the communication.
Status Shows the current status for the communication link (Not Configured, Link
Ok, No Communication).
Transmit Ok The number of requests successfully sent to the PLC.
Transmit Errors The number of transmit errors.
Received Ok The number of replies received without errors.
Receive Errors The number of receive errors.
Timeouts The number of timeouts waiting for replies from the PLC.
Bad Data The number of Bad Data packets received.
Session Id Errors The number of packets with bad Session Id.
Target Id Errors The number of packets with bad Target Id.
Received with bad length The number of packets received with bad length from
the PLC.
Unhandled commands
received from the plc.

The number of packets with unhandled commands

Last poll time The actual time for polling all connected points.
Mean poll time The average time for polling all connected points.
Max. poll time The maximum time it has taken for polling all connected points.
Min. poll time The minimum time it has taken for polling all connected points.
Reset The reset command will reset the statistical counters.

Reference Manual Control Logix Configuration

Control Logix Configuration 7

Department Config
The department config tab is used to associate the start and stop commands (Group
Start/Stop, Master Stop, Quick Stop) and the Alarm commands (Alarm Reset and
Alarm Silence) with PLC memory locations. First, select the department to be
configured or modified from the Department list.

Department Select here the department. A * in front of the department name


means that the department is active.
Active Enable the check box to activate the department. Remove the check to
deactivate the department.
Address set Selects one of the four address sets that can be configured for the
department. A * in front of the address set number means that this set is active.
PLC Select the PLC where the commands for this department are to be sent.
Command Each command in the left column must be assigned to the appropriate
Register and Bit within the PLC. The Type selection defines the type of data stored
at the PLC location. Type can be None (not used), INT, DINT or BOOL.

8 Control Logix Configuration

Reference Manual Control Logix Configuration

Address Configuration
The ECS database points that are associated with the Control Logix I/O system are
connected to the system through an address location within the PLC. This address
location is specified when the point is created.
First, in the Point Configuration utility, select Control Logix (22 - CLX) as the IF
Type.

Click on the Interface address button to view the Control Logix Address
Configuration window.

Reference Manual Control Logix Configuration

Control Logix Configuration 9

Control Logix Address Configuration


The Control Logix Address Configuration window is used to assign the current ECS
database point to a location within the Control Logix PLC. The point is used to read a
location within the PLC or write to a location within the PLC.
The Pointcode field identifies the current ECS database point.

PLC Select the PLC where the point location resides.


Input If this is a point location that is read by the ECS system, enter the data location
type and Tag-name.
Output If this is a point location that is written to by the ECS system, enter the data
location type and Tag-name.
Parameter If this point has a parameter block in the PLC that can be read on request
from e.g. a faceplate, enter the block start address as type and Tag-name.

Possible input types for analog points are:


None Not used.
12-bit Input from 12 bit A/D converter.
INT Signed Integer 16-bit.
DINT Signed Integer 32-bits.
REAL Floating point value.
12-bit/status/time Input from 12 bit A/D converter, status word, time stamp.
INT/status/time Signed Integer value, status word, time stamp.
REAL/status/time Floating point value, status word, time stamp.
INT/status/time (INT Array) Signed Integer value, status word, time stamp. From
INT array
REAL/status/time (REAL Array) Floating point value, status word, time stamp.
From Real array.

10 Control Logix Configuration

Reference Manual Control Logix Configuration

Possible output types for analog points are:


None Not used.
12-bit Input from 12 bit A/D converter.
INT Signed Integer 16-bit.
DINT Signed Integer 32-bits.
REAL Floating point value.

Possible input types for digital points are:


None Not used.
INT Machine Status Word (bit pattern).
DINT Machine Status Word (bit pattern).
INT/time Machine Status Word, time stamp.
DINT/time Machine Status Word, time stamp.
INT/time (INT Array) Machine Status Word, time stamp. From INT array.

Possible output types for digital points are:


None Not used.
INT Machine Status Word (bit pattern).
DINT Machine Status Word (bit pattern).
BOOL Bit.

Possible parameter types are:


None Not used.
Parameter Block Parameter Block.

Reference Manual Control Logix Configuration

Control Logix Configuration 11

Control Logix addresses and Pmove profile


The Control Logix and Pmove Address profile must consist of :
plc1

PLC number

plc2

Input type

plc3

Input tag

plc4

Output type

plc5

Output tag

plc6

Parameter type

plc7

Parameter tag

Legal values for plc1 are 0 to number of defined plcs.


Legal values for plc2 are depending of point-type:
Analog points:
None Not used.
12 bit Input from 12 bit A/D converter.
INT Signed Integer.
DINT Signed Integer.
REAL Floating point.
12-bit/status/time Input 12 bit A/D converter, status word, time stamp.
INT/status/time INT, status word, time stamp.
REAL/status/time REAL, status word, time stamp.
INT/status/time (INT Array) INT, status word, time stamp.
REAL/status/time (REAL Array) REAL, status word, time stamp.

0
3
4
5
6
9
12
10
13
14

Digital points:
None Not used.
INT Machine Status Word (bit pattern).
DINT Machine Status Word (bit pattern).
INT/time Machine Status Word, time stamp.
DINT/time Machine Status Word, time stamp.
INT/time (INT Array) Machine Status Word, time stamp.

0
1
2
7
8
15

Legal values for plc3 are legal tags in the plc.


Legal values for plc4 are depending of point-type:
Analog points:
None Not used.
12 bit Input from 12 bit A/D converter.
INT Signed Integer.
DINT Signed Integer.
REAL Floating point.

0
3
4
5
6

Digital points:
None Not used.
INT Machine Status Word (bit pattern).

12 Control Logix Configuration

0
1

Reference Manual Control Logix Configuration

DINT Machine Status Word (bit pattern).


BOOL Bit.

2
16

Legal values for plc5 are legal tags in the plc.


Legal values for plc6 are:
None Not used.
Parameter Block Parameter Block.

0
11

Legal values for plc7 are legal tags in the plc.

Reference Manual Control Logix Configuration

Control Logix Configuration 13

Glossary of Terms

Reference Manual Control Logix Configuration

Glossary of Terms 15

Index

Error! No index entries found.

Reference Manual Control Logix Configuration

Index 17

User Manual

ECS/SDR User Interface

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 5
$Modtime:: 7/16/01 3:59p
gf
$Author:: Ngb
$Workfile:: SDRUserInterface30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS/SDR User Interface............................................................................ 1
Introduction ................................................................................................................................... 1
Workstation Mouse....................................................................................................................... 1
Menu Commands................................................................................................................... 1
Command Buttons ................................................................................................................. 2
Toolbar Command Buttons ................................................................................................... 2
Mouse Terminology .............................................................................................................. 2
Manipulating Windows................................................................................................................. 3
Minimizing Windows ............................................................................................................ 3
Maximizing Windows ........................................................................................................... 3
Closing Windows................................................................................................................... 3
Moving Windows .................................................................................................................. 3
Dialog Forms................................................................................................................................. 4
Text Fields ............................................................................................................................. 4
Choice Menus ........................................................................................................................ 6
Option Buttons....................................................................................................................... 6
Checkboxes............................................................................................................................ 7
Form Tabs .............................................................................................................................. 7
Form Grids............................................................................................................................. 8
Common Commands ............................................................................................................. 9
ECS/SDR System Login............................................................................................................... 9
Current User........................................................................................................................... 9
Changing Your Password ...................................................................................................... 9
Workstation Desktop .................................................................................................................. 10
Taskbar................................................................................................................................. 10
Starting ECS/SDR Applications................................................................................................. 11
Taskbar Start Button............................................................................................................ 11
Toolbar Commands ............................................................................................................. 11
ECS/SDR System Logoff and Shutdown................................................................................... 12
System Logoff ..................................................................................................................... 12
System Shutdown ................................................................................................................ 12
Point Selection ............................................................................................................................ 14
Point List Commands .......................................................................................................... 14

Glossary of Terms ................................................................................... 17


Index.......................................................................................................... 19

User Manual ECS/SDR User Interface

Contents i

ECS/SDR User Interface

Introduction
The ECS/SDR User Interface document provides an introduction to the ECS
workstation and a description of the workstation environment. The manual also
describes the procedures used to log into the ECS/SDR system, start and stop
programs, and interface with the display windows and dialog boxes.

Workstation Mouse
The workstation mouse is used to execute commands, select parameter options,
and manipulate display windows. The workstation monitor displays a mouse
pointer to indicate the current mouse location. The mouse pointer is moved to
the desired display element and an action is initiated by clicking one of the
mouse buttons.

Menu Commands
When a menu command is clicked with the left mouse button, a list appears with
several options. In the example, the File menu reveals the Open, Print Setup,
Page Setup, and Exit options. An option that appears grey is not available.

To select an option, move the mouse pointer to the desired menu item and click
the left mouse button. In the example, the Open command is executed.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 1

Command Buttons
A command button appears as a raised button. In the example, the commands are
OK, Apply, Cancel, and Help.

To execute the command, move the mouse pointer to the button and click the left
mouse button.

Toolbar Command Buttons


Command buttons also appear in the toolbar area of application windows.

The command name or action


associated with the button can
be determined by placing the
mouse pointer over the button
for 3 seconds.

To initiate the command, move the mouse pointer to the button and click the left
mouse button.

Mouse Terminology
The workstation mouse is used for various functions. The following terms refer
to the described function throughout the ECS/SDR documentation.
If the right mouse button is
required,
the
user
is
instructed to click with the
right mouse button.

Click This action is used to execute a command, select an object, or activate a


display element. The action requires the user to move the mouse pointer to the
object and press the left mouse button.
Drag This action is used to move a display element. The action requires the user
to move the mouse pointer to the object and press and hold the left mouse
button. The mouse is then moved until the object is in the desired location at
which time the mouse button is released.
Select An object is selected by moving the mouse pointer to the object and
clicking the left mouse button.

2 ECS/SDR User Interface

User Manual ECS/SDR User Interface

Double-click This action is used to launch applications from desktop icons and
select text within text field. The action requires the user to click on the icon,
display element, or text twice in rapid succession.

Manipulating Windows
The mouse is also used to minimize, maximize and exit application windows.
These functions are implemented by clicking on the appropriate command
button located at the top right of the display window.

Minimizing Windows
Click on the
command button to minimize the display window. This
removes the window from the desktop. The window can be restored by clicking
on the icon located in the taskbar.

Maximizing Windows
Click on the
command button to maximize the display window. This
expands the size of the window to fill the entire screen area. After the display
window is maximized, the command button changes to
command to change the window to its previous size.

. Click on this

Windows can also be maximized by double clicking in the window title or


banner area.

Closing Windows
Click on the
command to close the window. If this is the main display
window associated with the application, the application is exited.

Moving Windows
To move a display window, click and hold the left mouse button in the window
title area. Drag the window to the desired location, then release the mouse
button.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 3

Dialog Forms
A dialog form is used to supply information to an application. This section
describes the elements that appear on these forms.

Text Fields
A text field is a dialog form display element used to supply text information to
an application.

Entering Text
To enter text, click in the field and begin typing.

The Paste selection is only


available if text has been
placed on the clipboard.

4 ECS/SDR User Interface

Text can also be entered by clicking the right mouse button in the field. When
the following menu appears, move the mouse until Paste is highlighted then
click the left mouse button.

User Manual ECS/SDR User Interface

Editing Text
To edit existing text, click in the area to be edited. A text cursor appears as a
vertical bar within the text. To add text, begin typing.

Press the keyboard <Delete> key to remove the character to the right of the
cursor. Press the keyboard <Backspace> key to remove the character to the left
of the cursor.
To replace text, highlight the text to be replaced, then begin typing.

Text is highlighted using any of the following methods:

Double-click on a word

Click in an area within the text field, hold down the keyboard <Shift>
key, and then click in another area of the field. The text between the
two points is highlighted.

Press and hold the left mouse button within the text field. Drag the
mouse to another area and release the mouse button. The area dragged
is highlighted.

Text can also be edited by clicking the right mouse button within the text field.
Choose one of the commands from the menu that appears

Undo Cancels the previous command.


Cut Removes the highlighted text and places it on the clipboard.
Copy Copies the highlighted text and places it on the clipboard.
Paste Places the contents of the clipboard into the text field at the point of the
text cursor.
Delete Removes the highlighted text from the text field.
Select All Highlights all text in the text field.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 5

Choice Menus
A choice menu limits the information that can be supplied to the application.
Information is supplied from a list of choices that appear when the menu arrow
is clicked. To select a list item, move the mouse until the desired choice is
highlighted, then click the left mouse button. In the example, the selection for
this field is changed from Department to Point code.

Option Buttons
Option buttons are another means to select one item from a group of items. All
items in the group are identified with a radio style button as shown in the choices
below (Local and Default). The group name in this case is Mode.

Only one option in an option


group can be selected at any
time.

6 ECS/SDR User Interface

The filled button indicates the current selection. In the example, Local is the
current mode. To change the selection, click on the button associated with the
desired choice. The option is filled to indicate selection and all other option
buttons in the group are deselected.

User Manual ECS/SDR User Interface

Checkboxes
Checkboxes are used for binary type selections (Enable/Disable, On/Off.
Yes/No, etc). An empty checkbox indicates disabled, off, or no. In this example,
the Server does not have a dual partner.

A filled checkbox indicates enabled, on, or yes. In this example, the Server has a
dual partner.

To toggle the current checkbox selection, click on the checkbox with the left
mouse button.

Form Tabs
A dialog form can contain multiple pages. In the example, the pages are Point
List, Search Criteria, Maintenance, and Favorites. Each page is identified by the
form tab. Click on the form tab to access the desired page. Search Criteria is the
current page in the example.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 7

Form Grids
A form grid presents information in data cells. The column and row labels
identify each cell.

The cell contents can be modified using any of the following methods:

Click in the cell, press the keyboard <F2> key and press the right
mouse button. Select Paste to place the clipboard contents into the data
cell.

Click in the cell and press the keyboard <F2> key twice to use the Cell
Text dialog form for data cell entry.

When entering numeric values with a leading zero (e.g. 0123), the zero is
dropped and the value is entered as 123. If the leading zero is required, precede
the numeric entry with the single apostrophe () character. For example 0123.

Cell Text Form


The cell text dialog form is used to enter text or values into a data cell. The form
is accessed by selecting a data cell and pressing the keyboard <F2> key twice.
When the form appears, click in the text field and begin typing. For additional
information on data entry and text field editing, refer to Text Fields.

Click on the OK command to assign the text field information to the data cell.
Click on the Cancel command to abort the data cell modification.

8 ECS/SDR User Interface

User Manual ECS/SDR User Interface

Common Commands
The commands that appear on dialog forms perform the same actions. The
commands include:
OK Saves any field changes made within the form then closes the form.
Apply Saves any field changes made within the form. The form remains open.
Cancel Ignores any field changes made since the form was opened or the last
Apply command was issued. Afterwards, the form is closed.
Reset Returns field assignments to the original assignments. That is the
assignments as they were when the form was opened or the after the last Apply
command was issued.
Help Opens the online Help window associated with the current dialog form or
application.

ECS/SDR System Login


To log into the ECS/SDR system, simultaneously press the keyboard <Ctrl>,
<Alt> and <Delete> keys at the logon message prompt.
The default user account is
flsa - no password is
required.

When the login window appears, enter your assigned User name and Password.
Complete the login process by moving the mouse pointer to the OK command and
pressing the left mouse button.

Current User
To determine the user currently logged into a workstation, simultaneously press
the keyboard <Ctrl>, <Alt> and <Delete> keys. A Windows 2000 Security
window appears and displays the user currently logged into the workstation and
the login time and date.

Changing Your Password


To change the password currently assigned to your account, simultaneously
press the keyboard <Ctrl>, <Alt> and <Delete> keys. A Windows 2000 Security
window appears. Click on the Change Password command. When the
Change Password dialog form appears, enter the Old Password and the New
Password in the appropriate fields. Re-enter the new password in the Confirm
New Password field.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 9

Workstation Desktop
The icons that appear on the
desktop, the location of the
taskbar, and the applications
that are automatically started
depend on the environment
and privileges assigned to the
user account.

After a user logs into the ECS/SDR system, the workstation desktop is started. A
few icons appear on the display and a desktop taskbar. In some cases, ECS/SDR
programs may be started automatically.

Taskbar
The taskbar holds the Start menu command and an icon button for each
program started since the login process. The icon button that appears pressed
indicates the active program. To activate a program, click on its taskbar icon
with the left mouse button. The window associated with the program appears in
front of all other displays.

10 ECS/SDR User Interface

User Manual ECS/SDR User Interface

Starting ECS/SDR Applications


Taskbar Start Button
The Start button located in the taskbar is used to start or launch ECS/SDR
applications. To start an application, click on the Start command. When the
menu appears, move the mouse pointer to the desired selection.
When a menu item has an arrow to its right, a cascaded menu is available. To
display the menu, move the mouse pointer to the arrow.
As the mouse pointer is moved over a menu selection, the menu item is
highlighted. When the desired selection is highlighted, click the left mouse
button.

Toolbar Commands
Some ECS/SDR applications provide access to other ECS/SDR applications by
providing a toolbar command button. The button icon is identified by the
specific application as shown below:

Point List
Alarm List
Point Trend
Point Parameters
To launch the application, click on the toolbar command button.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 11

ECS/SDR System Logoff and Shutdown


System Logoff
Simultaneously press the keyboard <Ctrl>, <Alt> and <Delete> keys. When the
Windows 2000 Security window appears, click on the Logoff command button.

System Shutdown
Before power is removed from the workstation computer, the Windows 2000
and ECS/SDR systems must be shut down in an organized manner to maintain
system and data integrity. To initiate the shutdown procedure, locate and select
Maintenance in the desktop Start menu. Select the desired shutdown option
and press the OK command.

Restart the computer in maintenance mode The ECS/SDR and


Windows 2000 systems shut down and a reboot to the maintenance
mode is initiated. When the logon prompt appears, log into the
flsamain account. The maintenance utility starts and the Maintenance
display appears.
Shut down the computer for maintenance mode The ECS/SDR
and Windows 2000 systems shut down. After the shutdown is executed,
power can be removed from the system. After power is restored, a
reboot to the maintenance mode is initiated. When the logon prompt
appears, log into the flsamain account. The maintenance utility starts
and the Maintenance display appears.
Restart the computer in run mode The ECS/SDR and Windows
2000 systems shut down and a reboot to the run mode is initiated. When
the logon prompt appears, log into the flsa or flsaadmin account.
Shut down the computer for run mode The ECS/SDR and
Windows 2000 systems shut down. After the shutdown is executed,
power can be removed from the system. After power is restored, a

12 ECS/SDR User Interface

User Manual ECS/SDR User Interface

reboot to the run mode is initiated. When the logon prompt appears, log
into the flsa or flsaadmin account.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 13

Point Selection
Whenever a database point must be entered into an ECS utility text field or data
cell, any of the following methods can be used:

Type the point name in the text field or data cell as described in Dialog
Forms.

Use the Copy/Paste method as described in Dialog Forms.

Use the Point List commands that appear in the ECS/SDR utility
toolbar.

Point List Commands


If any of the dialog forms associated with an ECS/SDR utility require point
names to be entered, the point selection commands appear in the toolbar.

When any of the point selection commands are pressed, a point name is copied
from the Point List utility and pasted into the active display element (text field or
data cell). The point name copied and pasted depends on the command used and
the point that is currently selected in the point list.

14 ECS/SDR User Interface

User Manual ECS/SDR User Interface

When a point selection command is issued, the Point List is started if it is not
running.

Point Selection Procedure


1.

Activate the text field or data cell that accepts a point name entry by
clicking in the display element.

2.

Click on the appropriate point selection command:

Selected Point The name of the selected point in the point list is
placed into the active display element.

Previous Point The name of the point prior to the selected point in
the point list is placed into the active display element.

Next Point The name of the point after the selected point in the
point list is placed into the active display element.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 15

Glossary of Terms

banner area
The area located along the top of a display window. Also called the title area.
The banner area includes the name of the application or dialog form.

launch
Start an application

title area
The area located along the top of a display window. Also called the banner area.
The title area includes the name of the application or dialog form.

clipboard
The clipboard is a copy/paste buffer. Information placed in the buffer with the
Copy or Cut commands can be placed in other applications by using the Paste
command.

mouse pointer
The mouse pointer is a display element that identifies the current mouse location.
The mouse pointer moves on the screen as the mouse is moved.

active program
The program associated with the display window being used. The display
window being used is said to have focus.

User Manual ECS/SDR User Interface

Glossary of Terms 17

Index

Error! No index entries found.

User Manual ECS/SDR User Interface

Index 19

User Manual

ECS/SDR User Interface

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 5
$Modtime:: 7/16/01 3:59p
gf
$Author:: Ngb
$Workfile:: SDRUserInterface30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS/SDR User Interface............................................................................ 1
Introduction ................................................................................................................................... 1
Workstation Mouse....................................................................................................................... 1
Menu Commands................................................................................................................... 1
Command Buttons ................................................................................................................. 2
Toolbar Command Buttons ................................................................................................... 2
Mouse Terminology .............................................................................................................. 2
Manipulating Windows................................................................................................................. 3
Minimizing Windows ............................................................................................................ 3
Maximizing Windows ........................................................................................................... 3
Closing Windows................................................................................................................... 3
Moving Windows .................................................................................................................. 3
Dialog Forms................................................................................................................................. 4
Text Fields ............................................................................................................................. 4
Choice Menus ........................................................................................................................ 6
Option Buttons....................................................................................................................... 6
Checkboxes............................................................................................................................ 7
Form Tabs .............................................................................................................................. 7
Form Grids............................................................................................................................. 8
Common Commands ............................................................................................................. 9
ECS/SDR System Login............................................................................................................... 9
Current User........................................................................................................................... 9
Changing Your Password ...................................................................................................... 9
Workstation Desktop .................................................................................................................. 10
Taskbar................................................................................................................................. 10
Starting ECS/SDR Applications................................................................................................. 11
Taskbar Start Button............................................................................................................ 11
Toolbar Commands ............................................................................................................. 11
ECS/SDR System Logoff and Shutdown................................................................................... 12
System Logoff ..................................................................................................................... 12
System Shutdown ................................................................................................................ 12
Point Selection ............................................................................................................................ 14
Point List Commands .......................................................................................................... 14

Glossary of Terms ................................................................................... 17


Index.......................................................................................................... 19

User Manual ECS/SDR User Interface

Contents i

ECS/SDR User Interface

Introduction
The ECS/SDR User Interface document provides an introduction to the ECS
workstation and a description of the workstation environment. The manual also
describes the procedures used to log into the ECS/SDR system, start and stop
programs, and interface with the display windows and dialog boxes.

Workstation Mouse
The workstation mouse is used to execute commands, select parameter options,
and manipulate display windows. The workstation monitor displays a mouse
pointer to indicate the current mouse location. The mouse pointer is moved to
the desired display element and an action is initiated by clicking one of the
mouse buttons.

Menu Commands
When a menu command is clicked with the left mouse button, a list appears with
several options. In the example, the File menu reveals the Open, Print Setup,
Page Setup, and Exit options. An option that appears grey is not available.

To select an option, move the mouse pointer to the desired menu item and click
the left mouse button. In the example, the Open command is executed.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 1

Command Buttons
A command button appears as a raised button. In the example, the commands are
OK, Apply, Cancel, and Help.

To execute the command, move the mouse pointer to the button and click the left
mouse button.

Toolbar Command Buttons


Command buttons also appear in the toolbar area of application windows.

The command name or action


associated with the button can
be determined by placing the
mouse pointer over the button
for 3 seconds.

To initiate the command, move the mouse pointer to the button and click the left
mouse button.

Mouse Terminology
The workstation mouse is used for various functions. The following terms refer
to the described function throughout the ECS/SDR documentation.
If the right mouse button is
required,
the
user
is
instructed to click with the
right mouse button.

Click This action is used to execute a command, select an object, or activate a


display element. The action requires the user to move the mouse pointer to the
object and press the left mouse button.
Drag This action is used to move a display element. The action requires the user
to move the mouse pointer to the object and press and hold the left mouse
button. The mouse is then moved until the object is in the desired location at
which time the mouse button is released.
Select An object is selected by moving the mouse pointer to the object and
clicking the left mouse button.

2 ECS/SDR User Interface

User Manual ECS/SDR User Interface

Double-click This action is used to launch applications from desktop icons and
select text within text field. The action requires the user to click on the icon,
display element, or text twice in rapid succession.

Manipulating Windows
The mouse is also used to minimize, maximize and exit application windows.
These functions are implemented by clicking on the appropriate command
button located at the top right of the display window.

Minimizing Windows
Click on the
command button to minimize the display window. This
removes the window from the desktop. The window can be restored by clicking
on the icon located in the taskbar.

Maximizing Windows
Click on the
command button to maximize the display window. This
expands the size of the window to fill the entire screen area. After the display
window is maximized, the command button changes to
command to change the window to its previous size.

. Click on this

Windows can also be maximized by double clicking in the window title or


banner area.

Closing Windows
Click on the
command to close the window. If this is the main display
window associated with the application, the application is exited.

Moving Windows
To move a display window, click and hold the left mouse button in the window
title area. Drag the window to the desired location, then release the mouse
button.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 3

Dialog Forms
A dialog form is used to supply information to an application. This section
describes the elements that appear on these forms.

Text Fields
A text field is a dialog form display element used to supply text information to
an application.

Entering Text
To enter text, click in the field and begin typing.

The Paste selection is only


available if text has been
placed on the clipboard.

4 ECS/SDR User Interface

Text can also be entered by clicking the right mouse button in the field. When
the following menu appears, move the mouse until Paste is highlighted then
click the left mouse button.

User Manual ECS/SDR User Interface

Editing Text
To edit existing text, click in the area to be edited. A text cursor appears as a
vertical bar within the text. To add text, begin typing.

Press the keyboard <Delete> key to remove the character to the right of the
cursor. Press the keyboard <Backspace> key to remove the character to the left
of the cursor.
To replace text, highlight the text to be replaced, then begin typing.

Text is highlighted using any of the following methods:

Double-click on a word

Click in an area within the text field, hold down the keyboard <Shift>
key, and then click in another area of the field. The text between the
two points is highlighted.

Press and hold the left mouse button within the text field. Drag the
mouse to another area and release the mouse button. The area dragged
is highlighted.

Text can also be edited by clicking the right mouse button within the text field.
Choose one of the commands from the menu that appears

Undo Cancels the previous command.


Cut Removes the highlighted text and places it on the clipboard.
Copy Copies the highlighted text and places it on the clipboard.
Paste Places the contents of the clipboard into the text field at the point of the
text cursor.
Delete Removes the highlighted text from the text field.
Select All Highlights all text in the text field.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 5

Choice Menus
A choice menu limits the information that can be supplied to the application.
Information is supplied from a list of choices that appear when the menu arrow
is clicked. To select a list item, move the mouse until the desired choice is
highlighted, then click the left mouse button. In the example, the selection for
this field is changed from Department to Point code.

Option Buttons
Option buttons are another means to select one item from a group of items. All
items in the group are identified with a radio style button as shown in the choices
below (Local and Default). The group name in this case is Mode.

Only one option in an option


group can be selected at any
time.

6 ECS/SDR User Interface

The filled button indicates the current selection. In the example, Local is the
current mode. To change the selection, click on the button associated with the
desired choice. The option is filled to indicate selection and all other option
buttons in the group are deselected.

User Manual ECS/SDR User Interface

Checkboxes
Checkboxes are used for binary type selections (Enable/Disable, On/Off.
Yes/No, etc). An empty checkbox indicates disabled, off, or no. In this example,
the Server does not have a dual partner.

A filled checkbox indicates enabled, on, or yes. In this example, the Server has a
dual partner.

To toggle the current checkbox selection, click on the checkbox with the left
mouse button.

Form Tabs
A dialog form can contain multiple pages. In the example, the pages are Point
List, Search Criteria, Maintenance, and Favorites. Each page is identified by the
form tab. Click on the form tab to access the desired page. Search Criteria is the
current page in the example.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 7

Form Grids
A form grid presents information in data cells. The column and row labels
identify each cell.

The cell contents can be modified using any of the following methods:

Click in the cell, press the keyboard <F2> key and press the right
mouse button. Select Paste to place the clipboard contents into the data
cell.

Click in the cell and press the keyboard <F2> key twice to use the Cell
Text dialog form for data cell entry.

When entering numeric values with a leading zero (e.g. 0123), the zero is
dropped and the value is entered as 123. If the leading zero is required, precede
the numeric entry with the single apostrophe () character. For example 0123.

Cell Text Form


The cell text dialog form is used to enter text or values into a data cell. The form
is accessed by selecting a data cell and pressing the keyboard <F2> key twice.
When the form appears, click in the text field and begin typing. For additional
information on data entry and text field editing, refer to Text Fields.

Click on the OK command to assign the text field information to the data cell.
Click on the Cancel command to abort the data cell modification.

8 ECS/SDR User Interface

User Manual ECS/SDR User Interface

Common Commands
The commands that appear on dialog forms perform the same actions. The
commands include:
OK Saves any field changes made within the form then closes the form.
Apply Saves any field changes made within the form. The form remains open.
Cancel Ignores any field changes made since the form was opened or the last
Apply command was issued. Afterwards, the form is closed.
Reset Returns field assignments to the original assignments. That is the
assignments as they were when the form was opened or the after the last Apply
command was issued.
Help Opens the online Help window associated with the current dialog form or
application.

ECS/SDR System Login


To log into the ECS/SDR system, simultaneously press the keyboard <Ctrl>,
<Alt> and <Delete> keys at the logon message prompt.
The default user account is
flsa - no password is
required.

When the login window appears, enter your assigned User name and Password.
Complete the login process by moving the mouse pointer to the OK command and
pressing the left mouse button.

Current User
To determine the user currently logged into a workstation, simultaneously press
the keyboard <Ctrl>, <Alt> and <Delete> keys. A Windows 2000 Security
window appears and displays the user currently logged into the workstation and
the login time and date.

Changing Your Password


To change the password currently assigned to your account, simultaneously
press the keyboard <Ctrl>, <Alt> and <Delete> keys. A Windows 2000 Security
window appears. Click on the Change Password command. When the
Change Password dialog form appears, enter the Old Password and the New
Password in the appropriate fields. Re-enter the new password in the Confirm
New Password field.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 9

Workstation Desktop
The icons that appear on the
desktop, the location of the
taskbar, and the applications
that are automatically started
depend on the environment
and privileges assigned to the
user account.

After a user logs into the ECS/SDR system, the workstation desktop is started. A
few icons appear on the display and a desktop taskbar. In some cases, ECS/SDR
programs may be started automatically.

Taskbar
The taskbar holds the Start menu command and an icon button for each
program started since the login process. The icon button that appears pressed
indicates the active program. To activate a program, click on its taskbar icon
with the left mouse button. The window associated with the program appears in
front of all other displays.

10 ECS/SDR User Interface

User Manual ECS/SDR User Interface

Starting ECS/SDR Applications


Taskbar Start Button
The Start button located in the taskbar is used to start or launch ECS/SDR
applications. To start an application, click on the Start command. When the
menu appears, move the mouse pointer to the desired selection.
When a menu item has an arrow to its right, a cascaded menu is available. To
display the menu, move the mouse pointer to the arrow.
As the mouse pointer is moved over a menu selection, the menu item is
highlighted. When the desired selection is highlighted, click the left mouse
button.

Toolbar Commands
Some ECS/SDR applications provide access to other ECS/SDR applications by
providing a toolbar command button. The button icon is identified by the
specific application as shown below:

Point List
Alarm List
Point Trend
Point Parameters
To launch the application, click on the toolbar command button.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 11

ECS/SDR System Logoff and Shutdown


System Logoff
Simultaneously press the keyboard <Ctrl>, <Alt> and <Delete> keys. When the
Windows 2000 Security window appears, click on the Logoff command button.

System Shutdown
Before power is removed from the workstation computer, the Windows 2000
and ECS/SDR systems must be shut down in an organized manner to maintain
system and data integrity. To initiate the shutdown procedure, locate and select
Maintenance in the desktop Start menu. Select the desired shutdown option
and press the OK command.

Restart the computer in maintenance mode The ECS/SDR and


Windows 2000 systems shut down and a reboot to the maintenance
mode is initiated. When the logon prompt appears, log into the
flsamain account. The maintenance utility starts and the Maintenance
display appears.
Shut down the computer for maintenance mode The ECS/SDR
and Windows 2000 systems shut down. After the shutdown is executed,
power can be removed from the system. After power is restored, a
reboot to the maintenance mode is initiated. When the logon prompt
appears, log into the flsamain account. The maintenance utility starts
and the Maintenance display appears.
Restart the computer in run mode The ECS/SDR and Windows
2000 systems shut down and a reboot to the run mode is initiated. When
the logon prompt appears, log into the flsa or flsaadmin account.
Shut down the computer for run mode The ECS/SDR and
Windows 2000 systems shut down. After the shutdown is executed,
power can be removed from the system. After power is restored, a

12 ECS/SDR User Interface

User Manual ECS/SDR User Interface

reboot to the run mode is initiated. When the logon prompt appears, log
into the flsa or flsaadmin account.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 13

Point Selection
Whenever a database point must be entered into an ECS utility text field or data
cell, any of the following methods can be used:

Type the point name in the text field or data cell as described in Dialog
Forms.

Use the Copy/Paste method as described in Dialog Forms.

Use the Point List commands that appear in the ECS/SDR utility
toolbar.

Point List Commands


If any of the dialog forms associated with an ECS/SDR utility require point
names to be entered, the point selection commands appear in the toolbar.

When any of the point selection commands are pressed, a point name is copied
from the Point List utility and pasted into the active display element (text field or
data cell). The point name copied and pasted depends on the command used and
the point that is currently selected in the point list.

14 ECS/SDR User Interface

User Manual ECS/SDR User Interface

When a point selection command is issued, the Point List is started if it is not
running.

Point Selection Procedure


1.

Activate the text field or data cell that accepts a point name entry by
clicking in the display element.

2.

Click on the appropriate point selection command:

Selected Point The name of the selected point in the point list is
placed into the active display element.

Previous Point The name of the point prior to the selected point in
the point list is placed into the active display element.

Next Point The name of the point after the selected point in the
point list is placed into the active display element.

User Manual ECS/SDR User Interface

ECS/SDR User Interface 15

Glossary of Terms

banner area
The area located along the top of a display window. Also called the title area.
The banner area includes the name of the application or dialog form.

launch
Start an application

title area
The area located along the top of a display window. Also called the banner area.
The title area includes the name of the application or dialog form.

clipboard
The clipboard is a copy/paste buffer. Information placed in the buffer with the
Copy or Cut commands can be placed in other applications by using the Paste
command.

mouse pointer
The mouse pointer is a display element that identifies the current mouse location.
The mouse pointer moves on the screen as the mouse is moved.

active program
The program associated with the display window being used. The display
window being used is said to have focus.

User Manual ECS/SDR User Interface

Glossary of Terms 17

Index

Error! No index entries found.

User Manual ECS/SDR User Interface

Index 19

User Manual

SDR Language Selection

FLS Automation A/S


Hffdingsvej 77
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 4
$Modtime:: 7/03/01 3:21p
MUS
$Author:: Ngb
$Workfile:: SdrLangCfgUi30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further
and future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
Language Configuration.......................................................................... 1
Introduction ................................................................................................................................ 1
Language Configuration............................................................................................................. 2
Language Selection .................................................................................................................... 3

Glossary of Terms.................................................................................... 5
Index.......................................................................................................... 7

User's Manual for SDR Language Configuration

Contents i

Language Configuration

Introduction
The information displayed in ECS dialog forms can be presented in one of two
languages. The two languages are referred to as the local language and the
default language. The local and default languages are assigned by using the
Language Configuration utility. An operator can then select the desired
langauge by using the Language Selection utility.

User's Manual for SDR Language Configuration

Language Configuration 1

Language Configuration
To assign the default and local languages, select Language Configuration from
the desktop Start menu.

Select the desired languages from the appropriate list boxes. The Default
language is the language initially used for all accounts. The Local language is
the second language available for assignment by the workstation operator.
The Language file folder text field indicates the location of the language
database.
If This form in English is enabled, the information in this window is presented
in the English language. If the field is disabled, the information in this window
is presented in the Default language assigned to the workstation.

2 Language Configuration

User's Manual for SDR Language Configuration

Language Selection
To select a language, start the Language Selection utility from the desktop
Start menu.

Used the option buttons to select the desired language: Local or Default.

The language selection applies to the workstation where the assignment is made.
Each ECS workstation can have a separate language assignment.

User's Manual for SDR Language Configuration

Language Configuration 3

Glossary of Terms

User's Manual for SDR Language Configuration

Glossary of Terms 5

Index

Error! No index entries found.

User's Manual for SDR Language Configuration

Index 7

User Manual

ECS/SDR Point List

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 3
$Modtime:: 7/17/01 4:41p
hct
$Author:: Ngb
$Workfile:: SDRPointListUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further
and future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved

Contents
Point List................................................................................................... 3
Introduction ................................................................................................................................ 3
Point List Display Description ................................................................................................... 4
Toolbar Commands............................................................................................................. 5
Status Bar ............................................................................................................................ 5
Point List Form ................................................................................................................... 5
Search Criteria Form........................................................................................................... 7
Maintenance Form ............................................................ Error! Bookmark not defined.
Favorites Form .................................................................................................................... 9

Glossary of Terms.................................................................................. 10
Index........................................................................................................ 11

User's Manual for SDR Point List

Contents i

Point List

Introduction
The Point List display is used to locate and review limited information for any point
in the ECS point database. The utility is also used in conjunction with other ECS
utilities to provide a convenient means to locate and select points for review or
modification.

User's Manual for SDR Point List

Point List 3

Point List Display Description


The Point List is accessed by clicking on Point List in the desktop Start menu. The
application can also be started from other ECS applications.

The Point List window includes a toolbar commands, four tab forms and a status bar.

4 Point List

User's Manual for SDR Point List

Toolbar Commands

Places the name of the selected point into the Windows Copy/Paste buffer.
The copied point code can then be pasted into text fields located in other displayes or
ECS applications. The selected point is identified by the arrow to the left of the point
code in the Point List display.
Used to display the OnLine Help document

Status Bar
The status bar provides additional information for the selected point. From left to
righ the information includes the selected point code, the department to which the
point is assigned, the conversion algorithm assigned to the point, and the interface
type associated with the point

Point List Form


The Point list tab is used to locate points within the ECS database. The form lists all
points in the ECS database unless a criterion has been specified in the Search Criteria
form. Refer to Search Criteria Form.

Point List Table


The point list table headings are described as follows:
Type Point type (A or B)
Point code Name of the point
Point text Text description assigned to the point
Group No Group to which the point is assigned
Alg No Corresponds to the number that appears next to the algorithm name in the
Point Configuration utilitys Conversion algorithm field.
IF Type Corresponds to the number that appears next to the interface name in the
Point Configuration utilitys Interface type field.

User's Manual for SDR Point List

Point List 5

Selecting Points
A point is selected by clicking the left mouse button on any information associated
with a point. The arrow at the left of the display moves to the selected point. A point
can also be selected by using the record selector.

The selected point is used as a reference when the following toolbar commands are
used in other ECS applications. When any of the point selection commands are
pressed, a point name is copied from the Point List utility and pasted into the active
display element (text field or data cell) of the ECS application. The point name
copied and pasted depends on the command used and the point that is currently
selected in the Point List utility.

Selected Point The name of the selected point in the point list is placed into
the active display element.
Previous Point The name of the point prior to the selected point in the point
list is placed into the active display element.
Next Point The name of the point after the selected point in the point list is
placed into the active display element.

6 Point List

User's Manual for SDR Point List

Point List Commands


The Search command is used to reissue the search as defined in the Search Criteria
form. Refer to Search Criteria Form. The Refresh command performs the same
function. Either command can be used to refresh the list in the event points are added
to the system. The Add to Favorites command places the point name on the
Favorites List. Refer to the Favorites Form.

Search Criteria Form


The Search Criteria tab is used to locate points within the ECS Point Database. The
search criterion is defined by enabling a checkbox and entering the appropriate
information to the right of the selection. For example, to list all points in Department
1, enable the Department checkbox and select Department 1 from the selection list.

Multiple criteria selections can be enabled. To disable a criteria selection, click on


the checkbox. A selection must be enabled before it is used in the point search. The
following describes the criteria selections.
Group To locate points in a specific group. Choose the department from the
selection list.
Point code To locate points by name or partial name. Enter the name in the text
field. The asterisk (*) can be used as a wildcard. For example, a Dop* entry locates
all points whose name begins with Dop.

User's Manual for SDR Point List

Point List 7

Point text To locate points by point text or partial point text. Enter the point text to
locate in the text field. The asterisk (*) can be used as a wildcard. For example, a
*Raw Mill* entry locates all points whose point text includes Raw Mill (but not at
the beginning or end).
Point type To list all A or B-points. Choose the desired option.
Conversion alg To locate points with a specific conversion algorithm, choose the
algorithm from the selection list. This option does not appear unless the Point type
search criteria is enabled.
Interface type To locate points associated with a specific interface. The choices
that appear in the selection list depend on the I/O system drivers installed on the ECS
system.
Order by
The Order by parameter allows the user to specify how the point
list is to be presented. The choices include Point number, Point code, and Group.
All points To display all points in the ECS point database
After all choices are enabled and the search criteria defined, click on the Search
command. The Point List tab form opens listing the points that satisfy the defined
criteria.

8 Point List

User's Manual for SDR Point List

Favorites Form
The Favorites tab form is used to maintain a list of points most often referenced or
points currently being referenced for analysis purposes. The list enables the user to
select points without searching or typing a point name.

Adding Points to the Favorites List


A point can be added to the Favorites List using any of the following methods

User's Manual for SDR Point List

Type the name of the point in the Enter Point text field, and then press the
Add command.

Copy a point name to the Windows Copy/Paste buffer from any other ECS
application. Click the right mouse button in the Enter Point text field and
select Paste.

Select a point in the Point list tab form and click on the Add to Favorites
command. Refer to Point List Commands.

Click on the Add to Favorites command


several ECS applications.

located in the toolbar of

Point List 9

Modifying the Favorites List


First, select a point in the list to modify by clicking on its name. The selection is
highlighted and the name of the point is placed in Enter Point text field. Click on the
Delete command to remove the point from the list.
To modify the name of the point, make the changes in the Enter Point text field and
click on the Change command.
To arrange points in the list, select the point to move and click on the Move Up or
Move Down commands. The point name is moved up or down one position with
each click.

Glossary of Terms

10 Glossary of Terms

User's Manual for SDR Point List

Index

Error! No index entries found.

User's Manual for SDR Point List

Index 11

User Manual

SDR Point Parameters

FLS Automation A/S


Hffdingsvej 77
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 5
$Modtime:: 11/07/01 10:06a
hct
$Author:: Ngb
$Workfile:: SDRPointParUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further
and future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
SDR Point Parameters ............................................................................. 3
Introduction ................................................................................................................................ 3
Toolbar Commands............................................................................................................. 4
Point Parameters and Real-Time Data ................................................................................ 4

A-Point Information .......................................................................................... 4


B-Point Information .......................................................................................... 4
Point Command................................................................................................................... 6
General Form ...................................................................................................................... 7
Statistics Form..................................................................................................................... 8

A-Point Statistics ................................................................................................ 8


B-Point Statistics................................................................................................. 9
Operator Inserted Form..................................................................................................... 10

Operator Inserted A-Point..............................................................................10


Operator Inserted B-Point ..............................................................................11
Glossary of Terms.................................................................................. 12
Index........................................................................................................ 13

User's Manual for SDR Point Parameters

Contents i

SDR Point Parameters

Introduction
The Point Parameters display provides real-time information for any point in the ECS
point database. The display is also used to modify various configuration parameters
assigned to the point and values to operator-inserted points.

User's Manual for SDR Point Parameters

SDR Point Parameters 3

Toolbar Commands
The toolbar commands located at the top of the display are used to initiate various
functions.
Launches the Point List utility. Refer to the online help document for the Point
List application.
These commands work in conjunction with the Point List utility and
are used to select a point for display. Refer to the online help document for the Point
List application.
The name of the point currently displayed in the Point Parameters display is
added to thePoint List Favorites List. Refer to the online help document for the Point
List application.
Launches the ECS Alarm List utility.
Launches the ECS Trend utility.
Launches OpStation to set up the homepicture for the point
Provides online help for the Point Parameters display utility.

Point Parameters and Real-Time Data


The top portion of the Point Parameters display provides database information and
real-time values for the selected point .

A-Point Information
The top, from left to right, identifies the pointcode, the point number, the current
point value, the current status and the current color. The middle row, from left to
right, provides the point text and department to which the point is assigned. The
bottom line provides the point group.

B-Point Information
The top, from left to right, identifies the pointcode, the point number, the current
point value, the current status and the current color. The middle row, from left to
right, provides the point text, the department to which the point is assigned, and the
current .Machine Status Word (MSW). The bottom line provides the point group.

4 SDR Point Parameters

User's Manual for SDR Point Parameters

User's Manual for SDR Point Parameters

SDR Point Parameters 5

Point Command
The Point command is used to specify a point for display.

When the command is pressed, the Select Point window appears. Enter the name of
the point to display or select a point from the menu.

6 SDR Point Parameters

User's Manual for SDR Point Parameters

General Form
The Point Parameter General tab is used to review or modify various configuration
parameters for the selected point. The General tab for a B-point is shown below.

Alarm suppressed To suppress the reporting of alarms for this point, select the Yes
option. To allow alarms to be reported for this point, select the No option. When Yes
is selected, the point is operator alarm suppressed (OpAlmSup).
Interval size The interval size is the amount a point value must increase or decrease
while in alarm before a new higher or lower level alarm is reported.
Hysteresis The hysteresis is the amount the point value must be out of alarm before
an out of alarm condition is reported.
Alarm Limits The High and Low alarm limits define the point values that will
trigger an alarm.
Graphical The High and Low graphical limits define the values used for the high
and low indicators on display elements owned by this point.
Normal The Normal entry define the values used for the normal indicator on
display elements owned by this point.
Total operating hours The total operating hours for B-points. The format is
<days>+<hour>:<min>:<seconds>. So if you want 5 days and 4 hours and 12
minutes and 34 seconds, then enter 5+04:12:34

User's Manual for SDR Point Parameters

SDR Point Parameters 7

Statistics Form
The Point Parameter Statistics tab is used to display the statistics for the selected
point. The display that appears depends on the type of point (A-point or B-point).

A-Point Statistics
The A-point statistics display shows the selected points current and previous
statistical values for the previous hour, shift, and day. The Current statistics are
maintained in memory and are updated each time the point is processed. The
Previous statistics are the last values that were saved to the statistical log the
previous hour, previous shift, and previous day.

Minimum The minimum value recorded for the specified time period
Average The average value recorded for the specified time period
Maximum The maximum value recorded for the specified time period
Calc. by report alg. The value calculated by the report algorithm for the specified
time period
Alarm time The amount of time the point was in alarm in the specified time period
Alarm count The number of alarms reported for the specified time period

8 SDR Point Parameters

User's Manual for SDR Point Parameters

Error count The number of errors reported for the specified time period

B-Point Statistics
The B-point statistics display shows the points statistical values for the current and
previous hour, shift, and day. The Current statistics are maintained in memory and
are updated each time the point is processed. The Previous statistics are the last
values that were saved to the statistical log the previous hour, the previous shift, and
the previous day.

Operating hours The number of hours the B-point was in a state defined as
operating for the specified time period
Total operating hours For the current statistics, the total number of operating hours
since report hour. For previous statistics, the total number of operating hours from
the daily statistical log file. The format is <days>+<hour>:<min>:<seconds>
Alarm time The amount of time the point was in an alarm state in the specified time
period
Alarm count The number of alarms reported for the specified time period
Error count The number of errors reported for the specified time period

User's Manual for SDR Point Parameters

SDR Point Parameters 9

Operator Inserted Form


The Point Parameter Operator Inserted tab is used to assign a value to an operator
inserted point. The display that appears depends on the type of point (A-point or Bpoint).

Operator Inserted A-Point

Last entered Read only text fields that display the Time of the last entry and the
Value entered.
New entered The Time text field is a read only field that displays the time that will
be assigned to the value entry when the Apply command is issued. The Value text
field is used to enter the value to be assigned to the operator inserted point.
After a Value is entered in the text field, click on the Apply command to assign the
value to the A-point. The range of allowable values can be set using point constants
C9 and C10 (low and high range respectively). A value of zero for both of these is
the same as no range limiting.

10 SDR Point Parameters

User's Manual for SDR Point Parameters

Operator Inserted B-Point

Last entered Read only text fields that display the Time of the last entry and the
Value entered.
New entered The Time text field is a read only field that displays the time that will
be assigned to the value entry when the Apply command is issued. The Value menu
is used to select a value to be assigned to the operator inserted point.
After a Value is selected, click on the Apply command to assign the value to the Bpoint.

User's Manual for SDR Point Parameters

SDR Point Parameters 11

Glossary of Terms

Homepicture
Homepicture is an OpStation picture associated a point. The homepicture association
is defined in the OpStation Configuration utility.

12 Glossary of Terms

User's Manual for SDR Point Parameters

O
Operating hours 8

Index

P
Point 310, 3

S
Statistics 78

T
Total operating hours 8

A
Alarm count 78
Alarm limits 6
Alarm suppressed 6
Alarm time 78
Average 7

C
Calculated 7

E
Error count 7

G
General 6
Graphical 6

H
Hysteresis 6

I
Interval size 6

L
Last entered 910

M
Maximum 7
Minimum 7

N
New entered 9, 10
Normal 6

User's Manual for SDR Point Parameters

Index 13

User Manual

SDR Alarm Header

FLS Automation A/S


Hffdingsvej 77
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 4
$Modtime:: 10/10/01 2:44p
hct
$Author:: Taa
$Workfile:: SDRAlarmHeadUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further
and future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
SDR Alarm Header ................................................................................... 3
Introduction ................................................................................................................................ 3
Program Overview ..................................................................................................................... 3
Tool Bar Commands .................................................................................................................. 4
Department Buttons.................................................................................................................... 4

Department Status.............................................................................................. 5
Selecting Departments ....................................................................................... 5
Alarm Notification ..................................................................................................................... 6
Alarm Response ......................................................................................................................... 7
Alarm Header Configuration...................................................................................................... 7

Glossary of Terms.................................................................................. 11
Index........................................................................................................ 13

User's Manual for SDR Alarm Header

Contents i

SDR Alarm Header

Introduction
The Alarm Header utility is a multifunctional display element used to notify an
operator of alarm conditions. The utility also provides commands to respond to
alarms, select departments and access other ECS utilities.

The Alarm Header is started from an ECS/SDR application like OpStation or


from the Windows START menu.

Program Overview
When the Alarm Header is started, it appears at the top of the workstation desktop.
The display includes department buttons, toolbar commands, the selected department
field at the right of the display, and the most recent alarm entry at the left.

The utility can be configured to "stay on top" and to be unmovable. The position on
the screen is saved when exiting.

User's Manual for SDR Alarm Header

SDR Alarm Header 3

Tool Bar Commands


Alarm Silence Used to turn off the audible alarms
Alarm Reset Resets alarms.
Alarm List for Selected Department Opens the Alarm List and displays
alarm log entries for the selected department.
Alarm List for Department in Alarm Opens the Alarm List and displays
alarm log entries for the department currently in alarm or the last department in
alarm.
Alarm List for Point in Alarm Opens the Alarm List and displays alarm log
entries for the point currently in alarm or the last point in alarm.
Point Parameters Opens the Point Parameters display for the point currently
in alarm or the last point in alarm.
Trend Log Opens the Trend Log display for the point currently in alarm if this
point is an A-point.
Homepicture Opens OpStation to set up homepicture for the point currently
in alarm or the last point in alarm.
Alarm Header Configuration Opens the Alarm Header Configuration
display. Refer to Alarm Header Configuration
Help Opens the on-line help information for the Alarm Header.

Department Buttons
The Alarm Header department buttons are labeled with the department name or with
the department number. In addition to the department buttons that identify PLC
departments, there is the System department button and the Plant button. The PLC
department buttons are used to select departments for specific actions and provide an
indication of the status of the individual department.
The system department is associated with system type alarms (file errors,
communication errors, etc.) and the Plant department is used to indicate an alarm in
any PLC department. The Plant department is also used to select all departments
when all plant alarms are to be silenced or reset.

4 SDR Alarm Header

User's Manual for SDR Alarm Header

Department Status
The colors used to indicate the status in a department button are defined in the Alarm
Configuration utility. Refer to the Alarm Configuration on-line help document. The
possible status indications are:
Normal Status The department does not contain a point in alarm. Typically
gray is used to indicate a normal status.
Alert Status The department currently has a point in the alarm state and the
alarm has not been silenced. Typically red is used to indicate an alert status.
Silence Status Department alarms have been silenced. Typically green is
used to indicate a silence status.
Inactive Status Alarms in this department are not reported to this
workstation. In addition, the department can not be selected for other
purposes. The button text is light grey to indicate an inactive status.

Selecting Departments
A department is selected by clicking on the department button. A colored bar appears
over the selected button. Typically magenta is used to indicate a selected department.
The name and number of the department currently selected appears on the right side
of the Alarm Header display

User's Manual for SDR Alarm Header

SDR Alarm Header 5

Alarm Notification
When a point goes into alarm, an alarm entry in red text appears in the left portion of
the Alarm Header. The entry includes the point code, the point description, the type
of alarm, the alarm limit exceeded, the point value when the alarm was reported, and
the time and date of the alarm.

The department button associated with the point in alarm changes to red and the
workstations audible alarm is sounded. Display elements in process graphics owned
by the point in alarm change to flashing red.
When multiple alarms are reported, the most recent alarm is placed in the Alarm
Header.
The colors referenced and the reaction of the workstation display elements assume
that the default alarm philosophy is assigned in the Alarm Configuration utility. Be
aware that the user can modify the alarm philosophy and the color assignments.

6 SDR Alarm Header

User's Manual for SDR Alarm Header

Alarm Response
When an alarm is received, the procedure defined by the default alarm configuration
and philosophy require the operator to issue the Alarm Silence twice and then the
Alarm Reset.

1st Alarm Silence Click on the toolbar Alarm Silence command


. The audible
alarm stops, the department button changes to green, and the Alarm Header entry is
highlighted.
2nd Alarm Silence Click on the toolbar Alarm Silence command
The Alarm Header entry is removed.

a second time.

Alarm Reset Click on the toolbar Alarm Reset command


. The department
button changes to grey. Display elements in process graphics owned by the points in
alarm change to solid red. The display elements change to solid green when the point
value returns to normal.

Alarm Header Configuration


The department alarms that are reported to the workstation and the departments that
can be selected by the user are determined by the assignments made in the Alarm
Header Configuration dialog.

To open the dialog, click on the

User's Manual for SDR Alarm Header

toolbar command.

SDR Alarm Header 7

Dept alarm active


Alarms generated in the highlighted departments are reported to this workstation.
Click on a department name to toggle the checkbox on or off. Click on the All
command to activate all departments and click on the None command to deactivate
all departments.
Only the departments selected in the Dept alarm active list, will appear on as buttons
on the header.

8 SDR Alarm Header

User's Manual for SDR Alarm Header

Alarm button sensitive


The Alarm Header department buttons for the checked departments are enabled and
can be used to select departments. Click on a department name to toggle the highlight
on or off. Click on the All command to enable all department buttons and click on the
None command to disable all department buttons.
Please note that alarms will appear from an insensitive department, but no silence or
reset can be issued.
Sound
Select Yes to enable the audible alarm. Select No to disable the audible alarm.
A checkmark in the Beep only checkbox will disable the sound player and the
internal speaker (or beeper) will be used instead.
The Select sound button opens a file selector, where it is possible to select a standard
*.wav sound file from the local hard drive. Afterwards the Test button is used to play
the sound.
Window not moveable
When this box is checked (and applied) the Alarm Header window will be fixed to
the actual location. Notice, that this checkbox has persistence, i.e. if it is checked
(and applied) and the Alarm Header window is closed and started again, the new
window will also have a fixed location, this time at the top of the screen which is the
default location for an Alarm Header.
Window always on top
When this box is checked (and applied) the Alarm Header window will always be on
top of any other window within that area of the screen. Notice, that this checkbox has
persistence, i.e. if it is checked (and applied) and the Alarm Header window is closed
and started again, the new window will also have the top priority. Note: This feature
has the drawback that the Alarm Header window may hide the window bar of
another window. If that happens, it can be necessary to minimize the Alarm Header
window, move or close the other window, and bring the Alarm Header window up
again.
Confirm program close
If selected the user is asked to confirm program exit.
Only show department number
If selected the department number will be displayed on the department buttons,
instead of the names. This will give room for more buttons.

User's Manual for SDR Alarm Header

SDR Alarm Header 9

Glossary of Terms

Department
A Plant is divided into departments. In the departments there is group, routes, master
points and points.

Homepicture
Homepicture is an OpStation picture associated a point. The homepicture association
is defined in the OpStation Configuration utility.

User's Manual for SDR Alarm Header

Glossary of Terms 11

Index

Selecting Departments 5
Silence Status 5
Sound 8
System 4

T
Trend Log 4

W
Window always on top 8
Window not moveable 8

A
Alarm button sensitive 8
Alarm Header Configuration 4, 6
Alarm Notification 5
Alarm Reset 46
Alarm Response 6
Alarm Silence 46
Alert Status 5

C
Configuration 46
Currently Selected 5

D
Department Status 5
Dept alarm active 7

H
help 45
homepicture 4

I
Inactive Status 5
Introduction 3

N
Normal Status 5

O
Only show department number 8

P
Plant 4
Point Parameters 4
program close 8
Program Overview 3

User's Manual for SDR Alarm Header

Index 13

User Manual

SDR Alarm List

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 10
$Modtime:: 14-12-01 18:02
Torben stradsson
$Author:: Bmr
$Workfile:: SdrBrowserUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
SDR Alarm List........................................................................................... 1
Introduction ................................................................................................................................... 1
Starting the application ................................................................................................................. 1
Application Overview................................................................................................................... 2
The Toolbar............................................................................................................................ 3
The system Tree..................................................................................................................... 6
The Status Bar........................................................................................................................ 7
Navigating.............................................................................................................................. 8

Alarm view .................................................................................................. 9


Alarm Entries ................................................................................................................................ 9
Filtering Alarms .......................................................................................................................... 10
Using the Alarm View ................................................................................................................ 12

Point Status View..................................................................................... 13


Point Entries ................................................................................................................................ 13
Point Filtering ............................................................................................................................. 14
Using Point Status View ............................................................................................................. 14

Point Grid View ........................................................................................ 15


Entries.......................................................................................................................................... 15

Glossary of Terms ................................................................................... 16


Index.......................................................................................................... 19

Doc-To-Help Standard Manual

Contents i

SDR Alarm List

Introduction
The Alarm list application can be used to browse through the system and locate relevant
information about alarm/event history and point status. A system tree offers easy navigation and
the advanced filter options enable the user to find the exact information in a quick and effective
way.
Real-time point status can be viewed, either from a detailed list or from a point grid, which
gives a status overview of thousand of points in a single window.

Starting the application


The application can be started from other applications (like Opstation) or from the
Windows Start menu.
Examples on Icons used for the Alarm list application:

1. Start Alarm list


2. Start Alarm list (selected department)
3. Start Alarm list (department in alarm)
4. Start Alarm list (selected point)

Doc-To-Help Standard Manual

SDR Alarm List 1

Application Overview
The Alarm list application can run in three modes:

Alarm view - show alarm and events

Point status view - show status, value and details for a list of points

Point Grid View - show point status for whole departments

The use of these views is described in the following chapters.


The application has four major elements:

2 SDR Alarm List

1.

Toolbars

2.

Tree

3.

Data View (Alarm List, Point Status View or Point Grid)

4.

Status bar

Doc-To-Help Standard Manual

The Toolbar
The toolbar are used for the following functions:

Tree navigation
There is three navigation buttons for the tree.
Top: Navigate the tree to the top level showing all departments
Up: Navigate tree one level up.
F5: Refresh view (F5 can also be used for this).

Search and settings


When pressing the search and settings button a dialog will fold out. Here it is possible
to do the following:
To search for a point in the tree, enter the point code
and press search. To find a earlier used point, use the
dropdown to the right.
The view size can zoom the views (except
pointview).
The Reset button will resize all columns and setting
to the factory default (for the selected view size).
The default setting is based on a maximized
application with the desktop resolution 1280 * 1024.
Show color bar, show/hides the status color column
from the alarm list and the point status list. When the
color column is hidden in the alarm list, the colors are
shown by coloring the lines.
The Show notes option show/hides the note pad column. If disabled, you will not be
able to se if a note has been written to a point code displayed in the view.
Short time format changes the time format in the dialogs (not in the alarm list it
selves) to 24-Dec 12:00 instead of 12-Dec-2001 12:00:01
To close the dialog, press the close button or the search and setting button.

Changing the View


The view can be changed between:
Alarm view - show alarm and events
Point status view - show status, value and details for a list of points
Point Grid View - show point status for whole departments

Doc-To-Help Standard Manual

SDR Alarm List 3

When the view is changed, the selection in the Tree is kept and the Data view will load
values for that selection. The filter options will change accordingly to the selected
view.

Silence and Reset


Issues the Alarm Silence and the Alarm Reset Command, based on the current selection
in the tree.

Filter functions
When this button is clicked the toolbar will expand covering the filter functions for the
selected view.
Depending on the selected view, the following filter buttons is also active on the
toolbar:
Pending / Active alarms - show only active alarms in the alarm list
Error - Show Alarms
Warning - Show Warning
Information - Show information events

Start Programs
Start the selected program with point/department selected in the status bar. You may
need to enlarge the application for this toolbar to become visible.
Opstation Home Picture
Point Parameters
Point Configuration
Trend
Notepad
Notepad (start new note, with the latest selected alarm line inserted)

4 SDR Alarm List

Doc-To-Help Standard Manual

General application functions


Print - starts print function for the selected view.
Help - show online help.
You may need to enlarge the application for this toolbar to become visible.
The selections on the toolbars are saved when the application are closed.

Doc-To-Help Standard Manual

SDR Alarm List 5

The system Tree


The tree contains the entire system divided into departments, groups, routes, master
points and points.

Plant

Department

Group

Route

Master
Point

A Point

B Point

B-points that are suppression points for an above route or group are shown with a little
lightning symbol in the upper right corner of the icon.
Suppression point
A master point that is suppression point for an above route or group.
Navigation is done thru the keyboard or with
the mouse.
Mouse
Single-click: select element
Double-click: expand/collapse element

Keyboard
Up - Moves one element up (and select it)
Down - Moves one element down (and select it)
Left - Expand element and moves one level down
Right - Collapse element and navigate one level up in the tree.
Page Up - Navigate one page up
Page Down - Navigate on page down
Home - To plant
End - To last element

6 SDR Alarm List

Doc-To-Help Standard Manual

In the Toolbar there is three buttons for navigating the tree:

Top: Navigate the tree to the top level showing all departments
Up: Navigate tree one level up.
F5: Refresh view (F5 can also be used for this).

The Status Bar


The Status bar is placed at the bottom of the application. It contains information about
the current selection and status.

The Fields are (from left to right):


Currently Selected Department
Currently Selected Point
Current status message
Page Status icon - explained below
Record count - show the number of lines in the current scope (including filters)
Activity icon - animated when the application communicates with the server
applications.
The Page Status icon shows where the current view is located in the scope. There are
four different states for this icon:

The whole list is on


the screen

The Top of the list


is on the screen

The list is somewhere in the middle

The List is at the


bottom

(Green)

(Green)

(Grey)

(Dark grey)

The page status icon changes color from green to yellow when alarms are viewed with
the Time Search function activated. This is to indicate that the view is static and no
new alarms are inserted until the time search are cleared, even if the list are at the top.

Doc-To-Help Standard Manual

SDR Alarm List 7

Navigating
The Alarm list and the Point Status List are navigated with a vertical scroll bar and six
buttons.
Go to top - navigates to the top of the list (in the current scope)
Go one page up - moves one page up in the list.
Go one line up - moves one line up
Go one line down - moves one line down
Go on page down.
Go to Bottom - navigate to the last line in the list

The scrollbar can navigate in the list with an analogue feel


The up and down button at the top and bottom of the scrollbar, equals the
one line up/down buttons above.
The grey dragging area of the scrollbar is resized to symbolize the
relationship between the whole list and the part of the list that is visible (one
page). As an example, the scrollbar shown to the left is moved one page
down, in a list of a total of five pages.
Clicking the white area above the dragging area equals pressing the One
Page Up bottom, and below equals One Page Down

8 SDR Alarm List

Doc-To-Help Standard Manual

Alarm view

Alarm Entries
The alarm list shows Process alarm entries, System alarm entries and Event
entries. All though the need of data presentation is different, all alarm and event
are shown in the same view, with the following columns:

Type
Show the Alarm / Event type as icons.
Information

Error,

Warning or

Colour
The colour of the alarm line is shown as a field (For better overview). If this
column is moved out of the view, the alarm lines a coloured instead.
All colours are system specific and configurable.
Id
The Id of the alarm or event. If the alarm is related to a point, this field will show
the point code.
Event Text
The Alarm text can contain various information, depending of the alarm type.
In Time
The time and date that the event occurred

Doc-To-Help Standard Manual

Alarm view 9

Out Time
The time and date of returning to normal state
Note
Shows a pencil if a note has been written in Notepad related to the point code of
this alarm. If this field is double-clicked, Notepad will try to locate and show
related notes.
Priority
The Priority of the alarm. 1= highest, 5=lowest.
Category
The category of the alarm. The categories are system specific, but an example
could be "Electrical"
User
The Login of the user or program.
All fields are updated when pressing the refresh button or [F5]
The columns can be moved and resized and the application will save the
positions when ending.

Filtering Alarms
The alarm list can be filtered to narrow down result, and there by minimizing the
time spent on searching up and down in the list. There is five different type of
filtering in the Alarm list and they can be switched on and off independently.

Pending alarms
The pending alarms button can be toggled either in or out. When the button
is in the 'in' position only alarm that are Active (pending) are shown. When the
button is in the 'out' position, all alarms are shown.

Alarm type
The three alarm types (Error, Warning and Information) can be filtered in or out
individually with the corresponding button. If all three buttons are 'in' all alarms
are shown.
The following filter function will also be available when the filter toolbar is
expanded, using the
button:

10 Alarm view

Doc-To-Help Standard Manual

The Time slider at the bottom of the toolbar will help you to find alarms back in
time. The right position is the present time and the left position is 7 days back. If
you drag the slider to the first mark the alarms shown at the top of the list is 24
hours old.
The slider works in 10 minutes intervals and you can go more than a week back
bu using the time up/down buttons at the upper left of the filter toolbar. One
click down will step the alarms list 7 days back.
As long as the slider are used new alarms will not appear at the top of the list !!
To reset the time search function press the

button.

Category
The category filter is used to filter out all other categories than the selected. The
categories are system specific, but examples could be: Point Specific, Process,
Electrical, Mechanical, System, Communication, Operator, Fuz, Qcx or Cem.
The selection is done as a dropdown, and if the selection says "none", all alarms
are shown (the filter is inactive).

Priority
Show only alarms with the selected priority and above. The selection is done by
clicking the drop-down arrow to the right of the icon and selecting a range. If the
selected Priority is '2', alarms with priority 1 and 2 are shown. The Icon will
always show the lowest priority that is chosen.

Time filter
The time filter can show alarms between two dates. When the Time filter is
selected, the toolbar will be changed.

The Time selector


The time selector gives the opportunity to select a single day (by clicking that
day on the calendar) or selecting an interval of days (by dragging on the
calendar).
The date and time in the 'from' and 'to' fields can be edited by hand to any time
and date for a precise interval.
Press 'Set' OR 'Cancel' to close the Time selector. Only 'Set' will change the time
filter.

Doc-To-Help Standard Manual

Alarm view 11

Using the Alarm View


The Alarm list a dynamically updated when the list are at the top-position. After
navigating in the list (Se Navigating), you should press the 'List Top' button to
ensure that the list is at the top position.
When the 'Page Status' in the status bar is green the list are at the top. (Se details)
When you click on a line, the point or department are shown in the status bar. If
you. at a later time, selects a program like Point Configurator, you will be able to
configure this point.
If you double-click on a line, the tree will navigate to that point and only alarms
for that point will now be shown in the list.

12 Alarm view

Doc-To-Help Standard Manual

Point Status View

Point Entries
The Point Status View is a dynamically updated list of points and values in the
following column:

1. Type - A, B or Master Point (also a B-point)


2. Colour - Point colour, show the state of the point
3. Note - Show if a note has been written in Notepad to this point code.
4. Point Code - the point code
5. Point Text - the point text
6. Value - the current value of the point
7. Status - the current status of the point. Could be hierarchy suppressed (by the
group, route or master point)
8. W/o suppress - the current status of the point it selves, disregarding hierarchy
suppression.
9. MSW - the current machine status word (B points only)
10. Active Route - if the point is a member of one or more routes, this column will
display the active one.
The fields Colour, Value, Status, w/o suppress and MSW are normally updated every
second. The Note field is updated every 5 minutes.
All fields are updated when pressing the refresh button or [F5]

Doc-To-Help Standard Manual

Point Status View 13

The columns can be moved and resized and the application will save the positions
when ending.

Point Filtering
Use the

button to show the point view toolbar.

The Point filter has the following capabilities selectable from a combo box:
None - No filter active
Suppressed status - show only suppressed points (at the current selection in the
tree)
Not Normal status - Show only point that are not in 'Normal' (at the current
selection in the tree)
Operator Alarm Suppressed - Show all point in the system that is Operator
Alarm Suppressed. (The tree will navigate to the top level)
Report Suppressed - Show all point in the system that is Report Suppressed. (The
tree will navigate to the top level)
The filter stays active until 'None' is selected. This can also be done by clicking once
on the point filter button.

Using Point Status View


The user can navigate the point list in the same way the Alarm list is navigated.
When a line is clicked, the point will be selected and used if a program is started from
the toolbar, ex. the Point Configurator.
If the point code is double-clicked the tree will navigate to that point, showing its sub
points (if it is a master point) or just show a single line with the clicked point.
If the Note column is double-clicked, Notepad will open and show notes with the
clinked point code.

14 Point Status View

Doc-To-Help Standard Manual

Point Grid View

Entries
The Point Grid shows the status colour of all the points in one or several departments.
This gives a general overview of the state of the points in the department.

The selection is done by expanding or collapsing the desired departments in the tree.
The details of a point can be viewed either by hovering over it and read the tool-tip or
by clicking it and changing view to the Point Status View. Moving to Alarm view
will show alarms for the clicked point.
The Zoom function in settings dialog will make the points larger or smaller.

Doc-To-Help Standard Manual

Point Grid View 15

Glossary of Terms

A Point
Analogue point

Active alarms
The same as pending alarms

Alarm Reset
Deactivates the alarm.

Alarm Silence
Silence the alarm, but keeping it active.

Alarm view
The mode where alarm and events are viewed

B Point
Binary point

Department
A department contains Groups only.

Group
A group can contain Routes, Master points and points.

Home Picture
OpStation picture associated to a point.

Master Point
Can contain several points in a logical unit. For example this enables you to suppress
sub-points in one shot.

MSW
Machine Status Word

16 Glossary of Terms

Doc-To-Help Standard Manual

Notepad
The Notepad application, enables you to write comments to an alarm or other
event in the system. If the note is related to a point, a pencil icon will mark the
point and alarms to that point, in both the Alarm list and the Point status list.

Pending
Pending alarms is alarms that have not been reset.

Plant
The Plant is the top-level container and consists of departments.

Point Grid View


The mode where a quick overview of point status for many points can be given.

Point status view


The mode where a list of points and there values and status can be viewed

Priority
All alarms has a priority from 1 (high) to 5 (low), to show the alarms inportances

Route
Two or more points can form a route. A point can be member of several routes
but only with one of them active.

Status bar
The information area at the bottom of the screen.

Suppressed
If a point is in a suppressed state, an alarm form the point will not become
active. This could used if the point is in an inactive route or if the operator has
manually suppressed it.

system Tree
The tree in left side of the screen, showing all Departments, Groups, Routes,
Master points and points, in the system.

toolbar
A control with buttons

Windows Start menu


The Start button in the lower left corner of the screen.

Doc-To-Help Standard Manual

Glossary of Terms 17

I
Information 1, 7, 910
Introduction 1

Index

M
major elements 2
Master Point 6, 1314, 1314
modes 2
MSW 13

A
A Point 6
Active Route 13
Alarm Reset 4
Alarm Silence 4
Alarm type 910
Alarm view 23, 9, 12, 15
Application Overview 2

B
B Point 6

C
Category 1011
Changing the View 3
Colour 9, 13, 15

D
dates 11
Department 47, 47, 47, 47, 12, 15

E
Error 4, 910
Event 1, 9
Event Text 9

F
Filter functions 4

G
Go to top 8
Grid 14, 15
Group 67, 13

Navigating 8, 12
navigation 1, 3, 6
Not Normal status 14
Note 4, 10, 1314
Notepad 4, 10, 1314, 1314

O
Operator Alarm Suppressed 14
Opstation Home Picture 4

P
Page Status 7
Pending alarms 10
Plant 6
Point Code 910, 1314
Point Configuration 4
Point Grid View 23, 15
Point parameters 4
Point Status View 23, 1314, 15
Point Text 13
Print 5
Priority 10
Process alarm 9

R
Refresh view 3, 7
Report Suppressed 14
Route 6, 13

S
scrollbar 8
Show Notes 14
Start Programs 4
Starting the application 1
Status 14, 7, 1213, 15
Status Bar 2, 4, 7, 12
Suppressed status 14
System alarm 9
system Tree 1, 6

H
Help 5

T
Time filter 11

Doc-To-Help Standard Manual

Index 19

Toolbar 7, 11, 1415


Tree 16, 16, 12, 14, 15
Tree navigation 3, 7
Trend 4

U
User 1, 1011, 14

V
Value 23, 13

W
Warning 4, 910

Z
Zoom 15

20 Index

Doc-To-Help Standard Manual

User's Manual

ECS/SDR Trend

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 4
$Modtime:: 7/18/01 12:26p
Henrik Brabrand
$Author:: Ngb
$Workfile:: SDRTrendUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further
and future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
Trend

Error! Bookmark not defined.


Introduction....................................................................... Error! Bookmark not defined.
Trend Display Forms ........................................................ Error! Bookmark not defined.
Plot Form .......................................................................... Error! Bookmark not defined.
Toolbar Commands............................................. Error! Bookmark not defined.
Trend Group Text Fields .................................... Error! Bookmark not defined.
Visible Property .................................................. Error! Bookmark not defined.
Trace Window .................................................... Error! Bookmark not defined.
Selected Point ..................................................... Error! Bookmark not defined.
Y-Scale Slider..................................................... Error! Bookmark not defined.
Start Time ........................................................... Error! Bookmark not defined.
X-Scale Slider..................................................... Error! Bookmark not defined.
Status Bar............................................................ Error! Bookmark not defined.
Horizontal and Vertical Zoom Functions ........... Error! Bookmark not defined.
Packages Form .................................................................. Error! Bookmark not defined.
Points Form....................................................................... Error! Bookmark not defined.
Changing Display Limits .................................... Error! Bookmark not defined.
Save Package Form........................................................... Error! Bookmark not defined.
Replace an Existing Trend Package.................... Error! Bookmark not defined.
Save the Current Trend Package as a New PackageError! Bookmark not defined.
Edit Packages Form .......................................................... Error! Bookmark not defined.
Creating Trend Packages .................................... Error! Bookmark not defined.
Modifying Trend Packages................................. Error! Bookmark not defined.
Config Form...................................................................... Error! Bookmark not defined.
Line Color Configuration ................................... Error! Bookmark not defined.
Default Trend horizon......................................... Error! Bookmark not defined.

Glossary of Terms

Error! Bookmark not defined.

Index

Error! Bookmark not defined.

User's Manual for SDR Trend

Contents i

Trend

Introduction
The Trend utility is used to review and analyze historical data in a value versus
time format. The values of up to 8 point codes can be reviewed in a single
display and the utility provides a means to quickly access data for points most
often analysed.

User's Manual for SDR Trend

Trend 1

Trend Display Forms


The forms associated with the Trend utility are used to perform various
functions. To access a form, click on the tab that contains the form name.
Plot Displays historical data for the points assigned to the trend group
Packages A trend package is a pre-defined trend group. Up to 8 points can
be assigned to a trend package and up to 100 trend packages can be created.
The Packages form is used to replace the current trend group with the
points assigned to a specific trend package.
Points Displays a list of the points currently assigned to the trend group
and enables the user to modify the Y-scale limits assigned to each point.
Save Package Provides a means to saves the current trend group as a trend
package.
Edit Packages Used to create new trend packages and modify existing
trend packages.
Config Used to configure the trend colors and default time horizon.

Plot Form
The plot form is used to review and analyse the historical data of the points
assigned to the trend group.

Toolbar Commands
The toolbar commands are used to modify the trace window x-axis and y-axis,
add and remove trend package points, change the information that is displayed
in the trend group text fields, and display a points alarm limits.
Y-scale, pan out. This command is used to reset the Y-scale to the
selected points display limits.
Y-scale, reset zoom. After the Y-scale has been modified, this command
is used to reset the Y-scale to the selected points display limits.
Y-scale, set scale. Enables the user to enter the Y-axis minimum and
maximum values directly.
X-scale, pan out. This command is used to reset the X-scale to the
maximum amount of time allowed by the system.
X-scale, reset zoom. After the X-scale has been modified, this command
is used to reset the X-scale to the maximum amount of time allowed by the
system, but know than 6 month.

2 Trend

User's Manual for SDR Trend

X-scale, set scale. Enables the user to enter the X-axis minimum and
maximum values directly.
These commands are used to temporarily modify the trend
group currently assigned to the trend display. First, select the trend point to be
replaced, then click on the appropriate point selection command. Refer to the
online Help document for the Point List utility.
Removes the point currently selected from the trend group.
When this command is active, the trend group text fields display the
current point value and point code (if space is available) for the associated point.
When this command is active, the trend group text point fields display the
point name and point value (if space is available) of the associated point.
When this command is active, the trend group text fields display the
point text of the associated point.
When this command is active, the trend group text fields display the point
plotted value and point code (if space is available) as it is recorded in the log
file. The values appear in the fields when the mouse pointer is moved across the
trace window. Horizontal and vertical dashed lines appear in the trace window to
identify the logged value location in the graph.
When this command is active, the alarm limits for the selected point
appears in the trace window as horizontal lines at the value level of alarm low
and alrm high.

Trend Group Text Fields


These fields provide information for each point in the trend group. The
information that is displayed depends on the active toolbar command used for
this purpose. The information may include point code, point text, current point
value, or the logged value presented at the location of the mouse pointer. The
text field with the white background is the selected point. Note that the text in
each field is a different color. The color assigned to the point code is the same
color used to represent the point values in the trace window.
A point can be added to the trend group by selecting a blank point location and
clicking on a Point List toolbar command. An existing point can also be replaced
in the same manner by selecting the point to replace and clicking on the toolbar
command.

User's Manual for SDR Trend

Trend 3

Visible Property
The status of the checkbox to the left of each Trend Group text field determines
if the point values of the associated point are plotted in the trace window. If the
checkbox is enabled, the plot values appear in the window. If the checkbox is
disabled, the plot values are removed from the trace window. Click on the
checkbox to toggle the current setting.

Trace Window
The values for all points in the trend group are plotted in the trace window. The
color of the trace corresponds with the color assigned to the point code.

Selected Point
A point is selected by clicking on its associated text field. When a point is
selected, the background of its text field changes to white and the trace window
Y scale is set to the points display limits.
Use the toolbar buttons
the currently selected test field.

to change the point associated with

The command
will fetch the previous point relative to the currently
selected point in the point list.
The command
will fetch the next point relative to the currently selected
point in the point list.
The command

will fetch the currently selected point from the point list.

Y-Scale Slider
The Y-scale is located at the left of the trace window and can be used to move
the Y-scale up or down. The scale can also be adjusted by clicking on the slide
bar up and down arrows. The Y scale indicates the value of the plotted point.
The Y-scale is set to the display limits of the selected point.

4 Trend

User's Manual for SDR Trend

Start Time
The time and date of the start of the logged data appears at the bottom left of the
Plot form.

X-Scale Slider
The X-Scale slider is located below the trace window. This element is used to
change the window start time back in time or forward in time by moving the
slider to the left or right respectively. Use the right and left arrows to make fine
time adjustments. The double right arrows can be pressed to set the time at the
right of the trace window to the current time.

Status Bar
The status bar at the bottom of the Plot form holds the following information.
The fields are described from left to right.

X/Y-Scale Status
This area in the status bar indicates the zoom assignments currently applied to
the X and Y-axis.

Span
The current span and plot frequency appears in this area of the status bar. The
span indicates the amount of time covered by the entire trace window. The plot
frequency indicates the resolution of the plotted values. That is, the amount of
time represented by a single plotted point.

Trend Package Name


The name of the current trend package.

Current Time
The current date and time

User's Manual for SDR Trend

Trend 5

Horizontal and Vertical Zoom Functions


The user can zoom in on trace window data by adjusting the X and Y-scale
assignments using the toolbar commands or the X and Y axis sliders. The user
can also zoom in on the plot data by using the mouse pointer and the following
procedures.

X-Axis Zoom
To zoom in on the X-axis:

Define the area to be zoomed by clicking and holding the left mouse button
on one edge of the area.

Move the mouse pointer to the opposite edge of the zoom area and release
the mouse button. Note that the point values and associated time and date
appear in the status bar as the mouse is moved. This can be used when
trying to locate a specific time in log data.

When the mouse button is released, the trace window is redrawn with the
start time equal to the left-most point selected and the end time is equal to
the right-most point selected.

Y-Axis Zoom
To zoom in on the Y-axis:

Define the area to be zoomed by clicking and holding the left mouse button
on one edge of the area.

Move the mouse pointer to the opposite edge of the zoom area and release
the mouse button. Note that the point values and associated time and date
appear in the status bar as the mouse is moved.

When the mouse button is released, the trace window is redrawn with the Yscale minimum value equal to the bottom-most point selected and the
maximum value is equal to the top-most point selected.

Packages Form
The Packages form is used to open an existing trend package. The available
trend packages are listed in the display. Used the horizontal scroll bar to view all
trend packages (1 250). Select the trend package to open by clicking on its
name. The Packages form closes and the Plot form is opened. The points
assigned to the trend package are assigned to the trend group and historical data
is plotted. The name of the trend package appears in the status bar.

6 Trend

User's Manual for SDR Trend

User's Manual for SDR Trend

Trend 7

Points Form
The Points form is used to review trend group point parameters and change the
operator display limits for an individual point.

Changing Display Limits


To change the operator display limits, click in the Y-max or Y-min field and
press the keyboard <F2> key. Enter the new value. Click on the Apply
command to save the modifications. The display limits are stored along with the
points in the trend package.

8 Trend

User's Manual for SDR Trend

Save Package Form


During data analysis, the trend package currently assigned to the trend group can
be modified by removing points, replacing points or adding points. These
modifications are temporary and are lost as soon as the trend package is
reopened. If the user wishes to save any of these changes to the existing trend
package or a new trend package, click on the Trend utility Save Package tab.

The Save Package form contains 3 lists:

Trend Packages Existing and available trend packages

Current trend package points The points assigned to the trend


package selected in the Trend Packages list.

New trend package points The points assigned to the current trend
group

When the Apply command is issued, the points in the New trend package
points list replace the points in the Current trend package points list. The
name of the new trend package is the name selected in the Trend Packages list.

Replace an Existing Trend Package

User's Manual for SDR Trend

1.

Select the trend package to replace from the Trend Packages list

2.

Click on the Apply command.

Trend 9

Save the Current Trend Package as a New


Package
1.

Click on a trend package location in the Trend Packages list that has
no name. The Current trend package points list should be empty.
Record the trend package number.

2.

Click on the Apply command.

3.

Click on the Edit Packages tab.

4.

Locate and select the trend package number recorded in step #1 from
the Trend Packages list

5.

Click in the Trend Package Name text field and enter the name of the
trend package.

6.

Click on the Apply command located in the Trend Packages frame.

Edit Packages Form


The Edit Packages form is used to create and edit trend packages.

10 Trend

User's Manual for SDR Trend

Creating Trend Packages


To create a trend package, click on the Edit Packages tab. The existing trend
packages are listed in the Trend packages frame. Select a trend package that
has no name assigned by clicking on the number. Perform the following:
1.

Click in the Trend Package Name text field and enter the name of the
trend package. Click on the Trend Packages Apply command.

2.

Click on a point location number located in the Trend package points


frame. In the example, point location 1 is selected.

3.

Click in the Trend Package Point text field and enter the name of the
point to be added to the trend package. Point codes can also be entered
by using the Point List utility toolbar commands.

4.

Click on the Change command. The point name appears to the right of
the selected point location number.

5.

Repeat steps 2 through 4 to add points to the trend package.

6.

To change the location or order of the points in the trend package,


select the point to move by clicking on its name. Click on the Move Up
or Move Down commands until the point is in the desired position.

7.

Click on the Apply command to save the trend package.

Modifying Trend Packages


To modify a trend package, click on the Edit Packages tab. The existing trend
packages are listed in the Trend packages frame. Select the trend package to
modify by clicking on its name. Perform the following:
1.

To change the name of the trend package, click in the Trend Package
Name text field and enter the new name. Click on the Trend Packages
Apply command.

2.

Click on the point location to modify in the Trend package points


frame.

3.

Click in the Trend Package Point text field and replace the existing
point name with the new point name. Point codes can also be entered
by using the Point List utility toolbar commands.

4.

To remove the point name, select the point in the list box, blank the
point in the edit box and press Change. You can also select the point in
the text box and press

User's Manual for SDR Trend

command.

5.

Click on the Change command to save the modifications for the


selected point.

6.

Repeat steps 2 through 5 to modify other points in the trend package.

7.

To change the location or order of the points in the trend package,


select the point to move by clicking on its name. Click on the Move Up
or Move Down commands until the point is in the desired position.

8.

Click on the Apply command to save the trend package.

Trend 11

Config Form
The Configuration window is used to configure various trend window attributes
as described below.

Line Color Configuration


The Line Color Configuration is used to configure the trend line color for the
current account.

Click on the individual color buttons to edit these. Click Reset Colors to return
to defualt settings.

Default Trend horizon


The default trend horizon is used each time the trend application is invoked. If
no default trend horizon is aviable a horizon of 8 hours is used.
The default trend horizon is specific to each user account and is set by
depressing the above shown button "Default". This will only succed if the plot
form has a valid horizon currently shown.

Glossary of Terms

12 Glossary of Terms

User's Manual for SDR Trend

Index

C
Current date 5
Current time 5

P
Point selection 3

S
Status 46
status bar 56, 56

User's Manual for SDR Trend

Index 13

User Manual

SDR Plant Reports

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 5
$Modtime:: 7/16/01 10:06a
Henrik Brabrand
$Author:: Ngb
$Workfile:: SdrReportUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further
and future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
SDR Plant Reports ................................................................................... 3
Introduction ................................................................................................................................ 3
Report Generation ...................................................................................................................... 3
Reports ................................................................................................................................ 3
Report Collections............................................................................................................... 5

Glossary of Terms.................................................................................... 8
Index.......................................................................................................... 9

User's Manual for Plant Reports

Contents i

SDR Plant Reports

Introduction
Periodically, the SDR system saves the values of all A-points and the statistical
information for all points to a historical data file. The historical data can be
reviewed and analyzed by generating plant and shift reports.

Report Generation
To generate a report, select Plant Reports in the desktop Start menu. When the
Report Print window opens, select the desired tab. The Reports tab is used to
generate an individual plant report. The Report Collections tab is used to print
all of the reports assigned to a single collection.

Reports
To generate a report, click on the Reports tab.

User's Manual for Plant Reports

SDR Plant Reports 3

Select the report to print by clicking on its name in the Report column. Use the
vertical scroll bar to locate the desired report if necessary.
To select multiple reports, select the first by clicking on its name or number.
Select the additional reports by performing any of the following:
If the additional report is adjacent to a selected report in the list, press the
keyboard <Shift> key while clicking on the report to add.
Adjacent reports names can also be selected by dragging the mouse over the
reports to select.
If the additional report is not adjacent to a selected report, press the
keyboard <Ctrl> key while clicking on the report to add.
Click on the column titles (Number, Report, or Report Collection) to
select all reports in the list.
Click on the Print command to generate the selected report(s). The Print Report
window appears.

Use the Select Last Day area (month, year and day elements) to define the last
day included in the report period.
Select the Report Type option: Day, Day Shift, or Week Shift. Refer to Report
Types.
Select the No. of Days to Print by clicking on the left or right arrow buttons.
The slider can also be used to enter the number of days. This field is not
available when a Report Type of Week Shift is selected. The No. of Days to
Print entry and the Select Last Day entry determines the report period.
The Print Info frame indicates the report period that will be included in the
report when the Print or View commands are issued. The points included in the
report and the value types used to represent log data are determined by the report
configuration. Refer to the online Help document for Report Configuration. The

4 SDR Plant Reports

User's Manual for Plant Reports

Print Setup command can be invoked to select a printer for the printout. If no
special printer is selected the default printer is used. The Print command sends
the output directly to the selected printer, the View command pops up a new
window showing the report on the screen.
A data value of "?" means that the requested data is not available in the pertinent
log file (log horizon exceeded), or that the Log Server process cannot be
reached, or that the Log Server experienced and error.
A data value of "-" means that no valid data was available in the pertinent log
file, instead a "hole value" was retrieved indicating that the system was not
running at the time that data is being requested from.
A data value of "*" means that no valid data was available in the pertinent log
file for a portion of the requested data. This can happen if the log horizon has
been exceeded for a portion of the data, for example if data is requested from
00:00 to 23:00, but there is only data from 13:00 to 23:00, and not from 00:00 to
12:00.

Report Types
There are three types of reports available to the ECS user - Day reports, DayShift reports, and Week-Shift reports.
Day Report
A day report lists values for each hour of the specified day. Statistical values for
the previous day is also included.
Day-Shift Report
The day-shift report lists values for any or all shifts for the specified day.
Statistical values for the previous day and the accumulated values for each shift
is also included.
Week-Shift Report
The week-shift report lists values for each shift for a specified 7-day period. The
daily totals for each of the 7 days and the weekly statistical information is also
included.

Report Collections
To generate all the reports assigned to a report collection, click on the Report
Collections tab.

User's Manual for Plant Reports

SDR Plant Reports 5

Select the group of reports to print by clicking on its name in the Report
Collection column. Use the vertical scroll bar to locate a collection if necessary.
Click on the Print command to generate the selected collection. The Print
Collection window appears.
Multiple report collections can not be selected.
A report collection can also be selected by double clicking on the report
collection name or number.

6 SDR Plant Reports

User's Manual for Plant Reports

Use the Select Last Day area (month, year and day elements) to define the last
day included in the report period.
Select the No. of Days to Print by clicking on the left or right arrow buttons.
The slider can also be used to enter the number of days. The No. of Days to
Print entry and the Select Last Day entry determines the report period.
Click on the Print command to print the report collection. The reports and types
of reports that are printed are determined by the report configuration. Refer to
the online Help document for Report Configuration.

User's Manual for Plant Reports

SDR Plant Reports 7

Glossary of Terms

8 Glossary of Terms

User's Manual for Plant Reports

Index

P
Print Info 4

R
Report Type 4

User's Manual for Plant Reports

Index 9

User Manual

ECS OpStation

FLS Automation A/S


Hffdingsvej 34
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV7
$Revision:: 6
$Modtime:: 1/18/02 11:28
HB
$Author:: Hb
$Workfile:: SdrOpStationUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
ECS OpStation ........................................................................................... 4
Introduction ................................................................................................................................... 4
ECS OpStation Description .......................................................................................................... 4
ECS OpStation Startup .......................................................................................................... 4
Menu Commands................................................................................................................... 4
Status Bar............................................................................................................................... 4
Tool Bar ................................................................................................................................. 4
Function Keys........................................................................................................................ 4
Mouse..................................................................................................................................... 4
Graphic Displays........................................................................................................................... 4
Softbuttons ............................................................................................................................. 4
Picture Back........................................................................................................................... 4
Popup Windows..................................................................................................................... 4
Faceplates............................................................................................................................... 4
Closing Popup and Faceplate Windows................................................................................ 4
Graphic Display Elements ............................................................................................................ 4
Display Element Behavior..................................................................................................... 4
Point Value Entry Element.................................................................................................... 4
Thermometer Elements ......................................................................................................... 4
Trend Element ....................................................................................................................... 4
Slider Element ....................................................................................................................... 4

Glossary of Terms ..................................................................................... 4


Index............................................................................................................ 4

User's Manual for OpStation

ECS OpStation 3

ECS OpStation

Introduction
The ECS OpStation application presents process graphics to the SDR system
operator. These graphics, also called pictures, models and mimic displays, include
display elements that are used to monitor and control the plant operation. The details
associated with the ECS OpStation are described in the following sections:

User's Manual for OpStation

ECS OpStation Description

Graphic Displays

Graphic Display Elements

ECS OpStation 5

ECS OpStation Description


ECS OpStation Startup
The ECS OpStation is started by selecting ECS OpStation in the desktop Start
menu. When the application starts, a process graphic previously assigned as the top
model is opened. The Topmodel is assigned through the ECS OpStation
Configuration Utility or locally from the Options menu.
Typically, the ECS OpStation utility is automatically started when the user logs into
the flsa account.

6 ECS OpStation

User's Manual for OpStation

Menu Commands
The commands available in the OpStation menu bar are used to open process
graphics, modify the appearance of the OpStation window and start other SDR
applications.

Picture Menu
Open Locate and open a graphic file. Requires the Ops_AllowOpen right.
Print Generate a printout. Four types of objects may be printed:
Picture Print the current picture only. The title area is not printed.
Window Print the main window including the title area.
Application Print the main window and all popups
Screen Print the entire desktop
Print Setup.. Change print parameters. Printer, number of copies, layout, etc,
Print on White Background Change background color to white while printing
Top Open top model picture
<Most Recently Used Items> Any one of the most recently used graphic files
can be opened by selecting its name from this list. Requires the Ops_AllowOpen
right.
Refresh All Force data servers to refresh cached data. Can be used after changing
configuration data. Adding points to ECS or other configuration stuff.
Exit Close the ECS OpStation application.

Alarm Menu
Silence Turn off the audible alarm for the current department.
Reset Reset all alarms associated with the current department.
Dep. Alarm List Open the Alarm List for the current department.
Point Alarm List Open the Alarm list for the selected point.

Control Menu
Select Send select command to PLC for selected point (group or device). The
devices selected in this manner are affected by a subsequent start or stop command.
Start Send start command for all selected groups and devices
Stop Send stop command for all selected groups and devices
Quick Stop Send quick stop command for the current department. All equipment
will be stopped immediately.
Master Stop Send master stop command for the current department. All equipment
will be stopped in a manner described by the PLC program.

Trend Menu
Trend Package Open the SDR Trend display.
Point Trend Open the SDR Trend display with the selected point assigned to the
trend set.

User's Manual for OpStation

ECS OpStation 7

Point Menu
Point List Open the SDR Point List
Add to Favorite List Add the selected point to the global list of favorite points.
This list can be accessed by other SDR applications.
Point Parameters Open the SDR Point Parameters display for the selected point.
Point Configuration Open the point configuration display for the selected point.

Options Menu
Show Status Bar Display or Remove the ECS OpStation status bar. Requires
Ops_AllowOptions right.
Show Tooltips Do or do not display point code tooltips on the pictures. Requires
Ops_AllowOptions right.
Use Mid Mouse Button for Control Select If checked, a click on the mid
button on a display element will send a select command to the PLC if applicable to
the owner point. Same function as Select from Control Menu. If not checked, the
faceplate (if any) associated the display element will be displayed. Requires
Ops_AllowOptions right.
Use Double Click As Mid Mouse Button If checked, double click will behave
like mid mouse button click. Should be checked if the mouse only have two buttons.
Requires Ops_AllowOptions right.
Auto Close Faceplates If checked, currently open faceplates and popup
windows will automatically be closed when the picture in main window is
changed. Requires Ops_AllowOptions right.
Use Default Topmodel Set Topmodel to be the one assigned through ECS
OpStation Configuration for the workstation. Requires Ops_AllowOptions right.
Set Current Picture As Topmodel Set Topmodel to be the currently displayed
picture. Requires Ops_AllowOptions right.

Toolbar menu
Left Select to show toolbar left. Requires Ops_AllowOptions right.
Right Select to show toolbar right. Requires Ops_AllowOptions right.
Top Select to show toolbar at the top. Requires Ops_AllowOptions right.
Hide Select to hide the toolbar. Requires Ops_AllowOptions right.
Use large toolbar icons If checked the icons are 32x32 else the are 16x16.
Requires Ops_AllowOptions right.
Customize Customize the toolbar. Requires Ops_AllowOptions right.

Help menu
Help Topics Access the ECS OpStation help system.
About OpStation Display the ECS OpStation version

Status Bar
The status bar at the bottom of the OpStation display window are described from left
to right.

8 ECS OpStation

User's Manual for OpStation

Department Displays the name of the current department. Each graphic is


associated with a department. When the graphic is opened, the graphics department
becomes the selected department.
Point Code Displays the point code of the selected point. A point is selected by
clicking on display element associated with the point.
Point Text Displays the point text of the selected point.
Point Value Displays the current value of the selected point.
Point Status Displays the current status of the selected point.
Io Control Displays the latest Io operation sent from OpStation
Error Displays the last error detected in a picture.
Right Double clicking on the status bar will bring up a error box with the errors that
occurred when a picture was loaded and the errors that happened in the last scan. The
error box is modal.

User's Manual for OpStation

ECS OpStation 9

Tool Bar
The tool bar provides a convenient way to initiate OpStation commands. To view the
command associated with a button, place the mouse pointer over the button for a few
seconds. A small window appears displaying the name of the toolbar command.
The toolbar can be moved anywhere within the OpStation display window. To move
the toolbar, click within the button area and drag the bar to the desired location. The
toolbar can also be resized in the same manner as a window is resized.
The toolbar can be configured by double clicking on a separator. (Requires the
Ops_AllowOptions right)
The buttons of the tool bar are defined as follows.
Open Topmodel
Open Graphic
Print Graphic
Send select command to PLC for selected group or device. The devices
selected in this manner are affected by a subsequent start or stop command.
Send start command for all selected groups and devices
Send stop command for all selected groups and devices
Send quick stop command for the current department. All equipment will be
stopped immediately.
Send master stop command for the current department. All equipment will be
stopped in a manner described by the PLC program
Turn off the audible alarm for the current department.
Reset all alarms for the current department
Open the alarm list for the current department
Open the alarm list for the selected point
Open the alarm list for the selected points group.
Open the SDR Trend display
Open the SDR Trend display with the selected point assigned to the trend
group
Open the SDR Point List
Add the selected point to the favorite points
Open the SDR Point Parameter display for the selected point

10 ECS OpStation

User's Manual for OpStation

Open the SDR Point Configuration display for the selected point
Open the ECS Note Pad and display notes for the selected point
Open the online help file

Function Keys
The keyboard function keys provide shortcuts to certain menu items. The following
function keys are used:
F1 Help
F5 Reset
F7 Control Start
F8 Control Stop
F9 Alarm Silence
F10 Alarm Reset
F12 Open Topmodel

Mouse
Either a 3-button mouse or a 2-button mouse may be used. For a 2-button mouse the
Options/Use Double Click as Mid Mouse Button can be set.
The buttons are used as follows:
Left button (LMB) is used to activate buttons, menus, window operations and to
select display elements in the graphic pictures.
Mid button (MMB) is used to set up a faceplate associated the display element
clicked upon. However, if Options/Use Mid Mouse Button for Control Select
is set, a control select command will be executed, if applicable to the display element.
Right button (RMB) is used to activate a popup menu related to the display
element clicked upon. If clicked in a place on the picture where there is no display
element (background) the previous picture will be displayed.

User's Manual for OpStation

ECS OpStation 11

Graphic Displays
Many graphic displays are created to present multiple levels of detail for different
plant areas or departments. These displays are arranged in a hierarchy. The operator
navigates the hierarchy by clicking on display elements with the workstation mouse.
The top of the display hierarchy is the top model that is started when the ECS
OpStation is initialized. The hierarchy is navigated from this point by clicking on
display elements called softbuttons.

Softbuttons
Softbuttons are graphic elements that appear like push buttons. When these buttons
are pushed a process graphic or a popup window assigned to the softbutton appears.
The new display allows the user to view multiple levels of detail or different areas of
the plant.
The text information on the softbutton identifies the display that is opened when the
button is pushed. To open a display, move the mouse pointer to the softbutton and
press the left mouse button. The first graphic (parent graphic) closes and the graphic
identified by the name on the softbutton opens.

Picture Back
Click the right mouse button in the background area of graphic to return to the parent
graphic. If you click the right mouse button on a display element you can select
Picture Back from the popup menu to return to the parant graphic.

Popup Windows
A softbutton that opens a popup window appears as any other softbutton. When this
softbutton is pressed, a popup window appears, but the parent graphic remains open.
Both displays can be viewed and used at the same time. The popup window normally
provides special control symbols for the area of the graphic where the popup
softbutton resides.

12 ECS OpStation

User's Manual for OpStation

Faceplates
Unlike normal popup windows which are activated by click on softbuttons, faceplates
are activated by click with mid mouse button on a display element with an associated
owner point.
Faceplates are popup windows that display information related to the display element
from where it was activated.

If a faceplate is resized (by dragging the border), the new size will apply to any
subsequent activation of the same faceplate, also next time OpStation is started. The
same is true for normal popup windows.
Faceplates are brougth in focus by click in the window.
Faceplates are associated with display elements either directly through the ECS
OpStation Editor or indirectly via the point algorithm. The latter is defined through
the ECS OpStation Configuration utility. If the display element has a faceplate
directly associated, this will be used, otherwise the faceplate associated the point
algorithm will be used.

Closing Popup and Faceplate Windows


Popup windows and faceplates are closed by clicking on the close
button

at the top right of the window.

If the option "Auto Close Faceplates" is set in the Options menu, then all popup
windows and faceplates will be closed automatically when another picture in the
main window is changed.

User's Manual for OpStation

ECS OpStation 13

Graphic Display Elements


A process graphic consists of drawing objects and symbols called display elements.
These elements are used to represent instrumentation and equipment throughout the
plant operation. There are two types of mimic display elements: dynamic and static.
A dynamic display element connects to a process device through the ECS system
software. The dynamic element reflects the current status of the device, for example
by changing color or updating text. Static display elements are used to present a
schematic view of the process area. Static elements do not change and are intended to
provide a familiar representation of the process and process equipment to the
OpStation user.

Display Element Behavior


A dynamic display element is connected to the process by assigning the element to a
database point. When this assignment is made, the point is referred to as the owner of
the display element. When the mimic display is activated, the type, status and value
of the database point determine the behavior of the display element.
Display element behavior falls into two categories: output behavior and input
behavior. The output behavior is how the appearance of the element changes when
the owner point changes value or status. The input behavior is the action initiated
when the user clicks on the element with a mouse button.

Output Behavior
The type of element determines the output behavior of a dynamic element. A point
value can be shown as a text string (123.45 Deg C) or as a percentage in a bar graph.
The value (for B-points) can be displayed as a text string (RUN) or the color of the
symbol itself can indicate its value (Running = Green; Stopped = Brown; etc.).
Point Values
A - points are displayed as numeric values along with the engineering units (30.7%).
The value of a B-point is shown as a text string (RUN or SEL). The color of the text
or numeric value indicates the point status.
Point Status
Text strings, values, or symbols, associated with a point, change color to signify the
current status of the connected device. In general, green indicates a normal condition
and flashing red indicates an alarm state. The flashing red changes to solid red after
the alarm is acknowledged.
The colors used to indicate the current status of point can be configured to meet the
specific needs of the user. The colors described in this manual are the default color
assignments.

Input Behavior
During system operation, the OpStation user can initiate specific actions by clicking
on a mimic display element. The action that takes place is dependent upon the input
behavior of the element and the mouse button that is used. An input action is used to
select a point or initiate one of many commands available in the popup menu.

14 ECS OpStation

User's Manual for OpStation

Selecting Points
Points can be selected by clicking on a display element owned by the point with the
left mouse button. The name and point text of the selected point appears in the Status
bar at the bottom of the OpStation window. Many of the OpStation menus and
toolbar commands affect the selected point.
Popup Menu
The popup menu is accessed by clicking the right mouse button on a display
element. When the mouse is clicked, the owner of the display element becomes the
selected point.

Picture Back Returns to the previous picture.


Faceplate Displays a faceplate popup associated with the selected point.
Point Alarm List Opens the SDR Alarm List and displays the alarms for the
selected point.
Point List Opens the SDR Point List
Add to Favorite List Adds the selected point to the favorite point list.
Point Parameters Opens the Point Parameters window and displays the
parameters and statistics for the selected point.
Point Configuration Opens the Point Configuration display and shows the
configuration parameters for the selected point.
ECS Note Pad Opens the ECS Note Pad and display notes for the selected point
Point Trend Opens the Point Trend display with the selected point assigned to the
trend package.

User's Manual for OpStation

ECS OpStation 15

Point Value Entry Element


The Point Value Entry element is a display element that displays a database point
value and allows the point value to be changed if the user has the appropriate access
privileges.

Point Value Modify Procedure

16 ECS OpStation

1.

To modify the value, move the mouse pointer to the field and click the left
mouse button. A box surrounds the element, the background changes to
blue, and the color of the value text changes to black (highlighting). The
value is frozen when highlighted.

2.

Use the keyboard to change the old value. This phase will turn the
highligthing background color to white. F2 or Left arrow key allows you
to do inline editing instead of retyping the whole field.

3.

Press the keyboard Enter key to assign the new value and send it to the
PLC. When the value is sent, the text color will turn grey. When the new
value is accepted by the PLC and returned to the database, the highlighting
of the field will be turned off. This is also the case if the new value is not
returned within a timeout period.

4.

Cancel the operation by clicking the mouse button outside the element or
pressing Esc key.

User's Manual for OpStation

Thermometer Elements
Thermometer elements are used to represent a point value in a horizontal, vertical or
deviation from normal bar graph.
A thermometer presents the entire display range (Graphical Low Limit - Graphical
High Limit) of a point as an unfilled rectangle. The current point value is displayed
by filling in the rectangle. This provides a visual indication of the value with respect
to the graphical low and high limits. The color used to represent the value is
determined by the status of the point.
There are three types of thermometer:

Basic Thermometer

Thermometer with Scale

Deviation Thermometer

Basic Thermometer
The Basic Thermometer displays the value of an A-Point as a percentage based upon
the present value and the graphical low and high limits. The thermometer also
includes thin lines to represent the normal value and the alarm limits. The line
indicating the normal value is green and the alarm limit lines are red.

User's Manual for OpStation

ECS OpStation 17

Thermometer with Scale


The Thermometer with Scale displays the value of an A-Point in the same manner as
the Basic Thermometer. The Thermometer with Scale however includes a scale with
numeric values to indicate graphical low, graphical high, and midrange. The
thermometer also includes thin lines to represent the normal value and alarm limits.
The line indicating the normal value is green and the alarm limit lines are red.

Deviation Thermometer
The Deviation Thermometer displays the value of an A-Point as deviation from an
assigned normal value. As the point value changes, the bar graph is filled to indicate
the amount the value has moved from normal. The graph fills to the left when the
value is less than normal. The graph fills to the right when the value is greater than
normal. The thermometer also includes thin lines to represent the normal value and
alarm limits. The line indicating the normal value is green and the alarm limit lines
are red.

Trend Element
A trend element is used to display the most recent historical values on a graph. The
graphs y-axis represents the point value and the x-axis represents time. The entire
trend window covers a period of time called the trend horizon. The right most fourth
of the trend is called the update horizon. The trend window is updated with new
values each time a pre-assigned update period expires.
Up to 4 points can be assigned to a trend element. All points have the same trend and
update horizons.

18 ECS OpStation

User's Manual for OpStation

Slider Element
The slider element consists of a large rectangle that represents the output range
(Output Range Low - Output Range High) and a slider bar (smaller rectangle). The
location of the slider bar indicates the value as a percentage of the range limits. If the
current value is equal to Output Range High, the slider bar appears at the top of the
slider. If the current value is equal to Output Range Low, the slider bar appears at the
bottom of the slider.
To modify the value associated with the slider, move the mouse pointer to the slider
bar. Click and hold the left mouse button. Move the slider bar until it is in the desired
location. Release the mouse button.
The slider element includes thin lines to display the normal value and alarm limits.
The line indicating the normal value is green, the alarm limit lines are red, and the
color of the slider bar represents the current status of the point.

User's Manual for OpStation

ECS OpStation 19

Glossary of Terms

Topmodel
The entry picture when OpStation is started. Normally contains buttons to reach other
pictures.The Topmodel is the top of the picture hierarchy.

Faceplate
A popup window which displays information related to the owner point of the
display element from where it was activated.

Selected point
The owner point of the last display element clicked (marked with surrounding
rectangle). The point properties are shown in the status bar.

Current department
The department associated the picture currently displayed. See Owner Model in ECS
OpStation Editor.

User's Manual for OpStation

Glossary of Terms 21

Index

Error! No index entries found.

22 Index

User's Manual for OpStation

Reference Manual

SDR Note Pad

FLS Automation A/S


Hffdingsvej 77
DK-2500 Valby
Copenhagen
Denmark
+45 36 18 27 00
Fax: +45 36 18 27 99
Printing History:
Version
Last modified
Author
Last modified by
Name of Word File
Index Range

SdrV6
$Revision:: 2
$Modtime:: 12/06/01 3:00p
Torben stradsson
$Author:: Taa
$Workfile:: SdrNotepUI30_English.doc
0-1000

$
$
$
$

Disclaimer:
Information in this document is subject to change without notice and does not represent a commitment on the part of
FLS Automation A/S.
The present documentation from FLS Automation A/S is subject to the content of the ordered, confirmed and
supplied system configuration.
Options specified and described in the FLS Automation A/S documentation as part of the general description but
initially neither ordered by the customer nor confirmed by the seller - will not commit the supplier to any further and
future supply and/or installation.
FLS Automation A/S assumes no responsibility for any errors that may appear in this document.
Copyright FLS Automation A/S. All rights reserved.

Contents
SDR Note Pad............................................................................................. 1
Introduction ................................................................................................................................... 1
Starting Note Pad .......................................................................................................................... 2

The Note Pad User Interfaces................................................................... 3


Note Pad Browser UI .................................................................................................................... 3
The command buttons ........................................................................................................... 4
Toolbar................................................................................................................................... 5
New Note dialog ........................................................................................................................... 6
Settings dialog............................................................................................................................... 7
Type definitions ..................................................................................................................... 7
Print dialog .................................................................................................................................... 9

Advanced user guide .............................................................................. 11


Definitions................................................................................................................................... 11
Changing the predefinitions........................................................................................................ 12
Security........................................................................................................................................ 13
External VBA use ....................................................................................................................... 13
VBA Methods...................................................................................................................... 14

Glossary of Terms ................................................................................... 16


Index.......................................................................................................... 17

Reference Manual SDR Note Pad

Contents i

SDR Note Pad

Introduction
The objective of the NotePad application is to satisfy a need for leaving a note to
other users, about a given situation on the plant. This could be a note to an alarm
event, that the current operator would like the next shift to keep an eye on.
The notes are viewed in the Note Pad Browser and has apart from the subject
line four attributes:

Timestamp - the time of creation

NoteType - a choice between predefined types e.g. "Point"

PointCode - The Point code of a relevant point.

Creator - The person that created the note, taken from the system
login.

Recipient - A predefined group of people that is meant to see the


note.

Changing the predefined types of the Note Type and the Recipient are explained
in the chapter "Changing the predefinitions"
Keyboard
In most cases the keyboard can be used instead of the mouse. Under each
description of the user interface a keyboard shortcut table is found. This table
apply only for UI's in English language.
Beside the shortcut keys, the normal window keys can be used. The TAB key
move the focus between controls and cursor keys and SPACE changes values.

Reference Manual SDR Note Pad

SDR Note Pad 1

Starting Note Pad


Note Pad can be started from ECS Opstation or from the START menu as shown
below.

There is one start up option: NoLogo.


If the program are started with the NoLogo option, there will be no FLS
Automation watermark on the printed pages. The option can be used in the
following ways:
SdrNotepUI30.exe NoLogo
SdrNotepUI30.exe -NoLogo
SdrNotepUI30.exe /NoLogo
When SdrNotepUI30.exe is started the program automatically starts the NotePad
Server (SdrNotepSvr30.exe). The server can be contacted for note information
through a VBA application like Microsoft Excel.
More information on this in the Advanced user guide s VBA Use.

2 SDR Note Pad

Reference Manual SDR Note Pad

The Note Pad User Interfaces

Note Pad Browser UI


In the Note Pad Browser User Interface you are able to locate and view notes.
The list will according to the filter function show either all notes or notes with a
given point code. The point can be retrieved from the starting application e.g.
ECS OpStation or selected from the Point List(more: Toolbar functions). The
point code can also be typed in manually and the search for notes start by
pushing either ENTER or the "Show Notes" button. If the filter presently are at
the "All Notes" position, it is also possibly to start the search simply by selecting
the "Point Only" filter function.
If no notes with the supplied point code were found, the status line will show
"No Notes found".

Filter
Function

List of
Notes

Note text
from the
Selected
Note

Reference Manual SDR Note Pad

The Note Pad User Interfaces 3

Sorting
The list can be sorted by date/time, by subject, by point code, by recipient or by
creator. The sorting is set by clicking on the list-header for the desired column.
It is also possible to resize the list columns by dragging the header.
Both sorting and column size are reset to default values at program start up.

Shortcut keys for English version


ALT + a

Append note

ALT + n

New note

ALT + c

Close application

ALT + p

Show Point only

ALT + l

Show All Notes

The command buttons

This will course the New Note dialog to appear, giving you the
opportunity to create a new note. If the note is relevant to a certain point code,
the point code has to be selected before pushing the New Note Button.
This button will start the New Note dialog with the same point
code, recipient, subject, type and note text as the selected note. The old note text
will be indented with a ">" sign and the new text can be added to the note where
desired.
Is it also possible to change the subject, note type and the recipient but not the
point code.
Pressing "Show Notes" will cause the list of notes to be
updated, showing only notes with a given point code (supplied in the point code
field).
If no notes are found the status line will show "No notes found" and the point list
will be empty.
Pressing this button is equivalent to pressing the "Point Only" radio button or
pressing ENTER from the point code field.
This will course the application to close and is equivalent to
pressing the "X" close button in the upper right corner.
All created notes, changed note settings and the browser window position on the
desktop is saved.
Sorting, column size and view information are not saved.

4 The Note Pad User Interfaces

Reference Manual SDR Note Pad

Toolbar
Point list navigation
Navigates through the point list and retrieve point codes.
(open point list, previous point, current point, next point). After receiving a point
code the Note Pad will switch the filter mode to "Point Only" and thereby
showing relevant notes. If no notes are found the status line will show "No notes
found" and the point list will show the last valid list of notes.
New Note
Opens the New Note dialog. This is equivalent to pressing the New
Note Button. If the new note has to have a reference to a point code, the point
has to be selected in the filter before pressing the New Note button. This can for
instance be done by using the point list navigators, as described above.
Print note
Opens the Print Note dialog. If you want to print a selection of notes,
you need to select the notes before pressing the Print note button. This is done by
clicking the desired notes in the list while holding down the CTRL key. You can
also use the SHIFT key to select several notes in a row.
Settings
Pressing this toolbar button will start the Settings dialog. The dialog
will be shown even if the user access rights wont allow the user to save the
settings.
Change View
This button changes the view mode in the note list. The modes are :

Detail mode

Small Icons mode

Large Icons mode

List mode

The modes will rotate every time the button is pushed. When the mode are
different than the default "Detail mode", the note details will be displayed in the
Status line at the bottom of the Browser.
Help
Show this help file.

Reference Manual SDR Note Pad

The Note Pad User Interfaces 5

New Note dialog


The New Note dialog box can be started as a "New Note" dialog or an
"Appended note" dialog depending on what button is used to start the dialog
with. The dialog is the same, but in the "Appended Note" dialog the fields are
filled with the values from the note selected in the browser.

If the "Use first line as subject" in the Settings a enabled, the first line of the note
text will be used as the subject, but only if the subject field is left blank before
pushing the create button.
If the "AutoType" function is enabled the subject will be written while you write
the note text.
The Type and the Recipient selector contain predefined entries and a selection
can take place only between the defined values.
The "Point Code" field contain the value from the last used filter in the Browser
or the point code of the note that the new note is appended to and cannot be
changed.
The "Create" button saves the note to the system database and the "Close" button
leaves without saving.

Shortcut keys for English version

6 The Note Pad User Interfaces

ALT + a

Auto type on/off

ALT + r

Create note

ALT + c

Close dialog

Reference Manual SDR Note Pad

Settings dialog
In the Settings dialog there are three setting that a user with administrator rights
can control.

"Default recipient" is the predefined recipient that are used when a new note
dialog is shown.
When the "Use first line of note as subject" checkbox is set, the user can leave
the subject field blank when creating a new note. The first valid line of the note
text will then be inserted as the subject line.
"No. of days for notes to expire" tells the Note Pad server how old a note can be
before it is deleted. Valid entries are from 729 days (2 years) to 1 day. The
default setting are 60 days.
Please show extreme caution when changing this to other values. Too many
notes will slow down the system, but on the other hand deleted notes cannot be
retrieved.
Please read the Advanced user guide for more detail.

Type definitions
The different types has a check box on the left side of the type icon. If the check
mark is present the type is active, if not the type is inactive (will not be used).
To add a new type, click the "Add" button and then select the new empty type.
Press the "Edit" button and write a name for the type in the name field. select the
icon to be used and enter a language reference if desired. Then press "Apply".
The language reference is a reference to an entry in the language database. If a
language reference is supplied the name will not be used ! Instead the system
will look for an entry in the language database with the ID supplied in the
Language database
This way, the Type name will change with the local language setting for the
entire ECS system.
The is six predefined entries in the language database :

Reference Manual SDR Note Pad

The Note Pad User Interfaces 7

LangRef
DefNoteTypeGeneral
DefNoteTypePoint
DefNoteTypeError
DefNoteTypeInform
DefNoteTypeCritical
DefNoteTypeMaintenance

The 32 Icons that are supplied is :


Icon 1 - 8 :

Icon 9- 16 :

Icon 17- 24:

Icon 25 - 32 :

It is not possible to custom define icons.


The type definitions can be edited from any ECS client and will be sent to the
server.

Shortcut keys for English version

8 The Note Pad User Interfaces

ALT + u

Use first line of note as subject of/off

ALT + o

OK - save changes

ALT + c

Close dialog - without saving

ALT + a

Add a new note type

ALT + e

Edit the selected note type

ALT + d

Delete the selected note type

ALT + p

Apply changes to the selected note type

ALT + r

Undo not applied changes to the selected note


type

Reference Manual SDR Note Pad

Print dialog
The Print dialog is invoked with the print button on the toolbar in the Note Pad
Browser UI.
You can print either a selection of notes or all notes from a number of days back.
When printing a selection of notes the selection has to be done before opening
the print dialog. This is done by clicking the desired notes in the Browser list
while holding down the CTRL key. You can also use the SHIFT key to select
several notes in a row. Then press the print dialog button on the toolbar.
When printing notes from a number of days back, select that radio button and
write the number of days in the field to the right. The number of days must be
between 1 day and 729 days ( 2 years).
To print all notes in the system use 729 days.

You can select a printer from the system printers. Default selection is the
"default system printer".
You can use a font size between 1 and 20 and a border size between 1 and 20,
and set the number of copies to be printed.
The paper size and the font typeface, will be the printer default.
Press "Print" to begin printing or "Close" to cancel the print.
The print will look like this :

Reference Manual SDR Note Pad

The Note Pad User Interfaces 9

Shortcut keys for English version

10 The Note Pad User Interfaces

ALT + p

Start print

ALT + i

Print selection only

ALT + r

Print notes from the last number of days

ALT + c

Close dialog

Reference Manual SDR Note Pad

Advanced user guide

Definitions
The system can hold 2,147,483,647 (2 billion) notes, dated from the 1st. of
January 2000 to the 31.th of December 2099.
If the NotePad server finds a note that a dated outside these limits, the note will
be copied into a new note and then deleted at the next clean up.
The generated note will have an explaining message appended to the note text in
the local language.
This kind of clean-up is done at program start and then automatically once every
day. Until the time when a invalid note can be rewritten the date of the note is
shown as 01.01.00.
For performance reasons it is recommended that the maximum number of notes
in the system is kept under 1000. This is ensured by setting the "No. of days for
notes to expire" to the number of days it takes for the users to generate this many
notes. The default value is 60 days. This is done in the Settings dialog.
An instant cleanup is done by setting "No. of days for notes to expire" to 1 and
then close and restart the application. Then only the notes from the current day
will survive.
If the database is taking up to much space it can be compacted with the compact
function in Microsoft Access' tools menu.
The database is named SdrNotep30.mdb and is located in the \ProDB\ directory.
The Note Pad client will make a quick refresh five times a minute and a total
refresh every 5 minutes.
Expired notes will be deleted at program start and then once a day.
Deleted notes cannot be retrieved.

Reference Manual SDR Note Pad

Advanced user guide 11

Changing the predefinitions


The predefinitions of the Note types and the Recipients can be changed in the
following way, using Microsoft Access.

Recipient definitions
The Recipients definitions are located in the SdrNoteRecipient table in the
SdrNotep30.mdb database in the ProDB catalog.
The table consist of three fields :
RecipientNo : A ID number between 1 and 255 that represent the recipient. The
number is required and has to be unique.
RecipientName : (optional) The displayed text, if no LangRef is supplied.
LangRef : A reference to an entry in the language database. (Optional if a
recipientName is supplied)
If a LangRef is supplied the RecipientName will not be used. Instead the system
will look for an entry in the language database with the ID supplied in the
LangRef field.
This way, the Name of the recipient will change with the local language setting
for the entire ECS system.
There are four predefined LangRef ID's :
LangRef
DefRecipAll
DefRecipOperator
DefRecipManager
DefRecipMaintenance
If a new recipient is added that is not represented in the language database, use
the RecipientName field to supply the recipient with a name, but be sure to leave
the LangRef field empty.

12 Advanced user guide

Reference Manual SDR Note Pad

Security
There are three security levels in the Note Pad system

All Users - can view and print notes.

Operators - can also create notes.

Administrators - can also change the settings.

All dialogs are visible even if permissions to press OK or Create is not


granted.
The OK or Create buttons will simply be disabled (shaded).
No user can delete a note - only the Note Pad system can and only if the
note are expired.
No user can change a note that are already written. It is only possibly to
append a new note with a changed contents.

External VBA use


The Note Pad server can be contacted for external use of Note Pad functions.
There is several methods you can use in a VBA script using for instance
Microsoft Excel.
For more information on the Note Pad Server methods the VBA Methods table
contain a short guide to some of the functions.
Below is a Excel VBA example, where a click on a button makes the three last
note subject and note texts appear in six cells.

First the Note pas server has to be started and initialised.

Then GetLastNoteNo get the numbers of the last three notes and
uses these numbers to gain access to the notes themselves.

After inserting the note texts and subjects, the objects is destroyed.

'VBA code example


Private Sub CommandButton1_Click()
Dim obj_NoteServer As SdrNotepSvr30.clsINotepSvr
Dim objSdrCreateObject As PtaEnvAuto20.clsPtaCreate
Dim vNoteArr As Variant
Dim vSubjectArr() As Variant
Dim NoteTextArr() As Variant
' Start server
Set objSdrCreateObject = New PtaEnvAuto20.clsPtaCreate
Set obj_NoteServer = objSdrCreateObject.CreateObject _
("SdrNotepSvr30.clsNotepSvr", "SDR", "")
obj_NoteServer.InitObject
' Get last 3 notes
obj_NoteServer.GetLastNoteNo 3, NoteArr
obj_NoteServer.GetNotes NoteArr, , vSubjectArr, , , , ,
NoteTextArr

Reference Manual SDR Note Pad

Advanced user guide 13

' Insert in Sheet


Cells(2, 2) = vSubjectArr(0)
Cells(3, 2) = NoteTextArr(0)
Cells(9, 2) = vSubjectArr(1)
Cells(10, 2) = NoteTextArr(1)
Cells(16, 2) = vSubjectArr(2)
Cells(17, 2) = NoteTextArr(2)
' Destruct objects
Set obj_NoteServer = Nothing
Set objSdrCreateObject = Nothing
End Sub

VBA Methods
Below is a table of some of the available methods.
Public Function GetAllNoteNo(ByRef vNoteNo As Variant) As Long

Retrieves all the note numbers of notes in the system.


Public Function GetNoteNoByPoint( _
ByVal sPointCode As String, _
ByRef vNoteNo As Variant) As Long

Retrieves a list of note numbers from notes with a given point code
Public Function GetNoteNoByDate( _
ByVal dtmFromDate As Date, _
ByVal dtmToDate As Date, _
ByRef vNoteNo As Variant) As Long

Retrieves a list of note numbers of notes between to dates.


Public Function GetLastNoteNo( _
ByVal nLastNotes As Long, _
ByRef vNoteNo As Variant) As Long

Retrieves a list of note numbers from the newest n notes in the system.
Public Function GetNote( _
ByVal lNoteNo As Long, _
Optional ByRef dtmDate As Date, _
Optional ByRef sSubject As String, _
Optional ByRef sPointCode As String, _
Optional ByRef sCreator As String, _
Optional ByRef nNoteType As Byte, _
Optional ByRef nRecipient As Byte, _
Optional ByRef sNoteText As String) As Long

Retrieves the contents of a note with the supplied note number.

14 Advanced user guide

Reference Manual SDR Note Pad

Public Function GetNotes( _


ByVal vNoteNo As Variant, _
Optional ByRef vDate As Variant, _
Optional ByRef vSubject As Variant, _
Optional ByRef vPointCode As Variant, _
Optional ByRef vCreator As Variant, _
Optional ByRef vNoteType As Variant, _
Optional ByRef vRecipient As Variant, _
Optional

ByRef

vNoteText

As

Variant)

As

Long

Retrieves an array of contents of notes with the supplied note numbers.


Public Function NewNote( _
Optional ByVal sSubject As String = "", _
Optional ByVal sPointCode As String = "", _
Optional ByVal Recipient As Byte = 1, _
Optional ByVal sCreator As String = "", _
Optional ByVal nNoteType As Byte = 1, _
Optional ByVal sNoteText As String = "") As
Boolean

Makes a new note in the system.

Reference Manual SDR Note Pad

Advanced user guide 15

Glossary of Terms

VBA
Visual Basic for Applications - programming language useable from many
Microsoft products like Word and Excel.

Predefined types
The predefined types are the type of recipient and the type of a note. They are
normally defined at install time. Se the Advanced user guide section.

Note Pad Browser


The main window in the program.

16 Glossary of Terms

Reference Manual SDR Note Pad

New Note dialog 45, 47, 67


Note Pad Browser 13, 9
Note Pad Browser UI 3
NoteType 1

Index

P
paper size 9
Point list 35
PointCode 1
predefinitions 1, 12
Print dialog 9

R
A
Advanced user guide 2, 711
Appended note 6
AutoType 6

B
border size 9
Browser 16, 16, 3, 49

C
change a note 13
Change View 5
Changing the predefinitions 1, 12
copies 9
Creator 14

Recipient 14, 67, 6, 12, 15


Recipient definitions 12

S
Security 13
security levels 13
Settings dialog 57, 11
Show Notes 34

T
Timestamp 1
Toolbar 39, 5, 9

V
VBA 2, 13
VBA example 13
VBA Methods 13

Definitions 1112, 1112


delete a note 13
Deleted notes 7, 11

E
Excel 2, 13
External VBA use 13

F
font 9

H
Help 5

I
Icons 5, 8

N
New Note 45, 47, 11, 13, 15

Reference Manual SDR Note Pad

Index 17

También podría gustarte