LoggingJobHistoryPlugin Class

Quartz.NET API Documentation

Logs a history of all job executions (and execution vetos) via common logging.

Inheritance Hierarchy

System Object
Quartz.Plugin.History LoggingJobHistoryPlugin

Namespace: Quartz.Plugin.History
Assembly: Quartz (in Quartz.dll) Version: 2.2.4.0

Syntax

C++

Copy to Clipboard Print

public class LoggingJobHistoryPlugin : ISchedulerPlugin, 
	IJobListener

public class LoggingJobHistoryPlugin : ISchedulerPlugin, 
	IJobListener

Remarks

The logged message is customizable by setting one of the following message properties to a string that conforms to the syntax of Format(String, Object).

JobToBeFiredMessage - available message data are:
Element Data Type Description
0 String The Job's Name.
1 String The Job's Group.
2 Date The current time.
3 String The Trigger's name.
4 String The Triggers's group.
5 Date The scheduled fire time.
6 Date The next scheduled fire time.
7 Integer The re-fire count from the JobExecutionContext.
The default message text is "Job {1}.{0} fired (by trigger {4}.{3}) at: {2:HH:mm:ss MM/dd/yyyy}"

Element	Data Type	Description
0	String	The Job's Name.
1	String	The Job's Group.
2	Date	The current time.
3	String	The Trigger's name.
4	String	The Triggers's group.
5	Date	The scheduled fire time.
6	Date	The next scheduled fire time.
7	Integer	The re-fire count from the JobExecutionContext.

JobSuccessMessage - available message data are:
Element Data Type Description
0 String The Job's Name.
1 String The Job's Group.
2 Date The current time.
3 String The Trigger's name.
4 String The Triggers's group.
5 Date The scheduled fire time.
6 Date The next scheduled fire time.
7 Integer The re-fire count from the JobExecutionContext.
8 Object The string value (toString() having been called) of the result (if any) that the Job set on the JobExecutionContext, with on it. "NULL" if no result was set.
The default message text is "Job {1}.{0} execution complete at {2:HH:mm:ss MM/dd/yyyy} and reports: {8}"

Element	Data Type	Description
0	String	The Job's Name.
1	String	The Job's Group.
2	Date	The current time.
3	String	The Trigger's name.
4	String	The Triggers's group.
5	Date	The scheduled fire time.
6	Date	The next scheduled fire time.
7	Integer	The re-fire count from the JobExecutionContext.
8	Object	The string value (toString() having been called) of the result (if any) that the Job set on the JobExecutionContext, with on it. "NULL" if no result was set.

JobFailedMessage - available message data are:
Element Data Type Description
0 String The Job's Name.
1 String The Job's Group.
2 Date The current time.
3 String The Trigger's name.
4 String The Triggers's group.
5 Date The scheduled fire time.
6 Date The next scheduled fire time.
7 Integer The re-fire count from the JobExecutionContext.
8 String The message from the thrown JobExecution Exception.
The default message text is "Job {1}.{0} execution failed at {2:HH:mm:ss MM/dd/yyyy} and reports: {8}"

Element	Data Type	Description
0	String	The Job's Name.
1	String	The Job's Group.
2	Date	The current time.
3	String	The Trigger's name.
4	String	The Triggers's group.
5	Date	The scheduled fire time.
6	Date	The next scheduled fire time.
7	Integer	The re-fire count from the JobExecutionContext.
8	String	The message from the thrown JobExecution Exception.

JobWasVetoedMessage - available message data are:
Element Data Type Description
0 String The Job's Name.
1 String The Job's Group.
2 Date The current time.
3 String The Trigger's name.
4 String The Triggers's group.
5 Date The scheduled fire time.
6 Date The next scheduled fire time.
7 Integer The re-fire count from the JobExecutionContext.
The default message text is "Job {1}.{0} was vetoed. It was to be fired (by trigger {4}.{3}) at: {2:HH:mm:ss MM/dd/yyyy}"