Table of contents

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

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

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):

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:

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.

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

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:

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:

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:

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.

More filters

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

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

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

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

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:

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:

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

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:

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.

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:

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

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:

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

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

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

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

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. 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.

    3. 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. 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.

33. 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.

34. Version released

35. Version unreleased

36. Version created

37. Version moved

38. Version updated

39. Version deleted

40. Option voting changed

41. Option watching changed

42. Option unassigned issues changed

43. Option subtasks changed

44. Option issuelinks changed

45. Option timetracking changed

46. Sprint created

47. Sprint deleted

48. Sprint updated

49. Sprint started

50. Sprint completed

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

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

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

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

55. 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 ***

56. 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 ***

57. Attachment created

58. Attachment deleted

59. Issue type created

60. Issue type updated

61. Issue type deleted

62. Filter created

63. Filter updated

64. Filter deleted

65. 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.

66. 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.

67. 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.

68. 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.

69. 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.

70. 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.

71. 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.

72. 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.

73. 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.

74. 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.

75. 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.

76. 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.

77. 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.

78. Login-free portal settings 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.

79. Public signup enabled *

    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. Public signup disabled *

    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. Requirement for email verification for signup 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.

82. Help center 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.

83. Help center 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.

84. Scheduled deletion of account

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

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

85. Canceled deletion of account

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

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

86. Assets roles updated

    1. The action is logged every 30 minutes **

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

87. Assets object type roles updated

    1. The action is logged every 30 minutes **

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

88. Issue view

Aggregated View

The Aggregated view shows all the actions based on action authors in the rows:

You can configure the columns which you want to be displayed:

You can check or uncheck “Select all“ checkbox to select all or none of the columns. Clicking “Reset default”, will select the default columns (Issue Created, Issue Updated, Issue Deleted, Issue Changed, Status Resolve, Issue Commented, Comment Updated and Comment Deleted).

The number of issues is clickable; if it is less than 100, the Jira page with the issues will open on a new tab:

If the number of issues is more than 100, after clicking the number, you will see a popup with the ranges of the issues, which you can click and open Jira filter with the corresponding selection:

You can Export the results in the .xlsx format by clicking Export (.xlsx) button. You will see the confirmation popup and after clicking Yes, the file will be downloaded.

Filter results by status and resolution

Additionally, you can filter the data based on transitioned statuses. Click +More button across the use filters and select Status changed and/or Resolution set:

After selecting the option(s) you will see the additional filters below the user filters:

Click Status Change button and choose “from“ and “to“ from the available statuses list (you can select more than one status):

When you select the desired statuses, click Apply button and Generate activity log to filter the actions:

In the same way, you can filter the actions by the Resolutions:

Results Breakdown

Additionally, you can break down the results in the aggregated view by:

• Project

• Destination status

• Transition

• Issues

• Fields

Breakdown by Projects

You can break the actions down by projects. To do so, click Breakdown button and select Projects:

You will see the actions, across the user, for specific projects. Non-project-related activities will be shown in a separate row - Non-project activities:

To get back to the aggregated view, without a breakdown by projects, uncheck “Projects” under the Breakdown dropdown.

Breakdown by Status

You can break the actions down by the destination status to see how many times the user transitioned the issue into the statuses. To do so, click Breakdown button and select Status.

You will see the actions, across the user, for specific destination status:

To get back to the aggregated view, without a breakdown by statuses, uncheck “Status” under the Breakdown dropdown.

Breakdown by Transition

You can break the actions down by the transitions to see how many times the user transitioned the issue from one status to another. To do so, click Breakdown button and select Transition.

You will see the actions, across the user, for specific status to status transition:

To get back to the aggregated view, without a breakdown by transitions, uncheck “Transition” under the Breakdown dropdown.

In the breakdown view, clicking the number in the Total column (the very last column) will open all the issues, for which the user has changed the status in the project, regardless of the issues, statuses, and how many times the status was changed. Therefore, the numbers across the status/transitions breakdown row might be different, but the opened issues will be the same.

Breakdown by issues

You can break the action by the issues. To do so, Breakdown button and select Issues.

It is possible to show at most 100 issues at the same time. If the filter retrieves more issues, you will see the corresponding notification below the “Generate activity log” button:

After the breakdown, you will see the list of the issues and the corresponding actions:

You can combine breakdown by issues with breakdown by project, status, and transition:

Breakdown by fields

You can break the action by the fields that were updated. To do so, Breakdown button and select Fields.

You can also combine various breakdowns, by selecting all the desired options under Breakdown:

Detail View

You can see the detailed view of the actions by clicking the Detail view tab:

For each action you can see the following information:

• Date

  • Date and time when the action was done

• Author

  • The user who did the action

  • The user name is clickable and the user profile will be opened on the new tab.

• Target

  • The item which was affected - issue, status, comment, issue link, worklog, project, user, version, sprint, board, global feature

• Action

  • Action that was done by the user, e.g. board configuration changed, issue deleted, commented, etc.

