@event::report

Note: There are three ways to use this script object method.

Option One:

Writes the specified text to the database for reporting purposes. The text appears in the Chronological view of the Exhaustive Report for this event.

Syntax:

@event::report("Report text")

Parameters:

Any text, enclosed in quotes, to record in the Exhaustive Report.

Returns:

(Boolean) true for success; false for failure

Option Two (Deprecated)

Writes the provided string out to the audit record to appear in the hierarchical exhaustive audit report. The notification ID relates this audit statement to a specific notification. This helps to create a more readable hierarchical exhaustive report.

Note: This option has been deprecated in favor of Option Three, below.

Syntax:

@event::report(String logString, String notificationId)

Parameters:

Returns:

(Boolean) true if logString is not empty and the notificationId is valid; otherwise false

Option Three

Writes the provided string out to the audit record to appear in the chronological exhaustive audit report. The recipient allows this audit statement to be related to a specific person.

Syntax:

@event::report(String logString, RecipientScriptObject recipient)

Parameters:

Returns:

(Boolean) true if logString is not empty; otherwise false