User Guide

User Guide

Table of contents

After installation, you will see User Activity Audit Log in the "Apps" administration menu:

User Activity Audit Log under “Apps“ menu

Initially only site- and org-admins can access the app. Users access can be defined in Permissions.

After clicking User Activity Audit Log, you will be navigated to the home page of the app:

The landing page of User Activity Audit Log

After the expiration of the license, you will see the corresponding message and will not be to use the app (Generate activity log button will be disabled):

Message if the license is expired

If you access the app for the first time, you will be presented to a brief onboarding session, displaying the main features of the app. You can dismiss the session at any step.

New user onboarding

If you have IP allowlisting enabled on your Cloud instance (this is possible Jira for Premium plans), please contact us for the IP to be added to the cloud allowlist. Without this, some actions will not be logged.

Basic Search

Using the basic search, you can define several terms from your Jira instance for filtering the users for which you would like to see the results in the audit log. There are the following options:

  1. Calendar

  2. Project

  3. User

  4. Group

  5. People in Projects

  6. People in Organizations

  7. More

    1. Status changed

    2. Resolution set

    3. Fields

Calendar control is used for choosing a date or range of dates:

image-20240621-093626.png
View of the calendar

To choose a range, you can click a starting date followed by an ending date of the range. To choose a single day, simply click on a desired date, and if it is part of a selected range, click the same date again. In addition, predefined dates can be chosen from the left panel of the calendar.

By default, the last 30 days are selected in the calendar.

After selecting the desired date or range, click Update to confirm the selection.

You can only select the maximum 1-year range. In case of selecting a wider range, the corresponding message will show up and the Update button will be disabled.

image-20240814-133935.png

With the Projects you can filter the action in the results that were done in certain projects. The existing projects will be displayed in the dropdown after typing the first letter:

image-20240814-135029.png
“Projects“ filter

User filter enables you to select a certain user or users on the instance, for which the action log should be displayed in the results. To choose the user, start typing the name, surname, or email of the user. The possible options will be displayed in the dropdown after the first letter:

image-20240814-134251.png
User search

You can select the desired user by checking the checkboxes on the left of the name of the user. The selected users will move to the top of the list:

image-20240604-125538.png

You can clear the selected users with “Clear selected items“.

Besides users, you can select users Group(s), People in Project(s) and/or Organizations(s). After selecting filters, click Generate Activity Log button to see the results based on the selected filters.

All the filters work in a way to filter USERS. For example, when you select a project under People in Project filter, all the users that are added to the People in the selected project, will be filtered. All the filters work with OR condition. The selection of the filters is not mandatory - if you select no filters, the results will show the data for ALL the users.

The filters will remain selected after page change or refresh.

More filters

By clicking the “+More“ button, you can also filter the actions by Status changed, Resolution set and Fields:

image-20240814-134427.png

You can choose only one option at the same time

From Status change, you can select the statuses from where or to which the statuses were changed:

image-20240704-134123.png
Selecting statuses

By typing the status, or selecting from the dropdown, you can choose the statuses in “from“ or “To“ destinations:

image-20240704-134237.png

You can choose several statuses and click the “Apply” button to save the selection:

image-20240704-134355.png

After selecting the statuses, click the “Generate activity log“ button to see the results.

In the same way, you can choose the resolutions, to filter the issues with the selected resolutions. Click the “Resolution set“ option and start typing to search and select the desired resolution. You can choose more than one resolution and click the” Apply” button to save the selection:

image-20240704-134752.png

After selecting the resolutions, click the “Generate activity log“ button to see the results.

You can also search for and select the Fields, to filter the issues where certain fields were updated. Click the “Fields“ option and start typing to search and select the desired field. The list of the fields shows the fields initially added to the Monitored fields in the Settings. You can choose more than one field and click the” Apply” button to save the selection:

image-20240704-135123.png
Selecting fields

After selecting the resolutions, click the “Generate activity log“ button to see the results.

If no field is selected, the results will show updates of all the monitored fields!

JQL Search

You can also enhance search using JQL. If you already preliminary have selected the filters in Basic Search, by toggling to JQL, the filters can be enhanced additionally with JQL. Pre-defined selections will remain and filter the results:

image-20240604-125657.png
JQL Search

With JQL you can filter only the actions related to the issues.

