Skip to content

Commit 9004f1c

Browse files
committed
Fix Wording and Update TOC
1 parent baa1834 commit 9004f1c

File tree

2 files changed

+19
-16
lines changed

2 files changed

+19
-16
lines changed

articles/data-factory/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -761,6 +761,8 @@ items:
761761
- name: Set Variable activity
762762
href: control-flow-set-variable-activity.md
763763
displayName: variables, control flow
764+
- name: Set Pipeline Return Value
765+
href: tutorial-pipeline-return-value.md
764766
- name: Switch activity
765767
href: control-flow-switch-activity.md
766768
displayName: control flow

articles/data-factory/tutorial-pipeline-return-value.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,28 @@ ms.reviewer: jburchel
1515
# Set Pipeline Return Value in Azure Data Factory and Azure Synapse Analytics
1616
[!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)]
1717

18-
In the calling pipeline-child pipeline paradigm, you can use the [Set Variable activity](control-flow-set-variable-activity.md) to return values from the child pipeline to the calling pipeline. In the following scenario, we have a child pipeline through [Execute Pipeline Activity](control-flow-execute-pipeline-activity.md). And we want to __retrieve information from the child pipeline__, to be sebsequently used in the calling pipeline.
18+
In the calling pipeline-child pipeline paradigm, you can use the [Set Variable activity](control-flow-set-variable-activity.md) to return values from the child pipeline to the calling pipeline. In the following scenario, we have a child pipeline through [Execute Pipeline Activity](control-flow-execute-pipeline-activity.md). And we want to __retrieve information from the child pipeline__, to then be used in the calling pipeline.
1919

2020
:::image type="content" source="media/pipeline-return-value/pipeline-return-value-00-paradigm.png" alt-text="Screenshot with ExecutePipeline Activity.":::
2121

2222
Introduce pipeline return value, a dictionary of key value pairs, that allows communications between child pipelines and parent pipeline.
2323

24-
## Pre-requesite - Calling a Child Pipeline
24+
## Prerequisite - Calling a Child Pipeline
2525

26-
The pre-requesite of the use case, is that you have an [Execute Pipeline Activity](control-flow-execute-pipeline-activity.md), calling a child pipeline. It is important that we enabled _Wait on Completion_ for the activity
26+
The prerequisite of the use case, is that you've an [Execute Pipeline Activity](control-flow-execute-pipeline-activity.md), calling a child pipeline. It's important that we enabled _Wait on Completion_ for the activity
2727

2828
:::image type="content" source="media/pipeline-return-value/pipeline-return-value-01-execute-pipeline-setting.png" alt-text="Screenshot setting ExecutePipeline Activity to wait for completion.":::
2929

3030

3131
## Configure Pipeline Return Value in Child Pipeline
3232

33-
We have expanded the [Set Variable activity](control-flow-set-variable-activity.md) to include system variables _Pipeline Return Value_. You do not need to define them at pipeline level (as opposed to any other variables you use in the pipeline).
33+
We've expanded the [Set Variable activity](control-flow-set-variable-activity.md) to include system variables _Pipeline Return Value_. You don't need to define them at pipeline level (as opposed to any other variables you use in the pipeline).
3434

3535
1. Search for _Set Variable_ in the pipeline Activities pane, and drag a Set Variable activity to the pipeline canvas.
36-
1. Select the Set Variable activity on the canvas if it is not already selected, and then its **Variables** tab, to edit its details.
36+
1. Select the Set Variable activity on the canvas if it isn't already selected, and then its **Variables** tab, to edit its details.
3737
1. Choose _Pipeline return value_ for variable type.
38-
1. Click _New_ to add a new key value pair.
39-
1. You can add resonable ammount of key value pairs, bounded by size limit of returning json.
38+
1. Select _New_ to add a new key value pair.
39+
1. You can add reasonable number of key value pairs, bounded by size limit of returning json.
4040

4141
:::image type="content" source="media/pipeline-return-value/pipeline-return-value-02-child-pipeline.png" alt-text="Screenshot shows the ui for pipeline return value.":::
4242

