http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorMemory/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorMemory/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorMemory/index.html deleted file mode 100644 index 08ec0bf..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorMemory/index.html +++ /dev/null @@ -1,77 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> - <head> - <meta charset="utf-8" /> - <title>MonitorMemory</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <h2>Description:</h2> - - <p>Reporting Task that checks how much Java Heap Space is - available after Full Garbage Collections. When the heap exceeds a - specified threshold immediatley following a Full Garbage Collection, - this Reporting Task will create a WARNING level log message and create - a System-Level bulletin to notify the user.</p> - - <p> - <strong>Properties:</strong> - </p> - - <ul> - <li><strong>Memory Pool</strong> - <ul> - <li>The name of the JVM Memory Pool. The allowed values depend - on the JVM and operating system. The following values are typically supported: - <ul> - <li>PS Old Gen</li> - <li>PS Survivor Space</li> - <li>PS Eden Space</li> - <li>PS Perm Gen</li> - </ul> - </li> - <li>Required: true</li> - <li>Default value: (none)</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Usage Threshold</strong> - <ul> - <li> - The threshold for memory usage that will cause a notification to occur. The format can either be a percentage (e.g., 80%) or a Data Size (e.g., 1 GB) - </li> - <li>Required: true</li> - <li>Default value: 65%</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Reporting Interval</strong> - <ul> - <li> - Indicates how often this reporting task should report bulletins while the memory utilization exceeds the configured threshold. - If set, must be a valid time period (e.g., "5 mins") - </li> - <li>Required: false</li> - <li>Default value: (none)</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - - </body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/additionalDetails.html new file mode 100644 index 0000000..9818592 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/additionalDetails.html @@ -0,0 +1,41 @@ +<!DOCTYPE html> +<html lang="en"> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + <head> + <meta charset="utf-8" /> + <title>StandardGangliaReporter</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <h2>Description:</h2> + + <p>Reporting Task that reports metrics to a Ganglia server. The following metrics are reported: + </p> + + <ul> + <li><strong>FlowFiles In (5 mins)</strong>: The number of FlowFiles received via Site-to-Site in the last 5 minutes</li> + <li><strong>Bytes In (5 mins)</strong>: The number of bytes received via Site-to-Site in the last 5 minutes</li> + <li><strong>FlowFiles Out (5 mins)</strong>: The number of FlowFiles pulled from Output Ports via Site-to-Site in the last 5 minutes</li> + <li><strong>Bytes Out (5 mins)</strong>: The number of bytes pulled from Output Ports via Site-to-Site in the last 5 minutes</li> + <li><strong>Bytes Read (5 mins)</strong>: The number of bytes read from disk by NiFi in the last 5 minutes</li> + <li><strong>Bytes Written (5 mins)</strong>: The number of bytes written to disk by NiFi in the last 5 minutes</li> + <li><strong>FlowFiles Queued</strong>: The total number of FlowFiles currently queued on the system at the point in time at which the Reporting Task is run</li> + <li><strong>Bytes Queued</strong>: The total number of bytes allocated by the FlowFiles that are currently queued on the system at the point in time at which the Reporting Task is run</li> + <li><strong>Active Threads</strong>: The number of threads actively running at the point in time at which the Reporting Task is run</li> + </ul> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/index.html deleted file mode 100644 index 48df9a6..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/index.html +++ /dev/null @@ -1,65 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> - <head> - <meta charset="utf-8" /> - <title>StandardGangliaReporter</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <h2>Description:</h2> - - <p>Reporting Task that reports metrics to a Ganglia server. The following metrics are reported: - </p> - - <ul> - <li><strong>FlowFiles In (5 mins)</strong>: The number of FlowFiles received via Site-to-Site in the last 5 minutes</li> - <li><strong>Bytes In (5 mins)</strong>: The number of bytes received via Site-to-Site in the last 5 minutes</li> - <li><strong>FlowFiles Out (5 mins)</strong>: The number of FlowFiles pulled from Output Ports via Site-to-Site in the last 5 minutes</li> - <li><strong>Bytes Out (5 mins)</strong>: The number of bytes pulled from Output Ports via Site-to-Site in the last 5 minutes</li> - <li><strong>Bytes Read (5 mins)</strong>: The number of bytes read from disk by NiFi in the last 5 minutes</li> - <li><strong>Bytes Written (5 mins)</strong>: The number of bytes written to disk by NiFi in the last 5 minutes</li> - <li><strong>FlowFiles Queued</strong>: The total number of FlowFiles currently queued on the system at the point in time at which the Reporting Task is run</li> - <li><strong>Bytes Queued</strong>: The total number of bytes allocated by the FlowFiles that are currently queued on the system at the point in time at which the Reporting Task is run</li> - <li><strong>Active Threads</strong>: The number of threads actively running at the point in time at which the Reporting Task is run</li> - </ul> - - <p> - <strong>Properties:</strong> - </p> - - <ul> - <li><strong>Hostname</strong> - <ul> - <li>The fully-qualified name of the host on which Ganglia is running</li> - <li>Required: true</li> - <li>Default value: localhost</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Port</strong> - <ul> - <li>The Port on which Ganglia is listening for incoming connections</li> - <li>Required: true</li> - <li>Default value: 8649</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/additionalDetails.html new file mode 100644 index 0000000..a3bc60f --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/additionalDetails.html @@ -0,0 +1,52 @@ +<!DOCTYPE html> +<html lang="en"> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<head> +<meta charset="utf-8" /> +<title>Distributed Map Cache Client Service</title> +<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> +</head> + +<body> + <p> + Below is an example of how to create a client connection to your distributed map cache server. + Note that the identifier in this example is <code>cache-client</code>. If you are using this template + to create your own MapCacheClient service, replace the values in this template with values that are + suitable for your system. Possible options for <code>Server Hostname</code>, <code>Server Port</code>, + <code>Communications Timeout</code>, and <span style="font-style: italic;">SSL Context Service</span>. + </p> + + <pre> +<?xml version="1.0" encoding="UTF-8" ?> +<services> + <service> + <identifier>cache-client</identifier> + <class>org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService</class> + <property name="Server Hostname">localhost</property> + <property name="Server Port">4557</property> + <property name="Communications Timeout">30 secs</property> + </service> +</services> + </pre> + + <i>See Also:</i> + <ul> + <li><a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">Distributed Map Cache Server</a></li> + <li><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">Standard SSL Context Service</a></li> + </ul> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html deleted file mode 100644 index 3e5197a..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html +++ /dev/null @@ -1,98 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<head> -<meta charset="utf-8" /> -<title>Distributed Map Cache Client Service</title> -<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> -</head> - -<body> - <h2>Description:</h2> - - <p>A Controller Service that can be used to communicate with a - Distributed Map Cache Server.</p> - - - - <p> - <strong>Properties:</strong> - </p> - <p>In the list below, the names of required properties appear - in bold. Any other properties (not in bold) are considered optional. - If a property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated.</p> - - <ul> - <li><strong>Server Hostname</strong> - <ul> - <li>The name of the server that is running the DistributedMapCacheServer service</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Server Port</strong> - <ul> - <li>The port on the remote server that is to be used when communicating with the - <a href="../nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">DistributedMapCacheServer</a> service</li> - - <li>Default value: 4557</li> - <li>Supports expression language: false</li> - </ul></li> - <li>SSL Context Service - <ul> - <li>If specified, indicates the SSL Context Service that is used to communicate with the remote server. If not specified, communications will not be encrypted - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Communications Timeout</strong> - <ul> - <li>Specifices how long to wait when communicating with the remote server before determining that there is a communications failure if data cannot be sent or received - <li>Default value: 30 secs</li> - <li>Supports expression language: false</li> - </ul></li> - - </ul> - - <p> - Below is an example of how to create a client connection to your distributed map cache server. - Note that the identifier in this example is <code>cache-client</code>. If you are using this template - to create your own MapCacheClient service, replace the values in this template with values that are - suitable for your system. Possible options for <code>Server Hostname</code>, <code>Server Port</code>, - <code>Communications Timeout</code>, and <span style="font-style: italic;">SSL Context Service</span>. - </p> - - <pre> -<?xml version="1.0" encoding="UTF-8" ?> -<services> - <service> - <identifier>cache-client</identifier> - <class>org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService</class> - <property name="Server Hostname">localhost</property> - <property name="Server Port">4557</property> - <property name="Communications Timeout">30 secs</property> - </service> -</services> - </pre> - - <i>See Also:</i> - <ul> - <li><a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">Distributed Map Cache Server</a></li> - <li><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">Standard SSL Context Service</a></li> - </ul> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/additionalDetails.html new file mode 100644 index 0000000..fa1bf42 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/additionalDetails.html @@ -0,0 +1,31 @@ +<!DOCTYPE html> +<html lang="en"> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + <head> + <meta charset="utf-8" /> + <title>Distributed Map Cache Client Service</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <i>See Also:</i> + <ul> + <li><a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">Distributed Map Cache Server</a></li> + <li><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">Standard SSL Context Service</a></li> + </ul> + + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html deleted file mode 100755 index ed1801c..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html +++ /dev/null @@ -1,51 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> - <head> - <meta charset="utf-8" /> - <title>Distributed Map Cache Client Service</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <h2>Description:</h2> - - <p>A Controller Service that can be used to communicate with a - Distributed Set Cache Server.</p> - - - - <p> - <strong>Properties:</strong> - </p> - <p>In the list below, the names of required properties appear - in bold. Any other properties (not in bold) are considered optional. - If a property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated.</p> - - <ul> - </ul> - - - <i>See Also:</i> - <ul> - <li><a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">Distributed Map Cache Server</a></li> - <li><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">Standard SSL Context Service</a></li> - </ul> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-server/src/main/resources/docs/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-server/src/main/resources/docs/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-server/src/main/resources/docs/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/additionalDetails.html new file mode 100644 index 0000000..2171be2 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-server/src/main/resources/docs/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/additionalDetails.html @@ -0,0 +1,53 @@ +<!DOCTYPE html> +<html lang="en"> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<head> +<meta charset="utf-8" /> +<title>Distributed Map Cache Client Service</title> +<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> +</head> + +<body> + <p> + Below is an example of how to create a distributed map cache server for clients to connect to. + Note that the identifier in this example is <code>cache-server</code>. If you are using this template + to create your own DistributedMapCache server, replace the values in this template with values that are + suitable for your system. Possible options for <code>Port</code>, <code>Maximum Cache Entries</code>, + <code>Eviction Strategy</code>, <span style="font-style: italic;">SSL Context Service</span>, and + <span style="font-style: italic;">Persistence Directory</span> + </p> + + <pre> +<?xml version="1.0" encoding="UTF-8" ?> +<services> + <service> + <identifier>cache-server</identifier> + <class>org.apache.nifi.distributed.cache.client.DistributedMapCacheServer</class> + <property name="Port">4557</property> + <property name="Maximum Cache Entries">10000</property> + <property name="Eviction Strategy">Least Recently Used</property> + </service> +</services> + </pre> + + <i>See Also:</i> + <ul> + <li><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">Distributed Map Cache Client Service</a></li> + <li><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">Standard SSL Context Service</a></li> + </ul> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-server/src/main/resources/docs/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-server/src/main/resources/docs/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-server/src/main/resources/docs/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html deleted file mode 100644 index 918cb22..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-server/src/main/resources/docs/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html +++ /dev/null @@ -1,103 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<head> -<meta charset="utf-8" /> -<title>Distributed Map Cache Client Service</title> -<link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> -</head> - -<body> - <h2>Description:</h2> - - <p>A Controller Service that starts an embedded server and listens for connections from clients. The - server provides the ability to query the cache, add data to the cache, and remove data from the cache.</p> - - - - <p> - <strong>Properties:</strong> - </p> - <p>In the list below, the names of required properties appear - in bold. Any other properties (not in bold) are considered optional. - If a property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated.</p> - - <ul> - <li><strong>Port</strong> - <ul> - <li>The port to listen on for incoming connections</li> - <li>Default value: 4557</li> - <li>Supports expression language: false</li> - </ul></li> - <li>SSL Context Service - <ul> - <li>If specified, this service will be used to create an SSL Context that will be used to secure communications; if not specified, communications will not be secure</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Maximum Cache Entries</strong> - <ul> - <li>The maximum number of cache entries that the cache can hold - <li>Default value: 10,000</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Eviction Strategy</strong> - <ul> - <li>Determines which strategy should be used to evict values from the cache to make room for new entries. Valid values: - <code>Least Frequently Used</code>, <code>Least Recently Used</code>, and <code>First In, First Out</code> - <li>Default value: Least Frequently Used</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Persistence Directory - <ul> - <li>If specified, the cache will be persisted in the given directory; if not specified, the cache will be in-memory only</li> - <li>Default value: no default (in-memory)</li> - <li>Supports expression language: true - JVM and System Properties Only</li> - </ul></li> - </ul> - - <p> - Below is an example of how to create a distributed map cache server for clients to connect to. - Note that the identifier in this example is <code>cache-server</code>. If you are using this template - to create your own DistributedMapCache server, replace the values in this template with values that are - suitable for your system. Possible options for <code>Port</code>, <code>Maximum Cache Entries</code>, - <code>Eviction Strategy</code>, <span style="font-style: italic;">SSL Context Service</span>, and - <span style="font-style: italic;">Persistence Directory</span> - </p> - - <pre> -<?xml version="1.0" encoding="UTF-8" ?> -<services> - <service> - <identifier>cache-server</identifier> - <class>org.apache.nifi.distributed.cache.client.DistributedMapCacheServer</class> - <property name="Port">4557</property> - <property name="Maximum Cache Entries">10000</property> - <property name="Eviction Strategy">Least Recently Used</property> - </service> -</services> - </pre> - - <i>See Also:</i> - <ul> - <li><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">Distributed Map Cache Client Service</a></li> - <li><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">Standard SSL Context Service</a></li> - </ul> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-services/nifi-ssl-context-bundle/nifi-ssl-context-service/src/main/resources/docs/org.apache.nifi.ssl.StandardSSLContextService/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-ssl-context-bundle/nifi-ssl-context-service/src/main/resources/docs/org.apache.nifi.ssl.StandardSSLContextService/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-ssl-context-bundle/nifi-ssl-context-service/src/main/resources/docs/org.apache.nifi.ssl.StandardSSLContextService/additionalDetails.html new file mode 100644 index 0000000..525337d --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-ssl-context-bundle/nifi-ssl-context-service/src/main/resources/docs/org.apache.nifi.ssl.StandardSSLContextService/additionalDetails.html @@ -0,0 +1,49 @@ +<!DOCTYPE html> +<html lang="en"> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + <head> + <meta charset="utf-8" /> + <title>StandardSSLContextService</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <p> + Below is an example of the template for a SSLContext controller service. Note that the identifier + in this example is <code>ssl-context</code>. If using this template to create your own SSLContext controller + service, replace the property values with values that are suitable for your system. Possible options for + <code>Keystore Type</code> and <code>Truststore Type</code> are <span style="font-style: italic;">JKS</span> + or <span style="font-style: italic;">PKCS12</span>. + </p> + + <pre> +<?xml version="1.0" encoding="UTF-8" ?> +<services> + <service> + <identifier>ssl-context</identifier> + <class>org.apache.nifi.ssl.StandardSSLContextService</class> + <property name="Keystore Filename">C:/testpki/localtest-ks.jks</property> + <property name="Keystore Password">localtest</property> + <property name="Keystore Type">JKS</property> + <property name="Truststore Filename">C:/testpki/localtest-ts.jks</property> + <property name="Truststore Password">localtest</property> + <property name="Truststore Type">JKS</property> + </service> +</services> + </pre> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-services/nifi-ssl-context-bundle/nifi-ssl-context-service/src/main/resources/docs/org.apache.nifi.ssl.StandardSSLContextService/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-ssl-context-bundle/nifi-ssl-context-service/src/main/resources/docs/org.apache.nifi.ssl.StandardSSLContextService/index.html b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-ssl-context-bundle/nifi-ssl-context-service/src/main/resources/docs/org.apache.nifi.ssl.StandardSSLContextService/index.html deleted file mode 100644 index f1eb237..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-ssl-context-bundle/nifi-ssl-context-service/src/main/resources/docs/org.apache.nifi.ssl.StandardSSLContextService/index.html +++ /dev/null @@ -1,63 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> - <head> - <meta charset="utf-8" /> - <title>StandardSSLContextService</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - - <!-- Service Documentation ================================================== --> - <h2>Configuring the SSLContext Controller Service:</h2> - <p> - The SSLContext controller service is a mechanism for providing all the security properties that - allow for secure communications between NiFi extensions and other systems. NiFi extensions include - processors, reporting tasks, and other controller services. - </p> - - <p> - The <code>controller-services.xml</code> file is located in the NiFi <code>conf</code> - directory. The user may set up any number of controller services within this file. - </p> - - <p> - Below is an example of the template for a SSLContext controller service. Note that the identifier - in this example is <code>ssl-context</code>. If using this template to create your own SSLContext controller - service, replace the property values with values that are suitable for your system. Possible options for - <code>Keystore Type</code> and <code>Truststore Type</code> are <span style="font-style: italic;">JKS</span> - or <span style="font-style: italic;">PKCS12</span>. - </p> - - <pre> -<?xml version="1.0" encoding="UTF-8" ?> -<services> - <service> - <identifier>ssl-context</identifier> - <class>org.apache.nifi.ssl.StandardSSLContextService</class> - <property name="Keystore Filename">C:/testpki/localtest-ks.jks</property> - <property name="Keystore Password">localtest</property> - <property name="Keystore Type">JKS</property> - <property name="Truststore Filename">C:/testpki/localtest-ts.jks</property> - <property name="Truststore Password">localtest</property> - <property name="Truststore Type">JKS</property> - </service> -</services> - </pre> - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-update-attribute-bundle/nifi-update-attribute-processor/src/main/resources/docs/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-update-attribute-bundle/nifi-update-attribute-processor/src/main/resources/docs/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-update-attribute-bundle/nifi-update-attribute-processor/src/main/resources/docs/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html new file mode 100644 index 0000000..30cfce9 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-update-attribute-bundle/nifi-update-attribute-processor/src/main/resources/docs/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html @@ -0,0 +1,253 @@ +<!DOCTYPE html> +<html lang="en"> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + <head> + <meta charset="utf-8" /> + <title>UpdateAttribute</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <h2>Description:</h2> + <p> + This processor updates the attributes of a FlowFile using properties or rules that are added by the user. + There are two ways to use this processor to add or modify attributes. One way is the "Basic Usage"; this allows you to set default attribute changes that affect + every FlowFile going through the processor. The second way is the "Advanced Usage"; this allows you to make conditional attribute changes that only affect a FlowFile if it + meets certain conditions. It is possible to use both methods in the same processor at the same time. + </p> + + <p> + <strong>Basic Usage</strong> + </p> + + <p> + For basic usage, changes are made by adding a new processor property and referencing as its name the attribute you want to change. Then enter the desired attribute + value as the Value. The Value can be as simple as any text string or it can be a NiFi Expression Language statement that specifies how to formulate the value. + (See the NiFi Expression Language Usage Guide for details on crafting NiFi Expression Language statements.) + </p> + + <p> + As an example, to alter the standard "filename" attribute so that it has ".txt" appended to the end of it, add a new property and make the property + name "filename" (to reference the desired attribute), and as the value, use the NiFi Expression Language statement shown below: + </p> + + <ul> + <li><strong>Property</strong>: filename + </li> + <li><strong>Value</strong>: ${filename}.txt + </li> + </ul> + + <p> + The preceding example illustrates how to modify an existing attribute. If an attribute does not already exist, this processor can also be used to add a new attribute. + For example, the following property could be added to create a new attribute called myAttribute that has the value myValue: + </p> + + <ul> + <li><strong>Property</strong>: myAttribute + </li> + <li><strong>Value</strong>: myValue + </li> + </ul> + + <p> + In this example, all FlowFiles passing through this processor will receive an additional FlowFile attribute called myAttribute with the value myValue. + This type of configuration might be used in a flow where you want to tag every FlowFile with an attribute so that it can be used later in the flow, + such as for routing in a RouteOnAttribute processor. + </p> + + <p><strong>Advanced Usage</strong> + </p> + + <p> + The preceding examples illustrate how to make changes to every FlowFile that goes through the processor. However, the UpdateAttribute processor + may also be used to make conditional changes. + </p> + + <p> + To change attributes based on some condition, use the Advanced User Interface (UI) in the processor by clicking the <strong>Advanced</strong> button in the lower right corner. + </p> + + <p> + Clicking the Advanced button displays the Advanced UI. In the Advanced UI, Conditions and their associated Actions are entered as "Rules". + Each rule basically says, "If these conditions are met, then do this action." One or more conditions may be used in a given rule, + and they all must be met in order for the designated action(s) to be taken. + </p> + + <p><strong>Adding Rules</strong> + </p> + + <p> + To add rules and their associated conditions and actions, click on the buttons with the plus symbol located to the right of the "Rules", "Conditions", and "Actions" labels. + </p> + + <p> + Upon adding a rule with its condition(s) and action(s), it is important to save it by clicking the <strong>Save</strong> button in the lower right corner. + If you do not do so and attempt to add or navigate to another rule, an error message will appear, asking you if you want to save your changes. + </p> + + <p><strong>Example Rules</strong> + </p> + + <p> + This example has two rules: CheckForLargeFiles and CheckForGiantFiles. The CheckForLargeFiles rule has these conditions: + </p> + + <ul> + <li>${filename:equals('fileOfInterest')} + </li> + <li>${fileSize:toNumber():ge(1048576)} + </li> + <li>${fileSize:toNumber():lt(1073741824)} + </li> + </ul> + + <p> + Then it has this action for the filename attribute: + </p> + <ul> + <li>${filename}.meg + </li> + </ul> + + <p> + Taken together, this rule says: + </p> + <ul> + <li>If the value of the filename attribute is fileOfInterest, <strong>and</strong> + </li> + <li>If the fileSize is greater than or equal to (ge) one megabyte (1,048,576 bytes), <strong>and</strong> + </li> + <li>If the fileSize is less than (lt) one gigabyte (1,073,741,824 bytes) + </li> + <li>Then change the value of the filename attribute by appending ".meg" to the filename. + </li> + </ul> + + <p><strong>Adding another Rule</strong> + </p> + + <p> + Continuing with this example, we can add another rule to check for files that are larger than one gigabyte. When we add this second rule, we can use the + previous rule as a template, so to speak, by taking advantage of the "Copy from existing rule" option in the New Rule window. Simply start typing the name of + an existing rule, and it will show up in a dropdown menu below the entry field. + </p> + + <p> + In this example, the CheckForGiantFiles rule has these conditions: + </p> + + <ul> + <li>${filename:equals('fileOfInterest')} + </li> + <li>${fileSize:toNumber():gt(1073741824)} + </li> + </ul> + + <p> + Then it has this action for the filename attribute: + </p> + + <ul> + <li>${filename}.gig + </li> + </ul> + + <p> + Taken together, this rule says: + </p> + <ul> + <li>If the value of the filename attribute is fileOfInterest, <strong>and</strong> + </li> + <li>If the fileSize is greater than (gt) one gigabyte (1,073,741,824 bytes) + </li> + <li>Then change the value of the filename attribute by appending ".gig" to the filename. + </li> + </ul> + + <p><strong>Combining the Basic Usage with the Advanced Usage</strong> + </p> + + <p> + The UpdateAttribute processor allows you to make both basic usage changes (i.e., to every FlowFile) and advanced usage changes (i.e., conditional) + at the same time; however, if they both affect the same attribute(s), then the conditional changes take precedence. This has the added benefit of supporting + a type of "else" construct. In other words, if none of the rules match for the attribute, then the basic usage changes will be made. + </p> + + <p><strong>FlowFile Policy</strong> + </p> + + <p> + Another setting in the Advanced UI is the FlowFile Policy. It is located in the upper-left corner of the UI, and it defines the processor's behavior when multiple rules + match. It may be changed using the dropdown menu. By default, the FlowFile Policy is set to "use clone". + </p> + + <p> + If the FlowFile policy is set to "use clone", and multiple rules match, then a copy of the incoming FlowFile is created, such that the number of outgoing FlowFiles + is equal to the number of rules that match. In other words, if two rules (A and B) both match, then there will be two outgoing FlowFiles, one for Rule A and one for Rule B. + This can be useful in situations where you want to add an attribute to use as a flag for routing later. In this example, there will be two copies of the file available, + one to route for the A path, and one to route for the B path. + </p> + + <p> + If the FlowFile policy is set to "use original", then all matching rules are applied to the same incoming FlowFile, and there is only one outgoing FlowFile with all the + attribute changes applied. In this case, the order of the rules matters and the action for each rule that matches will be applied in that order. If multiple rules contain + actions that update the same attribute, the action from the last matching rule will take precedence. Notably, you can drag and drop the rules into a certain order within + the Rules list. + </p> + + <p><strong>Filtering Rules</strong> + </p> + + <p> + The Advanced UI supports the creation of an arbitrarily large number of rules. In order to manage large rule sets, the listing of rules may be filtered using the + Filter mechanism in the lower left corner. Rules may be filtered by any text in the name, condition, or action. + </p> + + <p><strong>Closing the Advanced UI</strong> + </p> + + <p> + Once all changes have been saved in the Advanced UI, the UI can be closed using the X in the top right corner. + </p> + + <p> + <strong>Properties:</strong> + </p> + <p> + The properties in this processor are added by the user. The expression language is supported in user-added + properties for this processor. See the NiFi Expression Language Guide to learn how to formulate proper expression language statements to perform the desired functions. + </p> + + <p> + If an Attribute is added with the name <strong>alternate.identifier</strong> and that attribute's value is a URI, an ADD_INFO Provenance Event will be registered, + correlating the FlowFile with the given alternate identifier. + </p> + + <p> + <strong>Relationships:</strong> + </p> + <ul> + <li>success + <ul> + <li>If the processor successfully updates the specified attribute(s), then the FlowFile follows this relationship.</li> + </ul></li> + </ul> + + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-update-attribute-bundle/nifi-update-attribute-processor/src/main/resources/docs/org.apache.nifi.processors.attributes.UpdateAttribute/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-update-attribute-bundle/nifi-update-attribute-processor/src/main/resources/docs/org.apache.nifi.processors.attributes.UpdateAttribute/index.html b/nifi/nifi-nar-bundles/nifi-update-attribute-bundle/nifi-update-attribute-processor/src/main/resources/docs/org.apache.nifi.processors.attributes.UpdateAttribute/index.html deleted file mode 100644 index 30cfce9..0000000 --- a/nifi/nifi-nar-bundles/nifi-update-attribute-bundle/nifi-update-attribute-processor/src/main/resources/docs/org.apache.nifi.processors.attributes.UpdateAttribute/index.html +++ /dev/null @@ -1,253 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> - <head> - <meta charset="utf-8" /> - <title>UpdateAttribute</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor updates the attributes of a FlowFile using properties or rules that are added by the user. - There are two ways to use this processor to add or modify attributes. One way is the "Basic Usage"; this allows you to set default attribute changes that affect - every FlowFile going through the processor. The second way is the "Advanced Usage"; this allows you to make conditional attribute changes that only affect a FlowFile if it - meets certain conditions. It is possible to use both methods in the same processor at the same time. - </p> - - <p> - <strong>Basic Usage</strong> - </p> - - <p> - For basic usage, changes are made by adding a new processor property and referencing as its name the attribute you want to change. Then enter the desired attribute - value as the Value. The Value can be as simple as any text string or it can be a NiFi Expression Language statement that specifies how to formulate the value. - (See the NiFi Expression Language Usage Guide for details on crafting NiFi Expression Language statements.) - </p> - - <p> - As an example, to alter the standard "filename" attribute so that it has ".txt" appended to the end of it, add a new property and make the property - name "filename" (to reference the desired attribute), and as the value, use the NiFi Expression Language statement shown below: - </p> - - <ul> - <li><strong>Property</strong>: filename - </li> - <li><strong>Value</strong>: ${filename}.txt - </li> - </ul> - - <p> - The preceding example illustrates how to modify an existing attribute. If an attribute does not already exist, this processor can also be used to add a new attribute. - For example, the following property could be added to create a new attribute called myAttribute that has the value myValue: - </p> - - <ul> - <li><strong>Property</strong>: myAttribute - </li> - <li><strong>Value</strong>: myValue - </li> - </ul> - - <p> - In this example, all FlowFiles passing through this processor will receive an additional FlowFile attribute called myAttribute with the value myValue. - This type of configuration might be used in a flow where you want to tag every FlowFile with an attribute so that it can be used later in the flow, - such as for routing in a RouteOnAttribute processor. - </p> - - <p><strong>Advanced Usage</strong> - </p> - - <p> - The preceding examples illustrate how to make changes to every FlowFile that goes through the processor. However, the UpdateAttribute processor - may also be used to make conditional changes. - </p> - - <p> - To change attributes based on some condition, use the Advanced User Interface (UI) in the processor by clicking the <strong>Advanced</strong> button in the lower right corner. - </p> - - <p> - Clicking the Advanced button displays the Advanced UI. In the Advanced UI, Conditions and their associated Actions are entered as "Rules". - Each rule basically says, "If these conditions are met, then do this action." One or more conditions may be used in a given rule, - and they all must be met in order for the designated action(s) to be taken. - </p> - - <p><strong>Adding Rules</strong> - </p> - - <p> - To add rules and their associated conditions and actions, click on the buttons with the plus symbol located to the right of the "Rules", "Conditions", and "Actions" labels. - </p> - - <p> - Upon adding a rule with its condition(s) and action(s), it is important to save it by clicking the <strong>Save</strong> button in the lower right corner. - If you do not do so and attempt to add or navigate to another rule, an error message will appear, asking you if you want to save your changes. - </p> - - <p><strong>Example Rules</strong> - </p> - - <p> - This example has two rules: CheckForLargeFiles and CheckForGiantFiles. The CheckForLargeFiles rule has these conditions: - </p> - - <ul> - <li>${filename:equals('fileOfInterest')} - </li> - <li>${fileSize:toNumber():ge(1048576)} - </li> - <li>${fileSize:toNumber():lt(1073741824)} - </li> - </ul> - - <p> - Then it has this action for the filename attribute: - </p> - <ul> - <li>${filename}.meg - </li> - </ul> - - <p> - Taken together, this rule says: - </p> - <ul> - <li>If the value of the filename attribute is fileOfInterest, <strong>and</strong> - </li> - <li>If the fileSize is greater than or equal to (ge) one megabyte (1,048,576 bytes), <strong>and</strong> - </li> - <li>If the fileSize is less than (lt) one gigabyte (1,073,741,824 bytes) - </li> - <li>Then change the value of the filename attribute by appending ".meg" to the filename. - </li> - </ul> - - <p><strong>Adding another Rule</strong> - </p> - - <p> - Continuing with this example, we can add another rule to check for files that are larger than one gigabyte. When we add this second rule, we can use the - previous rule as a template, so to speak, by taking advantage of the "Copy from existing rule" option in the New Rule window. Simply start typing the name of - an existing rule, and it will show up in a dropdown menu below the entry field. - </p> - - <p> - In this example, the CheckForGiantFiles rule has these conditions: - </p> - - <ul> - <li>${filename:equals('fileOfInterest')} - </li> - <li>${fileSize:toNumber():gt(1073741824)} - </li> - </ul> - - <p> - Then it has this action for the filename attribute: - </p> - - <ul> - <li>${filename}.gig - </li> - </ul> - - <p> - Taken together, this rule says: - </p> - <ul> - <li>If the value of the filename attribute is fileOfInterest, <strong>and</strong> - </li> - <li>If the fileSize is greater than (gt) one gigabyte (1,073,741,824 bytes) - </li> - <li>Then change the value of the filename attribute by appending ".gig" to the filename. - </li> - </ul> - - <p><strong>Combining the Basic Usage with the Advanced Usage</strong> - </p> - - <p> - The UpdateAttribute processor allows you to make both basic usage changes (i.e., to every FlowFile) and advanced usage changes (i.e., conditional) - at the same time; however, if they both affect the same attribute(s), then the conditional changes take precedence. This has the added benefit of supporting - a type of "else" construct. In other words, if none of the rules match for the attribute, then the basic usage changes will be made. - </p> - - <p><strong>FlowFile Policy</strong> - </p> - - <p> - Another setting in the Advanced UI is the FlowFile Policy. It is located in the upper-left corner of the UI, and it defines the processor's behavior when multiple rules - match. It may be changed using the dropdown menu. By default, the FlowFile Policy is set to "use clone". - </p> - - <p> - If the FlowFile policy is set to "use clone", and multiple rules match, then a copy of the incoming FlowFile is created, such that the number of outgoing FlowFiles - is equal to the number of rules that match. In other words, if two rules (A and B) both match, then there will be two outgoing FlowFiles, one for Rule A and one for Rule B. - This can be useful in situations where you want to add an attribute to use as a flag for routing later. In this example, there will be two copies of the file available, - one to route for the A path, and one to route for the B path. - </p> - - <p> - If the FlowFile policy is set to "use original", then all matching rules are applied to the same incoming FlowFile, and there is only one outgoing FlowFile with all the - attribute changes applied. In this case, the order of the rules matters and the action for each rule that matches will be applied in that order. If multiple rules contain - actions that update the same attribute, the action from the last matching rule will take precedence. Notably, you can drag and drop the rules into a certain order within - the Rules list. - </p> - - <p><strong>Filtering Rules</strong> - </p> - - <p> - The Advanced UI supports the creation of an arbitrarily large number of rules. In order to manage large rule sets, the listing of rules may be filtered using the - Filter mechanism in the lower left corner. Rules may be filtered by any text in the name, condition, or action. - </p> - - <p><strong>Closing the Advanced UI</strong> - </p> - - <p> - Once all changes have been saved in the Advanced UI, the UI can be closed using the X in the top right corner. - </p> - - <p> - <strong>Properties:</strong> - </p> - <p> - The properties in this processor are added by the user. The expression language is supported in user-added - properties for this processor. See the NiFi Expression Language Guide to learn how to formulate proper expression language statements to perform the desired functions. - </p> - - <p> - If an Attribute is added with the name <strong>alternate.identifier</strong> and that attribute's value is a URI, an ADD_INFO Provenance Event will be registered, - correlating the FlowFile with the given alternate identifier. - </p> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>If the processor successfully updates the specified attribute(s), then the FlowFile follows this relationship.</li> - </ul></li> - </ul> - - </body> -</html>