With the buttons on the right side of the text field, you can:

  • Expand the JQL field;

  • See the help page for JQL (will be opened on a new tab);

  • Display results based on the JQL term (identical to clicking Generate Activity Log button).

After typing in the JQL term, click Generate Activity Log button to see the results based on the selected filters.

Due to the limitation of the corresponding Atlassian API, it is possible to retrieve at most 1,000 issues. If your search retrieves more issues, you will see the corresponding message and refine your search to view more actions.

image-20240621-094248.png
Message when more than 10,000 issues are retrieved with JQL

Adding a JQL filter limits the filter scope to only show actions performed in issues, and exclude other types of activities.

Manage Saved Filters

It is possible to save and manage filters for future use. After filling in the filters or JQL, click Save Filter text and fill in the “name” and “description” fields to save the filter:

 

image-20240704-114459.png
Saving filter

The saved filters will appear in the list by clicking Saved filters button:

Saved filters

From the popup, you can:

  • Search saved filters by the name

    • The saved filters will be immediately filtered when you start typing

  • Add filter to the favorites

    • Favorite filters will be identified by the filled yellow star

  • Generate Results by clicking the filter name (the popup will close and you will be navigated to the results table)

  • View filter:

    • Description

    • Owner

    • Viewers

    • Editors

  • Edit filter

    • Edit name and description

  • Share filter (see below)

  • Delete filter.

You can share the saved filter with other users, user groups, projects, organizations or limit access by choosing the Private option:

Filter subscription

You can also set up a subscription for the filter to receive regular emails with the filter results. To do so, click “Subscriptions“ under the three dots menu, along the filter:

image-20240714-184744.png
Subscriptions under the Saved filter menu

If no subscription is configured, you will see the popup to add a new subscription:

image-20240714-184846.png
“Add subscription“ popup

When you click the “Add subscription“ button, you will see the popup where you can configure a subscription.

 

image-20240714-185029.png

From here you can add:

  • Name - subscription name

  • Recipients - email addresses of the subscription recipients (you can add more than one subscriber)

  • Schedule

    • Basic - define a desired schedule with the basic scheduler.

    • Advanced - define a desired schedule with CRON expression.

  • Checkbox to choose whether to email this filter, even if there are no issues found.

After clicking the Save button, you will be navigated back to the list of the filter subscriptions with the following info:

  • Name - the name of the subscription

  • Schedule

  • Actions

    • Run - receive the email immediately

    • Edit - modify the subscription

    • Delete

  • Add subscription - from here you can also add a new subscription for the same filter

image-20240714-185932.png
List of the subscriptions for a Saved filter

All the subscription schedule times are displayed in UTC!

Results

After clicking Generate Activity Log results will be displayed in the results table. There are three views available: Aggregated View, Detailed View and Issue View.

List of the logged actions

