Skip to main content
Version: 26.1

Manage plugins

ReportPortal as a test management system can be reinforced by uploading plugins. For now, you can install the next plugins from the box:

  • Bug Tracking Systems plugins: Jira Server, Jira Cloud, Azure DevOps, GitLab, Monday, Rally
  • Notification plugins: E-mail server, Slack, Telegram, Teams
  • Authorization plugins: LDAP, SAML
  • Import plugins: JUnit, RobotFramework
  • Infrastructure providers: Sauce Labs, Mobitru
  • Other: Organizations, Quality Gates, Test Executions
PluginFeatures
Jira Server/Jira Cloud/Azure DevOps/GitLab/Monday/RallyThis plugin can be required for projects that collect defects in a separate tracking tool. The integration provides an exchange of information between ReportPortal and a BTS, for example: posting new issues to BTS, linking test failures with the existing issue in BTS, track issue statuses.
E-mail server/Slack/Telegram/TeamsWith this plugin, you will be able to configure notifications about test result finish in real time.
Sauce Labs/MobitruThis plugin helps you to integrate ReportPortal with Sauce Labs or Mobitru and watch a video of test executions right in the ReportPortal application on the log view.
LDAP/SAMLThis plugin helps authorize without new user creation.
JUnit/RobotFrameworkThis plugin is essential for importing tests into ReportPortal.
OrganizationsThis plugin adds a two-level hierarchy (organization → projects), so you can group projects and apply settings across teams.
Quality GatesThis plugin evaluates launches against configured quality rules and supports automated GO/NO-GO release decisions, including in CI/CD pipelines.
Test ExecutionsThis plugin provides a unified view of all test cases across launches with flexible filters and a customizable layout for faster analysis.
Implement your own pluginPlugin developers guide

Upload plugin​

info

Only Admin can upload plugin.

You can find the latest version of all ReportPortal plugins by the link. Then you should download the latest version of a needed plugin. Or you can use a direct link to the needed plugin from the table below.

Premium plugins are not available for download from Maven or GitHub. See the details for each plugin in the table below.

PluginLink to download
JIRA Serverhttps://search.maven.org/artifact/com.epam.reportportal/plugin-bts-jira or https://github.com/reportportal/plugin-bts-jira/packages
JIRA Cloudhttps://github.com/reportportal/plugin-bts-jira-cloud/packages
Azure DevOpshttps://github.com/reportportal/plugin-bts-azure/packages
GitLabhttps://github.com/reportportal/plugin-bts-gitlab/packages
Mondayhttps://github.com/reportportal/plugin-bts-monday/packages
Rallyhttps://search.maven.org/artifact/com.epam.reportportal/plugin-bts-rally or https://github.com/reportportal/plugin-bts-rally/packages
E-mailYou do not need to download this plugin, it is already available on the Plugins page
Slackhttps://github.com/reportportal/plugin-slack/packages
Telegramhttps://github.com/reportportal/plugin-telegram/packages
TeamsThe Teams plugin is a premium offering from ReportPortal, available as part of our paid support services.
If you're interested in enabling Teams for your setup, please contact us for more information.
LDAPThe LDAP plugin is a premium offering from ReportPortal, available as part of our paid support services.
If you're interested in enabling LDAP for your setup, please contact us for more information.
SAMLThe SAML plugin is a premium offering from ReportPortal, available as part of our paid support services.
If you're interested in enabling SAML for your setup, please contact us for more information.
JUnithttps://github.com/reportportal/plugin-import-junit/packages
RobotFrameworkhttps://github.com/reportportal/plugin-import-robot/packages
Sauce Labshttps://search.maven.org/artifact/com.epam.reportportal/plugin-saucelabs or https://github.com/reportportal/plugin-saucelabs/packages
Mobitruhttps://github.com/reportportal/plugin-mobitru/packages
OrganizationsThe Organizations plugin is a premium offering from ReportPortal, available as part of our paid support services.
If you're interested in enabling Organizations for your setup, please contact us for more information.
Quality GatesThe Quality Gates plugin is a premium offering from ReportPortal, available as part of our paid support services.
If you're interested in enabling Quality Gates for your setup, please contact us for more information.
Test ExecutionsThe Test Executions feature is a premium offering from ReportPortal, available as part of our paid support services.
If you're interested in enabling Test Executions for your setup, please contact us for more information.

