Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PostSlack/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PostSlack/additionalDetails.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PostSlack/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PostSlack/additionalDetails.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1,107 @@ +<!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>PostSlack</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + <style> + dt {font-style: italic;} + </style> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <h2>Description:</h2> + <p> + The PostSlack processor sends messages on Slack, a team-oriented messaging service. + The message can be a simple text message, furthermore Slack attachments can also be specified + or the FlowFile content (e.g. an image) can be uploaded and attached to the message too. + </p> + <h3>Slack App setup</h3> + <p> + This processor uses Slack Web API methods to post messages to a specific channel. + Before using PostSlack, you need to create a Slack App, to add a Bot User to the app, + and to install the app in your Slack workspace. After the app installed, you can get + the Bot User's OAuth Access Token that will be needed to authenticate and authorize + your PostSlack processor to Slack. + </p> + <h3>Message types</h3> + <p> + You can send the following types of messages with PostSlack: + </p> + <dl> + <dt>Text-only message</dt> + <dd> + A simple text message. In this case you must specify the <Text> property, + while <Upload FlowFile> is 'No' and no attachments defined through dynamic properties. + File related properties will be ignored in this case. + </dd> + <dt>Text message with attachment</dt> + <dd> + Besides the <Text> property, one or more attachments are also defined through dynamic properties + (for more details see the <a href="additionalDetails.html#slack-attachments">Slack attachments</a> section below). + The <Upload FlowFile> property needs to be set to 'No'. File related properties will be ignored. + </dd> + <dt>Attachment-only message</dt> + <dd> + The same as the previous one, but the <Text> property is not specified + (so no text section will be displayed at the beginning of the message, only the attachment(s)). + </dd> + <dt>Text message with file upload</dt> + <dd> + You need to specify the <Text> property and set <Upload FlowFile> to 'Yes'. + The content of the FlowFile will be uploaded with the message and it will be displayed + below the text. You should specify <File Name> and <File Mime Type> properties too + (otherwise some fallback values will be set), and optionally <File Title>. + The dynamic properties will be ignored in this case. + </dd> + <dt>File upload message without text</dt> + <dd> + The same as the previous one, but the <Text> property is not specified + (so no text section will be displayed at the beginning of the message, only the uploaded file). + </dd> + </dl> + <h3 id="slack-attachments">Slack attachments</h3> + <p> + Slack content and link attachments can be added to the message through dynamic properties. + Please note that this kind of Slack message attachments does not involve the file + upload itself, but rather contain links to external resources (or internal resources already uploaded + to Slack). Please also note that this functionality does not work together with file upload + (so it can only be used when 'Upload FlowFile' has been set to 'No'). + </p> + <p> + The Dynamic Properties can be used to specify these Slack message attachments as JSON snippets. + Each property value will be converted to JSON and will be added to the array of attachments in the JSON + payload being sent to Slack. + </p> + <p> + Example JSON snippets to define Slack attachments: + </p> + <pre> + { + "text": "Text that appears within the attachment", + "image_url": "http://some-website.com/path/to/image.jpg"; + } + </pre> + <pre> + { + "title": "Title of the attachment", + "image_url": "http://some-website.com/path/to/image.jpg"; + } + </pre> + </body> +</html>
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PostSlack/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PostSlack/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PostSlack/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PostSlack/index.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PostSlack</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;">PostSlack</h1><h2>Description: </h2><p>Sends a message on Slack. The FlowFile content (e.g. an image) can be uploaded and attached to the message.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>slack, post, notify, upload, message</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, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a> , and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Post Message URL</strong></td><td id="default-value">https://slack.com/api/chat.postMessage</td><td id="allowable-values"></td><td id="description">Slack Web API URL for posting text messages to channels. It only needs to be changed if Slack changes its API URL.</td></tr><tr><td id="name"><strong>File Upload URL</strong></td><td id="default-value">https://slack.com/api/files.upload</td><td id="allowable-values"></td><td id="description">Slack Web API URL for uploading files to channels. It only needs to be changed if Slack changes its API URL.</td></tr><tr><td id="name"><strong>A ccess Token</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">OAuth Access Token used for authenticating/authorizing the Slack request sent by NiFi.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Channel</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Slack channel, private group, or IM channel to send the message to.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Text</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Text of the Slack message to send. Only required if no attachment has been specified and 'Upload File' has been set to 'No'.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Upload FlowFile</strong></td> <td id="default-value">false</td><td id="allowable-values"><ul><li>Yes <img src="../../../../../html/images/iconInfo.png" alt="Upload and attach FlowFile content to the Slack message." title="Upload and attach FlowFile content to the Slack message."></img></li><li>No <img src="../../../../../html/images/iconInfo.png" alt="Don't upload and attach FlowFile content to the Slack message." title="Don't upload and attach FlowFile content to the Slack message."></img></li></ul></td><td id="description">Whether or not to upload and attach the FlowFile content to the Slack message.</td></tr><tr><td id="name">File Title</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Title of the file displayed in the Slack message. The property value will only be used if 'Upload FlowFile' has been set to 'Yes'.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">File Name</t d><td id="default-value">${filename}</td><td id="allowable-values"></td><td id="description">Name of the file to be uploaded. The property value will only be used if 'Upload FlowFile' has been set to 'Yes'. If the property evaluated to null or empty string, then the file name will be set to 'file' in the Slack message.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">File Mime Type</td><td id="default-value">${mime.type}</td><td id="allowable-values"></td><td id="description">Mime type of the file to be uploaded. The property value will only be used if 'Upload FlowFile' has been set to 'Yes'. If the property evaluated to null or empty string, then the mime type will be set to 'application/octet-stream' in the Slack message.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Dynamic Proper ties: </h3><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"><Arbitrary name></td><td id="value">JSON snippet specifying a Slack message "attachment"</td><td>The property value will be converted to JSON and will be added to the array of attachments in the JSON payload being sent to Slack. The property name will not be used by the processor.<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>FlowFiles are routed to success after being successfully sent to Slack</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure if unable to be sent to Slack</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attribute s: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>slack.file.url</td><td>The Slack URL of the uploaded file. It will be added if 'Upload FlowFile' has been set to 'Yes'.</td></tr></table><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> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PutSlack/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PutSlack/additionalDetails.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PutSlack/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PutSlack/additionalDetails.html Tue Feb 25 07:28:36 2020 @@ -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>PutSlack</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <h2>Description:</h2> + <p> + The PutSlack processor sends messages to <a href="https://www.slack.com";>Slack</a>, + a team-oriented messaging service. + </p> + <p> + This processor uses Slack's <a href="https://slack.com/apps/A0F7XDUAZ-incoming-webhooks";>incoming webhooks</a> + custom integration to post messages to a specific channel. Before using PutSlack, your Slack team should be + configured for the incoming webhooks custom integration, and you'll need to configure at least one incoming + webhook. + </p> + <p> + To configure PutSlack, set the following mandatory properties: + <ul> + <li> + <code>Webhook URL</code>: The URL received from Slack that allows the processor to send messages to your team. + </li> + <li> + <code>Webhook Text</code>: The text of the message to send to Slack. + </li> + </ul> + </p> + <p> + Dynamic properties can be used to append items to the "attachments" branch of the JSON payload. Each dynamic property will be processed and added + as an item within the array. The keys are not used by the processor. Instead, for each flowfile, the values of the dynamic properties is converted to JSON and added + to the the attachments key of the JSON payload sent to Slack. For information on the attachment data structure, see <a href="https://api.slack.com/docs/message-attachments";>https://api.slack.com/docs/message-attachments</a> + </p> + </body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PutSlack/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PutSlack/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PutSlack/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.3/org.apache.nifi.processors.slack.PutSlack/index.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSlack</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;">PutSlack</h1><h2>Description: </h2><p>Sends a message to your team on slack.com</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>put, slack, notify</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, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be enc rypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Webhook URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The POST URL provided by Slack to send messages into a channel.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Webhook Text</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The text sent in the webhook message<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Ch annel</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A public channel using #channel or direct message using @username. If not specified, the default webhook channel as specified in Slack's Incoming Webhooks web interface is used.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The displayed Slack username<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Icon URL</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Icon URL to be used for the message<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Icon Emoji</td><td id= "default-value"></td><td id="allowable-values"></td><td id="description">Icon Emoji to be used for the message. Must begin and end with a colon, e.g. :ghost:<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Dynamic Properties: </h3><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">A JSON object to add to Slack's "attachments" JSON payload.</td><td id="value">JSON-formatted string to add to Slack's payload JSON appended to the "attachments" JSON array.</td><td>Converts the contents of each value specified by the Dynamic Property's value to JSON and appends it to the payload being sent to Slack.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table></p><h3>Relation ships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles are routed to success after being successfully sent to Slack</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure if unable to be sent to Slack</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> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1,70 @@ +<!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>GetSNMP</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> + +<body> +<h2>Summary</h2> +<p> + This processor polls a SNMP agent to get information for a given OID (Strategy = GET) or for all the sub-tree associated to a given OID + (Strategy = WALK). This processors supports SNMPv1, SNMPv2c and SNMPv3. The component is based on <a href="http://www.snmp4j.org/";>SNMP4J</a>. +</p> +<p> + When the processor is triggered, it sends the SNMP request and gets the information associated to request OID(s). Once response is received + from the SNMP agent, a FlowFile is constructed. The FlowFile content is empty, all the information is written in the FlowFile attributes. + In case of a single GET request, the properties associated to the received PDU are transferred into the FlowFile as attributes. In case of a + WALK request, only the couples "OID/value" are transferred into the FlowFile as attributes. SNMP attributes names are prefixed with + <i>snmp$</i> prefix. +</p> +<p> + Regarding the attributes representing the couples "OID/value", the attribute name has the following format: + <ul><li>snmp$<i>OID</i>$<i>SMI_Syntax_Value</i></li></ul> + where OID is the request OID, and SMI_Syntax_Value is the integer representing the type of the value associated to the OID. This value is + provided to allow the SetSNMP processor setting values in the correct type. +</p> +<h2>SNMP Properties</h2> +<p> + In case of a single SNMP Get request, the following is the list of available standard SNMP properties which may come with the PDU: + <i>("snmp$errorIndex", "snmp$errorStatus", "snmp$errorStatusText", "snmp$nonRepeaters", "snmp$requestID", "snmp$type")</i> +</p> +<h2>Configuration Details</h2> +<p> + At the time of writing this document it only defines the essential configuration properties which are suitable for most cases. + Other properties will be defined later as this component progresses. + Configuring GetSNMP: +</p> +<ul> + <li><b>Host</b> - [REQUIRED] the name of the host where the SNMP agent is running. (default is localhost)</li> + <li><b>Port</b> - [REQUIRED] the port number on which the SNMP agent is listening. (default is 161)</li> + <li><b>OID</b> - [REQUIRED] the root OID to request.</li> + <li><b>Version</b> - [REQUIRED] the SNMP version to use (SNMPv1 [default], or SNMPv2c, or SNMPv3)</li> + <li><b>Community</b> - [REQUIRED if SNMPv1 or SNMPv2c] the SNMP community to use. (default is public)</li> + <li><b>Security Level</b> - [REQUIRED if SNMPv3] the security level to use. (default is authPriv)</li> + <li><b>Security Name</b> - [REQUIRED if SNMPv3] the security name (user name) to use.</li> + <li><b>Authentication Protocol</b> - [REQUIRED if SNMPv3 and authNoPriv or authPriv] the authentication protocol to use.</li> + <li><b>Authentication Password</b> - [REQUIRED if SNMPv3 and authNoPriv or authPriv] the authentication password to use.</li> + <li><b>Private Protocol</b> - [REQUIRED if SNMPv3 and authPriv] the private protocol to use.</li> + <li><b>Private Password</b> - [REQUIRED if SNMPv3 and authPriv] the private password to use.</li> + <li><b>Retries</b> - [REQUIRED] Sets the number of retries to be performed before a request is timed out. (default is 0)</li> + <li><b>Timeout</b> - [REQUIRED] Sets timeout in milliseconds before a confirmed request is resent or timed out. (default is 5000)</li> +</ul> + +</body> +</html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.GetSNMP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.GetSNMP/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.GetSNMP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.GetSNMP/index.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSNMP</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;">GetSNMP</h1><h2>Description: </h2><p>Retrieves information from SNMP Agent and outputs a FlowFile with information in attributes and without any content</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>snmp, get, oid, walk</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 is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive pr operty, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>OID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The OID to request</td></tr><tr><td id="name">Textual OID</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The textual OID to request</td></tr><tr><td id="name"><strong>SNMP strategy (GET/WALK)</strong></td><td id="default-value">GET</td><td id="allowable-values"><ul><li>GET</li><li>WALK</li></ul></td><td id="description">SNMP strategy to use (SNMP Get or SNMP Walk)</td></tr><tr><td id="name"><strong>Host Name</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">Network address of SNMP Agent (e.g., localhost)</td></tr><tr><td id="name "><strong>Port</strong></td><td id="default-value">161</td><td id="allowable-values"></td><td id="description">Numeric value identifying Port of SNMP Agent (e.g., 161)</td></tr><tr><td id="name"><strong>SNMP Version</strong></td><td id="default-value">SNMPv1</td><td id="allowable-values"><ul><li>SNMPv1</li><li>SNMPv2c</li><li>SNMPv3</li></ul></td><td id="description">SNMP Version to use</td></tr><tr><td id="name">SNMP Community (v1 & v2c)</td><td id="default-value">public</td><td id="allowable-values"></td><td id="description">SNMP Community to use (e.g., public)</td></tr><tr><td id="name"><strong>SNMP Security Level</strong></td><td id="default-value">authPriv</td><td id="allowable-values"><ul><li>noAuthNoPriv</li><li>authNoPriv</li><li>authPriv</li></ul></td><td id="description">SNMP Security Level to use</td></tr><tr><td id="name">SNMP Security name / user name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Security name used for SNMP exch anges</td></tr><tr><td id="name"><strong>SNMP Authentication Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>MD5</li><li>SHA</li><li></li></ul></td><td id="description">SNMP Authentication Protocol to use</td></tr><tr><td id="name">SNMP Authentication pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for SNMP authentication protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>SNMP Private Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>DES</li><li>3DES</li><li>AES128</li><li>AES192</li><li>AES256</li><li></li></ul></td><td id="description">SNMP Private Protocol to use</td></tr><tr><td id="name">SNMP Private protocol pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for SNMP private protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Number of retries</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Set the number of retries when requesting the SNMP Agent</td></tr><tr><td id="name"><strong>Timeout (ms)</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">Set the timeout (in milliseconds) when requesting the SNMP Agent</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are received from the SNMP agent are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot received from the SNMP agent are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>snmp$*</td><td>Attributes retrieved from the SNMP response. It may include: snmp$errorIndex, sn mp$errorStatus, snmp$errorStatusText, snmp$nonRepeaters, snmp$requestID, snmp$type, snmp$variableBindings</td></tr><tr><td>snmp$textualOid</td><td>This attribute will exist if and only if the strategy is GET and will be equal to the value given in Textual Oid property.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1,58 @@ +<!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>SetSNMP</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> + +<body> +<h2>Summary</h2> +<p> + This processor sends SNMP set requests to a SNMP agent in order to update information associated to a given OID. This processor supports + SNMPv1, SNMPv2c and SNMPv3. The component is based on <a href="http://www.snmp4j.org/";>SNMP4J</a>. +</p> +<p> + The processor constructs SNMP Set requests by extracting information from FlowFile attributes. The processor is looking for attributes + prefixed with <i>snmp$</i>. If such an attribute is found, the attribute name is split using the $ character. The second element must + respect the OID format to be considered as a valid OID. If there is a third element, it must represents the SMI Syntax integer value of + the type of data associated to the given OID to allow a correct conversion. If there is no third element, the value is considered as a String + and the value will be sent as an OctetString object. +</p> +<h2>Configuration Details</h2> +<p> + At the time of writing this document it only defines the essential configuration properties which are suitable for most cases. + Other properties will be defined later as this component progresses. + Configuring SetSNMP: +</p> +<ul> + <li><b>Host</b> - [REQUIRED] the name of the host where the SNMP agent is running. (default is localhost)</li> + <li><b>Port</b> - [REQUIRED] the port number on which the SNMP agent is listening. (default is 161)</li> + <li><b>Version</b> - [REQUIRED] the SNMP version to use (SNMPv1 [default], or SNMPv2c, or SNMPv3)</li> + <li><b>Community</b> - [REQUIRED if SNMPv1 or SNMPv2c] the SNMP community to use. (default is public)</li> + <li><b>Security Level</b> - [REQUIRED if SNMPv3] the security level to use. (default is authPriv)</li> + <li><b>Security Name</b> - [REQUIRED if SNMPv3] the security name (user name) to use.</li> + <li><b>Authentication Protocol</b> - [REQUIRED if SNMPv3 and authNoPriv or authPriv] the authentication protocol to use.</li> + <li><b>Authentication Password</b> - [REQUIRED if SNMPv3 and authNoPriv or authPriv] the authentication password to use.</li> + <li><b>Private Protocol</b> - [REQUIRED if SNMPv3 and authPriv] the private protocol to use.</li> + <li><b>Private Password</b> - [REQUIRED if SNMPv3 and authPriv] the private password to use.</li> + <li><b>Retries</b> - [REQUIRED] Sets the number of retries to be performed before a request is timed out. (default is 0)</li> + <li><b>Timeout</b> - [REQUIRED] Sets timeout in milliseconds before a confirmed request is resent or timed out. (default is 5000)</li> +</ul> + +</body> +</html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.SetSNMP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.SetSNMP/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.SetSNMP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.3/org.apache.nifi.snmp.processors.SetSNMP/index.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SetSNMP</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;">SetSNMP</h1><h2>Description: </h2><p>Based on incoming FlowFile attributes, the processor will execute SNMP Set requests. When founding attributes with name like snmp$<OID>, the processor will atempt to set the value of attribute to the corresponding OID given in the attribute name</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>snmp, set, oid</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 is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Host Name</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">Network address of SNMP Agent (e.g., localhost)</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">161</td><td id="allowable-values"></td><td id="description">Numeric value identifying Port of SNMP Agent (e.g., 161)</td></tr><tr><td id="name"><strong>SNMP Version</strong></td><td id="default-value">SNMPv1</td><td id="allowable-values"><ul><li>SNMPv1</li><li>SNMPv2c</li><li>SNMPv3</li></ul></td><td id="description">SNMP Version to use</td></tr><tr><td id="name">SNMP Community (v1 & v2c)</td><td id="default-value">public</td><td id="allowable-values"></td><td id="description">SNMP Community to use (e.g., public)</td></tr><tr><td id="name"><strong>SNMP Security Level</strong></td><td id="default-value">authPriv</td><td id="allowable-values"><ul><li>noAuthNoPriv</li><li>authNoPriv</li><li>authPriv</li></ul></td><td id="description">SNMP Security Level to use</td></tr><tr><td id="name">SNMP Security name / user name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Security name used for SNMP exchanges</td></tr><tr><td id="name"><strong>SNMP Authentication Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>MD5</li><li>SHA</li><li></li></ul></td><td id="description">SNMP Authentication Protocol to use</td></tr><tr><td id="name">SNMP Authentication pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for S NMP authentication protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>SNMP Private Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>DES</li><li>3DES</li><li>AES128</li><li>AES192</li><li>AES256</li><li></li></ul></td><td id="description">SNMP Private Protocol to use</td></tr><tr><td id="name">SNMP Private protocol pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for SNMP private protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Number of retries</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Set the number of retries when requesting the SNMP Agent</td></tr><tr><td id="name"><strong>Timeout (ms)</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">Set the timeout (in milliseconds) when requesting the SNMP Agent</td></tr ></table><h3>Relationships: </h3><table >id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All > FlowFiles that have been successfully used to perform SNMP Set are routed to >this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that failed >during the SNMP Set care 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> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-social-media-nar/1.11.3/org.apache.nifi.processors.twitter.GetTwitter/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-social-media-nar/1.11.3/org.apache.nifi.processors.twitter.GetTwitter/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-social-media-nar/1.11.3/org.apache.nifi.processors.twitter.GetTwitter/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-social-media-nar/1.11.3/org.apache.nifi.processors.twitter.GetTwitter/index.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetTwitter</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;">GetTwitter</h1><h2>Description: </h2><p>Pulls status changes from Twitter's streaming API. In versions starting with 1.9.0, the Consumer Key and Access Token are marked as sensitive according to https://developer.twitter.com/en/docs/basics/authentication/guides/securing-keys-and-tokens</p><h3>Tags: </h3><p>twitter, tweets, social media, status, json</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 is considered " sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Twitter Endpoint</strong></td><td id="default-value">Sample Endpoint</td><td id="allowable-values"><ul><li>Sample Endpoint <img src="../../../../../html/images/iconInfo.png" alt="The endpoint that provides public data, aka a 'garden hose'" title="The endpoint that provides public data, aka a 'garden hose'"></img></li><li>Firehose Endpoint <img src="../../../../../html/images/iconInfo.png" alt="The endpoint that provides access to all tweets" title="The endpoint that provides access to all tweets"></img></li><li>Filter Endpoint <img src="../../../../../html/images/iconInfo.png" alt="Endpoint that allows the stream to be filtered by specific terms or User IDs" title="Endpoint that allows the stream to be filtered by specific terms or User IDs"></img></li></ul></td><td id="description">Specifies which endpoint data should be pulled from</td></tr><tr><td id="name"><strong>Max Client Error Retries</strong></td><td id="default-value">5</td><td id="allowable-values"></td><td id="description">The maximum number of retries to attempt when client experience retryable connection errors. Client continues attempting to reconnect using an exponential back-off pattern until it successfully reconnects or until it reaches the retry limit. It is recommended to raise this value when client is getting rate limited by Twitter API. Default value is 5.</td></tr><tr><td id="name"><strong>Consumer Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Consumer Key provided by Twitter<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Consumer Se cret</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Consumer Secret provided by Twitter<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Access Token</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Access Token provided by Twitter<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Access Token Secret</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Access Token Secret provided by Twitter<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Languages</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of languages for which tweets should be fetched</td></tr><tr><td id="name">Terms to Filter On</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of ter ms to filter on. Ignored unless Endpoint is set to 'Filter Endpoint'. The filter works such that if any term matches, the status update will be retrieved; multiple terms separated by a space function as an 'AND'. I.e., 'it was, hello' will retrieve status updates that have either 'hello' or both 'it' AND 'was'</td></tr><tr><td id="name">IDs to Follow</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of Twitter User ID's to follow. Ignored unless Endpoint is set to 'Filter Endpoint'.</td></tr><tr><td id="name">Locations to Filter On</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of coordinates specifying one or more bounding boxes to filter on.Each bounding box is specified by a pair of coordinates in the format: swLon,swLat,neLon,neLat. Multiple bounding boxes can be specified as such: swLon1,swLat1,neLon1,neLat1,swLon2,swLat2,neLon2,neLat2.Ignored unless Endpoint is set to 'Filter Endpoint'.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All status updates will be routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>Sets mime type to application/json</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.GetSolr/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.GetSolr/additionalDetails.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.GetSolr/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.GetSolr/additionalDetails.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1,56 @@ +<!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>GetSolr</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> + +<body> +<h2>Usage Example</h2> +<p> + This processor pulls data from Solr collections. For its usage, Solr collections + have to fulfil two requirements: +</p> +<ul> + <li>The documents must include a date field containing the time when they were + indexed. Such kind of field can be easily added to documents at indexing time + e. g. using Solrs' UpdateRequestProcessor created by + 'TimestampUpdateProcessorFactory'.</li> + <li>The configuration of the Solr index (e. g. schema.xml or managed-schema) must + define a uniqueKey field.</li> +</ul> +<p> + Backwards compatibility to configurations of the GetSolr processor used within releases + of NiFi prior to 1.5 can be realized as follows: +</p> +<ul> + <li>Find the file conf/.getSolr* within the prior NiFi installation.</li> + <li>Open the file and copy the timestamp defined for 'LastEndDate'.</li> + <li>Insert the timestamp into the field 'Initial Date Filter'.</li> +</ul> +<p> + Annotation: The value of property 'Solr Query' actually is not added to parameter 'q' + but to parameter 'fq' for two reasons: +</p> +<ul> + <li>Improving performance by leveraging Solrs' filter cache.</li> + <li>Scoring is not required for the purpose of this processor as the sorting + is fixed to 'DateField asc, IdField asc'</li> +</ul> +</body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.GetSolr/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.GetSolr/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.GetSolr/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.GetSolr/index.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSolr</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;">GetSolr</h1><h2>Description: </h2><p>Queries Solr and outputs the results as a FlowFile in the format of XML or using a Record Writer</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Apache, Solr, Get, Pull, Records</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, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a pro perty is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Solr Type</strong></td><td id="default-value">Standard</td><td id="allowable-values"><ul><li>Cloud <img src="../../../../../html/images/iconInfo.png" alt="A SolrCloud instance." title="A SolrCloud instance."></img></li><li>Standard <img src="../../../../../html/images/iconInfo.png" alt="A stand-alone Solr instance." title="A stand-alone Solr instance."></img></li></ul></td><td id="description">The type of Solr instance, Cloud or Standard.</td></tr><tr><td id="name"><strong>Solr Location</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Solr url for a S olr Type of Standard (ex: http://localhost:8984/solr/gettingstarted), or the ZooKeeper hosts for a Solr Type of Cloud (ex: localhost:9983).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Collection</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Solr collection name, only used with a Solr Type of Cloud<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Return Type</strong></td><td id="default-value">XML</td><td id="allowable-values"><ul><li>XML</li><li>Records</li></ul></td><td id="description">Write Solr documents to FlowFiles as XML or using a Record Writer</td></tr><tr><td id="name">Record Writer</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href=".. /../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.11.3/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-parquet-nar/1.11.3/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a></td ><td id="description">The Record Writer to use in order to write Solr >documents to FlowFiles. Must be set if "Records" is used as return >type.<br/><strong>Supports Expression Language: true (will be evaluated using >variable registry only)</strong></td></tr><tr><td id="name">Solr >Query</td><td id="default-value"></td><td id="allowable-values"></td><td >id="description">A query to execute against Solr</td></tr><tr><td >id="name"><strong>Date Field</strong></td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The name of a date field in >Solr used to filter results</td></tr><tr><td id="name">Initial Date >Filter</td><td id="default-value"></td><td id="allowable-values"></td><td >id="description">Date value to filter results. Documents with an earlier date >will not be fetched. The format has to correspond to the date pattern of Solr >'YYYY-MM-DDThh:mm:ssZ'</td></tr><tr><td id="name">Return Fields</td><td >id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of field names to return</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Number of rows per Solr query</td></tr><tr><td id="name">Kerberos Credentials Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>KerberosCredentialsService<br/><strong>Implementation: </strong><a href="../../../nifi-kerberos-credentials-service-nar/1.11.3/org.apache.nifi.kerberos.KeytabCredentialsService/index.html">KeytabCredentialsService</a></td><td id="description">Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The username to use when Solr is configured with basic authentication.<br/><strong>Supports Expression Language: true (will be eval uated using variable registry only)</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password to use when Solr is configured with basic authentication.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.3/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.3/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context. This property must be set when communicating with a Solr over https.</td></tr><tr><td id="name"><strong>Solr Socket Timeout</strong></td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait for data on a socket connection to Solr. A value of 0 indicates an infinite timeout.</td></tr><tr><td id="name"><strong>Solr Connection Timeout</strong></td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait when establishing a connection to Solr. A value of 0 indicates an infinite timeout.</td></tr><tr><td id="name"><strong>Solr Maximum Connections</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">The maximum number of total connections allowed from the Solr client to Solr.</td></tr><tr><td id="name"><strong>Solr Maximum Connections Per Host</strong></td><td id="default-value">5</td><td id="allowable-values"></td><td id="descrip tion">The maximum number of connections allowed from the Solr client to a single Solr host.</td></tr><tr><td id="name">ZooKeeper Client Timeout</td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait for data on a connection to ZooKeeper, only used with a Solr Type of Cloud.</td></tr><tr><td id="name">ZooKeeper Connection Timeout</td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait when establishing a connection to ZooKeeper, only used with a Solr Type of Cloud.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>The results of querying Solr</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>CLUSTER</td><td>Stores latest date of Date Field so that the same data will not be fetched multiple times.</td></tr></table><h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1,48 @@ +<!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>PutSolrContentStream</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> + +<body> +<h2>Usage Example</h2> +<p> + This processor streams the contents of a FlowFile to an Apache Solr + update handler. Any properties added to this processor by the user are + passed to Solr on the update request. If a parameter must be sent multiple + times with different values, properties can follow a naming convention: + name.number, where name is the parameter name and number is a unique number. + Repeating parameters will be sorted by their property name. +</p> +<p> + Example: To specify multiple 'f' parameters for indexing custom json, the following + properties can be defined: +</p> +<ul> + <li><strong>split</strong>: /exams</li> + <li><strong>f.1</strong>: first:/first</li> + <li><strong>f.2</strong>: last:/last</li> + <li><strong>f.3</strong>: grade:/grade</li> +</ul> +<p> + This will result in sending the following url to Solr: </br> + split=/exams&f=first:/first&f=last:/last&f=grade:/grade +</p> +</body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.PutSolrContentStream/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.PutSolrContentStream/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.PutSolrContentStream/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.PutSolrContentStream/index.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSolrContentStream</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;">PutSolrContentStream</h1><h2>Description: </h2><p>Sends the contents of a FlowFile as a ContentStream to Solr</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Apache, Solr, Put, Send</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, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Solr Type</strong></td><td id="default-value">Standard</td><td id="allowable-values"><ul><li>Cloud <img src="../../../../../html/images/iconInfo.png" alt="A SolrCloud instance." title="A SolrCloud instance."></img></li><li>Standard <img src="../../../../../html/images/iconInfo.png" alt="A stand-alone Solr instance." title="A stand-alone Solr instance."></img></li></ul></td><td id="description">The type of Solr instance, Cloud or Standard.</td></tr><tr><td id="name"><strong>Solr Location</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Solr url for a Solr Type of Standard (ex: http://localhost:8984/solr/gettingstarted), or the ZooKeeper hosts for a Solr Type of Cloud (ex: localhost:9983).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Collection</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Solr collection name, only used with a Solr Type of Cloud<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Content Stream Path</strong></td><td id="default-value">/update/json/docs</td><td id="allowable-values"></td><td id="description">The path in Solr to post the ContentStream<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Content-Type</strong></td><td id="default-value">application/json</td><td id="allowable-values" ></td><td id="description">Content-Type being sent to >Solr<br/><strong>Supports Expression Language: true (will be evaluated using >flow file attributes and variable registry)</strong></td></tr><tr><td >id="name">Commit Within</td><td id="default-value">5000</td><td >id="allowable-values"></td><td id="description">The number of milliseconds >before the given update is committed<br/><strong>Supports Expression >Language: true (will be evaluated using flow file attributes and variable >registry)</strong></td></tr><tr><td id="name">Kerberos Credentials >Service</td><td id="default-value"></td><td >id="allowable-values"><strong>Controller Service API: ></strong><br/>KerberosCredentialsService<br/><strong>Implementation: ></strong><a >href="../../../nifi-kerberos-credentials-service-nar/1.11.3/org.apache.nifi.kerberos.KeytabCredentialsService/index.html">KeytabCredentialsService</a></td><td > id="description">Specifies the Kerberos Credentials Controller Service that >should be used for authenticating with Kerberos</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The username to use when Solr is configured with basic authentication.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password to use when Solr is configured with basic authentication.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.3/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService </a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.3/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context. This property must be set when communicating with a Solr over https.</td></tr><tr><td id="name"><strong>Solr Socket Timeout</strong></td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait for data on a socket connection to Solr. A value of 0 indicates an infinite timeout.</td></tr><tr><td id="name"><strong>Solr Connection Timeout</strong></td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait when establishing a connection to Solr. A value of 0 indicates an infinite timeout.</td></tr><tr><td id="name"><strong>Solr Maximum Connections</strong></td><td id="default-value">10</td><td id="allowable-val ues"></td><td id="description">The maximum number of total connections allowed from the Solr client to Solr.</td></tr><tr><td id="name"><strong>Solr Maximum Connections Per Host</strong></td><td id="default-value">5</td><td id="allowable-values"></td><td id="description">The maximum number of connections allowed from the Solr client to a single Solr host.</td></tr><tr><td id="name">ZooKeeper Client Timeout</td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait for data on a connection to ZooKeeper, only used with a Solr Type of Cloud.</td></tr><tr><td id="name">ZooKeeper Connection Timeout</td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait when establishing a connection to ZooKeeper, only used with a Solr Type of Cloud.</td></tr></table><h3>Dynamic Properties: </h3><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">A Solr request parameter name</td><td id="value">A Solr request parameter value</td><td>These parameters will be passed to Solr on the request<br/><strong>Supports Expression Language: false</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 original FlowFile</td></tr><tr><td>failure</td><td>FlowFiles that failed for any reason other than Solr being unreachable</td></tr><tr><td>connection_failure</td><td>FlowFiles that failed because Solr is unreachable</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:</h 3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.PutSolrRecord/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.PutSolrRecord/additionalDetails.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.PutSolrRecord/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-solr-nar/1.11.3/org.apache.nifi.processors.solr.PutSolrRecord/additionalDetails.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1,114 @@ +<!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>PutSolrRecord</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> + +<body> +<h2>Usage Example</h2> +<p> + This processor reads the NiFi record and indexes it into Solr as a SolrDocument. + Any properties added to this processor by the user are + passed to Solr on the update request. It is required that the input record reader + should be specified for this processor. Additionally, if only selected fields of a record are to be indexed + you can specify the field name as a comma-separated list under the fields property. +</p> +<p> + Example: To specify specific fields of the record to be indexed: +</p> +<ul> + <li><strong>Fields To Index</strong>: field1,field2,field3</li> +</ul> +<p> + <strong>NOTE:</strong> In case of nested the field names should be prefixed with the parent field name. +</p> +<ul> + <li><strong>Fields To Index</strong>: parentField1,parentField2,<strong>parentField3_childField1</strong>,<strong>parentField3_childField2</strong></li> +</ul> +<p> + In case of nested records, this processor would flatten all the nested records into a single solr document, the field name of the field in a child document would follow the format of <strong>{Parent Field Name}_{Child Field Name}</strong>. +</p> +<p> + Example: + <strong>For a record created from the following json:</strong><br/> +</p> +<pre> + { + "first": "Abhi", + "last": "R", + "grade": 8, + "exams": { + "subject": "Maths", + "test" : "term1", + "marks" : 90 + } + } +</pre> +<p> + <strong>The corresponding solr document would be represented as below:</strong><br/> +</p> +<pre> + { + "first": "Abhi", + "last": "R", + "grade": 8, + "exams_subject": "Maths", + "exams_test" : "term1", + "exams_marks" : 90 + } +</pre> +<p> + Similarly in case of an array of nested records, this processor would flatten all the nested records into a single solr document, the field name of the field in a child document would follow the format of <strong>{Parent Field Name}_{Child Field Name}</strong> and would be a multivalued field in the solr document. + Example: + <strong>For a record created from the following json:</strong><br/> +</p> +<pre> + { + "first": "Abhi", + "last": "R", + "grade": 8, + "exams": [ + { + "subject": "Maths", + "test" : "term1", + "marks" : 90 + }, + { + "subject": "Physics", + "test" : "term1", + "marks" : 95 + } + ] + } +</pre> +<p> + <strong>The corresponding solr document would be represented as below:</strong><br/> +</p> +<pre> + { + "first": "Abhi", + "last": "R", + "grade": 8, + "exams_subject": ["Maths","Physics"] + "exams_test" : ["term1","term1"] + "exams_marks" : [90,95] + } +</pre> +</body> +</html>
![http://some-website.com/path/to/image.jpg"](http://some-website.com/path/to/image.jpg"){kind=link}