Project settings

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.

Notifications

The ‘Notifications’ tab provides the administrator with the ability to activate notifications on the project – through either Email or Slack.

ReportPortal provides a way to add multiple rules with specific conditions. The notification rule should be unique per Notification group – Email or Slack, have a unique parameter set. For example: In case, Launch names, Attributes.

note

Users with ADMINISTRATOR role can configure ‘Notifications’ in the Administrate section.
Users with PROJECT_MANAGER role can edit the settings on the project space only.
Users with MEMBER/ OPERATOR/ CUSTOMER project role will not have the capability to edit the project settings, however, they do have the permission to view them.

Email notifications

tip

For using this functionality be sure that the Email server is configured. For that, go to the Project Settings -> Integrations -> Email Server.

To create Email notification rule, perform the following steps:

1. Go to the Project settings -> Notifications.

2. Choose Email Notification Group.

3. Click ‘Create Rule’ button.

4. Fill the form:

Rule name – from 1 to 55 characters, mandatory field

Recipients – optional field

Start typing any symbols into the ‘Recipients’ field. You can select an item from the auto-complete tooltip 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’.

Launch owner – optional checkbox

The ‘Launch owner’ checkbox is selected by default. Uncheck ‘Launch owner’ to exclude him/her from the notification.

In case – optional field, dropdown with the options:

• Always – notification will be sent upon the launch finish.
• 10% of items have issues – notification will be sent, if more than 10% of items have issues.
• 20% of items have issues – notification will be sent, if more than 20% of items have issues.
• 50% of items have issues – notification will be sent, if more than 50% of items have issues.
• Launch has issues – notification will be sent, if at least 1 item has issues
• Launch has ‘To Investigate’ items – notification will be sent, if at least 1 item has ‘To Investigate’

Launch names – optional field

Start typing any symbols into the ‘Launch names’ field. You can select an item from the auto-complete tooltip 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.

Attributes – optional checkbox

When the ‘Attributes’ checkbox is checked, user can provide key/value for attributes and select the necessary radio button:

• All attributes should match
• Any attribute should match

Start typing any symbols into the ‘Attribute key’ and ‘Attribute value’ fields. The system will suggest the results in the dropdown, 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.

You can edit/ copy/enable/disable notification rule by clicking on the appropriate controls on the notification rule.

5. Click on ‘Create’ button.

Slack notifications

tip

To use this functionality, ensure that the Slack plugin is uploaded and enabled. For that, go to Administrate -> Plugins or contact your instance Administrator.

To create Slack notification rule, perform the following steps:

1. Go to the Project settings -> Notifications.

2. Choose Slack Notification Group.

3. Click ‘Create Rule’ button.

4. Fill the form:

Rule name – from 1 to 55 characters, mandatory field

Webhook URL – mandatory field (it is configured on the Slack side)

In case – optional field, dropdown with the options:

• Always – notification will be sent upon the launch finish.
• 10% of items have issues – notification will be sent, if more than 10% of items have issues.
• 20% of items have issues – notification will be sent, if more than 20% of items have issues.
• 50% of items have issues – notification will be sent, if more than 50% of items have issues.
• Launch has issues – notification will be sent, if at least 1 item has issues
• Launch has ‘To Investigate’ items – notification will be sent, if at least 1 item has ‘To Investigate’

Launch names – optional field

Start typing any symbols into the ‘Launch names’ field. You can select an item from the auto-complete tooltip 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.

Attributes – optional checkbox

When the ‘Attributes’ checkbox is checked, user can provide key/value for attributes and select the necessary radio button:

• All attributes should match
• Any attribute should match

Start typing any symbols into the ‘Attribute key’ and ‘Attribute value’ fields. The system will suggest the results in the dropdown, 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.

You can edit/ copy/enable/disable notification rule by clicking on the appropriate controls on the notification rule.

5. Click on ‘Create’ button.

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.