Omron CX-SUPERVISOR - SCRIPT REFERENCE REV2.0 User manual

Cat. No. W09E-EN-01
CX-Supervisor
Software Release 2.0
SCRIPT REFERENCE
Cat. No. W09E-EN-01 Note: Specifications subject to change without notice.
Authorized Distributor:
Printed in Europe
Cat. No. W09E-EN-01 CX-Supervisor Software Release 2.0 SCRIPT REFERENCE

CX-Supervisor
Script Language
Software Revision 2.0

OMRON CX-Supervisor – Script Language
Revision 2.0 Page (i)
Notice
OMRON products are manufactured for use according to proper procedures by a qualified operator and
only for the purposes described in this manual.
The following conventions are used to indicate and classify precautions in this manual. Always heed
the information provided in them. Failure to heed precautions can result in injury to people or damage
to the product.
DANGER! Indicates information that, if not heeded, is likely to result in loss of life or
serious injury.
WARNING Indicates information that, if not heeded, could possibly result in loss of life
or serious injury.
Caution Indicates information that, if not heeded, could result in relatively serious or
minor injury, damage to the product, or faulty operation.
OMRON Product References
All OMRON products are capitalised in this manual. The word “Unit” is also capitalised when it refers
to an OMRON product, regardless of whether or not it appears in the proper name of the product.
The abbreviation “PLC” means Programmable Logic Controller and is not used as an abbreviation for
anything else.

CX-Supervisor – Script Language OMRON
Page (ii) Revision 2.0

OMRON CX-Supervisor – Script Language
Revision 2.0 Page (iii)
Visual Aids
The following headings appear in the left column of the manual to help you locate different types of
information.
Note: Indicates information of particular interest for efficient and convenient
operation of the product.
1, 2, 3… Indicates lists of one sort or another, such as procedures, checklists etc.
Represents a shortcut on the Toolbar to one of the options available on the
menu of the same window.
Indicates a program must be started, usually by clicking the appropriate
option under the standard Windows ‘Start’ button.


OMRON, 2007
All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or
transmitted, in any form, or by any means, mechanical, electronic, photocopying, recording, or
otherwise, without the prior written permission of OMRON.
All copyright and trademarks acknowledged.
No patent liability is assumed with respect to the use of the information contained herein. Moreover,
because OMRON is constantly striving to improve its high-quality products, the information contained
in this manual is subject to change without notice. Every precaution has been taken in the preparation of
this manual. Nevertheless, OMRON assumes no responsibility for errors or omissions. Neither is any
liability assumed for damages resulting from the use of the information contained in this publication.

CX-Supervisor – Script Language OMRON
Page (iv) Revision 2.0

OMRON CX-Supervisor – Script Language
Revision 2.0 Page (v)
About this Manual
This manual describes the script language syntax as a supplement to CX-Supervisor application user
manual.
This manual contains the following:
♦Chapter 1 Introduction. An overview to this manual including special typographical conventions.
♦Chapter 2 Expressions. A description of the use of expressions within scripts.
♦Chapter 3 Scripts. An introduction to scripts and the type of scripts.
♦Chapter 4 CX-Supervisor Script Language. A detailed reference to the CX-Supervisor script
language.
♦Chapter 5 VBScript Language Reference. A reference for the VBScript language.
♦Chapter 6 Functions and Methods. A detailed reference to the functions and methods available to
script languages.
♦Chapter 7 Script Examples. A description of the script language in practice, using some examples.
♦Chapter 8 Colour Palette. A description of the colour palette that can be applied to certain script
statements.
♦Appendix A OPC Communications Control. This appendix contains a list of the available
component properties and gives details of the Visual Basic script interface.
♦Appendix B CX-Server Communications Control. This appendix contains a list of the available
component properties and gives details of the Visual Basic script interface.
♦Appendix C JScript Features. This appendix provides a summary of the JScript features available
for use with the ExecuteJScript and ExecuteJScriptFile script functions.
♦Appendix D Obsolete Features. This appendix provides a summary of the obsolete features, which
remain enabled for backward compatibility.
A Glossary of Terms and Index are also provided.

CX-Supervisor – Script Language OMRON
Page (vi) Revision 2.0