To upload a plugin, perform the following actions:

  1. Log in to ReportPortal as Admin.
  2. Navigate to Instance plugins page.
  3. Click on "Upload Plugin" button.
  4. Choose .jar file which should be uploaded.
  5. Click "Upload" button.

Technical requirements for the plugin:

  • a plugin should have the format: .jar
  • a plugin file size is up to 128Mb
  • a plugin should have a version
  • a plugin should have a Manifest
  • a plugin should have a plugin Extensions
  • Admin cannot upload a plugin with existing ID and existing version to the system

Update a plugin​

info

Only Admin can upload plugin.

It is the same procedure as for Uploading. You can upload a plugin with the latest version to the ReportPortal, and an existing version will be updated to the latest one.

Enable / Disable a plugin​

info

Only Admin can enable or disable a plugin.

If you do not want to remove a plugin from project settings, but want to save plugin configurations, you can use an enable/disable function.

For that:

  1. Log in to ReportPortal as Admin.
  2. Navigate to Instance plugins page.
  3. Find plugin.
  4. Click a switcher to disable.

The plugin will be removed from Project Settings on the project spaces. But all plugin configurations will be saved in the database and you can return them back if you need by clicking on the switcher to enable the plugin.

Uninstall a plugin​

info

Only Admin can uninstall a plugin.

You can remove a plugin from the system by following these steps:

  1. Log in to ReportPortal as Admin.
  2. Navigate to Instance plugins page.
  3. Click on Plugin.
  4. Click "Uninstall" button.

The plugin will be successfully deleted. All plugin configurations will be deleted from the database. E-mail plugin can not be uninstalled.

Configure a plugin​

info

Admin can configure a plugin on the instance level.
Admin and Manager can configure plugin on the organizational level.
Admin, Manager, and user with edit permissions can configure plugin on the project level.

Users can configure a plugin on the instance level (global configuration), organizational level, and project level (project configuration). The configuration approach is the same for all three levels.

If a user configures plugin on the global level, then these configurations will be applied to all organizations and projects on the instance, which do not have their own configurations.

If a user configures plugin on the organizational level, then these configurations will be applied to all projects in the organization, which do not have their own configurations.

If the user configures a plugin on the project level, then these configurations will be applied to only this project and replace global and organizational configurations, in case they are.

Use case 1:

Situation: A small team, on ReportPortal instance there are several projects. Separate projects are added for different test types (UI, API, Unit and other). The team works with one project in a BTS (for example, Jira). Different projects post new bugs in the same BTS project.
Solution: configure global integration for the BTS plugin on the Instance plugins page.
Pros: Administrator configures integration once, and should not perform the same action several times. If the integration requires some changes, the Administrator can easily edit an integration, and the changes will apply to all projects on the instance.

Use case 2:

Situation: On ReportPortal instance there are several projects. Separate projects are added for different teams. Each team works with its project in a BTS and posts new bugs in different BTS projects. Each team should not have access to the BTS project of other teams.
Solution: configure project integrations for the BTS plugin on the Project settings.
Pros: Admin, Manager, or user with edit permissions configures integrations per project, team members from different projects can not see configurations of each other.

Use case 3:

Situation: On ReportPortal instance there are several projects. Separate projects are added for different teams. But for one team has been added several projects. So several projects on ReportPortal have connections with one BTS project and several projects have a connection with different BTS projects.
Solution: configure global integrations on the Instance plugins page, and configure project integrations for the BTS plugin on the Project settings.
Pros: Administrator configures integration once for those who need the same settings, and Admin, Manager, or user with edit permissions configures integrations per project, for those projects who need to limit access.