Debug Log
  • 25 Mar 2024
  • 3 Minutes to read
  • Contributors
  • Dark
    Light

Debug Log

  • Dark
    Light

Article Summary

This topic is related to the following section - Job Queues

About the Debug Log

The Debug Log provides a method for the Technical Lead to monitor many of the Job Queue, Datasource, or Reporting processes run by Migration. It captures debug messages based on the Debug Level. 

Note

The Debug Level may be set on the Debug Log page or on the Parameter Page. Refer to section  Administer > Setup > Parameters for more details.

These entries are listed from most constricted to least constricted in output. 

Debug Level

Description

NONE

No messages written to the debug log.

ERROR

Only Errors are written to the debug log (Default setting).

WARNING

Errors and Warnings are written to the debug log.

INFO

A concise trace of the Procedures and Parameters passed during execution.

TRACE

A verbose listing of All Entries, including debug messages, Dynamic SQL, etc. Useful for debugging, but expensive to leave enabled for a long time.

Working in Debug Log

View the following page by navigating to Monitor > Debug Log from the Syniti Migrate Homepage.

null
Debug Log: Display list of 1000 most recent records

The list of 1000 most current log entries will display in the left side panel for Log Entries.  The page is made up of six panels.  The details of each are shown below:

Panel

Description

Filter

The panel allows for filtering of log entries

Log Entries

This is the detailed list of debug log entries.  The drop down provides a list of fields to determine a filter and a Record Limit.

Settings

This panel allows for filtering of the Debug Log Entries for a specific level.

Details

This panel provides the details of the associated source.

Exception

This panel provides the exception details of the error.

Message

This panel provides a user friendly message.

Filter

The filter options for this page include the fields as well as a Record Limit value as shown below:

null
Debug Log: Filter features

Settings

While debugging an issue, switch the Debug Level within the Settings panel of this page (OR within the Administer > Setup > Parameters page) to TRACE. Perform the actions desired, and then use the results captured in the Debug Log to debug the code or raise support tickets as needed.

Once complete with the Debugging session, clear the debug log and set the Debug Level back to ERROR in the Parameter page.

null
Debug Log: List of entries

Note

Exception messaging is present for Log Entries of Level = ERROR.

The user may remove ALL jobs from the Debug Log by selecting and then clicking the Delete DeleteIcon_57x40 icon.  To Refresh the list of Log Entries, click on the Refresh SearchIcon icon.  The Search SearchIcon icon on the top right corner of the pane allows you to search for a specific Mapping Action.

Note

This displays numerous types of debugging information. You cannot Add/Edit the entries on this page, only monitor the results. (Ex: database calls, interface jobs that move data between systems, user access time stamping, etc.)

Download and Email the Debug Log

The user may download the Debug Log into a zip folder and then send out an email to the Syniti support team.  This is very useful when working with the Development team to address issues in builds and refreshing data.  Click on the DOWNLOAD DEBUG ZIP FILE DownloadIcon_52x45 button to initiate.

null
Debug Log: Download Debug Zip File

The system produces a zip folder that contains a list of .csv files of data.  The image below shows the list of files included in the zip folder.  It provides to Syniti Support team the Debug Log, the Version of Syniti Migrate (stored in the REF_PARAMETER.csv file), the list of Applications and Instances built, and all of the Job Queue information

null
Debug Log: Download Debug Zip File: Folder contents

Attach this zip folder to a ticket opened using the Helpdesk information stored in the User Profile > Helpdesk section of the system. This is the link to the Contact Support information for Syniti and SAP products - Contact Support


Was this article helpful?