LogDirectory Property
The path to a directory for logging.
Syntax
getLogDirectory(): string; setLogDirectory(logDirectory: string): void;
Default Value
""
Remarks
Setting LogDirectory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the class will log the complete text of the outgoing request and the incoming response.
The class will write multiple log files for each transmission, with separate extensions for each type of data:
| Status (.log) | Contains information about the steps taken during processing. |
| Request (.out) | Contains the raw request/response that is sent by the class. |
| Response (.in) | Contains the raw request/response that is received by the class. |
| Incoming ebXML (.ieb) | Contains the incoming ebXML message. |
| Outgoing ebXML (.oeb) | Contains the outgoing ebXML message. |
One or more of these log files may be disabled by setting the LogOptions configuration setting. LogDirectory supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the class will attempt to create the directory. The following macros are supported:
| %AS4From% | The AS4From value in the message. Note that invalid filename characters will be replaced with the _ character. |
| %MessageId% | The MessageId of the transmission, after it is generated. |
| %Date:format% | Format is a platform-specific date/time formatting string. For example: |
The filenames will be chosen automatically by the class. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile will contain the name of the files just written, minus the extension.
If logs cannot be written an exception will be thrown.