Skip to content

Commit 3782006

Browse files
authored
Merge pull request #1019 from reportportal/EPMRPP-107612
EPMRPP-107612 || Update Email Server, Slack, Telegram
1 parent 7c7e7cf commit 3782006

File tree

7 files changed

+69
-5
lines changed

7 files changed

+69
-5
lines changed

docs/configuration/ProjectSettings.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Users with MEMBER/ OPERATOR/ CUSTOMER project role will not have the capability
9393
### Email notifications
9494

9595
:::tip
96-
For using this functionality be sure that the Email server is configured. For that, go to the Project Settings -> Integrations -> Email Server.
96+
For using this functionality be sure that the [Email server](/plugins/notifications/EmailServer/) is configured. For that, go to the Project Settings -> Integrations -> Email Server.
9797
:::
9898

9999
To create Email notification rule, perform the following steps:
@@ -147,7 +147,7 @@ You can edit/ copy/enable/disable notification rule by clicking on the appropria
147147
### Slack notifications
148148

149149
:::tip
150-
To use this functionality, ensure that the Slack plugin is uploaded and enabled. For that, go to Administrate -> Plugins or contact your instance Administrator.
150+
To use this functionality, ensure that the [Slack plugin](/plugins/notifications/Slack) is uploaded and enabled. For that, go to Administrate -> Plugins or contact your instance Administrator.
151151
:::
152152

153153
To create Slack notification rule, perform the following steps:
@@ -195,7 +195,7 @@ You can edit/ copy/enable/disable notification rule by clicking on the appropria
195195
### Telegram notifications
196196

197197
:::tip
198-
To use this functionality, ensure that the Slack plugin is uploaded and enabled. For that, go to Administrate -> Plugins or contact your instance Administrator.
198+
To use this functionality, ensure that the [Telegram plugin](/plugins/notifications/Telegram) is uploaded and enabled. For that, go to Administrate -> Plugins or contact your instance Administrator.
199199
:::
200200

201201
To create Telegram notification rule, perform the following steps:

docs/plugins/notifications/EmailServer.mdx

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,3 +125,67 @@ Example of SMTP server configuration for Gmail email server (detailed info could
125125
<MediaViewer src={require('./img/email-server/EmailServer4.png')} alt="Example of Project Email Server integration" />
126126

127127
<MediaViewer src="https://youtu.be/OVnc5nxwp24" alt="Email Server integration" type="video" />
128+
129+
## Create Email notification rule
130+
131+
1. Go to the Project settings -> [Notifications](/configuration/ProjectSettings/#email-notifications).
132+
133+
2. Choose Email Notification Group.
134+
135+
3. Click ‘Create Rule’ button.
136+
137+
4. Fill the form:
138+
139+
**Rule name** – from 1 to 55 characters, mandatory field
140+
141+
**Recipients** - optional field, user name on the project or valid email
142+
143+
**Launch owner** - optional checkbox, who launched - that receives
144+
145+
:::note
146+
When the `Launch owner` checkbox is unchecked, you must fill in the `Recipients` field.
147+
:::
148+
149+
**In case** – optional field, dropdown with the options:
150+
151+
* Always – notification will be sent in any case.
152+
* 10% of items have issues – notification will be sent, if more than 10% of items have issues.
153+
* 20% of items have issues – notification will be sent, if more than 20% of items have issues.
154+
* 50% of items have issues – notification will be sent, if more than 50% of items have issues.
155+
* Launch has issues – notification will be sent, if at least 1 item has issues
156+
* Launch has ‘To Investigate’ items – notification will be sent, if at least 1 item has ‘To Investigate’
157+
158+
**Launch names** – optional field
159+
160+
You can select only existing launch name. The field allows multi select.
161+
162+
**Attributes** – optional checkbox
163+
164+
When the ‘Attributes’ checkbox is checked, you can provide key/value for attributes and select the necessary radio button:
165+
166+
* ‘All attributes should match’
167+
* ‘Any attribute should match’
168+
169+
5. Click on ‘Create’ button.
170+
171+
<MediaViewer src={require('./img/email-server/EmailNotificationRule.png')} alt="Create Email notification rule in our test report dashboard" />
172+
173+
## Disable Email notifications
174+
175+
1. Go to the Project settings -> Notifications.
176+
177+
2. Turn OFF for Email.
178+
179+
<MediaViewer src={require('./img/email-server/EmailDisableRule.png')} alt="Disable Email notifications in ReportPortal" />
180+
181+
## Disable plugin
182+
183+
1. Log in to ReportPortal as administrator.
184+
185+
2. Go to Administrate -> Plugins section -> Notifications tab.
186+
187+
3. Find Email plugin and click on it.
188+
189+
4. Turn OFF.
190+
191+
<MediaViewer src={require('./img/email-server/EmailDisablePlugin.png')} alt="Disable Email plugin in our qa metrics dashboard" />

docs/plugins/notifications/Slack.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Create Slack workspace and channel
8484

8585
### Create notification rule
8686

87-
1. Go to the Project settings -> Notifications.
87+
1. Go to the Project settings -> [Notifications](/configuration/ProjectSettings#slack-notifications).
8888

8989
2. Choose Slack Notification Group.
9090

docs/plugins/notifications/Telegram.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Chat id can be used to create notification rules in RP.
7474

7575
### Create notification rule
7676

77-
1. Go to the Project settings -> Notifications.
77+
1. Go to the Project settings -> [Notifications](/configuration/ProjectSettings#telegram-notifications).
7878

7979
2. Choose Telegram Notifications Group.
8080

94.9 KB
Loading
135 KB
Loading
164 KB
Loading

0 commit comments

Comments
 (0)