Component: Event Log (SCADA Tools)

From Flowcode Help
Jump to navigationJump to search


Author Matrix TSL
Version 1.0 (Release)
Category SCADA Tools


Image Event Log component

A simulation component designed to create a simple log record of events in your SCADA system. Logs to a file and / or to a console tab including optional automated time stamp.

Examples

No additional examples


Downloadable macro reference

This component does not contain any downloadable macros

Simulation macro reference

LogEvent

Allows an event string to be logged

Parameters

<- STRING LogString
This parameter may be returned back to the caller


Return value

This call does not return a value



Property reference

Log To Console

This property is of type True or false and can be referenced with the variable name LogToConsole.

No additional information


Log To File

This property is of type True or false and can be referenced with the variable name LogToFile.

No additional information


Include Timestamp

This property is of type True or false and can be referenced with the variable name IncludeTS.

Controls if a timestamp is appended to the start of the log string.

Yes: Add timestamp to log string

No: Leave log string as is

Console Name

This property is of type Line of text and can be referenced with the variable name ConsoleName.

No additional information


Clear On Init

This property is of type True or false and can be referenced with the variable name ConsoleClear.

Selects if the contents of the console are maintained or wiped on runtime start.

Yes: Console is automatically cleared

No: Console is maintained and appended

Log File

This property is of type Filename and can be referenced with the variable name LogFile.

File to store the log data.

Default: $(srcdir)log.txt


$(srcdir) specifies the directory containing your Flowcode project file.

log.txt specifies a file named log.txt


If the file does not exist then it will be automatically created for you.

Clear On Init

This property is of type True or false and can be referenced with the variable name FileClear.

Selects if the contents of the log file are maintained or wiped on runtime start.

Yes: Log file is automatically cleared

No: Log file is maintained and appended

TimeStamp

This property is of type Fixed list of ints and can be referenced with the variable name TimeStamp.

No additional information


US Date Format

This property is of type True or false and can be referenced with the variable name TimeStamp1::USDate.

Specifies the format of the date string.


No - "DD/MM/YY"

Yes - "MM/DD/YY"