OMRON CX-Supervisor – Script Language
Revision 2.0 Page (vii)
TABLE OF CONTENTS
CX-Supervisor ..............................................................................................................................Page
Chapter 1 – Introduction ......................................................................... 1
Chapter 2 – Expressions........................................................................... 3
Chapter 3 – Scripts ................................................................................... 7
Object ..................................................................................................................................................7
Page .....................................................................................................................................................7
Project..................................................................................................................................................7
Chapter 4 – CX-Supervisor Script Language........................................ 9
Points .................................................................................................................................................10
Logic and Arithmetic.........................................................................................................................12
Control Statements ............................................................................................................................15
Subroutines ........................................................................................................................................22
Punctuation ........................................................................................................................................23
Indirection within Script Commands and Expressions......................................................................26
Point Arrays within Script Commands and Expressions ...................................................................27
Using Aliases.....................................................................................................................................28
Chapter 5– VBScript Language reference ........................................... 31
List of features...................................................................................................................................31
Chapter 6 – Functions and Methods..................................................... 35
Object Commands .............................................................................................................................39
Page Commands ................................................................................................................................49
General Commands ...........................................................................................................................50
Communications Commands.............................................................................................................56
Point Commands ...............................................................................................................................58
PLC Commands.................................................................................................................................68

CX-Supervisor – Script Language OMRON
Page (viii) Revision 2.0
Table of Contents Chapter 6 continued Page
Temperature Controller Commands.................................................................................................. 73
Alarm Commands .............................................................................................................................79
File Commands .................................................................................................................................84
Recipe Commands ............................................................................................................................93
Report Commands............................................................................................................................. 95
Text Commands ................................................................................................................................97
Event/Error Commands................................................................................................................... 103
Printer Commands...........................................................................................................................105
Security Commands ........................................................................................................................109
Data Logging Commands................................................................................................................111
Database Commands....................................................................................................................... 117
Serial Port Functions ....................................................................................................................... 130
ActiveX Functions ..........................................................................................................................133
Chapter 7 – Script Examples ............................................................... 137
Balloon Script .................................................................................................................................137
Chapter 8 – Colour Palette................................................................... 141
Appendix A – OPC Communications Control................................... 143
Component Properties.....................................................................................................................143
Script Interface ................................................................................................................................143
Functions.........................................................................................................................................143
Appendix B – CX-Server Communications Control ......................... 145
Component Properties.....................................................................................................................145
Script Interface ................................................................................................................................145
Functions.........................................................................................................................................145
PLC Memory Functions..................................................................................................................145
Appendix C – JScript Features............................................................ 151

OMRON CX-Supervisor – Script Language
Revision 2.0 Page (ix)
Appendix D – Obsolete Features ......................................................... 153
Glossary of Terms................................................................................. 161
Index....................................................................................................... 169

OMRON CHAPTER 1 - Introduction
Revision 2.0 Page 1
CHAPTER 1
Introduction
This reference manual describes the script language syntax as a supplement to the CX-Supervisor
User Manual. It provides detailed definition of the syntax of CX-Supervisor scripts that drive project,
page, object actions and CX-Supervisor expressions as used by objects and scripts.
Typographic conventions used in the examples in this reference manual are as follows:
♦Script commands and reserved words are shown in the preferred case, which may be either
lower-, upper- or mixed-case.
♦Points are shown in lower-case. Objects are shown in upper-case.
The following terms are used in this reference manual:
♦Application. A set of files, containing an executable file, that carry out certain tasks. This
reference manual refers to the Microsoft Excel and Microsoft Word for Windows applications.
♦Constant. A point or object within a script that takes only one specific value.
♦Executable. A file that contains programs or commands, and has an ‘*.EXE’ extension.
♦Nesting. To incorporate one or more IF THEN ELSE/ELSEIF ENDIF statements inside a
structure of the same kind.
♦Operands. Constants or point variables.
♦Operators. Relational, arithmetic, and logical statements, for instance ‘+’, ‘<=’ or ‘AND’.
♦Or (‘|’). The ‘|’ symbol is used to represent ‘or’, where there are two or more forms of the same
syntax.
♦Point Types. Either Boolean, Integer, Real or Text.
♦Point Variable. A point or object within a script that may take different values.
♦Strings. Data in the form of text delimited by quotation marks (“ ”), which can be assigned to a
point.
♦The ‘{’ and ‘}’ braces. Must be inserted around the argument command or an error is reported.
An error is reported if there are spaces between braces.
♦‘TRUE’ and ‘FALSE’. Refer exclusively to Boolean states, where Boolean state 0 is ‘FALSE’
and Boolean state 1 is ‘TRUE’.

CHAPTER 1 - Introduction OMRON
Page 2 Revision 2.0