For the list of logged Confluence actions, see Confluence logs.

  1. Issue created

  2. Issue updated

  3. Issue deleted

  4. Issue resolved

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  5. Status changed

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  6. Comment added

  7. Comment updated

  8. Comment deleted

  9. Issuelink created

  10. Issuelink deleted

  11. Worklog created

  12. Worklog updated

  13. Worklog deleted

  14. Project created

  15. Project updated

  16. Project deleted

  17. Project role created *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  18. Project role updated *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  19. Project role deleted *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

    3. Retrieving this action into the app may take up to 30 minutes.

  20. Project category changed *

    1. Requires initial configuration of the connection to Jira Administration Log.

  21. User created

    1. This action also logs “Invite user“ and “Grant access“ actions from Atlassian Guard

      1. Requires initial configuration of the connection to Atlassian Guard.

    2. Retrieving this action into the app may take up to 30 minutes.

  22. User updated

  23. User deleted

    1. This action also logs “Remove user“ and “Revoke access“ actions from Atlassian Guard

      1. Requires initial configuration of the connection to Atlassian Guard.

    2. Retrieving this action into the app may take up to 30 minutes.

    3. Due to the API restrictions, in case of “user deleted“, the author of the action will be indicated as JIRA.

  24. User deactivated (requires Atlassian Guard on the instance)

    1. Requires initial configuration of the connection to Atlassian Guard.

    2. Retrieving this action into the app may take up to 30 minutes.

  25. User reactivated (requires Atlassian Guard on the instance)

    1. Requires initial configuration of the connection to Atlassian Guard.

    2. Retrieving this action into the app may take up to 30 minutes.

  26. User last active

    1. The Data/time when the last action of the user was logged either in the Administration, Organization or Assets log.

    2. Includes user last login action (i.e. when the logged out user logged in, not when the logged in user opens Jira).

    3. Except for the rare cases after changing the logic of defining last action (10-Jul-2024), only one “last active“ log will be visible in the log.

    4. Retrieving this action into the app may take up to 30 minutes.

  27. User added to group

    1. Viewing the actor requires the initial configuration of the connection to Atlassian Guard, otherwise the actor will be visible as JIRA.

    2. Retrieving this action into the app may take up to 30 minutes.

  28. User removed from group

    1. Viewing the actor requires the initial configuration of the connection to Atlassian Guard, otherwise the actor will be visible as JIRA.

    2. Retrieving this action into the app may take up to 30 minutes.

  29. User removed from site (requires Atlassian Guard on the instance)

    1. Requires initial configuration of the connection to Atlassian Guard.

    2. Retrieving this action into the app may take up to 30 minutes.

  30. User invited to site (requires Atlassian Guard on the instance)

    1. Requires initial configuration of the connection to Atlassian Guard.

    2. Retrieving this action into the app may take up to 30 minutes.

  31. User detail changed (requires Atlassian Guard on the instance)

    1. Requires initial configuration of the connection to Atlassian Guard.

    2. Retrieving this action into the app may take up to 30 minutes.

  32. Group created

    1. Requires initial configuration of the connection to Atlassian Guard.

    2. Retrieving this action into the app may take up to 30 minutes.

  33. Group removed

    1. Tis actions triggered when the group is removed from the project.

    2. Retrieving this action into the app may take up to 30 minutes.

  34. Group deleted

    1. Requires initial configuration of the connection to Atlassian Guard.

    2. Retrieving this action into the app may take up to 30 minutes.

  35. Api token created

    1. Requires initial configuration of the connection to Atlassian Guard.

    2. Retrieving this action into the app may take up to 30 minutes.

  36. Api token revoked

    1. Requires initial configuration of the connection to Atlassian Guard.

    2. Retrieving this action into the app may take up to 30 minutes.

  37. Version released

  38. Version unreleased

  39. Version created

  40. Version moved

  41. Version updated

  42. Version deleted

  43. Option voting changed

  44. Option watching changed

  45. Option unassigned issues changed

  46. Option subtasks changed

  47. Option issuelinks changed

  48. Option timetracking changed

  49. Sprint created

  50. Sprint deleted

  51. Sprint updated

  52. Sprint started

  53. Sprint completed

  54. Board created (will not be logged for Discovery Project boards)

  55. Board updated (will not be logged for Discovery Project boards)

  56. Board deleted (will not be logged for Discovery Project boards)

  57. Board configuration changed (will not be logged for Discovery Project boards)

  58. Assets object created (requires Jira Service Management Premium)

    1. Requires initial configuration of the connection to Assets.

    2. Retrieving this action into the app may take up to 60 minutes.

    3. Log visibility depends on the Assets and app permissions ***

  59. Assets object updated (requires Jira Service Management Premium)

    1. Requires initial configuration of the connection to Assets.

    2. Retrieving this action into the app may take up to 60 minutes.

    3. Log visibility depends on the Assets and app permissions ***

  60. Attachment created

  61. Attachment deleted

  62. Issue type created

  63. Issue type updated

  64. Issue type deleted

  65. Filter created

  66. Filter updated

  67. Filter deleted

  68. Permission scheme created *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  69. Permission scheme copied *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  70. Permission scheme deleted *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  71. Permission scheme updated *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  72. Permission added *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  73. Permission deleted *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  74. Global permission added *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  75. Global permission deleted *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  76. Customer permissions changed *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  77. Agent Portal Announcement Update Permission *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  78. Permission scheme added to project *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  79. Project roles changed *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  80. JIRA Service Desk configuration *

    1. Requires initial configuration of the connection to Jira Administration Log.

    2. Retrieving this action into the app may take up to 30 minutes.

  81. Login-free portal settings changed *

    1. Requires initial configuration of the connection to Jira Administration Log.