CX-Supervisor

Script Language
Software Release 1.1

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CX-Supervisor – Script Language

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.

Revision 1.1 Page 1

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CX-Supervisor – Script Language

Visual Aids
The following headings appear in the left column of the manual to help you locate different types of
information.
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.

 OMRON, 2001
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.

Revision 1.1 Page 2

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CX-Supervisor – Script Language

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 - Functions and Methods. A detailed reference to the CX-Supervisor script

language.

♦ Chapter 5 - Script Examples. A description of the script language in practice, using some
examples.

♦ Chapter 6 - 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 - Lite Communications Control. This appendix contains a list of the available
component properties and gives details of the Visual Basic script interface.

♦ Appendix C - VBScript Features. This appendix provides a summary of the VBScript features
available for use with the ExecuteVBScript and ExecuteVBScriptFile script functions.

♦ Appendix D - Jscript Features. This appendix provides a summary of the JScript features
available for use with the ExecuteJScript and ExecuteJScriptFile script functions.

A Glossary of Terms and Index are also provided.

Revision 1.1 Page 3

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CX-Supervisor – Script Language

TABLE OF CONTENTS
CX-Supervisor Page

Chapter 1 – Introduction.....................................................6
Chapter 2 – Expressions ....................................................7
Chapter 3 – Scripts ...........................................................10
Object...................................................................................................................................10
Page.....................................................................................................................................10
Project ..................................................................................................................................10

Chapter 4 – Functions and Methods................................11

Points ...................................................................................................................................16
Logic and Arithmetic.............................................................................................................18
Control Statements...............................................................................................................21
Subroutines ..........................................................................................................................28
Object Commands................................................................................................................29
Page Commands..................................................................................................................38
General Commands .............................................................................................................39
Communications Commands ...............................................................................................43
Point Commands..................................................................................................................46
PLC Commands ...................................................................................................................54
Temperature Controller Commands .....................................................................................60
DDE Commands ..................................................................................................................66
Alarm Commands.................................................................................................................70
File Commands ....................................................................................................................75
Graph Commands ................................................................................................................82
Recipe Commands...............................................................................................................86
Report Commands ...............................................................................................................87
Text Commands ...................................................................................................................90
Event/Error Commands ........................................................................................................96
Printer Commands ...............................................................................................................98
Security Commands ...........................................................................................................102
Data Logging Commands...................................................................................................104
Database Commands.........................................................................................................110

Revision 1.1 Page 4

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 1 - Introduction

Table of Contents Chapter 4 continued Page

Serial Port Functions ..........................................................................................................123
ActiveX Functions...............................................................................................................126
Punctuation ........................................................................................................................129
Indirection within Script Commands and Expressions ........................................................132
Point Arrays within Script Commands and Expressions .....................................................133
Using Aliases......................................................................................................................134

Chapter 5 – Script Examples.......................................... 136

Balloon Script .....................................................................................................................136
DDE Script..........................................................................................................................139

Chapter 6 – Colour Palette ............................................. 143

Appendix A – OPC Communications Control ............... 144
Component Properties .......................................................................................................144
Script Interface ...................................................................................................................144
Functions............................................................................................................................144

Appendix B – Lite Communications Control................. 146

Component Properties .......................................................................................................146
Script Interface ...................................................................................................................146
Functions............................................................................................................................146
PLC Memory Functions ......................................................................................................149

Appendix C – VBScript Features ................................... 151

Appendix D – JScript Features ...................................... 154
Glossary of Terms........................................................... 156
Index ................................................................................ 162

Release 1.1 Page 5

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 1 - Introduction

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’.

Release 1.1 Page 6

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

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 and chapter 4,
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,
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.

Release 1.1 Page 7

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

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.

Release 1.1 Page 8

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Refer to the CX-Supervisor User Manual for detailed dialog descriptions.

Release 1.1 Page 9

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

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

Release 1.1 Page 10

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

CHAPTER 4
Functions and Methods
This chapter describes the CX-Supervisor script language syntax. It provides a detailed definition of
the syntax of CX-Supervisor scripts that drive project, page and object actions, and CX-Supervisor
expressions as used by objects and scripts.
The following table describes the script language syntax at a glance.

Function Name Function Type Type Remarks

&, |, ^, <<, >> bitwise operators All Applies bitwise expressions
(objects) statement OP Specifies an object name for
modification or test.
(points) statement All Specifies a point name for modification
or test.
+, -, *, /, %, = arithmetic operators All Applies arithmetic expressions.
<, >, <=, >=, ==, != relational operators All Applies relational expressions.
AcknowledgeAlarm alarm command Scr Acknowledges an alarm.
AcknowledgeAllAlarms alarm command Scr Acknowledges all alarms.
AcknowledgeLatestAlarm alarm command Scr Acknowledge the latest alarm.
Acos unary function All Applies unary expression.
Asin unary function All Applies unary expression.
Atan unary function All Applies unary expression.
CancelForce point command Scr Removes the forcing of values on a
point.
Chr text command All Displays a character based on the
ASCII character set.
ClearAlarmHistory alarm command All Clears the alarm history.
ClearErrorLog event/error commands All Clears the error log.
ClearGraph graph command Scr Clears the data from a trend or scatter
graph.
ClearLogFile Data Logging command Scr Clears a data log file
ClearSpoolQueue printer command All Discards any queued messages or
alarms.
close object command Scr Closes a specified page.
CloseAlarmHistory alarm command All Closes the current alarm history.
CloseAlarmStatus alarm command Scr Closes the current alarm status.
CloseComponent comms command All Closes a component for a PLC (e.g.
CX-Server components).
CloseErrorLog error command Scr Closes the currently open Error Log.
CloseFile file command Scr Closes the open file.
CloseLogFile Data Logging command Scr Closes a data log file
CloseLogView Data Logging command Scr Closes the log viewer
ClosePLC PLC command Scr Close communications with a PLC.
colour object command OP Specifies a colour to an object.

Release 1.1 Page 11

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Function Name Function Type Type Remarks

CopyArray point command All Copies the content of an array.
CopyFile file command Scr Copies a specified file.
cos unary function All Applies unary expression.
DDEEnable DDE command All Enables DDE functions.
DDEExecute DDE command Scr Sends a command to an app. via a
DDE channel.
DDEInitiate DDE command Scr Initiates a DDE conversation.
DDEOpenLinks DDE command Scr Creates a DDE advise loop.
DDEPoke DDE command Scr Uses open DDE channel to send
information.
DDERequest DDE command Scr Uses open DDE channel to request
information.
DDETerminate DDE command Scr Closes the specified DDE channel.
DDETerminateAll DDE command Scr Closes all DDE channels.
DeleteFile file command Scr Deletes the specified file.
disable object command OP Disables an object.
DisableGroup point command All Prevents a group of points to be read or
written.
DisablePoint point command Scr Disables communications to a point.
display object command Scr Displays a specified page.
DisplayAlarmHistory alarm command Scr Displays the current alarm history.
DisplayAlarmStatus alarm command Scr Displays the alarm status of all current
alarms.
DisplayErrorLog event command Scr Displays the current Error Log.
DisplayRecipes recipe command Scr View the current recipes in the project.
DownloadPLCProgram PLC command All Downloads specified files to the PLC.
DownloadRecipe recipe command Scr Downloads a specified recipe.
EditFile file command All Edits a specified file.
EditGraph graph command Scr Displays a dialog used for editing trend
graphs.
EnableAlarms alarm command All Enables alarm functions.
EnableDDE comms command Scr Allows use of DDE functions.
EnableErrorLogging error command Scr All actions become subject to Error
Logging.
EnableGroup point command All Permits a group of points to be read or
written.
EnableOLE comms command Scr Allows use of OLE functions.
EnablePLC comms command Scr Allows use of PLC functions.
EnablePoint point command Scr Enables communications to a point.
EnablePrinting printer command All Permits printing of Alarms or messages.
ExportAndViewLog Data Logging command Scr Exports data log and views
ExportLog Data Logging command Scr Exports data log
FALSE Boolean state Scr Applies Boolean expression.

Release 1.1 Page 12

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Function Name Function Type Type Remarks

FileExists file command All Specifies the existence of a file.
Force point command Scr Locks the value of a point.
ForceReset point command Scr Sets a point value to 0.
ForceSet point command Scr Sets a point value to 1.
FormatText text command All Inserts text with standard ‘C’ formatting
characters.
GenerateReport report command All Produces a report based on a report
template.
GetBit point command All Retrieves a bit from a point.
GetPLCMode PLC command All Retrieves the mode of a PLC.
GetPointValue point command Scr Retrieves the value of a point.
GetSpoolCount printer command All Specifies the number of alarms or
messages queued for printing.
GetTextLength text command All Specifies the number of characters in a
text point.
height object command OP Specifies the height of an object.
horizontal%fill object command OP Specifies the horizontal fill of an object.
IFTHEN ELSE\ELSEIF statement Scr Applies a test to a script.
ENDIF
InputPoint point command Scr Reads a value from a point.
IsAlarmAcknowledged alarm command Scr Tests if a specified alarm has been
acknowledged.
IsAlarmActive alarm command Scr Tests if a specified alarm is currently
active.
Left statement Scr Extracts characters from the left of a
string
log unary function All Calculates the natural logarithm on a
number.
log10 unary function All Calculates the base-10 logarithm on a
number.
LogError error command Scr Logs an error message with the error
logger.
LogEvent error command Scr Logs an event message with the error
logger.
Login security command Scr Logs a user into a run-time application.
Logout security command Scr Logs a user out of a run-time
application.
Message text command Scr Outputs a string in a message box.
Mid text command Scr Extracts a substring from a string.
move object command OP Moves an object.
MoveFile file command Scr Moves the specified file.
OpenComponent comms command All Opens a component for a PLC (e.g. CX-
Server components).
OpenFile file command Scr Opens the specified file.

Release 1.1 Page 13

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Function Name Function Type Type Remarks

OpenLogFile Data Logging command Scr Opens a data log file
OpenLogView Data Logging command Scr Opens the Data Log Viewer
OpenPLC PLC command Scr Opens communications with a PLC.
OR, AND, NOT logical operators All Applies logical expressions.
OutputPoint point command Scr Displays the current value of a point.
PlayOLE gen. command Scr Plays an OLE object.
PlaySound gen. command Scr Plays a sound file.
PLCCommsFailed PLC command All Specifies if the PLC communications
have failed.
PLCMonitor PLC command Scr Monitors a PLC.
PointExists point command All Specifies the existence of a point.
PrintActivePage gen. command Scr Prints the currently active page.
PrintFile file command Scr Prints the specified file.
PrintMessage text command All Prints messages to the configured
‘Alarm/message printer’.
PrintPage gen. command Scr Prints the specified page.
PrintReport report command All Prints a report
PrintScreen gen. command Scr Prints the current display screen.
PrintSpoolQueue printer command All Prints all queued alarms or messages.
Rand gen. command Scr Calculates a random number.
Read file command Scr Reads data from an open file into a
point.
ReadMessage file command All Reads text from an external file.
REM statement Scr Remarks on line or lines of script.
RETURN statement Scr Stops sequential execution of script.
Right text command Scr Extracts characters from the right of a
string.
rotate object command OP Rotates an object.
RunApplication gen. command Scr Runs the specified application.
RunHelp gen. command Scr Runs the specified help file.
SaveGraph graph command All Saves graph data to disk.
SELECT CASE/END statement Scr Applied to complex tests.
SELECT
SelectFile file command All Specifies a file name and path.
SetBit point command All Sets a specific bit from a point.
SetPLCMode PLC command All Sets the mode of a PLC.
SetPLCPhoneNumber PLC command All Sets a phone number to a PLC.
SetPointValue point command Scr Sets the value of a point.
SetPrinterConfig printer command All Defines printer configuration.
SetupUsers security command Scr Defines users and passwords for Login.
ShutDown gen. command Scr Terminates CX-Supervisor.
sin unary function All Applies unary expression.

Release 1.1 Page 14

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Function Name Function Type Type Remarks

Snapshot graph command Scr Stores the current state of a trend
graph.
sqrt unary function All Applies unary expression.
StartGraph graph command Scr Starts the recording of a graphs data.
StartLogging Data Logging command Scr Starts a data set logging.
StopGraph graph command Scr Stops the recording of a graphs data.
StopLogging Data Logging command Scr Stops a data set logging.
tan unary function All Applies unary expression.
TCAutoTune temp. controller command All Starts or stops a temperature controller
auto-tune operation.
TCBackupMode temp. controller command All Defines how a temperature controller
stores internal variables.
TCGetStatusParameter temp. controller command All Retrieves the temperature controller
status parameter.
TCRemoteLocal temp. controller command All Defines the operational mode of a
temperature controller.
TCRequestStatus temp. controller command All Retrieves the temperature controller
status.
TCReset temp. controller command All Resets the temperature controller.
TCRspLsp temp. controller command All Defines the setpoint mode used by the
temperature controller.
TCRunStop temp. controller command All Defines either auto-output mode shift or
manual output mode shift.
TCSaveData temp. controller command All Saves data associated with the
temperature controller.
TCSettingLevel1 temp. controller command All Performs a settinglevel function for the
temperature controller.
TextToValue text command Scr Converts a string to a numerical point
value.
TRUE Boolean state Scr Applies Boolean expression.
UploadPLCProgram PLC command All Uploads programs in the PLC to
specified files.
ValueToText text command Scr Converts a numerical value into a text
point.
vertical%fill object command OP Specifies the vertical fill of an object.
ViewReport report command All Displays a report
visible object command OP Toggles the visibility of an object.
width object command OP Specifies the width of an object.
Write file command Scr Writes a value to an open file.
WriteMessage file command All Writes text to an external file.

Release 1.1 Page 15

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

The ‘Type’ column refers to the types of script and expression the function can be applied to. ‘All’
refers to both expressions and scripts. ‘Scr’ refers to scripts only. ‘OP’ refers to Object and Page
scripts only.
The style of this annex is such that each element of the script language is described in turn, describing
scope, syntax with remarks, typical examples and references. References are always forward; for
instance, if an example contains elements not yet described, a suitable reference is included; however
if an example contains elements already described, no reference is made.

Points
Basic Point Assignment
Syntax
pointname = expression

Remarks

Argument Description
pointname The point name to be assigned a value.
expression The value to be assigned to pointname. The expression may be of
type Boolean, Integer, Real or Text.

Typical Examples
count = 100
The Integer or Real point ‘count’ is assigned the value 100.
result = TRUE
The Boolean point ‘result’ is assigned the state ‘‘TRUE’’.
name = "Valve position"
The Text point ‘name’ is assigned the associated text, contained within quotation marks.

References
Refer to chapter 4, Punctuation for details of the use of quotation marks.

Release 1.1 Page 16

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Further Point Assignment

Syntax
pointname = expression

Remarks

Argument Description
pointname The point name to be assigned a value.
expression The value to be assigned to pointname. The expression may be of
type Boolean, Integer or Real and can include other points, logical or
arithmetical expressions. Mathematical precedence is applied as
follows:
• Parenthesis (highest).
• Unary minus and NOT logical operator.
• Multiplication, division and modulus.
• Addition and subtraction.
• Greater than, less than, greater than or equal to, and less than or
equal to relational operators.
• Shift Left (SHL) and Shift Right (SHR).
• Equal to and not equal to relational operators.
• Bitwise AND, XOR, OR.
• AND logical operator, OR logical operator (lowest).

Typical Examples
lift = height + rate/5.0
The Integer or Real point ‘lift’ is assigned the value calculated by the value of point ‘rate’ divided by 5,
plus the value of point ‘height’. Precedence can be changed by the introduction of parenthesis.
lift = lift - 0.2
The Integer or Real point ‘lift’ is assigned the value calculated by the current value of point ‘lift’ minus
0.2.
distance = distance * time
The Integer or Real point ‘distance’ is assigned the value calculated by the current value of point
‘distance’ multiplied by point ‘time’.

References
Refer to chapter 4, Logic and Arithmetic for details of the use of arithmetic and logic functions. Refer
to chapter 4, Punctuation for details of the use of parenthesis.

Release 1.1 Page 17

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Logic and Arithmetic

Arithmetic Operators
Syntax
pointname = expression

Remarks

Argument Description
pointname The point name to be assigned a value based on an arithmetical
expression.
expression The value to be assigned to pointname. The expression may include
the following operators with points and constants:
• Addition ‘+’.
• Subtraction ‘-’.
• Multiplication ‘*’.
• Division ‘/’.
• Modulus ‘%’.

Typical Examples
result = 60 + 20/5
The Integer or Real point ‘result’ is assigned the value calculated by the value of 20 divided by 5, plus
60.
lift = height + rate/5.0
The Integer or Real point ‘lift’ is assigned the value calculated by the value of point ‘rate’ divided by 5,
plus the value of point ‘height’. Precedence can be changed by the introduction of parenthesis.

References
Refer to chapter 4, Punctuation for details of the use of parenthesis.

Bitwise Operators
Syntax
pointname = expression
or
IF expression
or
DO WHILE expression
or
DO UNTIL expression

Release 1.1 Page 18

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Description
pointname The pointname to be assigned a value based on the bitwise operation.
expression The value to be assigned to pointname, or to be evaluated as a
Boolean expression. The expression can include the following
operators with points and constants:
• Bitwise AND, ‘BITAND’ or ‘&’.
• Bitwise OR, ‘BITOR’ or ‘|’.
• Bitwise XOR, ‘XOR’ or ‘^’.
• Bitwise Shift Left, ‘SHL’ or ‘<<’.
• Bitwise Shift Right, ‘SHR’ or ‘>>’.

Typical Examples
MSB = value & 128
The Boolean point ‘MSB’ is set ‘TRUE’ if the binary representation of ‘value’ has the bit set which is
worth 128.
Pattern = value << 2
The binary representation of ‘value’ is shifted left twice, and stored in ‘pattern’. Each Shift Left
operation has the effect of doubling the value, so two shifts quadruple the value.

Logical Operators
Syntax
pointname = expression
or
IF expression
or
DO WHILE expression
or
DO UNTIL expression
Remarks

Argument Description
Pointname The point name to be assigned a value based on a logical expression.
Expression The Boolean value to be assigned to pointname or the Boolean value
forming a conditional statement. The expression includes the
following operators with points and constants:
• And ‘AND’.
• Or ‘OR’.
• Not ‘NOT’.

Release 1.1 Page 19

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Examples
flag = temp AND speed
The Boolean point ‘flag’ is assigned a value based on the logic of point ‘temp’ AND point ‘speed’. If
‘temp’ and ‘speed’ are both not zero, ‘flag’ is set to 1, or ‘‘TRUE’’. A value of zero in either ‘temp’ or
‘speed’ supplies ‘FALSE’ or 0 to ‘flag’.
IF flag AND temp AND speed THEN
flag = FALSE
ENDIF
The Boolean point ‘flag’ is assigned ‘FALSE’, on the condition that ‘flag’ AND point ‘temp’ AND point
‘speed’ are all not zero. If the condition fails, then ‘flag’ is not assigned ‘FALSE’.

References
Refer to chapter 4, Control Statements for details of the use of the IF THEN ELSE/ELSEIF ENDIF
statements.

Relational Operators
Syntax
IF expression
or
DO WHILE expression
or
DO UNTIL expression
Remarks

Argument Description
Expression The value forming a conditional statement. The expression may
include the following operators with points and constants:
• Greater than ‘>’.
• Less than ‘<’.
• Greater than or equal to ‘>=’.
• Less than or equal to ‘<=’.
• Not equal to ‘!=’.
• Equal to ‘==’.

Typical Example
IF fuel < 0 THEN
fuel = 0
ENDIF
The point ‘fuel’ is assigned the value 0 on the condition that currently, ‘fuel’ is less than 0. If ‘fuel’ is
not less than 0, then it is not assigned the new value.

Release 1.1 Page 20

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

References
Refer to chapter 4, Control Statements for details of the use of the IF THEN ELSE/ELSEIF ENDIF
statements.

Control Statements
Simple Conditional Statements
Syntax
IF condition THEN
statementblock1
ENDIF
or
IF condition THEN
statementblock1
ELSE
statementblock2
ENDIF

Remarks

Argument Description
Condition The condition is made up of points and constants, using relational,
logical or arithmetical notation as a test. The condition can evaluate
Boolean state ‘TRUE’ and ‘FALSE’, Integer or Real numbers, or a text
string.
Statementblock1 One or more statements which are performed if the condition is met.
Statementblock2 One or more statements which are performed if the condition is not
met.

Typical Examples
IF fuel < 0 THEN
fuel = 0
ENDIF
Provided Integer point ‘fuel’ is less than 0, then it is assigned the value 0.
IF burner THEN
fuel = fuel - rate
ENDIF
Provided Boolean point ‘burner’ is ‘‘TRUE’’, then Integer point ‘fuel’ is assigned a new value. It is also
possible to apply ‘IF burner == TRUE THEN’ as the first line, with identical results.

Release 1.1 Page 21

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

IF distance > 630 AND distance < 660 AND lift >= -3 THEN
winner = TRUE
burner = FALSE
ENDIF
Provided that Integer point ‘distance’ is greater in value than 630 AND ‘distance’ is less in value than
660 (i.e. ‘distance’ is a value between 630 and 660) AND point ‘lift’ is greater than or equal to -3, then
Boolean points ‘winner’ and ‘burner’ are assigned new values.
IF burner AND fuel > 0 AND rate > 0 THEN
fuel = fuel - rate
ELSE
lift = 0
altitude = 0
ENDIF
Provided that Boolean point ’burner’ is ‘‘TRUE’’ AND points ‘fuel’ and ‘rate’ are greater in value than 0,
then ‘fuel’ is assigned a new value. Otherwise points ‘lift’ and ‘altitude’ are assigned a new value.

References
Refer to chapter 2, Indentation for details on the layout of code.

Nested Conditional Statements

Syntax
IF conditionA THEN
statementblock1
IF conditionB THEN
statementblock3
ENDIF
ELSE
statementblock2
ENDIF
or
IF conditionA THEN
statementblock1
IF conditionB THEN
statementblock3
ELSE
statementblock4
ENDIF
ELSE
statementblock2
ENDIF
or

Release 1.1 Page 22

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

IF conditionA THEN
statementblock1
ELSEIF conditionB THEN
statementblock3
ENDIF
or
IF conditionA THEN
statementblock1
ELSE
statementblock2
IF conditionB THEN
statementblock3
ELSE
statementblock4
ENDIF
ENDIF

Remarks

Argument Description
conditionA The condition is made up of points and constants, using relational,
logical or arithmetical notation as a test. The condition can evaluate
Boolean state ‘TRUE’ and ‘FALSE’, Integer or Real numbers, or a text
string.
conditionB This condition is nested in the first condition, either on a successful or
unsuccessful evaluation of conditionA. The condition is made up of
points and constants, using relational, logical or arithmetical notation
as a test. The condition can evaluate Boolean state ‘TRUE’ and
‘FALSE’, Integer or Real numbers, or a text string. There is no limit to
the number of nested conditional statements.
statementblock1 One or more statements which are performed if conditionA is met.
statementblock2 One or more statements which are performed if conditionA is not met.
statementblock3 One or more statements which are performed if conditionB is met.
statementblock4 One or more statements which are performed if conditionB is not met.

Typical Examples
IF burner AND fuel > 0 AND rate > 0 THEN
lift = lift + rate/5
ELSE
count = 1
IF altitude > 140 THEN
lift = lift - 0.2
ENDIF
ENDIF

Release 1.1 Page 23

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Provided a successful evaluation has been made to points ‘burner’ AND ‘fuel’ AND ‘rate’, point ‘lift’ is
updated with the current value of rate divided by 5 plus ‘lift’. Otherwise, a further evaluation is
required on point ‘altitude’. If ‘altitude’ is currently greater than 140, then ‘lift’ is decremented by 0.2.
IF burner AND fuel > 0 AND rate > 0 THEN
lift = lift + rate/5
ELSE
IF altitude > 140 THEN
lift = lift - 0.2
ENDIF
ENDIF
IF burner AND fuel > 0 AND rate > 0 THEN
lift = lift + rate/5
ELSEIF altitude > 140 THEN
lift = lift - 0.2
ENDIF
These two examples are identical. The use of the ELSEIF statement combines the ELSE statement
and the IF/ENDIF statements for brevity. It is acceptable to have more than one ELSEIF statement in
an IF THEN ELSE/ELSEIF ENDIF construct.

References
Refer to chapter 4, Punctuation for details of the use of indentation.

Case Select
Syntax
SELECT CASE expression
CASE expression
statementblock1
CASE expression
statementblock2
CASE expression
statementblock3
END SELECT
or
SELECT CASE expression
CASE expression
statementblock1
CASE expression
statementblock2
CASE ELSE
statementblock3
END SELECT

Release 1.1 Page 24

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Description
expression The expression may be a point, or a calculation of constants and/or
points that produces a result.
statementblock1 One or more statements that are only performed if the preceding
CASE expression is met.
statementblock2 One or more statements that are only performed if the preceding
CASE expression is met.
statementblock3 One or more statements that are only performed if the preceding
CASE expression is met.

