SYS 600 9.3 Java Programming Interface (Java-API)

94 Pages·2010·3.71 MB·English

MicroSCADA Pro SYS 600 9.3
Java Programming Interface (Java-API)

1MRS756648 MicroSCADA Pro SYS 600 9.3
Java Programming Interface (Java-API)
Issued: 31.3.2010
Version: A/31.3.2010 User’s Guide
Contents
Copyrights .....................................................................................5
1. Introduction ...............................................................................7
1.1. This manual ...................................................................................7
1.2. Use of symbols ..............................................................................8
1.3. Related documents .......................................................................9
1.4. Document revisions .......................................................................9
2. Safety information ...................................................................11
2.1. Backup copies .............................................................................11
2.2. Fatal errors ..................................................................................11
3. Instructions ..............................................................................13
3.1. IP Address ...................................................................................13
3.2. Hardware and software requirements .........................................13
3.3. Installation ...................................................................................14
3.4. Environment Settings ..................................................................17
3.5. Configuration ...............................................................................20
3.6. Configuring Java API for several products ..................................22
3.7. Using Java classes, applications and applets .............................22
3.7.1. Java classes ....................................................................22
3.7.2. Java applications .............................................................23
3.7.3. Examples .........................................................................24
4. Technical reference ................................................................31
4.1. Java classes ................................................................................31
4.1.1. SCIL_Connection .............................................................31
4.1.2. SCIL_SSL_Connection ....................................................32
4.1.3. SCIL_Interface .................................................................32
4.1.4. SCIL_Object .....................................................................35
4.1.5. Objects inherited from the SCIL_Object ..........................36
4.1.5.1. SCIL_BaseSystemObject ...................................36
4.1.5.2. SCIL_CommandProcedureObject ......................37
4.1.5.3. SCIL_DataObject ...............................................37
4.1.5.4. SCIL_EventChannelObject ................................38
4.1.5.5. SCIL_EventObject ..............................................38
4.1.5.6. SCIL_ProcessObject ..........................................38
4.1.5.7. SCIL_ScaleObject ..............................................39
4.1.5.8. SCIL_SystemObject ...........................................39
4.1.5.9. SCIL_TimeChannelObject .................................40
4.1.6. SCIL_FreeTypeObject .....................................................40
3
SYS 600 9.3 MicroSCADA Pro 1MRS756648
Java Programming Interface (Java-API)
User’s Guide
4.1.7. SCIL_Value .....................................................................43
4.1.8. SCIL_Message ................................................................49
4.1.9. EventLog .........................................................................50
5. Example application ...............................................................53
5.1. Using the example application ....................................................53
5.1.1. First page (main.html) ......................................................53
5.1.2. General info (generalinfo.html) ........................................54
5.1.3. Configuration & diagnostics (configuration.html) .............56
5.1.3.1. Applications (apl.html) .......................................57
5.1.3.2. Monitors (mon.html) ...........................................60
5.1.3.3. Nodes (nod.html) ...............................................60
5.1.3.4. Printers (pri.html) ...............................................61
5.1.3.5. Links (lin.html) ....................................................61
5.1.3.6. Stations (sta.html) ..............................................62
5.1.3.7. Nets (net.html) ...................................................62
5.1.3.8. Memory (memory.html) ......................................62
5.1.3.9. Time (time.html) .................................................64
5.1.3.10.Queues (queuemeters.html) ..............................65
5.1.3.11.Bar-chart (diagram.html) ....................................65
5.1.3.12.Line-diagram (linediagram.html) ........................66
5.1.3.13.Remote Communication Client Server
communication (main2.html) ..............................67
6. Terminology ............................................................................71
7. Abbreviations .........................................................................73
8. Index ........................................................................................75
4
1MRS756648 MicroSCADA Pro SYS 600 9.3
Java Programming Interface (Java-API)
User’s Guide
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 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 alicense and
may be used, copied, or disclosed only in accordance with the terms of such license.
Copyright © 2010 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.
5
6
1MRS756648 MicroSCADA Pro SYS 600 9.3
Java Programming Interface (Java-API)
User’s Guide
1. Introduction
1.1. This manual
This manual provides thorough information on Java API for SYS 600 and needed
information related to it. This manual gives instructions for installation and
describes how to configure Java and SYS 600 for a client-server communication.
Explanations for the abbreviations used in this manual can be found in the Glossary
chapter.
Java API
Java API for SYS 600 is kind of a client-server application. A Java applet or
application communicates with the server, which in turn communicates with SYS
600. Java applets work inside the Web browsers on PCs and applications run on the
PC itself. The server is designed to be used in both the Intranet and the Internet.
When used in the Internet, some of the functionalities may have to be restricted to
only certain hosts or users.
Figure 1.1.-1 shows a diagram describing the Java API. In case of the HSB system,
only the application in Hot state can be contacted. More information about the
application state (AS attribute) can be found in Chapter 5 (APL Objects for Base
System) of SYS 600 System Objects.
Java_API
Fig. 1.1.-1 The applets, as well as the applications, are connected to SYS 600 via
the Java API and Java classes complementing the API.
Benefits
The main advantage is to provide an easy-to-use programming environment for the
development of the application extension programs. In this environment, dynamic
data types (vectors, lists etc.) are handled in a safe way. The temporarily allocated
7
SYS 600 9.3 MicroSCADA Pro 1MRS756648
Java Programming Interface (Java-API)
User’s Guide
memory in the SYS 600 memory pool will be automatically released, if it is not
needed any more. One purpose to use Java API is to get information from SYS 600
to the office computers without opening SYS 600 monitors.
Java API functions
The main purpose for Java API is to provide the same functionality as in C-API, but
in the Java environment. The functions in the C-API are grouped into several Java
classes. The Java classes which handle the communication with SYS 600 are located
in the SCIL.jar file.
The SCIL_Interface functions can be used to read/write variables, execute SCIL
commands, read SYS 600 events etc. When the SCIL_Interface class has been
created, a new SCIL_Context is also created. The context remains the same until the
SCIL_Interface is destroyed. When there is more than one SCIL_Interface, each of
the SCIL_Interfaces have their own SCIL context. The variables used in one
SCIL_Context cannot be accessed in another context.
The data is transferred between Java and SYS 600 mainly using the SCIL_Value
class. The SCIL_Value encapsulates the SCIL data types. The SCIL_Message class
is used when working with the SYS 600 events. The EP messages from SYS 600 can
be used by methods in the SCIL_Interface. The user can select which events to order
by using the methods in SCIL_Interface. The message can be read by using the
getAepMessage function. Depending on the timeout value, the function will be
blocked infinitely until the message is found or the time limit is reached.
1.2. Use of symbols
This publication includes warning, caution, and information icons that point out
safety related conditions or other important information. It also includes tip icons to
point out useful information to the reader. The corresponding icons should be
interpreted as follows:
The caution icon indicates important information or warning related
to the concept discussed in the text. It might indicate the presence of
a hazard which could result in corruption of software or damage to
equipment or property.
The information icon alerts the reader to relevant facts and
conditions.
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 warning and caution notices.
8
1MRS756648 MicroSCADA Pro SYS 600 9.3
Java Programming Interface (Java-API)
User’s Guide
1.3. Related documents
Other useful or related manuals are:
Name of the manual MRS Number
SYS 600 9.3 System Objects 1MRS756662
SYS 600 9.3 Programming Language SCIL 1MRS756661
SYS 600 9.3 Installation and Administration Manual1MRS756634
1.4. Document revisions
Version Revision number Date History
A 9.3 31.3.2010 New document
9
10