Debug Mode

Your implementation team can execute the system using a special mode when they are configuring the application. To enable this mode, enter ?debug=true at the end of the URL that you use to access the application. For example, if the standard URL was http://CD-Production:7500/cis.jsp, you'd enter http://CD-Production:7500/cis.jsp?debug=true to enable configuration mode.

In addition, if you have security access to the application service F1OUDBUG, you can enable this mode without changing the URL via the Help Menu - Enable Debug option. If debug mode is enabled, the help menu entry shows a Disable Debug option, allowing you to turn it off without changing the URL.

When in this mode certain debugging oriented tools become available via an icon visible. Debug icon Clicking the icon displays a slide-out panel with options defined below.

The following are only applicable in a non-Cloud environment:

  • Start Debug starts a logging session. During this session the processing of various configuration tools objects are logged. For example, the log will show the data areas that are passed in at each step and the data areas returned after the step is processed.
  • Stop Debug stops the logging session.
  • Show Trace opens a window that contains the logging session. All of the steps are initially collapsed.
  • Clear Trace clears your log file.
Note: The buttons are secured. An application service F1CONFIGLOG has been provided for this functionality to allow implementations to restrict user access to these buttons. An additional application service F1DEBUG is checked when the environment is not a 'development' environment. This allows implementations to provide an additional layer of security for their production users.

The following are available to view log entries captured while using the system.

  • Show User Log allows you to view your own log entries. The number of "tail" entries to view may be specified in the adjacent Log Entries field before clicking the button. Limiting the number of entries to view allows the user to quickly and easily see only the latest log entries without having to manually scroll to the end of the log.

  • Show Log allows for advanced settings. It provides for a date / time range to allow a user to target the output for a specific period. In addition, administrative users may request to view logs of other users. The following are examples of when this capability is needed:

    • Batch and integration logs are captured by special user codes created for this type of processing. These users typically do not represent a human and therefore wouldn't access logs using "show user log".  Instead someone else would be accessing these logs.

    • Customer admins would like to retrieve logs for an end user possibly for support reasons. An end user might not have technical skills to gather or assess the logs nor would they be given the privilege to access the logs for security reasons

  • Checking the Global Debug indication starts various tracing options that are added to the user log.
Note: Show User Log button is secured. An application service F1USERLOG has been provided for this functionality to allow implementations to restrict user access to this button. Only users with access to the Administrative access mode of the application service are allowed to view logs of other users. Such restrictions may be called for in production environments.

For Cloud implementations only, the following buttons are available in this mode:

  • Restart TPWs - This button forces batch containers to terminate, interrupting all running batches. New containers will spin up and the interrupted batches resume. Refer to the Batch Best Practices technical reference paper for more information about this button and when to use it.

  • Restart CM Jar Servers - This button is provided to aid with support in the cloud for custom Java code in certain use cases. Refer to the Cloud Services Implementation Guide for more information.

Other parts of the system may show additional configuration oriented icons when in this mode. For example, explorer zones may provide additional tools to assist in debugging zone configuration. These icons are described in the context of where they appear.

Also, in debug mode drop down lists in data explorer and UI map zones will contain the code for each item in addition to the item's display string.