Class AuditTrailGenerator
CME Audit Trail generator.
Inherited Members
Namespace: OnixS.Cme.ILink3
Assembly: OnixS.Cme.ILink3.dll
Syntax
public class AuditTrailGenerator
Constructors
AuditTrailGenerator(IDecoder)
Initializes a new instance of the class.
Declaration
public AuditTrailGenerator(IDecoder decoder)
Parameters
| Type | Name | Description |
|---|---|---|
| IDecoder | decoder | The SBE decoder used to parse message data. |
AuditTrailGenerator(string, string)
Initializes a new instance of the class.
Declaration
public AuditTrailGenerator(string sbeSchemaFile = "ilinkbinary.xml", string licenseStore = ".")
Parameters
| Type | Name | Description |
|---|---|---|
| string | sbeSchemaFile | The path to the SBE schema file. |
| string | licenseStore | One or more paths to folders containing license files. Multiple paths should be delimited using the '|' character. |
Fields
DateTimeFormat
Gets or sets the format string used to represent DateTime values.
Declaration
public string DateTimeFormat
Field Value
| Type | Description |
|---|---|
| string |
Properties
TradingDayStart
Gets or sets the start time of the trading day in UTC.
Declaration
public TimeSpan TradingDayStart { get; set; }
Property Value
| Type | Description |
|---|---|
| TimeSpan |
Remarks
The default value is 09:45 (UTC).
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | Thrown if the value set is not a valid time of day. |
Methods
~AuditTrailGenerator()
Declaration
protected ~AuditTrailGenerator()
Generate(string, string, bool)
Generates the audit trail from the provided message log file or folder.
Declaration
public void Generate(string path, string outputFolder = null, bool generateBlankFile = false)
Parameters
| Type | Name | Description |
|---|---|---|
| string | path | The path to the message log file or folder. |
| string | outputFolder | The path to the output folder. If |
| bool | generateBlankFile | Indicates whether to generate an empty audit trail file for days or files that contain no messages resulting in audit trail records. |