• Project

  • The project where the action was done (Might be N/A in some cases, e.g. when the user was created or updated

• Details

  • You can view the details of the action by clicking View details button, or by clicking the table row anywhere:

    

From the details you can see the following information:

• User who did the action

• Which action was done

• When the action was done

• The affected object

  • In case of issues:

    • Issue key

    • Issue type

    • Issue summary

    • Request type

    • You can see the issue key and can open the issue by clicking Open button.

• Changes

  • Old value and new value

    • “Version released”, “Version unreleased” and “Asset Created” actions does not have Changes section.

Remarks

There are a few limitations in the results due to the limitations of the corresponding REST API:

• When the board is deleted, the corresponding Project name will not be shown in the Detail View.

• Project deleted will be shown in the actions after the project is deleted from the trash.

• The three actions related to Atlassian Access (user reactivation, deactivation and last activity date/time) will be retrieved every 1 hour.

Issue View

Issue view actions are available from the version 1.0.23 (28-May-2024). Issue view actions before that are not logged.

With the very first time after login the user in, you will see an announcement about the feature. After clicking the “OK, Understood“ button you will no longer see the notification.

You can track issues viewed by the users by clicking the Issue View tab in the Results grid. Issue view is considered when the user opens the issue either fully, in the right-side details or on the customer portal.

You can see the following information in the list:

• Date

  • The date/time when the issue was viewed in your time

• User

  • The user who viewed the issue

• Issue

  • Issue Key

  • Issue Summary

• Project

  • Project of the issue

You can also export the Issue views in Excel format by clicking “Export (.xlsx)“ button.

Who viewed the issue

After installing the app on the instance, you can also see who and when viewed the issue, from the issue details. To do so, click, “Open User Activity Audit Log” field from the issue details:

After clicking the field, you will see:

• User who viewed the issue

• From where the issue was viewed

  • Issue View (Issue details)

  • Customer Portal

• When the issue was viewed

Restore deleted issue

You can easily restore a deleted issue from the Detail view! To do so, click “Restore deleted issue“ button and click “Restore“ in the confirmation popup:

This will restore the issue with the system fields, custom fields cannot not be restored. Issue comments, history, and worklog will not be restored.

Export

You can Export the results in the .xlsx format by clicking Export (.xlsx) button. You will see the confirmation popup and after clicking Yes, the file will be downloaded. The following fields will be exported:

Export history

From the app Header → Export history, you can view all the exports made by the users:

• File name

• Date

• Author

• [number of] Exported records

• Actions → View filter

Clicking View Filer button will show additional information about the used filters:

In case of the Saved filters, you will be able to click the Filter name (in blue) and the saved filter will open. For the unsaved filter, “custom“ will be shown in the Filter name.

Integrations

You can integrate User Activity Audit Log with the external platforms to send real-time data from the app. You can use Webhooks or REST API, depending on your choice or the technical capabilities of your platform.

Webhooks

You can use app webhooks to receive real-time updates for all the actions registered in the app. To do so, go to the Settings and configure webhooks.

REST API

You can use app REST API to receive real-time updates for your desired Saved filters. To do so, go to the Saved Filters and click “REST API” under the three dots menu across the desired filter:

If you are configuring the webhooks for the first time, you will see a popup with “+ Add URL endpoint“ button:

When you click “+ Add URL endpoint“ button, you will see a window where you can generate you access token for the API:

Name the endpoint and click “Generate access token” button to generate a token:

Click Add Token button to save the token:

From the list you can edit the token name or delete it:

Sample JSON format

Depending on the selected filter to export, JSON format may vary. You can find a sample JSON below:

{
        "userId": "ACTOR_ACCOUNT_ID",
        "username": "ACTOR_DISPLAY_NAME",
        "avatar": "ACTOR_AVATAR"
        "ASSET_OBJECT_CREATED": "NUMBER",
        "ASSET_OBJECT_UPDATED": "NUMBER",
        "BOARD_CONFIGURATION_CHANGED": "NUMBER",
        "BOARD_UPDATED": "NUMBER",
        "COMMENT_DELETED": "NUMBER",
        "COMMENT_UPDATED": "NUMBER",
        "ISSUE_COMMENTED": "NUMBER",
        "ISSUE_CREATED": "NUMBER",
        "ISSUE_DELETED": "NUMBER",
        "ISSUELINK_CREATED": "NUMBER",
        "ISSUELINK_DELETED": "NUMBER",
        "ISSUE_RESOLVED": "NUMBER",
        "ISSUE_UPDATED": "NUMBER",
        "SPRINT_CLOSED": "NUMBER",
        "SPRINT_CREATED": "NUMBER",
        "SPRINT_STARTED": "NUMBER",
        "SPRINT_UPDATED": "NUMBER",
        "STATUS_CHANGED": "NUMBER",
        "USER_CREATED": "NUMBER",
        "VERSION_CREATED": "NUMBER",
        "VERSION_RELEASED": "NUMBER",
        "VERSION_UPDATED": "NUMBER",
        "WORKLOG_CREATED": "NUMBER",
        "total": NUMBER,
    }