Typical Examples
SELECT CASE colourvalue
CASE 1
colour (blue)
CASE 2
colour (green)
CASE 3
colour (cyan)
CASE ELSE
colour (0)
END SELECT
This example shows the assignment of a colour according to the value of a point. The value of Integer
point ‘colourvalue’ is evaluated and compared with each case until a match is found. When a match is
found, the sequence of actions associated with the CASE statement is performed. When ‘colourvalue’
is 1, the colour given to the current object is blue, when ‘colourvalue’ is 2, the colour given to the
current object is green, when ‘colourvalue’ is 3, the colour given to the current object is cyan. If
‘colourvalue’ falls outside the integer range 1—3, then the colour given is 0 (black). Like ELSE and
ELSEIF, the CASE ELSE statement is optional.
SELECT CASE TRUE
CASE temperature > 0 AND temperature <= 10
colour (blue)
CASE temperature > 10 AND temperature <= 20
colour (green)
CASE temperature > 20 AND temperature <= 30
colour (red)
CASE ELSE
colour (white)
ENDSELECT
In this example, instead of using a point as the condition as with the previous example, the value is the
condition — in this case Boolean state ‘‘TRUE’’ — with the integer point ‘temperature’ being tested at
each case. If it is ‘‘TRUE’’ that ‘temperature’ is between 0 and 10, then the current object is set to
blue, or if it is ‘‘TRUE’’ that ‘temperature’ is between 11 and 20, then the current object is set to green,
or if it is ‘‘TRUE’’ that ‘temperature’ is between 21 and 30, then the current object is set to red. If none

Release 1.1 Page 25

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

of these CASE statements are met, then the current object is set to white. Like ELSE and ELSEIF,
the CASE ELSE statement is optional.

References
Refer to chapter 4, Object Commands for details of applying attributes to an object and for the use of
the Colour object command. Refer to chapter 6, Colour Palette for details of the Colour Palette colour
designation.

FOR... NEXT Loop

Syntax
FOR pointname = startpt TO endpt STEP steppt
statementblock1
NEXT

Remarks

Argument Description
pointname The pointname to be used as the loop counter.
startpt The initial setting of pointname, and the first value to be used through
the loop.
endpt The last value to be used. The loop ends when pointname exceeds
this value.
steppt Amount to increase pointname by every pass of the loop. Steppt can
be negative to count backwards providing startpt is larger than endpt.
The STEP keyword and variable may be omitted in which case
pointname is incremented at each pass of the loop (identical to adding
STEP 1).

Typical Examples
FOR loopcount = 0 TO 100
RECTANGLE_1.vertical%fill = loopcount
NEXT
In this example, ‘RECTANGLE_1’ is gradually filled 100 times.
FOR loopcount = 100 TO 0 STEP -5
Ellipse_1.vertical%fill = loopcount
NEXT
In this example, the fill for ‘Ellipse_1’ is gradually removed 20 times (100 times/-5).
Note: Loop statements should be used with caution, as they consume processor time while
they are running and some other parts of the system may not be updated.

Release 1.1 Page 26

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

DO WHILE/UNTIL Loop
Syntax
DO WHILE expression
statementblock
LOOP
or
DO
statementblock
LOOP WHILE expression
or
DO UNTIL expression
statementblock
LOOP
or
DO
statementblock
LOOP UNTIL expression

Remarks

Argument Description
expression The expression may be a point, or a calculation of constants and/or
points that produces a result.
statementblock One or more statements to be executed multiple times depending on
expression.

Typical Example
DO WHILE dooropen == TRUE
Message (“You must shut the door before continuing”)
LOOP
DO
nextchar = Mid (Mystring, position, 1)
position = position + 1
LOOP UNTIL nextchar = “A”
Note: Loop statements should be used with caution, as they consume processor time while
they are running and some other parts of the system may not be updated.

Release 1.1 Page 27

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Subroutines
Call
Syntax
CALL subroutine (arguments)

Remarks

Argument Description
subroutine The name of the subroutine defined at project level.
arguments The list of arguments required by the subroutine separated by
commas. Each argument may be a pointname, constant, arithmetical
or logical expression or any valid combination.

Typical Example
CALL MySub ($Second, “Default”, 2 + Int1)

Return
Syntax
RETURN

Typical Example
IF limit > 1000 THEN
RETURN
ELSE
value = limit
ENDIF
REM final part of script
POLYGON_1.COLOUR = red
ELLIPSE_5.WIDTH = value
The integer point ‘limit’ is tested for its value. If its value exceeds 1000, then the condition is met, and
the RETURN command is executed. All statements after the RETURN command are ignored. If the
value of integer point ‘limit’ does not exceed 1000, then the RETURN command is not executed, and
statements after the RETURN command are performed.

References
Refer to the CX-Supervisor User Manual for the use of the RETURN statement for Recipe validation.

Release 1.1 Page 28

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Object Commands
Current Object
Syntax
objectcommand

Remarks

Argument Description
objectcommand • The expression can be made up of the following commands,
which are also described in chapter 4, Object Commands:
• Colour command.
• Disable command.
• Visible command.
• Move command.
• Rotate command.
• Vertical fill command.
• Horizontal fill command.
• Height command.
• Width command.
The content of the commands are made up of arithmetical or logical
expressions, x and y co-ordinates, or references, varying between
commands. The colour command requires a colour identifier.

Typical Example
colour (red)
The current object is specified as red in colour.

References
Refer to:
♦ Chapter 4, Blink for use of the blink command.
♦ Chapter 4, Colour for use of the colour command.
♦ Chapter 4, Disable for use of the disable command.
♦ Chapter 4, Height for use of the height command.
♦ Chapter 4, Horizontal Fill for use of the horizontal fill command.
♦ Chapter 4, Move for use of the move command.
♦ Chapter 4, Rotate for use of the rotate command.
♦ Chapter 4,Vertical Fill for use of the vertical fill command.
♦ Chapter 4, Visible for use of the visible command.
♦ Chapter 4, Width for use of the width command.
♦ The CX-Supervisor User Manual for details of the Animation Editor.

Release 1.1 Page 29

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Other Objects
Syntax
objectname.objectcommand
pagename.objectname.objectcommand

Remarks

Argument Description
objectname This is the name of the object. The object is provided with a generic
name on creation, which can be amended later to something more
meaningful. The script is automatically updated following any
amendment to the object name.
objectcommand This can be made up of the following commands, which are described
in chapter 4, Object Commends:
• Blink command
• Colour command.
• Disable command.
• Visible command.
• Move command.
• Rotate command.
• Vertical fill command.
• Horizontal fill command.
• Height command.
• Width command.
The content of the commands are made up arithmetical or logical
expressions, x and y co-ordinates, or references, varying between
commands. The colour command requires a colour identifier.

Typical Examples
POLYGON_1.colour (red)
POLYGON_1.colour = red
The specified object, ‘POLYGON_1’ is set to be red in colour.

References
Refer to:
♦ CX-Supervisor User Manual for details of object names.
♦ Chapter 4, Blink for use of the blink command.
♦ Chapter 4, Colour for use of the colour command.
♦ Chapter 4, Disable for use of the disable command.

Release 1.1 Page 30

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

♦ Chapter 4, Height for use of the height command.

♦ Chapter 4, Horizontal Fill for use of the horizontal fill command.
♦ Chapter 4, Move for use of the move command.
♦ Chapter 4, Rotate for use of the rotate command.
♦ Chapter 4, Vertical Fill for use of the vertical fill command.
♦ Chapter 4, Visible for use of the visible command.
♦ Chapter 4, Width for use of the width command.

Blink
Syntax
objectname.blink (colour, status)

Remarks

Argument Description
objectname This is the name of the object. Where a script is directly attached to
an object, objectname is not required.
colour Colour to blink to. Some colour values within the colour palette have a
meaningful colourID. This takes the form of the colour name, e.g.,
‘black’ or ‘yellow’. Alternatively, an integer value of 0x1000000 can be
added to a number 0-65 to select a palette entry.
status This argument may be omitted. May be on of:
TRUE – turn blinking On.
FALSE – turn blinking Off.
If omitted, TRUE is assumed.

Typical Examples
blink (red, TRUE)
Start blinking red.
LINE_1.blink(OxFFFFOO, status)
The object LINE_1 starts or stops blinking yellow depending on value of Boolean point ‘status’.

Colour
Syntax
objectname.colour (expression, context)
colour (expression, context)

Release 1.1 Page 31

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

or
objectname.colour (colourID, context)
colour (colourID, context)
An equals sign may be used as an alternative to brackets:
objectname.colour = expression
colour = expression
or
objectname.colour = colourID
colour = expression
Either spelling ‘colour’ or ‘color’ is acceptable.
Note: An equals sign may also be used for most other object commands, even if it is not directly
specified in this manual.

Remarks

Argument Description
objectname This is the name of the object. Where a script is directly attached to
an object, objectname is not required.
expression The expression may be an Integer point, or a calculation of constants
and/or points that produce an Integer value between 0 and 16777215.
This is the desired colour’s RGB value. (format is 0xBBGGRR).
colourID Some colour values within the colour palette have a meaningful
colourID. This takes the form of the colour name, e.g., ‘black’ or
‘yellow’. Alternatively, an integer value of 0x1000000 can be added to
a number 0-65 to select a palette entry.
context This argument is optional an may be omitted. It defines which part of
the object has it’s colour changed. May be one or more of:
@FILL – change fill colour
@FRAME – changes frame colour
If omitted both are changed. Equivalent to @FILL | @FRAME

Typical Examples
TEXT_3.colour (blue)
or
TEXT_3.colour = blue
The object ‘TEXT_3’ is set to blue.
BALL.color (35 + 0x1000000)
The object ‘BALL’ is set to colour 35 from the colour palette.
BALL.colour (0xFF0000,@FILL)
The object ‘BALL’ is set to blue.

Release 1.1 Page 32

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

shade = tint1 + tint2

IF shade > 65 OR shade < 0 THEN
shade = 0
ENDIF
ELLIPSE_1.colour (shade + 0x1000000)
The point ‘shade’ is set to a value based on ‘tint1’ and ‘tint2’, and is tested first to ensure that it is a
value between 0 and 65. If ‘shade’ falls outside this range, then it cannot be applied as a colour to an
object, and is therefore reset to 0 (or black). ELLIPSE_1’ is set to the palette colour of the value of
shade.

References
Refer to chapter 6, Colour Palette for details of colour names and colour numbers.

Disable
Syntax
objectname.disable (expression)

Remarks

Argument Description
objectname This is the name of the selectable object. Where a script is directly
attached to an object, objectname is not required.
expression The expression can be made up of points resulting in ‘TRUE’ or
‘FALSE’.

Typical Examples
disable (TRUE)
The current pushbutton object to which this example applies is disabled.
PUSH_8.disable (count AND flag)
The selectable object ‘PUSH_8’ is disabled provided Integer point ‘count’ AND Boolean point ‘flag’
return ‘‘TRUE’’.

Height
Syntax
objectname.height (expression, context)
objectname.height = expression

Release 1.1 Page 33

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Description
objectname This is the name of the object, following any amendment to the object
name. Where a script is directly attached to an object, objectname is
not required.
expression This is a value, point or an arithmetic expression returning a new
height value in pixels.
context This argument is optional and may be omitted. It defines which part of
the object is the datum, and remains static. May be one of:
@TOP – uses object top as datum.
@CENTRE – uses object centre as datum
@BOTTOM – uses object bottom as datum
If omitted @CENTRE is assumed

Typical Examples
height (100)
or
height = 100
The height of the current object is set to 100.
LINE_1.height (stretch/offset, @top)
The height of object ‘LINE_1’ is changed to the value calculated by points ‘stretch’ and ‘offset’,
keeping the top where it is.

Horizontal Fill
Syntax
objectname.horizontal%fill (expression, context)

Remarks

Argument Description
objectname This is the name of the object. Where a script is directly attached to
an object, objectname is not required.
expression This is an arithmetic expression that must return a value between 0
and 100. On return of a valid result, the fill commences from left to
right.
context This argument is optional and may be omitted. It defines which side of
the object is filled from. May be one of:
@LEFT – fill from the left
@RIGHT – fill from the right
If omitted, @LEFT is assumed

Release 1.1 Page 34

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Examples
horizontal%fill (50)
The current object to which this example applies is filled by 50%.
ELLIPSE_1.horizontal%fill (GAS_LEVEL, @RIGHT)
The object ‘ELLIPSE_1’ is filled from the right, provided the point ‘GAS_LEVEL’ returns a valid result,
between 0 and 100.

Move
Syntax
objectname.move (x co-ordinate, y co-ordinate)

Remarks

Argument Description
objectname This is the name of the object. following any amendment to the object
name. Where a script is directly attached to an object, objectname is
not required.
x co-ordinate The x and y co-ordinates of the origin of the object at its resultant
y co-ordinate position in pixels are specified in the form (x, y). Points alone or as
part of an arithmetic expression may be used as a basis for this
expression.

Typical Examples
move (100, 200)
The current object to which this example applies is moved to the specified position.
POLYGON_1.move (xpos, ypos/5)
The object ‘POLYGON_1’ is moved to the position specified by points ‘xpos’ and ‘ypos’ divided by 5.

Rotate
Syntax
objectname.rotate (angle, context, fixed, xcoord, ycoord)

Release 1.1 Page 35

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Description
objectname This is the name of the object. Where a script is directly attached to
an object, objectname is not required.
angle The angle of rotation can range between 0 to 360 in a clockwise
direction. Points alone, or as part of an arithmetic expression may be
used as an angle.
context This argument is not required and may be omitted. May be one of:
@TOPLEFT – rotate around top left of object
@TOPCENTRE –rotate around top centre of object
@TOPRIGHT – rotate around top right of object
@CENTRELEFT – rotate around centre left of object
@CENTRE – rotate around centre of object
@CENTRERIGHT – rotate around centre right of object
@BOTTOMLEFT – rotate around bottom left of object
@BOTTEMCENTRE – rotate around bottom centre of object
@ BOTTOMRIGHT – rotate around bottom right of object
@USERDEFINED – user defined point specified in xcoord and ycoord.
fixed This argument may be omitted. If this boolean value is true, the
rotation origin is fixed to the screen, even if the object is moved.
Otherwise, the rotation origin is relative to object postion.
xcoord Only required if @USERDEFINED is specified. These integer
ycoord variables specify the rotation origin in pixels

Typical Examples
rotate (45)
The current object to which this example applies is rotated by 45°.
RECTANGLE_1.rotate(tilt, @USERDEFINED, 0, -100, 10)
The object ‘RECTANGLE_1’ is rotated by the value of ‘tilt’, abount a point –100, 10 relative to the
objects current posiotion.
rotate (a * sin(b))
The current object is rotated based on the result of an arithmetic expression involving points named ‘a
and ‘b’.

Vertical Fill
Syntax
objectname.vertical%fill (expression, context)

Release 1.1 Page 36

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Description
objectname This is the name of the object. Where a script is directly attached to
an object, objectname is not required.
expression This is an arithmetic expression that must return a value between 0
and 100. On return of a valid result, the fill commences from bottom to
top.
context This argument may be omitted. May be one of:
@DOWN – Fill object downwards
@UP – Fill object upwards
If omitted, @UP is assumed

Typical Examples
vertical%fill (50)
The current object to which this example applies is filled by 50%.
ELLIPSE_1.vertical%fill (OIL_QUANTITY, @DOWN)
The object ‘ELLIPSE_1’ is filled provided the point ‘OIL QUANTITY’ returns a valid result, between 0
and 100.

Visible
Syntax
objectname.visible (expression)

Remarks

Argument Description
objectname This is the name of the object. Where a script is directly attached to
an object, objectname is not required.
expression The expression can be made up of points resulting in ‘TRUE’ or
‘FALSE’.

Typical Examples
visible (TRUE)
The current object to which this example applies becomes visible.
POLYLINE_8.visible (count AND flag)
The object ‘POLYLINE_8’ is made visible provided Integer point ‘count’ AND Boolean point ‘flag’
return ‘‘TRUE’’.

Release 1.1 Page 37

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Width
Syntax
objectname.width (expression, context)

Remarks

Argument Description
objectname This is the name of the object. Where a script is directly attached to
an object, objectname is not required.
expression This is a value, point or an arithmetic expression returning a new width
value in pixels.
context This argument may be omitted. May be one of:
@LEFT – use left of object as datum.
@CENTRE – use centre of object as datum.
@RIGHT – use right of object as datum.
If omitted, @CENTRE is assumed.

Typical Examples
width (150)
The width of the current object is set to 150.
LINE_1.width (squeeze/offset, @RIGHT)
The width of object ‘LINE_1’ is changed to the value calculated by points ‘squeeze’ and ‘offset’,
keeping the rightmost point fixed.

Page Commands
Display Page
Syntax
display ("pagename")

Remarks

Argument Description
pagename This is the name of the page for display, based on its filename without
the file extension, e.g. the pagename for CAR.PAG is simply ‘CAR’.

Release 1.1 Page 38

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Examples
display ("CAR")
The page ‘CAR.PAG’ is displayed.
textpoint = “CAR”
display(textpoint)
The page ‘CAR.PAG’ is displayed.

Close Page
Syntax
close ("pagename")

Remarks

Argument Description
pagename This is the name of the page for closure, based on its filename without
the file extension, e.g. the pagename for CAR.PAG is simply ‘CAR’.
The pagename for closure must be currently open.

Typical Examples
close("CAR")
The page ‘CAR.PAG’ is closed.
textpoint = “CAR”
close(textpoint)
The page ‘CAR.PAG’ is closed.

General Commands
Exponential
Syntax
result = Exp (value, exponent)

Remarks

Argument Description
result Point name to receive returned result of value raised to the power of
exponent.
value Number to raise.
exponent Power to raise value by.

Release 1.1 Page 39

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example
MSBMask = Exp (2, 15)
15
In this example, ‘MSBMask’ is assigned the value 2 , i.e. 32,768.

PlayOLE
Syntax
returnstate = PlayOLE(“objectname”,OLEVerbNumber)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
objectname string The identifier of the OLE object to be played.
OLEVerbNumber integer The verb number has a specific meaning to the OLE
application. Typical values are:
0: specifies the action that occurs when an end-user
double clicks the object in its container. The object
determines this action (often ‘edit’ or ‘play’).
-1: instructs the object to show itself for editing or viewing.
Usually an alias for some other object-defined verb.
-2: instructs an object to open itself for editing in a window
separate from that of its container.
-3: causes an object to remove its user interface from the
view. Applies only to objects that are activated in-place.
Positive numbers designate object specific verbs.

Typical Example
PlayOLE(“ole_1”,0)
The object ‘ole_1’ is played using its primary verb.

PlaySound
Syntax
returnstate = PlaySound(“soundfile”)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
soundfile string Path of sound file to be played.

Release 1.1 Page 40

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example
PlaySound(“c:\noise.wav”)
The soundfile “c:\noise.wav” is played.

Rand
Syntax
pointname = Rand(upperlimit)

Remarks

Argument Type Description

upperlimit integer The maximum negative or positive integer value that the
Rand function can generate.
pointname Integer Point that contains the integer returned from the Rand
point function.

Typical Example
randomnumber = Rand(upperlimit)
A random integer in the range 0 to upperlimit is returned and contained in the point ‘randomnumber’.
Maximum upperlimit is 32767.
Note: If ‘upperlimit’ is negative then the range is 0 to the negative number.

RunApplication
Syntax
returnstate = RunApplication(“executable”)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
executable string Pathname of executable file.

Typical Example
RunApplication(“c:\myprog.exe”)
The executable file c:\myprog.exe is run.

Release 1.1 Page 41

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

RunHelp
Syntax
returnstate = RunHelp(“helpfile”,helpindex)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
helpfile string Pathname of helpfile to be run.
helpindex integer Index into a help topic as defined by the help file being
run.

Typical Example
RunHelp(“c:\myhelp.hlp”,0)
The helpfile c:\myhelp.hlp is run, and topic 0 shown.

ShutDown
Syntax
returnstate = ShutDown()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
ShutDown()
CX-Supervisor runtime operation is terminated.

Sleep
Syntax
Sleep (duration)

Release 1.1 Page 42

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

Duration --- Number of milliseconds to wait before continuing.

Typical Example
Sleep (1000)
CX-Supervisor waits 1 second.
Note: The sleep statement should be used with caution, as some other parts of the system
may not be updated while a script is sleeping.

Communications Commands
CloseComponent
Syntax
Returnstate = CloseComponent(ComponentName, PLCName)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
ComponentName text A Text point or text constant containing the name of the
component to close.
PLCName text Text point or text constant containing the name of the
PLC that the component to close is attached to.

Typical Examples
CloseComponent(“PLC Data Monitor”, “MyPLC”)
In this example, the PLC Data Monitor component monitoring the PLC ‘MyPLC’ is closed.
Component = “Performance Monitor”
PLC = “PLC06”
OK = CloseComponent(Component, PLC)
In this example, the Performance Monitor component monitoring the PLC ‘PLC06’ is closed. ‘OK’ is
used to determine if the action was successful.

EnableDDE
Syntax
returnstate = EnableDDE(pointname)

Release 1.1 Page 43

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
Pointname bool A Boolean point that holds the required enable/disable
point state

Typical Examples
EnableDDE(result)
DDE functions are enabled based on the value of point ‘result’. If ‘point’ is ‘TRUE’, then DDE is
enabled, if ‘point’ is ‘FALSE’, then DDE is disabled.
EnableDDE(TRUE)
DDE functions can also be enabled directly without using a point to hold the desired status.

EnableOLE
Syntax
returnstate = EnableOLE(pointname)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
Pointname bool A Boolean point that holds the required enable/disable
point state.

Typical Examples
EnableOLE(result)
OLE functions are enabled based on the value of point ‘result’. If result is ‘TRUE’, then OLE is
enabled. If result is ‘FALSE’, then OLE is disabled.
EnableOLE(TRUE)
OLE functions can also be enabled directly without using a point to hold the desired status.

EnablePLC
Syntax
returnstate = EnablePLC(pointname)

Release 1.1 Page 44

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pointname bool A Boolean point that holds the required enable/disable
point state.

Typical Examples
EnablePLC(result)
PLC functions are enabled based on the value of point ‘result’. If result is ‘TRUE’, then PLC functions
are enabled. If result is ‘FALSE’, then they are disabled.
EnablePLC(TRUE)
PLC functions can also be enabled directly without using a point to hold the desired status.

OpenComponent
Syntax
Returnstate = OpenComponent(ComponentName, PLCName)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
ComponentName text A Text point or text constant containing the name of the
component to open.
PLCName text Text point or text constant containing the name of the PLC
that the component to open is attached to.

Typical Examples
OpenComponent(“PLC Data Monitor”, “MyPLC”)
In this example, the PLC Data Monitor component monitoring the PLC ‘MyPLC’ is opened.
Component = “Performance Monitor”
PLC = “PLC06”
OK = OpenComponent(Component, PLC)
In this example, the Performance Monitor component monitoring the PLC ‘PLC06’ is opened. ‘OK’ is
used to determine if the action was successful.

Release 1.1 Page 45

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Point Commands
CancelForce
Syntax
returnstate = CancelForce(pointname)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pointname point Name of point. If the point is an array point then all
elements within the array have the CancelForce
command applied.

Typical Example
CancelForce(point1)
The forcing of values on the point ‘point1’ is cancelled.

References
Refer to PLC operation manuals for a detailed description of Force Set, and Force Reset.

CopyArray
Syntax
CopyArray (SourceArray, DestArray)

Remarks

Argument Type Description

SourceArray --- Name of point array to copy from.
DestArray --- Name of point array to copy to.

Typical Example
InitArray (DestArray, 0)
First initialise ‘DestArray’.
SourceArray [0] = 1
SourceArray [1] = 2
SourceArray [2] = 3

Release 1.1 Page 46

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Then, initialise ‘SourceArray’ to {1, 2, 3}.

CopyArray (SourceArray, DestArray)
Finally, copy the content of the source array ‘SourceArray’ to the destination array ‘DestArray’.
The two arrays do not have to be the same size as each other, for example if ‘DestArray’ contains 20
elements, only elements [0], [1] and [2] are set to 1, 2 and 3 respectively, the remaining elements are
unchanged i.e. O’s. If ‘DestArray’ is smaller than ‘SourceArray’ i.e. it contains two elements then only
elements [0] and [1] are set to 1 and 2 respectively.
Note: ‘CopyArray’ accepts arrays of different type i.e. Boolean arrays can be copied into Real
arrays, the only restriction is that Text arrays cannot be copied into numeric arrays and
vice- versa.

DisableGroup
Syntax
returnstate = DisableGroup(groupname)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
groupname text Name of the group containing the points to disable.

Typical Example
DisableGroup(“<Default>“)
All points belonging to the <Default> group is disabled thus preventing values from being read\written.

DisablePoint
Syntax
returnstate = DisablePoint(pointname)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
Pointname point Name of point to be disabled.

Typical Example
DisablePoint(point1)
The point ‘point1’ is disabled thus preventing values to be read/written.
Note: This is useful for optimisation of communications.

Release 1.1 Page 47

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

EnableGroup
Syntax
returnstate = EnableGroup(groupname)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
groupname text Name of the group containing the points to enable.

Typical Example
EnableGroup(“<Default>“)
All points belonging to the ‘<Default>’ group is enabled thus allowing values to be read\written.

