SYS600 - Application Objects
SYS600 - Application Objects
4
Application Objects
Trace back information:
Workspace Main version a26
Checked in 2014-05-16
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Contents
1 Copyrights ............................................................................................. 7
3 Introduction ........................................................................................... 11
3
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
7 Scales .....................................................................................................147
7.1 General ......................................................................................... 147
7.2 Scale attributes ............................................................................. 148
7.3 Defining scale objects using SCIL ................................................ 150
4
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
5
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
6
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
1 Copyrights
The information in this document is subject to change without notice and should not be
construed as a commitment by ABB Oy. ABB Oy assumes no responsibility for any
errors that may appear in this document.
In no event shall ABB Oy be liable for direct, indirect, special, incidental or consequential
damages of any nature or kind arising from the use of this document, nor shall ABB Oy
be liable for incidental or consequential damages arising from the use of any software
or hardware described in this document.
This document and parts thereof must not be reproduced or copied without written
permission from ABB Oy, and the contents thereof must not be imparted to a third party
nor used for any unauthorized purpose.
The software or hardware described in this document is furnished under a license and
may be used, copied, or disclosed only in accordance with the terms of such license.
Copyright © 2014 ABB Oy. All rights reserved.
Trademarks
ABB is a registered trademark of ABB Group. All other brand or product names
mentioned in this document may be trademarks or registered trademarks of their respective
holders.
Guarantee
Please inquire about the terms of guarantee from your nearest ABB representative.
Third Party Copyright Notices
List of third Party Copyrights notices are documented in "3rd party licenses.txt" and
included in SYS600 installation package.
7
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Although warning hazards are related to personal injury, and caution hazards are
associated with equipment or property damage, it should be understood that operation
of damaged equipment could, under certain operational conditions, result in degraded
process performance leading to personal injury or death. Therefore, comply fully with
all warnings and caution notices.
9
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
10
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
3 Introduction
SYS600
SYS600 is a micro computer-based, programmable and scalable network control and
substation automation system. It is mainly used within the electric power process but
can also be used for the supervision and control of heat and water distribution, industrial
processes, water purification, traffic, etc.
The system servers of SYS600 are composed of the kernel, a number of facility programs,
engineering and system handling tools, configuration software and application software.
The SYS600 kernel software is independent of the application area and the extent of use.
It is the same in all systems, as are also most of the engineering and system handling
tools. A system server can host one or more application software packages, called
applications. The application specifies the functions of the SYS600 system to suit a
specific process. The application takes the user’s needs into account regarding the level
of information, user interface, control operations, and so on.
Applications
Each application has a certain supervisory control task, for example the control of
electricity distribution or heat distribution. An application may control its own process
and have its own connections to the process equipment, or it may share the equipment
with other applications. Each application has its own data (databases) and displays.
Different applications can communicate with each other, whether they are situated in
the same system server or in separate ones. In simple terms, an application is composed
of a set of objects that communicate with each other, with the user and with the process
equipment, see "A simplified scheme of a SYS600 application" in Figure 3.1.
The application objects specify control functions, calculations, data storage, process
control etc., and they are composed of process data (process objects), report data (data
objects), control programs (command procedures) and activation mechanisms (event
channels, time channels, logging profiles, events and event handling objects).
The application objects are programmed and controlled using the SCIL language, which
is an application language specifically developed for SYS600 and the control &
supervision domain.
11
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Application objects
Application objects are programmable units that perform various tasks, such as real time
process supervision, control procedures, data registration and storage, calculations,
automatic time and event activation, etc. There are eleven types of application objects,
each performing a particular task:
1. Process objects (P). Process objects are images of connected process signals. These
objects store and supervise the real time state of a process.
2. Event handling objects (H). Event handling objects define the texts related to the
states of process objects and transitions between the states (events).
3. Scales (X). Scales are algorithms for scaling the data transferred from the stations
to the real values of the measured entity.
4. Data objects (D). Data objects register and store sampled or calculated data.
5. Command procedures (C). These objects are SCIL programs, which can be executed
automatically or manually.
6. Time channels (T). These objects control the automatic time based data registrations
and program executions.
7. Event channels (A). These objects control automatic event based data registration
and program execution.
8. Logging profiles (G). These objects define the connection between SYS600
application database and Historian time series database.
9. Event objects (E). These objects activate automatic event controlled program
execution (for example updating) in user interface objects.
10. Free Type objects (F). Free Type objects define user-defined process object types.
11. Variable objects (V). Variable objects are temporary lists of attributes and attribute
values.
12
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
13
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Attributes
Information and data associated with objects, their values, functions, properties and
activities, are stored in attributes. Normally, an object has many different attributes, and
thus it can contain several types of data. Different object types have different sets of
attributes.
The attributes not only contain the dynamic data of the objects, but also define the objects
and their functions. Static (defining) attributes include object identities, addresses,
activation criteria, activity states, connections to other objects, alarm handling
specifications, SCIL programs and expressions. Examples of dynamic attributes are the
object values, historical data, status codes and time tags. Figure 3.3 shows an imaginary
object (data object) and its static and dynamic attributes.
Object
Static Attributes Dynamic Attributes
Figure 3.3: An imaginary object (data object) and a few of its static and dynamic attributes
Attribute values can be used in SCIL expressions and programs, for example in
calculations, displays, conditional statements, etc. The values can be changed
automatically by the process or system, or manually using SCIL. All dynamic and static
attributes can be accessed using SCIL, though all of them cannot be set using it.
As a rule, attributes are the only way to store, access, use and modify information in
objects and to operate through them. Attributes are therefore the most essential part of
objects.
14
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Event objects are event based activation signals that trigger execution of event methods
of Visual SCIL objects and event handlers (ON blocks) of pictures. They are generated
either by process objects or by SCIL. These objects have no attributes and no other
definitions beside activation criteria and the object name when activated by SCIL. The
picture program parts activated by the event objects are stored within the pictures in the
picture database and can be activated only when the picture is visible on the screen.
Variable objects are always created with SCIL. The variable objects are used as variables
and as temporary storage for data.
Databases
Most application object types are stored in databases. A database is a set of related data
stored in a structured form.
The process objects, event handling objects, scales and free type objects are stored in
the Process Database. The data objects, command procedures, time channels, event
channels and logging profiles are stored in a database named Report Database, and
these objects are called report objects with a common name.
Variable objects are stored in the same way as variables (see the Programming Language
SCIL manual). Event objects are not stored.
Each application may only contain one process database and one report database.
15
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
4 Object handling
This chapter presents the principles on how to define application objects and how to use
the objects in SCIL. It is divided into the following three sections:
4.1 Defining application objects : the possibilities for defining objects, the
principles for using the object definition tools, the principles for defining
objects with SCIL.
4.2 Using application objects in SCIL: the object notation and how to use
object notations in SCIL, accessing attributes.
4.3 Some SCIL commands: for application object handling.
17
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
General
In SCIL the application objects are used mainly through their attributes. Object data can
be included in SCIL programs and expressions via attributes. Object data can, for instance,
be shown in windows, it can form the basis for control operations or be used in the
definition of other objects, etc. Objects are identified by an object notation and attributes
of an object by an object attribute notation, see below.
All types of objects can be used in SCIL. However, event objects cannot be included in
expressions as they have neither data nor attributes.
18
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Object notation
Object notation has the following format:
name:{application}type{index}
where
'name' is the object name
'application' is the logical application number
'type' is the object type
'index' is an index number or an index range
The components of the notation are explained below. The ones within braces are not
always required. Indexing is applicable only for process objects, all the other objects are
unindexed. See the examples below in Using object notations, on page 21.
The components of the notation are explained below. The ones within braces are not
always required. The attribute name may be omitted if the object type has a default
attribute. For process objects of a predefined type, indexing is used to select the object.
For other types of objects, indexing is used to access elements of a vector valued attribute.
See the examples below in Using object notations, on page 21.
Name
The name of an object may be up to 63 characters long. Characters allowed are the letters
A-Z, all digits, underscore (_) and period (.). The object name must begin with a letter,
a digit or an underscore.
Object names can be freely chosen. Within an application, the object name must be
unique for a specific object type, but objects of different types may have the same name.
19
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Process objects defined in LIB 500 must obey tighter rules: a maximum of nine characters
is allowed for relay picture functions and ten characters for all the other types of picture
functions.
Application
Application is the logical number of the application where the object is stored. It is the
application number as known to the present application (according to the application
mapping, the APL:BAP attribute, see the System Objects manual). The number can be
omitted when the object is in the current application (the normal case).
Including an application number (other than the current one) in an object notation brings
about a data transfer between two applications, within the same or different base systems.
A prerequisite is that the applications recognise each other through application mapping.
Type
The object type is indicated with a letter in accordance with the following:
P Process objects
H Event handling objects
X Scale objects
D Data objects
C Command procedures
T Time channels
A Event channels
G Logging profiles
E Event objects
V Variable objects
F Free type objects
20
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Attribute
An attribute represents the value or feature to be read or written with the object notation.
It is generally named by a predefined attribute name, which is a combination of two
letters, A ... Z. Variable objects can have freely chosen attribute names of any length up
to 63 characters.
Reading an attribute means that the attribute value is used in an expression. Writing
an attribute means that the attribute value is changed or updated with the #SET or
#MODIFY commands. See the examples in Using object notations, on page 21.
The attribute of an object notation determines value and data type of the entire notation
(see the Programming Language SCIL manual). An object notation without an attribute
may still refer to a special attribute, the default attribute (mentioned in the subsequent
object descriptions, normally the object value).
Object notations are used without an attribute together with some commands ( Section 4.3
Some SCIL commands). In these cases they refer to the entire object. Event objects can
only be used without an attribute.
Index
Indices are used to differentiate attribute values with equal object notations in all other
respects. Such attribute values are handled as vectors, where the elements are accessed
using indices.
As a rule, indices refer to the elements of an attribute of vector type. The actual attribute
determines the data type of the elements. Predefined process object types are an exception.
For these objects, the indices refer to the individual objects in a group, not to the attributes
of a vector type. However, for a certain attribute, the values are handled as elements in
a vector.
In SCIL, an index or index range is marked in any of the following ways:
• With an integer number, either a positive decimal number or an octal number. An
index of a variable object where the attribute is not composed of two letters must
be embraced by brackets. In all other cases, no brackets are needed.
• With an integer type expression. The expression must be embraced by brackets.
• With an interval (i .. j), where "i" is the first index number and "j" the last. Two
points surrounded by brackets (..) are interpreted as all the indices of the actual
object notation. Interval (i ..) indicates all indices larger than or equal to "i", and (..
j) all indices less than or equal to "j".
No space is allowed between the index and the rest of the object notation.
21
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
In SCIL commands, object notation is used to identify the object and object attribute
notation to identify both an object and one of its attributes. For examples in using object
notation, see Section 4.3 Some SCIL commands.
When object attribute notation is used as an operand in an expression, the value of the
attribute replaces the entire notation. Examples:
!SHOW WINDOW OBJ:POV2
The value of the OV attribute of the process object OBJ with index 2 is read from the
process database and displayed in the window WINDOW.
V = DATA:DRT + 60
A variable is assigned the value of the latest registration time of a data object added by
60 seconds.
#SET BREAKER:PBO3 = 1
The process object BREAKER is closed. If the object represents a real physical object,
the command is sent to the relay, which closes the real breaker.
.SET ITEM._TITLE = "DAT_OBJ(3) " + DEC(DAT_OBJ:2DOV3)
The third registered value of the data object DAT_OBJ in application 2 is shown in the
title of a Visual SCIL object.
General
A detailed description of SCIL is found in the Programming Language SCIL manual.
This section briefly describes a few SCIL commands and functions, which are important
for application object handling. The commands here are given along with the arguments
22
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
necessary for making a complete statement. The arguments are written in lower case
letters.
Executing objects
#GET object
Gets process values from stations connected on ANSI lines (station type STA) and
updates them in the process data base. The 'object' must be a process object or a
communication system object with the attribute ME (see the System Objects manual).
Process queries
APPLICATION_OBJECT_LIST
APPLICATION_OBJECT_ATTRIBUTES
APPLICATION_ALARM_LIST
HISTORY_DATABASE_MANAGER
These SCIL functions constitute the basis for browsing through the process database,
report database, alarm list and event list (history database).
23
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Creating objects
Modifying objects
Deleting objects
#DELETE object
Deletes the object. The object can be of any application object type, except for an event
object.
24
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
5 Process objects
This chapter describes the process objects and their attributes. It is divided into five
sections with the following contents:
5.1 General: This section describes the basic features, use and functions of
process objects, process object types, user defined process object types,
an overview of process object attributes, the storage of process objects,
etc.
5.2 Configurable process object attributes: This section lists and describes in
detail the attributes that define the functionality of the object.
5.3 Dynamic process object attributes: This section lists and describes in detail
the attributes that contain the dynamic real-time data of the object.
5.4 Defining process objects: This section lists the required attributes, default
values and principles for creating process objects using SCIL, and presents
examples.
5.5 Process object group attributes: This section lists and describes in detail
the attributes that define the functionality of object groups.
5.1 General
Use
Process objects are typically data images of physical process devices, such as breakers,
disconnectors, switches, relays, detectors, sensors, regulators. These devices are connected
to SYS600 through Remote Terminal Units (RTUs), Protective Equipment, Programmable
Logics, etc., all of which will be referred to as process units or stations in the following
text.
Process objects supervise the process signals registered in stations and control the signals
sent from the stations to the process equipment. Generally, each input and output
connection in a station is represented by a process object in the SYS600 process database.
Additionally, general supervision and status information stored in a station can be
represented by process objects.
There are also process objects that have no physical correspondence, nor any data
correspondence in the stations. These process objects are used for process simulation,
for manually updated values, system message handling, etc.
Function
Process objects constitute the links between the control system and the controlled process.
A process object contains the process data, various stamps related to the data (for example
time and validation stamps or stamps set by the stations) and the alarm state information.
It also contains functional definitions, such as scale definition, automatic activation, etc.,
25
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
see Figure 5.1. Both the dynamic data that reflect the real-time state of the process and
the functional definitions are defined by attributes.
A process device is controlled by setting the object value of the corresponding output
object with the #SET command. The order is passed out to the NET unit and to the
process device via the station. Likewise, a spontaneous message from a station updates
the corresponding input objects in the process database. Under certain conditions, the
process objects of input type can also be updated using SCIL (with #SET, see the SS
attribute). Process objects without process connection are always updated using SCIL.
Every update of a process object, whether it comes from the process or from SCIL, may
cause the following effects, “post-processing”, (depending on the process object definition
and the value of the update):
• Alarm activation (input objects) including alarm signals, alarm printout and
registration in the alarm buffer (alarm list).
• Automatic printout.
• Event based updating of user interface objects (through event objects).
• Activation of an event channel.
• Registration in the history database (event list).
Each update of the object value also updates a validation stamp (the OS attribute) and a
time stamp (the RT, RM and RQ attributes), and, depending on the communication
protocol, possibly some other quality attributes.
If the process station sends an update message using an address that is not found in the
process database, an event channel (UNDEF_PROC or UNDEF_OPC_EVENT) is
activated to inform the application about the mismatch, see Chapter 11 Event channels.
26
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
27
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Operator
Process Displays Alarm Signals Alarm List Event List Event and Trends and
Alarm Printout Reports
Manual
Control
(SCIL)
Process Objects
Report Database
Object value
Validation stamp
Time stamp
Process Alarm activation
Event activation Stored
Database History buffering
Printout activation
data
etc.
Automatic control
functions (SCIL)
NETs
Stations
* RTUs
P
SPACOM
* PLCs
L
C * Protection Realys
* LCUs, etc.
Process
Process_database_functions
28
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Table 5.1: The S.P.I.D.E.R. RTU and SPACOM specific data types and the
corresponding process object types. The Bit Stream, File Transfer and OPC Event
object types are not included as they have no correspondence within these types
of stations.
Process Object Types S.P.I.D.E.R RTU Data Types SPACOM Data types
Binary Input, BI Indication single Indications
Indication single event recording Binary Signals
Alarms
Switches
Binary Output, BO Object command Select open/close of secured control
Regulation command Execute command
Cancel selection
Direct open/close commands
Lower/raise commands
Digital Input, DI Digital value
Digital Output, DO Digital setpoint
Analog Input, AI Analog value Measured data (current, voltage, integ-
Analog event recording rated energy values, tap changer posi-
tion, etc.).
Analog Output, AO Analog setpoint
General persistent output
Double Binary Indication, DB Indication double Breaker and disconnector states
Indication double event recording (open + close)
Pulse Counter, PC Pulse counter Pulse counters
Attributes
Table 5.2 lists the attributes of different process object types. This table lists both the
dynamic attributes that reflect the real-time state of the process and the definition attributes
that specify the functionality of the object. In the attribute descriptions in Section 5.2
Configurable process object attributes and in Section 5.3 Dynamic process object attributes
these two main types of attributes are kept apart. The attributes specific to OPC Event
objects are omitted. They are described in Section 5.3.10 OPC Event objects.
If no value is given to an attribute when an object is defined, the attribute is assigned a
default value. The default values of the attributes are given in the attribute descriptions
in Section 5.2 Configurable process object attributes and in Section 5.3 Dynamic process
object attributes.
Objects of the user-defined types have all the common attributes. In addition, they have
a number of user-defined attributes that can have any two-letter attribute name different
from the common attribute names. The user-defined attributes are defined by the free
type objects described in the Chapter 14 Free type objects.
29
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Table 5.2: The process object attributes of different process object types.
Object Types All Types Predefined types
Attributes BI BO AI AO DI DO DB PC BS FT OE NT
Object Addresses UN, OT, TI OA, OA, OA, OA, OA, OA, OA, OA, OA,
OB, IN, OB, IN, OB, IN, OB, IN, OB, IN, OB, IN, OB, IN, OB, IN, OB, IN,
IG IG IG IG IG IG IG IG IG
Post-processing PO, EH
Historian logging GN, GP GN, GP GN, GP GN, GP GN, GP GN, GP GN, GP GN, GP GN, GP
Operation Counting CE, CL, CE, CL, CE, CL, CE, CL,
CV, CO CV, CO CV, CO CV, CO
30
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Attributes BI BO AI AO DI DO DB PC BS FT OE NT
Storage
Process objects are stored in the process database file APL_PROCES.PRD. When the
application is WARM or HOT, the process objects are stored in the global memory pool
of SYS600 as well (see the System Objects manual).
All the attributes are stored in RAM. Depending on the switch state (see the attribute
SS), the process object values (OV) are updated either both on disk and in RAM or only
in RAM.
31
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
A process database may contain up to 1 000 000 process objects. Note, however, that a
full size database occupies at least 250 MB of the primary memory, or even more if very
long text attributes are used. The memory pool should hence be configured accordingly.
At application start up, the process database is copied from disk to RAM. As the values
stored on disk are probably outdated, the process database should be updated from the
stations. This is managed differently for different types of stations. Example:
• S.P.I.D.E.R. RTUs send all object values (input data) automatically to the process
database when the NET unit has been started (the NET unit has sent an SCI (Status
Check Instruction)). When the NET unit is running, process database can be updated
from the RTUs by setting the STAn:SSC attribute for all RTUs. For more information
on this attribute see the System Objects manual. For example, the setting can be
done in the initialization programs, which are application dependent command
procedures started by the event channels APL_INIT_1 and APL_INIT_2. For more
information on these event channels, see Chapter 11 Event channels.
• The process data of stations on ANSI lines (Allen-Bradley, SRIO, etc.) is read and
updated in the process database by means of the #GET command (Section 4.3 Some
SCIL commands), for example, in the initialization programs.
• Process data of SPACOM units are updated in the process database when the
STAn:SUP attribute of the stations (see the System Objects manual) is set. For
example, the statement #SET STA2:SUP = 1 means that all process data of the
SPACOM unit defined as STA2 is updated in the process database.
For predefined object types, the indices refer to individual objects in a group. An object
notation without an index refers either to a process group attribute or to the process object
with the lowest index, depending on the attribute. For user-defined object types, the
indices refer to elements in user-defined attributes of vector type. In the following attribute
descriptions (Section 5.2 Configurable process object attributes and Section 5.3 Dynamic
process object attributes), indexing is only explained in special cases.
32
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Depending on the context, a process object notation without attribute name refers either
to the default attribute OV (Object Value) or to the entire object. The object value attribute
OV is an alias name for the main attribute of the object. Depending on the process object
type, it refers to attribute BI, BO, AI, AO, DI, DO, DB, PC, BS, FT, OE or the main
attribute of the user-defined object type. The entire object is referred by object handling
commands, such as #CREATE, #DELETE, #MODIFY and #LIST.
The process data stored in stations using the ANSI X3.28 protocol can be directly accessed
with the system object attribute STAn:SME (see the System Objects manual).
IX Index
The index of a process object of predefined type. The individual objects in a group (up
to 65 535 objects with the same name) are identified by indices.
In principle, the index for a new process object can be freely chosen. However, there are
station type specific conventions that are widely used. As an example, the index of an
33
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
event recording object in S.P.I.D.E.R. RTUs should be assigned the index of the
supervised object plus 100.
Data type: Integer
Value: 1 ... 65 535
Access: Read-only, configurable
LN Logical Name
The logical name of the process group that the object belongs to. The individual process
objects in the group are identified by indices (the IX attribute).
Data type: Text
Value: Object name
Access: Read-only, configurable
Example:
Modifying the LN attribute, i.e. moving the object from a group to another:
#MODIFY ABC:P1 = LIST(LN = "DEF")
34
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
ZT Modification Time
The time when the object was created or modified. This attribute is automatically set
when the object is created and each time it is updated by the #MODIFY command (for
example, by the process object definition tool).
Data type: Time
Access: Read-only
Object types: All
CX Comment Text
A freely chosen text.
Data type: Text
Value: Any text, up to 255 characters
Default value: ""
Access: No restrictions
Object types: All
ES Event Source
The alias name of the object to be used as the event source name for the OPC Alarms &
Events Server.
Data type: Text
Value: Up to 255 characters
Default value: ""
Access: No restrictions
Object types: All
The value of the attribute is a hierarchical name that consists of any number of fields
separated by delimiters:
"area1.area2. ... .arean.source"
35
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Each field may contain any visible characters. The name is case sensitive. Single
embedded spaces are allowed in a field, whereas leading and trailing spaces are not
accepted.
By default, the characters recognized as delimiters are the colon (:), the slash (/), the
backslash (\) and the dot (.). An application may define its own delimiter character set
in the application attribute APL:BOP (OPC A&E Configuration), see the System Objects
manual.
Examples of valid ES attribute values:
• "South Tipperary:Kilkenny.Relay1.Breaker.Position"
• "Äänekosken ala-asema:Laukaan syöttö/Katkaisija.Tila"
The event source name (ES) and the event handling object (EH) together identify the
OPC event. Consequently, two or more process objects may have the same ES attribute
value, provided that they are connected to different event handling objects.
The hierarchy formed by the ES attribute values is shown by the area browser of the
OPC Alarms and Events Server.
IE Identifier Elements
This attribute shows the object’s Object Identifier (attribute OI) divided into hierarchy
levels.
Data type: Vector, the maximum length used by the application is defined by
APL:BOI
Element type: Text
Element value: The corresponding hierarchy level in the Object Identifier
Default value: Empty vector
Access: Read-only
Object types: All
then IE is
36
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
IL Identifier List
This attribute shows the object’s Object Identifier (attribute OI) divided into named
hierarchy levels.
Data type: List, the attribute names correspond to the hierarchy level names
defined by APL:BOI
Element type: Text
Element value: The corresponding hierarchy level in the Object Identifier
Default value: Empty list
Access: Read-only
Object types: All
then IL is
LIST(STA = "STA1", BAY = "BAY2", DEV = "DEV3")
OI Object Identifier
A freely chosen text that is used as a hierarchical location identifier for the object. The
attribute is divided into sub-fields (hierarchy levels) according to the application specific
conventions defined in the application attribute APL:BOI, see the System Objects manual.
Data type: Text
Value: Up to 63 characters
Default value: ""
Access: No restrictions
Object types: All
37
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Access: No restrictions
Object types: All
The value of the attribute is a hierarchical name that consists of any number of fields
separated by dots:
"field1.field2. ... .fieldn"
Each field may contain any visible characters, except for colons and dots. The name is
case-sensitive. Single embedded spaces are allowed in a field, whereas leading and
trailing spaces are not accepted.
Examples of valid ON attribute values:
• "South Tipperary.Kilkenny.Relay1.Breaker.Position"
• "Äänekosken ala-asema.Laukaan syöttö.Katkaisija.Tila"
The names are unique within an application. Consequently, the user cannot, for example,
give the same ON attribute value to a process object and a data object.
The hierarchy formed by the ON attribute values is shown by the name space browser
of the OPC Server.
OX Object Text
A freely chosen text.
Data type: Text
Value: Up to 63 characters
Default value: ""
Access: No restrictions
Object types: All
When the attribute is read, the value of the OX attribute is taken as a text identifier and
its translation into the current language is given. If the translation is not found, the
translation into English is given. If no translation is found, the value of the OX attribute
is returned as is.
38
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
5.2.3 Addresses
The attributes in this section specify the relationship between the process objects and
the corresponding input and output signals and data in the process units.
For any process object, the UN attribute (Unit Number) specifies the unit where the
corresponding process signal is located. Attributes OA (Object Address) and OB (Object
Bit Address) specify the address of the signal within the unit.
Attribute IN (Item Name) specifies the name of the signal within the unit that uses names
for signals instead of numeric addresses. Attribute IG (Item Group) is used to group
items for communication with the data source (OPC Data Access Server).
IG Item Group
The name of the item group the item belongs to.
Data type: Text
Value: Any text up to 255 characters, case-sensitive
Default value: ""
Access: No restrictions
Object types: All types
An item group is a collection of items that share some communication properties defined
by the OPC Data Access standard. This attribute has a meaning only if the data source
of the object is an OPC Data Access Server.
If IG = "" (undefined), the default item group "DefaultGroupIn" or "DefaultGroupOut"
is used, depending on the object type.
For output objects (object types BO, DO and AO), non-empty group names are not
allowed. The default group "DefaultGroupOut" is always used.
The properties of item groups are specified in node (NODn:B) objects, see the System
Objects manual.
The change of the item group name has no immediate effect on an active OPC connection.
The groups are set up when the connection to the OPC server is established.
IN Item Name
The name of the signal within the process unit.
Data type: Text
Value: Any text up to 255 characters, case-sensitive
Default value: ""
Access: No restrictions
Object types: All
39
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
An input object and an output object of the same data type (BI and BO, DI and DO, AI
and AO) may share an IN attribute value. Otherwise, the item names are unique within
a unit.
Named signals are typically used by process units that expose their data via an OPC Data
Access Server. The item names are often hierarchical names, where the dot character is
used as a delimiter.
The validity of the IN attribute is checked at run-time when the item is subscribed to and
when data is received from the OPC Server. Any errors are reported via the event channel
INVALID_OPC_ITEM, see Chapter 11 Event channels.
For OE (OPC Event) objects, this attribute defines the source of the event as specified
by the OPC Alarms and Events specification. Several process objects may share an IN
attribute value, because one source may generate different types of events. For details,
see Section 5.3.10 OPC Event objects.
OA Object Address
The address of the signal within the process unit. All real objects (the objects that are
connected to a process signal) require an object address, unless they are addressed by
the IN attribute. Possible bit address is given separately by the attribute OB.
For process objects belonging to stations using the ANSI X3.28 protocol, the object
address is the same as the word address defined in the station.
For process objects belonging to S.P.I.D.E.R. RTUs and SPA units, the object address
is a number coded according to the formula:
4096 * object type number + logical address
where
‘object type number' is 0 ... 11 according to the following:
0 = No object type (simple input, counter input, measurand input in P214)
1 = Object command (S.P.I.D.E.R. RTUs), binary output (SPA)
2 = Regulation command (S.P.I.D.E.R. RTUs), command output (P214)
3 = Digital setpoint
4 = Analog setpoint
5 = General persistent output (S.P.I.D.E.R. RTU), setpoint output (P214)
6 = Analog value
7 = Indication (single or double)
8 = Pulse counter
9 = Digital value
40
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
The object address of process objects belonging to REX stations (REF, RED, REC, REL,
etc., relays on a LON) is the address given in the process units.
The object address of process objects belonging to LMK stations (LSG device,
Weidmuller, etc., on LON) is the address defined in NET by the corresponding
LONWORKS 1
In the Process Object Definition Tool both the OA attribute and the logical address can
be used.
Data type: Integer
Value: 0 ... 2 147 483 647
0 = No object address.
Default value: 0
Access: Read-only, configurable
Object types: All
41
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
OT Output Type
The representation - decimal, octal or hexadecimal - to be used when displaying the
address (OA and OB) of the object.
Data type: Integer
Value: 0 Decimal representation
1 Octal representation
2 Hexadecimal representation
Default value: 0
Access: No restrictions
Object types: All
TI Table Index
Table index attribute supports configuring COM 500i object addressing. Reserved for
use by LIB 500.
Data type: Integer
Access: No restrictions
Object types: All
UN Unit Number
The logical number of the station where the object is found (see the System Objects
manual). Objects with a UN value of 1 … 50 000 may be connected to the process through
the communication system.
Data type: Integer
Value: 0 ... 65 535
Default: 0
Access: Read-only, configurable
Object types: All
IU In Use
State of use. This attribute determines whether the object can be operated or not. Taking
an object out of use (IU = 0) means that all functions of the object, such as updating and
alarm and event handling, are switched off. If the switch state is AUTO (SS = 2) or
42
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
FICTITIOUS (SS = 3) when the object is taken into use (IU set to 1), the OS attribute
(Object Status) gets the value 10 (NOT_SAMPLED_STATUS, see the OS attribute).
Data type: Integer
Value: 0 Out of use
1 In use
Default value: 0
Access: No restrictions
Object types: All
SS Switch State
This attribute describes how the object value attribute OV is updated: manually,
automatically or not at all.
Data type: Integer
Value: 0 ... 3
0 OFF, no updating, the object is not used.
1 MAN, manual updating. The object is updated by SCIL
(#SET). The object has no connection to the process.The
object value is stored on disk.
2 AUTO, the object is connected to the process. The AI, BI,
DI, PC and DB attributes can be updated from SCIL only if
the object’s UN = 0 and SS = 2. The object value is not stored
on disk.
3 FICTITIOUS. The object is fictitious. It is updated by SCIL
(#SET). The object has no connection to the process. The
object value is not stored on disk.
Default value: 0
Access: No restrictions
Object types: All
43
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Table 5.3: The table shows how different switch states affect the reading and writing of the OV attribute.
When the value is changed with a definition tool, it is changed according to the principles in the modify
column.
#SET obj:pov[ix] = value #MODIFY obj:p[ix] = LIST(ov = value) OV (RAM) OV (DISK)
SS=0 not possible, error 2013 (prof ob- changes DISK value status 2013 defined
ject switched off) is produced
SS=1 changes RAM and DISK values changes RAM and DISK values defined defined
SS=2 UN = 0: UN = 0: UN = 0: defined
changes RAM value changes RAM and DISK values defined
UN > 0: UN > 0: UN > 0:
input objects >> not possible, error input objects >> changes DISK value input objects >>
2018 (prof update capability error) output objects >> changes DISK value status 10
is produced output objects >>
output objects >> changes RAM defined
value
SS=3 changes RAM value changes RAM and DISK values defined defined
SU Substitution State
The substitution state tells whether the value of the object (OV attribute) originates from
the process, or is given by hand by the operator. Substitution mechanism is used to patch
the process database by hand in case of a communication break or station hardware
malfunction. If the operator knows the correct value of the object, he or she may write
the value into the process database (along with the SU attribute value 1) to allow the
applications that rely on the value work.
The value of SU is stored on disk. When SU is set to 1, the value of the OV attribute is
also stored on disk, even if the switch state of the object is AUTO.
The attribute may be set by a simple #SET command or a list type #SET command may
be used to set the SU attribute and the corresponding OV attribute at the same time, for
example:
#SET X:P1 = LIST(SU = 1, BI = 1)
The attribute is automatically reset from 1 to 0, when the value of the OV attribute is
updated by the process (SS = AUTO) or by SCIL (other switch states).
Setting the SU attribute generates an event and activates an event channel, printout and
history logging, if enabled.
Data type: Integer
Value: 0 Not substituted
1 Substituted
Default value: 0
Access: No restrictions
Object types: All
44
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
5.2.5 Scaling
BC Bit Count
The number of bits in the maximum value of the pulse counter. This is an informative
attribute that entails no automatic functions in the process database, but can be used in
SCIL programs.
Data type: Integer
Value: 1 ... 32
Default value: 16
Access: No restrictions
Object types: PC
DP Decimal Places
Number of decimal places used to display the value of the object.
Data type: Integer
Value: -1 ... 10
Default value: -1 (= unspecified)
Access: No restrictions
Object types: AI and AO
IR Integer Representation
The representation of analog values.
When IR = 1, the following attributes are represented as integer values:
AI objects: AI, MV, XV, LI, HI, LW, HW, ZD
AO objects: AO, LO, HO
When IR = 0, the attributes are represented as real (floating point) values.
Furthermore, when IR = 1, the value is not scaled between the database and the station.The
scale name attribute SN must be empty, if given at all, when the object is created.
Data type: Integer
Value: 0 Floating point representation. Data type REAL in SCIL
1 32-bit signed integer representation. Data type INTEGER in
SCIL
Default value: 0
Access: Read-only, configurable. It can be set with the #CREATE command,
but it cannot be modified with the #MODIFY command.
45
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
SC Scaling
The scaling of a pulse counter. It indicates the number of units that one pulse corresponds
to. The unit is determined by the ST (Sort Type) attribute.
The attribute has only an informative function that may be used by SCIL.
Data type: Real
Value: Size of one pulse
Access: No restrictions
Object types: PC
Example:
ENERGY = COUNTER:PPC3 * COUNTER:PSC3
SN Scale Name
The name of the scale used for the scaling of the object. A scale is an algorithm for
converting between the representation of analog data in the process unit and in the
database, in accordance with the engineering unit of the object (the ST attribute). Every
real value (see attribute IR) analog process object must have a scale (see Chapter 7
Scales). The scale must exist in the database before the process object can be created.
Scaling is done in the process database before the object value is registered (AI) or sent
to the process (AO).
Data type: Text
Value: Object name
Access: Read-only, configurable
Object types: AI and AO
ST Sort Type
The engineering unit of the object value.
Data type: Text
Value: Up to 10 characters
Access: No restrictions
Object types: AI, AO and PC
46
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
General
Process objects of any type can be equipped with alarm handling. The following object
types have alarm generation that is based on the object value (OV):
• Analog input objects (AI).
• Binary input objects (BI).
• Double binary objects (DB).
• OPC event objects (OE).
• Objects of user-defined types.
In addition, objects of any type may generate alarms that are based on the status of the
object, see Alarm generation, on page 50.
Alarms are categorised into 7 alarm classes (attribute AC, see below). The base system
software does not make any distinction between the classes, but applications may use
alarm classes to categorise alarms, for example according to their severity. AC attribute
value 0 disables all alarm handling of the object.
The alarm list contains all the alarming objects of the application. The list is maintained
in time order (the AT and AM attributes, see Section 5.3.3 Alarm and warning states).
An object may appear in the list only once. Obligatory acknowledgement of alarms may
be specified for a process object (attribute RC, see below). In this case, the alarming
object stays on the list until the alarm is acknowledged even if it is updated to a
non-alarming value.
An alarm picture to be shown on one or more alarm monitors may be associated to
the alarm (see attributes PD and PI below). When an alarm is generated, the name of the
alarm picture is appended to the monitor specific alarm picture queue. At the same time
a monitor alarm signal (a red flashing square in the upper right corner) is displayed. The
command !INT_PIC shows the alarm picture that is first in the queue. When the picture
is shown, it is removed from the queue. The alarm picture stays in the queue until it is
shown, and clearing the alarm does not remove it from the queue. When a semi-graphic
monitor is closed, the remaining alarm pictures in the alarm picture queue are shown
one by one. If an alarm occurs while the semi-graphic monitor is closed, the alarm picture
is automatically and immediately displayed on the screen.
By default, changes of alarm state (on/off) are considered as events by SYS600.
Consequently, post-processing of events (printouts, event channel activation and history
logging, see Section 5.2.8 Post-processing) applies to alarms as well.
Alarm handling may be temporarily disabled by setting the alarm blocking attribute
AB to 1 (see Section 5.3.4 Blocking attributes).
If an object has an alarm delay (non-zero AD attribute value, see below), a short alarm
state can pass without alarm activation.
Every time an alarm is generated, event channel named APL_ALARM is activated (see
Chapter 11 Event channels.) and application attribute AT (Alarm Tag, APL:BAT) is
47
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
incremented to notify the application about the alarm. Active alarms by alarm classes
are counted by APL:BAC and unacknowledged alarms by APL:BUC.
The attribute GA (Group Alarm) of the process object group indicates, whether any of
the objects of the group are in alarming state, see Section 5.5 Process object group
attributes.
If an audio alarm unit is connected to the system, an audio alarm for the alarm class of
the process object is set whenever an alarm is generated.
48
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Alarm Handling
=0
AC ?
>0
AZ = 1
AL = 1 =0 AZ = 2
AB ? BI = AG AL = 0 Change ?
(alarm on) Yes No
DB = LA
?
=1
Set
AT = RT ALARM LIST
AM =RM
=0
- RC ?
+ Alarm buffer
................
................
=1
................
-
AR ?
=1
PD
PI ?
Alarm picture
queue
+ ................ - !INT_PIC
................
Yes Yes
PF ? PF ?
Alarm Printout
Yes
LD > 0?
Figure 5.2: A rough outline of the alarm handling attributes for analog input and binary input
objects. OS is supposed to be 0. If the old OS = 10 the monitor alarm, alarm printout and external
alarm signals depend on the PU attribute (Picture at First Update, see Section 5.2.13 Printout
handling).
49
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Alarm generation
Alarm generation is based on the value and the status of an object.
Provided that the object has an alarm class (AC > 0) and the alarms are not blocked (AB
= 0), an alarm is generated in the following cases:
• The value of an analog input object (or an integer or real valued object of a
user-defined type) enters the low alarm or high alarm zone (AZ attribute, see
Section 5.2.7 Limit value supervision). The value of AZ is either received from the
station (SZ = 0) or it is calculated by SYS600 (SZ = 1). In the latter case, the alarm
zones are specified by the alarm limit attributes HI and LI.
• A binary input object (or a Boolean object of a user-defined type) gets the alarm
generating value (the AG attribute). At the first update, the alarm can be prevented
by the NV attribute (see below).
• A binary double indication gets any of the alarming values (the LA attribute). At
the first update, the alarm can be prevented by the NV attribute. See below.
• An OPC event object that represents an instance of an OPC condition enters the
Activated state, i.e. the OE attribute changes from 0 to a non-zero value.
• The OS attribute (Object Status, see Section 5.3.2 Time and validation stamps) gets
the value 1.
• The OR (Out of Range, see Section 5.3.7 Stamps set by the communication system)
or OF (Overflow, see Section 5.3.8 S.P.I.D.E.R. RTU specific attributes) attribute
gets value 1.
For binary and double binary objects, alarm generation is specified by the following
attributes:
AG Alarm Generation
Alarm generation of binary input objects (BI). This attribute specifies which bit value,
0, 1 or both, will generate an alarm. When the BI attribute gets this value, an alarm is
generated. If both bit values generate an alarm, the alarm generation at the first update
can be prevented by means of the Normal Value (the NV attribute, see below).
The attribute is also valid for user defined object types of data type Boolean.
Setting AG to 0 or 1 may generate or clear an alarm according to the current value of
the BI attribute, unless prevented by the revision compatibility (APL:BRC) setting
"SETTING_LA_AND_AG_DOES_NOT_ALARM".
Data type: Integer
Value: 0 Bit value 0 generates an alarm
1 Bit value 1 generates an alarm
2 Both bit value 0 and bit value 1 generate an alarm
3 Both bit values 0 and 1 generate an alarm on each update
(even if the value hasn’t changed)
4 Bit value 0 generates an alarm on each update
50
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
LA Alarm Activation
Alarm generation of double binary indications (DB), given as a bit mask. Several states,
even all four states can be alarm generating.
If one, two or three states are defined to be alarm generating, an alarm is generated when
the object value (the OV attribute) receives any of these states. The alarm disappears
when a non-alarming state is received. If all four states are defined to generate an alarm
(LA = 15), each new update causes a new alarm. In this case, the alarm disappears when
it is acknowledged.
When an object with LA = 15 is updated for the first time (OS goes from 10 to 0) and
the object value is the normal value (NV), or the normal value is 4, no alarm is generated
(see the NV attribute).
Setting LA (to a value other than 15) may generate or clear an alarm according to the
current value of the DB attribute, unless prevented by the revision compatibility
(APL:BRC) setting "SETTING_LA_AND_AG_DOES_NOT_ALARM".
Data type: Integer
Value: 0 ... 15. The alarm generating states given as a bit mask
0 = No alarm generation
Default value: 0
Access: No restrictions
Object types: DB
Example:
The DB values 0 and 2 will be generate an alarm (the value of DB:PLA1 value will be
5):
#SET DB:PLA1 = BIT_MASK(0,2)
LA Alarm Activation
Alarm generation of network topology objects (NT), given as a bit mask. Several states,
even all states can generate an alarm.
51
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
An alarm is generated when the object value (NT attribute) receives any of the states
defined in the LA attribute. The alarm disappears when a non-alarming state is received.
For more information about network topology objects, see Section 5.2.14 Network
topology.
Setting LA may generate or clear an alarm according to the current value of the NT
attribute, unless prevented by the revision compatibility (APL:BRC) setting
"SETTING_LA_AND_AG_DOES_NOT_ALARM".
Data type: Integer
Value: 0 ... 63. The alarm generating states given as a bit mask. In the
POWER schema, the NT attribute may have values 0 ... 5.
0 = No alarm generation
Default value: 0
Access: No restrictions
Object types: NT
Example:
The NT values 1 (Unpowered) and 2 (Uncertain) will be generate an alarm (the value
of NT:PLA1 value will be 6):
#SET NT:PLA1 = BIT_MASK(1,2)
NV Normal Value
The normal value of a binary input or double binary object.
The NV attribute is applied only at the first update after the application start-up and when
all states are alarm generating. All states are alarm generating when AG = 2 for binary
input objects or LA = 15 for DB objects. In these cases, the object does not cause any
alarm if its value is the same as the NV attribute or if NV = 2 (BI objects) or NV = 4
(DB objects).
Data type: Integer
Value: 0, 1 or 2 for binary input (BI) objects
0 ... 4 for double binary indications (DB)
Default value: 2 for binary objects and 4 for double indications. These values mean
that no alarm is generated at start-up for objects that are defined to
be alarm generating in all states.
Access: No restrictions
Object types: BI and DB
Example:
If a binary input object defined to generate alarm in all states (AG = 2) has NV = 1, no
alarm is generated if BI = 1 at the first update. However, if BI = 0 at first update, an
52
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
AC Alarm Class
There are seven equally significant alarm classes for grouping alarms. The application
engineer chooses how to group the objects in alarm classes. The objects can, for example,
be grouped based on the location of the process objects or alarm severity. An object with
alarm class 0 has no alarm function.
Changing AC from non-zero value to 0 clears the alarm indication (AL attribute) of the
object. Changing AC from 0 to a non-zero value does not affect the alarm indication,
AL remains as 0.
When AC is changed, an event is generated (if EE = 1) and the change is registered in
the history database (if HE = 1).
The alarm class is of significance when connecting the alarms to audio or audiovisual
alarm signals through additional circuit boards. All objects belonging to the same class
have the same type of audio alarms.
Data type: Integer
Value: 0 ... 7
0 = No alarm function
Default value: 0
Access: No restrictions
Object types: All
AD Alarm Delay
Alarm delay specifies the delay between the registration of an alarming value in the
process database and responding to the alarm. If an alarm delay is specified, the alarming
value is updated in the process database normally (attributes OV, OS, RT RM, RQ, AT,
AM, AQ, YT, YM and YQ) are updated), but the post-processing of the alarm is
postponed. In this case, the AL is not set, the object is not included in the alarm list and
no other post-processing that depends on the alarm state is done. When the delay expires,
the AL attribute (Alarm, see Section 5.3.3 Alarm and warning states) is set to 1, attributes
RT, RM and RQ are updated and the alarm post-processing is done, provided that the
alarming value still remains. If the object value is updated to a non-alarming value during
the delay, the pending alarm is cancelled.
The alarm delay is applied only when an alarm is about to be raised because of an alarming
OV value. Alarms caused by bad status of the object (such as OS value FAULTY) are
53
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
raised immediately. Also, clearing of an alarm takes place immediately, alarm delay is
not applied.
For analog input objects, the warnings are also delayed according to the AD attribute
value. If the object value is updated to an alarming value during a warning delay, the
delay is restarted. If the value returns to normal during the alarm delay, neither alarm
nor warning is produced. However, if the value returns to a warning state, a warning is
immediately generated.
Data type: Integer
Value: 0 ... 65 535
Unit: Seconds
Default value: 0
Access: No restrictions
Object types: All
PD Picture Devices
The logical monitor numbers of the alarm monitors, that is, the monitors where the picture
alarm message and the alarm picture will be shown. An object can have up to 15 alarm
monitors (the monitors with logical numbers 1 ... 15, see the System Objects manual).
Using the PU attribute (Printout at First Update, see Section 5.2.13 Printout handling),
alarm messages, including the monitor alarm, can be inhibited when the object is updated
for the first time.
Data type: Integer
Value: 0 ... 65 534, even numbers. The logical monitor numbers of the alarm
monitors given as a bit mask.
Access: No restrictions
Object types: All
Example:
Monitors by logical numbers 2 and 4 will receive monitor alarms:
#SET A:PPD = BIT_MASK(2, 4)
PI Picture
The name of the alarm picture of the object.
Data type: Text
Value: Picture name
Access: No restrictions
Object types: All
54
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
RC Receipt
Demand for acknowledgement. The attribute states whether acknowledgement of the
alarm is obligatory or not. If acknowledgement is required, the alarm is not removed
from the alarm list until it is acknowledged (by setting the AR attribute).
Data type: Integer
Value: 0 No acknowledgement
1 Demand for acknowledgement
Default value: 0
Access: No restrictions
Object types: All
These attributes apply to analog input and output objects (AI and AO).
Attributes LI, LW, HW and HI (Low Input, Low Warning, High Warning and High
Input) specify the alarm and warning limits of analog input objects. These attributes are
also valid for user-defined objects of data types real and integer. The values of the
attributes must obey the inequality LI <= LW <= HW <= HI. Setting a warning limit
equal to the corresponding alarm limit effectively disables the warning. Setting all the
limits to same value disables both alarms and warnings. If a warning and an alarm limit
have been set equal (HI = HW or LI = LW) and the alarm limit is changed, the value of
the warning limit will follow.
The dynamic attribute AZ (Alarm Zone) reflects the position of the value of AI attribute
relative to the warning and alarm limit attributes. Whenever the alarm zone changes, the
alarm state of the object is re-calculated and post-processing is done. When any of the
limit attributes is changed, the alarm zone is re-calculated.
Attributes LO and HO (Low Output and High Output) define the range of allowed AO
attribute values for an analog output object. If HO = LO, no range checking is done.
Zero deadband supervision (attributes ZD and ZE) is used to filter out small disturbances
and calibration errors of measurements.
HI High Input
The upper alarm limit of the analog input value. An alarm is raised (AL = 1), when the
AI attribute exceeds this value (provided that SZ = 1).
Data type: Real, if IR = 0
Integer, if IR = 1
Default value: 0
Access: No restrictions
55
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
HO High Output
The upper limit of the analog output value. Attribute AO cannot be set to a value larger
than HO.
Data type: Real, if IR = 0
Integer, if IR = 1
Default value: 0
Access: No restrictions
Object types: AO
HW High Warning
The upper warning limit of the analog input value.
Data type: Real, if IR = 0
Integer, if IR = 1
Default value: The value of HI attribute
Access: No restrictions
Object types: AI and user-defined types
LI Low Input
The lower alarm limit of the analog input value. An alarm is raised (AL = 1) when the
AI attribute goes below this value (provided that SZ = 1).
Data type: Real, if IR = 0
Integer, if IR = 1
Default value: 0
Access: No restrictions
Object types: AI and user-defined types
LO Low Output
The lower limit of the analog output value. Attribute AO cannot be set to a value smaller
than LO.
Data type: Real, if IR = 0
Integer, if IR = 1
Default value: 0
Access: No restrictions
56
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Object types: AO
LW Low Warning
The lower warning limit of the analog input object value.
Data type: Real, if IR = 0
Integer, if IR = 1
Default value: The value of LI attribute
Access: No restrictions
Object types: AI and user-defined types
57
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
ZD Zero Deadband
The width of the zero deadband, see Figure 5.3. The value of the object is regarded as
zero when it lies within the shaded zone, that is, within the range -ZD ... +ZD. See also
the ZE attribute above.
Data type: Real, if IR = 0
Integer, if IR = 1
Value: Width of the zero deadband
Default: 0
Access: No restrictions
Object types: AI
+ZD
ZD
0
ZD
-ZD
Illustration_ZD_attribute
5.2.8 Post-processing
General
When a process object is updated, several types of application specific actions may want
to be taken. Alarm handling and limit value supervision were described in previous
58
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
59
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
EH Event Handling
The name of the event handling object associated with the process object.
Data type: Text
Value: The name of the associated event handling (H) object
Default value: According to the process object type
Access: No restrictions
Object types: All
This attribute holds a reference to the event handling object that stores some additional
definitions for the post-processing. Currently, the values of the language-sensitive
attributes SX (State Text) and MX (Message Text) are obtained via the referenced event
handling object.
For OE (OPC Event) objects, the event handling object additionally defines the OPC
events that are received by the object.
60
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Activation criterion
For each type of post-processing, there is an attribute (AA, PA and HA) that specifies
the criterion for the activation, i.e. which type of change of the value is required to trigger
the activation.
The criterion may apply to:
• The OV attribute of the object (and the following OV related attributes: OS, SE and
SP).
• The OV attribute and the acknowledgement of an alarm.
• The alarm state (AS attribute) of the object.
In the first case, the criterion normally applies to the OV attribute of the object. When
the activation is caused by the change of some other attribute, the criterion is examined
as if the OV value had been changed (NEW VALUE). However, if the alarm state is
cleared by acknowledging the alarm (in case of a binary input or a double binary object,
whose all states are alarming states), neither event channel nor printout is activated.
When the object status OS changes, the status value 2 (INVALID, or OBSOLETE) has
a special treatment:
• When the object status is set to 2 as a consequence of the broken connection to the
process station, no activation is done regardless of the activation criterion. The
reason for this is that thousands or tens of thousands objects may be affected by the
communication break.
• When the object status is explicitly set to 2 by SCIL or a process message, the
activation is done if the criterion is NEW VALUE or UPDATE.
• When the object status returns from 2 to its normal value 0 (typically after the
connection has been re-established) and the object value OV does not change, the
activation is done only if the criterion is UPDATE.
The behavior in case of OS changes may be customised by the PP (Post-processing
Policy for Object Status 2) attribute of the station and/or application object, see the
System Objects manual.
Below, the criteria based on the object value are listed in the order of precedence. For
example, if the alarm zone of an analog input object is changed from the normal to a
warning zone or vice versa, the activation takes place if the criterion is UPDATE, NEW
VALUE or WARNING. If the criterion is ALARM, activation is not done.
0 ALARM Activation only when the AL attribute changes (an alarm
comes or goes).
3 WARNING Activation when the alarm zone (AZ) of an analog input ob-
ject changes from the normal zone to a warning zone or vice
versa, see Section 5.3.3 Alarm and warning states.
61
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
The criteria based on the object value and the alarm acknowledgement are listed below
according to precedence:
10 ALARM or ACK Activation only when the AL attribute changes (an alarm
comes or goes) or the alarm is acknowledged.
13 WARNING or Activation when the alarm zone (AZ) of an analog input
ACK object changes from the normal zone to a warning zone or
vice versa, or the alarm is acknowledged, see Section 5.3.3
Alarm and warning states.
14 UP or ACK Activation when a binary object (BI or BO) or a double
15 DOWN or binary object (DB) is changed ’up’ or ’down’ or the alarm
ACK is acknowledged.
For binary objects, ’up’ means 0 -> 1 and ’down’ 1 -> 0.
For double binary objects, ’up’ means 1 ->2 and ’down’ 2
-> 1.
The ’forbidden’ transitions of DB objects (from and to
states 0 and 3) cause both UP and DOWN activation.
11 NEW VALUE or Activation each time the value is changed or the alarm is
ACK acknowledged.
12 UPDATE or ACK Activation each time the value is updated (even if it is not
changed) or the alarm is acknowledged. However, if the
cause of transmission (CT) of the update is INTERROG-
ATED and the first update attribute (AF, HF or PU) is 0,
activation is not done. In this case, the update does not
contain any new information.
The criterion based on the alarm state (AS attribute) of the object:
6 ALARM STATE Activation only when the AS attribute changes.
62
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
First update
When an application starts up, the input type process objects that are connected to a
station are marked with NOT_SAMPLED_STATUS, the OS (Object Status) attribute
is set to 10. Normally, the stations are then asked to send the values of all their signals
to SYS600, a General Interrogation is done. The interrogation results in a large number
of process object updates in the process database. These updates are distinguished by
the Cause of Transmission of the update. Its value is INTERROGATED instead of
SPONTANEOUS which is used by consecutive updates sent spontaneously by the station.
Most of these start-up updates only initialize the process object to its current value and
do not represent any event in the station. Therefore, no post-processing should be done.
However, there are applications that want to print or log the start-up value of some
specific process objects or handle them by SCIL in a way or another. To enable this kind
of application dependent tailoring, there is an At First Update attribute for each type of
post-processing (attributes AF, PU and HF). Value 1 of one of these attributes specifies
that the corresponding post-processing is done at the first update. The default value is
0, no post-processing at the first update.
When a SPONTANEOUS update is received from the station, the post-processing is
done regardless of the At Fist Update attribute value even if the status of the process
object is NOT_SAMPLED_STATUS before the update.
Snapshot variables
When an event channel (attribute AN) or a printout (format picture, attribute PF) is
activated by the process database, the snapshot variables are passed as arguments to the
activated object. SCIL code run by the activated object may access these variables as
normal global variables.
Most of the variables are included in the set in order to describe the present state of the
process object, i.e. to take a snapshot of the dynamically changing object. These variables
have the same name as the process object attribute they represent. The others describe
the reason for the activation.
The following variables (by process object type) are included in the snapshot variable
set. Each variable has the value of the attribute by the same name.
• All types: LN, IX, OV, OS, RT, RM, RQ, SX, AL, AS, BL, SB, TM, OR, OF, RA,
RB, PB, XB, HB, UB, CT, OG, QL, TY and SU
• All alarming objects (AC > 0): AR, AT, AM, AQ, YT, YM and YQ
• Binary Input: BI
• Binary Output: BO, SE and SP
• Double Binary: DB
• Digital Input: DI
• Digital Output: DO
• Analog Input: AI, AZ, MV, MT, MM, MQ, WQ, XV, XT, XM and XQ
• Analog Output: AO
• Pulse Counter: PC and EP
• Bit Stream: BS
63
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
This section describes the activation of event channel objects and event objects as a
consequence of a process object update.
64
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Event activation
Event activation is used to implement event based updating of process pictures and other
user interface objects.
When certain changes in the process object take place (see below), an event object by
the name and index of the process object is activated. Event specific SCIL programs for
this particular event in any of the open monitors are then executed. The event program
is defined by #ON command, which can be used in any user interface object, or as an
event method available in Visual SCIL objects. For more information on event objects,
see Chapter 12 Logging profile objects.
A change of any of the following process object attributes causes an event object
activation:
AB, AC, AG, AR, AZ, BL, HB, HI, HO, HW, IU, LA, LI, LO, LW, OF, OR, OS, OV,
PB, RC, SB, TM, SE, SP, SS, UB, XB and user defined attributes.
For attributes PC, RC, SE and SP, any update causes the activation of an event object,
even if the value does not change.
AA Action Activation
This attribute specifies the value changes that activate the event channel. For details of
the activation criteria, see Section 5.2.8 Post-processing.
Data type: Integer
Values: 0 ... 15, the activation criterion, see Section 5.2.8 Post-processing
Default value: 0
Access: No restrictions
Object types: All
AE Action Enabled
This attribute enables or disables the activation of the event channel specified by the AN
attribute of the object.
Data type: Integer
Value: 0 Event channel activation disabled
1 Event channel activation enabled
Default value: 0
Access: No restrictions
Object types: All
65
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
AH Action on History
This attribute specifies whether updates marked HISTORY (see the CT attribute in
Section 5.3.7 Stamps set by the communication system) activate the event channel or
not.
Data type: Integer
Value: 0 No event channel activation at HISTORY events
1 HISTORY events activate the event channel according to the
same activation criterion as the real time data
Default: 0
Access: No restrictions
Object types: All
AN Action Name
The name of the event channel connected to the process object. Several process objects
can have the same event channel. However, each process object can be connected to
only one event channel.
Data type: Text
Value: Object name
Access: No restrictions
Object types: All
EE Event Enabled
This attribute enables or disables the activation of the event object.
Data type: Integer
Value: 0 No event object activation
66
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
TH Threshold
Event channel activation with threshold means that the event channel connected to the
process object is not activated immediately when the value is updated in the process
database. Instead, a certain type of algorithm is used to calculate when the activation is
to happen.
The purpose of thresholding is to lower the load of frequent event channel activations,
for example in cases where the event channel is used to send the value to another control
station via a slow communication channel. Event channel activation with threshold
applies to analog input process objects. TH attribute implements the threshold.
The algorithm used is an integrating threshold algorithm that works as follows:
1. When AI is updated and the new value differs from the last reported value (the value
of AI at the time of last activation), the threshold integral is set to zero and threshold
calculation is started.
2. On each calculation cycle (100 ms in current implementation) the time integral of
the difference between AI and the reported value is added to the threshold integral.
For example, if the reported value is 240.0 and AI is 243.0, value 0.3 is added to
the integral.
3. If the absolute value of the integral reaches or exceeds the TH attribute value, the
associated event channel is activated and the threshold calculation is stopped.
The algorithm guarantees that if the value is changed once and then stays in that new
value, the change is sooner or later reported. The attributes AE and XB are honoured.
AA should be set to UPDATE or NEW VALUE. AF should usually be set to 1 ( as it is
normally not sensible to filter out the first activation). If AF = 1, the event channel is
activated immediately without threshold calculation when the object is updated first time
after the start-up of the application.
If AI crosses a warning or alarm boundary or the status of the object (attribute OS)
changes, the event channel is activated immediately (or after the delay specified by AD)
and the threshold calculation is stopped.
In an HSB system, the intermediate values of the threshold integral are not shadowed
due to excessive load. Consequently, the threshold calculation is started from the
beginning after a switch-over.
Assigning a new value to TH does not restart the possible on-going threshold calculation.
The algorithm always uses the current value of TH.
Data type: Real
67
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 5.4: Event channel activation with threshold. Primary (left) y-axis represents the analog input value, here without
unit. Secondary (right) y-axis is the time integral of the analog input value. The value of the TH attribute in this example is
0,5. When the value of the threshold reaches or exceeds he value of 0,5, an event channel is activated and the threshold
calculation is reset.
68
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
General
There are two ways to store event history:
• Using history database (recommended)
• Using event log and history buffer (supported for compatibility)
Application attribute APL:BHP specifies which one is in use. For more information
about the HP attribute, see the System Objects manual. The System Configuration manual
also explains how to configure storing the event history.
In addition to the common causes of post-processing (attributes listed in Section 5.2.8
Post-processing), changes of the following attributes are logged:
• Operational state attributes IU (In Use) and SS (Switch State)
• Alarm attributes AC (Alarm Class), AG (Alarm Generation), AR (Alarm Receipt)
and LA (Alarm Activation)
• Alarm and warning limits HI (High Input), HW (High Warning), LW (Low Warning),
LI (Low Input), HO (High Output) and LO (Low Output)
• Blocking attributes AB (Alarm Blocking), HB (History Blocking), PB (Printout
Blocking), UB (Update Blocking) and XB (Action Blocking).
The history logging described in this section can be temporarily blocked by means of
the Blocking Attributes (attribute HB, see Section 5.3 Dynamic process object attributes).
History database
History database consists of history database files that each contain the events for one
day. The files are named according to the date as APL_yymmdd.PHD. For example file
APL_980115.PHD contains the events logged on January 15th, 1998. For fast access in
time stamp order, there is also an index file corresponding each data file. The name
extension of the index file is PHI.
Each event in the database contains the values of all attributes of the process object at
the time of event. In addition, some pseudo attributes that describe the event itself are
included, see Section 5.3.13 Event history attributes.
A specialised SCIL function, HISTORY_DATABASE_MANAGER, is designed to
handle the history database, see the Programming Language SCIL manual.
The history database is the basis for event lists made by LIB 500 version 4.0.2. and later.
69
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
PT, OX, OV, OS, AL, AS, AR, AT, AM, RT, RM, YT, YM, OF, OI, BL, SB, OR, RA,
RB, CT, PB, XB, HB, UB, AB, RI, RX, SE, SP, AZ and CA (Changed Attribute, see
Section 5.3.13 Event history attributes).The history buffer is read by process queries
(SCIL command #INIT_QUERY and SCIL function PROD_QUERY).
The history log is an ASCII text file. Each event is described as a long text line (377
characters), which contains the values of the following attributes:
GT (3), PT (3), LN (10), IX (3), CA (2), OV (12), OS (5), UN (3), OA (5), OB (2), OT
(1), RM (3), RT (10), IU (1), SS (1), HA (1), AB (1), AC (1), AL (1), AR (1), AS (2),
AD (3), RC (1), PF (10), OX (30), ST (10), AZ (1), HI (12), HO (12), HW (12), LI (12),
LO (12), LW (12), SZ (1), LA (2), NV (1), AG (1), BC (2), CE (1), CL (10), CO (1),
CV (10), OF (1), SE (1), SP (1), OI (30), BL (1), SB (1), OR (1), RA (11), RB (11), CT
(1), RI (11), RX (10), PH (11), AH (1), HH (1), PB (1), XB (1), HB (1), UB (1), ZE(1),
ZD (12), TH (12), OG (5), QL (5), TY (5), IR(1), SU(1), PO(1).
The numbers within parentheses indicate the field length reserved for the attribute value.
There is no space between the fields. The attribute names are not included in the log.
If a process object has history buffering (HE = 1), the data of the process object will be
copied to the history buffer when any of the following attributes is changed:
• Object value: OV. The OV attribute causes history registrations according to the
HA attribute.
• Operational state: SS, IU
• Limit values: HI, LI, LW, HW, HO, LO
• Alarm definition: AC
• Blocking attributes: AB, HB, PB, UB, XB
• Alarm state: AL, AR
• SE, SP. If HA is other than 0, not only a change but also an updating of these
attributes causes registration in the history buffer. If HA = 0, these attributes cause
no registration in the history buffer.
In addition, each user-defined attribute can be defined to cause a registration in the history
buffer.
The history buffer and the history log are the basis for event lists made by LIB 500
version 4.0.1 and earlier versions of application libraries.
HA History Activation
This attribute specifies the value changes that activate the history logging. For details
of the activation criteria, see Section 5.2.8 Post-processing.
Data type: Integer
Value: 0 ... 15, the activation criterion, see Section 5.2.8 Post-processing
Default value: 0
Access: No restrictions
70
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
HE History Enabled
This attribute specifies whether logging of event history is enabled for the object.
Data type: Integer
Value: 0 History logging is disabled
1 History logging is enabled
Default value: 0
Access: No restrictions
Object types: All
HH History on History
This attribute specifies whether the updates marked HISTORY (see the CT attribute in
Section 5.3 Dynamic process object attributes) are logged or not.
Data type: Integer
Value: 0 HISTORY events are not logged
1 HISTORY events are logged according to the same activation
criterion as the real time data
Default: 0
Access: No restrictions
Object types: All
71
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
The Historian logging attributes specify how the changes of the OV (Object Value)
attribute are stored in Historian database(s). For more information about Historian logging,
see Chapter 12 Logging profile objects.
GN Logging Name
This attribute tells the names of Historian database tags that receive data from this process
object.
Data type: Vector
Element type: List
Element value: DB The name of the DATABASE type logging profile object
that defines the Historian database
GN The name of the tag in this Historian database (see below)
Default: Empty vector
Access: Read-
only
Object types: BI, BO, DB, DI, DO, AI, AO and PC
The tags are finally named by the Historian database itself. When the tag is not yet
created, the GN attribute returns the proposed tag name in square brackets.
GP Logging Profile
This attribute specifies the logging profile to be used when logging values to the SYS600
Historian database(s).
Data type: Text
Value: Name of an OBJECT type logging profile object. If empty, no logging
is done.
Default value: ""
72
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Access: No restrictions
Object types: BI, BO, DB, DI, DO, AI, AO and PC
General
OPC events are generated by the SYS600 OPC A&E Server (OAES), which is an
implementation of the OPC Alarms & Events Custom Interface Standard Version 1.10
specification by OPC Foundation.
Each SYS600 application that wants to expose its events via the OPC Alarms and Events
interface has its own OAES instance (process).
The server is started and stopped by an application attribute (APL:BOE). Starting a server
requires a license.
One OAES instance may serve any number of A&E clients.
Functionality
The OPC A&E events are tightly coupled with the event and alarm handling of SYS600.
Any process object that generates SYS600 events (loggings to the history database), may
act as an OPC A&E event source. History logging and OPC A&E event generation go
hand in hand: The process object attributes HE (History Enabled), HA (History Activation)
and HF (History at First Update) apply to A&E events as well.
Condition events are associated with SYS600 alarms. An A&E condition is active while
the process object is alarming (AL attribute equals 1). Acknowledging the SYS600 alarm
(setting AR to 1) acknowledges the A&E condition as well, and vice versa. Alarm
blocking blocks the condition events as well.
In addition to condition events, any process object may generate either a simple (input
objects) or a tracking event (output objects).
The OV related A&E events to be generated are defined by the associated event handling
object of a process object. Each event handling object may define one simple/tracking
event and one condition event. All the OPC specified properties of events, conditions
and categories are described in event handling objects.
There are two types of predefined event handling objects in SYS600:
• Predefined OV (Object Value) related event handling objects are applied, when no
event handling object is associated with the process object (EH = ""). These event
handling objects are named according to the process object type and subtype. Some
examples are SYS_DI (event handling for Digital Input objects) and SYS_BI_AG0
(event handling for Binary Input objects with Alarm Generation from value 0).
73
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
• There is a predefined event handling object for each non-OV process object attribute,
whose changes are logged in the history database. These are applied regardless of
the EH attribute. These event handling objects are named as SYS_aa, where "aa" is
the name of the changed attribute. Examples: SYS_AC, SYS_UB.
A&E functionality may be added to the predefined event handling by creating new
application default event handling objects. They must be named according to a scheme
used for predefined event handling objects, but the prefix SYS is replaced by APL. For
example, to define the default A&E event handling for all Binary Input objects with
Alarm Generation from value 0, the next steps could be taken:
1. Copy the predefined H-object SYS_BI_AG0 to APL_BI_AG0.
2. Add the A&E definitions to APL_BI_AG0.
Now every AG=0 Binary Input object with EH="" follows this new event handling
object.
The event message texts of A&E event notifications are identical to SYS600 event texts.
Consequently, if they are translated into several languages by the application, an OPC
A&E client may choose the language it wants to receive.
Event sources
The OPC event source name is defined by the process object attribute ES (Event Source).
It is an application-given text, up to 255 characters long.
The event source names are case-sensitive. An OPC event is identified by the source
name and the event handling object of the process object. Consequently, two or more
process objects may share an event source name (ES), provided that they are connected
to different event handling objects (EH). If the ES attribute is left empty, the process
object does not generate OPC events.
Normally, hierarchical event source names are used. By default, the following characters
are considered as delimiters: dot (.), slash (/), backslash(\) and colon (:). The delimiter
character set may be changed by defining the DE sub-attribute of the application attribute
APL:BOP, see the System Objects manual.
An example of a valid hierarchical event source name is:
Eastern Substation:Bay 1/Breaker.Position
where three different delimiters and embedded blanks are used. The area browser of
OAES recognizes the hierarchy. Source names and area names, such as:
Eastern Substation:Bay 1
may be used as filters in an event subscription.
A process object may generate events of two event types. Any alarming process object
may generate condition events. In addition, input objects may generate simple events
and output objects may generate tracking events. The properties of the events are defined
by the event handling object of the process object, see Chapter 6 Event handling objects.
74
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Event categories
The event categories are defined in the event handling objects, see Chapter 6 Event
handling objects.
The category id may be any non-zero integer, the category description may be any text
up to 255 characters long.
Conditions
The properties of conditions, such as condition name, subconditions, severities etc. are
described in the event handling object, see Chapter 6 Event handling objects.
Multiple state conditions are supported. Because SYS600 implements multiple state
alarms only in case of analog objects, they are applicable only for analog input objects.
The subcondition is selected according to the AZ (Alarm Zone) attribute.
As mentioned earlier, SYS600 alarms and A&E conditions go hand in hand:
• Acknowledging a SYS600 alarm by setting AR to 1 also acknowledges the
corresponding A&E condition, if any.
• When an A&E client acknowledges a condition, the corresponding SYS600 alarm
is acknowledged as well.
• If the SYS600 alarm requires an ack, also the A&E condition requires an ack.
No alarm history is maintained for OPC A&E purposes, only the latest condition is
acknowledged.
75
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Engineering
Step-by-step procedure for engineering the process database for an A&E server:
1. Design the event categories and their properties: id, description and event type.
2. Design a grouping of process objects according to A&E events they should generate.
Each process object of a group sends identical events (apart from the source name)
and has the same condition (if any). Design the event and condition properties for
each group (event handling attributes OS and OC).
3. Create an event handling object for each group or extend the existing event handling
object with OPC A&E attributes OG, OS and OC.
4. If appropriate, create application default event handling objects for various process
object types and/or attributes.
5. Design the event source name hierarchy to be used. If the default delimiters are no
good, configure the APL:BOP attribute to define the delimiter characters.
6. Configure the ES (Event Source) attributes of process objects.
7. Connect each event source to its event handling object. This is done by setting the
EH attribute of the process object.
8. Set the OE attribute of the application (APL:BOE) to 1. This starts the OAES process.
The attributes in this section specify the printouts related to the process objects, the
printing devices and the automatic activation of printing procedures on the occurrence
of certain process events. The automatic printing described in this section can be
temporarily blocked by means of the Blocking Attributes (attribute PB, see Section 5.3
Dynamic process object attributes).
LD Listing Devices
The printers to be used for automatic printing of the physical format picture (defined by
the PF attribute, see below). The printers are given as a set of logical printer numbers in
the range 1 ... 15. The logical printer numbers are determined with the printer mapping
attribute (APLn:BPR, see the System Objects manual).
Data type: Integer
Value: 0 ... 65 534, even numbers
76
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Example:
The printer numbers 1, 3 and 5 are alarm and event printers (ABC:PLD2 == 42):
#SET ABC:PLD2 = BIT_MASK(1,3,5)
PA Printout Activation
This attribute specifies the value changes that activate the printout. For details of the
activation criteria, see Section 5.2.8 Post-processing.
Data type: Integer
Value: 0 ... 15, the activation criterion, see Section 5.2.8 Post-processing
Default value: 0
Access: No restrictions
Object types: All
PF Physical Format
The name of the automatically printed picture. This picture is also printed with the
command #LIST (see Chapter 4 Object handling). Each object can have its own physical
format picture, or several objects can share the same picture. When an automatic printout
is activated, a set of argument variables, so called snapshot variables, are passed to the
format picture, see Section 5.2.8 Post-processing.
Data type: Text
Value: Picture name
Access: No restrictions
Object types: All
77
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
PH Printout on History
The attribute specifies whether updates marked HISTORY (see the CT attribute
Section 5.3.7 Stamps set by the communication system) activate automatic printing or
not.
Data type: Integer
Value: 0 No printout activation at HISTORY events
1 HISTORY events are printed according to the same activation
criterion as the real time data
Default: 0
Access: No restrictions
Object types: All
The attributes described below are not configurable by SCIL, they are configured
automatically when a network topology model is imported into the process database.
78
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Object types: NT
When the value of the process object changes, recalculation of the network topology is
triggered via this attribute.
79
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
7 Transformer winding 3
8 Transformer winding 4
9 Line indicator
10 Truck
11 Generator
Default value: 0
Access: Read-only
Object types: NT
RO Referenced Objects
The (non-NT) process objects referenced by this object.
Data type: Vector
Element type: List
The name of the attribute tells the type of the reference, the value
specifies the referenced object. The reference types of the POWER
schema are the following:
TS Topological state indicator
LV Voltage level indicator
CH The child switching device of a truck
AP The auxiliary plug of a truck
PR The truck object of the child
Element value: LN Logical name of the referenced object
IX Logical index of the referenced object
Default value: Empty vector
Access: Read-only
Object types: NT
CE Counter Enabled
Operation counting is taken into use by setting this attribute to one.
Data type: Integer
80
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Value: 0 No counting
1 Counting in use
Default: 0
Access: No restrictions
Object types: BI, BO, DB and OE
CL Counter Limit
The upper limit for the counter. When the counter value (the CV attribute) exceeds this
limit, counter overflow (the CO attribute) is set.
Data type: Integer
Default: 0
Access: No restrictions
Object types: BI, BO, DB and OE
DX Directive Text
This attribute is reserved by ABB and should not be used in application programs.
FI Free Integer
An integer attribute that can be freely used for any application purpose.
Data type: Integer (32 bits)
Default value: 0
Access: No restrictions
Object types: All
FX Free Text
A text attribute that can be freely used for any application purpose.
Data type: Text
Value: Up to 63 characters
Default value: ""
Access: No restrictions
Object types: All
81
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
GI Gateway Information
An integer attribute reserved for use of standard gateway applications, such as COM 500i.
Data type: Integer
Default value: 0
Access: No restrictions.
Object types: All
RI Reserved Integer
An integer attribute reserved for use of standard application software, such as LIB 500.
Data type: Integer
Default value: 0
Access: No restrictions.
Object types: All
RX Reserved Text
A text attribute reserved for use of standard application software, such as LIB 500.
Data type: Text
Value: Up to 63 characters
Default value: ""
Access: No restrictions.
Object types: All
RZ Reserved Z
An integer attribute reserved for use of tagout functionality.
Data type: Integer
Default value: 0
Access: No restrictions.
Object types: All
82
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
within each sub-sectionThe attributes are in alphabetical order within each sub-section.
The attributes described in this section represent the actual value of the object. For real
objects (process objects connected to the process), the object values of input type are
automatically updated from the process stations. The object values of output type are
sent out to the process stations when set with the #SET command.
83
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
AI Analog Input
An analog input value (measured value) from the station via the communication system
to the base system. The value is scaled in the process database according to the scale
defined by the SN attribute (see Section 5.2.4 Operational state and Chapter 7 Scales).
Data type: Real, if IR = 0
Integer, if IR = 1
Default value: 0
Access: Read, conditional write. The attribute can be written only if the switch
state is manual (SS = 1) or fictitious (SS = 3), or if its UN = 0 and SS
= 2.
Object types: AI
AO Analog Output
An analog output value (for example a set value, an analog setpoint, general output)
from the base system to the station, via the communication system. The value is scaled
according to the scale given by the SN attribute (see 3.2.4.) before it leaves the process
database.
Data type: Real, if IR = 0
Integer, if IR = 1
Default value: 0
Access: Read, conditional write. The attribute cannot be written if the process
object is OFF (SS = 0).
Object types: AO
BI Binary Input
A binary input signal (indication) from the station to the base system via the
communication system.
Data type: Integer
Value: 0 or 1
Default value: 0
Access: Read, conditional write. The attribute can be written with SCIL if the
switch state is manual (SS = 1) or fictive (SS = 3) or if its UN = 0 and
SS = 2, but not otherwise.
Object types: BI
84
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
BO Binary Output
A binary output signal (control signal, object command, regulation command) from the
base system via the communication system to the station.
Data type: Integer
Value: 0 or 1
Default value: 0
Access: Read, conditional write. The attribute cannot be written if the process
object is OFF (SS = 0).
Object types: BO
BS Bit Stream
An output and input signal of bit string type.
Data type: Bit string
Value: Maximum length 1 808 bits, if connected to the process, otherwise
65 535 bits
Access: Read, conditional write. The attribute cannot be written if the process
object is OFF (SS = 0).
Object types: BS
Bit stream objects may also be used to receive text (VT_BSTR) data from an OPC Data
Access Server. In this case, the maximum length of the bit string is 65528 bits, equivalent
to 8191 characters. The BS value is converted to text by the SCIL function TYPE_CAST,
see the Programming Language SCIL manual.
Example:
@MY_TEXT = TYPE_CAST(ABC:PBS1, "TEXT") ;Read the BS value as text
85
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Access: Read, conditional write. The attribute can be written only if the switch
state is manual (SS = 1) or fictitious (SS = 3) or if its UN = 0 and SS
= 2.
Object types: DB
The semantics of values 1 and 2 may be swapped by STA:BSM (Switch State Mapping)
attribute, or application wide by APL:BSM attribute. For details, see the System Objects
manual.
DI Digital Input
A digital input value from the station via the communication system to the base system.
Data type: Integer
Value: 0 ... 65 535 (16 bits)
Default value: 0
Access: Read, conditional write. The attribute can be written only if the switch
state is manual (SS = 1) or fictitious (SS = 3) or if its UN = 0 and SS
= 2.
Object types: DI
DO Digital Output
A digital output value (digital setpoint) from the base system via the communication
system to the station.
Data type: Integer
Value: 0 ... 65 535 (16 bits)
Default value: 0
Access: Read, conditional write. The attribute cannot be written if the process
object is OFF (SS = 0).
Object types: DO
86
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
3 Powered
4 Error
5 Earthed
Default value: 0
Access: Read-only
Object types: NT
OE OPC Event
A numeric value corresponding to the state of the OPC condition or to the message last
received (see Section 5.3.10 OPC Event objects).
Data type: Integer
Value: 0 ... 255
Default value: 0
Access: Read-only
Object types: OE
OV Object Value
The OV attribute of output objects of IEC/REX type (BO, DO, AO, BS) is set with syntax
given in Table 5.4. For an object of IEC/REX type in auto state only output objects (BO,
DO, AO, BS) is set with syntax given in Table 5.4.
The intended use of the OV attribute is:
1. As a comprehensive name for one of the attributes AI, AO, BI, BO, BS, DI, DO,
DB, PC, OE, NT and FT depending on the object type. For user-defined object types,
the programmer selects which attribute, if any, will be the OV attribute. Setting the
OV attribute of an input object is meaningful only in case the object is in manual
or fictitious state.
2. As default attribute when no attribute name is given at assigning a value of an object.
For example, the #SET commands:
#SET A:PAI1 = 0
#SET A:POV1 = 0
#SET A:P1 = 0
87
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
where 'exp1', 'exp2', 'exp3' etc. are expressions assigned to the attributes. The part
within square brackets can be omitted, whereby the RM and OS attributes are set
to 0. Attributes RT and RM are assigned values at registration time if not given in
the list. Attributes TY, QL and OG apply to IEC/REX type objects only. For objects
of type IEC/REX also the OV attribute is optional.
Also the stamps set in the stations (see Section 5.3.7 Stamps set by the communication
system) can be written in this way.
Data type: Integer, real or bit string
Value: Integer 0 or 1 for binary objects
Real or integer for analog objects
Integer for DI, DO, PC, FT, OE and NT objects
Integer 0 ... 3 for DB objects
Bit string for BS objects
Default value: 0
Access: See the AI, AO, BI, BO, BS, DI, DO, DB, PC, FT, OE and NT attrib-
utes
Object types: All
Example:
#SET A:P2 = LIST(OV=3.0,RT=B:PRT,RM=B:PRM)
or
#SET A:POV2 = LIST(OV=3.0,RT=B:PRT,RM=B:PRM)
PC Pulse Counter
A pulse counter value from the station. The type of reading when the process object
belongs to a S.P.I.D.E.R. RTU (“End of period” or “intermediate”), is given by the EP
attribute of the object, see Section 5.3.8 S.P.I.D.E.R. RTU specific attributes.
Data type: Integer
Value: The value range is station type and protocol dependent.
Default value: 0
Access: Read, conditional write. The attribute can be written only if the switch
state is manual (SS = 1), or fictitious (SS = 3) or if its UN = 0 and SS
= 2.
Object types: PC
88
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
SX State Text
A descriptive text of the object value.
Data type: Text
Value: A descriptive text of the object state in the current language
Default value: Empty text
Access: Read-only
Object types: All
The text is obtained from the event handling object referenced by the EH attribute of the
process object.
TS Topological State
The value of the object (OV) interpreted as a topological state.
Data type: Integer
Value: 0 .. 3 In the topology schema POWER, the semantics of numeric
values is as follows:
0 Intermediate (middle) state
1 Closed
2 Open
3 Faulty state
Access: Read-only
Object types: BI, DB
For Binary Input (BI) objects, BI value 0 represents topological state 2 (open) and value
1 represents state 1 (closed) in the POWER schema.
For Double Binary (DB) objects, TS is determined according to the Topological State
Mapping (SM) attribute of the station object and/or the application. If the SM attributes
are not set, TS follows the value of DB (in any schema).
For details of the SM attribute (STAn:BSM and APLn:BSM), see the System Objects
manual.
These attributes are related to the object value. Each update of the object value in the
process database gets a validation stamp (the OS attribute) and time stamp (the RT, RM
and RQ attributes), regardless of whether the object value changes or not. For output
objects, the CS attribute stores the success code of the latest control attempt for tracking
purposes.
89
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
CS Control Status
Status of the latest attempt to control the object.
Data type: Integer
Value: 0 ... 65535 The status code of the latest attempt to set the OV attribute
of the object by SCIL.
Default value: 10 (NOT_SAMPLED_STATUS)
Access: Read-only
Object types: BO, DO and AO
OS Object Status
The status code of the process object. This attribute indicates the reliability of the object
value (the OV attribute).
Data type: Integer
Value: 0, 1, 2, 3 or 10:
0 OK_STATUS
1 FAULTY_VALUE_STATUS. The station has marked the
process object value faulty. An update with this status sets
the object to alarm state (AL = 1), provided that AC > 0
(Section 4.2 Using application objects in SCIL). The alarm
state prevails until a new update comes with OS = 0.
2 OBSOLETE_STATUS. The value is uncertain, it is possible
that it is not up-to-date. The connection to the station is (or
has been) lost. At application start-up, non-manual output
objects are marked with this status.
3 FAULTY_TIME_STATUS. The station has marked the re-
gistration time faulty.
10 NOT_SAMPLED_STATUS. The object value has not yet
been initialized. At application start-up, non-manual input
objects are marked with this status. This status is also set
when a modification of an object invalidates its object value,
for example SS or IU or the object address is changed.
Access: Read-only. The OS attribute can be set manually along with the OV
attribute, see the OV attribute, Section 5.3.1 Object value.
Object types: All
90
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
RM Registration Milliseconds
The milliseconds of the registration time. See attribute RT for the originator of this
attribute value.
Data type: Integer
Value: 0 ... 999
Unit: Milliseconds
Access: Read-only. The RM attribute can be set manually along with the RT
and OV attributes, see the OV attribute, Section 5.3.1 Object value.
Object types: All
RT Registration Time
The time when the object was last updated.
The time stamp may originate from the station, NET or the base system. If the update
from NET contains a time stamp (stamped by the station or NET itself), the time is copied
to the RT attribute. If the time stamp does not contain a date, the date is supplied by the
base system. If the update does not have a time stamp at all, the RT attribute is set
according to the base system time. When an object is updated with SCIL (with #SET),
the time stamp is always given by the base system.
Output objects are time stamped before the command is sent to NET. The RT attribute
of BO type objects is also updated when SE or SP is set (Section 5.3.8 S.P.I.D.E.R. RTU
specific attributes).
91
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
If an object has an alarm delay (the AD attribute, Section 4.2 Using application objects
in SCIL), the RT attribute is updated when the alarm delay expires.
Data type: Time
Initial value: Application start-up time
Access: Read-only. The RT attribute can be set manually along with the OV
attribute, see Section 5.3.1 Object value.
Object types: All
The attributes in this section show the alarm and warning states of the process objects.
Alarm and warning handling is defined by the alarm handling attributes in Section 5.2.6
Alarm handling and the limit values in Section 5.2.7 Limit value supervision.
AL Alarm
This attribute indicates whether alarm is active or not.
Data type: Integer
Value: 0 No alarm
1 Alarm is active
Access: Read-only
Object types: All
AR Alarm Receipt
Status of acknowledgement. This attribute indicates whether or not the alarm has been
acknowledged.
Data type: Integer
Value: 0 The alarm is not acknowledged
1 The alarm is acknowledged or there is no demand for acknow-
ledgement
Access: No restrictions
Object types: All
AS Alarm State
The alarm state is a number calculated from the alarm class (AC), the alarm (AL) and
the state of acknowledgement (AR).
Data type: Integer
92
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
When an alarm arises, the attribute gets the value of AC (1 ... 7), if RC = 1, and AC + 7,
if RC = 0. When the alarm is acknowledged, 7 is added to the attribute value. When the
alarm disappears, the attribute gets the value 0, supposing that it has been acknowledged,
or there is no demand for acknowledgement.
AM Alarm Milliseconds
The milliseconds of the alarm time (see the AT attribute below), that is, the time when
an alarm last arose or was cleared. Generally, the alarm milliseconds are the same as the
RM attribute of the update that caused the change of alarm state. However, in case the
object has an alarm delay there may be a difference, see the AT attribute.
Data type: Integer
Value: 0 ... 999
Initial value: Application start-up time
Unit: Milliseconds
Access: Read-only
Object types: All
AT Alarm Time
The alarm time when an alarm last arose or was cleared (in one second resolution).
Generally, the alarm time is the same as the RT attribute of the update that caused the
93
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
change of alarm state. If the object has an alarm delay, the AT and AM attributes are
updated when an alarm occurs. The RT and RM attributes are updated when the alarm
delay expires.
Data type: Time
Initial value: Application start-up time
Access: Read-only
Object types: All
AZ Alarm Zone
The alarm and warning state of the object, see Figure 5.5. Depending on the SZ attribute,
the value of the AZ is set either by SYS600 according to the limit values or by the station,
see Section 5.2.7 Limit value supervision.
Data type: Integer
Value: 0 ... 4:
0 Normal state
1 Low alarm
2 High alarm
3 Low warning
4 High warning
Access: Read-only
Object types: AI and user-defined types with real or integer value
OV
AZ = 2
Higher Input, HI
AZ = 4
Higher Warning, HW
AZ = 0
Lower Warning, LW
AZ = 3
Lower Input, LI
AZ = 1
Illustration_AZ_attribute
94
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
95
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
YT Alarm On Time
The time when an alarm last occurred in the object (in one second resolution). This
attribute is identical to the AT attribute while the object alarm is active. Unlike the AT
attribute, the YT attribute is not updated when the alarm is cleared.
Data type: Time
Initial value: 0
Access: Read-only
Object types: All
The following attributes are used to temporarily block the updating of a process object
or to block alarm generation and post-processing (printouts, event channel activation
and history logging) normally caused by process object update. The values of the blocking
attributes are stored on disk. Like the dynamic attributes, they are included in the Snapshot
variable list. The setting of any of the attributes is logged in the history database. Also,
an event is generated.
AB Alarm Blocking
Blocks alarm generation of the object.
Data type: Integer
Value: 0 No blocking
1 Alarm generation is blocked
Default value: 0
Access: No restrictions
Object types: All
When AB is set to 1, the alarm state of the object is cleared. When it is reset to 0, the
alarm state is recalculated unless prevented by revision compatibility (APL:BRC) setting
DONT_RECALCULATE_AL_AFTER_ALARM_BLOCKING. No printout or event
channel is activated even if the alarm state is changed.
HB History Blocking
Blocks logging of the history of the object.
Data type: Integer
Value: 0 No blocking
1 History logging is blocked
Default: 0
96
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Access: No restrictions
Object types: All
When history registration is blocked, no events are written into the history database.
Consequently, no events of the object are seen in the event list
PB Printout Blocking
Blocks printout generation of the object.
Data type: Integer
Value: 0 No blocking
1 Printouts are blocked
Default: 0
Access: No restrictions
Object types: All
UB Update Blocking
Blocks updating of the value of the object (OV attribute).
Data type: Integer
Value: 0 No blocking
1 Updating is blocked
Default: 0
Access: No restrictions
Object types: All
When the object is blocked (UB = 1), it is not updated by the process, nor from SCIL.
An error is raised if the OV value is tried to be set by SCIL. Consequently, both input
and output via the OV attribute is blocked. The OV attribute may, however, be read by
SCIL.
When UB is set to 1, the OS attribute of the object is set to OBSOLETE_STATUS (2)
to indicate that the value may be outdated.
XB Activation Blocking
Blocks event channel activation.
Data type: Integer
Value: 0 No blocking
1 Event channel activation is blocked
Default: 0
97
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Access: No restrictions
Object types: All
These attributes are used for counting the operations of an object. They can be used, for
example, for monitoring the need for service. The attributes are valid for BI, BO, DB
and OE objects.
CO Counter Overflow
This attribute is set to 1 when the CL attribute (Counter Limit) is exceeded.
Data type: Integer
Value: 0 No overflow
1 Overflow
Access: Read-only
Object types: BI, BO, DB and OE
CV Counter Value
This attribute counts the changes of the object value (see below).
Data type: Integer
Initial value: 0
Access: No restrictions
Object types: BI, BO, DB and OE
For BI, BO and DB objects, the counter is incremented when the object value changes
to 1 (from any other value).
For OE objects, the counter is incremented when the condition enters the active state
(CONDITION events) or on every event (SIMPLE and TRACKING events).
The attribute can be reset with SCIL (no automatic reset). The value is stored on disk.
The attributes in this section apply to analog input (AI) objects. All the minimum and
maximum attributes are stored on RAM only, not on disk. They are passed as snapshot
variables to format pictures and event channels.
98
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
MT Minimum Time
The time in seconds when the minimum value (the MV attribute) occurred.
Data type: Time
Access: Read-only
Object types: AI
MV Minimum Value
Records the lowest value of the AI attribute since the last reset. At the first update of the
object after application start-up, the MV attribute is reset to the current value. It may
also be reset by SCIL by writing any value into the MV attribute (normally it is reset to
the current value of AI).
Data type: Real, if IR = 0
Integer, if IR=1
Default: The value of the object at application start-up
Access: No restrictions
Object types: AI
99
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
XT Maximum Time
The time in seconds when the maximum value (the XV attribute) occurred.
Data type: Time
Access: Read-only
Object types: AI
XV Maximum Value
Records the highest value of the AI attribute since last reset. At the first update of the
object after application start-up, the XV attribute is reset to the current value. It may also
be reset by SCIL by writing any value to the XV attribute (normally it is reset to the
current value of AI).
Data type: Real, if IR = 0
Integer, if IR=1
Default: The value of the object at application start-up
Access: No restrictions
Object types: AI
100
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
The attributes in this section contain information set in NET on the basis of stamps set
by the process units (in the relays or RTUs) in accordance with the used protocol. If the
communication protocol supports these attributes, they are updated in the process database
along with the object value. The following rules apply for the BL, SB, TM, OR and OF
attributes:
• A change of a quality attribute generates an event if EE = 1.
• A change of a quality attribute activates an event channel, a printout and/or history
logging if the activation is enabled (AE == 1, LD <> 0 or HE == 1) and the activation
criterion (AA, PA or HA) is NEW VALUE or UPDATE.
• In such activation, the changed attribute is reported as the value of CA pseudo
attribute. If more than one attribute is changed at the same time, each change will
be reported separately in any order. For example, if OV changes from 0 to 1 and
SB from 1 to 0, two activations occur, one with CA == "BI", BI == 1 and SB == 0,
the other with CA == "SB", BI == 1 and SB == 0.
• When the switch state (SS) or the substitution state (SU) of the object is changed,
the quality attributes are set to 0.
RA and RB attributes are of informative character and do not affect the function of the
process object. The CT attribute affects the activation of the post-processing.
These attributes are supported by multiple protocols, see protocol specific manuals for
details. If a protocol does not support the attributes, they can still be used, but must be
set with SCIL. However, the attributes cannot be set one by one using the #SET command.
They may only be set along with the OV attribute using list value in the #SET command,
see the OV attribute in Section 5.3.1 Object value.
All attributes in this section are stored only in RAM.
BL Blocked
The updating of the value has been blocked in the relay.
Data type: Integer
Value: 0 Not blocked
1 Blocked
Access: Read-only. Can be written together with the OV attribute, see Sec-
tion 5.3.1 Object value.
Object types: All
CT Cause of Transmission
The type of the data transmission from the station to the process database. The function
of the CT attribute can be determined by setting a base system STY object attribute, see
the System Objects manual.
There are the following types of data transmission:
101
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
If CT = UNKNOWN, the process object is updated in the process database and the
consequential actions (post-processing) takes place according to the activation attributes,
that is, the update is regarded as spontaneous.
If CT = SPONTANEOUS, there is a slight difference in the case of the first update of
the process object (when OS is 10 before the event). Post-processing (printout, event
channel activation and history logging) is done regardless of the value of the
corresponding control attribute (PU, AF or HF, Section 5.2 Configurable process object
attributes).
If CT = INTERROGATED and the object value has not changed, there is a slight
difference in the post-processing when the activation criteria is UPDATE, see the AA,
HA and PA attributes in Section 5.2 Configurable process object attributes.
If CT = HISTORY, the process database is not updated at all. Only post-processing
(printout, event channel activation and/or history logging) is done. The snapshot variable
list and the history buffer (and history log) entry contains the received OV value and the
received communication protocol attribute values. The rest of attributes are copied from
the process object. The pseudo-attribute CA is set to "CT".
Data type: Integer
Value: 0 ... 255 as defined by the CT attribute of the station type (the
STYn:BCT attribute, see the System Objects manual. The following
values apply to stations of type REX:
0 UNKNOWN (applies to all station types)
1 SPONTANEOUS
2 INTERROGATED
3 HISTORY
Value 0 may mean that the attribute is not supported by the protocol.
Default value: 0
Access: Read-only. The attribute can be written along with the OV attribute,
see Section 5.3.1 Object value.
Object types: All
102
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
OR Out of Range
The station cannot handle the signal read from the process. An example could be that
the signal value is larger or smaller than the range supported by an analog/digital
converter.
An alarm is generated when this attribute is set to 1 unless prevented by revision
compatibility (APL:BRC) value "NO_ALARM_BY_OR_AND_OF".
Data type: Integer
Value: 0 OK
1 Out of range
Access: Read only. The attribute can be written along with the OV attribute,
see Section 5.3.1 Object value.
Object types: All
RA Reserved A
RB Reserved B
These attributes are used for protocol dependent data in various ways in different
protocols. In slave protocols, these attributes are used by the COM500i application. See
the protocol specific manuals for more information.
In the RP571 protocol these attributes are used as follows:
RA Relative time
RB Event number
Data type: Integer
Access: Read only. The attribute can be written along with the OV attribute,
see Section 5.3.1 Object value.
Object types: All
SB Substituted
The value read from the process has been substituted by another value in the station. For
example, the value has been changed manually on the relay front panel.
Data type: Integer
Value: 0 Not substituted
1 Substituted
Access: Read-only. The attribute can be written along with the OV attribute,
see Section 5.3.1 Object value.
Object types: All
103
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
TM Test Mode
The device is in test mode.
Data type: Integer
Value: 0 Not in test mode
1 In test mode
Access: Read-only. The attribute can be written along with the OV attribute,
see Section 5.3.1 Object value.
Object types: All
EP End of Period
This attribute tells the type of pulse counter reading. Each pulse counter update has this
attribute.
Data type: Integer
Value: 0 Intermediate reading
1 End of period reading
Initial value: 0
Access: Read-only
Object types: PC
OF Overflow
This attribute indicates whether there is an overflow in the event recording buffer or
pulse counter history buffer of the RTU.
The attribute is only valid for pulse counters and event recording objects (see 3.3). Each
update of these objects, originating from the RTU, contains the OF attribute.
An alarm is generated when this attribute is set to 1, unless prevented by revision
compatibility (APL:BRC) value "NO_ALARM_BY_OR_AND_OF".
Data type: Integer
Values: 0 No overflow
1 Overflow
Access: Read-
only
Object types: All (meaningful only for some types, however)
104
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
SE Selection
Selecting the object means that SYS600 performs a check-back before executing the
operation.
Selection of a IEC or REX type object in manual or fictitious state is done with the
predefined semantics given in Table 5.4. For an object of IEC/REX type in auto state
only output objects (BO, DO, AO, BS) are set with #SET LIST command, see Table 5.4.
Data type: Integer
Value: 0 Cancelling the selection (IHC)
1 Selection (CBXC)
Default value: 0
Access: Read, conditional write. It can be written with #SET.
Object types: BO,
AO
Example:
#ERROR CONTINUE
#IF CMD:PSE1 == 0 #THEN #BLOCK
#SET CMD:PSE1 = 1
#IF STATUS == 0 #THEN #BLOCK
#SET CMD:PBO1 = 0
#IF STATUS <> 0 #THEN !SHOW ERROR "FAILED"
#BLOCK_END
#ELSE !SHOW ERROR "SELECTION FAILED"
#BLOCK_END
#ELSE !SHOW ERROR "ALREADY SELECTED"
If not already selected, the command object CMD1 is selected, otherwise an error message
"ALREADY SELECTED" is displayed. If the selection succeeded, the command object
is set to 0, otherwise an error message "SELECTION FAILED" is displayed. If the set
operation did not succeed, an error message "FAILED" is displayed.
SP Stop Execution
Writing to this attribute interrupts the RTU200 object command under execution.
Data type: Integer
Value: 1
Access: Read, conditional write. It can be written with #SET.
Object types: BO
105
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Example:
#SET CMD:PSP5
The following attributes implement the protocol specific information used by IEC, REX
and DNP communication.
These attributes have a predefined semantics only for IEC, REX and DNP stations. For
output objects, they are configuration attributes that are sent within ACP messages (see
below). For input objects, they are dynamic attributes received in ACP messages. The
attributes are included in the snapshot variable lists. To fully support selection and its
cancellation in these protocols, the schema presented in Table 5.4 is to be used.
CT, OG and TY are always sent in the ACP message if corresponding attribute is specified
on the #SET list. If they are not on the list, the values in the corresponding database
attributes are sent unless they are zero.
Table 5.4: Schema concerning SCIL interface, process database and ACP
messages. SOV stands for Selected OV, a value stored in the database (without a
SCIL attribute name)
Action SCIL Process database
Select Open #SET n:PSEi= SE=1, SOV=OV
list(OV=’open’[,CT=a][,OG=b][,TY=c])
Select Close #SET n:PSEi= SE=1,SOV=OV
list(OV=’close’[,CT=a][,OG=b][,TY=c])
Select Deactivate #SET n:PSEi=0 | SE=0
#SET n:PSEi=list(SE=0[,CT=a][,OG=b][,TY=c])
Execute Open #SET n:POV=’open’ | OV=’open’, SE=0
#SET n:POVi=
list(OV=’open’[,CT=a][,OG=b][,TY=c])
Execute Close #SET n:POVi=’close’ | OV=’close’, SE=0
#SET n:POVi=
list(OV=’close’[,CT=a][,OG=b][,TY=c])
Execute Deactivate #SET n:PSEi=0 | SE=0
#SET n:PSEi=list(SE=0[,CT=a][,OG=b][,TY=c])
OG Originator Identification
Defines the source of the data for both input and output objects. For input objects, this
is dynamic information and for output objects a configuration attribute. OG is sent along
the ACP message in control messages if its value differs from 0. See also Table 5.4.
Data type: Integer
Value: 0 … 65 535
Access: No restrictions
106
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
QL Command Qualifier
Extra qualifier for commands and various purposes, for both input and output objects.
For input objects this is dynamic information, and for output objects a configuration
attribute. QL is sent along the ACP message in control messages if its value differs from
0. See also Table 5.4.
Data type: Integer
Value: 0 … 65 535
Access: No restrictions
Object types: All
TY Type Identification
Defines how the command should be interpreted by the communication unit, (e.g.
single/double bit command, regulating step command). For input objects this is dynamic
information, and for output objects a configuration attribute. TY is sent along the ACP
message in control messages if its value differs from 0. See also Table 5.4. ASDU type
or number of received command or indication is written to the TY attribute of the input
process object. The ASDU types vary according to the used protocol. For example,
ASDU type 45 for IEC60870-5-101 protocol is IEC single command.
Data type: Integer
Value: 0 ... 65 535
Access: No restrictions
Object types: All
OPC Event (OE) type process objects are defined to receive event notifications from
OPC A&E servers according to the Alarms and Events Custom Interface Standard,
Version 1.10, by OPC Foundation.
OPC Event objects may be created only into a unit that is connected to a station object
of OAE type. Furthermore, the node (ND) attribute of the station object must denote an
OPC_AE type node. On the other hand, an OAE unit may contain only OE type process
objects. Because of these restrictions, the following steps must be taken before any OPC
Event object may be created in unit u:
1. Create a node object (NODn:B) for the OPC A&E server. The type of the node
object is OPC_AE (NODn:BNT = "OPC_AE") and the attribute NODn:BOP
describes the OPC A&E server.
2. Create a station object (STAu:B) for unit u. The type of the station is OAE
(STAu:BST = "OAE") and the station is linked to node object n (STAu:BND = n).
107
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
For details of the node and station objects, see the System Objects manual.
Basic functionality
The basic functionality of an OPC Event object is to receive event notifications from an
OPC A&E server and store the received data in various attributes of the object.
The name of the event source is defined by the IN (Item Name) attribute of the object.
The EH (Event Handling) attribute of the object is left empty if only the basic functionality
is used by the application. In this case, the IN attribute must be unique within the unit
(UN).
No SYS600 alarm handling is done. The value of the OE attribute is always 0. If history
logging is enabled (HE = 1), the received message text (attribute VM) is used as the
message text identifier for the SYS600 event list.
Application specific actions may be taken by designing a command procedure run by
the associated event channel object (attribute AN, Action Name). All of the OPC Event
specific attributes are passed as snapshot variables to the command procedure.
Full functionality
Full functionality of OE Event objects includes the basic functionality plus the following:
• Differentiation between the three event types defined by the OPC standard (simple,
tracking and condition events)
• Several OPC Event objects for one event source to facilitate different handling of
different events from the same source
• Translation of event message texts to numerical values of the process object (attribute
OE)
• Alarm handling of condition events
• Full support for SYS600 history database, e.g. multilingual application support
The full functionality is obtained via an event handling object linked to the OE object
(attribute EH, Event Handling).
The event handling object specifies
1. which type of events the process object is to receive
2. how the numeric value of the process object is deduced from the contents of the
event notification
3. how the OPC event is stored in the history database.
There may be up to 200 OE process objects sharing the same IN attribute value (i.e. the
same OPC event source), provided that each of them is connected to a different event
handling object. For example, an OPC event source may send a simple event, a tracking
event and two different condition events. Thus, four OE process objects are created to
catch the events.
Alarm handling of condition events is enabled simply by defining the alarm class (attribute
AC) of the OE process object.
108
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
For the details of event handling objects, see Chapter 6 Event handling objects.
There are OPC servers that do not report anything about the
! event sources currently unreachable by the server. For example,
if there are three devices connected to one OPC server and the
connection to device 3 is broken for a reason or another, the
server may report active conditions from devices 1 and 2 but
nothing from device 3. Relying on the standard, the client (here
SYS600) draws the conclusion that all the conditions of device
3 are inactive.
To ease the engineering of OE objects, two new SCIL functions have been implemented.
• OPC_AE_NAMESPACE browses the name space, i.e. event categories, conditions
and event sources of any OPC A&E server. The results may be used to construct
the corresponding OE process objects and event handling objects in the process
database.
• OPC_AE_VALIDATE may be used to check the configuration. It cross-checks the
process database and the name space of the OPC A&E server and reports any
discrepancies found. For details, see the Programming Language SCIL manual.
Another problem related to the initial values of condition events may arise when an OE
object is created on-the-fly. The base system tries to read the current state of the condition
by using the method IOPCEventServer::GetConditionState. However, this method is
optional and not all OPC A&E servers have implemented it.
109
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
The state of all the condition events may be refreshed by the SCIL function
OPC_AE_REFRESH, see the Programming Language SCIL manual for details.
The substitution mechanism is used, the SU attribute value 1 in the process object indicates
here that the OS value is manually set. If the object has no value (OS = 10), the command
does nothing, the OS stays as 10 and SU as 0.
When the object later receives a genuine event notification from the server, both SU and
OS will be automatically reset to 0.
Alarm acknowledgement
Active OPC A&E conditions (alarms) are acknowledged by SCIL function
OPC_AE_ACKNOWLEDGE, see the Programming Language SCIL manual for details.
The function takes four arguments that are passed to the A&E server:
• Acknowledger ID is a text string that identifies the acknowledger
• Comment is a free text supplied by the acknowledger
• Cookie is the value of the CK attribute of the event to be acknowledged
• Active Time is the value of the CQ attribute of the event to be acknowledged
The "Cookie" and "Active Time" arguments are used to identify the event to be
acknowledged. These are needed because the semantics of acknowledgement in the OPC
specification is more or less tricky: An OPC A&E server may (but is not required to)
track alarms, i.e. to maintain a queue or list of unacknowledged alarms of a single source,
110
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
and it may require that all of them be acknowledged. So, if a condition becomes active
and then inactive without being acknowledged, and then active again, there may be two
alarms to be acknowledged.
By default, the SYS600 alarm handling and the OPC A&E alarm handling are totally
independent. SYS600 alarms are acknowledged by setting the AR attribute of the process
object to 1. OPC A&E alarms are acknowledged by SCIL function
OPC_AE_ACKNOWLEDGE.
If the application wants to couple these two types of alarms, the AA (Auto Acknowledge)
field of the OP attribute of the A&E server’s node object is set to 1. In this case, setting
the AR attribute of the process object generates an automatic acknowledgement to the
A&E server, provided that the process object is related to a condition event and that
condition is currently active.
The four acknowledgement arguments discussed above have the following values:
• The name of the MicroSCADA user who acknowledges the alarm is used as the
Acknowledger ID.
• Comment is a null string.
• Cookie and Active Time are the ones received in the latest event notification.
SYS600 does not maintain any list of unacknowledged A&E alarms. Consequently, it
is possible that ’old’ alarms cannot be acknowledged using the Auto Acknowledge
feature.
111
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
CK OPC Cookie
Server defined cookie associated with the event notification.
Data type: Integer
Value: OPC server specific values
Access: Read-only
Member: dwCookie
This value along with the CQ attribute value is used to identify the event to be
acknowledged with the SCIL function OPC_AE_ACKNOWLEDGE.
112
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
This value, along with the CK attribute value, is used to identify the event to be
acknowledged with the SCIL function OPC_AE_ACKNOWLEDGE.
ID OPC Actor ID
The actor ID of a tracking event or the acknowledger ID of a condition event.
Data type: Text
Value: OPC server specific
Access: Read-only
Member: szActorID
The value of this attribute is used as the user name (event attribute US) in the
post-processing of the event.
113
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
OE OPC Event
This attribute contains the numeric value of the OE type process object. This is the main
attribute of the object (OV, Object Value).
Data type: Integer
Value: 0 ... 255
Access: Read-only
The value of this attribute is deduced from the contents of the OPC event notification.
If no event handling object is associated with the object (EH = ""), the value is always
0. Otherwise, the following rules are applied:
• For simple and tracking events, the event message list (attribute EM of the associated
event handling object) is searched for the message received in the event notification
(attribute VM). If the event message matches the first message of the list, OE is set
0. If it matches the second message, OE is set to 1, etc. If no match is found, OE is
set to the length of the list, i.e. the last ’valid’ value + 1. If the EM attribute of the
event handling object is not given, OE is always set to 0.
• For condition events, OE is set to 0 if the condition is inactive.
• If the condition is active and the condition is a simple condition (having no
sub-conditions), OE is set to 1.
• If the source is in a sub-condition state, the OE is set to the ordinal number of the
current sub-condition. The sub-conditions are numbered by the order they are listed
in the SN (Subcondition Names) attribute of the associated event handling object.
QU OPC Quality
Quality associated with the condition state. This 16-bit value consists of 3 separate bit
fields. See the OPC Alarms and Events standard and the OPC server documentation for
the possible values of this attribute.
Data type: Integer
114
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
If the value of this attribute is not one of the ’good’ values, the OS (Object Status) attribute
of the process object is set to 2.
SE OPC Severity
Event severity.
Data type: Integer
Value: 1 ... 1000, OPC server specific values
Access: Read-only
Member: dwSeverity
115
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
The term File Transfer is used to mean any bulk data transfer between SYS600 and a
station. A file is a sequence of bytes of any length with no interpretation of its contents.
The implementation of file transfer in SYS600 base system is protocol independent, the
interpretation of the contents of a file is done with SCIL.
In SYS600, a file is represented by a disk file and identified by its disk file name. In a
station, a file is typically, but not necessarily, a memory segment in RAM and the
identification or naming is protocol dependent. The ID is handled in SYS600 as a byte
string with no interpretation.
File transfer is always initiated by SYS600, spontaneous file transfer from station to
SYS600 is not supported. File transfer is done asynchronously. It is initiated by SCIL,
but the SCIL command does not wait for the completion of the transfer.
The FT (File Transfer) process object type implements the file transfer functionality.
The following functions are supported:
• Receiving (uploading) a file from a station.
116
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
DC Directory Contents
Uploaded contents of a directory of a station.
Data type: List of vector attributes
Value: Attributes and their element types:
TYPE Text value "FILE" or "DIRECTORY"
ID Byte string, the file’s ID in the station
NAME Text, the file's name in the station
CREATION_TIME Time value
LENGTH Integer, length of the file as bytes
AUXILIARY Byte string value, station specific auxiliary
information
Attributes NAME, CREATION_TIME, LENGTH and AUXILIARY
are returned only if supported by the station.
Access: Read-only
Example:
UPLOAD = FT:PDC10
NAME_1 = UPLOAD.NAME(1)
TYPE_1 = UPLOAD.TYPE(1)
FF File Function
The function to be performed on a file.
Data type: Integer
Value: 0 … 4:
0 None
117
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
1 Send a file
2 Receive a file
3 Read directory
4 Delete a file or directory
Setting FF to 0 cancels the ongoing transfer
Default value: 0
Access: Read, conditional write. May be written only when switch state is
AUTO
FN File Name
The tag of the disk file to be sent or received.
Data type: Byte string
Value: File tag
Access: No restrictions
Example:
#SET FT:PFN10 = FM_FILE("C:\sc\conf.txt")
FT File Transfer
Displays the state of transfer.
Data type: Integer
Value: 0 … 4:
0 Idle
1 Transfer in progress
2 Cancelled by the user
3 Aborted by station or communication error
4 Ready
118
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Default value: 0
Access: Read-only
ID Identification
The file's ID in the station. An ID may be a fixed value known by the operator, or it may
be retrieved by reading the directory structure of the station. A zero length byte string
denotes the root of the directory structure. The value is station type (or protocol) specific.
When creating an ID with SCIL, differences in CPU architecture (especially
byte-ordering) may have to be taken care of.
Data type: Byte string
Value: Station type specific
Access: No restrictions
Example:
#SET FT:PID10 = PACK_STR(VECTOR(97,234),"byte_string",1,"big_endian")
ST Status
A SCIL status code giving more information when the transfer is aborted (FT = 3).
Data type: Integer
Value: A SCIL status code
Default value: 10
Access: Read-only
119
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
LE Level Enumeration
The calculated level of a network topology object.
Data type: Integer
Value: 0 .. n, the enumeration of the level. The maximum value n depends
on the application specific configuration of the topology schema. In
the POWER schema, up to 16 levels (0 .. 15) may be specified.
Access: Read-only
Object types: NT
LP Loop State
The calculated loop state of a network topology object.
The possible loop states depend on the topology schema. The values listed below
correspond to the POWER schema.
Data type: Integer
Value: 0 No loop
1 Topological loop
2 Power loop
3 Topological and power loop
Default value: 0
Access: Read-only
Object types: NT
LV Level Value
The calculated nominal level of a network topology object.
120
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
The levels and their nominal values depend on the topology schema.
Data type: Real
Value: In the POWER schema, the nominal voltage level as kilovolts.
Default value: 0.0
Access: Read-only
Object types: NT
LX Level Text
The translated textual name of the calculated level of a network topology object.
The levels and their names depend on the topology schema.
Data type: Text
Value: The localized name of the level
Access: Read-only
Object types: NT
NF Network Feeds
The network topology (NT) objects that feed this object, including earths.
The structure and contents of this attribute are defined by the topology schema. In the
POWER schema, the attribute has been defined as follows:
Data type: Vector
121
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Each event in the history database contains a snapshot of all attributes of the process
object. Additionally, some information related to the event itself is stored in the database
as pseudo attributes described below. They cannot be accessed using the standard process
object notation, but they can be used just like ordinary process object attributes in
arguments of HISTORY_DATABASE_MANAGER function.
Attributes CA (Changed Attribute), MX (Message Text) and US (User Name) are
available through the OPC Data Access Server as well, see the OPC Server manual for
details.
For more information about commands and functions used for queries, see the
Programming Language SCIL manual and for information on how to configure the event
history see the System Configuration manual. Process object attributes related to history
logging are described in Section 5.2.10 Logging of event history.
CA Changed Attribute
The name of the process object attribute that changed and caused the event logging.
Data type: Text
Value: Two character attribute name
Access: Read-only
122
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
ET Event Time
The time of the event, in a resolution of one second. For true process events, ET is equal
to RT.
Data type: Time
Access: Read-only
123
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
MX Message Text
A descriptive text of the event that caused the logging.
124
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
The text is obtained from the event handling object referenced by the EH attribute of the
process object.
Data type: Text
Value: A descriptive text of the event in the current language
Access: Read-only
US User Name
The name of the MicroSCADA user who caused the logging.
Data type: Text
Value: MicroSCADA user name
Access: Read-only
125
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Examples
Example 1:
#CREATE PROC:P1 = LIST(AI = 0, SN = "S")
An analog input object is created with the name PROC, index 1, analog input value 0
and scale name "S".
Example 2:
#LOCAL P = FETCH(0,"P","OLD",1)
P.OA = P.OA + 1
#CREATE NEW:P1 = P
The new process object is otherwise identical to the old one, but its object address is
changed.
CD Configuration Data
Configuration data of the process group.
Data type: List
Value: Any list
Access: No restrictions
The list may contain any number of attributes of any type. The total size of the contained
data is limited to approximately 64 kB.
GA Group Alarm
Indicates whether any of the process objects of the group is alarming.
Data type: Integer
Value: 0 None of the process objects of the group is alarming
1 At least one process object of the group is alarming
Access: Read-only
126
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
GC Group Comment
A freely chosen text.
Data type: Text
Value: Any text, up to 255 characters
Access: No restrictions
If an analog input object is in a warning state and has a fleeting alarm, it is regarded as
FLEETING until the alarm has been acknowledged.
GT Group Type
An arbitrary type number defined by the application.
Data type: Integer
Value: 0 ... 255
Default value: 0
Access: No restrictions
127
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
LF Logical Format
The name of the logical format picture, i.e. the format that prints the group with command
#LIST, see Chapter 4 Object handling.
The name of the group is passed as an argument variable LN to the format picture. This
way, several different objects can use the same logical format picture.
Data type: Text
Value: Picture name, up to 10 characters
Access: No restrictions
LN Logical Name
The logical name of the process object group.
Data type: Text
Value: Object name, up to 63 characters
Access: Read-only, configurable
PV Process Views
Names of process views displaying the process group.
Data type: Text vector
Value: Up to 10 process view names, up to 255 characters each
Default value: Empty vector
Access: No restrictions
The base system does not maintain the value of this attribute.
! It is the responsibility of the application to keep the value
up-to-date.
ZT Modification Time
The time when the object group was created or modified.
Data type: Time
Access: Read-only
This attribute is set by the main program when the object group is created and each time
the object group is updated by the #MODIFY command (for example, by the process
object group definition tool).
128
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
6.1 General
Use
Event handling objects define texts associated to the states of process objects and
transitions from one state to another (events).
The texts are not defined directly in the event handling objects, only the references to
the texts. These references, called text identifiers, are used at run-time to translate the
texts into the current language. See the Programming Language SCIL manual, the
Language Functions section, for the details of the translation process.
In theory, all the information contained in the event handling objects could be stored in
the process objects. However, by grouping functionally similar process objects to classes
129
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
and defining one event handling object for the class saves a lot of engineering work. The
reference to the event handling object is given in the EH (Event Handling) attribute of
a process object.
If the EH attribute of a process object is undefined (empty), a default event handling
object is applied. Each process object type and subtype has its own default event handling
object. There are two scopes of defaults:
• Application default event handling objects are application defined defaults that are
first applied. See Section 6.7 Application default event handling objects for details.
• Predefined event handling objects are system wide hardcoded defaults, which are
applied when application default object has not been defined. see Section 6.6
Predefined event handling objects for details.
In future releases of SYS600, some other properties related to the event handling may
be implemented by new attributes of event handling objects. Therefore, it is recommended
that distinct event handling objects are defined for logically unrelated process object
classes, even if the state and event texts happen to match by chance.
Common functionality
The event handling objects define the text identifiers for descriptions of various object
states and events (meaning roughly the transitions between states).
The object state often refers to the object value (OV) attribute of a process object.
However, a process object has many other states as well: It may be blocked (BL), its
value may be substituted (SB) or the sensor may be FAULTY (OS = 1), etc. There is a
set of predefined event handling objects to define the handling of these additional object
states, see Section 6.6 Predefined event handling objects. The event handling objects
created by the application always refer to the OV related object state.
The object state is an integer that is used as an index to the state text array (attribute ST)
and to the event message text matrix (attribute MT). The state is calculated in three steps
as follows:
1. The object value, which can be either an integer or a real number, is first defined
according to the process object type:
For the analog input (AI) objects that have an alarm class, the value of the AZ
attribute defines the object value.
For all other types, the OV attribute (BI, BO, DB etc.) is directly used as the object
value.
2. The value formula (attribute VF) is applied to the object value resulting in an event
value, which is an integer. The formula defines simple arithmetic operations to be
performed on the object value and optionally on another, user-defined attribute.
If no formula is defined, the object value is the event value.
130
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
3. The object state is calculated by comparing the event value (rounded to the nearest
integer) to the attributes VC (Value Count) and VL (Value Low), which define the
set of all object states.
If the event value falls outside the defined object states, the object state is undefined.
The resulting state and message texts will be empty.
For efficient handling of objects that may have a lot of different values, a range of
event values may be defined to represent one object state (see the VC attribute
below).
The event value calculated in step 2 may be used to format the translated state and the
message texts.
In the state texts, which are used to give the textual description of the value of an process
object (the attribute SX of the process object), the numeric event value may be referred
to in the translation by using the following notation:
Current \V2\ A
The event value, expressed with 2 decimals, is inserted in the translation. The resulting
text might then be:
Current 12.34 A
If the number of decimals is not given, the value is displayed with roughly six significant
digits.
In the event message texts (and state texts that are used as message texts), also the
previous event value is available. For example, the translation
Setpoint changed from \P1\ to \V1\
might generate the text
Setpoint changed from 5.1 to 5.5
There is a set of predefined event handling objects for object value related states and
events. One of these objects is applied when the EH attribute of a process object is not
defined. For details, see Section 6.6 Predefined event handling objects.
AEC functionality
The AEC event handling objects specify:
1. which events the process objects connected to the event handling are to receive
2. how the numeric values of process objects are deduced from the contents of the
event notifications
3. how the OPC events are shown in the SYS600 event list
Essentially, the 3rd item includes the functionality of SYS type event handling objects.
131
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Storage
The maximum number of event handling objects in an application is 65 535. The objects
are stored in the process database file APL_PROCES.PRD. When the application is
WARM or HOT, the objects are stored in the global memory pool of SYS600 as well
(see the System Objects manual).
CX Comment Text
A freely chosen text.
Data type: Text
Value: Any text, up to 255 characters
Access: No restrictions
132
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
LN Logical Name
The name of the event handling object.
Data type: Text
Value: Object name
Access: Read-only, configurable
MT Message Texts
The text identifiers of the event message texts.
Data type: Text vector
Length: 0 or 2, if VC = 0. 0 or n * n, if VC <> 0. "n" is the number of object
states. The maximum length is 65 536.
Indexing: By new and previous object state, see below
Element value: Text identifier
Default value: Empty vector
Access: Read-only, configurable
If the value of the VC (Value Count) attribute is 0, the MT attribute typically defines
two text identifiers, the first for the "Value changed message and the second for the
"Value updated but not changed" message. The attribute may be empty, provided that
the object has a non-empty ST attribute (of length 1). In this case, the ST attribute is
used to generate the event message texts.
If the value of the VC attribute is non-zero, the MT attribute may be either empty or a
vector of n * n text identifiers, where "n" is the number of distinct object states (see
attribute VC). The maximum length of the MT attribute is 65 536 texts. This limit implies
that the MT attribute may be used only when the state count n is less than or equal to
256.
When the MT attribute is empty, the state texts (attribute ST) are used as event message
texts as well, i.e. the description of the new object state is used as the description of the
event. The state texts are used as message texts also in cases where the previous state of
the process object is not known, for example when the value of the object is updated for
the first time after the application start-up.
When the MT attribute is defined, the event message text depends on both the new and
the previous state of the object. The MT attribute contains an n x n matrix of text
identifiers.
The following table illustrates the indexing and semantics of the MT attribute. It is
assumed that VC = 2 and VL = 0. The text identifiers are named as "EVENT_p_TO_n",
where p is the previous state and n is the new state.
New state = 0 New state = 1
Old state = 0 (1) "EVENT_0_TO_0" (2) "EVENT_0_TO_1"
133
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
For the indexing and the semantics of the attribute, see the MT attribute.
ST State Texts
The text identifiers of the object state texts.
Data type: Text vector
Length: The number of distinct object states, 0 ... 65 536
Indexing: Object state, see below
Element value: Text identifier
Default value: Empty vector
Access: Read-only, configurable
The first element of the vector defines the text identifier corresponding to the lowest
value of the object state, the last element corresponds to the highest value. For object
state numbering, see the VC attribute.
Even if no distinct object states have been defined (VC = 0), the ST attribute may be
used to define a text that is related to the value of the object. In this case, one text identifier
is defined (the length of the ST vector is 1), and the event value is inserted in the
translation, see Section 6.1 General.
134
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
VC Value Count
The number or a list of the distinct event values that the process object may have.
Data type: Integer or a vector
Value: Integer 0 ... 65 536 or a vector of up to 65 536 distinct values or ranges,
see below
Default value: 0
Access: Read-only, configurable
Typically, the VC attribute is defined as an integer. The possible object state values are
then VL, VL + 1, ... , VL + VC -1.
For AEC event handling objects, the value of this attribute follows the length of the EM
(Event Messages) attribute (SIMPLE and TRACKING events), or the length of the SN
(Subcondition Names) attribute (CONDITION events), and is not directly configurable.
The vector form, available only in SYS event handling objects, is used when the space
of event values is sparse or there are a lot of distinct values. For example, an object may
take only the values 0, 100, 101, 102 and 199. It would be extremely clumsy to define
200 state texts and 40 000 message texts for the events.
The vector lists all the distinct values and value ranges that the event value may have.
The distinct values are given as integers, the ranges as two-element integer vectors. The
values within a range are considered to represent the same object state. Consequently,
they share the corresponding state text and message texts. The values must be listed in
ascending numerical order.
When the vector form is used, the VL (Value Low) attribute has no meaning, because
the first element of the vector already defines the lowest possible value.
For the definition of the event value, see Section 6.1 General.
Example:
The VC attribute of the example case above could be given as:
VECTOR (0, (100, 102), 199)
135
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
VF Value Formula
The formula for scaling the object value or calculating the event value out of the object
value and an additional attribute.
Data type: Text
Value: Up to 255 characters, see below
Default value: ""
Access: Read-only, configurable
VL Value Low
The lowest of the distinct values that the process object state may have.
Data type: Integer
Value: Any integer value
Default value: 0
Access: Read-only, configurable
136
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
When the VC (Value Count) attribute is given as a vector, this attribute has no meaning,
see above.
For AEC event handling objects, the value is always 0.
ZT Modification Time
The time when the object was created or modified.
Data type: Time
Access Read-only
This attribute is set by the base system when the object is created, and it is updated each
time the object is updated by the #MODIFY command (for example, by the event handling
definition tool).
There may be several event handling objects that generate events of the same event
category. In this case, the category description (CD) is typically defined in only one of
them. If the description is given in several event handling objects, the descriptions must
be identical.
137
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
The subconditions of a multiple state condition are described by the elements of vector
SU. Each element is a list with the following attributes:
Data type: List
Value: The following attributes:
SD Text, up to 255 The definition of the subcondition
characters
SE Integer 0 ... The severity of the message generated when
1000 the subcondition becomes active, 0 = no ac-
tivation message sent
SN Text, up to 255 The name of the subcondition
characters
138
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
There may be several event handling objects that generate events of the same event
category. In this case, the category description (CD) is typically defined in only one of
them. If the description is given in several event handling objects, the descriptions must
be identical.
The severity (SE) of the event is an integer value 1 to 1000 to describe the urgency of
the event (1 = lowest, 1000 = highest). SE value 0 is here used to state that no event
notification is to be sent. If the SE is defined as a single integer value, this severity is
used in all event notification messages regardless of the value (state) of the process
object. If different severities for different events are required, these are given as an integer
vector of length VC (Value Count, see Section 6.3 OPC Alarms & Events server
attributes). The severities in the vector correspond to the distinct values of the new state
of the object.
139
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
CI Event Category ID
The OPC event category ID.
Data type: Integer
Value: Server specific
Default value: -1
Access: Read-only, configurable
This attribute defines the event category whose SIMPLE or TRACKING events (see the
ET attribute) the process objects will receive. Special value -1 specifies that the process
objects of this event handling receive events from any category.
For CONDITION events, the attribute has only a documentation meaning, because the
condition names are unique within a server.
CN Condition Name
The name of the condition that the event handling object is for.
Data type: Text
Value: Server specific text, up to 255 characters
Default value: ""
Access: Read-only, configurable
EM Event Messages
List of event messages of the SIMPLE or TRACKING event.
Data type: Text vector
Value: Up to 255 server specific event messages
Default value: Empty vector
Access: Read-only, configurable
ET Event Type
The OPC event type handled by this event handling object.
Data type: Text keyword
140
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
For SIMPLE and TRACKING events, attributes ND, CI and ET uniquely define the
events that the process objects of this event handling object will receive.
For CONDITION events, the received events are uniquely defined by attributes ND, ET
and CN.
ND Node
The number of the node object that specifies the OPC A&E Server in question.
Data type: Integer
Value: 1 ... 250, the node number
Access: Read-only, configurable
Note: The AEC event handling objects are OPC A&E Server specific. Consequently,
each server used by the application has its own set of event handling objects.
SN Subcondition Names
List of sub-condition names of the CONDITION event.
Data type: Text vector
Value: Up to 255 server specific sub-condition names
Default value: Empty vector (SIMPLE and TRACKING events)
One-element vector containing the name of the CONDITION
Access: Read-only, configurable
This attribute is used to translate a condition event to a numeric value of the process
object (attribute OE). If the condition is inactive, the value is 0. If the condition is active,
the numeric value is the ordinal number of the sub-condition name within the list in the
SN attribute.
According to the OPC standard, the only sub-condition of a simple condition has the
name of the condition itself (a condition is simple when it has only two states). Hence,
the default value of this attribute contains the name of the condition.
141
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Note that different text identifiers are used for the state "closed" and for the event "closed".
In many languages, distinct words are used for the two.
142
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
143
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
144
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
145
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
7 Scales
7.1 General
Use
Scales define algorithms for scaling the analog data received from the process stations
to the unit used in the process database.
Every definition of an analog process object contains a scale name (the process object
attribute SN), which is the name of the scale to be used in the scaling. The same scale
can be used by several analog process objects, independent of their type (analog input
or output).
Function
The stations (RTUs, protective equipment, PLCs and other process control units) receive
analog signals from the process instrumentation as electrical currents (mA) or voltages
(V). In the stations, these values are converted to digital values. In the process database
the digital values are scaled to the analog unit of the process object using the scaling
algorithm given by the scale name of the process object. The analog output values are
scaled correspondingly in the process database before they are sent out to the stations.
Three scaling algorithms are supported:
1. One-to-one scaling (no scaling)
2. Linear scaling
3. Stepwise linear scaling, this algorithm approximates a non-linear scaling curve by
a broken line.
As an example, scaling can mean that digital value 0 corresponds to 20 °C and value
1000 corresponds to 100 °C (see Figure 7.1).
Storage
The maximum number of scale objects in an application is 65 535. Scale objects are
stored in the process database file APL_PROCES.PRD. When the application is WARM
147
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
or HOT, the scale objects are stored in the global memory pool of SYS600 as well (see
the System Objects manual).
LN Logical Name
The name of the scale.
Data type: Text
Value: Object name
Access Read-only, configurable
SA Scaling Algorithm
The algorithm used in scaling: one-to-one, linear or stepwise linear scaling, see Figure 7.1.
Data type: Integer
Value: 0 1:1 scaling
1 Linear scaling
2 Stepwise linear scaling
Default: 0
Access: Read-only, configurable
148
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
SC Scaling Constants
Constants that specify the scaling curve. The curve is given as pairs of corresponding
station values and SYS600 process database values.
Data type: Vector
Value: If SA = 1: Four real elements
If SA = 2: Up to 100 real elements representing the coordinates of 50
points on the scaling curve
Indexing: If SA = 1:
Index 1 The lower station value
Index 2 The upper station value
Index 3 The lower process database value
Index 4 The upper process database value
If SA = 2:
An odd index refers to a station value and the following even index
to corresponding process database value. The station values must be
given in ascending order.
Default value: No
Access: Read-only, configurable
50 50
0 0
0 500 1000 0 500 1000
Stations Stations
SA = 1 SA = 2
SC = (0,1000,20,100) SC = (0,20,200,10,500,40,750,50,1000,100)
Linear_and_stepwise
149
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
ZT Modification Time
The time when the object was created or modified. This attribute is set by the base system
when the scale is created, and it is updated each time the scale is updated by the
#MODIFY command (for example, by the scale definition tool).
Data type: Time
Access: Read-only
Required attributes
When defining a new scale object, SA is the only mandatory attribute. If the SA attribute
is set to 1 or 2, the SC attribute must be defined as well.
Example:
Creating a one-to-one scale:
#CREATE ONE_TO_ONE:X = LIST(SA = 0)
150
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
8 Data objects
This chapter describes the data objects, their attributes and how to define data objects
with SCIL. It is divided into the following sections:
8.1 General: The use, activation and function of the data objects, etc.
8.2 Data object attributes: The data object attributes are listed and described.
The attributes are grouped in sub-sections according to their function.
8.3 The principles for defining data objects using SCIL and examples.
8.1 General
Use
Data objects (also called datalog objects) are used to sample and calculate, register and
store data. A data object can contain one or more, up to 1 000 000, registered values.
Each value has a validity stamp (status code) and a time stamp.
Data objects can be used for storing trend data, historical data, running plan data, data
for system configuration, optimization, calculation, etc. Data objects can also be used
as application wide variables when there is a need for using the same data in several
different SCIL contexts.
Function
Execution of a data object is carried out in the following steps:
1. The raw value of the object is first obtained by evaluating a user defined SCIL
expression (attribute IN). Typically, the expression contains a reference to another
application object, such as "VOLTAGE:PAI5". However, any valid SCIL expression
resulting in a proper data type will do. The expression may also refer to the argument
variables supplied by the activator of the object, see Variables, on page 153. The
data type of the object is specified by attribute VT. Data types REAL, INTEGER,
TEXT and TIME are supported.
2. A logging function (attribute LF) is applied to the raw value, resulting to the object
value (attribute OV). The simplest logging function, DIRECT, just sets OV equal
to the raw value, others perform various time series calculations, such as averaging,
accumulation, integration, slope calculation and minimum/maximum search, on the
raw value. There is also a logging function that makes a copy of the contents of
another data object, bypassing step 1 altogether.
3. The new object value is time-stamped and stored in the object as attributes OV, OS,
QT and RT. The new values are written to the disk, unless the object is defined as
"memory only" (attribute MO).
4. If history registration is defined for the object (attribute HR > 0), the new object
attribute values OV, OS and RT are also stored in the history of the object. The
history of the object is arranged as a cycling buffer: when the maximum number of
151
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
history entries has been reached, the oldest entries are lost. The history may also be
reset, see initialization below.
Data objects connected to a time channel are initialized by the time channel when it is
scheduled for its initialization run (see Chapter 10 Time channels). Initialization is carried
out in the following steps:
1. A new time series calculation is started. This applies to logging functions SUM,
MEAN, INTEGRAL, MAXIMUM and MINIMUM (see attribute LF).
2. The history of the object (if any) is cleared, the number of history registrations
(attribute LR) is set to zero.
152
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Variables
The following variables may be used in the SCIL expression of the IN attribute:
• argument variables given as a variable list of #EXEC or #EXEC_AFTER command,
when activated by SCIL (see Chapter 4 Object handling).
• argument variables of the event channel, when activated by an event channel (see
Chapter 11 Event channels).
• variables of the time channel, when activated by a time channel. These are the
variables created by the command procedures already executed by the time channel.
Execution queues
Data objects, as well as command procedures, time channels and event channels, are
executed by execution queues of the report database. An execution queue may be seen
as a queue of execution requests and an active base system program that executes these
requests. The program is implemented as a separate process within the underlying
operating system. Therefore, the queues are executed in parallel.
There are three types of execution queues:
153
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
1. The time channel queue schedules and executes the time channels. The request
queue is organized as a time schedule. When a time channel has been executed, it
is rescheduled according to its scheduling attributes.
2. The event channel queue is a multi-purpose queue that executes all the other
(non-parallel, see below) execution requests. As its name implies, its most important
task is to execute the event channels triggered by various process and system events.
It also executes the requests done by SCIL in human interface programs. The request
queue is organized as a FIFO (first in first out) queue.
3. Parallel queues are application defined queues that are normally used to optimize
the throughput of the system. There may be 0 to 30 parallel queues in an application,
the number is specified by the base system object attribute APL:BPQ. The mutual
priority of the queues (in the sense of CPU usage) may be defined (attribute
APL:BQP). A parallel queue may be dedicated or non-dedicated (attribute
APL:BQD). A dedicated queue accepts only requests that are explicitly given to it,
a non-dedicated queue accepts also parallel requests with non-specified queue
number. The request queue is organised as a FIFO.
A data object and a command procedure object is always executed by the time channel
queue or the event channel queue, unless it has specified parallel execution (attribute PE
= 1) for itself. The parallel queue to execute the object may be explicitly specified
(attribute PQ > 0) or it may be left unspecified (PQ = 0). If unspecified, the system will
assign the first idle queue to it, see Section 8.2.4 Execution control.
The objects activated by a command procedure object using #EXEC command are
executed in the same queue where the command procedure is running.
The queue that will execute the object may be determined by Figure 8.2.
154
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 8.2: The queues that execute data objects and command procedures
In addition to the execution queues described above, there are two virtual execution
queues that only hold requests until they are moved into a true execution queue:
1. Delayed execution queue holds requests until the delay expires. These are the
requests activated by #EXEC_AFTER command of SCIL language.
2. Parallel queue 0 holds parallel requests with PQ = 0 until a (non-dedicated) parallel
queue becomes idle.
The contents of the queues may be examined in SCIL programs by reading various
application object attributes (see the System Objects manual for details):
• Attributes EU (Event Channel Queue Used) and QU (Queue Used) give information
about the lengths of queues
• Attribute RO (Running Objects) lists the objects currently in execution
• Attribute QO (Queued Objects) lists the objects that are queued but not yet executing
155
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Storage
The combined maximum number of data and command procedure objects in an application
is 1 000 000. Data objects are stored in the report database files APL_REPORT.000 to
APL_REPORT.399. When the application is WARM or HOT, the data objects along
with most of their attributes are stored in the global memory pool of SYS600 as well
(see the System Objects manual).
The history registrations (attributes OV, OS, QT and RT, indexed values) are not
permanently stored in the global memory pool. Instead, the most recently used history
data is cached in the report cache along with the programs of command procedure objects.
The memory space for the report cache is allocated from the global memory pool (see
the System Objects manual, base system object attribute RC).
For optimization of the throughput, the dynamically changing attributes OV, OS, QT
and RT may be defined to be "memory only", see attribute MO. In this case, they are
not stored in the disk file at all.
156
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
8.2.2 Logging attributes: HR, IN, LF, PS, SR, TS, VL, VT
8.2.3 HistorianHistorian logging: GN, GP
8.2.4 Execution control: EP, PE, PQ, SE, TC
8.2.5 Storage: HN, MO
8.2.6 Registered data: LR,OS, OV, QT, RT
The data attributes in Section 8.2.6 Registered data represent the registered data. All
other attributes describe the definition of the object.
CM Comment
A freely chosen comment text.
Data type: Text
Value: Any text, up to 255 characters
Access: No restrictions
FI Free Integer
This attribute is reserved for the SCIL application. It has no functionality in the base
system.
Data type: Integer
Default value: 0
Access: No restrictions
FX Free Text
This attribute is reserved for the SCIL application. It has no functionality in the base
system.
Data type: Text
Value: Any text, up to 255 characters
Default value: ""
Access: No restrictions
IU In Use
The attribute states whether the object is in use or not. When the object is out of use (IU
= 0), it is not executed. However, the attributes can be both read and written normally.
Data type: Integer
157
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
LN Logical Name
The logical name of the data object.
Data type: Text
Value: Object name
Access: Read-only, configurable
The value of the attribute is a hierarchical name that consists of any number of fields
separated by periods:
"field1.field2. ... .fieldn"
Each field may contain any visible characters, except for colons and periods. The name
is case-sensitive. Single embedded spaces are allowed in the field, whereas leading and
trailing spaces are not accepted.
Examples of the valid ON attribute values:
• "South Tipperary.Kilkenny.Relay1.Breaker.Position"
• "Äänekosken ala-asema.Laukaan syöttö.Katkaisija.Tila"
The names are unique within an application. Consequently, the user cannot, for example,
give the same ON attribute value to a process object and a data object.
The hierarchy formed by the ON attribute values is shown by the name space browser
of the OPC Server.
158
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
ZT Modification Time
The time when the object was created or modified. This attribute is set by the base system
when the object is created, and it is updated each time the object is updated by the
#MODIFY command (for example, by the data object definition tool).
Data type: Time
Access: Read-only
HR History Registrations
The maximum number of history registrations. When the number of registrations (attribute
LR) exceeds this value, the oldest value is lost.
Data type: Integer
Value: 0 ... 1 000 000
Default value: 0
Access: Read-only, configurable
When a new data object is created or HR attribute is modified, the disk or memory space
required to store the history data is allocated from the report database file or from the
global memory pool, depending on the MO (Memory Only) attribute value. When HR
is lowered below the current number of registrations (attribute LR), the oldest values are
lost and LR is set equal to HR. When HR is raised, the old values are preserved.
Because the newest value of the object is always available in attributes OV, OS, QT and
RT (without indexing), it normally makes no sense to set HR to 1. When HR is 1, OV
and OV(1) are always equal except for the time interval between the initialization and
next execution of the object. Within this interval, LR is 0 and OV(1) does not exist.
IN Instruction
The SCIL expression to evaluate the raw value of the object.
Data type: Text
Value: SCIL expression, up to 255 characters
Access: Read-only, configurable
The evaluation of this attribute must result in the data type defined by the VT attribute.
However, if VT is "INTEGER", the following data conversions are done automatically:
real values are rounded to nearest integer and boolean values are converted to 0 (=
FALSE) or 1 (= TRUE).
159
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
LF Logging Function
The operation to be performed on the raw value to calculate the object value OV. The
previous value of OV and/or the previous raw value is used by many logging functions
to calculate the new object value (see Figure 8.1). The allowed value types (attribute
VT) for each logging function are given in the table below.
Data type: Integer
Value: 0 ... 10:
0 DIRECT. No calculation is performed. The object value is
the same as the raw value. VT: ALL
1 SUM. The cumulative sum of all raw values since last initial-
ization. VT: REAL, INTEGER
2 MEAN.The mean (or average) value of all raw values since
last initialization. VT: REAL
3 INTEGRAL. The time integral of the raw value since last
initialization. The raw value is assumed to be constant
between samplings. The time is measured in seconds. The
object value is calculated by adding the product of the previ-
ous raw value and the elapsed time to the previous object
value. VT: REAL
4 DIFFERENCE. The difference between two consecutive raw
values. The object value is calculated by subtracting the
previous raw value from the current. VT: REAL, INTEGER
5 PULSE DIFFERENCE. The same as above, but the raw value
is regarded to be a pulse counter, which is reset to zero at
certain value (attribute PS). VT: REAL, INTEGER
6 TIME DERIVATIVE. The time derivative (slope) of two
consecutive raw values. The time is measured in seconds.
The object value is calculated by dividing the difference of
the current and previous raw value by the elapsed time. VT:
REAL
7 PULSE DERIVATIVE. The same as above, but the raw value
is regarded to be a pulse counter, which is reset to zero at
certain value (attribute PS). VT: REAL
8 MAXIMUM. The object value is the largest of the raw values
since last initialization. VT: REAL, INTEGER, TIME
9 MINIMUM. The object value is the smallest of the raw values
since last initialization. VT: REAL, INTEGER, TIME
10 COPY. Copies all the registered values from another data
object. (specified by SR attribute). IN attribute has no
meaning. VT: ALL
160
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Default: 0 (DIRECT)
Access: Read-only, configurable
PS Pulse Scale
When the logging function is PULSE DIFFERENCE (LF = 5) or PULSE DERIVATIVE
(LF = 7), the raw value (result of evaluating the IN attribute) is regarded as a pulse
counter. The PS attribute indicates the width of the pulse counter, i.e. the value that resets
the physical pulse counter to zero. In other words, the PS attribute should be set to the
maximum value of the pulse counter + the size of one pulse. For other logging functions,
this attribute has no meaning.
Data type: Integer or real (according to VT attribute)
Value: Non-negative number
Default value: 0
Access: Read-only, configurable
SR Source
The name of the data object to be copied when the logging function is COPY (LF = 10).
For other logging functions, this attribute has no meaning and is set to an empty string.
Data type: Text
Value: Object name
Default value: ""
Access: Read-only, configurable
161
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
TS Time Stamp
The TS attribute specifies whether the attributes RT and QT get their value from the
system clock or from the (argument) variables QT, RT and RM.
Data type: Integer
Value: 0 RT and QT are read from the system clock
1 RT and QT are read from variables QT, RT and RM
Default: 0
Access: No restrictions
When TS = 1, the registration time of the object is set according to the following rules:
1. If argument variable QT is given and it contains a valid qualified time, it is used as
the registration time.
2. Otherwise, if argument variable RT is given and it contains a time value, it is used
as the registration time (possibly further specified by argument variable RM).
3. If neither a valid QT nor RT argument variable is given, the registration time is read
from the system clock.
When the object is started by a process event channel or by a predefined event channel,
argument variables QT, RT and RM normally contain the time of the triggering event.
When TS attribute is set to 1, the RT and QT attributes of the data object will match the
time of the event.
VL Value Length
Maximum value length. This attribute specifies the maximum length of the text type OV
attribute. If the value of VT attribute is not "TEXT", this attribute has no meaning, and
it is set to 0.
Data type: Integer
Value: 0 … 255
Access: Read only, configurable
VT Value Type
The value type of the logged data (attribute OV).
Data type: Text keyword
Value: "REAL", "INTEGER", "TIME" or "TEXT"
Default value: "REAL"
162
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Access: Read only, configurable with #CREATE but not with #MODIFY.
The Historian logging attributes specify how the changes of the OV (Object Value)
attribute are stored in Historian database(s). Only data objects of value type REAL or
INTEGER may be logged.
For more information about Historian logging, see Chapter 12 Logging profile objects.
GN Logging Name
This attribute tells the names of Historian database tags that receive data from this data
object.
Data type: Vector
Element type: List
Element value: DB The name of the DATABASE type logging profile object
that defines the Historian database
GN The name of the tag in this Historian database, see below
Default: Empty vector
Access: Read-only
The tags are finally named by the Historian database itself. When the tag is not yet
created, the GN attribute returns the proposed tag name in square brackets.
GP Logging Profile
This attribute specifies the logging profile to be used when logging values to the SYS600
Historian database(s).
Data type: Text
Value: Name of an OBJECT type logging profile object. If empty, no logging
is done.
Default value: ""
Access: No restrictions
163
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
EP Execution Priority
The execution order of the object relative to other data objects and command procedures
within the same time channel. Objects with the same EP value may be executed in any
order.
Data type: Integer
Value: 0 ... 255
0 is the highest and 255 the lowest priority order
Default value: 255
Access: Read-only, configurable
PE Parallel Execution
This attribute indicates whether the object is executed by a parallel queue or not, see
Figure 8.2.
Data type: Integer
Value: 0 Non-parallel execution
1 Parallel execution.
Default value: 0
Access: No restrictions
PQ Parallel Queue
The number of the parallel queue that will execute the object. If PE = 0, this attribute
has no meaning.
Data type: Integer
Value: 0 ... APL:BPQ
Value 0 means that any parallel queue will do.
Default value: 0
Access: No restrictions
SE Start-up Execution
This attribute indicates whether the data object is executed during application start-up,
when reporting is chasing the real time. If start-up execution is specified, the history
registrations that have been missed during the application shutdown are time-stamped
with the scheduled time and marked with NOT_SAMPLED_STATUS (OS = 10).
Data type: Integer
164
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Value: 0 No
1 Yes
Default value: 0
Access: No restrictions
TC Time Channel
The name of the time channel that runs the data object.
Data type: Text
Value: Object name
Access: Read-only, configurable
8.2.5 Storage
Note: Division of the report database into several files was, in the first place, implemented
due to the 32 MB size limit of MicroSCADA files. Now that no such restriction exists
anymore, using HN values other than 0 is more or less obsolete.
MO Memory Only
This attribute determines whether the dynamically changing attributes OV, OS, QT, RT
and LR are stored on disk. If old values (stored before last start-up) of these attributes
are not interesting to the application, some performance gain may be achieved by setting
this attribute to 1. Global memory pool must be defined large enough to hold all the
history registrations of memory-only data objects.
Data type: Integer
Value: 0 Dynamic attributes are stored on disk
1 Dynamic attributes are stored only in RAM
Default value: 0
Access: Read-only, configurable
165
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
LR Latest Registration
The index of the latest registered value, i.e. the current number of history registrations.
This attribute is automatically updated, but it may be changed by #SET command. If the
data object is used as a data storage of a SCIL application (not connected to any time
channel), LR should be set equal to HR, because only indices less or equal to LR can be
read by SCIL. An index above LR (if not above HR) may, however, be written by #SET
command. The change becomes visible only after LR has been raised.
Data type: Integer
Value: Less or equal to the attribute HR
Access: No restrictions.
OS Object Status
SCIL status code that describes the reliability of the object value.
Data type: Integer
Value: A SCIL status code, see the manual Status Codes.
Indexing: History registration number. Without indexing, the newest value.
Access: No restrictions
The value of this attribute can be any status code produced by the evaluation of the IN
attribute. In addition, the following status codes are used:
• NOT_SAMPLED_STATUS (10), used to indicate that the object has not been
executed. This status is set for a new object and for each missed scheduled execution.
• SUSPICIOUS_STATUS (1), used to indicate that the object value may be unreliable.
This status is set when the logging function is not DIRECT and evaluation of one
or more raw values has failed. For example, when the logging function is SUM, it
indicates that one or more of the values have a non-zero status or are totally missing
from the sum. The raw value status FAULTY_TIME_STATUS (3) is considered
here as a good status and does not set OS to SUSPICIOUS_STATUS.
OV Object Value
The object value.
Data type: Real, integer, text or time. Defined by the VT attribute.
Indexing: History registration number. Without indexing, the newest value.
166
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Access: No restrictions
RT Registration Time
The registration time of the object value with a resolution of one second. The time is
either read from the system clock or received as argument variable QT or RT, according
to the TS attribute value.
Data type: Time
Indexing: History registration number. Without indexing, the newest value.
Access: No restrictions.
167
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Expression, IN No expression
Logging function, LF DIRECT
Number of history registrations, HR 0
Execution priority, EP 255
In use, IU 0
When a new data object is created, its OS (Object Status) attribute is set to
NOT_SAMPLED_STATUS (= 10) and LR (Latest Registration) to 0.
Examples:
In the example below, a data object named "DATA" is created with the following
attributes:
Expression %A
Logging function PULSE DIFFERENCE
Maximum history registrations 2000
State of use In use
In the following example, an existing data object is copied using the FETCH function:
V = FETCH(0, "D", "DATA1")
#CREATE DATA2:D = V
Only the definition of object "DATA1" is copied by this example, not the registered
data.
168
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
9 Command procedures
This chapter describes the command procedures and their attributes. The chapter is
divided into the following sections:
9.1 General: The use of command procedures, the activation and function of
command procedures, the use of variables in command procedures, etc.
9.2 General: The attributes listed and described. The attributes are grouped
into sub-sections according to their functions.
9.3 Defining command procedures with SCIL : The principles for defining
command procedures using SCIL and an example.
9.1 General
Use
Command procedure objects contain a SCIL program of up to 1 000 000 program lines
and a set of attributes which control the execution of the object and provide various
information about the object. Command procedures can be started automatically or
manually. They can be used for all kinds of automatic operations, for example,
calculations, control operations, report printouts, automatic system and communication
configuration.
Sometimes a command procedure object is used only as a storage for a SCIL program
with no automatic activation mechanism.
Function
Execution of a command procedure object is carried out in the following steps:
1. If there is a compiled version of the SCIL program (attribute CP), it is executed,
otherwise the source code (attribute IN) version is executed.
2. The status of the program execution (attribute OS) along with a time stamp (attributes
RT and QT) is stored in the object.
3. The dynamic attributes OS, RT and QT are stored also on disk, unless the object is
defined as "memory only" (attribute MO).
A command procedure is activated in the following three ways:
• By a SCIL program with commands #EXEC and #EXEC_AFTER (see Chapter 4
Object handling), for example, #EXEC PROG:C.
• By a time channel (Chapter 8 Data objects), giving an automatic time based execution.
• By an event channel (Chapter 9 Command procedures), giving an automatic event
based execution triggered by a process or a system event.
It is possible to use all the three ways for activating the same command procedure.
169
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
When a command procedure object is used only as a storage for a SCIL program, the
program is usually executed by the #DO command or DO function of SCIL language,
for example, #DO PROG:CIN or #DO PROG:CCP.
As a rule, a command procedure object is executed in the same execution queue as its
activating object (time channel, event channel or another command procedure). Command
procedures activated by user interface programs are executed in the event channel queue.
In addition, the command procedure object itself may specify parallel execution, see
attributes PE and PQ.
Program
The SCIL program of a command procedure may be stored as the source code (text), as
a compiled program (byte string), or as both. The command procedure object always
executes the compiled version of the program, if it exists.
Because command procedures have no user interface, they are unable to handle user
interface related SCIL commands (Visual SCIL commands, primitive graphics and
picture commands).
Variables
Besides the variables defined by the command procedure program itself, the following
variables can be used in the program:
• argument variables given as a variable list of #EXEC or #EXEC_AFTER command,
when activated by SCIL (see Chapter 3 Introduction).
• argument variables of the event channel, when activated by an event channel (see
Chapter 9 Command procedures).
• variables of the time channel, when activated by a time channel. These are the
variables created by the command procedures already executed by the time channel.
Storage
The combined maximum number of data and command procedure objects in an application
is 1 000 000. Command procedure objects are stored in the report database files
APL_REPORT.000 to APL_REPORT.399. When the application is WARM or HOT,
the command procedures along with most of their attributes are stored in the global
memory pool of SYS600 as well (see the System Objects manual).
However, the most memory consuming attributes (attributes IN and CP, which contain
the SCIL program) are not permanently stored in the global memory pool. Instead, the
most recently used programs are cached in the report cache along with the history data
of the data objects. The memory space for the report cache is allocated from the global
memory pool (see the System Objects manual, base system object attribute RC).
For optimization of the throughput, the dynamically changing attributes OS, QT and RT
may be defined to be "memory only", see attribute MO. In this case, they are not stored
in the disk file at all.
170
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Object notation
Command procedures and their attributes are accessed from SCIL with the following
object notation (see also Chapter 4 Object handling):
name:{application}C{attribute}{(index)}
or
name:{application}C{attribute}{index}
where
'name' is the name of the object
'application' is the logical application number
'attribute' is the attribute name
'index' is an index or index range
Depending on the context, an object notation without an attribute refers to the entire
object (for example in command #EXEC) or to the default attribute IN (for example in
#SET command and as an operand of an expression).
CM Comment
A freely chosen comment text.
Data type: Text
Value: Any text, up to 255 characters
Access: No restrictions
171
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
FI Free Integer
This attribute is reserved for the SCIL application. It has no functionality in the base
system.
Data type: Integer
Default value: 0
Access: No restrictions
FX Free Text
This attribute is reserved for the SCIL application. It has no functionality in the base
system.
Data type: Text
Value: Any text, up to 255 characters
Default value: ""
Access: No restrictions
IU In Use
The attribute states whether the object is in use or not. When the object is out of use (IU
= 0), it is not executed. However, the attributes can be both read and written normally.
Data type: Integer
Value: 0 Out of use
1 In use
Default value: 0
Access: No restrictions
LN Logical Name
The logical name of the command procedure.
Data type: Text
Value: Object name
Access: Read-only, configurable
172
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Access: No restrictions
The value of the attribute is a hierarchical name that consists of any number of fields
separated by periods:
"field1.field2. ... .fieldn"
Each field may contain any visible characters, except for colons and periods. The name
is case-sensitive. Single embedded spaces are allowed in the field, whereas leading and
trailing spaces are not accepted.
Examples of the valid ON attribute values:
• "South Tipperary.Kilkenny.Relay1.Breaker.Position"
• "Äänekosken ala-asema.Laukaan syöttö.Katkaisija.Tila"
The names are unique within an application. Consequently, the user cannot, for example,
give the same ON attribute value to a process object and a command procedure object.
The hierarchy formed by the ON attribute values is shown by the name space browser
of the OPC Server.
ZT Modification Time
The time when the object was created or modified. This attribute is set by the base system
when the object is created, and it is updated each time the object is updated by the
#MODIFY command (for example, by the command procedure object definition tool).
Data type: Time
Access: Read-only
9.2.2 Program
CP Compiled Program
The result of SCIL compilation of the source program (attribute IN). This is the program
that is executed by the command procedure, unless it is empty.
When the IN attribute is modified alone (without CP attribute), the CP attribute is cleared.
Data type: Byte string
Value: Byte string value containing the byte code
Default value: Empty byte string
Access: Read only, configurable
CS Compilation State
173
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Indicates whether the SCIL compiled version of the source program exists.
IN Instructions
The SCIL source program as a text vector. This program is executed by the command
procedure if CP attribute is empty.
When the IN attribute is modified alone (without CP attribute), the CP attribute is cleared.
Data type: Text vector
Value: Up to 1 000 000 SCIL source code lines
Indexing: Program line number, 1 ... 1 000 000.
Default value: Empty vector
Access: Read-only, configurable
OS Object Status
The termination status of the latest execution of the command procedure.
Data type: Integer
Value: A SCIL status code.
Access: Read, conditional write. It can be written with #SET.
174
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
RT Registration Time
The time of the latest execution of the command procedure. The attribute is set after the
program execution is completed. The attribute gets its value from the system clock or
from the variable QT or RT, see TS Time Stamp, on page 175.
Data type: Time
Value: Execution time
Access: Read, conditional write. It can be written with #SET.
TS Time Stamp
The TS attribute specifies whether the attributes RT and QT get their value from the
system clock, or from the (argument) variables QT, RT and RM.
Data type: Integer
Value: 0 RT and QT are read from the system clock
1 RT and QT are read from variables QT, RT and RM
Default: 0
Access: No restrictions
When TS = 1, the registration time of the object is set according to the following rules:
1. If argument variable QT is given and it contains a valid qualified time, it is used as
the registration time.
2. Otherwise, if argument variable RT is given and it contains a time value, it is used
as the registration time (possibly further specified by argument variable RM).
3. If neither a valid QT nor RT argument variable is given, the registration time is read
from the system clock.
When the object is started by a process event channel or by a predefined event channel,
argument variables QT, RT and RM normally contain the time of the triggering event.
When TS attribute is set to 1, the RT and QT attributes of the command procedure object
will match the time of the event.
EP Execution Priority
The execution order of the object relative to other command procedures and data objects
within the same time channel. Objects with the same EP value may be executed in any
order.
Data type: Integer
Value: 0 ... 255
0 is the highest and 255 the lowest priority order
175
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
PE Parallel Execution
This attribute indicates whether the object is executed by a parallel queue or not, see
Chapter 6 Event handling objects.
Data type: Integer
Value: 0 Non-parallel execution
1 Parallel execution
Default value: 0
Access: No restrictions
PQ Parallel Queue
The number of the parallel queue that will execute the object, see Chapter 8 Data objects.
If PE = 0, this attribute has no meaning.
Data type: Integer
Value: 0 ... APL:BPQ
Value 0 means that any parallel queue will do.
Default value: 0
Access: No restrictions
SE Start-up Execution
This attribute indicates whether the command procedure is executed during application
start-up, when reporting is chasing the real time. If the value of this attribute is 0 (no
start-up execution) and a scheduled run has been missed during the application shutdown,
the status attribute (OS) is set to NOT_SAMPLED_STATUS (10) and the time stamp
attributes (RT and QT) tells the time of last missed execution.
Data type: Integer
Value: 0 No
1 Yes
Default value: 0
Access: No restrictions
176
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
TC Time Channel
The name of the time channel that runs the command procedure.
Data type: Text
Value: Object name
Access: Read-only, configurable
Note: Division of the report database into several files was, in the first place, implemented
due to the 32 MB size limit of MicroSCADA files. Now that no such restriction exists
anymore, using HN values other than 0 is more or less obsolete.
MO Memory Only
This attribute determines whether the dynamically changing attributes OS and RT (QT)
are stored on disk. If old values (stored before last start-up) of these attributes are not
interesting to the application, some performance gain may be achieved by setting this
attribute to 1.
Data type: Integer
Value: 0 OS and RT (QT) are stored on disk
1 OS and RT (QT) are stored only in RAM
Default value: 0
Access: Read-only, configurable
177
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
178
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
10 Time channels
This chapter describes the time channels, the time channel attributes and the definition
of time channels. It contains the following sections:
10.1 General: The use and function of time channels, the object notation and
the storage of time channels.
10.2 Time channel attributes: The time channel attributes listed and described.
The attributes are grouped according to the their function.
10.3 Defining time channels with SCIL
10.1 General
Use
Time channels provide schedules for automatic time activated start-up of operations in
the report database: logging of data objects and execution of command procedures. A
time channel can start one or more objects. If a time channel starts several objects, they
are started in priority order, see Figure 10.1. Each data and command procedure object
can be connected to only one time channel at a time.
A time channel is activated at chosen times, either at an absolute moment or cyclically
at fixed intervals. Discontinuous time activation is handled by means of conditions.
Time channels are used for cyclic program execution or data registration: time dependent
reports, trends, regular checks, time control, etc.
Function
A time channel has two functions: execution and initialization, see Figure 10.1. Execution
of a time channel means that the data and command procedure objects connected to the
time channel are executed. The objects are executed in the order of their priority (the EP
attribute). Initialization implies that the history registrations of the data objects attached
to the time channel are cleared (see Chapter 9 Command procedures for details). For
command procedures, initialization has no meaning.
Both initialization and execution can take place cyclically with fixed cycle lengths. The
cycle may be synchronized to the calendar clock or not. If not, adjusting the system clock
does not affect the effective length of the cycle (see attribute CP).
Cyclic initialization and execution is synchronized at chosen synchronization times. At
synchronization the cyclic initialization/execution is restarted, regardless of the phase
of the cycle in progress. Hence, initialization/execution always takes place at the
synchronization times. If no cycle is given, initialization/execution is done only at
synchronization times. Synchronization can occur once at a selected time or periodically
179
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
once a year, once a month, once a week, once a day or once an hour or it may be tied to
a daylight saving time switch, see Figure 10.1.
Conditional initialization and execution is obtained by means of conditions. A condition
is a boolean SCIL expression that is evaluated before the time channel is run. If the
evaluation results to TRUE, the time channel is run, otherwise it is skipped.
When run times of time channels coincide, the following rules are applied, in the given
order, to resolve the running order:
1. All executions are always done before initializations.
2. Runs synchronized to daylight saving time switch are done before others.
3. Runs with shorter cycles are done first.
4. Runs with shorter synchronization periods are done first.
If the rules do not resolve the order, the runs take place in unspecified order.
Time
Time Channel
X The objects are
emptied of all
Initialization registered data
Data Object
- Period
- Synchronization Time Channel: X
- Condition Priority: 1
New
Registration
Execution
- Period
- Synchronization Data Object
#EXEC - Condition
Event channel Program
Execution Time Channel: X
Priority: 2
Time_channels.CNV
Figure 10.1: The function of time channels. Data objects and command procedures are started in the order of their priority
(the EP attribute).
180
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 10.2: The activation of a time channel with periodic execution and initialization.
Time channels can also be executed by event channels (Chapter 11 Event channels) and
by the #EXEC and #EXEC_AFTER command (Section 5.3 Dynamic process object
attributes). In these cases, execution of the time channel takes place immediately and
independent of the condition. The execution does not affect the scheduled behavior of
the time channel. Initialization of the time channel cannot be done this way.
When an application is restarted after a shutdown, time channels are scheduled according
to their start-up execution policy, either once for each missed run, once or only according
to their next run time (see attribute SP).
As a rule, time channels are run in the time channel queue of the report database, as the
name of the queue implies. However, if parallel execution is specified (attribute PE is
set to 1), the time channel queue only takes care of the scheduling, the execution is done
in one of the parallel queues. Also, the executions started by an event channel or by SCIL
are done in the event channel queue.
Storage
The maximum number of time channels in an application is 65 535. Time channel objects
are stored in the report database file APL_REPORT.000. When the application is WARM
or HOT, the time channels along with all their attributes are stored in the global memory
pool of MicroSACADA as well (see the System Objects manual). A time channel may
be defined as “memory only” (see attribute MO). In this case, the dynamically changing
attributes (time tagging attributes) are not written into the disk file.
Object notation
Time channel attributes are accessed in SCIL with the following object notation (see
also Chapter 4 Object handling):
name:{application}T{attribute}{(index)}
or
181
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
name:{application}T{attribute}{index}
where
'name' is the name of the time channel
'application' is the logical application number
'attribute' is the attribute name
'index' is an index or an index range
Time channels have no default attribute. Consequently, a time channel object notation
without an attribute name always refers to the entire object.
Indexing is used to distinguish between initialization and execution.
CM Comment
A freely chosen text.
Data type: Text
Value: Any text, up to 255 characters
Access: No restrictions
IU In Use
This attribute indicates whether the time channel is in use or not. When the time channel
is not in use (IU = 0), it is never executed. However, its attributes can be both read and
written normally. When a time channel is taken into use (IU is set from 0 to 1), it is
scheduled according to the values of its scheduling attributes.
Data type: Integer
Value: 0 Out of use
1 In use
Default value: 0
182
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Access: No restrictions
LN Logical Name
The name of the time channel.
Data type: Text
Value: Object name
Access: Read-only, configurable
MO Memory Only
Specifies whether the dynamically changing attributes (time tagging attributes, see
Section 10.2.4 Time tagging) are written into the disk database file. Disabling disk writes
may be useful when running SYS600 without a hard disk.
Data type: Integer
Value: 0 All attributes are stored on disk
1 Time tagging attributes are not stored on disk
Access: No restrictions
At application start-up, the system does not know when a memory-only time channel
has been executed last. Therefore, the start-up execution policy value "YES" (see attribute
SP) is not allowed while MO = 1.
ZT Modification Time
The time when the object was created or modified. This attribute is set by the base system
when the object is created, and it is updated each time the object is updated by the
#MODIFY command (for example, by an object definition tool).
Data type: Time
Access: Read-only
10.2.2 Scheduling
CD Condition
Condition for running the time channel.
Data type: Vector of 2 text elements
Value: Boolean SCIL expression
Indexing: 1 Initialization
2 Execution
183
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
CP Cycle Policy
Specifies whether the cycle (attribute CY) is synchronized to the calendar clock or not.
If the cycle policy is set to "CALENDAR", the execution and initialization run time is
synchronized to the system clock. For example, if the cycle is 15 minutes, the scheduling
takes place at 00:00, 00:15, 00:30 etc. (unless synchronized to some other minute using
SY attribute). If the system clock is adjusted, the effective cycle length may differ from
the specified 15 minutes. The behavior at daylight saving time switches is specified by
the DP attribute.
If the cycle policy is set to "EVEN", the run times are not synchronized to the system
clock. If the cycle is 15 minutes, the scheduling may take place at 00:03:37, 00:18:37,
00:33:37, etc. Even if the system clock is adjusted, the effective cycle length is 15 minutes.
Daylight saving time switches do not affect the cycle length.
Data type: Text keyword
Value: "CALENDAR" Synchronized to calendar clock
"EVEN" Not synchronized
Default value: "CALENDAR"
Access: No restrictions
CY Cycle
Time interval between cyclic runs. The cycling starts at synchronization times.
Data type: Vector of 2 integers
Value: Cycle length, >= 0
Unit: Seconds
Indexing: 1 Initialization
2 Execution
Access: No restrictions
184
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
If the system runs in UTC time, this attribute has no effect, because there is no daylight
saving time. Also, when CP is set to "EVEN", this attribute has no meaning.
Data type: Text keyword
Value: "CALENDAR" Scheduled according to local time
"EVEN" Scheduled according to UTC time
"APPLICATION_DEFAULT" see below
Default value: "EVEN"
Access: No restrictions
185
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Note: For memory-only (MO = 1) time channels, SP attribute value "YES" is not allowed,
because the system does not know when the last run took place.
SU Synchronization Unit
Defines how often periodic synchronization takes place. The exact moment of first
synchronization is defined by the SY attribute.
Data type: Vector of 2 integers
Value: Synchronization unit coded as 0 ... 7:
0 No synchronization or once at the time determined by the
SY attribute
1 Once a year at the time determined by the SY attribute
2 Once a month at the time determined by SY
3 Last day of month at the time determined by the SY attribute
4 Once a week on the day of week and time fixed by the SY
attribute
5 Once a day at the hour and minute determined by the SY at-
tribute
6 Once an hour at the minute determined by the SY attribute
7 CY seconds before next daylight saving time switch
Indexing: 1 Initialization
2 Execution
Default value: 0
Access: No restrictions
186
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
SY Synchronization Time
The time of first synchronization. At the synchronization time, periodic
initialization/execution is started or restarted. See the SU attribute.
Data type: Vector of 2 time or list elements (qualified time)
Value: Absolute time
Indexing: 1 Initialization
2 Execution
Default value: 1978-01-01 00:00 (zero time)
Access: No restrictions
Example:
Time channel X is set to be executed after an hour. After that it is scheduled according
to its other scheduling attributes.
#SET X:TSY2 = CLOCK + 3600
PE Parallel Execution
This attribute indicates whether the object is executed in a parallel queue or not, see
Chapter 6 Event handling objects.
Data type: Integer
Value: 0 Non-parallel execution
1 Parallel execution. The object is executed in the queue spe-
cified by the PQ attribute.
Default value: 0
Access: No restrictions
187
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
PQ Parallel Queue
The number of the parallel queue, meaningful only if PE = 1. See Chapter 6 Event
handling objects.
Data type: Integer
Value: 0 ... APL:BPQ
Value 0 means that any parallel queue will do.
Default: 0
Access: No restrictions
SX Synchronized Execution
Specifies whether the completion of parallel objects of the time channel is waited for
before the next non-parallel object is started, see Figure 10.3.
Data type: Integer
Value: 0 No
1 Yes
Default value: 0
Access: No restrictions
Figure 10.3: An illustration of the SX attribute. The numbered boxes represent data objects and
command procedures that are run by the time channel. Objects 3, 4 and 5 are parallel, the others
are nonparallel. SX = 1 should be chosen if object number 6 is dependent on the results from
objects 3, 4 and 5.
188
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Time tagging attributes contain the timing information of latest scheduled run (execution
and initialization) of the time channel. Attributes RT, RS, QT and QS indicate scheduled
times, i.e. the times when the time channel was supposed to be run. Attributes RB, RE,
QB and QE tell the realized run time. The latter ones are updated only if the condition
(attribute CD) of the time channel is fulfilled, i.e. the data and command procedure
objects of the channel are executed (or initialized).
Attributes RT, RS, RB and RB give the run times with one second resolution as time
data type. Attributes QT, QS, QB and QE supply one millisecond resolution and daylight
saving time information as well.
The time tagging attributes are updated only by scheduled runs. They do not change
when a time channel is executed via an event channel or by SCIL command #EXEC or
#EXEC_AFTER.
189
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Indexing: 1 Initialization
2 Execution
Access: Read only
190
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Indexing: 1 Initialization
2 Execution
Access: Read only
RT Registration Time
The latest scheduled run time. This attribute is updated even if the condition of the time
channel is not fulfilled.
Data type: Vector of 2 time elements
Indexing: 1 Initialization
2 Execution
Access: Read only
191
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
V = FETCH(2,"T","TC_1")
V.CD = ("","DOW == 7")
#CREATE TC_2:T = V
A new time channel is created by copying an existing one from application 2 and adding
a condition for execution (executed only on Sundays).
192
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
11 Event channels
This chapter describes event channels and their attributes, as well as how to define the
event channels. It is divided in the following three sections:
11.1 General: The use of event channels and their function, the variables
transferred to the event channels.
11.2 Event channel attributes: Event channel attributes in alphabetical order.
11.3 Predefined event channels: Predefined event channels. The event channels
with predefined names and functions.
11.1 General
Use
Event channels are facilities for automatic event activated start-up of operations in the
report database. An event channel can start execution of data objects, command procedures
and time channels. Event channels are activated by process events (changes in the process
object values), by some application and system events and by SCIL. In other words, they
create a channel between external events and the report database.
The event channels are used for, for example:
• Storing process events in the report database.
• Event activated program execution, for example process control, calculation, printout,
etc.
• Forwarding process data to other objects.
• Automatic dial-up of stations or remote workstations.
• Event-activated system configuration.
Function
An event channel is essentially a list of other type of report database objects (command
procedures, data objects and time channels). One of these objects is the primary object
and the others (up to 10) are called secondary objects. The primary object is mandatory,
secondary objects are optional.
Activation (execution) of an event channel means that the primary object is first queued
for execution, followed by the secondary objects (if any) in the order they are listed in
the event channel object. Note that the objects are not executed at once, they are only
queued to one of the report database queues to be executed as soon as possible.
As a rule, the objects are queued to the event channel queue of the report database, as
the name of the queue implies. The objects may, however, specify parallel execution
instead (attribute PE set to 1). If an event channel is executed by SCIL in a command
procedure object, the objects are queued to the queue where the command procedure is
run.
193
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
#EXEC Activation_event_channel.CNV
194
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Variables
When an event channel is activated by SCIL, any number of named arguments may be
passed to it as a variable list.
Example:
#EXEC CHANNEL:A (@NAME = "ABC", @OV = 1)
The command procedure and data object(s) started by the channel may use the argument
variables as any other variables, and they are preset when the object starts its execution.
Each object started by the event channel has the same initial values for the argument
variables. If, for example, event channel CHANNEL in the example starts command
procedures C1 and C2, and C1 modifies variable OV, C2 still starts with OV value 1.
When an event channel is activated automatically by the process database, the argument
variables, called snapshot variables, are predefined and, as a rule, have the name of a
process object attribute. They reflect the state of the process object at the very moment
of the process event. The snapshot variables are described in Section 5.2.8 Post-processing.
Argument variables of predefined event channels started by various system events are
described in Section 11.3 Predefined event channels.
Storage
The maximum number of event channels in an application is 65 535. Event channel
objects are stored in the report database file APL_REPORT.000. When the application
is WARM or HOT, the event channels, along with all their attributes, are stored in the
global memory pool of SYS600 as well (see the System Objects manual).
Object notation
Event channel attributes are accessed in SCIL with the following object notation (see
also Chapter 4 Object handling.):
name:{application}A{attribute}{(index)}
or
name:{application}A{attribute}{index}
where
'name' is the name of the event channel
'application' is the logical application number
'attribute' is the attribute name
'index' is an index or an index range
Event channels have no default attribute. Consequently, an event channel object notation
without an attribute name always refers to the entire object.
195
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
CM Comment
A freely chosen comment text.
Data type: Text
Value: Any text, up to 255 characters
Access: No restrictions
LN Logical Name
The name of the event channel.
Data type: Text
Value: Maximum length 63 characters.
Access: Read-only, configurable
ON Object Name
The name of the primary object activated by the event channel.
Data type: Text
Value: Object name. Maximum length 63 characters.
Access: No restrictions
OT Object Type
The type of the primary object activated by the event channel.
Data type: Text
Value: "D" Data object
"C" Command procedure object
"T" Time channel object
Access: No restrictions
196
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
ZT Modification Time
The time when the object was created or modified. This attribute is set by the base system
when the object is created, and it is updated each time the object is updated by the
#MODIFY command (for example, by an object definition tool).
Data type: Time
Access: Read only
197
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
198
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
199
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
3 Communication break
200
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
201
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
HOST_APL The application number of the (local) application causing the conflict.
HOST_UNIT The unit number in the conflicting application.
AEP_EVENT
Event channel AEP_EVENT is activated whenever the state of an Application Extension
Program (AEP) changes. This event channel is implemented to supervise the AEP’s of
the application, for example to generate an alarm when an AEP becomes non-responsive.
The following argument variables are passed to the event channel:
AEPN The (SCIL) number of the AEP
EVENT Keyword describing the event:
"START" The AEP has been started.
"STOP" The AEP has stopped.
"CRASHED" The AEP has terminated ab-
normally.
"NO_RESPONSE" The AEP no longer responds.
"RECOVERED" The AEP has recovered from
the NO_RESPONSE state.
TIME The time stamp of the event (qualified time)
START_COMMAND The AEP_START argument used to start the AEP
202
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
HISTORIAN_EVENT
Event channel HISTORIAN_EVENT is activated whenever the state of a Historian
database connection changes or errors in configuration are encountered.
The following argument variables are passed to the event channel:
DATABASE The name of the DATABASE logging profile object that defines
the connection to the Historian database.
EVENT Keyword describing the event:
"CONNECTED" The database has been successfully
connected.
"RECONNECTED" The database has been successfully
reconnected after a communication
break. No data has been lost.
"LOST" The connection to the database has
been lost due to a communication
break.
"DISCONNECTED" The connection to the database has
been closed. If disconnected by the
communication process (CPMW),
the reason is described by variable
MESSAGE.
"STOPPED" The communication process (CP-
MW) has stopped due to an error
described by variable MESSAGE.
"CONNECT_FAILURE" A connection to the database could
not be established due to an error
described by variable MESSAGE.
"TAG_NOT_FOUND" A previously configured tag no
longer exists in the database. The
name of the tag is given as variable
TAG. A new tag is created.
"MISSING_TEMPLATES" The history templates given as text
vector variable TEMPLATES do
not exist in the Historian database.
TIME The time stamp of the event (qualified time)
203
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
UAL_EVENT
Event channel UAL_EVENT is activated whenever an event is written to the User
Activity Log.
The following argument variables are passed to the event channel:
EVENT_ID UAL defined integer that identifies the type of the event
EVENT_TEXT Localized description of the event id
TIME Local time of the event as qualified time (data type list)
SOE Sequence number of the event
USER User name
SEVERITY Syslog severity of the event (0 .. 7)
SOURCE Source of the event (text)
SENDER_IP IP address of the sender of the event
EXTRA_INFO Event id specific extra info of the event
The implemented values for SOURCE are "UN", "APL", "HOST" and "IMAGE".
Unit events
In the case of unit events (SOURCE = "UN"), the argument variables have the following
meaning:
SOURCE "UN"
SOURCE_NR Unit number (logical sta-
tion number)
EVENT "SUSPENDED" The connection to the station is lost
204
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
The events "RUNNING" and "SUSPENDED" are reported by all station types only if
the SE attribute of the NET node (NODn:SSE) is 3 or 4. Otherwise, they are reported
only by some station types (e.g "REX"). For more information, see the System Objects
manual.
205
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Host events
The host events (SOURCE = "HOST") are events that inform the image application
about the mirroring connections to host applications. The argument variables have the
following meaning:
SOURCE "HOST"
SOURCE_NR Application number of
the host
EVENT "CONNECTED" The connection to the host is established.
"LOST The connection to the host is lost.
"DISCONNECTED" The connection to the host has been dis-
connected by the image, because there
are no stations connected to the host any
more.
206
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Image events
The image events (SOURCE = "IMAGE") are events that inform the host application
about the mirroring connections to image applications. The argument variables have the
following meaning:
SOURCE "IMAGE"
SOURCE_NR Application number of
the image
EVENT "CONNECTED" The connection to the image is established.
"LOST" The connection to the image is lost.
"DISCONNECTED" The image application has disconnected the
mirroring session.
"RECONNECTED" The connection to the image is re-estab-
lished without losing any events.
"OVERFLOW" The event buffer for the image has over-
flown. Events have been lost.
207
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
IP_EVENT
Event channel IP_EVENT is activated whenever the state of an Integrated Program (IP)
changes. This event channel is implemented to supervise the IP’s of the system, for
example to generate an alarm when an IP becomes non-responsive.
The following argument variables are passed to the event channel:
IPN The (SCIL) number of the IP
EVENT Keyword describing the event:
"START" The IP has been started.
"STOP" The IP has stopped.
"CRASHED" The IP has terminated abnormally.
"NO_RESPONSE" The IP no longer responds.
208
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Printer events
The printer supervision done by the base system may generate the following events:
SOURCE "PRI"
SOURCE_NR The physical printer number
EVENT "LOST" Off-line, out of paper, paper jam etc.
"FOUND" OK after being LOST.
"OUTPUT LOST" Some output lost due to queue overflow
209
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
The "OUTPUT LOST" event is generated when the printer queue length PRIn:BQU
exceeds the maximum length PRIn:BQM (see the System Objects manual).
Node events
The node diagnostics (see the System Objects manual) may generate the following events:
SOURCE "NOD"
SOURCE_NR The node number
EVENT "LOST" Connection to the node is lost
"FOUND" Connection to the node is re-established
The following system events are generated whenever an application has changed its
shadowing phase (APL:BSP):
SOURCE "APL_SP"
210
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
This event is generated only once per system start-up. It may, however, be re-enabled
by setting attribute SYS:BME.
The following system events are generated to enable local memory pool supervision:
SOURCE "PICO_POOLi" i = Monitor number (1 … 100)
"REPR_POOLi" i = Queue number (1 … 32)
"PRIN_POOLi" i = 1 (process printouts) or
i = 2 (report printouts)
SOURCE_NR Application number
EVENT "OVERFLOW"
These events are generated only once per application start-up. They may, however, be
re-enabled by setting the ME attribute of the application object.
211
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Each of these events is generated only once per application start-up. They may, however,
be re-enabled by setting the QE attribute of the application.
License events
The following license events report various events related to the violation or expiration
of the system license. In addition to the standard SYS_EVENT argument variables, the
name of license field is always passed to the event channel in the argument variable
FUNCTIONALITY.
SOURCE "LICENSE"
SOURCE_NR 0 (not applicable)
EVENT "VIOLATION" An attempt has been made to violate one of the fields
of the license. The name of the field is passed in the
argument variable FUNCTIONALITY as follows:
"EXPIRATION" The license has expired.
"HW_KEY" No valid hardware key has
been found in the hour after
the start-up or the system has
run for a week after last de-
tection of a valid key.
"HSB" Unlicensed attempt to start
shadowing take-over.
"MIRRORING" Attempt to create a STA:B
object with an unlicensed
mirroring role.
212
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
213
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
214
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
The predefined event channel OS_EVENT receives Windows operating system events
(stored in the Windows Event Log) converted into SCIL format by the Operating System
Event Handler (OSEH).
Like SYS_EVENT, OS_EVENT is a system event channel, and the application must be
enabled by APL:BEE to receive these events.
The following argument variables are passed to the event channel:
RECORD_NR Integer, the event sequence number supplied by Windows
RT Time value, the time of event
TYPE A keyword specifying the type of event:
215
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
"ERROR"
"WARNING"
"INFORMATION"
"AUDIT_SUCCESS"
"AUDIT_FAILURE"
DOMAIN The domain name of the computer that generated the event
COMPUTER The name of the computer that generated the event
USER The name of the active user at the time event was logged (if pos-
sible to define)
LOG A keyword identifying one of the three Windows event logs:
"APPLICATION"
"SYSTEM"
"SECURITY"
SOURCE The name of the source (application, service, driver, subsystem)
that generated the event
CATEGORY Integer, a source specific category id
EVENT Integer, a source specific event id, which together with SOURCE
identifies the message
MESSAGE A text vector, the source specific message string. The message
may contain several lines.
216
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
This chapter describes logging profiles and their attributes. It is divided in the following
two sections:
12.1 General: The use of logging profiles and their function.
12.2 Logging profile attributes: Logging profile attributes.
12.1 General
Use
Logging profile objects are used to define the connection of SYS600 application database
to a Historian database.
A Historian database is a high performance time series database designed to store large
amounts of real-time data for later analysis and reporting. See the manuals Historian
Configuration and Administration, Historian Operation and Historian Monitor
Configuration for more information about Historian databases.
Functionality
The following data from the SYS600 database can be logged to a Historian database:
1. OV (Object Value) attribute of process objects of following types:
• BI (Binary Input)
• BO (Binary Output)
• DB (Double Binary)
• DI (Digital Input)
• DO (Digital Output)
• AI (Analog Input)
• AO (Analog Output)
• PC (Pulse Counter
2. OV (Object Value) attribute of data objects of value type real or integer.
In addition to the value itself, the time stamp and status are also logged (attributes RT
and OS, respectively).
The objects to be logged are specified by linking the object to a logging profile object
(attribute GP of process and data objects).
The logging profile objects specify where and how the data is logged.
217
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
• An OBJECT type profile is used to group a set of process and data objects that share
a set of logging properties.
• A DATABASE type profile specifies one Historian database and a set of logging
properties specific to this particular database.
• A HISTORY type profile specifies how the logged data will be aggregated in the
Historian database (averaging, summing up, etc.).
Each logged process and data object has a reference (attribute GP) to one OBJECT type
logging profile. The profile defines a few logging properties (Compression Accuracy
and Discreteness, see below) and up to 10 logging profile pairs of one DATABASE
profile and one HISTORY profile (Storage). Thus, the Storage attribute tells the Historian
databases to receive the data and aggregates to be used in each database.
A DATABASE type profile defines:
• The location and credentials of the database: attributes Database Address, User
Name and Password.
• Patterns for deducing values for various Historian tag properties from SYS600
database attributes. The patterns are given as deterministic, static SDDL (SCIL Data
Derivation Language) expressions. See the manual Programming Language SCIL
for SDDL details.
Additionally, the profile exposes the state of the database connection (Object Status)
and various diagnostics (Diagnostic Counters).
A HISTORY type profile contains only one additional attribute (History Collection
Templates), which simply lists the Historian history collection templates to be used to
aggregate the data.
Storage
The maximum number of logging profiles in an application is 65 535. Logging profile
objects are stored in the report database file APL_REPORT.000. When the application
is WARM or HOT, the logging profiles along with all their attributes are stored in the
global memory pool of SYS600 as well (see the System Objects manual).
Object notation
Logging profile object attributes are accessed in SCIL with the following object notation
(see also Chapter 4 Object handling.):
name:{application}G{attribute}{(index)}
or
name:{application}G{attribute}{index}
where
'name' is the name of the logging profile
'application' is the logical application number
218
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Logging profiles have no default attribute. Consequently, a logging profile object notation
without an attribute name always refers to the entire object.
CM Comment
A freely chosen comment text.
Data type: Text
Value: Any text, up to 255 characters
Access: No restrictions
IU In Use
This attribute indicates whether the logging profile is in use or not. When an OBJECT
type logging profile is not in use (IU = 0), the process and data objects connected to the
profile are not logged. When a DATABASE type logging profile is not in use, the
Historian database is disconnected. When taken into use, the connection is established.
Data type: Integer
Value: 0 Out of use
1 In use
Default value: 0
Access: No restrictions
LN Logical Name
The name of the logging profile.
Data type: Text
Value: Maximum length 63 characters.
Access: Read-only, configurable
PT Profile Type
The profile type of the logging profile object.
Data type: Text
219
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
ZT Modification Time
The time when the object was created or modified. This attribute is set by the base system
when the object is created, and it is updated each time the object is updated by the
#MODIFY command (for example, by an object definition tool).
Data type: Time
Access: Read only
CA Compression Accuracy
The compression accuracy used by the objects connected to the profile. Historian database
implements a compression algorithm used to save disk space required by the logged
values. Compression accuracy defines the maximum loss of accuracy at any moment of
time compared to uncompressed data. The value of this attribute is given in units of the
logged data (kV, A ...).
Data type: Real
Value: Requested compression accuracy. Value 0.0 implies that compression
is not used.
Default value: 0.0 (compression not used)
Access: No restrictions
When CA is changed, all the process and data objects connected to the profile are
reconfigured in the Historian database(s).
DI Discreteness
The discreteness of the values of objects connected to the profile. Discreteness defines
how the trends are drawn in the user interface of Historian. For non-discrete values, any
two consecutive logged values are connected by an inclined line. Discrete values are
presented as steps (horizontal and vertical lines). Discreteness also affects some aggregate
calculations.
Data type: Text
220
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
When DI is changed, all the process and data objects connected to the profile are
reconfigured in the Historian database(s).
ST Storage
This attribute specifies the Historian databases where the data from this profile is to be
logged and, for each database, how the data is aggregated.
Data type: Vector of up to 10 lists
Element value: List of two attributes:
"DB" The name of a DATABASE type logging profile
that specifies the Historian database to be used.
"HC" The name of a HISTORY type logging profile that
lists the used history collection templates (aggrega-
tion).
Default value: Empty vector
Access: No restrictions
When ST is changed, all the process and data objects connected to the profile are
reconfigured in the Historian database(s).
DA Database Address
The address of the Historian database.
Data type: Text, up to 255 characters
Value: DNS or IPV4 address of the database installation
Default value: ""
Access: Read, conditional write
The attribute can be changed only when the object is out of use (IU = 0).
221
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
DC Diagnostic Counters
Diagnostic counters of the Historian database connection.
Data type: Vector of 13 integers:
Indexing: 1 Connect count, transitions to CONNECTED state from states
NONE or DISCONNECTED
2 Lost count, transitions to state LOST (communication breaks)
3 Reconnect count, transitions from LOST to CONNECTED
state (recovered communication breaks)
4 Fail count, unintentional transitions from CONNECTED or
LOST to DISCONNECTED state
5 Connect time, seconds since last connect
6 Tag count, number of connected tags
7 Kilo-operations, number of database operations divided by
1000. A counted operation is either a logging of a tag value,
or a creation of a tag, or a change in the configuration of a
tag.
8 Operations, remainder after division (see above)
9 Throughput, written values per second, floating one minute
average
10 Maximum throughput
11 Queue limit, maximum length of the send queue
12 Queue length, current length of the send queue
13 Maximum queue length
Default value: All zeroes
Access: Read-only
Counters 1 to 4 are cumulative since the application start-up. Counters 5 to13 are cleared
at every successful connect. When the database is not connected, the counters 6 to 13
show the final figures from the latest connection.
DD Description Pattern D
Description pattern for data objects.
Data type: Text, up to 255 characters
Value: An SDDL expression used to deduce the Description property of the
database tag for data objects.
Default value: "LN"
Access: No restrictions
222
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
When DD is changed, all the data objects connected to the Historian database are
reconfigured. Also, any such change in attribute value in a data object that affects the
value of the SDDL expression triggers the reconfiguration of the data object.
DP Description Pattern P
Description pattern for process objects.
Data type: Text, up to 255 characters
Value: An SDDL expression used to deduce the Description property of the
database tag for process objects.
Default value: "if(OI <> "", join(" ", IE), LN + ":" + dec(IX, 0)) + " " +TX" If OI is
given, combine OI elements and TX. if OI is not given, combine LN,
IX and TX.
Access: No restrictions
When DP is changed, all the process objects connected to the Historian database are
reconfigured. Also, any such change in attribute value in a process object that affects
the value of the SDDL expression triggers the reconfiguration of the process object.
When ED is changed, all the data objects connected to the Historian database are
reconfigured. Also, any such change in attribute value in a data object that affects the
value of the SDDL expression triggers the reconfiguration of the data object.
223
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
When EP is changed, all the process objects connected to the Historian database are
reconfigured. Also, any such change in attribute value in a process object that affects
the value of the SDDL expression triggers the reconfiguration of the process object.
ND Name Pattern D
Name pattern for data objects.
Data type: Text, up to 255 characters
Value: An SDDL expression used to deduce the Proposed Name property of
the database tag for data objects.
Default value: "LN"
Access: No restrictions
When ND is changed, all the data objects connected to the Historian database are
reconfigured. Also, any such change in attribute value in a data object that affects the
value of the SDDL expression triggers the reconfiguration of the data object.
NP Name Pattern P
Name pattern for process objects.
Data type: Text, up to 255 characters
Value: An SDDL expression used to deduce the Proposed Name property of
the database tag for process objects.
Default value: "LN + ":" + dec(IX, 0)"
Access: No restrictions
When NP is changed, all the process objects connected to the Historian database are
reconfigured. Also, any such change in attribute value in a process object that affects
the value of the SDDL expression triggers the reconfiguration of the process object.
OS Object Status
The connection status of the Historian database.
Data type: Text
Value: "NONE" The object is not in use.
"DISCONNECTED" The database is not connected either be-
cause the connection has failed or the con-
nection has been lost for a long time (buffer
overflow).
"LOST" The network connection to the database has
been lost. The logged values are still buf-
fered to wait for possible re-connection.
224
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
PW Password
The password that is used for logging into the Historian database.
Data type: Text, up to 255 characters
Value: Password
Default value: ""
Access: Read, conditional write
The attribute can be changed only when the object is out of use (IU = 0).
SY Synchronize Tags
Setting the attribute synchronizes the Historian database tags to the logged SYS600
objects.
Data type: Integer
Value: 1 when set, 0 when read
Default value: 0
Access: Read, conditional write
When SY is set to 1, all such Historian database tags created by the application that no
more have a corresponding SYS600 object to log are deleted.
The attribute can be set only when the Historian database is connected.
US User Name
The user name that is used for logging into the Historian database.
Data type: Text, up to 255 characters
Value: User name
Default value: ""
Access: Read, conditional write
The attribute can be changed only when the object is out of use (IU = 0).
225
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
When HC is changed, all the process and data objects connected to the profile (via an
OBJECT type logging profile object) are reconfigured.
226
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
13 Event objects
Use
Event objects facilitate automatic event-driven functions in user interface objects (pictures
and Visual SCIL objects). The function to be performed is defined as a SCIL program
sequence (using the #ON command, Section 4.3 Some SCIL commands) or as an event
method in Visual SCIL objects.
The event objects are useful, for example, for the following purposes:
• To respond immediately to process events in user interface objects. The process
objects of interest are defined with event object activation (the attribute EE is set to
1). The response, i.e. a SCIL statement or program, is defined with #ON command
or as an event program. This makes cyclic updating with update programs
unnecessary. See Figure 13.1 and the next example.
• To communicate between monitors or between a command procedure and monitors.
Any SCIL program may activate an event (using #EXEC command) to notify all
open monitors for some significant application defined event.
Events may be used only within an application, they are not sent from an application to
another.
Function
Event objects are activated by process events or by SCIL (see below). The activation of
an event object is noted in all monitors belonging to the application. In pictures displayed
at the moment, it causes an execution of SCIL sequences defined for the event by means
of the #ON command. In Visual SCIL objects, it causes the execution of the event
methods specified for the event.
When an #ON command is executed (in a picture or in a Visual SCIL object), its argument
#ON block (a SCIL statement) is not executed at once but stored for later use. Whenever
the event object (given as the first argument of the #ON command) is executed, the #ON
block will be executed. See Figure 13.1.
The #ON commands are picture and picture function specific. Consequently, the main
picture, window pictures and all their picture functions may contain an #ON block for
the same event. Correspondingly, several Visual SCIL objects may contain an event
method for the same event.
227
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
#EXEC BREAKER3:E2
Displays
#ON BREAKER3:E2 #BLOCK
!SHOW BREAKER3 BREAKER3:PB12
#BLOCK_END
BREAKER3:E2
Process BREAKER3:PB12
Database (EE = 1)
Process
Event_objects
Figure 13.1: An example that illustrates the use of event objects in pictures.
Storage
Event objects are not stored.
228
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
name:{application}E{(index)}]
or
name:{application}E{index}
where
'name' is the name of the object
'application' is the logical application number
'index' is an index
Although the syntax allows for the application number, events are not sent from
application to another. Consequently, if the application number is given in the notation,
it must be the number of the current application.
Event objects have no attributes.They can only be used with the #EXEC, #EXEC_AFTER
and #ON commands.
Example
If the process object
BREAKER3:P2
is equipped with event object execution (BREAKER3:PEE2 = 1), the event object
BREAKER3:E2
is executed each time any of the attributes listed above is changed, see Figure 13.1.
Suppose a process picture containing the object has executed the following SCIL
statement:
#ON BREAKER3:E2 !SHOW BREAKER3 BREAKER3:PBI2
Now, the position of the breaker is shown in the window BREAKER3 each time the
event object is executed.
229
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
14.1 General
Use
Free type objects are used for defining new process object types, user-defined process
object types (see Chapter 4 Object handling), and their user-defined attributes. Using
free type objects, the programmer can define up to 156 process object types. Each new
process object type gets the common process object attributes (see the process object
attribute table in Chapter 4 Object handling). In addition, the programmer can design
new type specific attributes with desired features. Each user-defined object type has a
type number that is used as type definition when creating process objects of the type in
question.
Free type objects are mainly used for designing process object types to be used by standard
application packages and application extension programs.
Attributes
Free type objects have two types of attributes:
• Elementary attributes that are related to the process object type: name, type number,
main attribute (object value attribute), comment text and the total number of
user-defined attributes.
• Attributes that define the user-defined attributes: attribute name, data type, automatic
activation functions, etc. Each user-defined attribute is defined by a number of free
type attributes, which give the user-defined attribute its properties. The user-defined
attributes are identified by sequential numbers given as indices.
Object definition
Free type objects are defined with the #CREATE command and deleted with the
#DELETE command. A free type object cannot be deleted until all process objects of
the corresponding type have been deleted. Individual attributes cannot be deleted. After
231
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
a free type object has been created, its attributes can be changed with #MODIFY, though
with some restrictions:
• The attribute name (AN) is used to identify the attribute. Therefore the attribute
name itself may not be changed. A new attribute name is regarded as a new
user-defined attribute.
• Due to memory reservation, the new attributes given with #MODIFY do not become
valid for the process objects until the application is restarted.
Attribute 1 2 3 4 5 .......
Properties
Free_type_object_attributes.CNV
Figure 14.1: The attributes of free type objects. The type number, that is the PT attribute, is the
same as the PT attribute for the process objects. The OV attribute specifies which attribute will
be regarded as the OV attribute of the process objects.
The free type objects can also be created using an object definition tool. It can be accessed
in the Tool Manager by double-clicking the Free Types icon in the Application Objects
page.
Storage
The maximum number of free type objects in an application is 156. Free type objects
are stored in the process database file APL_PROCES.PRD. When the application is
WARM or HOT, the free type objects are stored in the global memory pool of SYS600
as well (see the System Objects manual).
Object notation
Free type objects and their attributes are accessed from SCIL with the following object
notation (see also Chapter 4 Object handling.):
232
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
name:{application}F{attribute}{(index)}
or
name:{application}F{attribute}{index}
where
'name' is the name of the object
'application' is the logical application number
'attribute' is the attribute name
'index' is an index or an index range
LN Logical Name
The name of the free type object (and the name of the process object type).
Data type: Text
Value: Object name
Access: Read-only, configurable. Cannot be modified with #MODIFY.
OV OV Attribute Name
The name of the attribute that represents the main attribute (the object value). All
automatic functions connected to the OV attribute (for example alarm handling, history
buffering, automatic printout) will be related to this attribute. The attribute must be of a
simple data type.
233
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Example:
#MODIFY TYPE_1:F=list(OV="BB")
CX Comment Text
A comment text related to the free type object.
Data type: Text
Value: Any text, up to 255 characters
Access: No restrictions
NA Number of Attributes
The number of user-defined attributes defined for the type.
Data type: Integer
Access: Read-only
ZT Modification Time
The time when the object was created or modified. This attribute set by the base system
when the object is created, and it is updated each time the object is updated by the
#MODIFY command (for example, by the Free Type Object definition tool).
Data type: Time
Access: Read-only
234
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
AN Attribute Name
The name of the attribute. The name can be any two-letter combination not used as a
common predefined process attribute name. However, some attribute names imply special
functions:
• If the OV value of the object type is integer or real, attributes LW, HW, LI, HI, SZ
and AZ will have the same function as the same attributes for analog input process
objects.
• If the OV value of the object type is a Boolean value, the AG attribute will have the
same function as the AG attribute for binary process objects.
Data type: Text
Value: Two character attribute name
Access: Read-only, configurable. Cannot be modified with #MODIFY, only
new user-defined attributes can be appended.
AI Attribute Indexing
The maximum index of the attribute (maximum number of elements) if it is a vector.
All elements in the vector are of the same data type, which is given with the AT attribute.
Data type: Integer
Value: 0 ... 10 000. 0 or 1 means that the attribute is not indexed.
Default: 0
Access: Read-only, configurable. Cannot be modified with #MODIFY, only
new user-defined attributes can be appended.
235
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
AL Attribute Length
The length of the attribute value or the elements of an indexed attribute.
Data type: Integer
Value: The value depends on the AT value (that is the data type of the attrib-
ute) in the following way:
"INTEGER" 0 Default, the same as 4 (see below)
4 Signed 32 bit value
2 Signed 16 bit value
1 Signed 8 bit value
-1 Unsigned 8 bit value
-2 Unsigned 16 bit value
"TEXT": (+)n Fixed size of n characters
-n Variable size, max. n characters where 1
<= n <= 255
"BIT_STRING": (+)n Fixed size of n bits
-n Variable size of max. n bits where 1 <= n
<= 65 535
For REAL, TIME and BOOLEAN values the attribute is ignored. The
length is fixed to 4, 4 and 1 bytes respectively.
Access: Read-only, configurable. Cannot be modified with #MODIFY, only
new user-defined attributes can be appended.
AP Attribute Printout
The selection of printout generation at attribute changes. If printout generation is selected,
the format picture of the process object (the PF attribute) is printed each time the attribute
changes.
Data type: Integer
Value: 0 No printout generation
1 Printout generation
Default: 0
Access: No restrictions
236
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
AA Attribute Action
The selection of event channel activation caused by changes of the attribute value. If
event channel activation is selected, the event channel of the process object (the AN
attribute) is activated each time the attribute is changed.
Data type: Integer
Value: 0 No event channel activation
1 Event channel activation
Default value: 0
Access: No restrictions
AH Attribute History
Selection of history database logging when the attribute is changed.
Data type: Integer
Value: 0 No history logging
1 History logging
Default: 0
Access: No restrictions
AE Attribute Event
Selection of event generation. If event generation is selected, the event object by the
name of the process object is activated each time the attribute is changed.
Data type: Integer
Value: 0 No event generation
1 Event generation
Default: 0
Access: No restrictions
AD Attribute on Disk
Updating of the attribute in the process database on disk when the attribute changes.
Data type: Integer
Value: 0 No updating
1 Updating
Default: 0
Access: No restrictions
237
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
AS Attribute Snapshot
Defining the attribute as a snapshot variable passed to the event channel and format
picture of the process object.
Data type: Integer
Value: 0 No (the attribute will not be a snapshot variable)
1 Yes (the attribute will be a snapshot variable)
Default: 0
Access: No restrictions
AO Attribute Offset
An informative attribute that tells the starting memory location of the attribute within
the consecutive memory area allocated for all the user-defined attributes of the process
object.
Data type: Integer
Value: 0 ... 60 000
Access: Read-only
Example:
A process object has four user-defined attributes of the following byte length:
1 1 byte AO(1) = 0
2 2 bytes AO(2) = 1
3 4 bytes AO(3) = 3
4 ....….. AO(4) = 7
238
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Examples
T1:FLN = = "T1"
T1:FPT = = 101
T1:FOV = = "BB"
The free type object T1 represents a user-defined process object type with type number
101. The object value (main attribute) of this type is called BB.
Suppose that the BB attribute is the first user-defined attribute of the type (index 1), and
that it has the following properties:
T1:FAN(1) == "BB"
T1:FAT(1) == "INTEGER"
T1:FAL(1) == 4
T1:FAP(1) == 1
This means that the BB attribute is a signed integer of 32 bits. A change in the attribute
generates an automatic printout.
239
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
15 Variable objects
Use
Variable objects serve as temporary storage for attributes (attributes gathered from other
objects or arbitrary attributes). They are used to form lists, for example, alarm and event
lists, to browse through object properties, to copy objects, to create and change objects,
etc.
The variable objects have no attributes of their own, but they may be assigned attributes
belonging to other object types or arbitrary attributes. The objects as a whole, including
all attributes, can be handled as variables of the data type list.
Definition
Variable objects can be created in two ways:
• by #CREATE command
• by assigning a variable a value of a list type expression
Creating a variable object erases the contents of the global variable by the same name.
Using #SET and #MODIFY commands, new attributes are added to the object and values
of existing attributes are changed.
Using #DELETE command, the object or one of its attributes is deleted.
Function
A variable object is, at the same time, both an object and a variable of list type. The list
as a whole is handled as a variable, for example %V, while the attributes in the list are
accessed with the variable object notation, e.g. V:VOV.
Being global variables, the variable objects are accessible only within the SCIL context
where they were created.
Attributes
The attributes of variable objects may have arbitrary names. Unlike other object types,
the variable objects can have attribute names containing up to 63 characters. All
alpha-numeric characters as well as underscores are allowed in the attribute names, but
the first character may not be a digit.
241
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
The variable object attributes are used in the same way as other application object
attributes. In addition, they can be used in variable expansions (for more information,
see the Programming Language SCIL manual).
For compatibility to other object types, the index does not have to be surrounded by
parantheses if the attribute name consists of exactly two letters. Otherwise, the parentheses
are mandatory. In NAME:VAA1, for example, the digit is regarded as an index. In
NAME:VAAA1 the digit is regarded as a part of the attribute name. In NAME:VAA(1)
the digit is an index.
Storage
The variable objects are stored as global variables, see the Programming Language SCIL
manual.
Examples
Creating a simple alarm list:
#INIT_QUERY "L"
@LIST = PROD_QUERY(20)
!SHOW AT LIST:VAT
!SHOW AM LIST:VAM
!SHOW LN LIST:VLN
!SHOW OX LIST:VOX
!SHOW OV LIST:VOV
!SHOW AR LIST:VAR
242
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
#INIT_QUERY "L"
@LIST = PROD_QUERY(20)
!SHOW AT %LIST.AT
!SHOW AM %LIST.AM
!SHOW LN %LIST.LN
!SHOW OX %LIST.OX
!SHOW OV %LIST.OV
!SHOW AR %LIST.AR
@V = FETCH(0,"D","DATA1")
@V.LN = "DATA2"
#CREATE DATA2:D = %V
243
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
This chapter describes how to access object definition tools through the Object Navigator
and how to use the Navigator for application object management (listing, copying,
moving, deleting, etc.). It also gives some general principles for using the object definition
tools.
245
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
If Process Objects is selected from the object tree, the view options are
Process Objects by Groups and Process Objects by Table, otherwise the options are
Objects by List and Objects by Table. The view option is selected from the View menu.
Figure 16.1: Object Navigator outlook, when process objects are viewed by groups. Status bar shows information on the
selected index.
The title of the Object Navigator can be, for example, as follows:
DEMO [101] - Object Navigator. The beginning of the title, DEMO, identifies the name
of the current application. The [101] stands for the application monitor.
The + or - sign to the left of an application name works as collapse/expand command
key. Clicking the + sign makes the object type names visible and accessible, clicking
the - sign makes the type names disappear. This makes the list easier to view.
When selecting an object type in an application, the object names of the type in question
appear in the list to the right of the object type list. If process objects were selected, the
Navigator shows a third list box furthest to the right. This list contains the indices of the
246
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
selected process object group. By default, all object names, up to one thousand names
that meet the filtering criteria of the selected type, are listed.
The buttons with the double arrows, , are enabled if there are more
than one thousand names in either direction. Clicking the middle arrow buttons result in
displaying the previous or next thousand items. Clicking the leftmost double left arrow
button results in displaying the first thousand items. Clicking the rightmost double right
arrow button results in displaying the last thousand items or as many as there are left.
Another way to browse object names is to use the numeric spinner left to arrow buttons.
The scroll bars allow the user to browse up and down in the lists.
Status bar
The status bar shows information depending on the selected object. See Table 16.1 and
Table 16.2 below.
Table 16.1: If the object is selected from object tree, status bar shows this
information
Selected object Information
Application - The type of application (LOCAL, PROXY or EXTERNAL)
- State of application (HOT, WARM, COLD or ERROR)
- The error text, if the state is error
- Computer name, if the type is EXTERNAL
- Base system version, if the type is EXTERNAL
- The text ‘Self-Diagnostics has found conflicts’, if conflicts exist
Object type - How many application objects are shown in the table
- The total number of application objects
- The state of cyclic refresh:on, off or not running
Table 16.2: If the object is selected from object table, status bar shows this
information
Selected object Information
Process Object Index - In Use or not
- Switch State
- Object type
- Object value
- Registration time
Event Handling Object - Event Handling Type
- Value Count (of SYS Event Handling)
- Value Low (of SYS Event Handling)
- Node (of AEC Event Handling)
- Event Type (of AEC Event Handling)
- Modification time
Scale Object - Scaling algorithm (Linear 1:1, Linear or Stepwise Linear)
- Modification time
247
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
In Figure 16.2, the status bar shows that the process object A_E_QD54 with index 10 is
in use. The Switch State is manual, the object type is Double Binary Indication
(REX/Double Indicat.) and the value is 1. The registration time was 2012-10-08
14:45:55.277.
248
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 16.2: The status bar gives information about the selected process object A_E_QD54
If an application object type is selected from object tree but no objects are selected from
the table, the status bar shows the number of objects in view and the total number of
objects. For example, when Command Procedures is selected from the Object tree as
shown in Figure 16.3.
249
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 16.3: Object Navigator. The status bar shows that the Command Procedures from number
one to number 491 or all objects are shown in the list.
Accessible applications
When the Object Navigator is entered, the application and object type tree shows the
accessible applications and object types available for the current application. The symbols
for the accessible applications are:
Local application. Green symbol for HOT state and cyan symbol for WARM
state applications.
External application. Only HOT state applications, green symbol, are accessible.
250
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 16.4: The status bar and the application symbol show that DEMO application is local
and hot.
External applications
It is possible to handle objects in external applications in the same way as in local
applications, if the mapped applications have MicroSCADA version 8.4.3 or later.
251
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
If there are external applications mapped to the current application, the Show External
Application check box is enabled as shown in Figure 16.5. The mapped external
applications are shown only when the check box is selected.
Figure 16.5: External applications are shown by checking the Show External Applications check
box. The local applications DEMO, WD and the external application DEMO are hot.
Proxy applications
A proxy application is shown as local or external, according to its Hot Application.
252
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 16.6: The application with number 11 is a proxy of DEMO application. It is shown in the
same way as DEMO application.
253
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 16.7: The View menu shows that the representation option at the moment is Table
For table format, the default attributes for Process Objects are LN, IX, UN (Unit Number),
OA (Object Address)/IN (Item Name or Source), OB (Object Bit Address)/EH (Event
Handling), OI (Object Identifier) and OX (Object Text). The values of OA and OB are
encoded depending on object type, but in the list, they are displayed in decimal format.
For this reason, they are shown between brackets ([OA]). If all address attributes UN,
OA and OB have their initial values as (UN = 0, AO = 0 and OB = 16), the attributes
are shown as empty fields.The value of the textual attribute IN instead of OA is shown
for objects that use names for signals instead of numeric addresses (objects of type
OPC/Binary Input, OPC/Binary Output, ... , OPC/Bit Stream and OPC Event).The value
of the textual attribute EH instead of OB is shown for OPC Event objects.
The default attributes for Event Handling Objects are LN and HT (Event Handling Type).
The default attributes for Scale Objects are LN and SA (Scaling Algorithm).
The default attributes for Data Objects are LN, TC (Time Channel) and IN (Instruction).
The default attributes for Command Procedures are LN and TC.
The default attributes for Time Channels are LN, CY (Cycle), SU (Synchronization Unit)
and SY (Synchronization Time). Execution part (index 2) of scheduling attributes CY,
SU and SY is shown.
The default attributes for Event Channels are LN, OT (Object Type) and
ON (Object Name).
The default attributes for Logging Profile Objects are LN and PT (Logging Profile Type).
The default attribute for Free Type Process Objects is LN.
The default attributes for Free Type Objects are LN, PT (Process Object Type),
OV (OV Attribute Name) and NA (Number of Attributes).
If a column header is double-clicked in the table, the shown page of the table becomes
sorted by the values of that column. If the values of the column can be of any type (cf.
OV process object attribute), the values are sorted as they were of text type.
254
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
LN is the only obligatory attribute for all objects in the table. Furthermoe, the IX attribute
is obligatory for process objects. An attribute can be selected from the User Defined
drop-down list (see Figure 16.8). The list includes all the attributes available for the
object type, except for attributes of vector and list type. A user-defined attribute is inserted
in the table by clicking the button with plus sign. The button with minus sign removes
a user-defined attribute from the table. The button removes the last attribute, if no attribute
is selected. Note that addressing attributes are selected or removed in one go with ADDR
item in the drop-down list. The table can have up to ten attributes.
Figure 16.8: Additional attributes can be selected from the User-Defined drop-down list, if the
attributes are shown in table format.
Page length
It is possible to change the page length for the table view by selecting
Object Table Page Length from the Options menu. The Table Page Length dialog
opens and the number of objects can be selected. See Figure 16.9.
Figure 16.9: Page length can be defined for application object attributes, if table format is
selected.
255
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Refresh functionality
This functionality is needed for updating the view of dynamic attributes when the objects
are presented in list format. Refresh function can be carried out by selecting Show >
Refresh from the menu bar or pressing the F5 key on the keyboard. Cyclic refresh can
be set on/off by toggling Show > Cyclic Refresh from the menu bar. Cyclic refresh runs
only if the number of objects in the list is 100 or less.
Filtering names
To restrict the listed object names, enter a Filter. Use * in the filter to denote one or more
characters and % to denote one character in the name. For example, POT* lists objects
beginning with a string "POT" and "*" lists all objects, %P* lists all objects, which have
P as the second character. All object names that match the filter are listed in the object
name list. Name filtering is available for process objects, when the option
Process Objects by Groups is selected. It is also available for process displays, pictures,
VSO-files, representations and measurement reports.
Filtering objects
When viewing objects, an empty filter is used by default. The filters are stored into a
parameter file when the Object Navigator is closed, and restored when the tool is opened
next time. The last 20 filters can be selected from the drop-down list. A filter can be
activated by selecting it from the list. Each application object type has a drop-down list
of its own. In Figure 16.10 the Process Objects are viewed in a table form.
Figure 16.10: Process Objects are viewed in a table form. In this figure there is no filter activated.
Defining a Filter
256
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
A new filter can be defined, if Options > Set Filter... is selected from the menu bar.
This command opens a Filter dialog. See Figure 16.11. The Filter dialog can also be
opened from the drop-down list on the right-hand side of the Filter field.
Figure 16.11: Filter dialog for defining and editing filters. There are two conditions specified in
this dialog: LN == A_* AND IX >= 10. The quotation marks are automatically added, if the
attribute type is text.
Only the value should be typed into a value field. If a quotation mark is needed, it is
automatically added to the filter.
If there is no filter selected in Object Navigator when the Filter dialog is opened, only
the first drop-down list is enabled. It is possible to choose any attribute from the Attribute
drop-down list. After the attribute is selected, the next drop-down list becomes enabled.
From this list, it is possible to choose the comparison signs < (smaller than), <= (smaller
than or equal to), == (equal to), >= (bigger than or equal to), > (bigger than) or <>
(unequal). In the text box, it is possible to type any text. AND or OR has to be chosen
from the last drop-down list to be able to enter the next filter condition.
After filling the dialog, the new filter is appended to the drop-down list in the Object
Navigator when OK or Apply is clicked if no SCIL errors were found. If the number of
items reaches 20, the last item in the drop-down list is erased.
A validation check is done when OK or Apply is clicked, or if OR or AND function is
chosen. The following message is shown if, for example, text is entered in the first filter
condition as an attribute value that should be of integer type.
257
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 16.12: Filter Status info dialog tells that the given attribute value is invalid
OK button updates the contents of process object list in Object Navigator and closes the
Filter dialog. Apply button refreshes the contents of process object list in Object
Navigator, according to defined filter. Clear button clears all fields and combo boxes
and Cancel button closes the dialog without any changes to the Object Navigator.
It is also possible to type the filter condition directly in the Filter field. Another check
is performed when OK or Apply is clicked. If there is any SCIL error in the Filter field,
an error message is shown.
Figure 16.13: This error message is caused by a missing attribute name in the filter field
258
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 16.14: Several objects have been selected from the table and right mouse button has been
clicked. To edit the attributes, select Edit from the pop-up menu.
The Edit dialog opens. It contains the values of the object that is the first one in the
selection.
259
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 16.15: Edit dialog contains the values of the attribute that was selected first.
The text fields for OA and OB are disabled if more than one object is selected from the
object table. These fields are also disabled if the attributes of the selected object type are
not editable.
The Clear Addresses button makes it possible to set the address attributes UN, OA and
OB or IN to their initial values (UN = 0, OA = 0, OB = 16, IN = "") at once.
Clicking the OI Editor button starts the Object Identifier editor. The editor makes it
easier to handle a structured Object Identifier attribute. For more information about the
editor, see Section 17.6 Object Identifier editor.
The OK and Apply buttons become enabled after something has been modified. Clicking
Apply will update the selected object(s) both in the database and in the table. Clicking
OK will do the same as Apply and close the Edit dialog.
Error messages are displayed if something goes wrong during the save operation.
260
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
of Process Objects of predefined type, the list shows the names of the process object
groups. The object names are listed in alphabetical order.
2. Double-click the name of the object and possibly the index (if the object is a process
object of a predefined type), click and choose Properties from the Object menu,
or click the Object Properties button in the toolbar.
The object definition tool of the selected object appears and can be edited. Refer to the
following chapters to learn how to use the object definition tools (see also Chapter 14
Free type objects).
16.2 Navigation
Overview
There are six navigation schemes aveilable in the application tree:
• Unit
• Unit and Item Name
• Node and Item Name
• Object Identifier
• OPC Name
• Event Source
The first two schemes and the three last ones are introduced for process objects and free
type process objects. The third scheme is introduced for process objects. The fifth scheme
is also introduced for data objects and command procedures.
Navigation By Unit
The first categorization, By Unit, is introduced for process objects and free type process
objects. In this navigation scheme, the different Unit Number (UN) attribute values found
from the selected application become presented. When a Unit Number is selected, all
the process objects containing the selected Unit Number value become viewed by Groups
or in Table. Unit numbers are sorted in ascending order according to Unit Number
attribute value.
If an empty Unit Number value is located, then those process objects become presented
under the category <No Address>.
261
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
262
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
263
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
264
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
265
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
266
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
267
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
6. Choose New from the Object menu and input an index in the dialog that appears.
Give the index that does not exist under the selected group.
7. Define the process object type and the station type in the dialog that appears (see
Figure 16.22). It is possible to change the focus between the two list boxes, possible
check boxes and the command buttons with the TAB key. For Analog Input and
Analog Output object types, there is a possibility to choose the object representation
to be real or 32-bit integer. Default data type is real and the 32-bit integer
representation can be chosen by selecting a check box shown in Figure 16.23. Also,
when creating Analog Input and Binary Input DNP, RTU 200 and RTU 200 (EDU)
base objects, an option for automatic creation of secondary object is given, see
Figure 16.23. The automatic creation of the secondary object is done during the
creation of the base object.
The given index will be the IX attribute of the object and the selected object type will
be the PT attribute. The 32-bit integer representation for the Analog Input and Output
types will be the IR attribute.
The object has been created with the default values given in Chapters 4 .. 12. For some
object types, obligatory attributes are assigned values.
Figure 16.22: The dialog, box where you can choose the object type (PT attribute) of a new
process object. Here a binary object will be created.
268
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 16.23: For the Analog Input and Output object types, there is a check box for selecting a
32-bit integer representation. Also for some Analog and Binary Input objects there is check box
for automatic creation of secondary object.
Figure 16.24: The given or selected value is 100.The station 100 should be of type OAE (OPC
Alarms & Events).
269
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
To create a new AEC event handling object to define the event handling of the OPC
Event (OE) type process objects:
1. Act as described in Creating new application objects, on page 267 and select the
AEC event handling type in New dialog.
2. Give the node number (ND attribute) or click the button with three dots and select
the number in the dialog that opens.
3. Give the event category ID (CI attribute), select the event type (ET attribute) from
the drop-down list of options and select the condition (CN attribute) from the
drop-down list of options, if the event type is CONDITION or click the button with
three dots to load the OPC A&E server event space and select the values of the
attributes at once in the dialog that opens.
4. Click OK. See Figure 16.26.
270
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 16.27: The selected value type is REAL. In this case, it is not possible to give the VL
attribute value.
4. Click OK.
271
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
4. Click OK.
272
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
For process object groups, the group indices have to be defined separately by
double-clicking on the index that is to be defined.
273
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
4. Type the name of the object in the white text box of the dialog that appears. Click
OK.
Figure 16.30: The Created Objects dialog informs that one Event Handling and one Scale Object
were created in the application
The copying of objects from a local application to an external application and vice versa
is done in the same way as copying between two local applications.
274
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Copied objects are temporarily located at the beginning of the current page. They will
be located at correct positions when the object tree is rebuilt.
To copy application objects within an application:
1. Click the object type under the name of the application where objects should be
copied.
2. Select an object for copying by clicking the name of the object. Several objects can
be selected by holding the CTRL key down while clicking the objects or pressing
the mouse button down and dragging the pointer over the objects.
3. Choose Copy from the Edit menu.
4. Choose Paste from the Edit menu.
In both cases, the user is reminded of a duplication of object names with the following
dialog. The dialog contains six buttons:
Retry Retries to paste, use if fields have been edited.
Retry to All Retries to paste the current and all subsequent process objects to the
same group. Use if the name field has been edited.
Overwrite Overwrites existing object.
Overwrite to All Overwrites the existing object and all subsequent matching objects,
if overwrite to all is confirmed by the overwrite prompt (refers to de-
leting application objects).
Skip Continues to paste but skips the currently matching object.
Stop Stops pasting, pasted objects are not cancelled.
275
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
1. Select application.
2. Select process object group.
3. Select an index or several indices.
4. Click Copy on the Edit menu.
5. Select target application.
6. Select target in one of the following manners:
Case 1 Select a process object group whereas the indexes are pasted under
that group
Case 2 No group is selected, the indices are pasted under the object group
name stored at copy
Case 3 If several object groups are selected, indices are pasted under the
first group in the selection.
7. Click Paste on the Edit menu.
If Address Overlap error occurs when pasting the process object index, the dialog in
Figure 16.32 is shown.
The user may fill in a new unit number, a new object address or check the "Remove
automatically all overlapping addresses." check box. If the check box is selected, all the
overlapping addresses of objects that remain to be pasted are cleared after a retry or skip.
The addresses that were cleared during pasting are shown in a dialog alongside the
corresponding indexes, see Figure 16.37. Changing the unit number is useful when
copying a whole process object group to another station where the object addresses
should be the same. The Retry to All button is enabled when the unit number is changed.
This button makes it possible to change the unit number of the selected process objects
at once.
If Address Overlap error occurs when pasting the process object index that uses names
as addresses, the dialog in Figure 16.33 is shown.
276
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
If the address conflict occurs when pasting the OPC Event process object index, the
dialog in Figure 16.34 is shown.
If the value of OPC Item Name (ON) attribute conflicts with another object, the dialog
in Figure 16.35 is shown. If the check box is checked, all conflicting ON attribute values
of objects that remain to be pasted are cleared after a retry or skip.
277
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
If the values of OPC Event Source (ES) and Event Handling (EH) attributes conflict
with another object, the dialog in Figure 16.36 is shown.If the check box is checked, all
conflicting ES and EH attribute values of objects that remain to be pasted are cleared
after a retry or skip.
278
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 16.37: Dialog presenting the addresses that were cleared during operation, alongside
the corresponding indexes.Values of ES, EH and ON attributes were cleared too.
279
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
280
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Moving objects
To move an application object:
1. Choose the application from where to move the object type and the object. Several
objects can also be moved by selecting them at the same time with the help of the
CTRL key.
2. Choose Cut from the Edit menu.
3. Choose another application where the object or the objects should be inserted.
4. Choose Paste from the Edit menu.
281
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
3. Choose Delete from the Edit menu. The delete prompt appears.
4. Click OK to delete or Cancel to cancel the deletion.
If copied application objects are going to be deleted, the dialog box shown in appears.
In the dialog box, the user has to confirm whether the delete operation is continued or
not. In this case, continuing the operation will cause the copied application object to
disappear also from the Clipboard.
Figure 16.40: The dialog box, that appears when a copied application object is being deleted.
282
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
File transfer
File transfer is implemented via process database. It is possible to create File Transfer
LAG 1.4 Process Objects in the same way as other Process Objects.
Figure 16.41: File transfer objects are created in the same way as other Process Objects
It is not possible to set the address for File Transfer LAG 1.4, only the station UN can
be modified. There is a separate page for File Transfer objects under the Dynamic tab.
See Figure 16.42.
The following functions are supported in current release:
• Receiving (uploading) a file from a station
• Sending (downloading) a file to a station
• Browsing the file hierarchy of a station
• Reading file attributes from a station
• Deleting a file or directory in a station
283
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 16.42: There is an own page for File Transfer objects under the Dynamic tab
The process objects of this type have all the same common attributes as other process
objects. Especially, the post-processing attributes, such as EE, AE etc., may be used to
report the completion of the transfer to the application.
The address attributes OA and OB have no meaning in conjunction with FT objects. OA
should be set to zero (if set at all).
There may be any number of FT objects connected to one station, e.g. each configured
to a specific download/upload.
284
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Pages
Most of the object definition tools are composed of pages, which can be accessed by
clicking the tabs. In some cases, the tool contains so many pages that not all of them can
be shown on screen at the same time. In these cases, make the tabs visible by moving to
the left and right with the arrow keys.
Figure 16.43 shows an example of an object definition tool, the data object definition
tool. It has five visible tabs.
User interaction
The user interface of the object definition tools follows Windows standard interface.
Options that cannot be applied to the object in quesiton, for example because of some
previous selection, are made unavailable. In Figure 16.43, the Source and Pulse Scale
texts are disabled, which indicates that these features cannot be changed.
Text boxes that provide a drop-down list of options are equipped with a down arrow.
Make a choice by clicking the arrow and then selecting an option on the list, or by clicking
the arrow and holding the mouse button down while dragging the cursor to the desired
option and releasing the button). In Figure 16.43 the Logging function has a drop-down
list of options. A button with three dots opens a selector dialog where a choice can be
made by clicking in a selection list. In Figure 16.43, the button is besides the Source text
box.
Check boxes are used when an attribute or feature can be either active or inactive. A
cross in the box means that the attribute or feature is selected. Change the selection by
clicking the check box.
The attributes are described in brief in the tool descriptions in the next chapters. For a
detailed description of the attributes, refer to the corresponding descriptions in Chapters
4 .. 12.
285
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
286
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
the other hand, SYS600 base system allows several process object indexes to be connected
to one event handling object, scale and event channel, and several data objects and
command procedures to be connected to one time channel. To ease engineering work,
a way to connect several objects to a single object in one go has been implemented in
Object Navigator.
As an example, process object indexes 1, 2 and 3 in EXAMPLE group in DEMO
application will be connected to EXAMPLE event channel:
1. Open Event Channel tool.
2. Click theConnected objects page. If the page is empty, only Add button is enabled.
3. Click the Add button. Empty Selected Objects page appears.
4. Click Select... button. Object Selector that shows process objects in DEMO
application will be opened. Select indexes 1, 2 and 3 in EXAMPLE group, see
Figure 16.44. The process object definition tool is also available in Object Selector.
However, the tool is in read-only mode, because the OK and Apply buttons are
dimmed.
5. Click the OK button in Object Selector. Object Selector will be closed and Event
Channel tool shows selected indexes as highlighted on Selected Objects page, see
Figure 16.45. To cancel the selection, click the Cancel button in the Object Selector
or the Event Channel tool.
6. Click the Connect button. Information dialog appears. The connect operation is
immediate, if the Yes button is clicked. It means that the AN attribute of the process
object indexes will be set to EXAMPLE immediately, not after the OK or Apply
button in the tool is clicked. The dialog also shows that the connect operation can
be undone. Information dialog appears only if more than one object will be connected,
see Figure 16.46.
7. Click the Yes button. The information dialog will be closed and Connected objects
page pops up showing connected indexes. In addition to Add button, Undo button
is enabled, see Figure 16.47.
8. To cancel the operation, click the Undo button and select Undo Connect from
pop-up menu.
287
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
288
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
289
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
290
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 16.48: Two indexes on Connected Objects page have been selected to be disconnected
from EXAMPLE event channel.
291
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 16.49: An example of self-diagnostics. The description field describes the problem on the
highlighted line and the action field gives advises to solve the problem.
292
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
For a detailed description of the attributes mentioned in this chapter, refer to Chapter 5
Process objects.
17.1 General
The tool for defining process objects of predefined types is accessed from the Object
Navigator by double-clicking a process object. Process objects are created in the Object
Navigator (for the procedure, see Section 16.3 Creating and editing objects). The Process
Object Definition Tool can also be accessed from the Event Channel Definition Tool
and the Event Handling Definition Tool.
The Process Object Definition Tool contains a common area and three main tabs:
• Configurable. Below this tab there are a number of sub-tabs each of which represent
a page with configurable attributes.
• Dynamic. This tab presents several pages that show the values of the dynamic
attributes at the moment the tool is opened. The content of the tool can also be
updated.
• All attributes. This page lists all attributes of a process object type in alphabetical
order.
The page All attributes has no sub-pages. The other two pages, Dynamic Attributes
and Configurable Attributes, have sub-pages, which vary depending on the process
signal type. The names of the sub-pages, as well as their contents, differ.
General
The common area above and below the pages, see Figure 17.1, contains basic definitions
that are common to all object types.
293
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 17.1: The Process Object Definition Tool. This picture shows the part of the tool that is common for all process objects.
It also shows notebook pages, which differ according to the process signal type.
Identification
This section of the tool specifies the identification attributes of the objects, see
Section 5.2.2 Identification attributes.
The Object Identifier (OI) attribute value contains the structural information, i.e. certain
character positions of OI value contain e.g. Substation, Bay or Device identification. To
handle this structural nature of the attribute a dedicated Object Identifier editor is
introduced, see Section 17.6 Object Identifier editor. The editor may be started by clicking
294
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
the button with three dots on the right side of the Object Identifier text box, see
Figure 17.1.
Operation state
Take the object into use and out of use with the In Use check box. The selection is applied
to the process object when OK or Apply is clicked. The selection specifies the IU
attribute. The Switch State is the SS attribute (see Section 5.2.4 Operational state).
This section presents information about the type of station, which reads or controls the
object, and the object type as it is defined in the station. This is not an attribute.
The structure of the tool depends on the signal type, as mentioned earlier. However,
process objects that have not been created by Object Navigator or an application library
(LIB 5xx or Power Process Library) may have no knowledge about the signal type. It is
possible in this kind of situation to fix the signal type by selecting a type from the
drop-down list (see Figure 17.2). The tool structure will immediately be changed. When
the selection has been confirmed by clicking the Apply or OK button, the signal type is
permanent and cannot be changed by the tool.
295
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Other information
The Modification Time text box below the pages shows the time when the object was
last modified, regardless of weather it was modified in the tool or with SCIL commands
(CREATE, MODIFY).
The Next and Previous Process Object Index (IX) and Group (LN) command buttons
below the pages make it easier to move from one Process Object Index or Group to
another. When any of the four command buttons is active, there is one or more object(s)
or index(es) in the respective direction of the button.
Values shown in the tool are the values at the moment the tool was opened. To update
the values of the tool, click the Fetch button.
Overview
The configurable attributes are grouped into the following sub-pages, which may be
shown or hidden depending on the object type:
• Adresses
• Scaling (analog objects and pulse counters)
• Limit values (analog objects)
• Alarms
• Events
• History
• Printouts
• Blocking
• Topology
• Miscellaneous
Addresses
In the Adresses page (see Figure 17.3) the addressing attributes are defined (see
Section 5.2.3 Addresses). The appearance of the page varies according to the object type.
The appearance also depends on the encoding of the addresses of the unit (attributes OA
and OB).
296
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 17.3: Example of the attributes that are defined in the Addresses page.
Figure 17.4: Example of the attributes that are defined in the Addresses page of OPC Event object.
Scaling
The Scaling page is shown only for analog objects and pulse counters (see Figure 17.5).
See Section 5.2.5 Scaling for the attributes.
297
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Limit values
The Limit values page (see Figure 17.6) for limiting value supervision is present when
defining an analog object. See Section 5.2.7 Limit value supervision for the attributes.
The pages for analog input objects are different from the pages for analog output objects.
Figure 17.6: The Limit Values page for a process object of type analog input.
Alarms
There are three different Alarms pages for defining alarms:
298
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
299
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 17.9: The Alarms page of objects, which are not of type binary input or double binary indication.
Post-processing
The Post-processing page (see Figure 17.10) is shown for all object types. See
Section 5.2.8 Post-processing for the attributes.
Events
The Events page (see Figure 17.11) is shown for all object types. See Section 5.2.9 Event
handling for the attributes.
300
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
History
The History page (see Figure 17.12) is shown for all object types. See Section 5.2.10
Logging of event history and Section 5.2.11 Historian logging for the attributes.
301
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Printouts
The Printouts page (see Figure 17.13) is shown for all object types. See Section 5.2.13
Printout handling for the attributes.
302
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Blocking
The Blocking page (see Figure 17.14) is shown for all objects type. See Section 5.3.4
Blocking attributes for the attributes.
Topology
The Topology page (see Figure 17.15) shows attributes of topology objects. See
Section 5.2.14 Network topology for attributes.
303
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Miscellaneous
The Miscellaneous page (see Figure 17.16) is shown for all object types. See
Section 5.2.15 Miscellaneous attributes for the attributes.
Object state
The Object State page is shown for all object types except for file transfer objects. See
Section 5.3.1 Object value for the attributes.
There are four different Object State pages:
• Binary input and double binary indication page: See Figure 17.17
• Page for output objects: See Figure 17.18
• Topology page: See Figure 17.19
• Page for other objects: See Figure 17.20
304
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
305
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
306
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
307
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
File transfer
The File Transfer page is visible only for the file transfer objects. See Section 5.3.11
File transfer attributes for the attributes.
Value history
The Value History attributes are analog input (AI) specific. See Section 5.3.6 Minimum
and maximum values for the attributes.
308
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
OPC event
The OPC Event page (see Figure 17.23) is shown for OPC Event (OE) objects. See
Section 5.3.10 OPC Event objects for the attributes.
309
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Alarm
The Alarm page (see Figure 17.24) shows the present alarm state of the object. See
Section 5.3.3 Alarm and warning states for the attributes.
310
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Counters
The Counters page (see Figure 17.25) shows the values of the operational counters. See
Section 5.3.5 Operation counter attributes for the attributes.
311
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
attribute of Analog Input object when the value of AI attribute is represented as an integer
(IR = 1).
312
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
313
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
General
The Object Navigator has access to the tool for defining event handling by double-clicking
an event handling object. A new object is created in the Object Navigator. The procedure
is described in Section 16.3 Creating and editing objects.
The tool has the common area and five pages for the event handling of type SYS:
State Texts, Message Texts, OPC A&E Server, Connected objects and All Attributes.
The tool has six pages for the event handling of type AEC: The additional page is
Event Messages for the object of SIMPLE event type and Subcondition Names for the
object of CONDITION event type. The page Connected objects lists all process objects
(if any) connected to the current event handling object. Selecting a row on the list and
clicking the Show button or simply double clicking on a row can show the definition of
a process object. The page All Attributes contains all attributes of the event handling
object in alphabetical order.
315
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
316
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 18.2: The Event Handling Definition Tool for the event handling of type AEC.
Overview
Pages State Texts and Message Texts show state texts (ST) and message texts (MT)
and their translation texts SX and MX.
State texts
The State Texts page is shown in Figure 18.1. See Section 6.2 Common event handling
object attributes for the attributes.
Message texts
The Message Texts page is shown in Figure 18.3. See Section 6.2 Common event handling
object attributes for the attributes.
317
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Overview
Pages Event Messages and Subcondition Names show event messages (EM) and
subcondition names (SN).
Event messages
The Event Messages page is shown in Figure 18.2. See Section 6.4 OPC Alarms &
Events client attributes for the attribute.
Subcondition names
The Subcondition Names page is shown in Figure 18.4. See Section 6.4 OPC Alarms
& Events client attributes for the attribute.
318
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Overview
The page OPC A&E Server shows OPC Alarms & Events server attributes. See
Section 6.3 OPC Alarms & Events server attributes for the attributes.
319
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
320
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
321
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
General
The Object Navigator has access to the definition tool for defining scales by
double-clicking a scale object. A new object is created in the Object Navigator. The
procedure is described in Section 16.3 Creating and editing objects. The tool is also
obtained from the Process Object Definition Tool by selecting to view the scale of a
process object.
The definition tool contains a common area and two or three pages. The alternative pages
are Connected objects, All Attributes, Linear Scaling and . The Scaling Algorithm
determines which pages are shown. See Figure 19.1. The page Connected objects lists
all process objects (if any) connected to the current scale. The definition of a process
object can be shown by selecting a row on the list and pressing Show - button or simply
double-clicking on a row.The page All Attributes contains all attributes in alphabetical
order.
Figure 19.1: The tool for defining scales. The scaling algorithm one-to-one scaling is selected.
323
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Common area
The common area above and below the pages contains Scaling Algorithm (SA) and
Modification Time (ZT) attributes (see Figure 19.1). See Section 7.2 Scale attributes for
the attributes.
Linear scaling
Figure 19.2 shows the Linear Scaling page of the Scale definition tool.
324
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 19.3: The Stepwise linear page of the scale definition tool.
The page shows 50 pairs of text boxes, each of which correspond to a coordinate on the
scaling algorithm curve, Section 7.2 Scale attributes.
The Insert button allows the user to enter scaling points in-between two points. The
Delete button deletes the selected point. The insertion and deletion place is determined
by clicking one of the text boxes in the correct row. Inserting moves the selected row
and all rows below it one row downwards. Deleting removes the selected row and moves
all the rows below it one row upwards.
325
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Overview
Access the Data Object Definition Toolfrom the Object Navigator by double-clicking a
data object. A new object is created in the Object Navigator. The procedure is described
in Section 16.3 Creating and editing objects. The tool is also accessed from the definition
tools for time channel and event channel.
The Data Object Definition Tool, see Figure 20.1, is composed of a common area and
six pages. The pages contain the following definitions and information:
• The Data Registration page defines the calculation of the object.
• The Data page lists the registered data and provides means for editing the object
value, the status code and registration time of certain indices.
• The Execution Control page defines the automatic time activation of the data object
and the executing tasks.
• The Storage page defines the file where the object is saved. It also defines things
concerning the registration and storage of data.
• The External Logging page specifies the logging profile object to be used when
logging values to the SYS600 Historian database(s). It also tells the names of
Historian database tags that receive data from this data object.
• The All Attributes page lists all attributes with their values in alphabetical order.
To define a new data object or edit an existing one, double-click the object name in the
Object Navigator and modify the desired attribute values on the data object form. All
attributes can be checked in the All Attributes page, and view registered data in the Data
page.
327
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 20.1: The Data Object Definition Tool includes six pages. In the first one, Data
Registration, you can define the calculation of the object.
Common area
The tool has a common area above and below the pages (see Figure 20.1). See
Section 8.2.1 Basic attributes for the attributes.
Data registration
The Data Registration page specifies the calculations to be performed at data object
execution. The list of SR (Source) shows only Data Objects of the same type (VT).
The Selector dialog can be opened by clicking the button. See Figure 20.1. This
button is enabled only when the Copy Data from Another Data Object checkbox is
marked.
328
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 20.2: Copy Data from Another Data Object check box is checked to enable logging function
COPY
Data
The second page of the Data Object Definition Tool is shown in Figure 20.3. This page
shows the dynamic values of the data objects value (OV), status (OS) and registration
time (RT). See Section 8.2.6 Registered data for the attributes.
In the area showing the registered values, the indices are shown to the left. Browse
through the indices using the scroll bars. Above the registered values is the internal object
value (stored value) with status codes and registration time.
The tool reads the values from the report database. The shown values can be updated by
clicking the Fetch button in the Data page. There are also possibilities for listing the
registered values. The listing order and the listed indices can be defined using the controls
to the right from the Registered Values list. Double arrow buttons can be used to browse
registered values. The dynamic attributes in the tool can be changed.
329
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 20.3: The second page of the Data Object Definition Tool contains dynamic data of the
Data Objects. You can view or change the data.
330
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 20.4: Using this dialog you can change the values of OV, OS and RT attributes.
Execution control
Figure 20.5 shows the Execution Control page of the Data Object Definition Tool. In
this page, the time activation and the executing tasks can be specified. See Section 8.2.4
Execution control for the attributes.
Figure 20.5: The Execution Control page of the Data Object Definition Tool
Storage
Figure 20.6 shows the Storage page of the Data Object Definition Tool. See Section 8.2.5
Storage for the attributes.
331
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 20.6: The storage page of the Data Object Definition Tool
External logging
Figure 20.7 shows the External Logging page of the Data Object Definition Tool. See
Section 8.2.5 Storage for the attributes.
Figure 20.7: The external logging page of the Data Object Definition Tool
All attributes
The page named All Attributes is shown in Figure 20.8. The page lists all attributes in
alphabetical order. The attribute values in white text boxes can be edited. The attribute
values with grey background cannot be edited.
332
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 20.8: The All Attributes page of the Data Object Definition Tool
333
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
This chapter describes how to define command procedures using the definition tools.
Overview
The definition tool for command procedures is accessed from the Object Navigator by
double-clicking a command procedure. A new object is created in the Object Navigator.
The procedure is described in Section 16.3 Creating and editing objects. It can also be
accessed from time channel and event channel tools.
The Command Procedure Definition Tool comprises a common area and four pages.
The pages contain the following definitions and information:
• The Procedure page contains the program of the command procedure.
• The page Execution Control defines the automatic time activation of the command
procedure and the executing tasks.
• The Storage page defines the file where the object is saved and the origin of the
time stamp.
• The All Attributes page finally lists all attributes in alphabetical order.
Common area
The tool has a common area above and below the pages (see Figure 21.1). See
Section 9.2.1 Basic attributes for the attributes.
Procedure page
Figure 21.1 shows the Procedure page of the Command Procedure Definition Tool. The
Instruction (IN): list contains the program.
To type a new program or edit an existing one:
1. Click the Edit button or double-click the Instruction (IN): list.
2. The SCIL editor appears as a separate dialog. The general functions of the SCIL
Editor are described in the Programming Language SCIL manual. It is also possible
to import and export text from the SCIL Program Editor. To import, choose Import
and to export, choose Export from the File menu. The import function opens a file
chooser, where the name of the file to be imported is specified. The contents of the
file is loaded in the SCIL Program Editor when OK or Apply is clicked. It is placed
starting from the row where the cursor is, if the row is empty. It there is text in the
row, the contents is placed starting from the next row. The Export function also
opens a file chooser where the name of the file is specified. If no text is selected,
everything in the SCIL Program Editor is transferred into the specified file. Note
335
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
that if an existing file is specified, export overwrites the previous contents of the
file.
Compile IN when Edited If check box is checked, the compilation is done al-
ways when user clicks Apply or OK button. A suc-
cessful compilation updates the IN and CP-attributes.
336
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 21.1: The Procedure page of the Command Procedure Definition Tool
337
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 21.2: The Execution Control page of the Command Procedure Definition Tool
Storage page
Figure 21.3 shows the Storage page of the definition tool. See Section 9.2.5 Storage
attributes for the attributes.
Figure 21.3: The Storage page of the Command Procedure Definition Tool
338
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
All attributes
Figure 21.4 shows the page All Attributes. This page lists all command procedure
attributes in alphabetical order.The attribute values in white text boxes can be edited,
whereas attribute values with grey background cannot be edited.
Figure 21.4: All Attributes page of the Command Procedure Definition Tool
339
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Overview
The definition tool for time channels is accessed from the Object Navigator by
double-clicking a time channel. A new object is created in the Object Navigator. The
procedure is described in Section 16.3 Creating and editing objects. It can also be accessed
from data object and command procedure tools.
The Time Channel Definition Tool, see Figure 22.1, comprises a common area and five
pages containing the following definitions and information:
• The Execution page specifies the Execution of the time channel.
• The Initialization page specifies the Initialization of the time channel.
• The Execution Control page defines the execution policies and the executing tasks.
• The Connected objects page shows the objects connected to the time channel.
• The All Attributes page finally lists all attributes in alphabetical order.
Common area
The tool has a common area above and below the pages (see Figure 22.1). See Section 10.1
General for the attributes.
Execution
The Execution page specifies the execution time of the time channel. See Section 10.1
General for an explanation of the execution of time channels and Section 10.2.2
Scheduling for the attributes.
341
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 22.1: The Execution page of the Time Channel Definition Tool
Initialization
Figure 22.2 shows the Initialization page. This page specifies the initialization times of
the time channel. See Section 10.1 General for an explanation of what initialization
means and Section 10.2.2 Scheduling for the attributes.
Execution cycle The time interval for periodically recurrent executions if such
is desired. The fields can be left empty. The CY attribute,
index 2.
342
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
The time settings farthest down on the page show the latest initialization and
synchronization times.
Figure 22.2: The Initialization page of the Time Channel Definition Tool
343
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Execution control
Figure 22.3 shows the Execution Control page. See Section 10.2.2 Scheduling and
Section 10.3 Defining time channels with SCIL for the attributes.
Figure 22.3: The Execution Control page of the Time Channel Definition Tool
Connected objects
The Connected objects page provides an overview of all data objects and command
procedures connected to the time channel (see Figure 22.4). Only the first 10 000 objects
are shown in the list. If there are more than 10 000 connections, the user is informed.
344
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Each row in the list contains the name of an object, the priority within the time channel
and the object type. The page is of informative character and the list of connected objects
cannot be edited here. However, the object definitions are accessed from the list. Objects
are added to the list when they are defined in their respective tools to be activated by the
time channel in question, or by clicking Add button on the page. See Section 16.4 General
principles for using object definition tools for how to connect several objects in one go.
To view or edit any of the objects in the list, click the object and then Show... button.
The definition of the selected object appears in a new window.
Figure 22.4: The Connected Objects page of the Time Channel Definition Tool
345
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
All attributes
The All Attributes page (see Figure 22.5) lists all time channel attributes in alphabetical
order. All attributes, except read-only attributes, can be changed. The data fields of the
read-only attributes are grey.
Figure 22.5: The All Attributes page of the Time Channel Definition Tool
346
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Overview
The definition tool for defining event channels is accessed from the Object Navigator
by double-clicking an event channel. A new object is created in the Object Navigator.
The procedure is described in Section 16.3 Creating and editing objects. The tool is also
obtained from the Process Object Definition Tool by selecting to view the event channel
of a process object.
The Event Channel Definition Tool, see Figure 23.1, comprises a common area and three
pages containing the following definitions and information:
• The page Activated Objects specifies the primary and secondary objects activated
by the event channel.
• The page Connected objects shows the process object indexes connected to the event
channel.
• The page All Attributes lists all attributes in alphabetical order.
Common area
The tool has a common area above and below the pages (see Figure 23.1). See Section 11.2
Event channel attributes for the attributes.
Activated objects
Figure 23.1 shows the Activated Objects page. This page specifies the data objects and
command procedures activated by the event channel.
347
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
To view the object definitions of the activated objects, click the object name in the list
and then click the Show... button.
To add a new secondary object, click the New button.
To edit an object name or type in the list, click the object name and the Set button.
To remove a secondary object from the list, click the object name and Remove....
Connected objects
The Connected objects page (see Figure 23.2) lists all process objects that activate the
event channel.
348
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
The connection of process objects to the event channel is done in the process object
definition or by clicking Add button. See Section 16.4 General principles for using object
definition tools how to connect several objects in one go. To view or edit the process
object definitions, click the object in the list and then click the Show... button. The
Show... button opens the Process Object Definition Tool where the selected objects can
be edited as described in Chapter 17 Process Object Definition Tool.
Attribute list
This page (see Figure 23.3) lists all event channel attributes in alphabetical order. The
attribute values in white text boxes can be edited. The attribute values with grey
background cannot be edited.
349
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 23.3: All event channel attributes are listed in alphabetical order
350
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
General
The Object Navigator has access to the tool for defining logging profile objects by
double-clicking a logging profile object. A new object is created in the Object Navigator.
The procedure is described in the Section 16.3 Creating and editing objects.
The tool has the common area and two pages for the logging profile of type OBJECT:
Connected objects and All Attributes. The page Connected objects lists all process
and data objects that are connected to the current OBJECT logging profile. Connecting
and disconnecting objects is described in the Section 16.4 General principles for using
object definition tools.
The tool has the common area and three pages for the logging profile of type
DATABASE: Connected objects, Diagnostic Counters and All Attributes. The page
Connected objects lists all logging profile objects that are connected to the logging
profile. The Diagnostic Counters page shows counters of the Historian database
connection.
The tool has the common area and two pages for the logging profile object of type
HISTORY: Connected objects and All Attributes. The page Connected objects lists
all logging profile objects that are connected to the logging profile.
The page All Attributes contains all attributes that are relevant to the current logging
profile object. The attributes are in alphabetical order.
351
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 24.1: The Definition Tool of the Logging Profile Object of type OBJECT
352
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Figure 24.2: The Definition Tool of the Logging Profile Object of type DATABASE
353
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 24.3: The Definition Tool of the Logging Profile Object of type HISTORY
354
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
General
This chapter introduces the Free Type Object Tool and the Free Type Process Object
Tool. These tools are Application Object handling tools and are launched from the
Application Object Navigator.
The tool for handling application objects, Application Object Navigator, is accessed
through Tool Manager. The Application Object Navigator presents objects classified by
type in a tree where application names form the nodes and object types form the leafs.
The Free Type Object tools are accessed by choosing object type and name of the object
of interest.
355
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 25.1: The Free Type Process Object tool as it appears after double clicking an object
named ´A_SPA_ANSW´ in the Object Navigator and expanding the ´Identification´ node with the
default view ´Standard´.
Fields
Logical Name (LN) Value (text) of the LN-attribute. The logical name of the
process object.
Process Object Type (PT) Value (integer) of the PT-attribute.
Comment Text (CX) Value (text) of the CX-attribute. The value of this attribute
is supposed to serve as a description of the object.
356
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Attribute definition
User attribute names are presented in a listbox. The order in which they are presented is
determined by the elements in the text vector that is the value of the AN attribute. The
357
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
value can be checked using the Examine tab of Test Dialog and entering
OBJ_NAME:FAN in the inspection field.
The properties of a single User Attribute are shown in the right side of the User Attributes
list. The properties displayed belong to the User Attribute currently selected in the User
Attributes list. The values of AN, AI, AT and AL indexes cannot be configured on
existing User Attributes.
Figure 25.2: Attribute Definition tab of the Free Type Object definition tool
New User Attributes are defined by clicking the New Attribute button, see Figure 25.2.
This action adds a + sign to the attribute list, focuses the Name (AN) field and assigns
358
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
default values to the rest of the attribute indices. As the User Attribute name is defined,
the name is shown in the User Attributes list preceded by a + sign. The + sign disappears
as the definition is saved. The attribute indices AN, AI, AT and AL are modifiable until
the User Attribute definition is saved. Removal of User Attributes can be done prior to
saving. Saved User Attributes cannot be removed. After saving the User Attributes, the
attributes appear on the View User Attributes tree of the same type of process object in
the Free Type Process Object Tool, see Section 25.1 Free Type Process Object Tool.
Attribute tree
The Attribute Tree tab is used for grouping, displaying and modifying Free Type Object
attributes. The groups and attributes displayed in the tree are predefined (in file
attrib_f.scl). When an attribute in the tree is selected, an attribute data type specific edit
field is displayed in the edit box.
359
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Figure 25.3: The Attribute Tree tab of Free Type Object definition tool
360
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
Index
361
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Attribute Event (F) .............................................. 237 Changed Attribute (Events) ................................ 122
Attribute History (F) ............................................ 237 CI Event Category ID (H) ................................... 140
Attribute Indexing (F) .......................................... 235 CK OPC Cookie (OE) ......................................... 112
Attribute indices .................................................. 360 CL Counter Limit (BI, BO, DB, OE) ...................... 81
Attribute information ........................................... 357 CM :Comment (A) .............................................. 196
Attribute Length (F) ............................................ 236 CM :Comment (C) .............................................. 171
Attribute name ................................................ 19, 21 CM :Comment (D) .............................................. 157
Attribute Name (F) .............................................. 235 CM :Comment (G) .............................................. 219
Attribute Offset (F) .............................................. 238 CM :Comment (T) ............................................... 182
Attribute on Disk (F) ........................................... 237 CM :OPC Change Mask (OE) ............................. 112
Attribute Printout (F) ........................................... 236 CN :Condition Name (H) .................................... 140
Attribute Snapshot (F) ........................................ 238 CN :Connected Network Objects (NT) ................. 78
Attribute tree ....................................................... 357 CN :OPC Condition Name (OE) ......................... 112
Attribute Tree ...................................................... 359 CO Counter Overflow (BI, BO, DB, OE) ............... 98
Attribute Value Type (F) ...................................... 235 Command Procedure ......................................... 336
Audio alarm .......................................................... 48 Command procedure object ................................. 12
Automatic printout .......................................... 26, 77 command procedures ................................. 335, 341
AX Attribute Comment Text (F) .......................... 238 Command procedures ........................ 169, 335, 341
AZ Alarm Zone (AI) ............................................... 94 Command Qualifier (P) ....................................... 107
Comment :A ........................................................ 196
B Comment :C ....................................................... 171
Comment :D ....................................................... 157
BC Bit Count (PC) ................................................ 45 Comment :G ....................................................... 219
BI .......................................................................... 34 Comment :T ........................................................ 182
BI Binary Input (BI) ............................................... 84 Comment Text .................................................... 356
Binary Input .......................................................... 26 Comment Text :F ................................................ 234
Binary Input (BI) .................................................... 84 Comment Text :H ................................................ 132
Binary Output ........................................................ 26 Comment Text :P .................................................. 35
Binary Output (BO) ............................................... 85 Compilation State (C) ......................................... 173
Bit Count (PC) ...................................................... 45 Compiled Program (C) ....................................... 173
Bit Stream ............................................................. 26 Compile IN when Edited ..................................... 336
Bit Stream (BS) ..................................................... 85 Compression Accuracy (G) ................................ 220
BL Blocked (P) .................................................... 101 Condition ............................................................ 180
Blocked (P) ......................................................... 101 CONDITION ....................................................... 138
BO ........................................................................ 34 CONDITION (Event Type) .................................. 141
BO Binary Output (BO) ......................................... 85 Condition (T) ....................................................... 183
BOTH (OPC Event Generation) ......................... 138 Condition Name (H) ............................................ 140
BS ......................................................................... 34 Configuration Data ............................................. 126
BS Bit Stream (BS) ............................................... 85 Connected Network Objects (NT) ........................ 78
Connectivity Packages ......................................... 18
C Control Status (BO, DO, AO) ............................... 90
COPY (Logging Function) .................................. 160
CA :Changed Attribute (Events) ......................... 122 Counter Enabled (BI, BO, DB, OE) ...................... 80
CA :Compression Accuracy (G) ......................... 220 Counter Limit (BI, BO, DB, OE) ............................ 81
CALENDAR (Cycle Policy) ................................. 184 Counter Overflow (BI, BO, DB, OE) ..................... 98
CALENDAR (Daylight Switch Policy) ................. 185 Counter Value (BI, BO, DB, OE) ........................... 98
Cause of Transmission (P) ................................. 101 CP :Compiled Program (C) ................................ 173
CD ...................................................................... 343 CP :Cycle Policy (T) ........................................... 184
CD :Condition (T) ............................................... 183 CQ OPC Cookie Time (OE) ................................ 113
CD :Configuration Data (Groups) ....................... 126 CREATE ............................................................... 24
CD :Event Category Description (H) .................. 139 Creating objects ................................................... 24
CE Counter Enabled (BI, BO, DB, OE) ................ 80 CS :Compilation State (C) .................................. 173
362
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
CS :Control Status (BO, DO, AO) ........................ 90 DP :Decimal Places (AI, AO) ................................ 45
CT Cause of Transmission (P) ........................... 101 DP Description Pattern P (G) ............................. 223
CV Counter Value (BI, BO, DB, OE) ..................... 98 DX Directive Text (P) ............................................ 81
CX :Comment Text (F) ........................................ 234
CX :Comment Text (H) ....................................... 132 E
CX :Comment Text (P) ......................................... 35
CY ....................................................................... 342 ED Equipment Path Pattern D (G) ..................... 223
Cycle ................................................................... 179 ED Event Daylight Saving (Events) .................... 122
Cycle (T) ............................................................. 184 EE Event Enabled (P) .......................................... 66
Cycle Policy (T) .................................................. 184 EH ....................................................................... 130
CY Cycle (T) ....................................................... 184 EH Event Handling (P) ......................................... 60
EM :Event Messages (H) ................................... 140
D EM :Event Time Milliseconds (Events) ............... 123
End of Period (PC) ............................................. 104
DA Database Address (G) .................................. 221 EP :End of Period (PC) ...................................... 104
Data .................................................................... 151 EP :Execution Priority (C) ................................... 175
Database .............................................................. 15 EP :Execution Priority (D) ................................... 164
Database Address (G) ........................................ 221 EQ Qualified Event Time (Events) ...................... 123
Datalog object .................................................... 151 Equipment Path Pattern D (G) ........................... 223
Data object ........................................... 12, 151, 327 ES Event Source (P) ............................................ 35
Data type .............................................................. 21 ET :Event Time (Events) .................................... 123
Daylight Switch Policy (T) ................................... 184 ET :Event Type (H) ............................................. 140
DB ......................................................................... 34 EVEN (Cycle Policy) ........................................... 184
DB Double Binary Indication (DB) ........................ 85 EVEN (Daylight Switch Policy) ........................... 185
DC Diagnostic Counters (G) ............................... 222 Event Category ..................................................... 75
DC Directory Contents (FT) ................................ 117 Event Category Description (H) .......................... 139
DD Description Pattern D (G) ............................. 222 Event Category ID (H) ........................................ 140
Decimal Places (AI, AO) ....................................... 45 Event channel ......................................... 26, 66, 193
Defining objects .................................................... 14 Event channel object ............................................ 12
Definition tools .................................................... 335 Event channel queue .......................................... 154
DELETE ................................................................ 24 Event channels ................................................... 347
Deleting objects .................................................... 24 Event Comment Text (Events) ............................ 123
Description Pattern D (G) ................................... 222 Event Daylight Saving (Events) .......................... 122
Description Pattern P (G) ................................... 223 Event Enabled (P) ................................................ 66
DI .......................................................................... 34 Event handling .................................................... 315
DI :Discreteness (G) ........................................... 220 Event Handling ................................................... 130
Diagnostic Counters (G) ..................................... 222 Event Handling (P) ............................................... 60
DI Digital Input (DI) ............................................... 86 Event handling object ........................................... 12
DIFFERENCE (Logging Function) ..................... 160 Event handling objects ....................................... 129
Digital Input ........................................................... 26 Event Handling Type (H) .................................... 132
Digital Input (DI) .................................................... 86 Event list ............................................................. 241
Digital Output ........................................................ 26 Event Messages (H) ........................................... 140
Digital Output (DO) ............................................... 86 Event method ..................................................... 227
DIRECT (Logging Function) ............................... 160 Event object ...................................... 12, 23, 26, 227
Directive Text (P) .................................................. 81 Event object handling ........................................... 23
Directory Contents (FT) ...................................... 117 Event recording object .......................................... 34
Discreteness (G) ................................................ 220 Event recording objects ........................................ 25
DO ................................................................ 34, 170 Event Source ........................................................ 74
DO Digital Output (DO) ........................................ 86 Event Source (P) .................................................. 35
Double Binary Indication (DB) .............................. 85 Event Time (Events) ........................................... 123
Double Indication .................................................. 26 Event Time Milliseconds (Events) ...................... 123
DP :Daylight Switch Policy (T) ............................ 184 Event Type (H) .................................................... 140
363
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
EXEC ............................ 23, 153, 169, 194, 228–229 Group .............................................................. 32–33
EXEC_AFTER .................... 153, 169, 194, 228–229 Group Alarm (Groups) ........................................ 126
Executing objects ................................................. 23 Group Alarm State (Groups) .............................. 127
Executing task .................................................... 154 Group Comment (Groups) .................................. 127
Execution .................................................... 174, 179 Grouping ............................................................. 359
Execution Control page ...................................... 337 Group Type (Groups) ......................................... 127
Execution Priority :C ........................................... 175 GS Group Alarm State (Groups) ........................ 127
Execution Priority :D ........................................... 164 GT Group Type (Groups) ................................... 127
Execution queue ................................................. 153
EX Event Comment Text (Events) ...................... 123 H
F HA History Activation (P) ...................................... 70
HB History Blocking (P) ........................................ 96
Fetch ................................................................... 296 HC History Collection Templates (G) .................. 226
FF File Function (FT) .......................................... 117 HD History Logging Daylight Saving (Events) .... 124
FI Free Integer :C ............................................... 172 HE History Enabled (P) ........................................ 71
FI Free Integer :D ............................................... 157 HF History at First Update (P) .............................. 71
FI Free Integer :P ................................................. 81 HH History on History (P) ..................................... 71
File Function (FT) ............................................... 117 High Input (AI) ...................................................... 55
File Name (FT) .................................................... 118 High Output (AO) .................................................. 56
File Transfer ......................................................... 26 High Warning (AI) ................................................. 56
File Transfer (FT) ................................................ 118 HI High Input (AI) .................................................. 55
File Transfer Progress (FT) ................................ 118 Historian ....................................................... 72, 163
FN File Name (FT) .............................................. 118 HISTORIAN_EVENT .......................................... 203
FP File Transfer Progress (FT) ........................... 118 Historical data ..................................................... 151
Free Integer :C ................................................... 172 HISTORY_DATABASE_MANAGER ............... 23, 69
Free Integer :D ................................................... 157 History Activation (P) ............................................ 70
Free Integer :P ...................................................... 81 History at First Update (P) .................................... 71
Free Text :C ........................................................ 172 History Blocking (P) .............................................. 96
Free Text :D ........................................................ 157 History buffering ................................................... 69
Free Text :P .......................................................... 81 History Collection Templates (G) ........................ 226
Free type object .................................................... 12 History database .................................................. 26
Free type objects ................................................ 231 History Database .................................................. 69
Free Type Object Tool ........................................ 355 History Enabled (P) .............................................. 71
Free Type Process Object Tool .......................... 355 History File Number :C ....................................... 177
FT ......................................................................... 35 History File Number :D ....................................... 165
FT File Transfer (FT) ........................................... 118 History Logging Daylight Saving (Events) .......... 124
FX Free Text :C .................................................. 172 History Logging Time (Events) ........................... 124
FX Free Text :D .................................................. 157 History Logging Time Milliseconds (Events) ....... 124
FX Free Text :P ..................................................... 81 History Log Numbers (P) ...................................... 71
History on History (P) ........................................... 71
G History Registrations (D) .................................... 159
HL History Log Numbers (P) ................................ 71
GA Group Alarm (Groups) .................................. 126 HM History Logging Time Milliseconds (Events) . 124
Gateway Information (P) ...................................... 82 HN :History File Number (C) .............................. 177
GC Group Comment (Groups) ........................... 127 HN :History File Number (D) .............................. 165
GET ...................................................................... 23 HO High Output (AO) ........................................... 56
GI Gateway Information (P) .................................. 82 HQ Qualified History Logging Time (Events) ...... 124
GN Logging Name :D ......................................... 163 HR History Registrations (D) .............................. 159
GN Logging Name :P ........................................... 72 HT :Event Handling Type (H) ............................. 132
GP Logging Profile :D ......................................... 163 HT :History Logging Time (Events) .................... 124
GP Logging Profile :P ........................................... 72 HW High Warning (AI) .......................................... 56
364
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
365
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
Maximum Value (AI) ........................................... 100 NM Network Topology Model (NT) ....................... 79
MEAN (Logging Function) .................................. 160 NO (Start-up Execution Policy) .......................... 186
Memory Only :C ................................................. 177 Node (H) ............................................................. 141
Memory Only :D ................................................. 165 NO Network Object Connection (P) ..................... 79
Memory Only :T .................................................. 183 Normal Value (BI, DB) .......................................... 52
Message Text (Events) ....................................... 124 NP Name Pattern P (G) ...................................... 224
Message Texts (H) ............................................. 133 NS :Network Object Subtype (NT) ....................... 79
MINIMUM (Logging Function) ............................ 160 NS :OPC New State (OE) ................................... 113
Minimum Qualified Time (AI) ................................ 99 NT Network Object State (NT) ............................. 86
Minimum Time (AI) ............................................... 99 Number of Attributes (F) ..................................... 234
Minimum Time Milliseconds (AI) ........................... 99 NV Normal Value (BI, DB) .................................... 52
Minimum Value (AI) .............................................. 99
MIRRORING_CONFIGURATION ....................... 201 O
MM Minimum Time Milliseconds (AI) .................... 99
Modification Time :A ........................................... 197 OA Object Address (P) ......................................... 40
Modification Time :C ........................................... 173 Object Address (P) ............................................... 40
Modification Time :D ........................................... 159 Object attribute notation ....................................... 18
Modification Time :F ........................................... 234 Object Bit Address (P) .......................................... 41
Modification Time :G ........................................... 220 Object identification ............................................ 357
Modification Time :Groups .................................. 128 Object Identifier (P) .............................................. 37
Modification Time :H ........................................... 137 Object name ......................................................... 19
Modification Time :P ............................................. 35 Object Name (A) ................................................. 196
Modification Time :T ........................................... 183 Object Navigator ......................................... 335, 341
Modification Time :X ........................................... 150 Object notation ............................................... 18, 21
MODIFY ................................................................ 24 Object Status :C ................................................. 174
MO Memory Only :C ........................................... 177 Object Status :D ................................................. 166
MO Memory Only :D ........................................... 165 Object Status :G ................................................. 224
MO Memory Only :T ........................................... 183 Object Status :P .................................................... 90
MON_EVENT ..................................................... 199 Object Text (P) ...................................................... 38
MQ Minimum Qualified Time (AI) ......................... 99 Object Type (A) ................................................... 196
MT :Message Texts (H) ...................................... 133 Object value ........................................................ 151
MT :Minimum Time (AI) ........................................ 99 Object Value ......................................................... 83
MV Minimum Value (AI) ........................................ 99 Object Value :D ................................................... 166
MX :Message Text (Events) ............................... 124 Object Value :P ..................................................... 87
MX :Translated Message Texts (H) .................... 134 OB Object Bit Address (P) .................................... 41
OC OPC Condition Event (H) ............................. 137
N OE ................................................................ 35, 107
OE OPC Event (OE) ..................................... 87, 114
Name Pattern D (G) ........................................... 224 OF Overflow (P) .................................................. 104
NA Number of Attributes (F) ............................... 234 OG :OPC Event Generation (H) ......................... 138
ND :Network Topology Data (NT) ....................... 121 OG :Originator Identification (P) ......................... 106
ND :Node (H) ...................................................... 141 OI Object Identifier (P) .......................................... 37
ND Name Pattern D (G) ..................................... 224 ON ........................................................ 23, 227, 229
Network Feeds (NT) ........................................... 121 ON :Object Name (A) ......................................... 196
Network Object Connection (P) ............................ 79 ON :OPC Item Name (C) .................................... 172
Network Object State (NT) ................................... 86 ON :OPC Item Name (D) .................................... 158
Network Object Subtype (NT) .............................. 79 ON :OPC Item Name (P) ...................................... 37
Network Topology Data (NT) .............................. 121 ONCE (Start-up Execution Policy) ..................... 186
Network Topology Model (NT) .............................. 79 One-to-one scaling ............................................. 147
Next Group ......................................................... 296 OPC ...................................................................... 39
Next Index .......................................................... 296 OPC A&E Server ................................................ 107
NF Network Feeds (NT) ..................................... 121 OPC Ack Required (OE) ..................................... 112
366
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
367
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
368
1MRS758113 MicroSCADA Pro SYS600 9.4
Issued: 16.5.2014 Application Objects
Version: 16.5.2014
Technical Description
369
SYS600 9.4 MicroSCADA Pro 1MRS758113
Application Objects
Technical Description
370
Contact us
www.abb.com/substationautomation