@@ -48,12 +48,12 @@ String | The most straight forward of all. It expects a string value.
4848
Expression | It allows you to reference output from previous activities.
4949
Array | It expects an array of _string values_. Press "enter" key to separate values in the array
5050
Boolean | True or False
51-
Null | Signal place holder status; the value will be constant _null_
51+
Null | Signal place holder status; the value is constant _null_
5252
Int | It expects a numerical value of integer type
5353
Float | It expects a numerical value of float type
54-
Object | __Warning__ very complicated use cases only. It allows you to embed a list of key value pairs type, i.e. json, for the value
54+
Object | __Warning__ complicated use cases only. It allows you to embed a list of key value pairs type for the value
5555

56-
Object Type are defined as follows:
56+
Value of object type is defined as follows:
5757

5858
``` json
5959
[{"key": "myKey1", "value": {"type": "String", "content": "hello world"}},
@@ -63,16 +63,17 @@ Object Type are defined as follows:
6363

6464
## Retrieving Value in Calling Pipeline
6565

66-
The pipeline return value of the child pipeline will become the activity output of the Execute Pipeline Activity. You can retrieve the information with _@activity('Execute Pipeline1').output.pipelineReturnValue.keyName_. The use case is limitless.
67-
68-
For instance, you may use an _int_ value from child pipeline to define the wait period for a [wait activity](control-flow-wait-activity.md), or a _sting_ value to definet the URL for the [Web activity](control-flow-web-activity.md), or _expression_ payload to a [script activity](transform-data-using-script.md) for logging purposes.
66+
The pipeline return value of the child pipeline becomes the activity output of the Execute Pipeline Activity. You can retrieve the information with _@activity('Execute Pipeline1').output.pipelineReturnValue.keyName_. The use case is limitless. For instance, you may use
67+
* An _int_ value from child pipeline to define the wait period for a [wait activity](control-flow-wait-activity.md)
68+
* A _sting_ value to define the URL for the [Web activity](control-flow-web-activity.md)
69+
* An _expression_ value payload for a [script activity](transform-data-using-script.md) for logging purposes.
6970

7071
:::image type="content" source="media/pipeline-return-value/pipeline-return-value-03-calling-pipeline.png" alt-text="Screenshot shows the ui for pipeline return value.":::
7172

72-
There are 2 noticeable call outs in referencing the pipeline return values.
73+
There are two noticeable call outs in referencing the pipeline return values.
7374

7475
1. With _Object_ type, you may further expand into the nested json object, such as _@activity('Execute Pipeline1').output.pipelineReturnValue.keyName.nextLevelKey_
75-
1. With _Array_ type, you can specify the index in the list, with _@activity('Execute Pipeline1').output.pipelineReturnValue.keyName[0]_. The number is zero indexed, meaning that it starts with 0.
76+
2. With _Array_ type, you can specify the index in the list, with _@activity('Execute Pipeline1').output.pipelineReturnValue.keyName[0]_. The number is zero indexed, meaning that it starts with 0.
7677

7778
> [!NOTE]
7879
> Please make sure that the _keyName_ you are referencing exists in your child pipeline. ADF expression builder can _not_ confirm the referential check for you.
@@ -84,7 +85,7 @@ You may have multiple Set Pipeline Return value activities in a pipeline. Howeve
8485

8586
:::image type="content" source="media/pipeline-return-value/pipeline-return-value-04-multiple.png" alt-text="Screenshot with Pipeline Return Value and Branching.":::
8687

87-
To avoid missing key nissing situation in the calling pipeline, described above, we encourage you to have the same list of keys for all branches in child pipeline. Please consider using _null_ types for keys that doesn't have values, in a specific branch.
88+
To avoid missing key situation in the calling pipeline, described above, we encourage you to have the same list of keys for all branches in child pipeline. Consider using _null_ types for keys that don't have values, in a specific branch.
8889

8990
## Next steps
9091
Learn about another related control flow activity:

0 commit comments

Comments
 (0)