Logging

Property

Description

Saving log messages

Determines the mechanism for saving log messages into Switch's logging database:


  • Fast: uses delayed writing to increase speed but risks loosing 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 can be quite slow when Switch logs many messages per second (in practice the "fast" option is almost always preferred).

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, starting with the day on which the feature was turned on.

The timing can be set to a particular time of the day or with a time delay between two exports. You can also specify the number of days after which the logs should be cleared.

You can also choose to export all the log messages or only messages about changes.

In the User Preferences > Logging menu, when you select "Yes" option for Export messages to XML, the following fields appear which helps you to configure how and when you want to export the log messages:


  • Destination folder: Choose the folder where you want to place the exported XML files. To process the XML files with Switch, set the destination folder to the input folder of an active flow.
  • Timing: Select the time for exporting the messages. When you choose Time of the day in this drop-down menu, the sub option will be Time (hh:mm). If you choose Time since previous export, the text on the sub option will change to Delay (hours).
    • Time (hh:mm): Specify the time when you want to start exporting the messages.
    • Delay (hours): Specify the time delay between two exports.
  • Clean up exported logs older than (days): Specify the number of days after which logs should be cleaned. If you provide a value of "0", Switch will not clean the logs automatically.
  • Export changes only: Select "Yes" in this menu to export log messages about changes only. Select "No" to export all the log messages.

The name of the exported files include the Switch server name (see internal communication preferences) and the date in the format: "<server-name> logs YYYY-MM-DD.xml".

See Exporting log messages for information on the XML schema of the exported files.

Log debug messages

When set to "Yes" any debug messages are written to the regular log database (normally they are ignored).

Turn on this preference only when so requested by Enfocus Support, or when you are debugging a script that issues debug messages.

Log to text file

When set to "Yes" all execution log messages (including debug messages) are written to a comma-separated text file in addition to the regular log database.

Turn on this preference only when so requested by Enfocus Support.

Log FTP interaction When set to "Yes", FTP interaction is logged to a file named FtpSendTrace.log in the logs folder of the Switch Data Root whenever Switch encounters an error during the FTP transfer. The following field appears when you select "Yes" option for this preference:
  • Clean the log when flow is activated: When set to "Yes", the FTP interaction logs will be deleted when the flow is activated.
Note: When logs are stored for a long time, the Switch application may become slow and sometimes non-responsive. Therefore, it is recommended to clear logs regularly. Also, it is equally important to store the older logs which may help in debugging if you ever come across any problems. Export messages to XML helps you to configure these settings.