Skip to main content

Project configuration

To see the list of available projects and open a project, click the drop-down list in the top of the left menu.

ReportPortal supports customization of the default settings.

Permission: Users with the Administrator role can edit project settings on the project "Settings" page in Administrate section and on the Project space. Users with the PROJECT_MANAGER role can edit the settings on the project space only. MEMBER/ OPERATOR/ CUSTOMER can only view applied project settings.

Project settings​

To go to the project settings page, click the "Project Settings" icon in the left menu.

The project configuration page will be opened.

The project settings are divided into following tabs: "General", "Integrations", "Notifications", "Defect Types", "Analyzer", "Pattern Analysis", "Demo Data" and "Quality Gates" (if you have our premium feature).

General settings​

Our test automation results dashboard allows you to control the amount of the stored data (launches, test items, logs and attachments) by removing outdated elements using Quartz jobs. Functionality of data removing depends on two configurations.

The first one is API service back-end environment variables that are described in ReportPortal jobs configuration

The second one is the "General" tab you can configure parameter of data storage in ReportPortal for this project:

  • Name – is a disabled field as the project name cannot be changed.

  • Launch inactivity timeout - this parameter specifies the scheduled time for a job to interrupt inactive launches (launches which have the status 'in progress', but there is no any items during the chosen period). There are six options:

    • 1 hour,
    • 3 hours,
    • 6 hours,
    • 12 hours,
    • 1 day,
    • 7 days.

  • Keep launches - this parameter specifies how long the system will keep old launches in the data base. There are five options:

    • 7 days,
    • 14 days,
    • 21 days,
    • 30 days,
    • 90 days.

After this period a launch will be deleted, and you can not see it in ReportPortal.

  • Keep logs - this parameter specifies how long the system will keep old logs in launches. Related launch structures will be saved, to keep statistics. There are five options:

    • 7 days,
    • 14 days,
    • 21 days,
    • 30 days,
    • 90 days.

  • Keep attachments - this parameter specifies how long to keep binary data (screenshots, files, video, and others attachments) in the system. There are five options:

    • 7 days,
    • 14 days,
    • 21 days,
    • 30 days,
    • 90 days.

Integrations​

The "Integration" tab can allow the project to connect ReportPortal with external systems or rewrite global configurations for third party systems.

For more information on this topic, please refer to Integration with external systems.

E-mail notifications​

The "Notifications" tab provides the administrator with the ability to activate e-mail notifications on the project.

ReportPortal provides a way to add multiple rules with specific conditions. The Notification rule should be unique per project, have a unique parameter set, and specify recipients. For Example: In case, Launch names, attributes).

Permissions: Users with ADMINISTRATOR a role can configure "Notifications" in the Administrate section. Users with PROJECT_MANAGER roles can edit the settings on the project space only.

To do that, perform the following steps:

  1. Login to the ReportPortal.
  2. Navigate to the Project -> Project "Settings" page.
  3. Open the "Notifications" tab and click on a button "Create new notification rule"
  4. Enter your email into the "From" field. This email will be used as a notification sender.
  5. Select recipients. To do that, start typing any symbols into the "Recipients" field. You can select an item from the auto-complete tool-tip using the keyboard (use the "Up" and "Down" arrows and "Enter" button). You can also enter a custom email into the "Recipients" field. To add a custom email, just enter the email address and press "Enter".
  6. The "Launch owner" is selected by default. Uncheck "Launch owner" to exclude him/her from the notification.
  7. Select the "In Case" setting. To do that, select one of the following options from the "In Case" drop-down.
  8. Select launches (optional). To do that, start typing any symbols into the "Launch names" field. You can select an item from the auto-complete tool-tip using the "Up" and "Down" arrows and clicking "Enter" on the keyboard. This is an alternate way you can add a new launch name that does not exist on the project. Several launches names can be selected; the recipients will receive notifications when each of them finishes.
  9. Then Select attributes (optional). To do that, start typing any symbols into the "Attribute key" and "Attribute value" fields. The system will suggest the results in the drop-down, after at least 1 symbol is provided. It is also possible to add a new attribute (that does not exist on the project). Several attributes can be selected at once; the corresponding recipients will receive notifications about the launches that have all the specified attributes.
  10. Switch ON Notifications
  11. The system will activate the "Email notification" option. After the launch is finished, the recipients will receive a notification via email.
  12. Add more rules, if needed. Each Notification rule should be unique.
  13. You can edit/ copy/enable/disable notification rule by clicking on the appropriate controls on the notification rule.
note

Users with a MEMBER/ OPERATOR/ CUSTOMER project role will not have the capability to edit the project settings, however, they do have the permissions to view them.

tip

For using this functionality be sure that the E-mail server is configured.

Custom defect types​

