Skip to content

Commit 12651ec

Browse files
Update how-to-send-notifications-to-teams.md
Updated based on Acrolinx suggestions
1 parent 7535629 commit 12651ec

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

articles/data-factory/how-to-send-notifications-to-teams.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ a data factory or Synapse pipeline can invoke. Many enterprises are also increa
1818

1919
## Prerequisites
2020

21-
Before you can send notifications to Teams from your pipelines you must create an [Incoming Webhook](/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using) for your Teams channel. If you need to create a new Teams channel for this purpose, refer to the [Teams documentation](https://support.microsoft.com/office/create-a-channel-in-teams-fda0b75e-5b90-4fb8-8857-7e102b014525).  
21+
Before you can send notifications to Teams from your pipelines, you must create an [Incoming Webhook](/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using) for your Teams channel. If you need to create a new Teams channel for this purpose, refer to the [Teams documentation](https://support.microsoft.com/office/create-a-channel-in-teams-fda0b75e-5b90-4fb8-8857-7e102b014525).  
2222

2323
1. Open Microsoft Teams and go to the Apps tab. Search for "Incoming Webhook" and select the Incoming Webhook connector.
2424

@@ -40,7 +40,7 @@ Before you can send notifications to Teams from your pipelines you must create a
4040

4141
:::image type="content" source="media/how-to-send-notifications-to-teams/teams-add-icon.png" alt-text="Highlights the name property, optional image upload, and "Create" button in the Incoming Webhook options page.":::  
4242

43-
1. Copy the Webhook URL that is generated on creation and save it for later use in pipeline. After that, click the "Done" button to complete the set up.
43+
1. Copy the Webhook URL that is generated on creation and save it for later use in pipeline. After that, click the "Done" button to complete the setup.
4444

4545
:::image type="content" source="media/how-to-send-notifications-to-teams/teams-copy-webhook-url.png" alt-text="Shows the new webhook URL on the Incoming Webhook options page after creation.":::
4646

@@ -63,7 +63,7 @@ Before you can send notifications to Teams from your pipelines you must create a
6363

6464
:::image type="content" source="media/how-to-send-notifications-to-teams/name-pipeline.png" alt-text="Shows the "Properties" panel.":::
6565

66-
:::image type="content" source="media/how-to-send-notifications-to-teams/hide-properties-panel.png" alt-text="Shows the "Properties" pannel hidden.":::
66+
:::image type="content" source="media/how-to-send-notifications-to-teams/hide-properties-panel.png" alt-text="Shows the "Properties" panel hidden.":::
6767

6868
1. In the "Configurations" pane, select **Parameters**, and then select the **+ New** button define following parameters for your pipeline.
6969

@@ -98,7 +98,7 @@ Before you can send notifications to Teams from your pipelines you must create a
9898

9999
1. Search for "Set variable" in the pipeline "Activities" pane, and drag a **Set Variable** activity to the pipeline canvas.
100100

101-
1. Select the **Set Variable** activity on the canvas if it is not already selected, and its "General" tab, to edit its details.
101+
1. Select the **Set Variable** activity on the canvas if it isn't already selected, and its "General" tab, to edit its details.
102102

103103
1. In the "General" tab, specify **Set JSON schema** for **Name** of the **Set Variable** activity.
104104

@@ -185,7 +185,7 @@ Before you can send notifications to Teams from your pipelines you must create a
185185

186186
1. Create a dependency condition for the **Web** activity so that it only runs if the **Set Variable** activity succeeds. To create this dependency, click the green handle on the right side of the **Set Variable** activity, drag it, and connect it to the **Web** activity.
187187

188-
1. Select the new **Web** activity on the canvas if it is not already selected, and its "General" tab, to edit its details.
188+
1. Select the new **Web** activity on the canvas if it isn't already selected, and its "General" tab, to edit its details.
189189

190190
1. In the "General" pane, specify **Invoke Teams Webhook Url** for **Name** of the **Web** activity.
191191

@@ -201,7 +201,7 @@ Before you can send notifications to Teams from your pipelines you must create a
201201

202202
:::image type="content" source="media/how-to-send-notifications-to-teams/web-activity-settings-pane.png" alt-text="Shows the "Web" activity settings pane.":::
203203

204-
1. All set and now you are ready to validate, debug, and then publish your **NotifiyTeamsChannelPipeline** pipeline.
204+
1. All set and now you're ready to validate, debug, and then publish your **NotifiyTeamsChannelPipeline** pipeline.
205205
- To validate the pipeline, select **Validate** from the tool bar.
206206
- To debug the pipeline, select **Debug** on the toolbar. You can see the status of the pipeline run in the "Output" tab at the bottom of the window.
207207
- Once the pipeline can run successfully, in the top toolbar, select **Publish all**. This action publishes entities you created to Data Factory. Wait until you see the **Successfully** published message.
@@ -221,7 +221,7 @@ Before you can send notifications to Teams from your pipelines you must create a
221221

222222
:::image type="content" source="media/how-to-send-notifications-to-teams/name-pipeline-synapse.png" alt-text="Shows the "Properties" panel.":::
223223

224-
:::image type="content" source="media/how-to-send-notifications-to-teams/hide-properties-panel-synapse.png" alt-text="Shows the "Properties" pannel hidden.":::
224+
:::image type="content" source="media/how-to-send-notifications-to-teams/hide-properties-panel-synapse.png" alt-text="Shows the "Properties" panel hidden.":::
225225

226226
1. In the "Configurations" pane, select **Parameters**, and then select the **+ New** button define following parameters for your pipeline.
227227

@@ -256,7 +256,7 @@ Before you can send notifications to Teams from your pipelines you must create a
256256

257257
1. Search for "Set variable" in the pipeline "Activities" pane, and drag a **Set Variable** activity to the pipeline canvas.
258258

259-
1. Select the "Set variable" activity on the canvas if it is not already selected, and its **General** tab, to edit its details.
259+
1. Select the "Set variable" activity on the canvas if it isn't already selected, and its **General** tab, to edit its details.
260260

261261
1. In the "General" tab, specify **Set JSON schema** for **Name** of the "Set variable" activity.
262262

@@ -343,7 +343,7 @@ Before you can send notifications to Teams from your pipelines you must create a
343343

344344
1. Create a dependency condition for the **Web** activity so that it only runs if the **Set Variable** activity succeeds. To create this dependency, click the green handle on the right side of the **Set Variable** activity, drag it, and connect it to the **Web** activity.
345345

346-
1. Select the new **Web** activity on the canvas if it is not already selected, and its "General" tab, to edit its details.
346+
1. Select the new **Web** activity on the canvas if it isn't already selected, and its "General" tab, to edit its details.
347347

348348
1. In the "General" pane, specify **Invoke Teams Webhook Url** for **Name** of the **Web** activity.
349349

@@ -359,34 +359,34 @@ Before you can send notifications to Teams from your pipelines you must create a
359359

360360
:::image type="content" source="media/how-to-send-notifications-to-teams/web-activity-settings-pane-synapse.png" alt-text="Shows the "Web" activity settings pane.":::
361361

362-
1. All set and now you are ready to validate, debug, and then publish your **NotifiyTeamsChannelPipeline** pipeline.
362+
1. All set and now you're ready to validate, debug, and then publish your **NotifiyTeamsChannelPipeline** pipeline.
363363
- To validate the pipeline, select **Validate** from the tool bar.
364364
- To debug the pipeline, select **Debug** on the toolbar. You can see the status of the pipeline run in the "Output" tab at the bottom of the window.
365365
- Once the pipeline can run successfully, in the top toolbar, select **Publish all**. This action publishes entities you created to Data Factory. Wait until you see the **Successfully** published message.
366366

367367
:::image type="content" source="media/how-to-send-notifications-to-teams/validate-debug-publish-synapse.png" alt-text="Shows the "Validate, Debug, Publish" buttons to validate, debug, and then publish your pipeline.":::
368368

369369
---
370-
## Sample Usage
371-
In this sample usage scenario, we will create a master pipeline with three **Execute Pipeline** activities. The first **Execute Pipeline** activity will invoke our ETL pipeline and the remaining two **Execute Pipeline** activities will invoke the "NotifiyTeamsChannelPipeline" pipeline to send relevant success or failure notifications to the Teams channel depending on the execution state of our ETL pipeline.
370+
## Sample usage
371+
In this sample usage scenario, we'll create a master pipeline with three **Execute Pipeline** activities. The first **Execute Pipeline** activity will invoke our ETL pipeline and the remaining two **Execute Pipeline** activities will invoke the "NotifiyTeamsChannelPipeline" pipeline to send relevant success or failure notifications to the Teams channel depending on the execution state of our ETL pipeline.
372372

373373
1. Select **Author** tab from the left pane in **Data Factory** or **Integrate** tab from the left pane in **Synapse Studio**. Next, select the + (plus) button, and then select **Pipeline** to create a new pipeline.
374374

375375
1. In the "General" panel under Properties, specify **MasterPipeline** for **Name**. Then collapse the panel by clicking the **Properties** icon in the top-right corner.
376376

377377
1. Search for pipeline in the pipeline "Activities" pane, and drag three **Execute Pipeline** activities to the pipeline canvas.
378378

379-
1. Select first **Execute Pipeline** activity on the canvas if it is not already selected, and its "General" pane, to edit its details.
380-
- For **Name** property of the **Execute Pipeline** activity, we recommend to use the name of your invoked ETL pipeline for which you want to send notifications. For example, we used **LoadDataPipeline** for the **Name** of our **Execute Pipeline** activity because it is the name of our invoked pipeline.
379+
1. Select first **Execute Pipeline** activity on the canvas if it isn't already selected, and its "General" pane, to edit its details.
380+
- For **Name** property of the **Execute Pipeline** activity, we recommend using the name of your invoked ETL pipeline for which you want to send notifications. For example, we used **LoadDataPipeline** for the **Name** of our **Execute Pipeline** activity because it's the name of our invoked pipeline.
381381
- In the "Settings" pane, select an existing pipeline or create a new one using the **+ New** button for the **Invoked pipeline** property. For example, in our case, we selected **LoadDataPipeline** pipeline for the "Invoked pipeline" property. Select other options and configure any parameters for the pipeline as required to complete your configuration.
382382

383383
:::image type="content" source="media/how-to-send-notifications-to-teams/execute-pipeline-activity-1-general.png" alt-text="Shows the "Execute pipeline" activity general pane for "LoadDataPipeline" pipeline.":::
384384

385385
:::image type="content" source="media/how-to-send-notifications-to-teams/execute-pipeline-activity-1-settings.png" alt-text="Shows the "Execute pipeline" activity setting pane for "LoadDataPipeline" pipeline.":::
386386

387-
1. Select second **Execute Pipeline** activity on the canvas, and its "General" pane, to edit its details.
387+
1. Select second **Execute Pipeline** activity on the canvas, and it's "General" pane, to edit its details.
388388
- Specify **OnSuccess Notification** for **Name** of the **Execute Pipeline** activity.
389-
- In the "Settings" pane, select **NotifiyTeamsChannelPipeline** pipeline, which we created earlier, for the **Invoked pipeline** property. Customize the parameters as required based on activity type. For example, I customised the parameters as follows:
389+
- In the "Settings" pane, select **NotifiyTeamsChannelPipeline** pipeline, which we created earlier, for the **Invoked pipeline** property. Customize the parameters as required based on activity type. For example, I have customized the parameters as follows:
390390

391391
| Name | Value |
392392
| :---------------- | :---------------------------------------------------------------------------------------------------------------- |
@@ -403,13 +403,13 @@ In this sample usage scenario, we will create a master pipeline with three **Exe
403403

404404
- Create a dependency condition for the second **Execute Pipeline** activity so that it only runs if the first **Execute Pipeline** activity succeeds. To create this dependency, click the green handle on the right side of the first **Execute Pipeline** activity, drag it, and connect it to the second **Execute Pipeline** activity.
405405

406-
:::image type="content" source="media/how-to-send-notifications-to-teams/execute-pipeline-activity-2-general.png" alt-text="Shows the "Execute pipeline" activity "OnSuccess Notification" general pane for "NotifiyTeamsChannelPipeline" pipeline.":::
406+
:::image type="content" source="media/how-to-send-notifications-to-teams/execute-pipeline-activity-2-general.png" alt-text="Shows the second "Execute pipeline" activity "OnSuccess Notification" general pane for "NotifiyTeamsChannelPipeline" pipeline.":::
407407

408-
:::image type="content" source="media/how-to-send-notifications-to-teams/execute-pipeline-activity-2-settings.png" alt-text="Shows the "Execute pipeline" activity "OnSuccess Notification" setting pane for "NotifiyTeamsChannelPipeline" pipeline.":::
408+
:::image type="content" source="media/how-to-send-notifications-to-teams/execute-pipeline-activity-2-settings.png" alt-text="Shows the second "Execute pipeline" activity "OnSuccess Notification" setting pane for "NotifiyTeamsChannelPipeline" pipeline.":::
409409

410-
1. Select third **Execute Pipeline** activity on the canvas, and its "General" pane, to edit its details.
410+
1. Select third **Execute Pipeline** activity on the canvas, and it's "General" pane, to edit its details.
411411
- Specify **OnFailure Notification** for **Name** of the **Execute Pipeline** activity.
412-
- In the "Settings" pane, select **NotifiyTeamsChannelPipeline** pipeline for the **Invoked pipeline** property. Customize the parameters as required based on activity type. For example, I customised the parameters this time as follows:
412+
- In the "Settings" pane, select **NotifiyTeamsChannelPipeline** pipeline for the **Invoked pipeline** property. Customize the parameters as required based on activity type. For example, I have customized the parameters this time as follows:
413413

414414
| Name | Value |
415415
| :---------------- | :---------------------------------------------------------------------------------------------------------------- |
@@ -428,9 +428,9 @@ In this sample usage scenario, we will create a master pipeline with three **Exe
428428

429429
- Validate, debug, and then publish your **MasterPipeline** pipeline.
430430

431-
:::image type="content" source="media/how-to-send-notifications-to-teams/execute-pipeline-activity-3-general.png" alt-text="Shows the "Execute pipeline" activity "OnSuccess Notification" general pane for "NotifiyTeamsChannelPipeline" pipeline.":::
431+
:::image type="content" source="media/how-to-send-notifications-to-teams/execute-pipeline-activity-3-general.png" alt-text="Shows the third "Execute pipeline" activity "OnFailure Notification" general pane for "NotifiyTeamsChannelPipeline" pipeline.":::
432432

433-
:::image type="content" source="media/how-to-send-notifications-to-teams/execute-pipeline-activity-3-settings.png" alt-text="Shows the "Execute pipeline" activity "OnSuccess Notification" setting pane for "NotifiyTeamsChannelPipeline" pipeline.":::
433+
:::image type="content" source="media/how-to-send-notifications-to-teams/execute-pipeline-activity-3-settings.png" alt-text="Shows the third "Execute pipeline" activity "OnFailure Notification" settings pane for "NotifiyTeamsChannelPipeline" pipeline.":::
434434

435435
1. Run pipeline to receive notifications in Teams. For example, below are sample notifications, when my pipeline ran successfully and when it failed.
436436

@@ -449,7 +449,7 @@ make your messages dynamic. For example:  
449449

450450
- ``@activity("DataFlow").error.Message``
451451

452-
The above expressions will return the relevant error messages from a failure, which can be sent out as notification on a Teams channel. Refer to the
452+
The above expressions will return the relevant error messages from a failure, which can be sent out as notification on a Teams channel. For more information, see the
453453
[Copy activity output properties](copy-activity-monitoring.md) article for more details.
454454

455455
We also encourage you to review the Microsoft Teams supported [notification payload schema](https://adaptivecards.io/explorer/AdaptiveCard.html) and

0 commit comments

Comments
 (0)