EnablePoint
Syntax
returnstate = EnablePoint(pointname)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pointname point Name of point to be enabled.

Typical Example
EnablePoint(point1)
The point ‘point1’ is enabled thus allowing values to be read/written.

Force
Syntax
returnstate = Force(pointname)

Release 1.1 Page 48

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pointname point Name of point to have force state applied. If the point is
an array point then all elements within the array have the
Force command applied.

Typical Example
Force(point1)
The point ‘point1’ is locked in its current state. i.e. if it is currently set to 1 it cannot be changed until
the forced state is removed via the CancelForce command.

ForceReset
Syntax
returnstate = ForceReset(pointname)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pointname point Name of point. If the point is an array point then all
elements within the array have the ForceReset command
applied.

Typical Example
ForceReset(point1)
The Boolean point ‘point1’ has its value set to ‘FALSE’.

References
Refer to PLC operation manuals for a detailed description of ForceSet, and ForceReset.

ForceSet
Syntax
returnstate = ForceSet(pointname)

Release 1.1 Page 49

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pointname point Name of point. If the point is an array point then all
elements within the array have the ForceSet command
applied.

Typical Example
ForceSet(point1)
The Boolean point ‘point1’ has its value set to ‘TRUE’.

References
Refer to PLC operation manuals for a detailed description of Force Set, and Force Reset.

GetBit
Syntax
returnpoint = GetBit(pointname,bit)

Remarks

Argument Type Description

pointname Integer / This is the name of the point to get the bit value from.
real Indirection or point value may be used.
bit integer This specifies which bit to get the value of.
returnpoint bool This contains the return value ‘TRUE’ or ‘FALSE’.

Typical Example
pointname = 256;
returnpoint = GetBit(pointname,8)
The point ‘returnpoint’ contains ‘TRUE’.

GetPointValue
Syntax
returnpoint = GetPointValue(pointname,offset)

Release 1.1 Page 50

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

pointname point This is the name of the point whose contents are to be
returned.
offset integer This specifies the offset into an array point. 0 if the point
is not an array point.
returnpoint point Point that contains the return value. The type of data
returned is dependant on the pointname specified.

Typical Example
pointname = 10;
returnpoint = GetPointValue(pointname,0)
The point ‘returnpoint’ contains the value 10. The offset is added to any offset specified for
pointname. For example:
returnpoint = GetPointValue(a[10],10)
Causes the 21st element (offsets begin at zero) of array ‘a’ to be retrieved.
Note: It is often simpler to access an array element directly, e.g. returnpoint = a[20].

InitialiseArray
Syntax
InitArray (arrayname, value)

Remarks

Argument Type Description

arrayname --- Name of point array.
value --- Value to set all elements of the array to.

Typical Example
InitArray (MyArray, 0)
In this example, all elements of the array ‘MyArray’ are set to 0.

InputPoint
Syntax
returnstate = InputPoint(pointname, returnflag)

Release 1.1 Page 51

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pointname point The point name whose data is to be read.
returnflag point Optional Boolean point which is set to ‘TRUE’ when value
is returned from the PLC.

Typical Examples
InputPoint(point)
returnflag = FALSE
InputPoint(point, returnflag)
A request is made that the current value of point ‘point’ should be read. In the second example,
returnflag is set to ‘TRUE’ when the value is returned from the PLC.
Note: The value is not returned immediately - it is not possible to use the returned value in the
same script as the InputPoint command. Instead, the value should be accessed from
within an “On Condition” script which has an expression of ‘returnflag = TRUE’.

OutputPoint
Syntax
returnstate = OutputPoint(pointname)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pointname point The point to be updated.

Typical Examples
OutputPoint(result)
The point ‘result’ is updated with its current value.
Note: The value of a point connected to a PLC is not be set if the point is currently in a
“forced” state.

PointExists
Syntax
returnpoint = PointExists(pointname)

Release 1.1 Page 52

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

pointname string This text contains the point name.
returnpoint point Boolean point that contains the return value.

Typical Example
PointName=“Testpoint”
Exists=PointExists(PointName)
The Boolean point ‘Exists’ is set to ‘TRUE’ if a point called ‘TestPoint’ exists.
Note: “PointName” is a text point which can be set to any string value.

SetBit
Syntax
returnstate = SetBit(pointname,bit,value)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pointname integer/ This is the name of the point to set the bit for. Indirection
real or point arrays may be used.
bit integer This specifies the bit to set.
value bool This specifies the value to set the bit to.

Typical Example
testpoint = 0;
SetBit(testpoint,4,TRUE)
The point ‘testpoint’ contains the value 16.

SetPointValue
Syntax
returnstate = SetPointValue(pointname,offset,value)

Release 1.1 Page 53

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pointname point This is the name of the point whose contents are to be
updated. Indirection or point arrays may be used.
offset integer This specifies the offset into an array point. 0 if the point
is not an array point.
value Integer / The new value that the chosen point is to be updated to.
real

Typical Example
SetPointValue(value,0,10)
The point ‘value’ contains the value 10.
Note: The value of a point connected to a PLC is not set if the point is currently in a “forced”
state.
The offset is added to any offset specified for pointname. For instance:
SetPointValue(a[10],10,100)
Causes the 21st element (offsets begin at zero) of array ‘a’ to be set to 100. It is often simpler to
access an array element directly, for instance:
a[20] = 100

PLC Commands
ClosePLC
Syntax
returnstate = ClosePLC(“plcname”)

Remarks

Argument Type Description

returnstate bool 1 if the function is successful otherwise 0.
plcname string Name of PLC to be opened. If the PLC is being accessed
using a communications component, e.g. the Omron CX-
Communications Control this parameter should be the
control name and PLC name separated by a dot e.g.
“OMRONCXCommunicationsControl.controlPLC”.

Release 1.1 Page 54

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example
ClosePLC(“controlPLC”)
The PLC called controlPLC is closed. No further communications with the PLC will take place until it
is reopened.

DownloadPLCProgram
Syntax
returnstate = DownloadPLCProgram(plcname, filename, processed)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
plcname string Name of PLC to download the program to.
filename string Name of the file on disk to download to the PLC. If a drive
and path are not specified, the current directory is
assumed, which may not be the same as the application
directory. If a filename is specified as “” the user is
prompted at runtime for a filename.
processed bool processed is set to ‘TRUE’ when the operation is actually
completed.

Typical Example
DownloadPLCProgram(“controlPLC”, “Prog01.bin”, done)
DO UNTIL done or timeout > 5
Sleep(10)
timeout += 0.01
LOOP
The program stored in the file ‘Prog01.bin’ in the current directory is downloaded to the PLC
‘controlPLC’. Before continuing, the script waits up to five seconds for the action to succeed.
Note: The operation may not be complete immediately after the statement has been
executed. The processed flag ‘done’ is set at a later time when the operation has been
completed. Therefore, if using statements that require the upload to be completed,
either wait for the flag to be set (as shown) or create an On Condition script containing
the code to be executed after the upload, with the processed flag as the expression
(e.g. ‘done’).
Note: This command can only be used when the PLC is in ‘STOP’ mode. Refer to chapter 4,
GetPLCMode or chapter 4, SetPLCMode for further information.

Release 1.1 Page 55

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

GetPLCMode
Syntax
mode = GetPLCMode(“plcname”)

Remarks

Argument Type Description

mode string A Text point containing the current PLC mode. Possible
modes are ‘STOP’, ‘DEBUG’, ‘RUN’, ‘MONITOR’ and
‘UNKNOWN’.
plcname string Name of the PLC.

Typical Example
currentmode = GetPLCMode(“controlPLC”)
In this example, the current mode of the PLC ‘controlPLC’ is stored in the point ‘currentmode’.

OpenPLC
Syntax
Returnstate = OpenPLC(“plcname”, processed)

Remarks

Argument Type Description

returnstate bool 1 if the function is successful otherwise 0.
plcname string Name of PLC to be opened. If the PLC is being accessed
using a communications component, e.g. the Omron CX-
Communications Control this parameter should be the
control name and PLC name separated by a dot e.g.
“OMRONCXCommunicationsControl.controlPLC”.
processed bool Flag set to TRUE when set operation has actually been
completed.