The "Defect Types" tab allows users with permissions to create custom defect types as subtypes of default defects on the project.

After Installation the ReportPortal by default sets-up the following defect types groups:

  • To investigate - means that no investigation was performed on this defect yet.
  • Product Bug - defect was investigated and a production bug was found as a cause for this test failure.
  • Automation Bug - defect was investigated and an automation test is not correct.
  • System Issue - defect was investigated and it turns out that it is a system-level issue, like the app, crashed and caused the test to fail.
  • No Defect - defect was investigated and defined as not a defect.

ReportPortal allows the use of existing defect types (Product Bug, Automation Bug, System Issue, No Defect, To investigate) and or to create custom ones on the project settings page.

To create custom defect types, perform the following steps:

  1. Login into the ReportPortal.
  2. Navigate to Projects -> Project "Settings" page.
  3. Open "Defect Types" tab
  4. Click "Add Defect Type" button under any default defect type
  5. Add new defect type form will appear
  6. Enter "Defect name" and "Abbreviation", select color for defect presentation on the launches grid and widgets.
  7. Submit form. You will see an added defect type on the chart preview.

Add more custom defects, if you need it. The system allows us to add up to ten subtypes of each default defect type.

Now you can do bug triage and set defect types as default Product Bug/Automation Bug/System Issue/No Defect/TO investigate or custom defects. All of them will be available to select on the Defect Type editor. For more information refer to the Investigation of failure topic.

note

Default defects cannot be modified and or deleted from the system. Custom defect types can be deleted at any time.

You can create up to 15 custom defect types for each group.

tip

If you have deleted a custom type from the system, all test executions with this deleted defect type get the parent type of the group in which deleted defect has belonged. Statistics updates in all launches where a deleted defect was present.
For example, if you create a custom "Product Bug-1" as a subtype of "Product Bugs" group and investigate a few defects as "Product Bug-1", then remove "Product Bug-1" from your project, all investigated "Product Bug-1" defects will be shown as "Product Bug".

Auto-analysis and Pattern analysis​

The "Auto-Analysis" and "Pattern analysis" tabs can allow reducing test failure analysis routine on the project.

For more information on this topic, please refer to Analysis.

Demo data​

The "Demo Data" tab provides a way to generate demo data on the project.

The generated data could demonstrate how the launches, filter, and dashboard will look. On the other hand, demo data could be modified or removed without any effect of your real objects.

Management of users on the project​

On the "Project Members" page users with the appropriate roles can invite new members.

Permissions:

User with ADMINISTRATOR role and users with project role PROJECT_MANAGER.

Invite user on a project​

To invite a user on the "Project Members" page, perform the following steps:

  1. Login into ReportPortal instance as with the PROJECT_MANAGER project role.
  2. Navigate to the "Project Members" page on the left menu.
  3. Click the "Invite User" tab.
  4. Enter the email address of the user in case he/she is not present in the ReportPortal database or enter his/her login name.
  5. In case the user is already available in the ReportPortal, his/her name will appear in the suggestion list. If not, the Admin should enter the correct email address.
  6. Select an appropriate role.
  7. Then click 'Invite'.
  8. In case the user is already available in ReportPortal s/he will be assigned to the project If not, the letter with an invitation link will be sent to the user email address.
  9. The user will receive an email with the link to the registration. When the user clicks the link, he/she will see a registration form.
  10. The user needs to fill in the registration form and click the "Register" button to complete the registration.
  11. The user will be assigned to the project that the invitation was sent from, and to "Personal Project" with the PROJECT MANAGER project role.

Project role​

Every user is given a specific Project role within a specific project.

Depends on the role, the user is able or not able to perform some actions. For more details, please see the "Permissions map".

There are 4 possible Project roles in ReportPortal:

  • PROJECT MANAGER
  • MEMBER
  • OPERATOR
  • CUSTOMER
note

The ADMINISTRATOR has all privileges on the project.

Edit project role​

To edit the project role, perform the following steps:

  1. Login into the ReportPortal as a user with PROJECT_MANAGER project role.
  2. Navigate to the "Project Members" page on the left menu.
  3. Select a new value from the "Project Role" drop-down for the user. - The new project role will be automatically saved.

Unassign user from the project​

Depending on the project needs the assignment could be removed. To unassign the assignment for the user on the project, perform the following steps:

  1. Login into the ReportPortal as a user with PROJECT_MANAGER project role.

  2. Navigate to the "Project Members" page on the left menu.

  3. Find the required member.

  4. Click the 'Unassign' button for the user.

  5. Confirm the action in the popup.

  6. The user will be unassigned from the current project but will stay in the system.

note

Invite user, Assign/Unassign internal user to/from the project, change user's role on a project action can be done for a user with a similar and lower role only.