Switch preferences: Logging

These preferences allow you to configure the way (log) messages are handled in Switch.

For more information about the different message types, refer to Message types.

Property

Description

Saving log messages

Determines the mechanism for saving log messages to the Switch logging database:

  • Fast (recommended): Uses delayed writing to increase speed but risks losing messages in case of an operating system crash or power failure.

  • Safe: Writes each message to disk before proceeding; this guarantees that no messages are lost, but it slows down Switch when many messages are logged per second.

Export messages to XML

When set to Yes the messages stored in the execution log are automatically exported to XML files at a time and interval as configured by the user (see below), starting with the day on which the feature was turned on.

Note:

The name of the exported files include the Switch server name (as set in the Internal communication preferences) and the date. The file name format is "<server-name> logs YYYY-MM-DD.xml".

Example: SwitchServer logs 2013-12-25.xml

For information on the XML schema of the exported files, see XML schema.

If Export messages is set to Yes, the following additional fields appear:
  • Destination folder: Folder where the exported XML files will be placed.
    Tip: To process the XML files with Switch, set the destination folder to the input folder of an active flow.
  • Timing: Time for exporting the messages. There are two options:
    • Time of the day: If this option is selected, enter a value for Time (hh:mm) (Time when you want to start exporting the messages).
    • Time since previous export: If this option is selected, enter a value for Delay (hours) (Time delay between two exports).

  • Clean up exported logs older than (days): Number of days after which logs should be cleaned.

    If you set this option to 0, Switch will not clean the logs automatically.

  • Export changes only:
    • If set to Yes, only log messages about changes are exported.
    • If set to No, all log messages are exported.

Log to CSV file

If set to Yes, all execution log messages are written to a CSV file in addition to the regular log database.

A new log file is created every 10.000 messages and every day. The name of the log file includes the date and the time (YYYYMM-DDHHmmss).

Note: Enable this option only on request of the Enfocus technical support team.

The following options are only available if Log to CSV file is set to Yes.

 

CSV file delimiter

The delimiter separating the records in the generated CSV log file, for example a comma or a semicolon.

 

Log files folder

Folder where the CSV log files will be stored.

If set to Default, the log files are stored in the "Logs" folder of the Application data root (see Switch preferences: Application data).

 

Log debug messages

If set to Yes, assert and debug messages are also written to the log file.

If set to No, the assert and debug messages are just discarded.

Note: Assert and debug messages are never shown in the Messages pane!

Refer to Columns.

Log FTP interaction If set to Yes, problems with failed FTP transfers are logged and saved in:
  • FtpSendTrace.log for FTP send
  • FtpWatchFolderTrace.log and FtpReceiveTrace.Log for FTP receive
These files can be found in the logs folder of the Switch Application Data Root (as set in the Application data preferences).

The following option is only available if Log FTP interaction is set to Yes.

 

Clean the log when flow is activated

If set to Yes, the FTP interaction logs will be deleted when the flow is activated.
Note: When logs are stored for a long time, Switch may become slow and sometimes non-responsive. Therefore, we recommend clearing logs regularly.