Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse

All administrative functions of Herzum Approval require you to be a user with the Jira Administrators or Jira System Administrators global permission.

Overview

The Support Request tab allows you to create a zip file containing useful information about your instance that, when you ask for Herzum assistence, can be requested by Herzum support Team for troubleshooting purposes.

Image Removed

Preliminary setup

Preliminary setup to collect debug logs case of Outgoing or incoming email issues

Take care to enable the Jira Outgoing Mail and Incoming Mail logs in order to allow the app retrieving these information.

Preliminary setup to collect debug logs case of Generic issues

Before to reproduce the bug, consider the possibility to enable com.herzum package Debug logs in order to collect more detailed information on the error:

  • Navigate on System > Logging and Profiling

Image Removed

  • Navigate on Default Loggers and click Configure to configure logging level for com.herzum package

Image Removed

  • Edit package name 'com.herzum' and select logging level 'Debug'; click Add

Image Removed

Disable com.herzum package Debug logs after reproducing the issue:

  • Scroll the Package list to locate com.herzum package and click Off

(info)  It's recommended to setup the Debug logging level temporarily and only for troubleshooting purposes.

Preliminary setup to collect debug logs case of Automatic notification issues

Before to reproduce the bug, consider the possibility to enable com.herzumlog.approval.arn package Debug logs in order to collect more detailed information on the error:

  • Navigate on System > Logging and Profiling

Image Removed

  • Navigate on Default Loggers and click Configure to configure logging level for com.herzumlog.approval.arn package

Image Removed

  • Edit package name 'com.herzumlog.approval.arn' and select logging level 'Debug'; click Add

Image Removed

Disable com.herzumlog.approval.arn package Debug logs after reproducing the issue:

  • Scroll the Package list to locate com.herzumlog.approval.arn package and click Off

(info)  It's recommended to setup the Debug logging level temporarily and only for troubleshooting purposes.

Preliminary setup to collect debug logs case of Jql Performance issues

Before to reproduce the bug, enable com.herzumlog.approval.performance package Debug logs in order to collect more detailed information on the error:

  • Navigate on System > Logging and Profiling

Image Removed

  • Navigate on Default Loggers and click Configure to configure logging level for com.herzumlog.approval.performance package

Image Removed

  • Edit package name 'com.herzumlog.approval.performance' , select logging level 'Debug'and click Add

Image Removed

After you have reproduced the issue, disable com.herzumlog.approval.performance package Debug logs:

  • Scroll the Package list to locate com.herzumlog.approval.performance package and click Off

The  Support Request steps of the operations to be performed are shown below::

Step 1 of 4: Enter data into the support form

In this step some preliminary information is requested:

  • Contact Email
  • Summary (required)
  • Priority (required)
  • Description
  • Approval version (not editable, already set)

Image Added

Step 2 of 4: Create the Herzum export.zip file

In this step you can view and select the information to include in the export.zip file to be created.

By default the file will include the following information:

  • Tomcat Logs

Image Added

Info
titleImportant

In some cases, the export.zip file may be so large that it cannot be created. In this case it is recommended to exclude the Tomcat Logs section.

Enable the herzum package debug logs and reproduce the bug

Step 3 of 4: Enable the herzum package debug logs and reproduce the bug

In this step you can enable the herzum package debug logs and reproduce the bug.

Image Added

The operations to be performed in sequence are as follows:

  1. Enable Debug logging level for the com.herzum.package
  2. Enable Debug logging level for the com.herzumlog.package
  3. Reproduce the bug
  4. Disable Debug logging for com.herzum package
  5. Disable Debug logging for com.herzumlog package


With the first operation you can configure Enable Debug logging level for the com.herzum

Image Added


Image Added


With the second operation you can configure Enable Debug logging level for the com.herzumlog

Image Added

Image Added

The third thing to do is to reproduce the bug in the environment monitored by herzum log levels.

Image Added

With the fourth operation you can disable com.herzum package Debug logs after reproducing the issue:


Image Added

Image Added

With the fifth operation you can disable com.herzumlog package Debug logs after reproducing the issue:


Image Added

Image Added

(info)  It's recommended to setup the Debug logging level temporarily and only for troubleshooting purposes.

Create and

Step 4 of 4: Download the Herzum export.zip file

Accomplish the following steps in order to generate the In this step you can download the Herzum export.zip file that will allow us to investigate an issue with Herzum Approval app:

  1. navigate the Support Request tab on the Troubleshooting and Support screen
  2. fill the fields  showing up on the form:
    1. Contact Email
    2. Summary(required)
    3. Priority(required)
    4. Description
  3. review the information to include into the file

    Info

    By default the file will include the following information:

  4. download and attach the zip file to the ticket opened in the Herzum customer support portal.

.

Image Added

Image Added

(info) The export.zip will include only latest 2000 tuples of the Audit Logs and related tuples of the AuditLogsDetail but with a Max of 4000 tuples.


In this section

Table of Contents

Need support?

We would love to help.

Button HyperlinktitleSubmit a support requesttypeprimaryurlhttps://chicago.herzum.com/jira/plugins/servlet/desk/portal/44targettrue