| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FileParameterProvider</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">FileParameterProvider</h1><h2>Description: </h2><p>Fetches parameters from files. Parameter groups are indicated by a set of directories, and files within the directories map to parameter names. The content of the file becomes the parameter value.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>file</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Parameter Group Directories</strong></td><td>parameter-group-directories</td><td></td><td id="allowable-values"></td><td id="description">A comma-separated list of directory absolute paths that will map to named parameter groups. Each directory that contains files will map to a parameter group, named after the innermost directory in the path. Files inside the directory will map to parameter names, whose values are the content of each respective file.</td></tr><tr><td id="name"><strong>Parameter Value Byte Limit</strong></td><td>parameter-value-byte-limit</td><td id="default-value">256 B</td><td id="allowable-values"></td><td id="description">The maximum byte size of a parameter value. Since parameter values are pulled from the contents of files, this is a safeguard that can prevent memory issues if large files are included.</td></tr><tr><td id="name"><strong>Parameter Value Encoding</strong></td><td>parameter-value-encoding</td><td id="default-value">Base64</td><td id="allowable-values"><ul><li>Base64 <img src="../../../../../html/images/iconInfo.png" alt="File content is Base64-encoded, and will be decoded before providing the value as a Parameter." title="File content is Base64-encoded, and will be decoded before providing the value as a Parameter."></img></li><li>Plain text <img src="../../../../../html/images/iconInfo.png" alt="File content is not encoded, and will be provided directly as a Parameter value." title="File content is not encoded, and will be provided directly as a Parameter value."></img></li></ul></td><td id="description">Indicates how parameter values are encoded inside Parameter files.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>read filesystem</td><td>Provides operator the ability to read from any file that NiFi has access to.</td></tr></table><h3>System Resource Considerations:</h3>None specified.</body></html> |