Configure Debug Mode

If you have access to the settings.json, you can enable or disable debug mode for MATRIXX Backoffice Customer Tool. When debug mode is turned on, you can display debug information at the bottom of pages where user input is required by entering the debug activation code. You can copy a page shot of the debug information and include it in correspondence with technical support or use it for reference when attempting to resolve issues. The debug information includes the URL of each request made to the specific MATRIXX Backoffice Customer Tool page and the response information.

About this task

The debug string is defined by default in the settings.json file and has the value "DEBUG_MODE_TOGGLE": "951951".

Note: Optionally, use the following URL to retrieve information about the MATRIXX Backoffice Customer Tool deployment when debugging issues. You must have the MTX_ROLE_ADMIN role to access this URL.

http://hostname:8081/matrixxbct/services/search/webappstatus

Procedure

  1. Access the settings.json file located at /opt/mtx/conf/matrixxbct in the files for your configuration source. See the discussions about configuring MATRIXX web apps and the provided example for more information.
  2. Look for a line that contains DEBUG_MODE_TOGGLE.
    If this line exists, and specifies a string value, then debug mode is enabled.
  3. Do one of the following:
    • If debug mode is not enabled and you want to enable it (there is no setting enabling DEBUG_MODE_TOGGLE) add a line similar to the following: 
      "DEBUG_MODE_TOGGLE": "string_value",

      where string_value specifies the string that users must enter to display a debug page.

    • If a DEBUG_MODE_TOGGLE value exists and you want to change it, modify the string value that is specified.
    • To disable debug mode, delete or comment out the line containing the DEBUG_MODE_TOGGLE setting.
  4. Save the file.
  5. Rebuild the configuration image and host it in your image repository.
  6. Update your Helm values file with the new tag for the image, if necessary. See the discussions about configuring MATRIXX web apps and the provided example for more information.
  7. Restart MATRIXX Backoffice Customer Tool and log in as an administrative user.
  8. On any page, enter the debug activation code.
    The debug display appears at the bottom of the UI page.
  9. To copy the debug page into memory, click Copy.
  10. To deactivate debug mode, enter the activation string again.