...
Let's have a look at the following example with two translators: shared_var_test_1 and shared_var_test_2. We want to share a variable (called variableA) from one translator to another.
Step-by-step instruction to do that:
Double-click first translator to open its worksheet and drop the Variable shape from the left panel ToolBox in CONTROL OBJECTS group:
By default, the variable is named as var. To set another name, click to the shape, and change the property Name in the left panel.
In our example we want to rename it to variableA.
To set a value for the variable, click the shape and put the value to the fx input on top of the workspace using quotes.
Update the default variable varTaskParamsTo do that, three steps have to be taken
Step 1: Declare the variable as "output variable" in the source shape
This is done simply by typing the variable name (or comma-separated list of names) in the OutParams property of the source shape:
...
Step 2. Instruct the target shape to receive this new variable as input.
Click on the second task and in the CustomCMParams property set the name of the variable in the first column.
It does not have to be same variableA. You can use another alias for the target shape.
In the second column you should use the following construct:
Code Block |
---|
EXPR#:param_TASK_[name_of_task]_[original_name_of_shared_parameter]: |
...
EXPR#:param_TASK_ is a required prefix. [name_of_task] is the name of the task where shared variable was created (shared_var_test_1 in our example). And variableA is the original name of the shared variable.
Info |
---|
There are three default variables generated by each shape: :TASK_[name_of_task]_STATUS:, :TASK_[name_of_task]_CORRID: and :TASK_[name_of_task]_SEVERITYCODE: . Such variables do not require 'param_' prefix in front of them. |
Final expression for our example:
Code Block |
---|
EXPR#:param_TASK_shared_var_test_1_variableA: |
...
Step 3. In the source shape, make the variable visible to the whole workflow.
This step differs depending on the type of source shape. Expand corresponding link below to see specific details
Expand | ||||
---|---|---|---|---|
| ||||
Drop the Code shape from left panel in ADVANCED group and set value of the Code shape as
If you need to share more variables you can add them to the Code shape using syntax variable_name;variable_value!. For example, if we have another variable count to share, the Code shape value is set like this:
Your final picture should look like this |
Expand | ||
---|---|---|
| ||
Step A: Drop a Variable shape onto the worksheet. It represents the variable you are going to share. Drop a Call Include shape from the left panel in ADVANCED group |
...
and click |
...
The include file will open for edit:
Paste the following code into the editor
...
language | xml |
---|
...
the Browse button next to the File property in the right panel ../eagle_ml-2-0_cm/w_config.inc |
...
Or, click the "ellipsis" button to select the file from the open dialog. Step C: Drop the Code shape from left panel in group ADVANCED after the variable box and set value of the Code shape as
|
...
Step D: Drop a Call Include shape from the Advanced section of the toolbox, and type the following text in its File property: ../eagle_ml-2-0_cm/get_w_state.inc |
...
You can change the code between the two green lines <!-- Code which you can change starts here --> and <!-- Code which you can change ends here --> to add shared variables.
In our case:
...
Or, click the "ellipsis" button to select the file from the open dialog. Step E: Drop another Code shape and set its value as:
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Now you can save and close editor tab
...
If you add several variables, use comma separator in OutParams property, for example, variableA,variable1,variable2,…
Now we can call variable variableA like this EXPR#:param_variableA:
Click to the second translator and in the property CustomCMParams set the name of the variable in first column, which you will use in the translator. It is not necessary to use the original name variableA in first column.
In the second column you must use the following construction:
Code Block |
---|
EXPR#:param_TASK_[name_of_task]_[original_name_of_shared_parameter]: |
EXPR#:param_TASK_ is a required prefix. [name_of_task] is the name of the task where shared variable was created (shared_var_test_1 in our example). And variableA is the original name of the shared variable.
Final expression for our example:
Code Block |
---|
EXPR#:param_TASK_shared_var_test_1_variableA: |
Double click second translator. Here you can use :param_it_is_shared_var: construction.
param_ is a required prefix, then goes the name which you set in CustomCMParams property earlier.
Workspace of the second translator.
We drop a STATUS shape to check the value of the variable.
Status after workflow launch
Step F: Drop the second Call Include shape and type or select file ../eagle_ml-2-0_cm/upd_w_state.inc after all these additions you should have something similar to this: |
To verify that new variables are passed to the target shape, run your workflow and check the Control Message tab in the Monitoring Tool.
You should be able to see your new variables as input parameters in the RTR:
...