[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324826989 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. + +- *Set empty string* - Check to explicity set the value of the Parameter to an empty string. Unchecked by default. + +- *Sensitive Value* - Set to "Yes" if the Parameter's Value should be considered sensitive. If sensitive, the value of the Parameter will not be shown in the UI once applied. The default setting is "No". + +- *Description* - A description that explains what the Parameter is, how it is to be used, etc. This field is optional. + +Once these settings are configured, select "Apply". Add additional Parameters or edit any existing Parameters. + +image:update-parameter-context.png[Update Parameter Context] + +To complete the process, select "Apply" from the Parameter Context window. The following operations are performed to validate all components that reference the added or modified parameters: Stopping/Restarting affected Processors, Disabling/Re-enabling affected Controller Services, Updating Parameter Context. + +image:parameters-validate-affected-components.png[Validate Affected Components] + +The Referencing Components section lists any components referencing the parameters in the parameter context organized by process group. + +[[assigning_parameter_context_to_PG]] + Assigning a Parameter Context to a Process Group +For a component to reference a Parameter, its Process Group must first be assigned to a Parameter Context. Once assigned, processors and controller services within that Process Group may only reference Parameters
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324799529 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -729,23 +901,30 @@ NiFi properties have resolution precedence of which you should be aware when cre * Processor-specific attributes * FlowFile properties * FlowFile attributes -* From variable registry: +* From Variable Registry: ** User defined properties (custom properties) ** System properties ** Operating System environment variables When you are creating custom properties, ensure that each custom property contains a distinct property value, so that it is not overridden by existing environment properties, system properties, or FlowFile attributes. -There are two ways to use and manage custom properties: +There are two ways to use and manage custom properties with Expression Language: + +- *Variables*: Variables are created and configured within the NiFi UI. They can be used in any field that supports Expression Language. Variables cannot be used for sensitive properties. NiFi automatically picks up new or modified variables. Variables are defined at the Process Group level, as a result, the access policies for viewing and changing variables are derived from the access policies of the Process Group. See <> for more information. Review comment: I made sure to state "two ways to use and manage custom properties **with Expression Language**", which is a category I don't believe Parameters fall under. But, since Customer Properties File method uses Variables, I changed the note to include that this functionality will be removed also. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324801095 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -729,23 +901,30 @@ NiFi properties have resolution precedence of which you should be aware when cre * Processor-specific attributes * FlowFile properties * FlowFile attributes -* From variable registry: +* From Variable Registry: ** User defined properties (custom properties) ** System properties ** Operating System environment variables When you are creating custom properties, ensure that each custom property contains a distinct property value, so that it is not overridden by existing environment properties, system properties, or FlowFile attributes. -There are two ways to use and manage custom properties: +There are two ways to use and manage custom properties with Expression Language: + +- *Variables*: Variables are created and configured within the NiFi UI. They can be used in any field that supports Expression Language. Variables cannot be used for sensitive properties. NiFi automatically picks up new or modified variables. Variables are defined at the Process Group level, as a result, the access policies for viewing and changing variables are derived from the access policies of the Process Group. See <> for more information. + +WARNING: Variables are still supported for compatibility purposes but do not have the same power as Parameters such as support for sensitive properties and more granular control over who can create, modify or use them. Variables will be removed in a future release. As a result, it is highly recommended to switch to Parameters. Review comment: Good call. Added this warning under the "Variables" heading and the "Referencing Custom Properties via nifi.properties" heading. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324799529 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -729,23 +901,30 @@ NiFi properties have resolution precedence of which you should be aware when cre * Processor-specific attributes * FlowFile properties * FlowFile attributes -* From variable registry: +* From Variable Registry: ** User defined properties (custom properties) ** System properties ** Operating System environment variables When you are creating custom properties, ensure that each custom property contains a distinct property value, so that it is not overridden by existing environment properties, system properties, or FlowFile attributes. -There are two ways to use and manage custom properties: +There are two ways to use and manage custom properties with Expression Language: + +- *Variables*: Variables are created and configured within the NiFi UI. They can be used in any field that supports Expression Language. Variables cannot be used for sensitive properties. NiFi automatically picks up new or modified variables. Variables are defined at the Process Group level, as a result, the access policies for viewing and changing variables are derived from the access policies of the Process Group. See <> for more information. Review comment: I made sure to state "two ways to use and manage custom properties **with Expression Language**", which is a category I don't believe Parameters fall under. But, since Customer Properties File method uses Variables, I changed the note to include that his functionality will be removed also. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324783889 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. + +- *Set empty string* - Check to explicity set the value of the Parameter to an empty string. Unchecked by default. + +- *Sensitive Value* - Set to "Yes" if the Parameter's Value should be considered sensitive. If sensitive, the value of the Parameter will not be shown in the UI once applied. The default setting is "No". + +- *Description* - A description that explains what the Parameter is, how it is to be used, etc. This field is optional. + +Once these settings are configured, select "Apply". Add additional Parameters or edit any existing Parameters. + +image:update-parameter-context.png[Update Parameter Context] + +To complete the process, select "Apply" from the Parameter Context window. The following operations are performed to validate all components that reference the added or modified parameters: Stopping/Restarting affected Processors, Disabling/Re-enabling affected Controller Services, Updating Parameter Context. + +image:parameters-validate-affected-components.png[Validate Affected Components] + +The Referencing Components section lists any components referencing the parameters in the parameter context organized by process group. Review comment: That's a good distinction. I've improved the two screenshots and also added some more clarifying text. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324768080 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. Review comment: Good idea. Added. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324346114 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. + +- *Set empty string* - Check to explicity set the value of the Parameter to an empty string. Unchecked by default. + +- *Sensitive Value* - Set to "Yes" if the Parameter's Value should be considered sensitive. If sensitive, the value of the Parameter will not be shown in the UI once applied. The default setting is "No". + +- *Description* - A description that explains what the Parameter is, how it is to be used, etc. This field is optional. + +Once these settings are configured, select "Apply". Add additional Parameters or edit any existing Parameters. + +image:update-parameter-context.png[Update Parameter Context] + +To complete the process, select "Apply" from the Parameter Context window. The following operations are performed to validate all components that reference the added or modified parameters: Stopping/Restarting affected Processors, Disabling/Re-enabling affected Controller Services, Updating Parameter Context. + +image:parameters-validate-affected-components.png[Validate Affected Components] + +The Referencing Components section lists any components referencing the parameters in the parameter context organized by process group. + +[[assigning_parameter_context_to_PG]] + Assigning a Parameter Context to a Process Group +For a component to reference a Parameter, its Process Group must first be assigned to a Parameter Context. Once assigned, processors and controller services within that Process Group may only reference Parameters
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324297610 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. + +- *Set empty string* - Check to explicity set the value of the Parameter to an empty string. Unchecked by default. + +- *Sensitive Value* - Set to "Yes" if the Parameter's Value should be considered sensitive. If sensitive, the value of the Parameter will not be shown in the UI once applied. The default setting is "No". + +- *Description* - A description that explains what the Parameter is, how it is to be used, etc. This field is optional. + +Once these settings are configured, select "Apply". Add additional Parameters or edit any existing Parameters. + +image:update-parameter-context.png[Update Parameter Context] + +To complete the process, select "Apply" from the Parameter Context window. The following operations are performed to validate all components that reference the added or modified parameters: Stopping/Restarting affected Processors, Disabling/Re-enabling affected Controller Services, Updating Parameter Context. + +image:parameters-validate-affected-components.png[Validate Affected Components] + +The Referencing Components section lists any components referencing the parameters in the parameter context organized by process group. + +[[assigning_parameter_context_to_PG]] + Assigning a Parameter Context to a Process Group +For a component to reference a Parameter, its Process Group must first be assigned to a Parameter Context. Once assigned, processors and controller services within that Process Group may only reference Parameters
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324285008 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. + +- *Set empty string* - Check to explicity set the value of the Parameter to an empty string. Unchecked by default. + +- *Sensitive Value* - Set to "Yes" if the Parameter's Value should be considered sensitive. If sensitive, the value of the Parameter will not be shown in the UI once applied. The default setting is "No". + +- *Description* - A description that explains what the Parameter is, how it is to be used, etc. This field is optional. + +Once these settings are configured, select "Apply". Add additional Parameters or edit any existing Parameters. + +image:update-parameter-context.png[Update Parameter Context] + +To complete the process, select "Apply" from the Parameter Context window. The following operations are performed to validate all components that reference the added or modified parameters: Stopping/Restarting affected Processors, Disabling/Re-enabling affected Controller Services, Updating Parameter Context. + +image:parameters-validate-affected-components.png[Validate Affected Components] + +The Referencing Components section lists any components referencing the parameters in the parameter context organized by process group. + +[[assigning_parameter_context_to_PG]] + Assigning a Parameter Context to a Process Group +For a component to reference a Parameter, its Process Group must first be assigned to a Parameter Context. Once assigned, processors and controller services within that Process Group may only reference Parameters
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324242476 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. + +- *Set empty string* - Check to explicity set the value of the Parameter to an empty string. Unchecked by default. + +- *Sensitive Value* - Set to "Yes" if the Parameter's Value should be considered sensitive. If sensitive, the value of the Parameter will not be shown in the UI once applied. The default setting is "No". + +- *Description* - A description that explains what the Parameter is, how it is to be used, etc. This field is optional. + +Once these settings are configured, select "Apply". Add additional Parameters or edit any existing Parameters. + +image:update-parameter-context.png[Update Parameter Context] + +To complete the process, select "Apply" from the Parameter Context window. The following operations are performed to validate all components that reference the added or modified parameters: Stopping/Restarting affected Processors, Disabling/Re-enabling affected Controller Services, Updating Parameter Context. + +image:parameters-validate-affected-components.png[Validate Affected Components] + +The Referencing Components section lists any components referencing the parameters in the parameter context organized by process group. + +[[assigning_parameter_context_to_PG]] + Assigning a Parameter Context to a Process Group +For a component to reference a Parameter, its Process Group must first be assigned to a Parameter Context. Once assigned, processors and controller services within that Process Group may only reference Parameters
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324241813 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. + +- *Set empty string* - Check to explicity set the value of the Parameter to an empty string. Unchecked by default. + +- *Sensitive Value* - Set to "Yes" if the Parameter's Value should be considered sensitive. If sensitive, the value of the Parameter will not be shown in the UI once applied. The default setting is "No". + +- *Description* - A description that explains what the Parameter is, how it is to be used, etc. This field is optional. + +Once these settings are configured, select "Apply". Add additional Parameters or edit any existing Parameters. + +image:update-parameter-context.png[Update Parameter Context] + +To complete the process, select "Apply" from the Parameter Context window. The following operations are performed to validate all components that reference the added or modified parameters: Stopping/Restarting affected Processors, Disabling/Re-enabling affected Controller Services, Updating Parameter Context. + +image:parameters-validate-affected-components.png[Validate Affected Components] + +The Referencing Components section lists any components referencing the parameters in the parameter context organized by process group. + +[[assigning_parameter_context_to_PG]] + Assigning a Parameter Context to a Process Group +For a component to reference a Parameter, its Process Group must first be assigned to a Parameter Context. Once assigned, processors and controller services within that Process Group may only reference Parameters
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324240880 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. + +- *Set empty string* - Check to explicity set the value of the Parameter to an empty string. Unchecked by default. + +- *Sensitive Value* - Set to "Yes" if the Parameter's Value should be considered sensitive. If sensitive, the value of the Parameter will not be shown in the UI once applied. The default setting is "No". + +- *Description* - A description that explains what the Parameter is, how it is to be used, etc. This field is optional. + +Once these settings are configured, select "Apply". Add additional Parameters or edit any existing Parameters. + +image:update-parameter-context.png[Update Parameter Context] + +To complete the process, select "Apply" from the Parameter Context window. The following operations are performed to validate all components that reference the added or modified parameters: Stopping/Restarting affected Processors, Disabling/Re-enabling affected Controller Services, Updating Parameter Context. + +image:parameters-validate-affected-components.png[Validate Affected Components] + +The Referencing Components section lists any components referencing the parameters in the parameter context organized by process group. + +[[assigning_parameter_context_to_PG]] + Assigning a Parameter Context to a Process Group +For a component to reference a Parameter, its Process Group must first be assigned to a Parameter Context. Once assigned, processors and controller services within that Process Group may only reference Parameters
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324238782 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. + +- *Set empty string* - Check to explicity set the value of the Parameter to an empty string. Unchecked by default. + +- *Sensitive Value* - Set to "Yes" if the Parameter's Value should be considered sensitive. If sensitive, the value of the Parameter will not be shown in the UI once applied. The default setting is "No". + +- *Description* - A description that explains what the Parameter is, how it is to be used, etc. This field is optional. + +Once these settings are configured, select "Apply". Add additional Parameters or edit any existing Parameters. + +image:update-parameter-context.png[Update Parameter Context] + +To complete the process, select "Apply" from the Parameter Context window. The following operations are performed to validate all components that reference the added or modified parameters: Stopping/Restarting affected Processors, Disabling/Re-enabling affected Controller Services, Updating Parameter Context. + +image:parameters-validate-affected-components.png[Validate Affected Components] + +The Referencing Components section lists any components referencing the parameters in the parameter context organized by process group. + +[[assigning_parameter_context_to_PG]] + Assigning a Parameter Context to a Process Group +For a component to reference a Parameter, its Process Group must first be assigned to a Parameter Context. Once assigned, processors and controller services within that Process Group may only reference Parameters
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324237736 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. + +- *Set empty string* - Check to explicity set the value of the Parameter to an empty string. Unchecked by default. + +- *Sensitive Value* - Set to "Yes" if the Parameter's Value should be considered sensitive. If sensitive, the value of the Parameter will not be shown in the UI once applied. The default setting is "No". + +- *Description* - A description that explains what the Parameter is, how it is to be used, etc. This field is optional. + +Once these settings are configured, select "Apply". Add additional Parameters or edit any existing Parameters. + +image:update-parameter-context.png[Update Parameter Context] + +To complete the process, select "Apply" from the Parameter Context window. The following operations are performed to validate all components that reference the added or modified parameters: Stopping/Restarting affected Processors, Disabling/Re-enabling affected Controller Services, Updating Parameter Context. + +image:parameters-validate-affected-components.png[Validate Affected Components] + +The Referencing Components section lists any components referencing the parameters in the parameter context organized by process group. + +[[assigning_parameter_context_to_PG]] + Assigning a Parameter Context to a Process Group +For a component to reference a Parameter, its Process Group must first be assigned to a Parameter Context. Once assigned, processors and controller services within that Process Group may only reference Parameters
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324236849 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. + +- *Set empty string* - Check to explicity set the value of the Parameter to an empty string. Unchecked by default. + +- *Sensitive Value* - Set to "Yes" if the Parameter's Value should be considered sensitive. If sensitive, the value of the Parameter will not be shown in the UI once applied. The default setting is "No". Review comment: Made this update. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [nifi] andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide
andrewmlim commented on a change in pull request #3725: NIFI-6558 Added Parameters to User Guide and Sys Admin Guide URL: https://github.com/apache/nifi/pull/3725#discussion_r324234880 ## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ## @@ -711,15 +711,187 @@ whatever comments are appropriate for this component. Use of the Comments tab is image::comments-tab.png["Comments Tab"] -=== Additional Help + Additional Help You can access additional documentation about each Processor's usage by right-clicking on the Processor and selecting 'Usage' from the context menu. Alternatively, select Help from the Global Menu in the top-right corner of the UI to display a Help page with all of the documentation, including usage documentation for all the Processors that are available. Click on the desired Processor to view usage documentation. +[[Parameters]] +=== Parameters +The values of properties in the flow, including sensitive properties, can be parameterized using Parameters. Parameters are created and configured within the NiFi UI. Any property can be configured to reference a Parameter with the following conditions: + + - A sensitive property can only reference a Sensitive Parameter + - A non-sensitive property can only reference a non-Sensitive Parameter + - Properties that reference Controller Services can not use Parameters + +NOTE: NiFi automatically picks up new or modified parameters. + +[[parameter-contexts]] + Parameter Contexts +Parameters are created within Parameter Contexts. Parameter Contexts are globally defined/accessible to the NiFi instance. Access policies can be applied to Parameter Contexts to determine which users can create them. Once created, policies to read and write to a specific Parameter Context can also be applied (see <> for more information). + += Creating a Parameter Context +To create a Parameter Context, select Parameter Contexts from the Global Menu: + +image:parameter-contexts-selection.png["Global Menu - Parameter Contexts"] + +In the Parameter Contexts window, click the `+` button in the upper-right corner and the Add Parameter Context window opens. The window has two tabs: Settings and Parameters. + +image:parameter-contexts-settings.png["Parameter Contexts - Settings"] + +On the "Settings" tab, add a name for the Parameter Context and a description if desired. Select "Apply" to save the Parameter Context or select the "Parameters" tab to add parameters to the context. + + Adding a Parameter to a Parameter Context +Parameters can be added during Parameter Context creation or added to existing Parameter Contexts. + +During Parameter Context creation, select the "Parameters" tab. Click the `+` button to open the Add Parameter window. + +image:add-parameter-during-parameter-context-creation.png[Add Parameter] + +To add parameters to an existing Parameter Context, open the Parameter Context window and click the Edit button (image:iconEdit.png["Edit"]) in the row of the desired Parameter Context. + +image:edit-parameter-context.png[Edit Parameter Context] + +On the "Parameters" tab, click the `+` button to open the Add Parameter window. + +The Add Parameter window has the following settings: + +- *Name* - A name that is used to denote the Parameter. Only alpha-numeric characters (a-z, A-Z, 0-9), hyphens ( - ), underscores ( _ ), periods ( . ), and spaces are allowed. + +- *Value* - The value that will be used when the Parameter is referenced. + +- *Set empty string* - Check to explicity set the value of the Parameter to an empty string. Unchecked by default. Review comment: Added a note for this. Also corrected "explicity" to "explicitly". This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services