| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>TransformXml</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;">TransformXml</h1><h2>Description: </h2><p>Applies the provided XSLT file to the FlowFile XML payload. A new FlowFile is created with transformed content and is routed to the 'success' relationship. If the XSL transform fails, the original FlowFile is routed to the 'failure' relationship</p><h3>Tags: </h3><p>xml, xslt, transform</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, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</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">XSLT file name</td><td>XSLT file name</td><td></td><td id="allowable-values"></td><td id="description">Provides the name (including full path) of the XSLT file to apply to the FlowFile XML content.One of the 'XSLT file name' and 'XSLT Lookup' properties must be defined.<br/><br/><strong>This property requires exactly one file to be provided..</strong><br/><br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">XSLT Lookup</td><td>xslt-controller</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>StringLookupService<br/><strong>Implementations: </strong><a href="../../../nifi-lookup-services-nar/1.19.1/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html">SimpleCsvFileLookupService</a><br/><a href="../../../nifi-couchbase-nar/1.19.1/org.apache.nifi.couchbase.CouchbaseKeyValueLookupService/index.html">CouchbaseKeyValueLookupService</a><br/><a href="../../../nifi-lookup-services-nar/1.19.1/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html">DistributedMapCacheLookupService</a><br/><a href="../../../nifi-elasticsearch-client-service-nar/1.19.1/org.apache.nifi.elasticsearch.ElasticSearchStringLookupService/index.html">ElasticSearchStringLookupService</a><br/><a href="../../../nifi-lookup-services-nar/1.19.1/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html">SimpleKeyValueLookupService</a><br/><a href="../../../nifi-lookup-services-nar/1.19.1/org.apache.nifi.lookup.XMLFileLookupService/index.html">XMLFileLookupService</a><br/><a href="../../../nifi-scripting-nar/1.19.1/org.apache.nifi.lookup.script.SimpleScriptedLookupService/index.html">SimpleScriptedLookupService</a><br/><a href="../../../nifi-lookup-services-nar/1.19.1/org.apache.nifi.lookup.db.SimpleDatabaseLookupService/index.html">SimpleDatabaseLookupService</a><br/><a href="../../../nifi-lookup-services-nar/1.19.1/org.apache.nifi.lookup.PropertiesFileLookupService/index.html">PropertiesFileLookupService</a></td><td id="description">Controller lookup used to store XSLT definitions. One of the 'XSLT file name' and 'XSLT Lookup' properties must be defined. WARNING: note that the lookup controller service should not be used to store large XSLT files.</td></tr><tr><td id="name">XSLT Lookup key</td><td>xslt-controller-key</td><td></td><td id="allowable-values"></td><td id="description">Key used to retrieve the XSLT definition from the XSLT lookup controller. This property must be set when using the XSLT controller property.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Indent</strong></td><td>indent-output</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to indent the output.</td></tr><tr><td id="name"><strong>Secure processing</strong></td><td>secure-processing</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to mitigate various XML-related attacks like XXE (XML External Entity) attacks.</td></tr><tr><td id="name"><strong>Cache size</strong></td><td>cache-size</td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">Maximum number of stylesheets to cache. Zero disables the cache.</td></tr><tr><td id="name"><strong>Cache TTL after last access</strong></td><td>cache-ttl-after-last-access</td><td id="default-value">60 secs</td><td id="allowable-values"></td><td id="description">The cache TTL (time-to-live) or how long to keep stylesheets in the cache after last access.</td></tr></table><h3>Dynamic Properties: </h3><p>Supports Sensitive Dynamic Properties: <strong>No</strong></p><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">An XSLT transform parameter name</td><td id="value">An XSLT transform parameter value</td><td>These XSLT parameters are passed to the transformer<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>The FlowFile with transformed content will be routed to this relationship</td></tr><tr><td>failure</td><td>If a FlowFile fails processing for any reason (for example, the FlowFile is not valid XML), it will be routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |