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

From Flowcode Help
Jump to navigationJump to search
Line 22: Line 22:
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 68: Line 70:
  
  
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Macro reference==
+
''<span style="color:red;">No additional examples</span>''
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''LogEvent'''
 
−
|-
 
−
| colspan="2" | Allows an event string to be logged&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | LogString
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
  
−
 
+
==Macro reference==
−
==Property reference==
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Log To Console
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Log To File
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Include Timestamp
 
−
|-
 
−
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Console Properties
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Console Name
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Clear On Init
 
−
|-
 
−
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | File Properties
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
 
−
| width="90%" | Log File
 
−
|-
 
−
| colspan="2" | 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.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Clear On Init
 
−
|-
 
−
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timestamp Properties
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | TimeStamp
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | US Date Format
 
−
|-
 
−
| colspan="2" | Specifies the format of the date string.  No - "DD/MM/YY"  Yes - "MM/DD/YY" &nbsp;
 
−
|}==Macro reference==
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''LogEvent'''
 
−
|-
 
−
| colspan="2" | Allows an event string to be logged&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | LogString
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
 
−
 
 
−
 
 
−
 
 
−
==Property reference==
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Log To Console
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Log To File
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Include Timestamp
 
−
|-
 
−
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Console Properties
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Console Name
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Clear On Init
 
−
|-
 
−
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | File Properties
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
 
−
| width="90%" | Log File
 
−
|-
 
−
| colspan="2" | 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.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Clear On Init
 
−
|-
 
−
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timestamp Properties
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | TimeStamp
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | US Date Format
 
−
|-
 
−
| colspan="2" | Specifies the format of the date string.  No - "DD/MM/YY"  Yes - "MM/DD/YY" &nbsp;
 
−
|}==Macro reference==
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''LogEvent'''
 
−
|-
 
−
| colspan="2" | Allows an event string to be logged&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | LogString
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
 
−
 
 
−
 
 
−
 
 
−
==Property reference==
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Log To Console
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Log To File
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Include Timestamp
 
−
|-
 
−
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Console Properties
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Console Name
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Clear On Init
 
−
|-
 
−
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | File Properties
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
 
−
| width="90%" | Log File
 
−
|-
 
−
| colspan="2" | 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.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Clear On Init
 
−
|-
 
−
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timestamp Properties
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | TimeStamp
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | US Date Format
 
−
|-
 
−
| colspan="2" | Specifies the format of the date string.  No - "DD/MM/YY"  Yes - "MM/DD/YY" &nbsp;
 
−
|}==Macro reference==
 
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 16:47, 30 January 2023

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

Fc9-comp-macro.png LogEvent
Allows an event string to be logged 
Fc9-string-icon.png - STRING LogString
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-7-icon.png Log To Console
 
Fc9-type-7-icon.png Log To File
 
Fc9-type-7-icon.png 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 
Fc9-conn-icon.png Console Properties
Fc9-type-10-icon.png Console Name
 
Fc9-type-7-icon.png 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 
Fc9-conn-icon.png File Properties
Fc9-type-13-icon.png 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. 
Fc9-type-7-icon.png 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 
Fc9-conn-icon.png Timestamp Properties
Fc9-type-16-icon.png TimeStamp
 
Fc9-type-7-icon.png US Date Format
Specifies the format of the date string. No - "DD/MM/YY" Yes - "MM/DD/YY"  
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Event_Log_(Runtime_Tools)&oldid=34940"