Repository: nifi
Updated Branches:
  refs/heads/master 4366c67b2 -> ce0855e98

NIFI-5074 Added section Variables in Versioned Flows to User Guide

Signed-off-by: Pierre Villard <>

This closes #2627.


Branch: refs/heads/master
Commit: ce0855e9883ef353108a3989350d1e8097ac5191
Parents: 4366c67
Author: Andrew Lim <>
Authored: Wed Apr 11 12:24:16 2018 -0400
Committer: Pierre Villard <>
Committed: Wed Apr 11 18:53:07 2018 +0200

 .../asciidoc/images/PG1_Variable_Reference.png  | Bin 0 -> 59812 bytes
 .../main/asciidoc/images/PG1_imported_diff.png  | Bin 0 -> 143940 bytes
 .../main/asciidoc/images/PG1_imported_same.png  | Bin 0 -> 170541 bytes
 .../main/asciidoc/images/PG1_process_group.png  | Bin 0 -> 176792 bytes
 .../main/asciidoc/images/PG1_variable_ref_2.png | Bin 0 -> 61554 bytes
 .../asciidoc/images/PG1_variable_ref_PG.png     | Bin 0 -> 59326 bytes
 .../main/asciidoc/images/PG1_versioned_flow.png | Bin 0 -> 144635 bytes
 .../src/main/asciidoc/images/rpg-variable.png   | Bin 0 -> 60025 bytes
 nifi-docs/src/main/asciidoc/user-guide.adoc     |  36 ++++++++++++++++++-
 9 files changed, 35 insertions(+), 1 deletion(-)
diff --git a/nifi-docs/src/main/asciidoc/images/PG1_Variable_Reference.png 
new file mode 100644
index 0000000..d163e49
Binary files /dev/null and 
b/nifi-docs/src/main/asciidoc/images/PG1_Variable_Reference.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/PG1_imported_diff.png 
new file mode 100644
index 0000000..64ac5e3
Binary files /dev/null and 
b/nifi-docs/src/main/asciidoc/images/PG1_imported_diff.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/PG1_imported_same.png 
new file mode 100644
index 0000000..27bd0f0
Binary files /dev/null and 
b/nifi-docs/src/main/asciidoc/images/PG1_imported_same.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/PG1_process_group.png 
new file mode 100644
index 0000000..0ab327c
Binary files /dev/null and 
b/nifi-docs/src/main/asciidoc/images/PG1_process_group.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/PG1_variable_ref_2.png 
new file mode 100644
index 0000000..2400ceb
Binary files /dev/null and 
b/nifi-docs/src/main/asciidoc/images/PG1_variable_ref_2.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/PG1_variable_ref_PG.png 
new file mode 100644
index 0000000..9aa6250
Binary files /dev/null and 
b/nifi-docs/src/main/asciidoc/images/PG1_variable_ref_PG.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/PG1_versioned_flow.png 
new file mode 100644
index 0000000..de12212
Binary files /dev/null and 
b/nifi-docs/src/main/asciidoc/images/PG1_versioned_flow.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/rpg-variable.png 
new file mode 100644
index 0000000..1975491
Binary files /dev/null and 
b/nifi-docs/src/main/asciidoc/images/rpg-variable.png differ
diff --git a/nifi-docs/src/main/asciidoc/user-guide.adoc 
index 09dc543..e7806fb 100644
--- a/nifi-docs/src/main/asciidoc/user-guide.adoc
+++ b/nifi-docs/src/main/asciidoc/user-guide.adoc
@@ -1878,7 +1878,7 @@ The following actions are not considered local changes:
 * updating a processor that was referencing a non-existent controller service 
to reference an externally available controller service
 * modifying variables
-WARNING: Variables do not support sensitive values and will be included when 
versioning a Process Group.
+WARNING: Variables do not support sensitive values and will be included when 
versioning a Process Group. See <<Variables_in_Versioned_Flows>> for more 
 ==== Show Local Changes
 The local changes made to a versioned process group can be viewed in the Show 
Local Changes dialog by selecting "Version->Show local changes" from the 
context menu.
@@ -1940,6 +1940,40 @@ 
image::process-group-version-control-stopped.png["Version Control Stopped on Pro
 === Nested Versioned Flows
 A versioned process group can contain other versioned process groups.  
However, local changes to a parent process group cannot be reverted or saved if 
it contains a child process group that also has local changes.  The child 
process group must first be reverted or have its changes committed for those 
actions to be performed on the parent process group.
+=== Variables in Versioned Flows
+Variables are included when a process group is placed under version control.  
If a versioned flow is imported that references a variable not defined in the 
versioned process group, the reference is maintained if the variable exists.  
If the referenced variable does not exist, a copy of the variable will be 
defined in the process group.  To illustrate, assume the variable “RPG_Var" 
is defined in the root process group:
+image::rpg-variable.png["Root Process Group Defined Variable"]
+A process group PG1 is created:
+image::PG1_process_group.png["PG1 Process Group"]
+The GetFile processor in PG1 references the variable "RPG_Var":
+image::PG1_variable_reference.png["PG1 References RPG Variable"]
+PG1 is saved as a versioned flow:
+image::PG1_versioned_flow.png["PG1 Versioned Flow"]
+If PG1 versioned flow is imported into this same NiFi instance:
+image::PG1_imported_same.png["PG1 Imported to Same NiFi"]
+the added GetFile processor will also reference the "RPG_Var" variable that 
exists in the root process group:
+image::PG1_variable_ref_2.png["Both PG1 Reference RPG Variable"]
+If PG1 versioned flow is imported into a different NiFi instance where 
"RPG_Var" does not exist:
+image::PG1_imported_diff.png["PG1 Imported to Different NiFi"]
+A "RPG_Var" variable is created in the PG1 process group:
+image::PG1_variable_ref_PG.png["PG1 References PG Variable Copy"]
 === Restricted Components in Versioned Flows
 To import a versioned flow or revert local changes in a versioned flow, a user 
must have access to all the components in the versioned flow. As such, it is 
recommended that restricted components are created at the root process group 
level if they are to be utilized in versioned flows. Let's walk through some 
examples to illustrate the benefits of this configuration. Assume the following:

Reply via email to