Versions Compared

Old Version 27

changes.mady.by.user Antonella Capalbo

Saved on

compared with

New Version Current

changes.mady.by.user Antonella Capalbo

Saved on

Key

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


Info
iconfalse

You must have the Jira System Administrators global permission before you can carry out the instructions on this page.

Info
iconfalse

Table of Contents

Info
iconfalse

The Integrity Check tab on the Troubleshooting and Support screen, allows you to check for out of date information in the database

on

or missing consistences and recover the identified anomalies.


Overview

The Integrity Checker tab provides the capability to Check or immediately Recover inconsistencies on

  • the Data maintained by the App, so to ensure that any update performed on the Jira core tables is consistent with the data persisted on the app tables
  • the Approval Conditions on the Workflows interested by the Approvals configurations
  • the Project Permissions on the Permission Scheme interested by the Approvals configurations (Browse Projects, Transition Issues, Resolve Issues, Close Issues)
  • the Automatic Actions (e.g. automatic notification and automatic workflow transition), so to ensure that, basing on the applied configurations, any expected automatic action, that for some reason were not performed, can succeed.

Furthermore, following a Check or a Recover, the app

writes

log into the Integrity Check Log file and the Integrity Recover Log file

the detail of the identified anomalies

 which anomalies have been identified and how the app have recovered

these anomaliesImage Removed

them.

Image Modified

Image Modified

Both the Check and the Recovery can be performed on specific separate areas relating the app functionalities.

In particular it's possible to run separately the Check or the Recover on the specific Areas detailed below.

Check operation

You are able to run the check integrity on any distinct item listed below:

  • Check Core Approval Configurations Data Integrity

    • Check Approval Mapping Configurations Integrity: The routine checks if any Project, Issue type, Source Workflow status Id and Workflow Transition ID associated to any Approval Mapping doesn't exist anymore and if they are not consistent with respect the workflow configuration.

    • Check Single Issue Approval Configurations Integrity: The routine checks if any Approval Id, Issue Id, Source Workflow status Id and Workflow Transition ID associated to any Approval Mapping doesn't exist anymore and if they are not consistent with respect the workflow configuration.

    • Check the Minimum Required Approvals based on conditions consistency: The routine checks if any "Minimum Required Approvals based on conditions" has Approval Mapping ID Issue Id that is equal to Null or the associated Approval Mapping Id or Issue Id doesn't exist anymore. 
    • Check Conditional Rules: The routine checks if the User Evaluator setup on any Conditional Rule is null or empty. 
  • Check Pending Approvals Integrity
    • Check consistency on All Issue Approval: Check Pending Approvals integrity with respect to either the Approval Mapping Configurations and the Single Issue Approval Configurations.
  • Check Non-Core Approval Configurations Data Integrity

    • Check on Permissions to Notify an Approval Request: The routine checks if any Project and Issue type associated to the Permissions to 'Notify an Approval Request' doesn't exist anymore. 

    • Check on Permissions to Configure Approval for Single Issue: The routine checks if any Project and Issue type associated to the Permissions to 'Configure Approval for Single Issue' doesn't exist anymore. 

    • Check Users list separator: The routine checks on the Users field value of the Approvals table in order to ensure that the used convention to concatenate the list of users is the expected one.
    • Template Icon: The routine checks if any email template has an associated invalid icon (Icon Id = null). 
  • Check Jira Data impacting automatic transition
    • Check Automatic Responsive Transition permissions: The routine checks if the Super User running the Responsive Automatic Transition has Transition Issue permission on any Project interested by an Approval Mapping configuration or a Single Issue approval configuration.
  • Check Jira Data impacting app functionalities
    • Check Approval Conditions on the Workflows:  The routine checks the existence of the Approval condition on any workflow transition belonging to the workflows used by the Projects/Issue Types interested by an Approval Mapping configuration or used by the issues interested by a Single Issue approval configuration. 
  • Check Automatic actions consistency

    • Check Automatic Transition consistency: The routine checks if some issue had not transited automatically

    • Check Approval Request email notification consistency: The routine checks if the Outgoing SMTP Mail Server is enabled and if any expected  automatic approval request notification was not sent by email. 

    • Check Approval Request by comment consistency: The routine checks if any expected  automatic approval request notification was not sent by Jira Comments 

Image Removed

Recover operation

