Component: Event Log (Runtime Tools): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix TSL
Version	1.0
Category	Runtime Tools

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.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_EventLog.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_EventLog.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

LogEvent

	LogEvent
Allows an event string to be logged
- STRING	LogString

- VOID	Return

Property reference

	Properties
	Log To Console

	Log To File

	Include Timestamp
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 Properties
	Console Name

	Clear On Init
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
	File Properties
	Log File
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
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 Properties
	TimeStamp

	US Date Format
Specifies the format of the date string. No - "DD/MM/YY" Yes - "MM/DD/YY"

@@ Line 14: / Line 14: @@
 ==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.
+==Component Source Code==
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EventLog.fcfx FC_Comp_Source_EventLog.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EventLog.fcfx FC_Comp_Source_EventLog.fcfx]
 ==Detailed description==
@@ Line 24: / Line 48: @@
 ==Examples==
@@ Line 33: / Line 75: @@
-==Downloadable macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+==Macro reference==
+===LogEvent===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''LogEvent'''
+| width="90%" class="mtx-class-macrohead" | '''LogEvent'''
 |-
 | colspan="2" | Allows an event string to be logged&nbsp;
@@ Line 51: / Line 104: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
@@ Line 77: / Line 128: @@
 |-
 | colspan="2" | 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&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Console Properties
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
@@ Line 87: / Line 142: @@
 |-
 | colspan="2" | 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&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | File Properties
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
@@ Line 97: / Line 156: @@
 |-
 | colspan="2" | 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&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Timestamp Properties
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
@@ Line 107: / Line 170: @@
 |-
 | colspan="2" | Specifies the format of the date string.  No - "DD/MM/YY"  Yes - "MM/DD/YY" &nbsp;
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
-|-
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
-|-
 |}

SteveT (talk | contribs)