Available Log Files

Table 1 describes the logs that are generated by the data setup utility and the properties that control each log file. For more information about the runtime properties, see Configuring the properties files for the utility.

Table 1. DSU Log Files
Log File Runtime Property Name Description
General Log logFileLocation This log is always created and contains general information such as:
  • the operation performed
  • the user ID that executed the operation
  • the time the operation was started and stopped
  • the number of rows affected by the operation
  • the overall success or failure of the operation
The general log is located in the directory specified in logFileLocation and has the following naming convention: DSU_operation_YYYYMMDD_HHmmss_SSS.log where:
operation
is the DSU operation that was performed
YYYY
is the year
MM
is the month
DD
is the day
HH
is the hour
mm
are minutes
ss
are seconds
SSS
are milliseconds
Console Log logToConsole The information written to the general log can also be written to the console, which provides an easy way to see the operations being performed by the DSU. It is enabled by setting the logToConsole property to true.
Trace Log
enableTrace
logFileLocation
This log contains the same information as the general log, as well as trace data for each database operation performed by the DSU. To help analyze any DSU failures, it is recommended that trace logging always be enabled. It is enabled by setting enableTrace to true.
The trace log is located in the directory specified in logFileLocation and has the following naming convention: DSU_operation_YYYYMMDD_HHmmss_SSS.trc where:
operation
is the DSU operation that was performed
YYYY
is the year
MM
is the month
DD
is the day
HH
is the hour
mm
are minutes
ss
are seconds
SSS
are milliseconds
Audit Log enableAudit Audit log information is generated for only those operations that actually change data in the FTM database. If enableAudit is set to true, the DSU stores the audit log information in the FTM database.
Audit log information generated for the import operation is:
  • the name of the worksheet from which the configuration data was imported
  • the number of rows in the configuration data worksheet that were processed
  • the number of records inserted, deleted, updated, and unchanged
Audit log information generated for the delete operation is:
  • the name of the database table from which records were deleted
  • the number of records deleted
CSV Summary Log
generateCSVLogFiles
csvLogFileDelimiter
csvLogFileLocation
This log contains summary information for the operation being performed. It is only generated if generateCSVLogFiles is set to true. The values in a CSV summary log file are separated by the character specified in csvLogFileDelimiter. The file is located in the directory specified in csvLogFileLocation.

The contents of the CSV summary log file depend on the operation being performed. For more information about the data logged, see CSV Summary Log File.

CSV Detail Log
generateCSVLogFiles
csvLogFileDelimiter
csvLogFileLocation
This log contains detailed information for the import and delete operations. It is only generated if generateCSVLogFiles is set to true. The values in a CSV detail log file are separated by the character specified in csvLogFileDelimiter. The file is located in the directory specified in csvLogFileLocation.

The contents of the CSV detail log file depend on the operation being performed. For more information about the data logged, see CSV Detail Log File.

CSV Error Log
generateCSVLogFiles
csvLogFileDelimiter
csvLogFileLocation
This log contains error information for the operation being performed. It is only generated if generateCSVLogFiles is set to true. The values in a CSV error log file are separated by the character specified in csvLogFileDelimiter. The file is located in the directory specified in csvLogFileLocation.

The contents of the CSV error log file depend on the operation being performed. For more information about the data logged, see CSV Error Log File.