Log File

Logs are recorded if any of the following events occurs in DocuWorks Tray.
  • A document has been moved or copied successfully from Desk to a tray, or a document has been moved or copied successfully from a tray to Desk.
  • An image file has been converted from the multifunction device to a DocuWorks document.

Location where to create a log file

A log file is created in the following folder.
"{DWFolders specified by using DocuWorks Personal Settings}\TrayFolder\TrayOption\Log"

Log file name

When a document is moved, the log file is named "year and month_move.log".
When a document is copied, the log file is named "year and month_copy.log".
When an image document transferred from the multifunction device is converted to a DocuWorks document, the log file is named "year and month_convert.log".
When a document is opened, the log file is named "year and month_open.log".

Log record

Logs are added to the same log file if they are recorded in the same year and month.
When the month changes, a new log file is created.

Character code of log file

A log file has character code UTF-8.

When log writing failed:

When log writing failed, an error message appears to indicate the possible reasons.

Contents logged when a document is moved or copied

One-row information is logged every event. Each row has the following items. Items are delimited by a comma (,).
  • Seriousness ("info")
  • Date and time when the move/copy was performed (yyyy-MM-dd HH:mm:ss.SSS UTC offset-based format)
  • Module ID of DocuWorks Tray (0049-401001-DWTRAY)
  • "<<<Name of tray with document unmoved or uncopied>>>, <<<path used before moving or copying a document>>>, <<<path used after moving or copying a document>>>, <<<name of tray with document moved or copied>>>, <<<GUID of tray with document unmoved or uncopied>>>, <<<GUID of tray with document moved or copied>>> , MOVE: The way how to move documents"
    (If the destination of moving or copying is Desk, name and GUID of tray with document moved or copied are blank. Also, the way how to move documents is set to "0" if you move/copy documents with an action on the tray application or if you move documents by using a mailbox. Otherwise, it is set to "1" or "2".)
  • Log ID
  • Blank
  • Blank

Example

Name of tray with document unmoved or uncopied: "ToDo"
Path used before moving or copying a document: "C:\ToDo folder\scan-1.xdw"
GUID of tray with document unmoved or uncopied: B1C18255-4DE0-4490-B904-83513631E7CE
Path used after moving or copying a document: "D:\working\scan-1.xdw"
Name of tray after moving or copying a document: Blank because the destination is Desk
GUID of tray with document moved or copied: Blank because the destination is Desk
(In this example, the link folder to "D:\active" is set as the move or copy destination.)
How to Move/Copy Documents: 0
In this case, the following information is logged.
info,2015-03-13 12:00:00.000+09:00,401,"SRC:<<<ToDo>>>,<<<C:\DoDo folder\Scan-1.xdw>>>,DST:<<<>>>,<<<D:\working\Scan-1.xdw>>>,SRCGUID:<<<{B1C18255-4DE0-4490-B904-83513631E7CE}>>>,DSTGUID:<<<>>> , MOVE:0",0049-401001-DWTRAY, ,
A file moved or copied from or to a tray can be identified from the date and time, "SRC" (before a document is moved or copied), and "DST:" (destination into which a moved or copied document is classified).

Contents logged when an image file in the multifunction device is converted to a DocuWorks document

One-row information is logged every event. Each row has the following items. Items are delimited by a comma (,).
  • Seriousness ("info" is displayed when conversion has succeeded. "error" is displayed when the conversion has failed.)
  • Date and time when the conversion was performed (yyy-MM-dd HH:mm:ss.SSS UTC offset-based format)
  • DocuWorks conversion module ID of DocuWorks Tray (0050-401001-DWTRAYCONV)
  • "<<<Image file path>>>,<<<Path of generated DocuWorks document>>>"
  • Log ID
  • Blank
  • Blank

Example

Image file path; "C:\DocuWorks\DWFolders\TrayFolder\TrayOption\Polling\fax0001.tif"
Path of created DocuWorks document: "D:\Fax received-document\fax0001.xdw"
Result of conversion to DocuWorks document: Succeed
In this case, the following information is logged.
info, 2015-03-10 12:00:00.000+9:00,351,” SRC:<<<C:\DocuWorks\DWFolders\TrayFolder\TrayOption\Polling\fax0001.tif>>>,DST:<<<D:\Fax received-document\fax0001.xdw>>>”,0050-401001-DWTRAYCONV, ,
An unconverted image file or a converted DocuWorks document can be identified from the date and time, "SRC:" (before conversion), and "DST:" (after conversion).

Contents logged when a document is opened

One-row information is logged every event. Items are delimited by a comma (,).

  • Seriousness ("info")
  • Date and time when the document was opened (yyyy-MM-dd HH:mm:ss.SSS UTC offset-based format)
  • Module ID of DocuWorks Tray
  • "<<<Name of tray with target document>>>,<<<path to the target document>>>,<<<GUID of tray with target document>>>"
  • Log ID
  • Blank
  • Blank

Example

Name of tray with target document: "Faxed_Documents"
Path to target document: "D:\Faxed_Documents\fax0001.xdw"
GUID of tray with target document: "B1C18255-4DE0-4490-B904-83513631E7CE"
In this case, the following information is logged.
info,2015-08-06 13:49:56.962+09:00,401,"SRC:<<<Faxed_Documents>>>,<<<D:\Faxed_Documents\fax0001.xdw>>>,SRCGUID:<<<{B1C18255-4DE0-4490-B904-83513631E7CE}>>>",0049-401001-DWTRAY,,