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.
To open the "Project Settings" page, click the corresponding icon in the left menu.
All users can view the project settings.
Admin, Manager, and user with edit permissions can update project settings.
The project settings are divided into following tabs: "General", "Integrations", "Notifications", "Defect Types", Log Types, "Analyzer", "Pattern-Analysis", "Demo Data" and "Quality Gates".
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, can be edited on Organization level -> Projects page.
In addition to the Project Settings General section, you can find the project name on the left menu and in the URL.
-
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
- 180 days
- Forever
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
- 180 days
Widgets continue to work even if the logs are deleted, as they are linked to test items.
- 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
Project settings cannot exceed organizational settings.
Integrations
Our test reporting tool integrates seamlessly, allowing for a streamlined connection with external systems.
Integrations can be added at the instance level, making them applicable to all projects, or they can be configured specifically for a project in the Project Settings.
For those who require a different configuration from other projects, or who want to integrate only their specific project with an external system, follow these steps:
- Go to the Project settings -> Integrations tab.
- Click on one of the shown integration panels.
- Click on the "Add Project Integration" button.
Performing these steps will unlink your current project from the global (instance level) settings and initiate a project-specific configuration.
Notifications
The Notifications tab provides the ability to activate notifications for the project through Email, Slack, Telegram, or Teams.
ReportPortal provides a way to add multiple rules with specific conditions. The notification rule should be unique per Notification group – Email, Slack, Telegram, Teams. For example: In case, Launch names, Attributes.
Admin, Manager, and user with edit permissions can configure notifications.
Email notifications
For using this functionality be sure that the Email server is configured on the instance or on the project level.
To create Email notification rule, perform the following steps:
- Go to the Project settings -> Notifications.
- Choose Email Notification Group.
- Click ‘Create Rule’ button.
- Fill the form:
Rule name – from 1 to 55 characters, mandatory field
Email – optional field
Required unless the Launch Owner is selected as the recipient via the checkbox.
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 – dropdown field; by default, the value is set to Always:
- 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.
- Click on ‘Create’ button.
Slack notifications
To use this functionality, ensure that the Slack plugin is uploaded and enabled. For that, go to the instance level -> Plugins page.
To create Slack notification rule, perform the following steps:
- Go to the Project settings -> Notifications.
- Choose Slack Notification Group.
- Click ‘Create Rule’ button.
- 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 – dropdown field; by default, the value is set to Always:
- 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.
- Click on ‘Create’ button.
Telegram notifications
To use this functionality, ensure that the Telegram plugin is uploaded and enabled. For that, go to the instance level -> Plugins page.
To create Telegram notification rule, perform the following steps:
- Go to the Project settings -> Notifications.
- Choose Telegram Notifications Group.
- Click ‘Create Rule’ button.
- Fill the form:
Rule name – from 1 to 55 characters, mandatory field
Chat id – mandatory field, copied from group info in Telegram
When creating a Telegram notification rule in ReportPortal, prefix the Chat id value with a minus sign (-).
Bot Api Key - mandatory field, received during registration your Telegram bot
In case – dropdown field; by default, the value is set to Always:
- Always – notification will be sent in any case.
- 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
You can select only existing launch name. The field allows multi-selection.
Attributes – optional checkbox
When the ‘Attributes’ checkbox is checked, you can provide key/value for attributes and select the necessary radio button:
- ‘All attributes should match’
- ‘Any attribute should match’
- Click on ‘Create’ button.
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 default 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:
- Go to the Project settings -> "Defect Types" tab.
- Click "Create Defect Type" button at the top of the page or "Create a new Defect Type" button under any default defect type.
- Enter "Defect name" and "Abbreviation", select color for defect presentation on the launches grid and widgets.
- Click "Create" button.
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.
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.
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".
Log Types
Log types define how log entries are categorized and visually highlighted, helping users quickly understand the importance and context of events. Every log entry belongs to a specific log type. Some core system log types are built in and cannot be removed, while custom log types can be added and configured to meet your project needs.
In the Project Settings -> Log Types tab, you can find the log types available in your project – both system and custom. On this page, you can create custom log types, edit their appearance, delete custom log types, and configure which log types will be displayed in the log level slider on the Log page of the test item.
Admin, Manager, and user with edit permissions can configure log types.
Create custom log type
You can create your own log types to better control how logs are organized and visually presented within a project.
To create a custom log type:
- Go to the Project settings -> Log types.
- Click the "Create log type" button.
- Enter a unique "Log type name".
- Provide a numeric "Log level" value.
- Select colors for the "Label color", "Background", and "Text color".
- Toggle "Text bold" if you want the log type to appear in bold.
- Click "Create" button.
When a custom log type is created, it is added to the list of available log types and becomes immediately usable within the project.
The "Show in log filter" flag for newly created log types is OFF by default.
If a user reports tests with a log type that doesn’t exist in the project, the system assigns them level 60000 – Unknown.
Edit log type
You can update existing log types, adjust their appearance, and manage whether they appear in the log type filter slider.
If you update a log type name, make sure to update it in your reporting configuration as well. The system currently identifies log types by their name.
If you change a log level, all previously reported logs with the old level will be treated as Unknown.
To edit log type:
- Go to the Project settings -> Log types.
- Click the "Edit" icon next to a custom log type.
- Update the "Log type name", "Log level", and appearance settings (label color, background color, text color, bold).
- Click "Save" button.
Log type name and Log level of a system log type cannot be changed.
To manage the "Show in log filter" toggle:
- Go to the Project settings -> Log types.
- Modify the "Show in log filter" toggle.
Log types marked as filterable appear in the log type filter slider on the log view, along with an additional "All" option that shows logs of every type.
When a log type is selected in the slider, logs with that log level and all higher log levels are displayed. Even if a specific type does not appear in the slider but falls within the selected range, its logs are still included. If no log types are marked as filterable, the slider does not appear.
A maximum of 6 log types can be active in the filter slider at the same time (plus the "All" option).
Delete custom log types
You can delete custom log types from the project.
System log types cannot be deleted.
To delete a custom log type:
- Go to the Project settings -> Log types.
- Find the custom log type you want to delete.
- Click the "Delete" icon.
- Click "Confirm" button.
Analyzer
The Analyzer can allow reducing test failure analysis routine on the project.
For more information on this topic, please refer to Auto-Analysis documentation.