Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-2449 This closes #845. Update Admin and Getting Started guides for custom properties

This commit is contained in:
Andrew Lim 2016-08-11 23:53:12 -04:00 committed by joewitt
parent 9c7668948c
commit d32a7ba761
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
nifi-docs/src/main/asciidoc/administration-guide.adoc
View File

@ -1915,5 +1915,19 @@ that is specified.
Example: `12 hours` Example: `12 hours`
|==== |====
[[custom_properties]]
=== Custom Properties
To configure custom properties for use with NiFi’s Expression Language:
* Create the custom property. 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.
** Each node in a clustered environment is configured with the same custom properties.
* Update the 'nifi.properties' file with the location of the custom property files.
|====
|*Property*|*Description*
|nifi.variable.registry.properties|This is a comma-separated list of file location paths for one or more custom property files.
|====
NOTE: *For Upgrading* - Take care when configuring the properties above that are marked with an asterisk (*). To make the upgrade process easier, it is advisable to change the default configurations to locations outside the main root installation directory. In this way, these items can remain in their configured location through an upgrade, and NiFi can find all the repositories and configuration files and pick up where it left off as soon as the old version is stopped and the new version is started. Furthermore, the administrator may reuse this _nifi.properties_ file and any other configuration files without having to re-configure them each time an upgrade takes place. As previously noted, it is important to check for any changes in the _nifi.properties_ file of the new version when upgrading and make sure they are reflected in the _nifi.properties_ file you use. NOTE: *For Upgrading* - Take care when configuring the properties above that are marked with an asterisk (*). To make the upgrade process easier, it is advisable to change the default configurations to locations outside the main root installation directory. In this way, these items can remain in their configured location through an upgrade, and NiFi can find all the repositories and configuration files and pick up where it left off as soon as the old version is stopped and the new version is started. Furthermore, the administrator may reuse this _nifi.properties_ file and any other configuration files without having to re-configure them each time an upgrade takes place. As previously noted, it is important to check for any changes in the _nifi.properties_ file of the new version when upgrading and make sure they are reflected in the _nifi.properties_ file you use.

7
nifi-docs/src/main/asciidoc/getting-started.adoc
View File

@ -565,6 +565,13 @@ will provide auto-complete functionality. Clicking on or using the keyboard to n
cause a tooltip to show, which explains what the function does, the arguments that it expects, and the return type of the function. cause a tooltip to show, which explains what the function does, the arguments that it expects, and the return type of the function.
Custom Properties Within Expression Language
--------------------------------------------
In addition to using FlowFile attributes, you can also define custom properties for Expression Language use. Defining custom properties gives you additional flexibility in processing and configuring dataflows. For example, you can refer to custom properties for connection, server, and service properties. Once you have created custom properties, you can identify their location in the `nifi.variable.registry.properties` field in the 'nifi.properties' file. After you have updated the 'nifi.properties' file and restarted NiFi, you are able to use custom properties as needed.
Working With Templates Working With Templates
---------------------- ----------------------