OMRON CHAPTER 2 - Expressions
Revision 2.0 Page 3
CHAPTER 2
Expressions
This chapter describes the use of expressions within scripts.
Expressions consist of operators and operands:
♦Operators are relational, arithmetic, logical and include many functions.
♦Operands are constants or point variables.
Expressions can be used in a script as part of a statement (refer to chapter 3 Scripts, chapter 4 CX-
Supervisor Script Language, and Chapter 6 Functions and Methods). However expressions can be
applied to the following actions directly using the associated Expression: or Digital Expression: field:
♦Blink.
♦Close page.
♦Colour Change (Analogue).
♦Colour Change (Digital).
♦Display Status Text.
♦Display Text Point.
♦Display Value.
♦Edit point value (Analogue).
♦Edit point value (Digital).
♦Edit point value (Text).
♦Enable/Disable.
♦Horizontal move.
♦Horizontal percentage fill.
♦Resize height.
♦Resize width.
♦Rotate.
♦Show page.
♦Vertical move.
♦Vertical percentage fill.
♦Visible.
The following example of a simple expression contains a point (‘redcars’) attached to a particular
object with an appropriate object action, Resize (Height). At runtime, once the value of the point has
been met within the attributes declared within the Active Expression Range/Required Height: fields,

CHAPTER 2 - Expressions OMRON
Page 4 Revision 2.0
the current object is resized accordingly. This example is an Integer or Real example, whereby the
value of the point either falls inside or outside the specified range. In this example, the point 'redcars'
must fall between 0 and 40 for the expression to be met.
The following example of a more complex expression contains a test on point ‘position’. If ‘position’
is more than 300 in value, and ‘position’ is less than 450 in value, i.e. the value of ‘position’ is
between 300 and 450, then the expression has been met, and an action is initiated (in this instance the
current object is made visible if the expression is met). This example is a Boolean example, whereby
either the expression is met (‘TRUE’) or not met (‘FALSE’). A Boolean value is always returned
from a Digital Expression: field, as opposed to an Expression: field, which returns an Integer or Real
value.
Operators used within this example are fully described in chapter 4, Logic and Arithmetic.
The following example of an expression contains a value point ‘prompt’ which is included at the
value position denoted by a ‘#’ symbol.

OMRON CHAPTER 2 - Expressions
Revision 2.0 Page 5
Refer to the CX-Supervisor User Manual for detailed dialog descriptions.
Note: Boolean Expressions execute when the expression is TRUE so it can be said that every
Boolean expression has an inferred “== TRUE”. Sometimes Boolean expressions can be
difficult to read e.g. “bMyFlagPoint” or “BitMask & 0x80. It can help maintenance if this
“== TRUE” is explicitly specified e.g. “bMyFlagPoint == TRUE” or “BitMask & 0x80 ==
TRUE”.
Note: When using Boolean operators (e.g. ==, !=, &&, ||, |) never mix tests for Boolean and non
Boolean operands. For example never use “bMyFlagPoint == 1” or “bMyFlagPoint == 0”.
Instead always test using the correct Boolean constant i.e. “TRUE” or “FALSE” for CX-
Supervisor scripts, or “True” and “False” when using VBScript.
Note: On Condition scripts are only executed when the expression is TRUE. Sometimes this leads
to peculiar results, for example using $Second as it will be executed when $Second changes
to 59, and to 1 but not when it changes to 0. To execute a condition script any time a point
changes, force the expression to always evaluate to TRUE for example “$Second || TRUE”.
This works because the $Second forces the expression to be tested when the point changes,
but the || TRUE means the test will return TRUE regardless of the value of the point.
Note: Use array points in On Condition expressions with caution. The expression “MyArray[3] ==
1” does not mean “execute every time the third element changes to 1”. It means execute
when any element of MyArray changes and the third element happens to be 1
Note: Using an array point without any index is the same as specifying element 0 i.e. MyArray
actually means MyArray[0] == 1

CHAPTER 2 - Expressions OMRON
Page 6 Revision 2.0

OMRON CHAPTER 3 - Scripts
Revision 2.0 Page 7
CHAPTER 3
Scripts
A CX-Supervisor script is a simple programming language used to manipulate points. Scripts can be
created at different levels, at object level, page level or project level. Although the script code can be
applied to all levels of script, there are subtle differences, described in the following paragraphs.
Object
If a script is executed as a runtime action of an object, then the script can affect the object of the
action, or any other, depending on the actual content of the script.
Page
Page scripts are concerned with manipulating points and graphical objects that are used or included
within that page. In other words page scripts are used to drive a number of actions on the occurrence
of a particular event. These actions may manipulate several graphical objects on one page.
Project
Scripts can be applied to a project to manipulate points. These scripts are associated with events that
occur throughout the whole operating session