Settings

Change settings, investigate events, check data migration tasks, schedule jobs and see database statistics.

Accessing Settings

To access the Settings, follow the steps below:

  • Select in the Jira top navigation bar Administration > Manage Apps.

  • The App page will appear. Click in the side navigation on the left on Settings.

Global settings

Display

Hide administration links in the sidebar-navigation from non-administrators

  • When you disable this setting all administration links in the sidebar-navigation are visible to everyone (Permission Editor, Settings and REST API Explorer).

  • When you enable this setting all administration links in the sidebar-navigation are hidden to normal users.

Permissions

Grant Jira administrators default global permissions on all customfields

  • When you disable this setting you have to grant single permissions per customfield to Jira administrators in the Permission Editor.

  • When you enable this setting all Jira administratiors automatically have global permissions on all cutomfields and can work on them in the Field Editor, without the need to grant permisions on a per field basis.

Only Jira Administrators are allowed to delete customfield options

  • When you disable this setting every user can delete customfield options in the customfields they have permissions for.

  • When you enable this setting only Jira administrators can delete customfield options.
    Note:

    Only if the feature is active, these REST Endpoints will return HTTP 403 for non-administrators.

    DELETE /user/customfields/{customFieldId}/contexts/default/options/{optionId}
    DELETE /user/customfields/{customFieldId}/contexts/default/options/default
    DELETE /user/customfields/{customFieldId}/contexts/{contextId}/options/{optionId}
    DELETE /user/customfields/{customFieldId}/contexts/{contextId}/options/default
    DELETE /user/customfields/{customFieldId}/contexts/default/options/{optionId}/childoptions/{childOptionId}
    DELETE /user/customfields/{customFieldId}/contexts/{contextId}/options/{optionId}/childoptions/{childOptionId}

System

Disable Event Log

  • When you disable this setting (default) then the App will log Events as usual to the Event Log.

  • When you enable this setting the App will no longer log Events to the Event Log. But it will still react to Events such as UserDeletedEvent to cleanup permissions. It will simply do this silently.

Disable Audit Log

  • When you disable this setting (default) then the App will log user interactions to the Jira Audit Log.

  • When you enable this setting the App will no longer log to the Jira Audit Log. Read more in the Audit Log documentation.

Event Log

The app needs to react to certain events in order to keep permissions and search-indexes up to date. The table shows the event log with triggered actions for each event.

Since app version 2.5.4 you can disable the Event Log completely via the Disable Event Log setting.

Event Log Maintenance

If you think, the Event Log has too many entries you have the possibility to delete entries automated or manually. You can manually delete entries older than one month or to delete all entries. Note that event log entries can be useful in order to investigate certain incidents and it is not bad at all to store them. Deleted entries cannot be restored.

For the automated deletion you can choose from predefined schedules or define a custom schedule with your own cron-expression. An expression looks like so:

  • 0 15 8 * * ?     Every day at 8:15 am.
  • 0 0/10 * * * ? * Every 10 minutes, forever.
Read all Details in the Atlassian Docs 'Construct cron expressions'.

Migration Tasks

When new versions of the app are released and internal functionality changes, Data Migration Tasks are executed. This is done to migrate data to a new storage format or perform certain cleanup operations. Usually the tasks are triggered automatically by events and do not need manual execution.

Migration Tasks Maintenance

If the Migration Tasks display as FAILED forever then you can clear all Migration Task information and then the job 'JobRunDataMigrationTasks' can be manually scheduled for execution. Usually Migration Tasks are idempotent and can be executed multiple times even though that should be avoided. You should only perform this action in error cases! The tasks are designed to not overwrite existing data.

If the status permanently remains on fail try to perform an Instance Health Check to make sure your Jira Installation is working as expected. Usually failed migration task executions happen because of misconfigured base URLs or webserver proxy settings. If you are lost after all, issue a support request and we will help you fix the problem.

Data Storage

The app stores data in the database in separate tables. The tables are used to store permissions, customfield search indexes, event log entries and job status. Here you can see how many rows each database table currently has.

Jobs

The app executes background processes as jobs when bigger tasks need to be performed. These jobs run asynchronously, log their status and can be manually scheduled for execution if a previous execution failed. Usually the jobs are triggered automatically by events and do not need manual execution.

Jobs Maintenance

If Jobs remain on SCHEDULED or RUNNING forever you can set the status of these jobs to FAILED in the database. That does not stop running Jobs that are in some kind of deadlock, you should at some point restart Jira to do so. Once these jobs are set to FAILED you can manually reschedule them for execution. Do this only if you have waited more than one day.