You are able to recover data integrity and automatic actions consistency on any distinct item listed below:

  • Recover Core Approval Configurations Data Integrity

    • Recover Approval Mapping Configurations Integrity: The routine recovers database consistency by deleting any any Approval Mapping associated to a Project, Issue type, Source Workflow status Id and Workflow Transition ID that doesn't exist anymore or case of the configuration is not consistent with respect the workflow configuration.

    • Recover Single Issue Approval Configurations Integrity: The routine recovers database consistency by deleting any any Single Issue Approval Configurations associated to an Issue Id, Source Workflow status Id and Workflow Transition ID that doesn't exist anymore or case of the configuration is not consistent with respect the workflow configuration.

    • Recover the Minimum Required Approvals based on conditions consistency: The routine recovers database consistency by deleting any "Minimum Required Approvals based on conditions" configuration associated to an Approval Mapping ID or Issue Id that is not defined or case of the associated Approval Mapping Id or Issue Id doesn't exist anymore. 

    • Recover Conditional Rules: The routine recovers database consistency by updating the User Evaluator setup on any Conditional Rule when it is found null or empty.

  • Recover Pending Approvals Integrity

    • Recovery consistency on All Issue Approval

  • Recover Non-Core Approval Configurations Data Integrity

    • Recover on Permissions to notify an Approval Request

    • Recover on Permissions to Configure Approval for Single Issue

    • Recover Users list separator

    • Recover Template Icon

  • Recover Jira Data impacting automatic transition

    • Recover Automatic Reponsive Transition permissions

  • Recover Jira Data impacting app functionalities
    • Recover Approval Conditions on the Workflows

  • Recover Automatic actions consistency

    • Recover Automatic Transition Consistency

    • Recover Approval Request email notification consistency

    • Recover Approval Request by Comment consistency

(warning) The App doesn't allow to run the Recover of the Automatic Actions without running the Recovery of Core Data Integrity.

Integrity Check

  • Choose Image Added > Manage apps > Herzum Approval >Troubleshooting and Support. 
  • Select the Check box.
    The Integrity checker has a number of 'integrity checks' that look for common inconsistencies in
    • Herzum Approval's stored data
    • Jira Data impacting app functionalities (Approval Conditions on the Workflows,  Project Permissions)
    • Issues Workflow status with respect any expected automatic workflow transition to perform
    • Approvals Notifications with respect any expected automatic notification by email or by Comments.

Image Added

  • Select one or more items whose data you would like to check the integrity of and click the 'Check' button.
  • After the selected checks run, the screen provides details about the existing inconsistencies.

The whole list of possible inconsistencies by 'integrity checks' type can be reviewed on List of possible inconsistencies per 'integrity checks'.

  • If any inconsistencies were found, you are able to fix it navigating on the Recovery tab or fix it manually basing on the reported information. 
  • If any inconsistencies were found you will be able to retrieve these information on the integrityCheck log file.

(info) Notice that this file is overwritten each time that you run the check. Case you want maintain these information for future review, you must download the file and keep it in a different folder. 

Integrity Recover

  • Choose Image Added > Manage apps > Herzum Approval >Troubleshooting and Support. 
  • Select the Recove box.

Image Added

(info) The Integrity recover performs the same 'integrity checks' then the Integrity Checker, but, in addition, it fixes the inconsistencies.

The whole list of possible inconsistencies for each category of integrity check can be reviewed on List of possible inconsistencies per 'integrity checks'.

The whole list of actions that are taken for each category of integrity recover can be reviewed on /wiki/spaces/HAP/pages/56183625.

  • Select one or more items whose data you would like to recover the integrity of and click the 'Recover' button.

(warning) Some of the 'recover integrity operations' have depends by the consistency of other recovers so it's not possible to recover them without perform a recover of an item that can potentially impact it. The app automatically manage such dependency by checking the related box.

  • After the selected checks run, the screen provides details about the existing data inconsistencies and all the corrective actions that have taken place.

(minus) We strongly recommend taking a backup of your data before correcting any data inconsistencies.

  • If any inconsistencies were found you will be able to retrieve these information on the integrityRecover log file, in addition to the the corrective actions that have taken place.

(info) Notice that this file is overwritten each time that you run the recover. Case you want maintain these information for future review, you must download the file and keep it in a different folder. 





In this section

Info
iconfalse

Table of Contents

Related Documentation

Here you can find some useful links to our customer documentation relating the topics addressed on this page

Still need help?

We would love to help.