5.1.4.13. User Preferences

User Preferences are accessible via the User Menu in the Navigation Bar, which also contains profile-related actions such as changing the password and logging out.

Administrators can also access these settings via the user management page by clicking on the respective username.

The user menu.

The user settings menu.

The user settings page.

The user preferences page.

Sub-pages that reference preferences of features disabled by an administrator, e.g., Erosion Notification System, will not be visible to users.

Erosion Notification Emails

If the Dashboard-integrated Erosion Notification System is enabled by an administrator, you can subscribe to or unsubscribe from the projects visible to you in your personal settings. These settings are not available for federated users who log in via OIDC or SAML.

The Enable checkbox determines whether you receive notifications. It is checked by default. If checked, the page also displays the Preferred Content Type for emails (HTML, TEXT, or BOTH) and the Email Subscriptions table. With the default BOTH setting, emails use the multipart/alternative content type, and your mail client chooses how to display them.

In the Email Subscriptions table, you define an ordered set of subscription rules. Each rule is identified by a project name or a *-pattern; the first match determines the notification content or whether you receive notifications for the matched project.

By default, you are subscribed to all projects visible to you. This is represented by a single rule matching all projects using “*” as the Project Pattern. Enabled determines whether you receive notifications for the matched projects. The following five columns define which user categories’ information should be included or excluded in your notifications. The final six columns define the issue kinds you are interested in for the matched projects.

The five user categories are:

Me

Your own issues. This is the only user category enabled by default. This has no effect if you are not mapped to the project (i.e., from the point of view of the dashboard, you do not have any issues in the project).

Anybody

User-neutral total counts of all issues.

Nobody

Issues owned by the special “Nobody” user. This has no effect if this user does not exist in the project.

Public

Issues of all public users, detailed on a per-user basis.

NonPublic

Issues of all users mapped to the project, excluding those in the “Me”, “Nobody”, and “Public” categories, detailed on a per-user basis. This only affects users with the View Issue Owners permission.

For each user category, you can choose between four “events” that trigger their inclusion in a notification email:

Changed

Include the user category in your notification if its users have added or removed issues.

Added

Same as “Changed”, but ignores removed issues.

Always

Always include the user category.

Never

Never include the user category.

Caution

If no user categories are included due to the absence of relevant issue changes, you will receive no notification email. To ensure you receive a notification email for every new version, use “Always” instead of “Changed”.

API Tokens

In this section of the user settings page, you can configure secrets to replace your login password. These tokens generally cause fewer problems should they be stolen. Their use is recommended wherever possible, especially if your Dashboard is integrated with a centralized user database such as ActiveDirectory, in which case a password usually also grants access to services beyond the Dashboard.

All Axivion Suite IDE plugins that connect to the Dashboard use tokens internally to enhance password security.

Consider using API Tokens for the following use cases:

When a token is used, its type restricts user permissions to the following:

IDE Plugin

Permissions required by IDE plugins: Log in, Manage Named Filters, View, View Issue Owners, View Annotations, Annotate Issues, Create Issue Tags, and Delete Issue Comments.

Continuous Integration

Permissions typically needed for CI purposes: Log in, View, View Annotations, Low-Level Issue Annotation Control, and Update Analysis Artifacts.

General Purpose

No restrictions; provides the same permissions as a regular password login.

In almost all of these cases, tokens of type IDE Plugin are sufficient. A CI system that uploads analysis results to the Dashboard requires a token of type Continuous Integration or General Purpose.

Depending on the use case, there may be different mechanisms for using an Application Token instead of a password; however, in most cases, you can simply specify the Token String where you would normally specify the password.