Typical Example
OpenPLC(“controlPLC”, doneopen
DO UNTIL doneopen or timeout > 5
Sleep(10)
timeout += 0.01
LOOP
The PLC called controlPLC is opened for communication.
Note that the PLC may not be opened immediately after the statement has been executed. The
processed flag will be set at a later time when the operation has been completed. Therefore, if using

Release 1.1 Page 56

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

statements which require the operation to be completed, either wait for the flag to be set as shown
above, or create an On Condition script containing the code to be executed after the PLC is opened
with the ‘processed' flag as the expression (this is generally more efficient).

PLCCommsFailed
Syntax
returnstate = PLCCommsFailed(“plcname”)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
plcname string Name of PLC to be checked.

Typical Example
IsFailing = PLCCommsFailed (“controlPLC”)
The point IsFailing is set to true if the PLC called controlPLC is currently not communicating.
Otherwise it is set to false.
Note: This function returns to TRUE from the time when a communications timeout error with
the named PLC occurs, until successful communication with the PLC takes place.

PLCMonitor
Syntax
returnstate = PLCMonitor(“plcname”)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
plcname string Name of PLC to be monitored.

Typical Example
PLCMonitor(“controlPLC”)
The monitor dialog for the PLC called controlPLC is invoked. This dialog can be used to check PLC
status, change mode, etc.

Release 1.1 Page 57

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

SetPLCMode
Syntax
returnstate = SetPLCMode(“plcname”, mode, processed)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
plcname string Name of PLC.
mode string A value for the new PLC mode. Valid modes are ‘STOP’,
‘DEBUG’, ‘RUN’ and ‘MONITOR’.
processed bool processed is set to ‘TRUE’ when the operation is actually
completed.

Typical Examples
SetPLCMode(“controlPLC”, “STOP”, done)
DO UNTIL done or timeout > 5
Sleep(10)
timeout += 0.01
LOOP
In this example, the mode of the PLC called ‘controlPLC’ is changed to “STOP”. Before continuing,
the script waits up to five seconds for the action to succeed.
Note: The mode may not be changed immediately after the statement has been executed.
The processed flag ‘done’ is set at a later time when the operation has been completed.
Therefore, if using statements that require the operation to be completed, either wait for
the flag to be set (as shown) or create an On Condition script containing the code to be
executed after the mode is set, with the processed flag as the expression (e.g. ‘done’).

SetPLCPhoneNumber
Syntax
Returnstate = SetPLCPhoneNumber(“plcname”, numbertext)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
plcname string Name of PLC to change the number of.
numbertext string New phone number for the PLC.

Release 1.1 Page 58

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example
SetPLCPhoneNumber(“controlPLC”, “01234 987654”)
The phone number for the PLC is changed to the required value.

UploadPLCProgram
Syntax
returnstate = UploadPLCProgram(plcname, filename, processed)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
plcname string Name of PLC to upload the program from.
filename string Name of the file on disk to upload the program to. If a
drive and path are not specified, the file is created in the
current directory, which may not be the same as the
application directory. If a filename is specified as “” the
user is prompted at runtime for a filename.
processed bool processed is set to ‘TRUE’ when the operation is actually
completed.

Typical Example
UploadPLCProgram(“controlPLC”, “Prog01.bin”, done)
DO UNTIL done or timeout > 5
Sleep(10)
timeout += 0.01
LOOP
The program in the PLC ‘controlPLC’ is uploaded to the file ‘Prog01.bin’ in the current directory.
Before continuing, the script waits up to five seconds for the action to succeed.
Note: The operation may not be complete immediately after the statement has been
executed. The processed flag ‘done’ is set at a later time when the operation has been
completed. Therefore, if using statements that require the upload to be completed,
either wait for the flag to be set (as shown) or create an On Condition script containing
the code to be executed after the upload, with the processed flag as the expression
(e.g. ‘done’).
Note: This command can only be used when the PLC is in ‘STOP’ mode. Refer to chapter 4,
GetPLCMode or chapter 4, SetPLCMode for further information.

Release 1.1 Page 59

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Temperature Controller Commands

TCAutoTune
Syntax
returnstate = TCAutoTune(TController,mode)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
TController string This is a string representing the name of the temperature
controller.
mode point This is a point depicting the mode of operation and
defines the operation to be carried out when a
TCAutoTune command is issued.
0: Indicates that the auto-tuning operation is to be
stopped.
1: This mode is supported on the E5*K and is used to set
the limit cycle of the manipulated variable change width to
40%.
2: This is used to start the auto-tuning operation.

Typical Example
temp1 = TCAutoTune(“e5ak”,temp2)

TCBackupMode
Syntax
returnstate = TCBackupMode(TController,mode)

Release 1.1 Page 60

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
TController string This is a string representing the name of the temperature
controller.
mode point This is a point depicting the mode of operation and
defines the method used by a temperature controller for
storing internal variables.
0: In this mode variables are stored in RAM and EPROM.
1: In this mode variables are stored in RAM only.

Typical Example
temp1 = TCBackupMode(“ea5k”,temp2)

TCGetStatusParameter
Syntax
returnstate = TCGetStatusParameter(TController,paramID,value)

Release 1.1 Page 61

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
TController string This is a string representing the name of the temperature
controller.
paramID point This is a point depicting the required parameter range 0
to 22:
0: ControlMode.
1: Output.
2: InputShiftDelay (Bool) E5*F, E5*X, E5*J.
3: DisplayUnit.
4: PIDConstantDisplay (Bool) E5*F, E5*X, E5*J.
5: OutputType.
6: CoolingType.
7: Output2.
8: Alarm1.
9: Alarm2.
10: InputType (Integer) E5*F, E5*X, E5*J.
11: OperationMode.
12: BackupMode.
13: AutoTuneMode.
14: OverFlow (Bool) E5*F, E5*X, E5*J.
15: UnderFlow (Bool) E5*F, E5*X, E5*J.
16: SensorMalfunction (Bool) E5*F, E5*X, E5*J.
17: ADConvertorFailure (Bool) E5*F, E5*X, E5*J.
18: RAMAbnormality (Bool) E5*F, E5*X, E5*J.
19: RAMMismatch (Bool) E5*F, E5*X, E5*J.
20: StatusWordsOnly (Bool) E5*K only (TRUE indicates
valid words below).
21: Status0 (word) E5*K only.
22: Status1 (word) E5*K only.
value point, The returned status parameter value. Refer to paramID
real or int above for details.

Typical Example
temp1 = TcGetStatusParameter(“e5ak”,temp2,temp3)

TCRemoteLocal
Syntax
returnstate = TCRemoteLocal(TController,mode)

Release 1.1 Page 62

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
TController string This is a string representing the name of the temperature
controller.
mode point This is a point depicting the mode of operation and
defines the operational mode of a temperature controller.
0: This specifies the temperature controller is in remote
mode.
1: This specifies that the temperature controller is in local
mode.

Typical Example
temp1 = TCRemoteLocal(“e5ak”,temp2)
Note: This command was previously called TCOperationalMode.

TCRequestStatus
Syntax
returnstate = TCRequestStatus(Tcontroller, returnflag)

Remarks

Argument Type Description

returnstate Bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
TController String This is a string representing the name of the temperature
controller.
returnflag Point This is a point depicting that the status has been returned
and is available for the command TCGetStatusParameter.

Typical Example
temp1 = TCRequestStatus(“e5ak”, temp2)
Note: The status information is NOT returned immediately - it is not possible to access the
status information in the same script as the TCRequestStatus command. Instead, the
status information should be accessed from within an “On Condition” script which has
an expression of “returnflag == TRUE”.

Release 1.1 Page 63

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

TCRspLsp
Syntax
returnstate = TCRspLsp(Tcontroller,mode)

Remarks

Argument Type Description

returnstate Bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
TController String This is a string representing the name of the temperature
controller.
mode Point This is a point depicting the mode of operation and
defines the setpoint mode used by the temperature
controller.
0: This specifies remote setpoint mode.
1: This specifies local setpoint mode.

Typical Example
temp1 = TCRspLsp(“e5ak”,temp2)
Note: This command was previously called TCSetpoint.

TCRunStop
Syntax
returnstate = TCRunStop(TController,mode)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
TController string This is a string representing the name of the temperature
controller.
mode point This is a point depicting the mode of operation and
defines either auto-output mode shift or manual output
mode shift.
0: This specifies manual output mode shift.
1: This specifies auto-output mode shift.

Release 1.1 Page 64

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example
temp1 = TCRunStop(“e5ak”,temp2)
Note: This command was previously called TCModeShift.

TCSaveData
Syntax
returnstate = TCSaveData(TController)

Remarks

Argument Type Description

returnstate Bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
TController String This is a string representing the name of the temperature
controller.

Typical Example
temp1 = TCSaveData(“e5ak”,temp2)

TCSettingLevel1
Syntax
returnstate = TCSettingLevel1(TController)

Remarks

Argument Type Description

returnstate Bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
TController String This is a string representing the name of the temperature
controller.

Typical Example
temp1 = TCSettingLevel1(“e5ak”)

TCReset
Syntax
returnstate = TCReset(TController)

Release 1.1 Page 65

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate Bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
TController String This is a string representing the name of the temperature
controller.

Typical Example
temp1 = TCReset(“e5ak”)

DDE Commands
DDEExecute
Syntax
returnstate = DDEExecute(channel, {command})

Remarks

Argument Type Description

returnstate Bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
channel Integer This is an integer point which contains the return value of
point the DDEInitiate() command. Both server and topic
parameters applied to the channel based on the
DDEInitiate() command must be open or an error is
reported.
command String This is a command as recognised by the server
application specified within the channel.

Typical Example
channelname = DDEInitiate("Excel", "Sheet1.xls")
DDEExecute(channelname, {[OPEN("C:\EXCEL\WORK\SHEET2.XLS")]})
The file ‘SHEET2.XLS’ within path ‘C:\EXCEL\WORK’ is opened in Microsoft Excel, as specified by
the Integer point ‘channelname’. The file ‘SHEET1.XLS’ is already open in Microsoft Excel.

DDEInitiate
Syntax
channel = DDEInitiate("server", topic")

Release 1.1 Page 66

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

channel Integer This is an integer point which contains the return value of
point the DDEInitiate() command.
server String This contains the application that supports DDE as a DDE
server. Typically, this is the name of the applications’
*.EXE executable file without the filename extension. At
runtime, the server application must be open or a value
cannot be returned and an error is reported.
topic String This contains the name of the topic recognised by the
server application. Typically, a topic is a document within
an application. At runtime, the topic must be open or a
value cannot be returned and an error is reported.
The topic may be left empty, which enables documents to
open remotely prior to making a specified connection.
The topic name ‘System’ may be used to find out which
other topics within the server application are available.
However, this is dependant on the server application
supporting this topic.

Typical Example
channelname = DDEInitiate("Excel", "Sheet1.xls")
The Integer point ‘channelname’ is provided with a DDE link to the application Microsoft Excel which is
run by the executable filename ‘EXCEL.EXE’, and to the file ‘SHEET1.XLS’ within that application.

DDEOpenLinks
Syntax
returnstate = DDEOpenLinks(channel)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
channel Integer This is an integer point which contains the return value of
point the DDEInitiate() command. Both server and topic
parameters applied to the channel in the DDEInitiate()
command must be open or an error is reported.

Typical Example
channelname = DDEInitiate("Excel", "Sheet1.xls")
DDEOpenLinks(channelname)

Release 1.1 Page 67

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

The DDEOpenLinks command enables points which have been configured to communicate via DDE
to begin data transfer. Data transfer between CX-Supervisor and the application Microsoft Excel is
automatically maintained until the channel is closed either by Microsoft Excel or by the command
DDETerminate() using the Integer point ‘channelname’, or the command DDETerminateAll().

DDEPoke
Syntax
returnstate = DDEPoke(channel, "item", pointname)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
channel Integer This is an integer point which contains the return value of
point the DDEInitiate() command. Both server and topic
parameters applied to the in the DDEInitiate() command
must be open or an error is reported.
item string This is an item as recognised by the server application.
For instance, a cell is an item within a spreadsheet
application. Likewise, a page is an item for a word
processing application. It is wholly dependant on the
server application
pointname point This is a point whose attributes must include a DDE
Access of ‘Read/Only’ or ‘Read/Write’. The contents of
this point are assigned to the server application.

Typical Example
channelname = DDEInitiate("Excel", "Sheet1.xls")
DDEPoke(channelname, "R2C5", data)
The content of point ‘data’ is sent to row 2, column 5 of ‘SHEET1.XLS’ in the Microsoft Excel
application. The Microsoft Excel application, and ‘SHEET1.XLS’ are specified by Integer point
‘channelname’.

References
Refer to the CX-Supervisor User Manual for details of DDE Access.

DDERequest
Syntax
pointname = DDERequest(channel, "item")

Release 1.1 Page 68

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

channel Integer This is an integer point which contains the return value of
point the DDEInitiate() command. Both server and topic
parameters applied to the channel in the DDEInitiate()
command must be open or an error is reported.
item string This is an item as recognised by the server application.
For instance, a cell is an item within a spreadsheet
application. Likewise, a page is an item for a word
processing application. It is wholly dependant on the
server application.
pointname point This is a point whose attributes must include a DDE
Access of ‘Read/Write’.

Typical Example
channelname = DDEInitiate("Excel", "Sheet1.xls")
cellref = DDERequest(“channelname”, "R2C5")
The point ‘cellref’ is filled from a specific item, row 2, column 5 from ‘SHEET1.XLS’ from the Microsoft
Excel application, specified by the Integer point ‘channelname’.

References
Refer to the CX-Supervisor User Manual for details of DDE Access.

DDETerminate
Syntax
returnstate = DDETerminate(channel)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
channel Integer This is an integer point which contains the return value of
point the DDEInitiate() command. Both server and topic
parameters applied to the channel in the DDEInitiate()
command must be open or an error is reported.

Typical Example
DDETerminate(channelname)
The server and topic specified by Integer point ‘channelname’ is closed.

Release 1.1 Page 69

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

DDETerminateAll
Syntax
returnstate = DDETerminateAll()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
DDETerminateAll()
All previously initiated DDE links are closed.

Alarm Commands
AcknowledgeAlarm
Syntax
returnstate = AcknowledgeAlarm(“alarmname”)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
alarmname string This is the identifier of the alarm.

Typical Example
AcknowledgeAlarm(“temphigh”)
The alarm ‘temphigh’ is acknowledged.

References
Refer to the CX-Supervisor User Manual for details of alarms.

AcknowledgeAllAlarms
Syntax
returnstate = AcknowledgeAllAlarms()

Release 1.1 Page 70

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
AcknowledgeAllAlarms()
All alarms are acknowledged.

References
Refer to the CX-Supervisor User Manual for details of alarms.

AcknowledgeLatestAlarm
Syntax
returnstate = AcknowledgeLatestAlarm()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
AcknowledgeLatestAlarm()
The most current alarm of the highest priority is acknowledged.

References
Refer to the CX-Supervisor User Manual for details of alarms.

ClearAlarmHistory
Syntax
returnstate = ClearAlarmHistory()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Release 1.1 Page 71

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example
ClearAlarmHistory()
The alarm history window is cleared and the log is cleared.

References
Refer to the CX-Supervisor User Manual for details of alarms.

CloseAlarmHistory
Syntax
returnstate = CloseAlarmHistory()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
CloseAlarmHistory()
The alarm history window is closed.

References
Refer to the CX-Supervisor User Manual for details of alarms

CloseAlarmStatus
Syntax
returnstate = CloseAlarmStatus()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
CloseAlarmStatus()
The current alarm status window is closed.

Release 1.1 Page 72

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

References
Refer to the CX-Supervisor User Manual for details of alarms.

DisplayAlarmHistory
Syntax
returnstate = DisplayAlarmHistory()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
DisplayAlarmHistory()
The alarm history window is displayed.

References
Refer to the CX-Supervisor User Manual for details of alarms.

DisplayAlarmStatus
Syntax
returnstate = DisplayAlarmStatus()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
DisplayAlarmStatus()
The current alarm status is displayed.

References
Refer to the CX-Supervisor User Manual for details of alarms.

Release 1.1 Page 73

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

EnableAlarms
Syntax
EnableAlarms (flag, “message”)

Remarks

Argument Type Description

flag --- If set ‘TRUE’ then alarm logging is enabled. If set
‘FALSE’ logging is disabled.
message --- Text message which is recorded in the alarm log to
indicate change of status.

Typical Example
EnableAlarms (TRUE, “Alarm logging enabled”)

References
Refer to the CX-Supervisor User Manual for details of alarms.

IsAlarmAcknowledged
Syntax
pointname = IsAlarmAcknowledged("alarmname")

Remarks

Argument Type Description

pointname bool The Boolean point name to be assigned a value based on
point the test of an acknowledged alarm.
alarmname string The identifier of the alarm.

Typical Example
acknowledged = IsAlarmAcknowledged("temptoohigh")
The point ‘acknowledged’ is assigned Boolean state ‘‘TRUE’’ if the ‘temptoohigh’ alarm is currently
acknowledged. The point is assigned Boolean state ‘FALSE’ if the alarm is not currently
acknowledged.

References
Refer to the CX-Supervisor User Manual for details of alarms.

Release 1.1 Page 74

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

IsAlarmActive
Syntax
pointname = IsAlarmActive("alarmname")

Remarks

Argument Type Description

pointname bool The Boolean point name to be assigned a value based on
point the test of an active alarm.
alarmname string The identifier of the alarm.

Typical Example
active = IsAlarmActive("temptoohigh")
The point ‘active’ is assigned Boolean state ‘‘TRUE’’ if the ‘temptoohigh’ alarm is currently active. The
point is assigned Boolean state ‘FALSE’ if the alarm is not currently active.

References
Refer to the CX-Supervisor User Manual for details of alarms.

File Commands
CloseFile
Syntax
returnstate = CloseFile(pointname)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pointname bool A Boolean point that holds the required status of whether
blank spaces should be stripped from the file when it is
closed.

Typical Examples
CloseFile(status)
The currently open file is closed. Blank spaces at the end of each line are stripped from the file if the
Boolean point ‘status’ is set to ‘TRUE’.
CloseFile(FALSE)

Release 1.1 Page 75

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

In this example, the currently open file is closed and any blank spaces are not stripped from the file.
Note: If blank spaces are stripped from the file, then it greatly reduces in size but it takes
slightly longer to close. Blank spaces should not be stripped from the file if it is being
used on a network drive by more than one system at a time.

CopyFile
Syntax
returnstate = CopyFile(“sourcename”, “destname”)

Remarks

Argument Type Description

Returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise
sourcename string Pathname of file to be copied. May include a “*” wildcard
character.
destname string Pathname of destination of copy. If path name does not
exist it is created.

Typical Example
CopyFile(“c:\autoexec.bat”, “c:\autoexec.old”)
The file “c:\autoexec.bat” is copied to the file “c:\autoexec.old”.
CopyFile(“c:\logging\*.dlv”, “a:\backup”)
The data log files (ending in dlv) in “C:\logging” are copied to the “\backup” directory on drive A:

DeleteFile
Syntax
returnstate = DeleteFile(“filename”)

Remarks

Argument Type Description

Returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
Filename string Pathname of file to be deleted.

Typical Example
DeleteFile(“c:\pagename.pag”)
The file “c:\pagename.pag” is deleted.

Release 1.1 Page 76

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

EditFile
Syntax
returnstate = EditFile(“filename”)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
filename string Pathname of the file to be edited.

Typical Example
EditFile(“C:\report3.txt”)

FileExists
Syntax
returnpoint = FileExists (filename)

Remarks

Argument Type Description

filename string This text string contains the file name.
returnpoint point Boolean point that contains the return value.

Typical Example
FileName = “TEST.TXT”
Exists = FileExists(FileName)
The Boolean point ‘Exists’ is set to ‘TRUE’ if a file called ‘C:\TEST.TXT’ exists.
Note: “FileName” is a text point which can be set to any string value.

MoveFile
Syntax
returnstate = MoveFile(“sourcename”, “destname”)

Release 1.1 Page 77

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

Returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
sourcename string Pathname of file to be moved.
destname string Pathname of destination of move.

Typical Example
MoveFile(“c:\autoexec.bat”, “c:\autoexec.old”)
The file “c:\autoexec.bat” is moved to the file “c:\autoexec.old”.

OpenFile
Syntax
returnstate = OpenFile(“filename”)

Remarks

Argument Type Description

Returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
Filename string Pathname of file to be opened.

Typical Example
OpenFile(“c:\filename.csf”)
The file “c:\filename.csf” is opened and able to be accessed by the Read() and Write() script
commands. Only one file can be open at a time. Files can be shared (for instance located on a
network drive, and accessed by several running CX-Supervisor applications simultaneously - this can
be used for data exchange).

PrintFile
Syntax
returnstate = PrintFile(“filename”)

Remarks

Argument Type Description

Returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
Filename string Pathname of file to be printed.

Release 1.1 Page 78

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example
PrintFile(“c:\autoexec.bat”)
The file “c:\autoexec.bat” is sent to the currently configured printer.
Script commands that have textual arguments can take either literal strings within quotes or text
points.
Note: CX-Supervisor uses the OLE registration information (file extension associations) to
decide how to print a file. It invokes the parent application associated with a particular
file extension, instructing the application to start minimised and passing the “print”
command. For example, if the file extension .txt is associated with Notepad, then
Notepad is invoked to print the file.

Read
Syntax
returnstate = Read(RecordId, pointname, ...)

Remarks

Argument Type Description

Returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
RecordId integer An index into the file.
Pointname point Name(s) of point(s) to be updated with the data read from
the open file.

Typical Examples
Read(1, value)
The point ‘value’ is loaded with the value read from the currently open file using the value of 1 as an
index into the file.
ReadOK = Read(indexno, value1, value2, value3)
The points ‘value1’, ‘value2’, ‘value’ are loaded using the value of indexno as an index into the file.
Pass or fail status is stored in ‘ReadOK’.
Note: It is advisable to use a RecordId less than 1024 whenever possible, in order to optimise
file access time (records 0 to 1023 are cached).

ReadMessage
Syntax
returnstate = ReadMessage (“filename”, offset, textpoint, noofchars)

Release 1.1 Page 79

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

Returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
Filename string Pathname of file to be read.
Offset integer An offset from the beginning of the file (in characters )
indicating where to start reading from.
Textpoint text The text point which holds the characters read from the
point file.
Noofchars integer The number of characters to read from the file.

Typical Example
ReadMessage (“C:\CX-SUPERVISOR\TESTFILE.TXT”, 0, TextPoint, 20)
The first 20 characters are be read from the file “C:\CX-SUPERVISOR\TESTFILE.TXT” and stored in
the point ‘TextPoint’.
Note: Text points can hold up to 256 characters therefore a maximum of 256 characters can
be read from the file.

SelectFile
Syntax
filename = SelectFile (filter, path)

Remarks

Argument Type Description

Filename --- Text string returned. Contains fully qualified filename
including drive and path if OK was selected from OpenFile
comms dialog, otherwise contains empty string.
Filter string Optional argument. If ommitted, will show all files. This
argument must be supplied if path is specified i.e. set to
“”. Specifies the filter string used by the ‘Files of type’ list.
The string should contain 1 or more filters separated with
a ‘|’ (pipe) character and end with 2 characters i.e. ‘||’.
Each filter should have some user text and 1 or more
filespecs seperated with a semicolon. No spaces should
be used, except within the user text.
Path string Optional argument. Specifies the path to show initally. If
ommitted, the dialog shows the current working directory.

Release 1.1 Page 80

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example
TFile = SelectFile()
The ‘File Open’ dialog will be displayed, showing all files in the current working directory. The users
choice will be stored in tFile.
TFile = SelectFile(“Text Files (*.txt)|*.txt||”)
The ‘File Open’ dialog will be displayed, showing just files with a .txt extension in the current working
directory.
TFile = SelectFile(“Text Files (*.txt; *.csv)|*.txt;*.csv||”)
The ‘File Open’ dialog will be displayed, showing files with either a .txt or .csv extension in the current
working directory.
TFile = SelectFile(“Text Files (*.txt;
*.csv)|*.txt;*.csv|Document Files (*.doc)|*.doc||”)
In this example, the ‘Files of type’ filter has 2 choices: one to show text files (i.e. both .txt and .csv
files), and one to show document files (just .doc files).
TFile = SelectFile(“”, “C:\WINDOWS”)
The ‘File Open’ dialog will be displyed, showing all files in the “C:\WINDOWS” directory.

Write
Syntax
returnstate = Write(RecordId, pointname, ...)

Remarks

Argument Type Description

Returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
RecordId integer An index into the file.
Pointname point Name(s) of point(s) containing data to write to the open
file.

Typical Examples
WroteOK = Write(indexno, $Second)
The point ‘$Second’ is written to the currently open file using the value of indexno as an index into the
file. Pass or fail status is stored in ‘WroteOK’.
Write(2, $Second, $Minute, $Hour)
The points ‘$Second’, ‘$Minute’, ‘$Hour’ are written to the currently open file using the value 2 as an
index into the file.

Release 1.1 Page 81

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Note: It is advisable to use a RecordId less than 1024 whenever possible, in order to optimise
file access time (records 0 to 1023 are cached).

WriteMessage
Syntax
returnstate = WriteMessage(“filename”, offset, “text”, linefeed)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
filename string Pathname of file to be written.
offset integer An offset from the beginning of the file (in characters)
indicating where to start writing. If the offset is -1 then the
message is appended to the end of the file.
text string The text to be written into the file.
linefeed bool A flag to indicate a carriage return and line feed should be
appended.

Typical Example
WriteMessage(“C:\CX-SUPERVISOR\TESTFILE.TXT”, 0, “Hello World”, TRUE)
The text ‘Hello World’ is written at the start of the ‘C:\CX-SUPERVISOR\TESTFILE.TXT’ file and a
carriage return and line feed is appended which moves and subsequent text to the start of the next
line.
Note: When the text is written into the file it overwrites any existing text that may exist at this
location.

Graph Commands
ClearGraph
Syntax
returnstate = ClearGraph(“graphid”, ”pagename”)

Release 1.1 Page 82

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
graphid string The identifier of the trend or scatter graph to be cleared.
pagename string Optional parameter indicating the name of the page that
the graph is on.

Typical Examples
ClearGraph(“Graph_1”, “TestPage1”)
The trend or scatter graph on ‘TestPage1’ with the identifier ‘Graph_1’ has its data cleared.
ClearGraph (“Graph_2”)
The trend or scatter graph on the current page, with the identifier ‘Graph_2’, has its data cleared.

EditGraph
Syntax
returnstate = EditGraph(“graphid”)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
graphid string The identifier of the trendgraph to be edited.

Typical Example
EditGraph(“Graph_1”)
The Edit Graph dialog is displayed offering options to view historical data for the chosen trend graph.
♦ Display Data loads the currently selected data sample i.e. either the current screen data or a
snapshot of the data, into the trend graph.
♦ Snapshot stores the current data buffer associated with the trend graph. The snapshot is given a
timestamped default description.
♦ Description provides the ability to change the description associated with the snapshot.
♦ Import Data provides the ability to load in a previously saved trend graph file.
♦ Export Data provides the ability to store a snapshot to a file, either in internal CX-Supervisor
format, or as a text file that can be imported into other applications.
♦ Delete removes the currently selected snapshot.

Release 1.1 Page 83

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Note: This command is provided for compatability with SCS v2.0 applications. For newer
applications the data logging facilities should be used in preference.
Note: This command can only be used if the trend is set to log to a file.

SaveGraph
Syntax
returnstate = SaveGraph(“graphid”)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
graphid string The identifier of the trend to be saved.
pagename string Optional parameter indicating the name of the page that
the graph is on.

Typical Examples
SaveGraph(“Graph_1”, “TestPage1”)
The trend graph on the page ‘TestPage’ with the identifier ‘Graph_1’ has its data saved to disc.
SaveGraph(“Graph_2”)
The trend graph on the current page with the identifier ‘Graph_2’ has its data saved to disc.

Snapshot
Syntax
returnstate = Snapshot(“graphid”, “pagename”)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
graphid string The identifier of the trend graph to have a snapshot
pagename string Optional parameter indicating the name of the page that
the graph is on.

Typical Examples
Snapshot(“Graph_1”, “TestPage1”)

Release 1.1 Page 84

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

The current data in trend graph ‘Graph1’ on ‘TestPage1’, is stored and is able to be viewed via the
EditGraph command.
Snapshot(“Graph_2”)
The current data in trend graph ‘Graph1’ on the current page, is stored and is able to be viewed via
the EditGraph command.
Note: This command is provided for compatability with SCS v2.0 applications. For newer
applications the data logging facilities should be used in preference.

StartGraph
Syntax
returnstate = StartGraph(“graphid”, “pagename”)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
graphid string The identifier of the trend or scatter graph to be started.
pagename string Optional parameter indicating the name of the page that
the graph is on.

Typical Examples
StartGraph(“Graph_1”, “TestPage1”)
The trend or scatter graph on ‘TestPage1’ with the identifier ‘Graph_1’ has its data logging started.
StartGraph(“Graph_2”)
The trend or scatter graph on the current page with the identifier ‘Graph_2’ has its data logging
started.
Note: This command is provided for compatability with SCS v2.0 applications. For newer
applications the data logging facilities should be used in preference.

StopGraph
Syntax
returnstate = StopGraph(“graphid”, “pagename”)

Release 1.1 Page 85

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
graphid string The identifier of the trend or scatter graph to be stopped.
pagename string Optional parameter indicating the name of the page that
the graph is on.

Typical Examples
StopGraph(“Graph_1”, “TestPage1”)
The trend or scatter graph on ‘TestPage1’ with the identifier ‘Graph_1’ has its data logging stopped.
StopGraph(“Graph_2”)
The trend or scatter graph on the current page with the identifier ‘Graph_2’ has its data logging
stopped.

Recipe Commands
DisplayRecipes
Syntax
returnstate = DisplayRecipes()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
DisplayRecipes()
The current recipes is displayed.

References
Refer to the CX-Supervisor User Manual for details of recipes.

DownloadRecipe
Syntax
returnstate = DownloadRecipe(“recipename”)

Release 1.1 Page 86

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
recipename string The name of the recipe to be downloaded.

Typical Example
DownloadRecipe(“recipe1”)
The recipe ‘recipe1’ is downloaded.

References
Refer to the CX-Supervisor User Manual for details of recipes.

UploadRecipe
Syntax
returnstate = UploadRecipe(“recipename”, processed)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
recipename string The name of the recipe to be uploaded.
processed bool Flag set to true when operation has been completed.

Typical Example
UploadRecipe(“recipe1”,done)
The recipe ‘recipe1’ is uploaded, and point ‘done’ is set True when the upload is complete.

References
Refer to the CX-Supervisor User Manual for details of recipes.

Report Commands
GenerateReport
Syntax
returnstate =
GenerateReport(ReportTemplateFile,ReportOutputFile)

Release 1.1 Page 87

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
ReportTemplateFile string Pathname of the report template file.
ReportOutputFile string Pathname of the report output file.

Typical Example
GenerateReport(“report3.txt”,“output.txt”)

PrintReport
Syntax
returnstate = Printreport(ReportTemplateFile)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
ReportTemplateFile string Pathname of the report template file.

Typical Example
PrintReport(“report3.txt”)
The ReportTemplateFile report3.txt contains a predefined set of point names and text laid out exactly
as the report reader likes to view them. The point names contained within enclosing characters are
the CX-Supervisor names for the data that is required in the report.
The enclosing characters can be changed in the Project/Runtime Setting/Report setting dialog box,
but once set must be fixed for all reports generated by the project.
The file can be written using any ASCII text editor, for instance a Text file (.TXT), a Rich Text file
(.RTF) or a Hypertext file (.HTML) .
Examples of the way in which text is changed:
The shift foreman was ((ShiftForeman))
Becomes:
The shift foreman was Fred Smith
The shift output was ((ShiftOutput)) litres
Becomes:
The shift output was 5000 litres
Format specifiers can be used:

Release 1.1 Page 88

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

%s for text string points;

%d for integer points;
%f for real floating points.
Where ‘MyTextpoint=“Hello”’:
The text of ((“My text point is %s”,Mypoint))
Becomes:
The text of My text point is Hello
Where MyRealpoint=5467.7658:
To two decimal places the value of MyRealpoint is
((“%4.2f”,MyRealpoint))
Becomes:
To two decimal places the value of MyRealpoint is 5467.76
Combinations of format specifiers are possible:
((%s to two decimal places the value of MyRealpoint is
%4.2f”,MyTextpoint,MyRealpoint))
Becomes:
Hello to two decimal places the value of MyRealpoint is 5467.76

ViewReport
Syntax
returnstate = ViewReport(ReportTemplateFile)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
ReportTemplateFile string Pathname of the report template file.

Typical Example
ViewReport(“report3.txt”)

Release 1.1 Page 89

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Text Commands
BCD
Syntax
result = BCD (value)

Remarks

Argument Type Description

Value --- Number to convert to Binary Coded Decimal (BCD).
result --- String containing BCD representation of value.

Typical Example
BCDStr = BCD(39)
In this example, ‘BCDstr’ contains ‘00111001’.

Bin
Syntax
result = Bin (value)

Remarks

Argument Type Description

value --- Number to be converted to a binary number.
result --- String containing binary representation of value.

Typical Example
BStr = Bin (20)
In this example, ‘Bstr’ contains ‘10100’.

Chr
Syntax
result = Chr (value)

Release 1.1 Page 90

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

value --- Extended ASCII value to convert to a character.
result --- String containing single character representation of value.

Typical Example
Char = Chr(65)
In this example, ‘Char’ contains ‘A’.

FormatText
Syntax
textpoint = FormatText (“formattext”, expression, ...)

Remarks

Argument Type Description

textpoint text A text point which holds the formatted text.
point
formattext string The text (with appropriate formatting characters) that the
result expression is inserted into.
expression Integer / The value(s) or expression(s) that is inserted into
real formattext.

Typical Examples
TextPoint = FormatText (“Boiler temperature is %ld degrees.”,
BoilerTemp)
The value of the ‘BoilerTemp’ point is inserted into the specified text at the position marked by the
formatting characters (%ld) and then stored in the point ‘TextPoint’.
If the value of ‘BoilerTemp’ was 57 then the resultant text that is stored in ‘TextPoint’ is as follows:
“Boiler temperature is 57 degrees.”
TextPoint = FormatText (“Boiler %ld temperature is %ld degrees.”,
BoilerNo, BoilerTemp)
The value of ‘BoilerNo’ point is inserted at the first ‘%ld’ marker and the value of the ‘BoilerTemp’ point
is inserted at the second ‘%ld’ marker and the resulting string is stored in the point ‘TextPoint’.
If the value of ‘BoilerNo’ was 7 and the value of ‘BoilerTemp’ was 43 then the resultant text stored in
the ‘TextPoint’ is as follows:
“Boiler 7 temperature is 43 degrees.”

Release 1.1 Page 91

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Note: The formatting characters are standard ‘C’ formatting characters (as used by the C-
language sprintf function). Some commonly used types are:
♦ %ld. Insert integer value;
♦ %f. Insert decimal value. Prefix with decimal point and number to control position
(for instance ‘%.2f’ for 2 decimal places);
♦ %s. Insert string;
♦ %IX. Insert hexadecimal value (upper case HEX characters, for instance ‘FFFF’);
♦ %lx. Insert hexadecimal value (lower case HEX characters, for instance ‘ffff’);
♦ %c. Insert character (can be used to convert value to character, for instance to
insert control character).
With the text left aligned, and with a width field (for instance ‘%-6ld’ to insert a value left aligned with a
field 6 characters wide).

References
More complex expressions (for instance controlling justification, decimal places, number base, etc.)
are also possible. Refer to any C language reference book for full details of the format used by the
‘sprintf’ function.

GetTextLength
Syntax
value = GetTextLength (textpoint)

Remarks

Argument Type Description

textpoint text This is the point which has its text length counted.
returnpoint Integer / This is the point that holds the return value.
real

Typical Example
textpoint = “Hello World”
count = GetTextLength (textpoint)
The number of characters in ‘textpoint’ is counted and the point ‘count’ is set to the value 11.

Hex
Syntax
result = Hex (value)

Release 1.1 Page 92

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

Value --- Number to be converted to a Hex number.
Result --- String containing Hex representation of value.

Typical Example
HStr = Hex (44)
In this example, ‘Hstr’ contains ‘2C’.

Left
Syntax
lefttext = Left(textpoint,noofchars)

Remarks

Argument Type Description

textpoint text The text point containing the string that is to be
manipulated.
noofchars integer The number of characters to extract from the start of the
string.
lefttext text Text point containing the specified range of characters.

Typical Example
textpoint = “abcdefgh”
lefttext = Left(textpoint,3)
The text point ‘lefttext’ contains the string ‘abc’.

Message
Syntax
Message(“message”)

Remarks

Argument Type Description

message string Contains the text string that is displayed in the message
box.

Typical Example
Message(“this is a message”)
The message ‘this is a message’ is displayed in a Message Box.

Release 1.1 Page 93

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Mid
Syntax
midtext = Mid(textpoint,offset,noofchars)

Remarks

Argument Type Description

textpoint text The text point containing the string that is to be
manipulated.
offset integer The zero based index of the first character in the string
that is to be included in the extract.
noofchars integer The number of characters to extract from the string.
midtext text Text point containing the specified range of characters.

Typical Example
textpoint = “abcdefgh”
midtext = Mid(textpoint,3,2)
The text point ‘midtext’ contains the string ‘de’.

PrintMessage
Syntax
PrintMessage (“message”)

Remarks

Argument Type Description

message string Contains the text string that is sent to the printer.

Typical Example
PrintMessage (“Print this message”)
The message ‘print this message’ is printed to the configured ‘Alarm/message printer’, queued if
operating in page mode, or printing has been disabled by the EnablePrinting command.

References
Refer to the CX-Supervisor User Manual for further details to configure the ‘Alarm/message printer’.

Right
Syntax
righttext = Right(textpoint,noofchars)

Release 1.1 Page 94

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

textpoint text The text point containing the string that is to be
manipulated.
noofchars integer The number of characters to extract from the end of the
string.
righttext integer Text point containing the specified range of characters.

Typical Example
textpoint = “abcdefgh”
righttext = Right(textpoint,3)
The text point ‘righttext’ contains the string ‘fgh’.

TextToValue
Syntax
valuepoint = TextToValue(textpoint)

Remarks

Argument Type Description

textpoint text The text point containing the string that is to be converted
into a number.
valuepoint integer A point containing the value returned after conversion
from a string.

Typical Examples
textpoint = “10”
valuepoint = TextToValue(textpoint)
The value 10 is assigned to the point ‘valuepoint’.
textpoint = “10.34”
realpoint = TextToValue(textpoint)
The real value 10.34 is assigned to the real point ‘realpoint’.

ValueToText
Syntax
textpoint = ValueToText(value)

Release 1.1 Page 95

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

value integer The number that is to be placed into the textpoint. A point
name is also a valid parameter.
textpoint text point A text point containing the value converted into a string.

Typical Examples
textpoint = ValueToText(10)
The value 10 is put into a string and assigned to the text point ‘textpoint’.
value = 10
textpoint = ValueToText(value)
This has the same effect as the previous example.

Event/Error Commands
ClearErrorLog
Syntax
ClearErrorLog()

Typical Example
ClearErrorLog()
The error list is cleared and the log deleted.

CloseErrorLog
Syntax
returnstate = CloseErrorLog()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
CloseErrorLog()
The list of all currently logged errors is closed.

Release 1.1 Page 96

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

DisplayErrorLog
Syntax
returnstate = DisplayErrorLog()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
DisplayErrorLog()
A list of all currently logged errors is displayed in a dialog.

EnableErrorLogging
Syntax
returnstate = EnableErrorLogging(pointname)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pointname bool A Boolean point.

Typical Example
EnableErrorLogging(flag)
Error Logging is enabled based on the Boolean point ‘flag’. If ‘flag’ is ‘TRUE’, then error logging is
enabled. If ‘flag’ is false, then error logging is disabled.

LogError
Syntax
returnstate = LogError(“message”, priority)

Release 1.1 Page 97

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
message string Contains the text string that is displayed in the Error Log.
priority integer Priority assigned to the error.
0 - low 1- medium 2- high.

Typical Example
LogError(“This is an error”, 1)
The message ‘This is an error’ appears as a medium priority error in the error log.

LogEvent
Syntax
returnstate = LogEvent(“message”)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
message string Contains the text string that is displayed in the Error Log.

Typical Example
LogEvent(“this is an event”)
The message ‘this is an event’ appears as an event in the error log.

Printer Commands
ClearSpoolQueue
Syntax
returnstate = ClearSpoolQueue()

Release 1.1 Page 98

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
ClearSpoolQueue()
Any messages (typically printed alarms) that are queued up waiting to be sent to the CX-Supervisor
Alarm/Message printer is discarded.

EnablePrinting
Syntax
returnstate = EnablePrinting(flag)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
flag bool 0 to disable, 1 to enable.

Typical Example
EnablePrinting(FALSE) - Disables printing
EnablePrinting(TRUE) - Enables printing
While alarm printing is disabled, any new messages are stored but not printed. When alarm printing is
re-enabled, any pending messages are printed (if in line mode) or added to the current page (if in
page mode).

GetSpoolCount
Syntax
returnstate = GetSpoolCount()

Remarks

Argument Type Description

returnstate int Number of messages queued up waiting to be printed on
Alarm/Message printer.

Release 1.1 Page 99

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example
NumberMessages = GetSpoolCount()
The count of the number of messages (typically printed alarms) that are queued up waiting to be sent
to the CX-Supervisor Alarm/Message printer is returned.

PrintActivePage
Syntax
returnstate = PrintActivePage(flag)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
flag bool Flag is to indicate whether the print setup dialog is to be
displayed before printing.

Typical Example
PrintActivePage(TRUE)
The currently active page is sent to the printer. The flag ‘TRUE’ indicates that the print dialog is
displayed. ‘FALSE’ causes the print dialog not to be shown.

PrintPage
Syntax
returnstate = PrintPage (“pagename”, flag)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
pagename string The name of the page to be printed.
flag bool Flag to indicate whether the print setup dialog is to be
displayed before printing.

Typical Example
PrintPage(“page1”, TRUE)
The CX-Supervisor page is sent to the printer. The flag ‘TRUE’ indicates that the print dialog is
displayed first to allow for printer configuration. If ‘FALSE’ was specified instead of ‘TRUE’ then the
print dialog is not shown, the page is just printed.

Release 1.1 Page 100

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

PrintScreen
Syntax
returnstate = PrintScreen(flag)

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
flag bool Flag to indicate whether the print setup dialog is to be
displayed before printing.

Typical Example
PrintScreen(FALSE)
All CX-Supervisor pages currently on view is printed. The flag ‘FALSE’ indicates that the print dialog
is not displayed. A flag of ‘TRUE’ causes the print dialog to be shown, allowing the user to configure
or choose the printer.

PrintSpoolQueue
Syntax
returnstate = PrintspoolQueue()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
PrintSpoolQueue
Any message (typically printed alarms) that are queued up waiting to be sent to the CX-Supervisor
Alarm/Message printer is printed immediately.

SetPrinterConfig
Syntax
returnstate StePrintConfig(Driver, Device, Port)

Release 1.1 Page 101

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate Bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.
Driver String Name of printer device (e.g. “Epson9” for 9 pin Epson
printers.
Device String Name of specific device (e.g. “Epson FX-870”). This is
optional.
Port String Name of port or file(e.g. “LPT1.”).
Line Terminator String Optional. Sets terminator (e.g. cr) to be added to end of
each printed line.

Typical Examples
SetPrinterConfig(“SCSPRN”, “”, “LPT1:”)
This uses standard CX-Supervisor line print driver.
SetPrinterConfig(“”, “”, “”)
This uses default Windows printer driver.
SetPrinterConfig(“Epson9”, “”, “LPT2:”)
This uses Epson printer driver, attached to LPT2.
SetPrinterConfig(DriverNamePoint, DeviceNamePoint, PrintNamePoint)
This uses text points.
Terminator = FormatText(“%c%c”,13,10)
Character 10 is 'lf' (newline), character 13 is cr (carriage return).
SetPrinterConfig(“Epson9”,“”,“LPT1:”,Terminator)

Security Commands
Login
Syntax
returnstate = Login()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Release 1.1 Page 102

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example
Login()
The Login dialog is displayed for user entry.

References
Refer to the CX-Supervisor User Manual for details of Login.

Logout
Syntax
returnstate = Logout()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
Logout()
The user is logged out.

References
Refer to the CX-Supervisor User Manual for details of Logout.

Setup Users
Syntax
returnstate = SetupUsers()

Remarks

Argument Type Description

returnstate bool Returnstate is ‘1’ if the function is successful, or ‘0’
otherwise.

Typical Example
SetupUsers()
The Setup Users dialog is displayed for user entry.

References
Refer to the CX-Supervisor User Manual for details of setting and modifying user details.

Release 1.1 Page 103

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Data Logging Commands

ClearLogFile
Syntax
ClearLogFile("datasetname")

Remarks

Argument Type Description

datasetname string Name of Data Set to clear as text point or constant.

Typical Example
ClearLogFile("Process 1")
This command will clear all data from the active (latest) log file for this data set, and add a ‘Clear
Event’ indicator.

CloseLogFile
Syntax
CloseLogFile("datasetname")
or
CloseLogFile("databaselink")

Remarks

Argument Type Description

datasetname text Name of Data Set to close as text point or constant.
databaselink text Name of Database link to close as text point or constant.

Typical Example
CloseLogFile("Process 1")
This command will close the active log file for the data set. Logging for this data set is automatically
stopped.

CloseLogView
Syntax
CloseLogView("datasetname")

Release 1.1 Page 104

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

datasetname string Name of Data Set view to close as text point or constant.

Typical Example
CloseLogView("Process 1")
This command will close the Data Log Viewer, which is displaying the named data set.

ExportAndViewLog
Syntax
ExportAndViewLog ("datasetname", "item list", "format", file,
outputfile)
or
ExportAndViewLog ("datasetname", TextArray, "format", file,
outputfile)

Remarks

Argument Type Description

datasetname string Name of Data Set to export as text point or constant.
item list string List of Items and/or Groups within the data set to export,
separated by commas. Alternatively use “*” to export all.
TextArray string A text point, which has an array size specified as 1 or
array more elements . Each element holds an Item or Group
name.
format string Either “CSV” or “Text” to specify output format. May
include suffix ‘-‘ followed by:
B to exclude break information
D to exclude the log date
T to exclude the log time
M to exclude to log milliseconds
file integer Number of file to export where 0 is the latest (active) file, 1
is the previous file etc.
outputfile string File name for output file. May include full path, which will
be created automatically if it does not exist.

All these arguments are optional, and may be omitted provided there are no further arguments i.e. to
specify the ‘format’, ‘datasetname’ and ‘item list’ must be included but ‘file’ and ‘output’ may be
omitted.

Release 1.1 Page 105

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Examples
ExportAndViewLog("Balloon", "*")
or
ExportAndViewLog("Balloon", "Altitude,Fuel,Burning,Lift,Group 1",
"CSV-BDTM", 0, "output")
or
ItemList[0] = "Altitude"
ItemList[1] = "Fuel"
ItemList[2] = "Burning"
ItemList[3] = "List"
ItemList[4] = "Group 1"
ExportAndViewLog("Balloon", ItemList, "CSV-BDTM", 0, "output")
All these commands will export all the data in the specified file, for the named data set to the named
output file, in the format specified (as per ExportLog). It then launches an appropriate viewer to
display the file, using the Windows file associations.

ExportLog
Syntax
ExportLog ("datasetname", "item list", "format", file, outputfile)
or
ExportLog ("datasetname", TextArray, "format", file, outputfile)

Release 1.1 Page 106

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

datasetname string Name of Data Set to export as text point or constant.
item list string List of Items and /or Groups within the data set to export,
separated by commas. Alternatively use “*” to export all.
TextArray string A text point, which has an array size specified as 1 or
array more elements. Each element holds an Item or Group
name.
format string Either “CSV” or “Text” to specify output format. May
include suffix ‘-‘ followed by:
B to exclude break information
D to exclude the log date
T to exclude the log time
M to exclude to log milliseconds
file integer Number of file to export where 0 is the latest (active) file, 1
is the previous file etc.
outputfile string File name for output file. May include full path, which will
be created automatically if it does not exist.

All these arguments are optional, and may be omitted provided there are no further arguments i.e. to
specify the ‘format’, ‘datasetname’ and ‘item list’ must be included but ‘file’ and ‘output’ may be
omitted.

Typical Examples
ExportLog("Balloon", "*")
or
ExportLog("Balloon", "Altitude,Fuel,Burning,Lift,Group 1" "CSV-BDTM",
0, "output")
or
ItemList[0] = "Altitude"
ItemList[1] = "Fuel"
ItemList[2] = "Burning"
ItemList[3] = "List"
ItemList[4] = "Group 1"
ExportAndViewLog("Balloon", ItemList, "CSV-BDTM", 0, "output")
All these commands will export all the data in the specified file, for the named data set to the named
output file, in the format specified.

Release 1.1 Page 107

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

OpenLogFile
Syntax
OpenLogFile("datasetname”)
or
OpenLogFile("databaselink")

Remarks

Argument Type Description

datasetname text Name of Data Set to open as text point or constant.
databaselink text Name of Database link to open as text point or constant.

Typical Example
OpenLogFile("Balloon")
This command will open the log file, ready to start logging. As the function is disk intensive it should
not be called frequently.

OpenLogView
Syntax
OpenLogView("datasetname", "item list", sessionfile)
or
OpenLogView("datasetname", TextArray, sessionfile)

Remarks

Argument Type Description

datasetname string Name of Data Set to view as text point or constant.
item list string List of Items and/or Groups within the data set to view,
separated by commas
TextArray string A text point, which has an array size specified as 1 or
array more elements. Each element holds an Item or Group
name.
sessionfile string Optional filename of session information file. The Data
Log Viewer is shown with the session settings (e.g.
Window position, size, colours, grid options etc. stored in
the session file. If ommitted, the previous settings are
used.

Typical Example
OpenLogView("Balloon", "Altitude,Fuel,Burning,Lift,Group 1")

Release 1.1 Page 108

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

or
ItemList [0] = "Altitude"
ItemList [1] = "Fuel"
ItemList [2] = "Burning"
ItemList [3] = "Lift"
ItemList [4] = "Group 1"
OpenLogView("Balloon", ItemList)
Both these commands will open the Data Log Viewer, and load the Ballon log file, and show the
named items.
OpenLogView("Balloon", ItemList, "C:\Program Files\Omron\CX-
SUPERVISOR\App\MySessionInfo.txt")
This command will open the Data Log Viewer and Balloon log file as above but the Data Log Viewer
will always appear in the same position, and with the same settings – not as it was last shown.

StartLogging
Syntax
StartLogging("datasetname")
or
StartLogging("databaselink")

Remarks

Argument Type Description

datasetname text Name of Data Set to start logging as text point or
constant.
databaselink text Name of Database link to start logging as text point or
constant.

Typical Example
StartLogging("Process 1")
This command will start logging of all items in the named data set. If the file is closed it will be
automatically opened.

StopLogging
Syntax
StopLogging("datasetname")
or
StopLogging("databaselink")

Release 1.1 Page 109

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

datasetname Text Name of Data Set to stop logging as text point or
constant.
databaselink text Name of Database link to stop logging as text point or
constant.

Typical Example
StopLogging("Process 1")
This command will stop logging of all items in the named data set.

Database Commands
DBAddNew
Description
Adds a new record to a Recordset. This function will fail if the Recordset is opened with a lock of
'Read Only'.

Syntax
returnstate = DBAddNew(level)

Remarks
Argument Type Description
returnstate bool 1 if the function is successful otherwise 0
level text A text point or constant specifying the connection level.
This should be a field or recordset level.

Typical Examples
Result = DBAddNew("Northwind.Order Details")
Using a Recordset connection level, a new record is added with values from all fields associated with
a property type ‘Add’. Point 'Result' is set true if this was successful.
DBAddNew("Northwind.Order Details.OrderID")
DBAddNew("Northwind.Order Details.ProductID")
DBAddNew("Northwind.Order Details.Quantity")
DBAddNew("Northwind.Order Details.UnitPrice")
DBUpdate("Northwind.Order Details")

Release 1.1 Page 110

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Using a Field connection level, each required field is added to the new record using multiple calls to
DBAddNew(). When the record is complete, it is added by calling the DBUpdate() function
Note: To use DBAddNew() with a Recordset level the Recordset must be configured to
perform this type of operation i.e it will need to contain fields for any primary keys and
‘non null’ values required to create a new record. When used at Recordset level all
fields associated with the Recordset with property type ‘Add’ are added (as if calling
DBAddNew()) and the record is updated (as if calling DBUpdate()). Points associated
with the ‘Add’ property can be array points, thus enabling you to add multiple records in
one operation.
Note: When using a Field level connection, the operation may be canceled at any stage
before the DBUpdate() function is called by calling the DBExecute() command
"CancelUpdate".
Note: Only Fields with a property type of ‘Add’ can be added to a Recordset. The value(s) of
the associated points at the time DBUpdate() is called will be used to create the record.

DBClose
Description
Closes a Connection or Recordset. Closing a Connection will automatically close all recordsets
associated with it. Recordsets can be closed in isolation by selecting the appropriate level.

Syntax
returnstate = DBClose(level)

Remarks
Argument Type Description
returnstate bool 1 if the function is successful otherwise 0
level text A text point or constant specifying the connection level.
This should be a connection or recordset level.

Typical Examples
Result = DBClose("Northwind.Order Details")
Closes the 'Order Details' Recordset
Result = DBClose("Northwind")
Closes the connection to the Northwind database, and also any Recordsets which may be open.

DBDelete
Description
Deletes the specified number of records from the current record position. This function works only at
the Recordset level. This function will fail if the Recordset is opened with a lock of 'Read Only'.

Release 1.1 Page 111

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Syntax
returnstate = DBDelete(level, quantity)

Remarks

Argument Type Description

returnstate bool 1 if the function is successful otherwise 0
level text A text point or constant specifying the connection level.
This must be a recordset level.
quantity int Number of records to delete.

Typical Examples
Result = DBDelete("Northwind.Order Details", 10)
Delete the next 10 records in the recordset
DBMove("First")
Result = DBDelete("Northwind.Order Details", 10)
Delete the first 10 records.

DBExecute
Description
The DBExecute function allows the execution of miscellaneous commands and allows for future
expansion by supporting new commands without the need to create more new DB functions.

Syntax
return = DBExecute(level, command, parameter)

Release 1.1 Page 112

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

return 1 if the function is successful otherwise 0 except for "Find"
and "FindNext" commands which return the record
number if found or if not, set the current record to EOF
and return -1.
level text A text point or constant specifying the connection level,
which depends on the command specified.
command text Command to execute. May be one of the commands
listed below.
parameter text Command parameter only required with certain
commands. For "Connection", this parameter should hold
the new connection string. For "Find" and "FindNext" this
parameter should be the search criteria. For "Source" this
is the Recordset source. For "Filter" this is the Recordset
filter.

Typical Examples
Pos = DBExecute("Northwind.Order Details", "Find", "UnitPrice >
14.00")
Find the next record satisfying the specified criteria, starting from the current position. Valid search
criteria include: "ProductName LIKE ‘G*’ " wildcard search finds all records where ProductName starts
with ‘G’, "Quantity = 5", "Price >= 6.99". Only single search values are allowed, using multiple values
with ‘AND’ or ‘OR’ will fail.
DBExecute("Connection1.Recordset1", "Source", "Table2")
Modify the Recordsets source to open a different table than configured.
DBExecute("Northwind.Shippers", "Filter", "CompanyName = ‘United
Package’")
Apply a filter to display only records with a company name ‘United Package’
DBExecute("Northwind.Shippers", "Filter", "")
Cancel an existing filter (by passing an empty string)

Release 1.1 Page 113

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

DBExecute Commands

Command Connection Description

Level
Connection Connection Modify the connection string.
BeginTrans Connection Begins a new Transaction.
CommitTrans Connection Saves any pending changes and ends the current
transaction.
RollbackTrans Connection Cancels any changes made and ends the
transaction.
CommitTransAll Connection Saves all changes and ends all transactions.
RollbackTransAll Connection Cancels all changes and ends all transactions.
TransCount Connection Returns the number of pending transactions.
Requery Recordset Re-run the Recordset Query.
CancelUpdate Recordset Cancel a DBAddNew operation.
Find Recordset Find the specified criteria in a Recordset.
FinNext Recordset Combined DBMove("Next"), DBFind() operation.
Source Recordset Modify the Recordset source.
Filter Recordset Apply a filter to a Recordset.
Save Recordset Saves a Recordset in XML format.

DBGetLastError
Description
Returns the last error string generated by the Database provider, and displays it in a message box.

Syntax
returnstate = DBGetLastError(level, display)

Remarks

Argument Type Description

returnstate text The error message from the provider
level text A text point or constant specifying the connection level.
This must be a Connection level.
display bool Optional flag. By default DBGetLastError will display the
providers error message in a message box. Setting this
flag to FALSE prevents this action.

Typical Examples
DBGetLastError("Northwind")
or
DBGetLastError("Northwind", TRUE)

Release 1.1 Page 114

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Both the above lines will get and display the last error to occur for the Northwind connection.
ErrMsg = DBGetLastError("Northwind", FALSE)
The last error to occur for the Northwind connection is stored Text point 'ErrMsg', without displaying a
message box.

DBMove
Description
The DBMove function enables you to navigate around a Recordset by moving the position of the
‘current record’ in the Recordset. When a Recordset is first opened the first record is the current
record.

Syntax
returnstate = DBMove(level, direction, position)

Remarks

Argument Type Description

returnstate bool 1 if the function is successful otherwise 0
level text A text point or constant specifying the connection level.
This must be a Recordset level.
direction text A text string indicating where to move to. May be one of:
"First"
"Last"
"Next"
"Previous"
"Position"
"FirstPage"
"LastPage"
"NextPage"
"PreviousPage"
"Page"
"Bookmark"
position int/real This optional parameter is only required when directions
of "Position", "Page" and "Bookmark" are used. When
used with "Position" and "Page" this parameter must be
an integer, and is the record or page number to move to.
When used with "Bookmark" this parameter must be a
real.

Typical Examples
DBMove("Northwind.Order Details", "First")
Goto the first record in the Recordset.

Release 1.1 Page 115

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

pos = 3
DBMove("Northwind.Order Details", "Position", pos)
Goto the third record in the Recordset.
DBMove("Northwind.Order Details", "Page", 6)
Goto the sixth page in the Recordset.
Note: Bookmarks are returned from the function ‘DBProperty’, they enable you to return to a
‘marked’ record, even after records have been added or deleted
Note: Some Providers do not support moving in the "Previous" direction i.e. cursors are
‘Forward-Only’. Some ‘Forward-Only’ providers do allow moving "First", while some are
strictly Forward-Only i.e. the Recordset has to be Re-queried effectively a combined
Close then Open operation to reset the cursor back to the start of the Recordset. Some
Providers that do support moving "Previous" do not support moving to "Position".
However, in order to be consistent, CX-Supervisor ensures that that all operations
(except "Bookmarks") will work for any connection to any provider but you need to bear
in mind when designing applications that use ‘Forward-Only’ cursors, that there may be
some ‘long-winded’ acrobatics being performed behind the scenes. See DBSupports()
for details of how to check the type of cursor in force.
Note: Bookmarks will only work if specifically supported by the Provider.

DBOpen
Description
Opens a Connection or Recordset. Opening a Connection will automatically open all recordsets
associated with it, that are marked as auto open. Recordsets can be opened in isolation by selecting
the appropriate level.

Syntax
returnstate = DBOpen(level)

Remarks

Argument Type Description

returnstate bool 1 if the function is successful otherwise 0
level text A text point or constant specifying the connection level.
This may be a Connection or Recordset level.

Typical Examples
DBOpen("Northwind")
Open the connection to the Northwind database, and automatically open any Recordsets set to open
on connection.
done = DBOpen("Northwind.Order Details")
Just open a specific Recordset.

Release 1.1 Page 116

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

DBProperty
Description
Returns the requested property. This function operates on the Recordset and Field levels. The type
of the value returned depends on the property requested.

Syntax
returnstate = DBProperty(level, property)

Remarks

Argument Type Description

returnstate Property value returned. See table for type.
level text A text point or constant specifying the connection level.
This may be a Recordset or Field level.
property text The name of the property to get. For details see the
Recordset Properties and Field Properties tables.

Typical Examples
Page = DBProperty("CSV.Result", "CurrentPage")
Get the current page for the CSV.Result Recordset.
FieldSize = DBProperty("Northwind.Customers.Address", "Size")
Get the size for the 'Address' field.
Note: The Recordset will only return valid properties when it is Open.

Recordset Properties
The properties of a Recordset are:

Release 1.1 Page 117

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Property Description Return type

"CurrentRecord" Current cursor position Integer
"RecordCount" Number of records in the Recordset. Integer
"Bookmark" Record marker. Real
"PageCount" Number of pages in the Recordset. Integer
"PageSize" Number of records in a page. Integer
"CurrentPage" Page in which the cursor position resides. Integer
"Source" Command or SQL that created the Recordset. Text
"Sort" Field name(s) the Recordset is sorted on. Text
"FieldCount" Number of fields(columns) in the Recordset. Integer
"BOF" Current position is at the start of the Recordset. Bool
"EOF" Current position is at the end of the Recordset. Bool

Field Properties
The properties of a Field are

Property Description Return type

"Value" Value of the field at the current position. As type of field
"Name" Name of the Field. String
"Type" The fields data type. String
"Size" Maximum width of the field. Integer

DBRead
Description
Reads a record from a Recordset to the associated point(s), or if associated points are array points,
reads a whole page of records. This function operates on both Recordset and Field levels. At the
Field level the associated column values from the Recordsets current position will be copied into the
Point (number of elements copied = number of elements in the Point, no paging applies at the Field
level).

Syntax
returnstate = DBRead(level, reset)

Release 1.1 Page 118

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

returnstate bool 1 if the function is successful otherwise 0
level text A text point or constant specifying the connection level.
This may be a Recordset or Field level.
reset bool This argument is optional and may be omitted. If omitted
or TRUE, when the read is complete the record cursor is
reset to the position prior to reading.

Typical Examples
DBRead("Northwind.Customers")
Read the next page of records from the 'Customers' Recordset.
DBRead("Northwind.Customers", FALSE)
Read the next page of records from the 'Customers' Recordset, and leave the cursor at the next
record.
DBRead("Northwind.Customers.Address")
The Address field is read. If it is an array point, the Address is read from subsequent records until the
array has been filled.
Note: Use with reset = TRUE is useful if the read operation is being combined with a
subsequent Write operation i.e. you can read in a set of records - resetting the cursor,
make modifications to some of the fields and then Write the changes back to the
Recordset.
Note: Use with reset = FALSE will leave the current position at the start of the next set of
records. This option can be of benefit if the Provider only supports forward moving
cursors, or you simply want to step through the records a page at a time.

DBSchema
Description
Issues commands to read schema results or properties or set up new schema criteria. This function
operates only at a Schema level.

Syntax
return = DBSchema(level, command, parameters...)

Release 1.1 Page 119

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

return Value returned by command. For some commands e.g.
"RecordCount" this is an integer value, for other
commands this is a text value.
level text A text point or constant specifying the connection level.
This must be a Schema level.
command text The command must be one of the following:
"Read" - Transfers a schema page into the
associated point
"Set" - Enables schema details to be modified

"Type" - Returns the current Schema Type

"Criteria" - Returns the current Schema Criteria

"Filter" - Returns the current Schema Filter

"RecordCount" - Returns the number of records in the
current Schema
"PageCount" - Returns the number of pages in the
current Schema
"CurrentPage" - Returns the current Schema page
parameters Some commands require 1 or more extra parameters.
"Read" takes an optional parameter ‘Page Number’ of
type integer. If no ‘Page Number’ is supplied, this function
will return page 1 when first called and automatically
return the next page of schemas for each subsequent call,
cycling back to the beginning when all pages have been
returned.
"Set" takes three text parameters for Schema ‘Name’,
‘Criteria’ and ‘Filter’.

Typical Examples
NumberOfRecords = DBSchema("Invoice.Data Types", "RecordCount")
Read the Number of records in the Schema.
DBSchema("Invoice.Data types", "Read", 2)
Read Schema page 2 results into the associated point.
DBSchema("Invoice.Data Types", "Set", "Columns", "COLUMN_NAME", "")
Set a new Schema to return column names.

Release 1.1 Page 120

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

DBState
Description
Reports if the specified level is in the requested state.

Syntax
return = DBState(level, state)

Remarks

Argument Type Description

return bool 1 if the specified level is in the requested state, otherwise
0
level text A text point or constant specifying the connection level.
This may be a Connection or Recordset level.
state text The requested state must be either "Open" or "Closed"

Typical Examples
State = DBState("Invoice", "Closed")
Checks if the Connection "Invoice" is currently closed.
State = DBState("Northwind.Customers", "Open")
Checks if the Recordset "Customers" is currently open.

DBSupports
Description
Returns TRUE if the specified Recordset supports the requested operation.

Syntax
return = DBState(level, operation)

Remarks

Argument Type Description

return bool 1 if the specified Recordset supports the requested
operation, otherwise 0
level text A text point or constant specifying the connection level.
This must be a Recordset level.
operation text The requested operation may be one of:
"AddNew", "Bookmark", "Delete", "Find","MovePrevious"
or "Update"

Release 1.1 Page 121

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example
Result = DBSupports("CSV.Recordset1", "Delete")
Checks if records can be deleted in 'Recordset1'
Note: If the "MovePrevious" operation is not supported then only 'Forward-Only' cursor
movements are supported.

DBUpdate
Description
Update the record being added in a Recordset. Used in conjunction with DBAddNew to commit a new
record.

Syntax
returnstate = DBUpdate(level)

Remarks

Argument Type Description

returnstate bool 1 if the function is successful otherwise 0
level text A text point or constant specifying the connection level.
This must be a Recordset level.

Typical Example
DBAddNew("Northwind.Order Details.OrderID")
DBAddNew("Northwind.Order Details.ProductID")
DBAddNew("Northwind.Order Details.Quantity")
DBAddNew("Northwind.Order Details.UnitPrice")
DBUpdate("Northwind.Order Details")
Each field is added to the new record using multiple calls to DBAddNew(). When the record is
complete, it is added to the Recordset by calling the DBUpdate() function.

DBWrite
Description
Writes a set of records into a Recordset from the associated point(s). This function operates on both
Recordset and Field levels. At the Recordset level all the associated points values from the Points will
be written into the Recordset starting at the current record (1 page of values will be written for each
Point). At the Field level the associated values from the point are written into the Recordsets starting
at the current position. The number of elements written = number of elements in the Point. This
function will fail, if the Recordset is opened with a Lock of ‘Read Only’.

Syntax
return = DBWrite(level, reset)

Release 1.1 Page 122

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

return Bool 1 if the function is successful otherwise 0
level Text A text point or constant specifying the connection level.
This must be a Recordset level.
reset Bool This argument is optional and may be omitted. If omitted
or TRUE, when the write is complete the record cursor is
reset to the position prior to writing.

Typical Examples
DBWrite("Northwind.Customers")
Write all point values to the associated Customers fields.
DBWrite("Northwind.Customers.Address", FALSE)
Write the point values to the Address column, and leave the cursor at the next set of records.

Serial Port Functions

InputCOMPort
Description
Sets the serial communications port for receiving ASCII text messages. Any message received is
placed in the text point. The boolean flag is set true to indicate that a message has been received. It
is up to the user to reset this flag between receiving messages in order to indicate that a new
message is present.

Syntax
ReturnState = InputCOMPort(PortNumber, Message, MessagePresent)

Remarks

Argument Type Description

ReturnState Bool True if successful else false.
PortNumber Integer The number of the port previously configured using the
function SetupCOMPort and opened with OpenCOMPort.
message Text Text point to hold ASCII text message received through
the port.
MessagePresent Bool Boolean point indicating that a message has been
received.

Typical Example:
bState = InputCOMPort(1, Msg, bTransmission)

Release 1.1 Page 123

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

OutputCOMPort
Description
Sends an ASCII text message out through the designated serial communications port.

Syntax
ReturnState = OutputCOMPort(PortNumber, Message)

Remarks

Argument Type Description

ReturnState Bool True if successful else false.
PortNumber Integer The number of the port previously configured using the
function SetupCOMPort and opened with OpenCOMPort.
message Text Text point holding the ASCII text message to send
through the port.

Typical Example:
bState = OutputCOMPort(1, Msg)

CloseCOMPort
Description
Closes the designated serial communications port on the PC. The port must have been configured
and opened before it can be closed.

Syntax
ReturnState = CloseCOMPort(PortNumber)

Remarks

Argument Type Description

ReturnState Bool True if successful else false.
PortNumber Integer The number of the port previously configured using the
function SetupCOMPort and opened using the script
function OpenCOMPort.

Typical Example:
bState = CloseCOMPort(1)

Release 1.1 Page 124

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

OpenCOMPort
Description
Opens the designated serial communications port on the PC for transmitting or receiving data. The
port must have been configured before it can be opened.

Syntax
ReturnState = OpenCOMPort(PortNumber)

Remarks

Argument Type Description

ReturnState Bool True if successful else false.
portNumber Integer The number of the port previously configured using the
function SetupCOMPort.

Typical Example:
bState = OpenCOMPort(1)

SetupCOMPort
Description
Configures the designated serial communications port on the PC for transmitting or receiving data.

Syntax
ReturnState = SetupCOMPort(PortNumber, ConfigurationString,
HandShaking, TerminationChar, ControlCharFlag)

Remarks

Argument Type Description

returnstate Bool True if successful else false.
portnumber Integer The number of the serial port to be configured.
ConfigurationString Text A string indicating the desired Baud rate, Parity, number
of data bits and stop bits.
HandShaking Integer The required handshaking protocol. Valid values are
0 – None 1 - XonXoff
2 – RTS 3 - RTS & XonXoff
TerminationChar Integer A character indicating the end of the message.
ControlCharFlag Bool A flag indicating that control characters contained in a
received message should be Ignored.

Release 1.1 Page 125

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example:
bState = SetupCOMPort(2, "9600,N,8,1", 0, 0x0D, TRUE)

ActiveX Functions
GetProperty
Description
Gets the value of a property of an OLE object and stores it in a point.

Syntax
propertyvalue = GetProperty(object, property, ...)

Remarks

Argument Type Description

propertyvalue n/a The value of the property. Type is dependant on the type
of the property.
object Text The name of the OLE object to get the property of.
property Text The name of the property to get.
... n/a Any number of parameters for the property.

Typical Examples
OLE1Height = GetProperty(“OLE1”, “Height”)
This will read the property ‘Height’ from the OLE object ‘OLE1’ and store it in the point ‘OLEHeight’.
DM100Value = GetProperty(“CXComms1”, “DM”, 100)
This will read the property ‘DM’ (with one parameter 100) from the OLE object ‘CXComms1’ and store
it in the point ‘DM100Value’.

PutProperty
Description
Puts a value stored in a point into the property of an OLE object.

Syntax
PutProperty(object, property, ..., value)

Release 1.1 Page 126

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Remarks

Argument Type Description

object Text The name of the OLE object containing the property to
change.
property Text The name of the property to put.
... n/a Any number of parameters for the property.
value n/a The value to write to the property. Type is dependant on
the type of property. Can also be a number.

Typical Examples
PutProperty(“OLE1”, “Left”, NewLeftValue)
This will write the value stored in the point NewLeftValue to the property ‘Left’ in the OLE object
‘OLE1’.
PutProperty(“CXComms1”, “DM” 10, NewValue)
This will write the value stored in the point NewValue to the property ‘DM’ (with one parameter 10) in
the OLE object ‘CXComms1’.
PutProperty(“Gauge1”, “Value”, 25.2)
This will write the value 25.2 to the object ‘Gauge1’.

Execute
Description
Execute a method of an OLE object.

Syntax
Execute(object, method, ...)

Remarks

Argument Type Description

object Text The name of the OLE object.
method Text The name of the method to execute.
.... n/a Any number of parameters for the method.

Typical Examples
Execute(“OLE1”, “Start”)
This will call the method ‘Start’ on the object ‘OLE1’.
Execute(“CXComms1”, “OpenPLC”, “MyPLC”)
This will call the method ‘OpenPLC’ with one text parameter ‘MyPLC’ on the OLE object ‘CXComms1’

Release 1.1 Page 127

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

ExecuteVBScript
Description
Creates aliases allowing Visual Basic Script to be executed in line. This uses the Windows Scripting
Host. See Appendix C for a list of supported functions and details of the Windows Scripting Host.

Syntax
@VBSCRIPT
@ENDSCRIPT

Typical Examples
@VBSCRIPT
OLE1.LEFT = Point(“PointName”)
@ENDSCRIPT
This Visual Basic Script will write the value from the point ‘PointName’ into the property ‘Left’ of the
OLE object ‘OLE1’.

ExecuteJScript
Description
Creates aliases allowing Java Script to be executed in line. See Appendix D for a list of supported
functions and details of the Windows Scripting Host.

Syntax
@JSCRIPT
@ENDSCRIPT

Typical Examples
@JSCRIPT
Point(“PointName”) = OLE_1.Height;
@ENDSCRIPT
This Java Script will write the value of the property ‘Height’ from the OLE object ‘OLE1’ into the Point
named ‘PointName’.
Note: The Java Script can not include the { or } characters. To use these, put the script in a
text file and use the ExecuteJScriptFile function.

ExecuteVBScriptFile
Description
Allows Visual Basic script stored in a text file to be executed. This uses the windows scripting host
which must be installed. See Appendix C for a list of supported functions.

Release 1.1 Page 128

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Syntax
returnstate = ExecuteVBScriptFile(scriptfile)

Remarks

Argument Type Description

returnstate bool 1 if the function is successful otherwise 0.
scriptfile Text The name of the file with the Visual Basic Script to
execute.

Typical Examples
returnstate = ExecuteVBScriptFile(“c:\vbscript.txt”)
This will execute the Visual Basic Script stored in “c:\vbscript.txt”.

ExecuteJScriptFile
Description
Allows Java script stored in a text file to be executed. This uses the windows scripting host which
must be installed. See Appendix D for a list of supported functions.

Syntax
returnstate = ExecuteJScriptFile(scriptfile)

Remarks

Argument Type Description

returnstate bool 1 if the function is successful otherwise 0.
scriptfile Text The name of the file with the Java Script to execute.

Typical Examples
returnstate = ExecuteJScriptFile(“c:\jscript.txt”)
This will execute the Java Script stored in “c:\jscript.txt”.

Punctuation
Command String Delimiters
Syntax
DDEExecute(channel, {[command1][command2][command3]})

Release 1.1 Page 129

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Typical Example
channelname = DDEInitiate("Excel", "Sheet1.xls")
DDEExecute(channelname, {[OPEN("C:\EXCEL\WORK\SHEET2.XLS")]})
It is possible to pass multiple commands in one DDEExecute() command. Each command is
surrounded by square brackets [...]. There must be no space between the closure of one square
bracket and the opening of the next [...][...].
The ‘{‘ and ‘}’ braces must be inserted around the whole set of commands { [ . . . ] [ . . . ] } or an error is
reported. The braces act as delimiters for the whole command string. This allows the actual
commands in the command string to contain quotes.

Indentation
Typical Examples
IF burner AND fuel > 0 AND rate > 0 THEN
lift = lift + rate/5
ELSE
IF altitude > 140 THEN
lift = lift - 0.2
ENDIF
ENDIF
IF burner AND fuel > 0 AND rate > 0 THEN
lift = lift + rate/5
ELSE
IF altitude > 140 THEN
lift = lift - 0.2
ENDIF
ENDIF
Both examples provide identical functionality, but the use of indentation, either spaces or tabs to show
the construction of the statements aids readability.
The use of the ELSEIF statement in this example was omitted for clarity.

Multiple Commands
Typical Examples
count = 75
result = log(count)
count = 75 : result = log(count)
Both examples provide identical functionality, but the use of the colon between statements allows both
to reside on the same line.

Release 1.1 Page 130

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Parenthesis
Typical Examples
result = 20 + 30 * 40
The result is 1220.
result = (20 + 30) * 40
The values in parenthesis are calculated first. The result is 2000.

References
Refer to chapter 4, Arithmetric Operations for further details.

Quotation Marks
Typical Examples
name = "Valve position"
The Text point ‘name’ is assigned associated text, contained within quotation marks. Quotation marks
must be used in this instance.
channelname = DDEInitiate("Excel", "Sheet1.xls")
The Integer point ‘channelname’ is provided with a DDE link to an application which is run by an
executable filename, and to the associated application file. Quotation marks must be used for server
names, topic names, DDE commands and item names.
BlueCarsAck = IsAlarmAcknowledged("BLUEPAINT")
The point ‘BlueCarsAck’ is assigned a Boolean state based on the alarm ‘BLUEPAINT’. Quotation
marks must be used for an alarm name.

Remarks
Syntax
REM | rem comment
or
‘comment

Remarks

Argument Type Description

Comment --- Descriptive text.

Typical Examples
REM The following statement adds two numbers
result = 45 + 754
result = 45 + 754 ‘add two numbers

Release 1.1 Page 131

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Indirection within Script Commands and Expressions

It is possible to use text points directly or indirectly in place of literal string arguments within scripts
and expressions. For instance, each of the following commands has the same effect:
♦ Using a string literal;
PlayOLE(“ole_1”, 0)
♦ Using a textpoint directly;
textpoint = “ole_1”
PlayOLE(textpoint, 0)
♦ Using a textpoint indirectly via the ‘^’ notation.
text = “ole_1”
textpoint = “text”
PlayOLE(^textpoint, 0)
It is possible to use text points indirectly in place of point name arguments within script commands.
For instance, each of the following commands has the same effect:
♦ Using a point name directly;
verbnumber = 0
PlayOLE(“ole_1”, verbnumber)
♦ Using a textpoint indirectly via the ‘^’ notation.
verbnumber = 0
textpoint = “verbnumber”
PlayOLE(“ole_1”, ^textpoint)
An example using Indirection
The value of point indirection can be seen in a situation where it is necessary to dynamically change
the pointname that an object is linked to. In the following example a toggle button is configured to
control the Boolean state of one of four points:
♦ The four Boolean points to be controlled are called ‘motor1’, ‘motor2’, ‘motor3’ and ‘motor4’.
♦ The text point ‘textpoint’ is used to store the name of the Boolean point to be controlled.
♦ The text point ‘text’ is used to store the string value of the integer point ‘index’
♦ The integer point ‘index’ (which has a range 1-4) is used to dynamically change the point being
controlled.
♦ Access to any of the four Boolean points ‘motor1’, ‘motor2’, ‘motor3’, ‘motor4’ can be achieved by
applying indirection to ‘textpoint’ using the ‘^’ notation and changing the contents of ‘textpoint’.
For instance, in order to dynamically change the Boolean point a toggle button is linked to follow these
steps.
1, 2, 3… 1. Link the toggle button to a textpoint using indirection e.g. ^textpoint.

Release 1.1 Page 132

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

2. Link the following script code to run as required. e.g. on clicking a button.
• Text = ValueToText(index)
• TextPoint = “motor” + text
3. The ValueToText function converts the integer value of the point ‘index’ into a
string held in the textpoint ‘text’. Therefore the point ‘text’ contains either ‘1’, ‘2’,
‘3’ or ‘4’. The expression ‘motor’ + text appends the contents of the point ‘text’
to the literal string ‘motor’. Therefore ‘textpoint’ contains either ‘motor1’,
‘motor2’, ‘motor3’ or ‘motor4’ dependant on the value of ‘index’. Change the
value of the ‘index’ to determine which Boolean point to control. e.g. via the
Edit Point Value (Analogue) animation.

Point Arrays within Script Commands and Expressions

It is possible to access the elements of a point array directly or indirectly from within scripts or
expressions.
♦ Setting the value of an array point directly;
arraypoint[2] = 30
♦ Getting the value of an array point directly;
value = arraypoint[2]
♦ Setting the value of an array point using indirection;
textpoint = “arraypoint”
^textpoint[2] = 30
♦ Getting the value of an array point using indirection;
textpoint = “arraypoint”
value = ^textpoint[2]
♦ Setting the value of an array point using SetPointValue();
SetPointValue(arraypoint,2,30)
♦ Getting the value of an array point using GetPointValue().
value = GetPointValue(arraypoint,2)

An example using Point Arrays

The value of array points can be seen in a situation where it is necessary to dynamically change the
pointname that an object is linked to. In the following example a toggle button is configured to control
the Boolean state of one of four elements of an array point.
The Boolean array point ‘motor’ is configured to contain 4 elements.
The integer point ‘index’ (which has a range 0-3) is used to dynamically change the element of the
point being controlled.
In order to dynamically change the element of a Boolean point that a toggle button is linked to follow
these steps.

Release 1.1 Page 133

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

1, 2, 3… 1. Link the toggle button to an array point. e.g. ‘motor[index]’.

2. Change the value of the ‘index’ to determine which element of the Boolean
point to control. e.g. via the Edit Point Value (Analogue) animation.

Using Aliases
This facility is used to declare an alias - that is, to define a text string that can be used in place of
another text string or a number within any script or expression. The Alias Definitions dialog is
displayed by selecting the “Alias Definition...” option from the Project menu. It can also be displayed if
“Aliases...” is selected from the script editor. The dialog displays either the User defined aliases or the
preset System aliases and is toggled between these two displays by pressing the User/System Alias
button.
The following illustration shows the Alias Definitions dialog displaying a number of User defined
aliases. The System aliases are pre-defined and can not be edited or added to.

Syntax:
@AliasName Alias definition 'optional comment

Remarks:

Argument Type Description

@AliasName string The string name of the alias
Alias definition string This is a string representing the actual text or expression
of the expanded alias.
‘ comment string This is an optional comment.

Release 1.1 Page 134

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

The @ symbol at the beginning of each line initiates each alias command. For example, the text string
@SomePoint could be used to represent any sequence of characters in a script or expression – e.g. it
could be defined as:
@SomePoint = InArray[1]
or even
@SomePoint = Inarray[1] + Inarray[2] / 2
This is an easy way of identifing the individual members of array points. It can also be used to
associate names with numbers, for example,
@SecondsPerDay = 86400
Alias definations are stored in a simple text file in the project directory, called <project name>.pre.
The format of the file consists of any number of lines such as:
@Test1 = InArray[12] * 10
i.e. an @ symbol followed by the name of the alias, then an equals sign (or space), followed by the
definition of the alias. Anything that follows the last apostrophe ( ' ) symbol on a line is interpreted as a
comment. Any line which does not start with the @ symbol is also assumed to be a comment.

Typical Examples
Declare boiler temperatures
@BoilerTemp1 = InArray[0] ' for boiler room 1
@BoilerTemp2 = InArray[1] ' for boiler room 2
@SecondsPerMinute = 60 ' sets duration
Aliases may also be used to create a complicated expression such as
@HYPOTENUSE sqrt(Opposite * Opposite + Adjacent * Adjacent)
'Calculates length of Hypotenuse
This can be used in a script in the following way:
Opposite = 8.45
Adjacent = 9.756
length = @HYPOTENUSE
where Opposite, Adjacent and length are all REAL points.
Note: Changing an alias definition after it has been used in an expression or script will not
automatically change the result in the script. The appropriate script or expression
where that alias is used must be accessed and recompiled by pressing the OK button in
order to apply the changes.

Release 1.1 Page 135

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

CHAPTER 5
Script Examples
This chapter provides two applications for a script. The first script is a typical script exercising the
basic commands. The second script is specific for DDE use. Both examples are described twice,
once as a whole, and once on a line by line basis.

Balloon Script
The following script applies to a simple game.

The user must attempt to land the balloon on the plateau on the right, using the Max/Min slider control
throughout the flight. Clicking Reset clears the current game and initialises a new game. Clicking the
on/off pushbutton starts the game.
When the balloon is airborne, clouds move slowly horizontally and change colour slightly. Clicking
Help at any time brings up a special help page; clicking Close from this help page returns the user to
the game. The blue gauge shows the amount of fuel consumed and left.
The project consists of three page scripts and one object. The three page scripts are initiated at
varied intervals: 10 milliseconds, 100 milliseconds and 1000 milliseconds.
The page script initiated at intervals of 10 milliseconds determines the position of each cloud, and the
speed at which each cloud moves. The page script initiated at intervals of 1000 milliseconds
determines how the balloon reacts to the conditions.
The page script initiated at intervals of 100 milliseconds provides the main configuration of the game,
reacting to user input and moving the balloon accordingly. This page script is as follows:

Release 1.1 Page 136

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

IF burner AND alt > 400.0 THEN

burner = FALSE
ENDIF
IF burner THEN
fuel = fuel - rate
IF fuel < 0.0 THEN
fuel = 0.0
burner = FALSE
ENDIF
ENDIF

IF burner AND fuel > 0.0 AND rate > 0.0 THEN
lift = lift + rate/5.0
ELSE
IF alt > 140.0 THEN
lift = lift - 0.2
ENDIF
ENDIF
IF lift < -10.0 THEN
lift = -10.0
ENDIF
alt = alt + lift
IF alt <= 140.0 THEN
IF distance>630.0 AND distance<660.0 AND lift>=-3.0 THEN
winner = TRUE
burner = FALSE
ENDIF
IF lift < -3.0 then
crash = TRUE
burner = FALSE
ENDIF
lift = 0.0
ENDIF

speed = (alt-140.0 )/100.0

IF speed < 0.0 then
speed = 0.0
ENDIF

distance = distance + speed

The following paragraphs describe the above script on a line by line basis.
IF burner AND alt > 400.0 THEN
burner = FALSE
ENDIF
If the fuel burner is on, based on Boolean point ‘burner’ set to ‘TRUE’, and the altitude of the balloon,
based on point ‘alt’, exceeds 400, then the fuel burner is turned off. Point ‘alt’ is measured in pixels
between 140 and 1000, so the value of 400 is the height in pixels.

Release 1.1 Page 137

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

IF burner THEN
fuel = fuel – rate
IF fuel < 0.0 THEN
fuel = 0.0
burner = FALSE
ENDIF
ENDIF
If the fuel burner is on, the amount of fuel remaining decreases by the rate of ascent. The rate of
ascent, point ‘rate’ can be modified by moving the slider. If point ‘fuel’ currently has a value of less
than 0, then there is no fuel left and the fuel burner is turned off.
IF burner AND fuel > 0.0 AND rate > 0.0 THEN
lift = lift + rate/5.0
ELSE
IF alt > 140.0 THEN
lift = lift - 0.2
ENDIF
ENDIF
If the fuel burner is on, and there is still fuel left, and the rate of ascent exceeds 0 (the balloon has
taken off) then point ‘lift’ is incremented by the rate of ascent divided by 5 to allow the balloon to climb.
Otherwise the balloon must be descending and point ‘lift’ is decremented by 0.2.
IF lift < -10.0 THEN
lift = -10.0
ENDIF
Once point ‘lift’ reaches -10, it is not allowed to go lower.
alt = alt + lift
The altitude of the balloon is incremented by point ‘lift’.
IF alt <= 140.0 THEN
IF distance>630.0 AND distance<660.0 AND lift>=-3.0 THEN
winner = TRUE
burner = FALSE
ENDIF
If the balloon has hit the ground (point ‘alt’ equals 140), then provided it is on the plateaux (the position
of the balloon in pixels defined by point ‘distance’ is between 630 and 660) and the rate of descent is
not too fast (defined by point ‘lift’), then the game is won.
IF lift < -3.0 then
crash = TRUE
burner = FALSE
ENDIF
If the balloon has hit the ground (point ‘alt’ equals 140), then if the rate of descent is not too fast
(defined by point ‘lift’), then the game is lost.
lift = 0.0
ENDIF

Release 1.1 Page 138

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Point ‘lift’ is reset.

speed = (alt-140.0 )/100.0
IF speed < 0.0 then
speed = 0.0
ENDIF
Point ‘speed’ is calculated based on the altitude.
distance = distance + speed
Point ‘distance’ is calculated based on the speed.

DDE Script
The following script demonstrates how to generate a report using Microsoft Word for Windows
application. It is a more detailed example targeted at more proficient script writers. The example
assumes the following:
A file ‘REPORT.DOC’ exists in a directory named “C:\WINWORD\WORK”.
A text point ‘Header’ exists with the default text “CX-Supervisor Report — Date.
A real point named ‘Input’ exists with a default value of ‘325.99’. DDE Access of at least Read/Only is
required for the point.
A real point named ‘Output’ exists with a default value of ‘250.00’. DDE Access of at least Read/Only
is required for the point.
'Establish a connection to the report document
channel = DDEInitiate("Winword", "C:\WINWORD\WORK\REPORT.DOC")

IF channel > 0 THEN

‘Output header and date
DDEPoke(channel, "\StartOfDoc", Header)
DDEPoke(channel, "\EndOfDoc", $Date)
DDEExecute(channel, {[EndOfDocument]})
DDEExecute(channel, {[InsertPara]})
DDEExecute(channel, {[InsertPara]})

‘Output column headings (note : Chr$(9) is a TAB)

DDEExecute(channel, {[Insert "Time" + Chr$(9) + "Input"
+ Chr$(9) + "Output"]})
DDEExecute(channel, {[InsertPara]})

‘Change header and column headings to Bold font

DDEExecute(channel, {[EditSelectAll]})
DDEExecute(channel, {[FormatFont .Bold = 1, .Underline
= 0]})
DDEExecute(channel, {[EndOfDocument]})

‘Change font to normal for the data fields

Release 1.1 Page 139

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

DDEExecute(channel, {[SelectCurWord]})
DDEExecute(channel, {[FormatFont .Bold = 0]})
DDEExecute(channel, {[EndOfDocument]})

‘Output the data fields

DDEPoke(channel, "\EndOfDoc", $Time)
DDEExecute(channel, {[EndOfDocument]})

DDEExecute(channel, {[Insert Chr$(9)]})

DDEPoke(channel, "\EndOfDoc", Input)
DDEExecute(channel, {[EndOfDocument]})

DDEExecute(channel, {[Insert Chr$(9)]})

DDEPoke(channel, "\EndOfDoc", Output)
ENDIF

The script will generate the following output in ‘REPORT.DOC’:

The following paragraphs describe the above script on a line by line basis. The description assumes
the reader has a knowledge of the target application, in this instance Microsoft Word for Windows.
'Establish a connection to the report document
A remark describing the next few lines of code.
channel = DDEInitiate("Winword", "C:\WINWORD\WORK\REPORT.DOC")

Release 1.1 Page 140

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

The point ‘channel’ is assigned with the Microsoft Word for Windows executable file filename (minus
the file extension) ‘Winword’, and the path and filename of the topic, ‘REPORT.DOC’.
IF channel > 0 THEN
The point ‘channel’ is tested to ensure it is not empty, and therefore the demonstration continues to
run.
‘Output header and date
DDEPoke(channel, "\StartOfDoc", Header)
Microsoft Word for Windows is passed a navigational ‘go to start of document’ command, with the text
contained within point ‘Header’.
DDEPoke(channel, "\EndOfDoc", $Date)
Microsoft Word for Windows is passed a navigational ‘go to end of document’ command, and the date
contained within system point ‘$Date’ is inserted.
DDEExecute(channel, {[EndOfDocument]})
DDEExecute(channel, {[InsertPara]})
DDEExecute(channel, {[InsertPara]})
Microsoft Word for Windows is passed an EndOfDocument command, followed by two InsertPara
commands.
‘Output column headings (note : Chr$(9) is a TAB)
DDEExecute(channel, {[Insert "Time" + Chr$(9) + "Input"
+ Chr$(9) + "Output"]})
DDEExecute(channel, {[InsertPara]})
Microsoft Word for Windows is passed an Insert command, containing ‘Time’ followed by a tab
character, followed by ‘Input’, followed by a tab character, followed by ‘Output’, followed by an
InsertPara command.
‘Change header and column headings to Bold font
DDEExecute(channel, {[EditSelectAll]})
DDEExecute(channel, {[FormatFont .Bold = 1, .Underline = 0]})
DDEExecute(channel, {[EndOfDocument]})
Microsoft Word for Windows is passed an EditSelectAll command supplying an extended selection
across all of ‘REPORT.DOC’. The selected area is reformatted as emboldened, with no underline
(both .Bold and .Underline are Boolean with an ‘on’ and ‘off’ state).
‘Change font to normal for the data fields
DDEExecute(channel, {[SelectCurWord]})
DDEExecute(channel, {[FormatFont .Bold = 0]})
DDEExecute(channel, {[EndOfDocument]})
Microsoft Word for Windows is passed an SelectCurWord command supplying an extended selection
across the current word. The selected area is reformatted as normal (.Bold is Boolean with an ‘ON’
and ‘OFF’ state). An EndOfDocument command is also passed.
‘Output the data fields
DDEPoke(channel, "\EndOfDoc", $Time)
DDEExecute(channel, {[EndOfDocument]})

Release 1.1 Page 141

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 5 – Script Examples

Microsoft Word for Windows is passed a navigational ‘go to end of document’ command, and the time
contained within system point ‘$Time’ is inserted. An EndOfDocument command is also passed.
DDEExecute(channel, {[Insert Chr$(9)]})
DDEPoke(channel, "\EndOfDoc", Input)
DDEExecute(channel, {[EndOfDocument]})
Microsoft Word for Windows is passed an Insert command, containing a tab character, followed by a
navigational ‘go to end of document’ command, followed by the value of point ‘Input’, followed by an
EndOfDocument command.
DDEExecute(channel, {[Insert Chr$(9)]})
DDEPoke(channel, "\EndOfDoc", Output)
Microsoft Word for Windows is passed an Insert command, containing a tab character, followed by a
navigational ‘go to end of document’ command, followed by the value of point ‘Output’, followed by an
EndOfDocument command.
ENDIF
If point ‘channel’ is empty, the lines of script within the IF THEN ENDIF control statement are ignored.
The page script is finished.

Release 1.1 Page 142

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON CHAPTER 6 – Colour Palette

CHAPTER 6
Colour Palette
This chapter discusses the colour palette. A colour may be specified by its name or number. The
following table provides a cross-reference between these. Some colour names made up of more than
one word are separated by an underscore or a hyphen. A specified colour can be changed in the CX-
Supervisor development environment for the current session; such changes cannot be saved to a
Page or Project, unless colours are changed from the Colour Palette located under the General
Settings submenu in the Project menu.
Using a 16 colour-based screen resolution (consult the Microsoft Windows documentation for further
information) colours 16 to 65 are dithered from the sixteen base colours. Higher colour-based
resolutions are not dithered.

No. Colour No. Colour

0 black 12 purple
1 blue 13 olive
2 green 14 dark_grey
3 cyan 15 light-grey
4 red 16 pale-green
5 magenta 17 light-blue
6 yellow 18 off-white
7 white 19 grey
8 dark_blue 20 cherry
9 dark_green 21 silver
10 blue-green 22 apple
11 brown 23 orange
24-65 Not used

Release 1.1 Page 143

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON APPENDIX A – OPC Communications Control

Appendix A
OPC Communications Control
This appendix contains a list of the available component properties and gives details of the Visual
Basic script interface. These properties can be set in run time by using a Visual Basic script command
– for example: -
OMRONCXOPCCommunicationsControl1.ServerNodeName = “\\NAME”
The Script Interface defines the Visual Basic script interface for the OPC communications control.
See ExecuteVBScript script functions for more information on running Visual Basic Script.

Component Properties
Property Title Example Description
DisplayErrors True When set True, the object will display a message box for any errors.
False If set to False, error messages are not displayed.
ProjectName Name of .OPC file containing the client setup.
ServerComputerName “MyPC” This is the name of the PC with the OPC Server.
ServerName Name of the OPC Server to connect to.
e.g. OMRON.OpenDataServer.1
ServerProjectName Optional filename, which if specified causes the OPC Server to use
the specified file, if supported by the server.

Script Interface
The Script Interface defines the methods for the OPC communications control.

Functions
Value Function for getting and setting an OPC item value.
Read Function to read the value of an OPC item.
Write Function to write the value of an OPC item.

Value
Reads or writes the value of an OPC item.
Example 1 – Reading a value:
intVal = OMRONCXOPCCommunicationsControl1.Value(“MyGroup”, “BoilerTemp”)
In this example, the OPC item ‘BoilerTemp’ in the OPC group called “MyGroup” will be read from the
OPC Server and will be stored in ‘intVal’.

Release 1.1 Page 144

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON APPENDIX A – OPC Communications Control

Example 2 – Writing a value:

OMRONCXOPCCommunicationsControl1.Value(“MyGroup”, “BoilerTemp”) = 50
In this example, the value 50 will be written to the OPC item ‘BoilerTemp’.
Note: ‘Value’ is the default property so is assumed if omitted. Therefore, the following examples are
the same:
intVal = OMRONCXOPCCommunicationsControl1.Value(“MyGroup”, “BoilerTemp”)
and
intVal = OMRONCXOPCCommunicationsControl1 (“MyGroup”, “BoilerTemp”)

Read
Reads the value of an OPC item.
Example of synchronous read:
intVal = OMRONCXOPCCommunicationsControl1.Read(“MyGroup”, “BoilerTemp”)
In this example, the OPC item ‘BoilerTemp’ in the OPC group called “MyGroup” will be read from the
OPC Server and will be stored in ‘intVal’. The script will wait for the read operation to complete before
continuing to execute the next line. This is identical to the operation of the ‘Value’ method.

Write
Writes the value of an OPC item.
Example of synchronous write:
OMRONCXOPCCommunicationsControl1.Write “MyGroup”, “BoilerTemp”, NewValue
In this example, ‘NewValue’ will be written to the OPC item ‘BoilerTemp’ in the OPC group called
“MyGroup”. The script will wait for the write operation to complete before continuing to execute the
next line. This is identical to the operation of the ‘Value’ method.

Release 1.1 Page 145

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON APPENDIX B – Lite Communications Control

Appendix B
Lite Communications Control
This appendix contains a list of the available component properties and gives details of the Visual
Basic script interface. These properties can be set in run time by using a Visual Basic script command
– for example: -
OMRONCXCommunicationsControl1.ServerNodeName = “\\NAME”
The Script Interface defines the Visual Basic script interface for the Lite communications control. See
ExecuteVBScript script functions for more information on running Visual Basic Script.

Component Properties
Property Title Example Description
DisplayErrors True When set True, the object will display a message box for any errors.
False If set to False, error messages are not displayed.
ListPLCs Holds a list of all PLC names configured in the project file. This
property is read only.
ListPoints Holds a list of all point names configured in the project file. This
property is read only.

Script Interface
The Script Interface defines the Visual Basic script interface for the Lite communications control.

Functions
Value Function for getting and setting an area of memory in a PLC. This function allows
logical names to be used. If an array is used, the first element is returned.
Values Function for getting and setting an area of memory in a PLC. This function allows
logical names to be used. If an array is used then a SAFEARRAY is returned with
all values.
SetDefaultPLC Function for setting the default PLC. This is primarily used when a project
contains multiple PLCs.
OpenPLC Opens the specific PLC for communications.
ClosePLC Closes the specific PLC.
ReadArea Function for reading a block of memory from the PLC.
WriteArea Function for writing a block of memory to the PLC.
RunMode Function for reading / writing the current mode of the PLC.
TypeName Function for reading the PLC type (e.g. CQM1H).
IsPointValid Checks a point name is valid.
PLC Memory Functions A, AR, C, CIO, D, DM, DR, E, EM, G, GR, H, IR, LR, SR, ST, T, TC, TK, W.
Functions for getting and setting the memory areas in the PLC.

Release 1.1 Page 146

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON APPENDIX B – Lite Communications Control

Value
Reads the value of an address from a PLC, or writes a value to an address in a PLC. This function
allows logical names.
Example 1 – Reading a value from the PLC using a logical name.
intVal = OMRONCXCommunicationsControl1.Value(“BoilerTemp”)
or
intVal = OMRONCXCommunicationsControl1 (“BoilerTemp”)
In these examples, the PLC address associated with ‘BoilerTemp’ will be read from the PLC and
stored in ‘intVal’. “Value” is the default property and does not have to be specified.
Example 2 – Writing a value to the PLC using a logical name.
OMRONCXCommunicationsControl1.Value(“BoilerTemp”) = 50
or
OMRONCXCommunicationsControl1 (“BoilerTemp”) = 50
In these examples, the value 50 will be written to the PLC address associated with ‘BoilerTemp’.
“Value” is the default property and does not have to be specified.
Further examples
OMRONCXCommunicationsControl1 (“PLCName/DM0”) = 1000
OMRONCXCommunicationsControl1 (“DM0”) = 1000
intval = CommunicationsControl1(“DM100”)
These examples are physical addresses. A PLC name can optionally be specified otherwise the
current default PLC will be assumed.

Values
Reads an array of values from a PLC, or writes an array of values to a PLC. This function allows
logical names. If an array is used then a SAFEARRAY is returned with all values.
Example 1 – Reading an array of values from the PLC using a logical name.
SomeArray = OMRONCXCommunicationsControl1.Values(“BoilerTemps”)
Example 2 – Writing an array of values to the PLC using a logical name.
OMRONCXCommunicationsControl1.Values(“BoilerTemps”) = SomeArray

SetDefaultPLC
The ‘SetDefaultPLC’ function can be used to inform the script parser that a particular PLC is has been
set as the default. Once a default PLC has been set, then it is not necessary (with some functions) to
specify a PLC name. For example,
OMRONCXCommunicationsControl1.SetDefaultPLC(“MyPLC”)
intVal = OMRONCXCommunicationsControl1.Value(“BoilerTemp1”)
OMRONCXCommunicationsControl1.Value(“BoilerTemp1”) = 75
intVal = OMRONCXCommunicationsControl1.Value(“DM50”)
Each ‘Value’ function above will access data in the PLC called ‘MyPLC’.
Note: If there is only 1 PLC in the project then it is not necessary to call the ‘SetDefaultPLC’
function. The first PLC in a project will automatically be set as the default PLC.

Release 1.1 Page 147

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON APPENDIX B – Lite Communications Control

OpenPLC
Opens a PLC for communications. If no PLC is specified then the default PLC is opened.
Example 1:
OMRONCXCommunicationsControl1.SetDefaultPLC(“MyPLC”)
OMRONCXCommunicationsControl1.OpenPLC()
OMRONCXCommunicationsControl1.DM(100) = 10
OMRONCXCommunicationsControl1.DM(50) = 10
Example 2:
OMRONCXCommunicationsControl1.OpenPLC(“MyPLC”)
OMRONCXCommunicationsControl1.DM(100) = 10

ClosePLC
Closes a previously opened PLC. If no PLC is specified then the default PLC is closed.
Example:
OMRONCXCommunicationsControl1.ClosePLC(“MyPLC”)

ReadArea
Reads a specified block of memory from a PLC.
Examples of synchronous read:
MyVariant = OMRONCXCommunicationsControl1.ReadArea(“MyPLC/DM0”, 12, vbString)
MyVariant = OMRONCXCommunicationsControl1.ReadArea(“BoilerTemp”, 10, vbInteger)
MyVariant = OMRONCXCommunicationsControl1.ReadArea(“BoilerTemp”, 20)
In the first example, DM0 to DM11 will be read as characters (part of a string) from ‘MyPLC’ and will
be stored in ‘MyVariant’. The second example demonstrates that it is also possible to use a logical
name for the start address, and that any VB variant types (such as vbInteger) can be used. The third
example shows that the VB Variant type parameter is optional – if none is specified then vbInteger is
assumed. The script will wait for the read operation to complete before continuing to execute the next
line.

WriteArea
Writes a block of memory to a specified area in a PLC.
Examples of synchronous write:
MyString = “TestString”
OMRONCXCommunicationsControl1.WriteArea “MyPLC/DM50”, 10, MyString
Dim newValue(2) As Long
newValue(1) = 0
newValue(2) = 1
OMRONCXCommunicationsControl1.WriteArea “BoilerTemp”,2,newValue

Release 1.1 Page 148

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON APPENDIX B – Lite Communications Control

In the first example, the contents of ‘MyString’ will be written into DM50 to DM54. Any additional data
in ‘MyString’ will be ignored (i.e. if ‘MyString’ is 15 characters in length then the first 10 characters will
be written to DM50 to DM54 and the remaining 5 characters will be ignored – {Note: each PLC
address holds 2 characters}). The second example shows that a logical name can be used. The
script will wait for the write operation to complete before continuing to execute the next line.

RunMode
Reads the current operating mode of a PLC (Stop/Program, Debug, Monitor, Run), where
0=Stop/Program mode, 1=Debug mode, 2=Monitor mode and 4=Run mode.
Example
intMode = OMRONCXCommunicationsControl1.RunMode(“MyPLC”)
In this example, the operating mode would be read from ‘MyPLC’ and stored in ‘intMode’. If ‘MyPLC’
was in ‘Monitor’ mode then ‘intMode’ would be set to the value 2.

TypeName
Reads the PLC model name of a PLC (e.g. C200H, CQM1H, CVM1 etc).
Example
strPLCType = OMRONCXCommunicationsControl1.TypeName(“MyPLC”)
In this example, the PLC model type will be read from ‘MyPLC’ and will be stored in ‘strPLCType’.

IsPointValid
Checks if a Point name has been defined in the CX-Server project file.
Examples
bValid = OMRONCXCommunicationsControl1.IsPointValid(“MyPoint”)
bValid = OMRONCXCommunicationsControl1.IsPointValid(“MyPoint”, “MyPLC”)
In both examples, the boolean variable bValid is set True if the point “MyPoint” has been defined.

PLC Memory Functions

(A, AR, C, CIO, D, DM, DR, E, EM, -
G, GR, H, IR, LR, SR, ST, T, TC, TK, W)
All PLC memory functions (e.g. A, AR, D, DM etc.) work in exactly the same way. The following
examples use the DM function to get and set the value of a DM address in a PLC.
Example 1
intVal = OMRONCXCommunicationsControl1.DM(100)
In this example, the contents of DM100 will be read from the PLC and stored in ‘intVal’.

Release 1.1 Page 149

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON APPENDIX B – Lite Communications Control

Note: These examples assume there is only 1 PLC in the CX-Server project file, or that the
‘SetDefaultPLC’ function has been used to select the required PLC. Refer to the
‘SetDefaultPLC’ function for details about using script with multiple PLCs in the project.
Example 2
OMRONCXCommunicationsControl1.DM(100) = 75
In this example, the value 75 will be written to DM100 in the PLC.
Bit addressing, that is accessing data from individual memory bits, is also supported by these memory
areas: IR, AR, HR and CIO.
Example 3
bVal = OMRONCXCommunicationsControl1.IR(“100.2”)
In this example, the status of bit IR100.2 (i.e. bit 2 of IR100) will be read from the PLC and stored in
‘bVal’ (e.g. ‘bVal’ will be set to TRUE or FALSE).
Example 4
OMRONCXCommunicationsControl1.IR(“100.2”) = True
In this example, bit IR100.2 (i.e. bit 2 of IR100) in the PLC will be set to True. Note that use of the
quotes is optional, but is required to differentiate between 100.1 and 100.10

Release 1.1 Page 150

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON APPENDIX C – VBScript Features

APPENDIX C
VBScript Features
This appendix provides a summary of VBScript features available for use with the ExecuteVBScript
and ExecuteVBScriptFile script functions. These features are provided by the Windows Scripting
Host, included by default with Windows 98 and Windows 2000. For Windows 95 and Windows NT,
the Windows Scripting Host is available as a free download from Microsofts Web site.
For details of the latest versions and support contact Micrsoft at –
http://msdn.microsoft.com/scripting

Category Keyword / Feature

Array handling Array
Dim, Private, Public, ReDim
IsArray
Erase
LBound, UBound
Assignments Set
Comments Comments using ‘ or Rem
Constants/Literals Empty
Nothing
Null
True, False
Control flow Do…Loop
For…Next
For Each…Next
If…Then…Else
Select Case
While…Wend
With
Conversions Abs
Asc, AscB, AscW
Chr, ChrB, ChrW
CBool, CByte
CCur, Cdate
CDbl, CInt
CLng, CSng, CStr
DataSerial, DateValue
Hex, Oct
Fix, Int
Sgn
TimeSerial, TimeValue
Date / Times Date, Time
DateAdd, DateDiff, DatePart
DateSerial, DateValue
Day, Month, MonthName
Weekday, weekdayName, Year
Hour, Minute, Second
Now
TimeSerial, TimeValue

Release 1.1 Page 151

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON APPENDIX C – VBScript Features

Category Keyword / Feature

Declarations Class
Const
Dim, Private, Public, ReDim
Function, Sub
Property Get, Property Let, Property Set
Error Handing On Error
Err
Expressions Eval
Excute
RegExp
Replace
Test
Formatting Strings FormatCurrency
FormatDateTime
FormatNumber
FormatPercent
Input / Output InputBox
LoadPicture
MsgBox
Literals Empty
False
Nothing
Null
True
Math Atn, Cos, Sin, Tan
Exp, Log, Sqr
Randomize, Rnd
Miscellaneous Eval Function
Execute Statement
RGB Function
Objects CreateObject
Err Object
GetObject
RegExp
Operators Addition (+), Subtraction (-)
Exporentiation (^)
Modulus arithmetic (Mod)
Multiplication (*), Division (/)
Integer Division (\)
Negation (-)
String concatentation (&)
Equality (=), Inequality (<>)
Less Than (<), LessThan or Equal(<+)
Greater Than (>)
Greater Than or Equal To (>=)
Is
And, Or, Xor
Eqv, Imp
Options Option Explicit

Release 1.1 Page 152

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON APPENDIX C – VBScript Features

Category Keyword / Fearure

Procedures Call
Function, Sub
Property Get, Property Let, Property Set
Rounding Abs
Int, Fix, Round
Sgn
Script Engine ID ScriptEngine
ScriptEngineBuildVersion
ScriptEngineMajorVersion
ScriptEngineMinorVersion
Strings Asc, AscB, AscW
Chr, ChrB, ChrW
Filter, InStr, InStrB
InStrRev
Join
Len, LenB
LCase, UCase
Left, LeftB
Mid, MidB
Right, RightB
Replace
Space
Split
StrComp
String
StrReverse
LTrim, RTrim, Trim
Variants IsArray
IsDate
IsEmpty
IsNull
IsNumeric
IsObject
TypeName
VarType

Release 1.1 Page 153

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON APPENDIX D – JScript Features

APPENDIX D
JScript Features
This appendix provides a summary of JScript features available for use with the ExecuteJScript and
ExecuteJScriptFile script functions. These features are provided by the Windows Scripting Host,
included by default with Windows 98 and Windows 2000. For Windows 95 and Windows NT, the
Windows Scripting Host is available as a free download from Microsofts Web site.
For details of the latest versions and support contact Micrsoft at –
http://msdn.microsoft.com/scripting

Category Keyword / Feature

Array Handing Array
join, length, reverse, sort
Assignments Assign (=)
Compound Assign (OP=)
Booleans Boolean
Comments /*…*/ or //
Constants / Literals NaN
null
true, false
Infinity
undefined
Control flow break
continue
for
for..in
if…else
return
while
Dates and Time Date
getDate, getDay, getFullYear, getHours,
getMilliseconds, getMinutes, getMonth, getSeconds,
getTime, getTimezoneOffset, getYear,
getUTCDate, getUTCDay, getUTCFullYear,
getUTCHours, getUTCMilliseconds, getUTCMinutes,
getUTCMonth, getUTCSeconds,
setDate, setFullYear, setHours, setMilliseconds,
setMinutes, setMonth, setSeconds, setTime, setYear,
setUTCDate, setUTCFullYear, setUTCHours,
setUTCmillisecinds, setUTCMinutes, setUTCMonth,
setUTCSeconds,
toGMTString, toLocaleString, toUTCString, parse, UTC
Declarations function
new
this
var
with

Release 1.1 Page 154

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON APPENDIX D – JScript Features

Category Keyword / Feature

Function Creation Function
arguments, length
Global Methods Global
escape, unescape
eval
isFinite, isNaN
parseInt, parseFloat
Maths Math
abs, acos, asin, atan, atan2, ceil, cos, exp, floor, log,
max, min, pow, random, round, sin, sqrt, tan,
E, LN2, LN10, LOG2E, LOG10E, PI, SQRT1_2, SQRT2
Numbers Number
MAX_VALUE, MIN_VALUE
NaN
NEGATIVE_INFINITY, POSITIVE_INFINITY
Object Creation Object
new
constructor, prototype, toString, valueOf
Operators Addition(+), Subtraction (-)
Modulus arithmetic (%)
Multiplication (*), Division (/)
Negation (-)
Equality (==), Inequality (!=)
Less Than (<), Less Than or Equal To (<=)
Greater Than (>)
Greater Than or Equal To (>=)
Logical And (&&), Or (||), Not (!)
Bitwise And (&), Or (|), Not (~), Xor (^)
Bitwise Left Shift (<<), Shift Right (>>)
Unsigned Shift Right (>>>)
Conditional (?:)
Comma (,)
delete, typeof, void
Decrement (--), Increment (++)
Objects Array
Boolean
Date
Function
Global
Math
Number
Object
String
Strings String
charAt, charCodeAt, fromCharCode
indexOf, lastIndexOf
split
toLowerCase, toUpperCase
length

Release 1.1 Page 155

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON GLOSSARY OF TERMS – Script Language

GLOSSARY OF TERMS
AND A logic operator used to interrogate Boolean type points. AND returns
‘TRUE’ if all arguments are ‘TRUE’. An example of AND is that if a is a
statement and b is a statement, AND returns ‘TRUE’ if both a and b are
‘TRUE’. If one or both statements return ‘FALSE’ then AND returns
‘FALSE’.
Application A software program that accomplishes a specific task. Examples of
applications are CX-Supervisor, SYSMAC-CDM, Microsoft Word for
Windows and Microsoft Excel. CX-Supervisor and its development
environment allows the creation and testing of new applications through a
Graphical User Interface (GUI).
Arguments Words, phrases, or numbers that can be entered on the same line as a
command or statement to expand or modify the command or statement
within the CX-Supervisor script language. The command acts on the
argument. In essence the command is a verb, and the argument is the
object of the verb. An example of an argument in CX-Supervisor is
“DDETerminate(channel)” where DDETerminate is a command within
the script language, and channel is the argument upon which the
command will act.
Bitmap The representation of an image stored in a computer’s memory. Each
picture element (pixel) is represented by bits stored in the memory. In CX-
Supervisor a bitmap image can be installed as a single object.
Boolean type A type of point where the value of the point can be one of two states.
Essentially the two states are ‘0’ and ‘1’, but these states can be assigned a
meaningful designation. Examples are:
State Example Example Example Example
0 ‘OFF’ ‘FALSE’ ‘OUT’ ‘CLOSED’
1 ‘ON’ ‘TRUE’ ‘IN’ ‘OPEN’
See also: AND, NOT and OR.
COM COM is a Microsoft technology that allows components used to interact.
Communications Driver The relevant communications management system for OMRON PLCs in
conjunction with Microsoft Windows, providing facilities for other SYSMAC
software to maintain PLC device and address information and to
communicate with OMRON PLCs and their supported network types.
Constant Within CX-Supervisor, a constant is a point within the script language that
takes only one specific value.
Control Object In CX-Supervisor, a control object is applied in the development
environment and can be a pushbutton, a toggle button, a slider, a trend
graph, a rotational gauge or a linear gauge. Essentially a control object can
be a complex graphic object consisting of a number of primitive graphic
objects, which provides user interaction.

Release 1.1 Page 156

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON GLOSSARY OF TERMS – Script Language

Database Connection Level A Database Connection Level is a string which determines what level in the
database tree hierarchy is to be operated on. Some examples are listed
below:
"Northwind" Connectionlevel
"CSV.Result" Recordset level
"Northwind.Order Details.OrderID" Field level
"Invoice.Data Types" Schema level
DCOM DCOM is a distributed version of COM that allows components on different
PCs to interact over a network.
DDE Dynamic Data Exchange. A channel through which correctly prepared
programs can actively exchange data and control other applications within
Microsoft Windows. CX-Supervisor, through the use of its script language,
allows extensive use of DDE functionality.
Development Environment SCADA applications are created and tested using the development
environment within CX-Supervisor. On completion, the finished application
can be delivered as a final customer application to be run by the run-time
environment.
DLL Dynamic Link Library. A program file that although cannot be run stand-
alone as an executable, can be utilised by one or more applications or
programs as a common service. DLL files have a *.DLL extension. DLL’s
comprise a number of stand-alone functions. In CX-Supervisor, a DLL
containing icons can be accessed to represent the display part of an OLE
object. One such DLL, ‘MORICONS.DLL’, is provided in the standard
Microsoft Windows installation.
Download A recipe is downloaded during runtime. This process involves identifying
the appropriate recipe and executing the validation code, if any exists. The
download is complete when each ingredient has set its point to the target
value.
Embedded Object An embedded object is a complex object that can be a bitmap object or an
OLE object.
Executable A file that contains programs or commands of an application that can be
executed by a user or another application. Executable files have a *.EXE
file extension. CX-Supervisor provides two executable files, one for the
development environment (CX-SUPERVISORDEV.EXE), and one for the
run-time environment (SCS.EXE).
Expressions In the CX-Supervisor script language, expressions are a construct for
computing a value from one or more operands. For instance, in the
example “lift = height + rate”, the expression is “height + rate”
where the result yielded from the expression is used for the value of “lift”.
Outside of the script language, expressions consisting of operators and
operands can be used to control objects , through actions.

Release 1.1 Page 157

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON GLOSSARY OF TERMS – Script Language

Graphic Object In CX-Supervisor, a graphic object is created in the development

environment, and can be a line, an arc, a polygon (including a square and
rectangle), a round rectangle, an ellipse (including a circle), or a polyline. A
complex object can exist as a combination of two or more graphic objects.
GUI Graphical User Interface. Part of a program that interacts with the user and
takes full advantage of the graphics displays of computers. A GUI employs
pull-down menus and dialog boxes for ease of use. Like all Microsoft
Windows based applications, CX-Supervisor has a GUI.
I / O type Input / Output type. An attribute of a point that defines the origin and
destination of the data for that point. The data for a point can originate (be
input from) and is destined (is output to) to the internal computer memory,
PLC, DDE target application.
Icon Pictorial representations of computer resources and functions. The CX-
Supervisor development environment and run-time environment are run
from icons. Icons are also used in CX-Supervisor to indicate an OLE
object.
Ingredient Each recipe consists of at least one ingredient. Each ingredient must be
related to an existing point.
Integer type A type of point where the value of the point can only be a whole positive or
negative number.
Item Within the CX-Supervisor script language, Item is used in DDE functions to
contain specific information pertaining to an outside application. Using DDE
functions, CX-Supervisor allows the manipulation of an outside application
with the target application command contained within Item.
JVM Java Virtual Machine – allows the execution of Java Script and Java
Applets.
Microsoft Excel A spreadsheet application.
Microsoft Windows A windowing environment for MS-DOS computers, that is noted for its GUI,
and for features such as multiple typefaces, desk accessories (such as a
clock, calculator, calendar and notepad), and the capability of moving text
and graphics from one application to another via a clipboard.
CX-Supervisor will run only under Microsoft Windows. DDE functions
communicating with other applications supported by CX-Supervisor use
Microsoft Windows as a basis.
Microsoft Word for Windows A word processing application.
See also SVGA mode and VGA mode.
Nesting To incorporate one or more IF THEN ELSE/ELSEIF ENDIF statements
inside a structure of the same kind.
Network 1. Part of the PLC configuration, based on the device type. The number of
Networks available is dependant on the device type.

Release 1.1 Page 158

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON GLOSSARY OF TERMS – Script Language

2. A number of computers linked together with a central processing point

known as a Server which is accessible to all computers. Networks
affect CX-Supervisor in that further Network associated options are
available if the computer is Network connected.
Non-Volatile A point that is designated as ‘non-volatile’ is a point whose value is saved
on disk and automatically reloaded when CX-Supervisor resumes
execution.
NOT A logic operator used to interrogate Boolean type points which produces the
Boolean inverse of the supplied argument. An example of NOT is that if a
is a statement and is ‘FALSE’, then NOT returns ‘TRUE’. If a is a statement
and is ‘TRUE’, then NOT returns ‘FALSE’.
Object In CX-Supervisor, an object can be text, graphics, a control, a bitmap, or
OLE object as created in the development environment. A complex object
can exist as a combination of two or more objects of any of the above
types. Specifically, graphical objects can be categorised as a line, an arc, a
polygon (including a square and rectangle), a round rectangle, an ellipse
(including a circle), or a polyline. A control is essentially a complex graphic
object and is specifically either a pushbutton, a toggle button, a slider, a
trend graph, a rotational gauge or a linear gauge.
OLE Object Linking and Embedding. Used to transfer and share information
between Microsoft Windows based applications and accessories. When
OLE is used in CX-Supervisor, it is possible to view or even edit a file from
a target application.
Operand The term used for constants or point variables.
Operator A symbol used as a function, with infix syntax if it has two arguments (e.g.
“+”) or prefix syntax if it has only one argument (e.g. NOT). The CX-
Supervisor script language uses operators for built-in functions such as
arithmetic and logic.
OR A logic operator used to interrogate Boolean type points. OR returns
‘TRUE’ if any of the supplied arguments are ‘TRUE’. An example of OR is
that if a is a statement and b is a statement, OR will return ‘TRUE’ if either a
and b are ‘TRUE’. If both statements return ‘FALSE’ then OR will return
‘FALSE’.
Pages The combination and manipulation of pages containing objects within
projects forms the basis of CX-Supervisor. More than one page can exist
for each project. The pages in a project provide the visual aspect of CX-
Supervisor corresponding to a display with the objects contained in each
page providing a graphical representation of the system being monitored.
Pixel A single displayable point on the screen from which a displayed image is
constructed. The screen resolution of the computer’s Visual Display Unit
(VDU) is defined by the number of pixels across and the number of pixels
down (e.g. 1024 x 768).
PLC Programmable Logic Controller.

Release 1.1 Page 159

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON GLOSSARY OF TERMS – Script Language

Point variable A point within the CX-Supervisor script language that stores a value or
string assigned to that point.
Point A point is used to hold a value of a predefined type - Boolean, Integer, Text,
etc. The contents of a point may be controlled by an object or I/O
mechanism such as DDE. The contents of a point may control the action or
appearance of an object, or be used for output via an I/O mechanism.
Program Manager An integral part of Microsoft Windows 3.x which allows Microsoft Windows
based applications to be started from icons and for all applications to be
organised. CX-Supervisor can be run from Program Manager.
Project A CX-Supervisor application will consist of one or a number of pages linked
together. The pages may contain passive or active graphics, text or
animations, and may be grouped together logically to form a project. A
project may consist of many pages, or simply a single page. Projects may
be built and tested within the CX-Supervisor development environment, and
run stand-alone under the CX-Supervisor run-time environment.
Only one project at a time may be open for editing within the CX-Supervisor
development environment.
Real type A type of point where the value of the point can be any number, including
those containing a decimal point.
Recipe A recipe is a set of pre-defined steps used to perform a particular task. A
CX-Supervisor project may contain zero or more number of recipes.
Recipes are defined in the development environment and executed, or
downloaded, in the run-time environment.
Run Time Environment SCADA applications are run using the run-time environment of CX-
Supervisor, following creation of the application in the CX-Supervisor
development environment.
SCADA Supervisory Control and Data Acquisition. (see CX-Supervisor)
Server 1. Within the CX-Supervisor script language, Server is used in DDE
functions to contain a link to an outside application. Using DDE
functions, CX-Supervisor allows the manipulation of an outside
application as specified as the Server.
See also Server Application.
2. A Server is the central processing point of a Network which is
accessible to all computers. Networks affect CX-Supervisor in that
further associated options are available if the computer Network is
connected.
Server Application An application that can be used to view or interact with, whilst currently
within CX-Supervisor.
See also DDE and OLE.

Release 1.1 Page 160

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON GLOSSARY OF TERMS – Script Language

Statement Within the CX-Supervisor script language, a statement is a command

understood by the run-time environment. Statements are constructed of
commands and arguments, which when combined, help to formulate a
finished application to be used in the run-time environment.
String The contents of a Text type point that can only contain literal alphanumeric
characters. A string starts following an opening quotation mark, and ends
before a closing question mark; in the example “name = "spot"”, the
point “name” holds the string spot.
SVGA mode A mode of video display that provides 800 × 600 pixel resolution (or higher)
with 16 or more colours and is supported on Super Video Graphics Adapter
systems.
CX-Supervisor A SCADA software application which creates and maintains graphical user
interfaces and communicates with PLCs and other I/O mechanisms.
Target Value An ingredient must specify a target value for its related point. This is the
value to which the point will be set in runtime when the recipe is
downloaded.
Text Object In CX-Supervisor, a text object is a string on a page. Attributes such as
typeface, point size, embolden, italicise, underline, left justify, flush right,
and centre can be applied to enhance its presentation.
Text type A type of point that holds a string.
Topic Within the CX-Supervisor script language, Topic is used in DDE functions to
specify a file name pertaining to an outside application. Using DDE
functions, CX-Supervisor allows the opening of a file, part of the server
application.
Validation Code Recipe validation code is CX-Supervisor script language which is used to
check point values before downloading a recipe.
VGA mode A mode of video display that provides 640 × 480 pixel resolution with 16
colours and is supported on Video Graphics Adapter systems.
Windows Desktop An integral part of Microsoft Windows which allows Microsoft Windows
based applications to be started from icons and for all applications to be
organised. CX-Supervisor can be run from Windows Desktop.
Wizard Wizards are dialogs used by the CX-Supervisor development environment
to take the user through complex operations in a simplified step-by-step
process.

Release 1.1 Page 161

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON INDEX – Script Language

INDEX
Bin - Text Commands: · 90
Bitmap · 156
Pixel · 159
A Bitwise Operators - Logic and Arithmetic: · 18
Blink - Object Commands: · 31
AcknowledgeAlarms - Alarm Commands: · 70
AcknowledgeAllAlarms - Alarm Commands: · 70
AcknowledgeLatestAlarm - Alarm Commands: · 71
Alarm Commands · 70 C
AcknowledgeAlarms · 70
AcknowledgeAllAlarms · 70 Call - Subroutines: · 28
AcknowledgeLatestAlarm · 71 CancelForce - Point Commands: · 46
ClearAlarmHistory · 71 Case Selected - Control Statements: · 24
CloseAlarmHistory · 72 Chr - Text Commands: · 90
CloseAlarmStatus · 72 ClearAlarmHistory - Alarm Commands: · 71
DisplayAlarmHistory · 73 ClearErrorLog - Event/Error Commands: · 96
DisplayAlarmStatus · 73 ClearGraph -Graph Commands: · 82
EnableAlarms · 74 ClearLogFile - Data Logging Commands: · 104
Is AlarmAcknowledged · 74 ClearSpoolQueue - Printer Commands: · 98
IsAlarmActive · 75 Close Page - Page Commands: · 39
Alarms CloseAlarmHistory - Alarm Commands: · 72
Script Editor · 72 CloseAlarmStatus - Alarm Commands: · 72
Alias Examples · 135 CloseComponent - Communications Commands: ·
Animation Editor 43
Expressions · 7, 157 CloseErrorLog - Event/Error Commands: · 96
Animations CloseFile - File Commands: · 75
Expressions within · 7 CloseLogFile - Data Logging Commands: · 104
Appendix A CloseLogView - Data Logging Commands: · 104
OPC Communications Control · 144 Colour - Object Commands: · 31
Appendix B Colour Palette · 143
Lite Communications Control · 146 COM · 156
Appendix C Command String Delimiters - Punctuation: · 129
VBScript Features · 151 Communications Commands · 43
Appendix D CloseComponent · 43
JScript Features · 154 EnableDDE · 43
Application · 156 EnableOLE · 44
Arguments · 156 EnablePLC · 44
Arithmetic Operators - Logic and Arithmetic: · 18 OpenComponent · 45
Communications Drive · 156
Constant · 156
Control Object · 156
B Control Statements · 21
Case Selected · 24
Balloon Script - Script Examples: · 136 Do While/Until Loop · 27
Basic Point Assignment – Points: · 16 For...Next Loop · 26
BCD - Text Commands: · 90 Nested Conditional Statements · 22

Release 1.1 Page 162

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON INDEX – Script Language

Simple Conditional Statements · 21 DisablePoint - Point Commands: · 47

Conventions in this manual · 6 Display Page - Page Commands: · 38
CopyArray - Point Commands: · 46 DisplayAlarmHistory - Alarm Commands: · 73
CopyFile - File Commands: · 76 DisplayAlarmStatus - Alarm Commands: · 73
Current Object - Object Commands: · 29 DisplayErrorLog - Event/Error Commands: · 97
CX-Supervisor · 161 DisplayRecipes - Recipe Commands: · 86
DLL · 157
Do While/Until Loop - Control Statements: · 27
Download · 157
D DownloadPLCProgram - PLC Commands: · 55
DownloadRecipe - Recipe Commands: · 86, 87
Data Logging Commands · 104 Dynamic Data Exchange · See DDE
ClearLogFile · 104 Dynamic Link Library · See DLL
CloseLogFile · 104
CloseLogView · 104
ExportAndViewLog · 105
ExportLog · 106 E
OpenLogFile · 108
OpenLogView · 108 EditFile - File Commands: · 77
StartLogging · 109 EditGraph - Graph Commands: · 83
StopLogging · 109 Embedded Object · 157
DCOM · 157 EnableAlarms - Alarm Commands: · 74
DDE · 157 EnableDDE - Communications Commands: · 43
Example · 139 EnableErrorLogging - Event/Error Commands: · 97
Item · 158 EnableGroup - Point Commands: · 48
Script Editor · 44 EnableOLE - Communications Commands: · 44
Server · 160 EnablePLC - Communications Commands: · 44
Server Application · 160 EnablePoint - Point Commands: · 48
Topic · 161 EnablePrinting - Printer Commands: · 99
DDE Commands · 66 Event/Error Commands · 96
DDE TerminateAll · 70 ClearErrorLog · 96
DDEExecute · 66 CloseErrorLog · 96
DDEInitiate · 66 DisplayErrorLog · 97
DDEOpenLinks · 67 EnableErrorLogging · 97
DDEPoke · 68 LogError · 97
DDERequest · 68 LogEvent · 98
DDETerminate · 69 Exponential - General Commands: · 39
DDE Script - Script Examples: · 139 ExportAndViewLog - Data Logging Commands: ·
DDE TerminateAll - DDE Commands: · 70 105
DDEExecute - DDE Commands: · 66 ExportLog - Data Logging Commands: · 106
DDEInitiate - DDE Commands: · 66 Expressions · 7
DDEOpenLinks - DDE Commands: · 67
DDEPoke - DDE Commands: · 68
DDERequest - DDE Commands: · 68
DDETerminate - DDE Commands: · 69 F
DeleteFile - File Commands: · 76
Development environment · 157 File Commands · 75
Disable - Object Commands: · 33 CloseFile · 75
DisableGroup - Point Commands: · 47

Release 1.1 Page 163

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON INDEX – Script Language

CopyFile · 76 GUI · 158

DeleteFile · 76
EditFile · 77
FileExists · 77
MoveFile · 77 H
OpenFile · 78
PrintFile · 78 Height - Object Commands: · 33
Read · 79 Hex - Text Commands: · 92
ReadMessage · 79 Horizontal Fill - Object Commands: · 34
SelectFile · 80
Write · 81
WriteMessage · 82
FileExists - File Commands: · 77
For...Next Loop - Control Statements: · 26
I
Force - Point Commands: · 48
Icons · 158
ForceReset - Point Commands: · 49
Indentation - Punctuation: · 130
ForceSet - Point Commands: · 49
Indirection within Script Commands and
FormatText - Text Commands: · 91
Expressions · 132
Functions and Methods · 11
Ingredient · 158
Further Point Assignment – Points: · 17
InitiateArray - Point Commands: · 51
Input Point - Point Commands: · 51
Input/Output type · 158
G Is AlarmAcknowledged - Alarm Commands: · 74
IsAlarmActive - Alarm Commands: · 75
General Commands · 39
Exponential · 39
PlayOLE · 40
PlaySound · 40
J
Rand · 41
Java Script Features · 154
RunApplication · 41
Java Virtual Machine · 158
RunHelp · 42
JScript Features · 154
ShutDown · 42
Sleep · 42
GenerateReport - Report Commands: · 87
GetBit - Point Commands: · 50
GetPLCMode - PLC Commands: · 56
L
GetPointValue - Point Commands: · 50
GetSpoolCount - Printer Commands: · 99 Left - Text Commands: · 93
GetTextLength - Text Commands: · 92 Lite Communications Control · 146
Glossary of Terms · 156 LogError - Event/Error Commands: · 97
Graph Commands · 82 LogEvent - Event/Error Commands: · 98
ClearGraph · 82 Logic and Arithmetic · 18
EditGraph · 83 Arithmetic Operators · 18
Snapshot · 84 Bitwise Operators · 18
StartGraph · 85 Relational Operators · 20
StopGraph · 84, 85 Logical Operators - Logic and Arithmetic: · 19
Graphic Object · 158 Login - Security Commands: · 102
Graphical User Interface · See GUI Logout - Security Commands: · 103

Release 1.1 Page 164

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON INDEX – Script Language

OpenFile - File Commands: · 78

M OpenLogFile - Data Logging Commands: · 108
OpenLogView - Data Logging Commands: · 108
Other Objects - Object Commands: · 30
Message - Text Commands: · 93
OutputPoint - Point Commands: · 52
Microsoft
Excel · 158
Windows · 158
Word for Windows · 158
Mid - Text Commands: · 94
P
Miscellaneous Commands
Remarks · 131 Page – Scripts: · 10
Move - Object Commands: · 35 Page Commands · 38
MoveFile - File Commands: · 77 Close Page · 39
Multiple Commands - Punctuation: · 130 Display Page · 38
Pages · 159
Parenthesis - Punctuation: · 131
Pixel · 159
N PlayOLE - General Commands: · 40
PlaySound - General Commands: · 40
PLC · 159
Nested Conditional Statements - Control
Network · 158
Statements: · 22
PLC Commands · 54
Nesting · 158
DownloadPLCProgram · 55
Non-volatile · 159
GetPLCMode · 56
PLCCommsFailed · 57
PLCMonitor · 57
O SetPLCMode · 58
SetPLCPhoneNumber · 58
UploadPLCProgram · 59
Object · 159 PLC Memory Functions · 149
Object Commands · 29 PLCCommsFailed - PLC Commands: · 57
Blink · 31 PLCMonitor - PLC Commands: · 57
Colour · 31 Point · 160
Current Object · 29 Point Arrays within Script Commands and
Disable · 33 Expressions · 133
Height · 33 Point Commands · 46
Horizontal Fill · 34 CancelForce · 46
Move · 35 CopyArray · 46
Other Objects · 30 DisableGroup · 47
Rotate · 35 DisablePoint · 47
Vertical Fill · 36 EnableGroup · 48
Visible · 37 EnablePoint · 48
Width · 38 Force · 48
Object Linking and Embedding · See OLE ForceReset · 49
Objects – Scripts: · 10 ForceSet · 49
OLE · 159 GetBit · 50
OPC Communications Control · 144 GetPointValue · 50
OpenComponent - Communications Commands: · InitiateArray · 51
45 Input Point · 51

Release 1.1 Page 165

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON INDEX – Script Language

OutputPoint · 52
PointExists · 52
SetBit · 53
R
SetPointValue · 53
Rand - General Commands: · 41
Point Variable · 160
Read - File Commands: · 79
PointExists - Point Commands: · 52
ReadMessage - File Commands: · 79
Points · 16
Recipe · 160
Basic Point Assignment · 16
Recipe Commands · 86
Boolean · 156
DisplayRecipes · 86
Further Point Assignment · 17
DownloadRecipe · 86, 87
Integer · 158
Relational Operators - Logic and Arithmetic: · 20
Real · 160
Remarks - Miscellaneous Commands: · 131
Script Editor · 17
Report Commands · 87
Text · 161
GenerateReport · 87
PrintActivePage - Printer Commands: · 100
PrintReport · 88
Printer Commands · 98
ViewReport · 89
ClearSpoolQueue · 98
Return - Subroutines: · 28
EnablePrinting · 99
Right - Text Commands: · 94
GetSpoolCount · 99
Rotate - Object Commands: · 35
PrintActivePage · 100
RunApplication - General Commands: · 41
PrintPage · 100
RunHelp - General Commands: · 42
PrintScreen · 101
Runtime Environment · 160
PrintSpoolQueue · 101
SetPrinterConfig · 101
PrintFile - File Commands: · 78
PrintMessage - Text Commands: · 94
PrintPage - Printer Commands: · 100
S
PrintReport - Report Commands: · 88
PrintScreen - Printer Commands: · 101 SCADA · 160
PrintSpoolQueue - Printer Commands: · 101 Script Editor
Program Manager · 160 AND statement · 156
Programmable Logic Controller · See PLC Applications, use of external · 6, 66, 67, 68, 69,
Project · 160 139, 140, 141, 142
Project – Scripts: · 10 Arithmetic functions · 19
Punctuation Conditional statements, nesting · 24
Command String Delimiters · 129 Control Statements · 123. See also Control
Indentation · 130 Statements
Multiple Commands · 130 Current object statement · 29
Parenthesis · 131 Examples · 136
Quotation Marks · 131 Executable files, use of · 6, 67, 157
FALSE Boolean state · 6, 8
Functions and methods, summary of · 16
Logical functions · 20
Q Mathematical precedence · 17, 18
Multiple statements on one line · 130
Nesting conditional statements · 24
Quotation Marks - Punctuation: · 131
NOT statement · 159
Object Commands · 129. See also Object
Commands

Release 1.1 Page 166

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON INDEX – Script Language

Operator and operand · 6, 159 Statement · 161

OR statement · 159 StopGraph - Graph Commands: · 84, 85
Parenthesis · 18, 131 StopLogging - Data Logging Commands: · 109
Quotation marks · 131 String · 161
Relational functions · 21 Subroutines · 28
Script code examples · 136 Call · 28
Subroutines · 129. See also Subroutines Return · 28
Summary of functions and methods · 16 Super Video Graphics Adapter · See SVGA
TRUE Boolean state · 6, 8 Supervisory Control and Data Acquisition · See
Script Examples · 136 SCADA
Balloon Script · 136 SVGA · 161
DDE Script · 139
Script Interface · 144, 146
Functions · 144, 146
PLC Memory Functions · 149 T
Script Interface Functions
ClosePLC · 148 Target Value · 161
OpenPLC · 148 TCAutoTune - Temperature Controller Commands:
Read · 145 · 60
ReadArea · 148 TCBackupMode - Temperature Controller
RunMode · 149 Commands: · 60
SetDefaultPLC · 147 TCGetStatusParameter - Temperature Controller
TypeName · 149 Commands: · 61
Value · 144, 147 TCRemoteLocal - Temperature Controller
Values · 147 Commands: · 62
Write · 145 TCRequestStatus - Temperature Controller
WriteArea · 148 Commands: · 63
Scripts · 10 TCReset - Temperature Controller Commands: ·
Objects · 10 65
Page · 10 TCRspLsp - Temperature Controller Commands: ·
Project · 10 64
Security Commands · 102 TCRunStop - Temperature Controller Commands:
Login · 102 · 64
Logout · 103 TCSaveData - Temperature Controller Commands:
SetupUsers · 103 · 65
SelectFile - File Commands: · 80 TCSettingLevel1 - Temperature Controller
SetBit - Point Commands: · 53 Commands: · 65
SetPLCMode - PLC Commands: · 58 Temperature Controller Commands · 60
SetPLCPhoneNumber - PLC Commands: · 58 TCAutoTune · 60
SetPointValue - Point Commands: · 53 TCBackupMode · 60
SetPrinterConfig - Printer Commands: · 101 TCGetStatusParameter · 61
SetupUsers - Security Commands: · 103 TCRemoteLocal · 62
ShutDown - General Commands: · 42 TCRequestStatus · 63
Simple Conditional Statements - Control TCReset · 65
Statements: · 21 TCRspLsp · 64
Sleep - General Commands: · 42 TCRunStop · 64
Snapshot - Graph Commands: · 84 TCSaveData · 65
StartGraph - Graph Commands: · 85 TCSettingLevel1 · 65
StartLogging - Data Logging Commands: · 109 Text Commands · 90

Release 1.1 Page 167

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON INDEX – Script Language

BCD · 90
Bin · 90
Chr · 90
FormatText · 91
GetTextLength · 92
Hex · 92
Left · 93
Message · 93
Mid · 94
PrintMessage · 94
Right · 94
TextToValue · 95
ValueToText · 95
Text Object · 161
TextToValue - Text Commands: · 95
Topic · 161
Typographical conventions · 6

U
UploadPLCProgram - PLC Commands: · 59
Using Aliases · 134

V
Validation Code · 161
ValueToText - Text Commands: · 95
VBScript Features · 151
Vertical Fill - Object Commands: · 36
VGA · 161
Video Graphics Adapter · See VGA
ViewReport - Report Commands: · 89
Visible - Object Commands: · 37
Visual Basic Script Features · 151

W
Width - Object Commands: · 38
Windows Desktop · 161
Wizard · 161
Write - File Commands: · 81
WriteMessage - File Commands: · 82

Release 1.1 Page 168

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]
 OMRON INDEX – Script Language

Release 1.1 Page 169

AUDIN - 8, avenue de la malle - 51370 Saint Brice Courcelles - Tel : 03.26.04.20.21 - Fax : 03.26.04.28.20 - Web : http: www.audin.fr - Email : [email protected]