WriteSystemLog Method (String, String)

VirtualUserScript WriteSystemLog Method (String, String)

C# API

Writes an alert of Error severity to the Alerts table in Test Controller, specifying a heading to prefix to the message.

Namespace: Facilita.Fc.Runtime
Assembly: fc_clr (in fc_clr.dll) Version: 9.5.7.98

Syntax

C++

Copy to Clipboard Print

public void WriteSystemLog(
	string heading,
	string message
)

public void WriteSystemLog(
	string heading,
	string message
)

Parameters

heading: Type: System String
A string to be prefixed to the output message.

message: Type: System String
An alert message which appears in the Description column of the alerts table in the Alerts sub-view of Test Controller.

Remarks

This method was included for backwards compatibility with older eggPlant Performance scripts. The Test Controller Alerts table is made accessible from the script using WriteSystemLog. WriteSystemLog will add an alert of severity level Error. Other table fields include the time into the test the error alert was raised (HH:MM:SS), the source of the alert (this will always be 'Engine' when called from the script), the index of the VU who raised the alert and the injector that VU was deployed on, the group which that VU was a member of and the script the VU was executing when the alert was raised.

Caution
WriteSystemLog must be used sparingly. It is possible to flood the Alerts log. For diagnostic purposes use WriteMessage(String), SetProgressPoint(String), Error(String) and Warn(String) to output to the VU event log; this can be viewed at runtime in Test Controller. The Alerts log should only be used for a small number of important messages.