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

Historical Actions in the Logs

For all the actions it is possible to see the log starting from the installation of the plugin. However, for the issue- and asset-related actions, also historical data, starting from January 1st, 2022 will be also available in the app. With the first install, you will see the corresponding informational message:

After the first install, depending on the number of issues and Asset objects, retrieving historical data may take from minutes to hours.

The following actions are not available in the historical data and only the actions done after the app installation will be visible:

• Global feature enable/disable

• Board

• Sprint

• Comment update old value

• Issue deleted

Permissions

You can define user roles for the Jira users who can access the plugin. There are two roles available in the app:

• Administrator: can access all the logs in the app + define user permissions

• Manager: can access all the logs in the app, but cannot define user permissions

To define roles for certain users, go to Settings in the top ribbon of the app and click Permissions in the dropdown menu:

To add a user to the app, click the “+Add user” button:

You can search the user by name, email or group and select the user from the list:

To define the role of the user and click Add:

After adding, the user will be added to the list:

For the users in the list, you can change the Role from the list itself:

To remove the user from the Permissions, click Remove button and Delete button on the confirmation popup:

You can search users in the list by name or filter the list by role.

When a user, who does not have the right to use the app, tries to access the logs, the corresponding message will be displayed:

Configuring Assets Connection

The app includes action logs made on Assets (formerly Insight), namely object created and object updated. To enable displaying the asset-related actions, go to Settings in the top ribbon of the app and click Assets audit log in the dropdown menu:

The configuration consists of several fields to be filled:

• Email

  • Fill in the email related to the Atlassian account (valid JSM agent) that will be used to access the data in the Assets.

• Workspace ID

  • Fill in the ID of the Assets (Insight) workspace you want to configure backup for. The Workspace ID can be found on the following link: https://[yourcloud].atlassian.net/rest/servicedeskapi/insight/workspace. The Jira Service Management REST API uses the workspace Id to identify your individual instance of Assets (Insight), it is an alphanumeric string at the end of the text shown on the opened link with the following sample appearance: 3b3b70g5-66f8-3c01-a2d7-e5bbf2584dc3:

  • {"size":1,"start":0,"limit":50,"isLastPage":true,"_links":{"self":"https://[yourcloud].atlassian.net/rest/servicedeskapi/assets/workspace","base":"https://[yourcloud].atlassian.net","context":""},"values":[{"workspaceId":"3b3b70g5-66f8-3c01-a2d7-e5bbf2584dc3"}]}

• API Token

  • Atlassian API token secures account access to the API. You can create a token, through the following URL: Atlassian account - API Tokens. You can read more about Atlassian API Token on the documentation page: Manage API tokens for your Atlassian account | Atlassian Support.

  • After creating an API Token, just copy and paste it into the corresponding “API Token“ field on the configuration page.

After filling the three fields in, click “Sync Assets Log“ button. After Sync starts, the “Connection status pending“message will be displayed. If there is an error in the filled fields, you will see the corresponding error message:

If the sync is successful the corresponding message will be displayed:

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

3. Group

4. People in Projects

5. Organization

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.

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.

JQL Search

You can also enhance search using JQL. If you preliminary have already 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 of the field it is possible to:

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

Results

After clicking Generate Activity Log results will be displayed in the results table. There are two views available: Aggregated View and Detailed 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:

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, select “None” under the Breakdown dropdown.

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.

Detail View

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

For each action you can see the following information:

• Date

  • Date and time when the action was done

• Author

  • User who did the action

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

• Target

  • 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

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 all the fields. 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:

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: