Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-splunk-nar/1.2.0/org.apache.nifi.processors.splunk.GetSplunk/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-splunk-nar/1.2.0/org.apache.nifi.processors.splunk.GetSplunk/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-splunk-nar/1.2.0/org.apache.nifi.processors.splunk.GetSplunk/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-splunk-nar/1.2.0/org.apache.nifi.processors.splunk.GetSplunk/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSplunk</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;">GetSplunk</h1><h2>Description: </h2><p>Retrieves data from Splunk Enterprise.</p><h3>Tags: </h3><p>get, splunk, logs</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><ta ble id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Scheme</strong></td><td id="default-value">https</td><td id="allowable-values"><ul><li>https</li><li>http</li></ul></td><td id="description">The scheme for connecting to Splunk.</td></tr><tr><td id="name"><strong>Hostname</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">The ip address or hostname of the Splunk server.</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">8089</td><td id="allowable-values"></td><td id="description">The port of the Splunk server.</td></tr><tr><td id="name"><strong>Query</strong></td><td id="default-value">search * | head 100</td><td id="allowable-values"></td><td id="description">The query to execute. Typically beginning with a <search> command followed by a search clause, such as <search source="tcp:7689"> to search for messages rec eived on TCP port 7689.</td></tr><tr><td id="name"><strong>Time Field Strategy</strong></td><td id="default-value">Event Time</td><td id="allowable-values"><ul><li>Event Time <img src="../../../../../html/images/iconInfo.png" alt="Search based on the time of the event which may be different than when the event was indexed." title="Search based on the time of the event which may be different than when the event was indexed."></img></li><li>Index Time <img src="../../../../../html/images/iconInfo.png" alt="Search based on the time the event was indexed in Splunk." title="Search based on the time the event was indexed in Splunk."></img></li></ul></td><td id="description">Indicates whether to search by the time attached to the event, or by the time the event was indexed in Splunk.</td></tr><tr><td id="name"><strong>Time Range Strategy</strong></td><td id="default-value">Provided</td><td id="allowable-values"><ul><li>Managed from Beginning <img src="../../../../../html/images/iconInfo.pn g" alt="The processor will manage the date ranges of the query starting from the beginning of time." title="The processor will manage the date ranges of the query starting from the beginning of time."></img></li><li>Managed from Current <img src="../../../../../html/images/iconInfo.png" alt="The processor will manage the date ranges of the query starting from the current time." title="The processor will manage the date ranges of the query starting from the current time."></img></li><li>Provided <img src="../../../../../html/images/iconInfo.png" alt="The the time range provided through the Earliest Time and Latest Time properties will be used." title="The the time range provided through the Earliest Time and Latest Time properties will be used."></img></li></ul></td><td id="description">Indicates how to apply time ranges to each execution of the query. Selecting a managed option allows the processor to apply a time range from the last execution time to the current execution time. Whe n using <Managed from Beginning>, an earliest time will not be applied on the first execution, and thus all records searched. When using <Managed from Current> the earliest time of the first execution will be the initial execution time. When using <Provided>, the time range will come from the Earliest Time and Latest Time properties, or no time range will be applied if these properties are left blank.</td></tr><tr><td id="name">Earliest Time</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The value to use for the earliest time when querying. Only used with a Time Range Strategy of Provided. See Splunk's documentation on Search Time Modifiers for guidance in populating this field.</td></tr><tr><td id="name">Latest Time</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The value to use for the latest time when querying. Only used with a Time Range Strategy of Provided. See Splunk's documentation on Search Time Modifiers for guidance in populating this field.</td></tr><tr><td id="name"><strong>Time Zone</strong></td><td id="default-value">UTC</td><td id="allowable-values"><ul><li>Africa/Abidjan</li><li>Africa/Accra</li><li>Africa/Addis_Ababa</li><li>Africa/Algiers</li><li>Africa/Asmara</li><li>Africa/Asmera</li><li>Africa/Bamako</li><li>Africa/Bangui</li><li>Africa/Banjul</li><li>Africa/Bissau</li><li>Africa/Blantyre</li><li>Africa/Brazzaville</li><li>Africa/Bujumbura</li><li>Africa/Cairo</li><li>Africa/Casablanca</li><li>Africa/Ceuta</li><li>Africa/Conakry</li><li>Africa/Dakar</li><li>Africa/Dar_es_Salaam</li><li>Africa/Djibouti</li><li>Africa/Douala</li><li>Africa/El_Aaiun</li><li>Africa/Freetown</li><li>Africa/Gaborone</li><li>Africa/Harare</li><li>Africa/Johannesburg</li><li>Africa/Juba</li><li>Africa/Kampala</li><li>Africa/Khartoum</li><li>Africa/Kigali</li><li>Africa/Kinshasa</li><li>Africa/Lagos</li><li>Africa/Libreville</li><li>Africa/Lome</li><li>Africa/Luanda</li><li >Africa/Lubumbashi</li><li>Africa/Lusaka</li><li>Africa/Malabo</li><li>Africa/Maputo</li><li>Africa/Maseru</li><li>Africa/Mbabane</li><li>Africa/Mogadishu</li><li>Africa/Monrovia</li><li>Africa/Nairobi</li><li>Africa/Ndjamena</li><li>Africa/Niamey</li><li>Africa/Nouakchott</li><li>Africa/Ouagadougou</li><li>Africa/Porto-Novo</li><li>Africa/Sao_Tome</li><li>Africa/Timbuktu</li><li>Africa/Tripoli</li><li>Africa/Tunis</li><li>Africa/Windhoek</li><li>America/Adak</li><li>America/Anchorage</li><li>America/Anguilla</li><li>America/Antigua</li><li>America/Araguaina</li><li>America/Argentina/Buenos_Aires</li><li>America/Argentina/Catamarca</li><li>America/Argentina/ComodRivadavia</li><li>America/Argentina/Cordoba</li><li>America/Argentina/Jujuy</li><li>America/Argentina/La_Rioja</li><li>America/Argentina/Mendoza</li><li>America/Argentina/Rio_Gallegos</li><li>America/Argentina/Salta</li><li>America/Argentina/San_Juan</li><li>America/Argentina/San_Luis</li><li>America/Argentina/Tucuman</li><l i>America/Argentina/Ushuaia</li><li>America/Aruba</li><li>America/Asuncion</li><li>America/Atikokan</li><li>America/Atka</li><li>America/Bahia</li><li>America/Bahia_Banderas</li><li>America/Barbados</li><li>America/Belem</li><li>America/Belize</li><li>America/Blanc-Sablon</li><li>America/Boa_Vista</li><li>America/Bogota</li><li>America/Boise</li><li>America/Buenos_Aires</li><li>America/Cambridge_Bay</li><li>America/Campo_Grande</li><li>America/Cancun</li><li>America/Caracas</li><li>America/Catamarca</li><li>America/Cayenne</li><li>America/Cayman</li><li>America/Chicago</li><li>America/Chihuahua</li><li>America/Coral_Harbour</li><li>America/Cordoba</li><li>America/Costa_Rica</li><li>America/Creston</li><li>America/Cuiaba</li><li>America/Curacao</li><li>America/Danmarkshavn</li><li>America/Dawson</li><li>America/Dawson_Creek</li><li>America/Denver</li><li>America/Detroit</li><li>America/Dominica</li><li>America/Edmonton</li><li>America/Eirunepe</li><li>America/El_Salvador</li><li>Amer ica/Ensenada</li><li>America/Fort_Nelson</li><li>America/Fort_Wayne</li><li>America/Fortaleza</li><li>America/Glace_Bay</li><li>America/Godthab</li><li>America/Goose_Bay</li><li>America/Grand_Turk</li><li>America/Grenada</li><li>America/Guadeloupe</li><li>America/Guatemala</li><li>America/Guayaquil</li><li>America/Guyana</li><li>America/Halifax</li><li>America/Havana</li><li>America/Hermosillo</li><li>America/Indiana/Indianapolis</li><li>America/Indiana/Knox</li><li>America/Indiana/Marengo</li><li>America/Indiana/Petersburg</li><li>America/Indiana/Tell_City</li><li>America/Indiana/Vevay</li><li>America/Indiana/Vincennes</li><li>America/Indiana/Winamac</li><li>America/Indianapolis</li><li>America/Inuvik</li><li>America/Iqaluit</li><li>America/Jamaica</li><li>America/Jujuy</li><li>America/Juneau</li><li>America/Kentucky/Louisville</li><li>America/Kentucky/Monticello</li><li>America/Knox_IN</li><li>America/Kralendijk</li><li>America/La_Paz</li><li>America/Lima</li><li>America/Los_Angel es</li><li>America/Louisville</li><li>America/Lower_Princes</li><li>America/Maceio</li><li>America/Managua</li><li>America/Manaus</li><li>America/Marigot</li><li>America/Martinique</li><li>America/Matamoros</li><li>America/Mazatlan</li><li>America/Mendoza</li><li>America/Menominee</li><li>America/Merida</li><li>America/Metlakatla</li><li>America/Mexico_City</li><li>America/Miquelon</li><li>America/Moncton</li><li>America/Monterrey</li><li>America/Montevideo</li><li>America/Montreal</li><li>America/Montserrat</li><li>America/Nassau</li><li>America/New_York</li><li>America/Nipigon</li><li>America/Nome</li><li>America/Noronha</li><li>America/North_Dakota/Beulah</li><li>America/North_Dakota/Center</li><li>America/North_Dakota/New_Salem</li><li>America/Ojinaga</li><li>America/Panama</li><li>America/Pangnirtung</li><li>America/Paramaribo</li><li>America/Phoenix</li><li>America/Port-au-Prince</li><li>America/Port_of_Spain</li><li>America/Porto_Acre</li><li>America/Porto_Velho</li><li>Ameri ca/Puerto_Rico</li><li>America/Rainy_River</li><li>America/Rankin_Inlet</li><li>America/Recife</li><li>America/Regina</li><li>America/Resolute</li><li>America/Rio_Branco</li><li>America/Rosario</li><li>America/Santa_Isabel</li><li>America/Santarem</li><li>America/Santiago</li><li>America/Santo_Domingo</li><li>America/Sao_Paulo</li><li>America/Scoresbysund</li><li>America/Shiprock</li><li>America/Sitka</li><li>America/St_Barthelemy</li><li>America/St_Johns</li><li>America/St_Kitts</li><li>America/St_Lucia</li><li>America/St_Thomas</li><li>America/St_Vincent</li><li>America/Swift_Current</li><li>America/Tegucigalpa</li><li>America/Thule</li><li>America/Thunder_Bay</li><li>America/Tijuana</li><li>America/Toronto</li><li>America/Tortola</li><li>America/Vancouver</li><li>America/Virgin</li><li>America/Whitehorse</li><li>America/Winnipeg</li><li>America/Yakutat</li><li>America/Yellowknife</li><li>Antarctica/Casey</li><li>Antarctica/Davis</li><li>Antarctica/DumontDUrville</li><li>Antarctic a/Macquarie</li><li>Antarctica/Mawson</li><li>Antarctica/McMurdo</li><li>Antarctica/Palmer</li><li>Antarctica/Rothera</li><li>Antarctica/South_Pole</li><li>Antarctica/Syowa</li><li>Antarctica/Troll</li><li>Antarctica/Vostok</li><li>Arctic/Longyearbyen</li><li>Asia/Aden</li><li>Asia/Almaty</li><li>Asia/Amman</li><li>Asia/Anadyr</li><li>Asia/Aqtau</li><li>Asia/Aqtobe</li><li>Asia/Ashgabat</li><li>Asia/Ashkhabad</li><li>Asia/Baghdad</li><li>Asia/Bahrain</li><li>Asia/Baku</li><li>Asia/Bangkok</li><li>Asia/Beirut</li><li>Asia/Bishkek</li><li>Asia/Brunei</li><li>Asia/Calcutta</li><li>Asia/Chita</li><li>Asia/Choibalsan</li><li>Asia/Chongqing</li><li>Asia/Chungking</li><li>Asia/Colombo</li><li>Asia/Dacca</li><li>Asia/Damascus</li><li>Asia/Dhaka</li><li>Asia/Dili</li><li>Asia/Dubai</li><li>Asia/Dushanbe</li><li>Asia/Gaza</li><li>Asia/Harbin</li><li>Asia/Hebron</li><li>Asia/Ho_Chi_Minh</li><li>Asia/Hong_Kong</li><li>Asia/Hovd</li><li>Asia/Irkutsk</li><li>Asia/Istanbul</li><li>Asia/Jakarta</li ><li>Asia/Jayapura</li><li>Asia/Jerusalem</li><li>Asia/Kabul</li><li>Asia/Kamchatka</li><li>Asia/Karachi</li><li>Asia/Kashgar</li><li>Asia/Kathmandu</li><li>Asia/Katmandu</li><li>Asia/Khandyga</li><li>Asia/Kolkata</li><li>Asia/Krasnoyarsk</li><li>Asia/Kuala_Lumpur</li><li>Asia/Kuching</li><li>Asia/Kuwait</li><li>Asia/Macao</li><li>Asia/Macau</li><li>Asia/Magadan</li><li>Asia/Makassar</li><li>Asia/Manila</li><li>Asia/Muscat</li><li>Asia/Nicosia</li><li>Asia/Novokuznetsk</li><li>Asia/Novosibirsk</li><li>Asia/Omsk</li><li>Asia/Oral</li><li>Asia/Phnom_Penh</li><li>Asia/Pontianak</li><li>Asia/Pyongyang</li><li>Asia/Qatar</li><li>Asia/Qyzylorda</li><li>Asia/Rangoon</li><li>Asia/Riyadh</li><li>Asia/Saigon</li><li>Asia/Sakhalin</li><li>Asia/Samarkand</li><li>Asia/Seoul</li><li>Asia/Shanghai</li><li>Asia/Singapore</li><li>Asia/Srednekolymsk</li><li>Asia/Taipei</li><li>Asia/Tashkent</li><li>Asia/Tbilisi</li><li>Asia/Tehran</li><li>Asia/Tel_Aviv</li><li>Asia/Thimbu</li><li>Asia/Thimphu</li><li >Asia/Tokyo</li><li>Asia/Ujung_Pandang</li><li>Asia/Ulaanbaatar</li><li>Asia/Ulan_Bator</li><li>Asia/Urumqi</li><li>Asia/Ust-Nera</li><li>Asia/Vientiane</li><li>Asia/Vladivostok</li><li>Asia/Yakutsk</li><li>Asia/Yekaterinburg</li><li>Asia/Yerevan</li><li>Atlantic/Azores</li><li>Atlantic/Bermuda</li><li>Atlantic/Canary</li><li>Atlantic/Cape_Verde</li><li>Atlantic/Faeroe</li><li>Atlantic/Faroe</li><li>Atlantic/Jan_Mayen</li><li>Atlantic/Madeira</li><li>Atlantic/Reykjavik</li><li>Atlantic/South_Georgia</li><li>Atlantic/St_Helena</li><li>Atlantic/Stanley</li><li>Australia/ACT</li><li>Australia/Adelaide</li><li>Australia/Brisbane</li><li>Australia/Broken_Hill</li><li>Australia/Canberra</li><li>Australia/Currie</li><li>Australia/Darwin</li><li>Australia/Eucla</li><li>Australia/Hobart</li><li>Australia/LHI</li><li>Australia/Lindeman</li><li>Australia/Lord_Howe</li><li>Australia/Melbourne</li><li>Australia/NSW</li><li>Australia/North</li><li>Australia/Perth</li><li>Australia/Queensland</li> <li>Australia/South</li><li>Australia/Sydney</li><li>Australia/Tasmania</li><li>Australia/Victoria</li><li>Australia/West</li><li>Australia/Yancowinna</li><li>Brazil/Acre</li><li>Brazil/DeNoronha</li><li>Brazil/East</li><li>Brazil/West</li><li>CET</li><li>CST6CDT</li><li>Canada/Atlantic</li><li>Canada/Central</li><li>Canada/East-Saskatchewan</li><li>Canada/Eastern</li><li>Canada/Mountain</li><li>Canada/Newfoundland</li><li>Canada/Pacific</li><li>Canada/Saskatchewan</li><li>Canada/Yukon</li><li>Chile/Continental</li><li>Chile/EasterIsland</li><li>Cuba</li><li>EET</li><li>EST5EDT</li><li>Egypt</li><li>Eire</li><li>Etc/GMT</li><li>Etc/GMT+0</li><li>Etc/GMT+1</li><li>Etc/GMT+10</li><li>Etc/GMT+11</li><li>Etc/GMT+12</li><li>Etc/GMT+2</li><li>Etc/GMT+3</li><li>Etc/GMT+4</li><li>Etc/GMT+5</li><li>Etc/GMT+6</li><li>Etc/GMT+7</li><li>Etc/GMT+8</li><li>Etc/GMT+9</li><li>Etc/GMT-0</li><li>Etc/GMT-1</li><li>Etc/GMT-10</li><li>Etc/GMT-11</li><li>Etc/GMT-12</li><li>Etc/GMT-13</li><li>Etc/GMT-14</ li><li>Etc/GMT-2</li><li>Etc/GMT-3</li><li>Etc/GMT-4</li><li>Etc/GMT-5</li><li>Etc/GMT-6</li><li>Etc/GMT-7</li><li>Etc/GMT-8</li><li>Etc/GMT-9</li><li>Etc/GMT0</li><li>Etc/Greenwich</li><li>Etc/UCT</li><li>Etc/UTC</li><li>Etc/Universal</li><li>Etc/Zulu</li><li>Europe/Amsterdam</li><li>Europe/Andorra</li><li>Europe/Athens</li><li>Europe/Belfast</li><li>Europe/Belgrade</li><li>Europe/Berlin</li><li>Europe/Bratislava</li><li>Europe/Brussels</li><li>Europe/Bucharest</li><li>Europe/Budapest</li><li>Europe/Busingen</li><li>Europe/Chisinau</li><li>Europe/Copenhagen</li><li>Europe/Dublin</li><li>Europe/Gibraltar</li><li>Europe/Guernsey</li><li>Europe/Helsinki</li><li>Europe/Isle_of_Man</li><li>Europe/Istanbul</li><li>Europe/Jersey</li><li>Europe/Kaliningrad</li><li>Europe/Kiev</li><li>Europe/Lisbon</li><li>Europe/Ljubljana</li><li>Europe/London</li><li>Europe/Luxembourg</li><li>Europe/Madrid</li><li>Europe/Malta</li><li>Europe/Mariehamn</li><li>Europe/Minsk</li><li>Europe/Monaco</li><li>Eur ope/Moscow</li><li>Europe/Nicosia</li><li>Europe/Oslo</li><li>Europe/Paris</li><li>Europe/Podgorica</li><li>Europe/Prague</li><li>Europe/Riga</li><li>Europe/Rome</li><li>Europe/Samara</li><li>Europe/San_Marino</li><li>Europe/Sarajevo</li><li>Europe/Simferopol</li><li>Europe/Skopje</li><li>Europe/Sofia</li><li>Europe/Stockholm</li><li>Europe/Tallinn</li><li>Europe/Tirane</li><li>Europe/Tiraspol</li><li>Europe/Uzhgorod</li><li>Europe/Vaduz</li><li>Europe/Vatican</li><li>Europe/Vienna</li><li>Europe/Vilnius</li><li>Europe/Volgograd</li><li>Europe/Warsaw</li><li>Europe/Zagreb</li><li>Europe/Zaporozhye</li><li>Europe/Zurich</li><li>GB</li><li>GB-Eire</li><li>GMT</li><li>GMT0</li><li>Greenwich</li><li>Hongkong</li><li>Iceland</li><li>Indian/Antananarivo</li><li>Indian/Chagos</li><li>Indian/Christmas</li><li>Indian/Cocos</li><li>Indian/Comoro</li><li>Indian/Kerguelen</li><li>Indian/Mahe</li><li>Indian/Maldives</li><li>Indian/Mauritius</li><li>Indian/Mayotte</li><li>Indian/Reunion</li><li>I ran</li><li>Israel</li><li>Jamaica</li><li>Japan</li><li>Kwajalein</li><li>Libya</li><li>MET</li><li>MST7MDT</li><li>Mexico/BajaNorte</li><li>Mexico/BajaSur</li><li>Mexico/General</li><li>NZ</li><li>NZ-CHAT</li><li>Navajo</li><li>PRC</li><li>PST8PDT</li><li>Pacific/Apia</li><li>Pacific/Auckland</li><li>Pacific/Bougainville</li><li>Pacific/Chatham</li><li>Pacific/Chuuk</li><li>Pacific/Easter</li><li>Pacific/Efate</li><li>Pacific/Enderbury</li><li>Pacific/Fakaofo</li><li>Pacific/Fiji</li><li>Pacific/Funafuti</li><li>Pacific/Galapagos</li><li>Pacific/Gambier</li><li>Pacific/Guadalcanal</li><li>Pacific/Guam</li><li>Pacific/Honolulu</li><li>Pacific/Johnston</li><li>Pacific/Kiritimati</li><li>Pacific/Kosrae</li><li>Pacific/Kwajalein</li><li>Pacific/Majuro</li><li>Pacific/Marquesas</li><li>Pacific/Midway</li><li>Pacific/Nauru</li><li>Pacific/Niue</li><li>Pacific/Norfolk</li><li>Pacific/Noumea</li><li>Pacific/Pago_Pago</li><li>Pacific/Palau</li><li>Pacific/Pitcairn</li><li>Pacific/Pohnpei</ li><li>Pacific/Ponape</li><li>Pacific/Port_Moresby</li><li>Pacific/Rarotonga</li><li>Pacific/Saipan</li><li>Pacific/Samoa</li><li>Pacific/Tahiti</li><li>Pacific/Tarawa</li><li>Pacific/Tongatapu</li><li>Pacific/Truk</li><li>Pacific/Wake</li><li>Pacific/Wallis</li><li>Pacific/Yap</li><li>Poland</li><li>Portugal</li><li>ROK</li><li>Singapore</li><li>SystemV/AST4</li><li>SystemV/AST4ADT</li><li>SystemV/CST6</li><li>SystemV/CST6CDT</li><li>SystemV/EST5</li><li>SystemV/EST5EDT</li><li>SystemV/HST10</li><li>SystemV/MST7</li><li>SystemV/MST7MDT</li><li>SystemV/PST8</li><li>SystemV/PST8PDT</li><li>SystemV/YST9</li><li>SystemV/YST9YDT</li><li>Turkey</li><li>UCT</li><li>US/Alaska</li><li>US/Aleutian</li><li>US/Arizona</li><li>US/Central</li><li>US/East-Indiana</li><li>US/Eastern</li><li>US/Hawaii</li><li>US/Indiana-Starke</li><li>US/Michigan</li><li>US/Mountain</li><li>US/Pacific</li><li>US/Pacific-New</li><li>US/Samoa</li><li>UTC</li><li>Universal</li><li>W-SU</li><li>WET</li><li>Zulu</li><li >EST</li><li>HST</li><li>MST</li><li>ACT</li><li>AET</li><li>AGT</li><li>ART</li><li>AST</li><li>BET</li><li>BST</li><li>CAT</li><li>CNT</li><li>CST</li><li>CTT</li><li>EAT</li><li>ECT</li><li>IET</li><li>IST</li><li>JST</li><li>MIT</li><li>NET</li><li>NST</li><li>PLT</li><li>PNT</li><li>PRT</li><li>PST</li><li>SST</li><li>VST</li></ul></td><td > id="description">The Time Zone to use for formatting dates when performing a >search. Only used with Managed time strategies.</td></tr><tr><td >id="name">Application</td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The Splunk Application to >query.</td></tr><tr><td id="name">Owner</td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The owner to pass to >Splunk.</td></tr><tr><td id="name">Token</td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The token to pass to >Splunk.</td></tr><tr><td id="name">Username</td><td >id="default-value"></td><td id="a llowable-values"></td><td id="description">The username to authenticate to Splunk.</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password to authenticate to Splunk.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Security Protocol</td><td id="default-value">TLSv1_2</td><td id="allowable-values"><ul><li>TLSv1_2</li><li>TLSv1_1</li><li>TLSv1</li><li>SSLv3</li></ul></td><td id="description">The security protocol to use for communicating with Splunk.</td></tr><tr><td id="name"><strong>Output Mode</strong></td><td id="default-value">JSON</td><td id="allowable-values"><ul><li>ATOM</li><li>CSV</li><li>JSON</li><li>JSON_COLS</li><li>JSON_ROWS</li><li>RAW</li><li>XML</li></ul></td><td id="description">The output mode for the results.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Results retrieved from Spl unk are sent out 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>splunk.query</td><td>The query that performed to produce the FlowFile.</td></tr><tr><td>splunk.earliest.time</td><td>The value of the earliest time that was used when performing the query.</td></tr><tr><td>splunk.latest.time</td><td>The value of the latest time that was used when performing the query.</td></tr></table><h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>CLUSTER</td><td>If using one of the managed Time Range Strategies, this processor will store the values of the latest and earliest times from the previous execution so that the next execution of the can pick up where the last execution left off. The state will be cleared and start over if the query is changed.</td></tr></table><h3>Restricted: </h3>This component is not res tricted.</body></html> \ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-splunk-nar/1.2.0/org.apache.nifi.processors.splunk.PutSplunk/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-splunk-nar/1.2.0/org.apache.nifi.processors.splunk.PutSplunk/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-splunk-nar/1.2.0/org.apache.nifi.processors.splunk.PutSplunk/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-splunk-nar/1.2.0/org.apache.nifi.processors.splunk.PutSplunk/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSplunk</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;">PutSplunk</h1><h2>Description: </h2><p>Sends logs to Splunk Enterprise over TCP, TCP + TLS/SSL, or UDP. If a Message Delimiter is provided, then this processor will read messages from the incoming FlowFile based on the delimiter, and send each message to Splunk. If a Message Delimiter is not provided then the content of the FlowFile will be sent directly to Splunk as if it were a single message.</p><h3>Tags: </h3><p>splunk, logs, tcp, udp</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 opt ional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Hostname</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">The ip address or hostname of the destination.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port on the destination.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Max Size of Socket Send Buffer</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum size of the socket send buffer that should be used. This is a suggesti on to the Operating System to indicate how big the socket buffer should be. If this value is set too low, the buffer may fill up before the data can be read, and incoming data will be dropped.</td></tr><tr><td id="name"><strong>Idle Connection Expiration</strong></td><td id="default-value">5 seconds</td><td id="allowable-values"></td><td id="description">The amount of time a connection should be held open without being used before closing the connection.</td></tr><tr><td id="name">Timeout</td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The timeout for connecting to and communicating with the destination. Does not apply to UDP</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the data being sent.</td></tr><tr><td id="name"><strong>Protocol</strong></td><td id="default-value">TCP</td><td id="allowable-values"><ul> <li>TCP</li><li>UDP</li></ul></td><td id="description">The protocol for communication.</td></tr><tr><td id="name">Message Delimiter</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the delimiter to use for splitting apart multiple messages within a single FlowFile. If not specified, the entire content of the FlowFile will be used as a single message. If specified, the contents of the FlowFile will be split on this delimiter and each section sent as a separate message. Note that if messages are delimited and some messages for a given FlowFile are transferred successfully while others are not, the messages will be split into individual FlowFiles, such that those messages that were successfully sent are routed to the 'success' relationship while other messages are sent to the 'failure' relationship.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="a llowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context. If this property is set, messages will be sent over a secure connection.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that are sent successfully to the destination are sent out this relationship.</td></tr><tr><td>failure</td><td>FlowFiles that failed to send to the destination are sent out 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.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-spring-nar/1.2.0/org.apache.nifi.spring.SpringContextProcessor/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-spring-nar/1.2.0/org.apache.nifi.spring.SpringContextProcessor/additionalDetails.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-spring-nar/1.2.0/org.apache.nifi.spring.SpringContextProcessor/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-spring-nar/1.2.0/org.apache.nifi.spring.SpringContextProcessor/additionalDetails.html Tue May 9 15:27:39 2017 @@ -0,0 +1,94 @@ +<!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>SpringContextProcessor</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <h2>Description:</h2> + <p> + <b>SpringContextProcessor</b> â allows integration of processes encapsulated in Spring Application Context to run as NiFi + processor by becoming a runtime host for an instance of Spring Application Context. + </p> + <p> + Communication between NiFi and process encapsulated within Spring Application Context is accomplished via Spring Messaging + (one of the core modules of Spring Framework) and supports 3 usage modes: + <ul> + <li><i>Headless</i> - no interaction with NiFi, meaning nothing is sent to it and nothing is received from it (i.e., some monitoring app). + In this case NiFi simply plays the role of the runtime host.</li> + <li><i>One way (NiFi -> Spring or Spring -> NiFi). </i> - This depends on existence of pre-defined message channel in Spring + Application Context. The name of the channel should be âfromNiFiâ and the type <i>org.springframework.messaging.MessageChannel.</i></li> + <li><i>By-directional (NiFi -> Spring -> NiFi or Spring -> NiFi -> Spring)</i> - This depends on existence of two channels + in Spring Application Context. One channel receives messages from NiFi with name âfromNiFiâ and type <i>org.springframework.messaging.MessageChannel</i>i> + and another is to receive messages from Spring with name âtoNiFiâ and type <i>org.springframework.messaging.PollableChannel.</i></li> + </ul> + The example below demonstrates template configuration for bi-directional Spring Application Context configuration: + <code> + <pre> + <int:channel id=âfromNiFiâ/> + + <!â + your custom app configuration to receive messages from âfromNiFiâ channel and optionally send back to NiFi via âtoNiFiâ channel. + It could contain any Spring-based application (i.e., Spring Integration, Apache Camel and/or custom code). All you need to do is inject + channels into your beans and send/receive messages from it. + --> + + <int:channel id="toNiFi"> + <int:queue/> + </int:channel> + </pre> + </code> + </p> + <p> + The component is based on assumption that user has an existing Spring Application encapsulated in Spring Context that exposes optional in/out + MessagingChannels to allow data to flow to/from ApplicationContext and into/out-of. NiFi. + Such application is realized by having a directory on the file system, which contains contains all required resources for such application to run. + Such resources usually are JAR files to satisfy application's class-path as well as JAR representing the application and its configuration. + Below is the example of what such directory may contain. In this case the 'SI_DEMO-0.0.1-SNAPSHOT.jar' represents the actual application and the rest + of the JARs represent class-path dependency required by an application. + <pre> + deps + âââ SI_DEMO-0.0.1-SNAPSHOT.jar + âââ aopalliance-1.0.jar + âââ commons-logging-1.2.jar + âââ spring-aop-4.2.4.RELEASE.jar + âââ spring-beans-4.2.4.RELEASE.jar + âââ spring-context-4.2.4.RELEASE.jar + âââ spring-core-4.2.4.RELEASE.jar + âââ spring-expression-4.2.4.RELEASE.jar + âââ spring-integration-core-4.2.5.RELEASE.jar + âââ spring-messaging-4.2.4.RELEASE.jar + </pre> + </p> + <p> + You introduce the processor the usual way and then configure its properties: + <ul> + <li><i><b>Application Context config path</b></i> [REQUIRED] - a path to the Application Context configuration. + The path is relative to the class-path of the application defined by the <i>Application Context class path</i> property </li> + <li><i><b>Application Context class path</b></i> [REQUIRED] - a path to a directory on the file system where application dependencies are. </li> + <li><i>Send Timeout</i> [OPTIONAL] - the wait time for sending messages to Spring Application Context. Only required if NiFi plans to send data to Spring. + Defaults to 0 (don't wait). FlowFiles that were successfully sent to Spring will be removed from session while FlowFiles that could not be sent to + Spring will be routed to <i>failure</i> relationship.</li> + <li><i>Receive Timeout</i> - [OPTIONAL] - the wait time for receiving messages from Spring Application Context. Only required if NiFi plans to receive data from Spring. + Defaults to 0 (don't wait). FlowFile is created if and only if a message is successfully received from Spring. It is then transferred to <i>success</i> relationship.</li> + </ul> + </p> + </body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-spring-nar/1.2.0/org.apache.nifi.spring.SpringContextProcessor/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-spring-nar/1.2.0/org.apache.nifi.spring.SpringContextProcessor/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-spring-nar/1.2.0/org.apache.nifi.spring.SpringContextProcessor/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-spring-nar/1.2.0/org.apache.nifi.spring.SpringContextProcessor/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SpringContextProcessor</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;">SpringContextProcessor</h1><h2>Description: </h2><p>A Processor that supports sending and receiving data from application defined in Spring Application Context via predefined in/out MessageChannels.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Spring, Message, Get, Put, Integration</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Application Context config path</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The path to the Spring Application Context configuration file relative to the classpath</td></tr><tr><td id="name"><strong>Application Context class path</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to the directory with resources (i.e., JARs, configuration files etc.) required to be on the classpath of the ApplicationContext.</td></tr><tr><td id="name">Send Timeout</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Timeout for sending data to Spring Application Context. Defaults to 0.</td></tr><tr><td id="name">Receive Timeout</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Timeout for receiving date from Spring context. Defaults to 0.</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 successfully received from Spring Application Context are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be sent to Spring Application Context are 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.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>StandardSSLContextService</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;">StandardSSLContextService</h1><h2>Description: </h2><p>Standard implementation of the SSLContextService. Provides the ability to configure keystore and/or truststore properties once and reuse that configuration throughout the application</p><h3>Tags: </h3><p>ssl, secure, certificate, keystore, truststore, jks, p12, pkcs12, pkcs</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 "sensiti ve", 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">Keystore Filename</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully-qualified filename of the Keystore</td></tr><tr><td id="name">Keystore Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password for the Keystore<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Key Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password for the key. If this is not specified, but the Keystore Filename, Password, and Type are specified, then the Keystore Password will be assumed to be the same as the Key Password.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Keystore Type</td><td id="default-value"></td><td id="allowable-values"><ul><li>JKS</li><li>PKCS12</li></ul></td><td id="description">The Type of the Keystore</td></tr><tr><td id="name">Truststore Filename</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully-qualified filename of the Truststore</td></tr><tr><td id="name">Truststore Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password for the Truststore<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Truststore Type</td><td id="default-value"></td><td id="allowable-values"><ul><li>JKS</li><li>PKCS12</li></ul></td><td id="description">The Type of the Truststore. Either JKS or PKCS12</td></tr><tr><td id="name">SSL Protocol</td><td id="default-value">TLS</td><td id="allowable-values"><ul><li>SSL</li><li>SSLv2Hello</li><li >SSLv3</li><li>TLS</li><li>TLSv1</li><li>TLSv1.1</li><li>TLSv1.2</li></ul></td><td > id="description">The algorithm to use for this SSL >context</td></tr></table><h3>State management: </h3>This component does not >store state.<h3>Restricted: </h3>This component is not >restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.ControllerStatusReportingTask/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.ControllerStatusReportingTask/additionalDetails.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.ControllerStatusReportingTask/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.ControllerStatusReportingTask/additionalDetails.html Tue May 9 15:27:39 2017 @@ -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>ControllerStatusReportingTask</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <h2>Description:</h2> + + <p> + Reporting Task that creates a log message for each Processor and each Connection in the flow. + + For Processors, the following information is included (sorted by descending Processing Timing): + </p> + <ul> + <li>Processor Name</li> + <li>Processor ID</li> + <li>Processor Type</li> + <li>Run Status</li> + <li>Flow Files In (5 mins)</li> + <li>FlowFiles Out (5 mins)</li> + <li>Bytes Read from Disk (5 mins)</li> + <li>Bytes Written to Disk (5 mins)</li> + <li>Number of Tasks Completed (5 mins)</li> + <li>Processing Time (5 mins)</li> + </ul> + + <p> + For Connections, the following information is included (sorted by descending size of queued FlowFiles): + </p> + <ul> + <li>Connection Name</li> + <li>Connection ID</li> + <li>Source Component Name</li> + <li>Destination Component Name</li> + <li>Flow Files In (5 mins)</li> + <li>FlowFiles Out (5 mins)</li> + <li>FlowFiles Queued</li> + </ul> + + <p> + If may be convenient to redirect the logging output of this ReportingTask to a separate log file than the typical application log. + This can be accomplished by modified the logback.xml file in the NiFi conf/ directory such that a logger with the name + <code>org.apache.nifi.controller.ControllerStatusReportingTask</code> is configured to write to a separate log. + </p> + + <p> + Additionally, it may be convenient to disable logging for Processors or for Connections or to split them into separate log files. This + can be accomplished by using the loggers named + <code>org.apache.nifi.controller.ControllerStatusReportingTask.Processors</code> and + <code>org.apache.nifi.controller.ControllerStatusReportingTask.Connections</code>, respectively. + </p> + </body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.ControllerStatusReportingTask/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.ControllerStatusReportingTask/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.ControllerStatusReportingTask/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.ControllerStatusReportingTask/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ControllerStatusReportingTask</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;">ControllerStatusReportingTask</h1><h2>Description: </h2><p>Logs the 5-minute stats that are shown in the NiFi Summary Page for Processors and Connections, as well optionally logging the deltas between the previous iteration and the current iteration. Processors' stats are logged using the org.apache.nifi.controller.ControllerStatusReportingTask.Processors logger, while Connections' stats are logged using the org.apache.nifi.controller.ControllerStatusReportingTask.Connections logger. These can be configured in the NiFi logging configuration to log to different files, if desired.</p ><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: ></h3><p>stats, log</p><h3>Properties: </h3><p>In the list below, the names of >required properties appear in <strong>bold</strong>. Any other properties >(not in bold) are considered optional. The table also indicates any default >values.</p><table id="properties"><tr><th>Name</th><th>Default >Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td >id="name"><strong>Show Deltas</strong></td><td >id="default-value">true</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td >id="description">Specifies whether or not to show the difference in values >between the current status and the previous status</td></tr></table><h3>State >management: </h3>This component does not store state.<h3>Restricted: ></h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.MonitorDiskUsage/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.MonitorDiskUsage/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.MonitorDiskUsage/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.MonitorDiskUsage/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>MonitorDiskUsage</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;">MonitorDiskUsage</h1><h2>Description: </h2><p>Checks the amount of storage space available for the specified directory and warns (via a log message and a System-Level Bulletin) if the partition on which it lives exceeds some configurable threshold of storage space</p><h3>Tags: </h3><p>disk, storage, warning, monitoring, repo</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Va lue</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Threshold</strong></td><td id="default-value">80%</td><td id="allowable-values"></td><td id="description">The threshold at which a bulletin will be generated to indicate that the disk usage of the partition on which the directory found is of concern</td></tr><tr><td id="name"><strong>Directory Location</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The directory path of the partition to be monitored.</td></tr><tr><td id="name">Directory Display Name</td><td id="default-value">Un-Named</td><td id="allowable-values"></td><td id="description">The name to display for the directory in alerts.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.MonitorMemory/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.MonitorMemory/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.MonitorMemory/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.controller.MonitorMemory/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>MonitorMemory</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;">MonitorMemory</h1><h2>Description: </h2><p>Checks the amount of Java Heap available in the JVM for a particular JVM Memory Pool. If the amount of space used exceeds some configurable threshold, will warn (via a log message and System-Level Bulletin) that the memory pool is exceeding this threshold.</p><h3>Tags: </h3><p>monitor, memory, heap, jvm, gc, garbage collection, warning</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><ta ble id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Memory Pool</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>Code Cache</li><li>Metaspace</li><li>Compressed Class Space</li><li>G1 Eden Space</li><li>G1 Survivor Space</li><li>G1 Old Gen</li></ul></td><td id="description">The name of the JVM Memory Pool to monitor</td></tr><tr><td id="name"><strong>Usage Threshold</strong></td><td id="default-value">65%</td><td id="allowable-values"></td><td id="description">Indicates the threshold at which warnings should be generated</td></tr><tr><td id="name">Reporting Interval</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Indicates how often this reporting task should report bulletins while the memory utilization exceeds the configured threshold</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.AttributesToJSON/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.AttributesToJSON/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.AttributesToJSON/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.AttributesToJSON/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>AttributesToJSON</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;">AttributesToJSON</h1><h2>Description: </h2><p>Generates a JSON representation of the input FlowFile Attributes. The resulting JSON can be written to either a new Attribute 'JSONAttributes' or written to the FlowFile as content.</p><h3>Tags: </h3><p>json, attributes, flowfile</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</t h></tr><tr><td id="name">Attributes List</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma separated list of attributes to be included in the resulting JSON. If this value is left empty then all existing Attributes will be included. This list of attributes is case sensitive. If an attribute specified in the list is not found it will be be emitted to the resulting JSON with an empty string or NULL value.</td></tr><tr><td id="name"><strong>Destination</strong></td><td id="default-value">flowfile-attribute</td><td id="allowable-values"><ul><li>flowfile-attribute</li><li>flowfile-content</li></ul></td><td id="description">Control if JSON value is written as a new flowfile attribute 'JSONAttributes' or written in the flowfile content. Writing to flowfile content will overwrite any existing flowfile content.</td></tr><tr><td id="name"><strong>Include Core Attributes</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true< /li><li>false</li></ul></td><td id="description">Determines if the FlowFile org.apache.nifi.flowfile.attributes.CoreAttributes which are contained in every FlowFile should be included in the final JSON value generated.</td></tr><tr><td id="name"><strong>Null Value</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true a non existing or empty attribute will be NULL in the resulting JSON. If false an empty string will be placed in the JSON</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Successfully converted attributes to JSON</td></tr><tr><td>failure</td><td>Failed to convert attributes to JSON</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>JSONAttributes</td><td>JSON representation of Attributes </td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.Base64EncodeContent/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.Base64EncodeContent/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.Base64EncodeContent/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.Base64EncodeContent/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>Base64EncodeContent</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;">Base64EncodeContent</h1><h2>Description: </h2><p>Encodes or decodes content to and from base64</p><h3>Tags: </h3><p>encode, base64</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Mode</strong></td><td id="default-value">Encode</td><td id="allowable-values"><ul><li>Encode</li><li>Decode</ li></ul></td><td id="description">Specifies whether the content should be encoded or decoded</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully encoded or decoded will be routed to success</td></tr><tr><td>failure</td><td>Any FlowFile that cannot be encoded or decoded will be routed to failure</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.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.CompressContent/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.CompressContent/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.CompressContent/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.CompressContent/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>CompressContent</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;">CompressContent</h1><h2>Description: </h2><p>Compresses or decompresses the contents of FlowFiles using a user-specified compression algorithm and updates the mime.type attribute as appropriate</p><h3>Tags: </h3><p>content, compress, decompress, gzip, bzip2, lzma, xz-lzma2, snappy, snappy framed</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</t h><th>Description</th></tr><tr><td id="name"><strong>Mode</strong></td><td id="default-value">compress</td><td id="allowable-values"><ul><li>compress</li><li>decompress</li></ul></td><td id="description">Indicates whether the processor should compress content or decompress content. Must be either 'compress' or 'decompress'</td></tr><tr><td id="name"><strong>Compression Format</strong></td><td id="default-value">use mime.type attribute</td><td id="allowable-values"><ul><li>use mime.type attribute</li><li>gzip</li><li>bzip2</li><li>xz-lzma2</li><li>lzma</li><li>snappy</li><li>snappy framed</li></ul></td><td id="description">The compression format to use. Valid values are: GZIP, BZIP2, XZ-LZMA2, LZMA, Snappy, and Snappy Framed</td></tr><tr><td id="name"><strong>Compression Level</strong></td><td id="default-value">1</td><td id="allowable-values"><ul><li>0</li><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li><li>7</li><li>8</li><li>9</li></ul></td><td id="description">The com pression level to use; this is valid only when using GZIP compression. A lower value results in faster processing but less compression; a value of 0 indicates no compression but simply archiving</td></tr><tr><td id="name"><strong>Update Filename</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, will remove the filename extension when decompressing data (only if the extension indicates the appropriate compression format) and add the appropriate extension when compressing data</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles will be transferred to the success relationship after successfully being compressed or decompressed</td></tr><tr><td>failure</td><td>FlowFiles will be transferred to the failure relationship if they fail to compress/decompress</td></tr></table><h3>Reads Attributes: </h3><table id= "reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>If the Compression Format is set to use mime.type attribute, this attribute is used to determine the compression type. Otherwise, this attribute is ignored.</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>If the Mode property is set to compress, the appropriate MIME Type is set. If the Mode property is set to decompress and the file is successfully decompressed, this attribute is removed, as the MIME Type is no longer known.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.ControlRate/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.ControlRate/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.ControlRate/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.ControlRate/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ControlRate</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;">ControlRate</h1><h2>Description: </h2><p>Controls the rate at which data is transferred to follow-on processors. If you configure a very small Time Duration, then the accuracy of the throttle gets worse. You can improve this accuracy by decreasing the Yield Duration, at the expense of more Tasks given to the processor.</p><h3>Tags: </h3><p>rate control, throttle, rate, throughput</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><ta ble id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Rate Control Criteria</strong></td><td id="default-value">data rate</td><td id="allowable-values"><ul><li>data rate <img src="../../../../../html/images/iconInfo.png" alt="Rate is controlled by counting bytes transferred per time duration." title="Rate is controlled by counting bytes transferred per time duration."></img></li><li>flowfile count <img src="../../../../../html/images/iconInfo.png" alt="Rate is controlled by counting flowfiles transferred per time duration" title="Rate is controlled by counting flowfiles transferred per time duration"></img></li><li>attribute value <img src="../../../../../html/images/iconInfo.png" alt="Rate is controlled by accumulating the value of a specified attribute that is transferred per time duration" title="Rate is controlled by accumulating the value of a specified attribute that is transferred per time durati on"></img></li></ul></td><td id="description">Indicates the criteria that is used to control the throughput rate. Changing this value resets the rate counters.</td></tr><tr><td id="name"><strong>Maximum Rate</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum rate at which data should pass through this processor. The format of this property is expected to be a positive integer, or a Data Size (such as '1 MB') if Rate Control Criteria is set to 'data rate'.</td></tr><tr><td id="name">Rate Controlled Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of an attribute whose values build toward the rate limit if Rate Control Criteria is set to 'attribute value'. The value of the attribute referenced by this property must be a positive long, or the FlowFile will be routed to failure. This value is ignored if Rate Control Criteria is not set to 'attribute value'. Changing this value res ets the rate counters.</td></tr><tr><td id="name"><strong>Time Duration</strong></td><td id="default-value">1 min</td><td id="allowable-values"></td><td id="description">The amount of time to which the Maximum Rate pertains. Changing this value resets the rate counters.</td></tr><tr><td id="name">Grouping Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">By default, a single "throttle" is used for all FlowFiles. If this value is specified, a separate throttle is used for each value specified by the attribute with this name. Changing this value resets the rate counters.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles are transferred to this relationship under normal conditions</td></tr><tr><td>failure</td><td>FlowFiles will be routed to this relationship if they are missing a necessary Rate Controlled Attribute or the attribute is not in the expec ted format</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.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertCharacterSet</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;">ConvertCharacterSet</h1><h2>Description: </h2><p>Converts a FlowFile's content from one character set to another</p><h3>Tags: </h3><p>text, convert, characterset, character set</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowabl e Values</th><th>Description</th></tr><tr><td id="name"><strong>Input Character Set</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the CharacterSet to expect for Input<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Output Character Set</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the CharacterSet to convert to<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td></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.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertJSONToSQL</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;">ConvertJSONToSQL</h1><h2>Description: </h2><p>Converts a JSON-formatted FlowFile into an UPDATE, INSERT, or DELETE SQL statement. The incoming FlowFile is expected to be "flat" JSON message, meaning that it consists of a single JSON element and each field maps to a simple type. If a field maps to a JSON object, that JSON object will be interpreted as Text. If the input is an array of JSON elements, each element in the array is output as a separate FlowFile to the 'sql' relationship. Upon successful conversion, the original FlowFile is routed to the 'original' relationship and the SQL is routed to the 'sql' relationship.</p><h3>Tags: </h3><p>json, sql, database, rdbms, insert, update, delete, relational, flat</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>JDBC Connection Pool</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DBCPService<br/><strong>Implementations: </strong><br/><a href="../../../nifi-hive-nar/1.2.0/org.apache.nifi.dbcp.hive.HiveConnectionPool/index.html">HiveConnectionPool</a><br/><a href="../../../nifi-dbcp-service-nar/1.2.0/org.apache.nifi.dbcp.DBCPConnectionPoo l/index.html">DBCPConnectionPool</a></td><td id="description">Specifies the JDBC Connection Pool to use in order to convert the JSON message to a SQL statement. The Connection Pool is necessary in order to determine the appropriate database column types.</td></tr><tr><td id="name"><strong>Statement Type</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>UPDATE</li><li>INSERT</li><li>DELETE</li></ul></td><td id="description">Specifies the type of SQL Statement to generate</td></tr><tr><td id="name"><strong>Table Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the table that the statement should update<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Catalog Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the catalog that the statement should update. This may not apply for the database that you are updating. In thi s case, leave the field empty<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Schema Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the schema that the table belongs to. This may not apply for the database that you are updating. In this case, leave the field empty<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Translate Field Names</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, the Processor will attempt to translate JSON field names into the appropriate column names for the table specified. If false, the JSON field names must match the column names exactly, or the column will not be updated</td></tr><tr><td id="name">Unmatched Field Behavior</td><td id="default-value">Ignore Unmatched Fields</td><td id="allowable-values"><ul><li>Ignore Unmatched Fields <img src="../../../../ ../html/images/iconInfo.png" alt="Any field in the JSON document that cannot be mapped to a column in the database is ignored" title="Any field in the JSON document that cannot be mapped to a column in the database is ignored"></img></li><li>Fail <img src="../../../../../html/images/iconInfo.png" alt="If the JSON document has any field that cannot be mapped to a column in the database, the FlowFile will be routed to the failure relationship" title="If the JSON document has any field that cannot be mapped to a column in the database, the FlowFile will be routed to the failure relationship"></img></li></ul></td><td id="description">If an incoming JSON element has a field that does not map to any of the database table's columns, this property specifies how to handle the situation</td></tr><tr><td id="name">Unmatched Column Behavior</td><td id="default-value">Fail on Unmatched Columns</td><td id="allowable-values"><ul><li>Ignore Unmatched Columns <img src="../../../../../html/images/ico nInfo.png" alt="Any column in the database that does not have a field in the JSON document will be assumed to not be required. No notification will be logged" title="Any column in the database that does not have a field in the JSON document will be assumed to not be required. No notification will be logged"></img></li><li>Warn on Unmatched Columns <img src="../../../../../html/images/iconInfo.png" alt="Any column in the database that does not have a field in the JSON document will be assumed to not be required. A warning will be logged" title="Any column in the database that does not have a field in the JSON document will be assumed to not be required. A warning will be logged"></img></li><li>Fail on Unmatched Columns <img src="../../../../../html/images/iconInfo.png" alt="A flow will fail if any column in the database that does not have a field in the JSON document. An error will be logged" title="A flow will fail if any column in the database that does not have a field in the JSON document. An error will be logged"></img></li></ul></td><td id="description">If an incoming JSON element does not have a field mapping for all of the database table's columns, this property specifies how to handle the situation</td></tr><tr><td id="name">Update Keys</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of column names that uniquely identifies a row in the database for UPDATE statements. If the Statement Type is UPDATE and this property is not set, the table's Primary Keys are used. In this case, if no Primary Key exists, the conversion to SQL will fail if Unmatched Column Behaviour is set to FAIL. This property is ignored if the Statement Type is INSERT<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Quote Column Identifiers</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Enabling this option will cause all column names to be quoted, allowing you to use reserved words as column names in your tables.</td></tr><tr><td id="name">Quote Table Identifiers</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Enabling this option will cause the table name to be quoted to support the use of special characters in the table name</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>sql</td><td>A FlowFile is routed to this relationship when its contents have successfully been converted into a SQL statement</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be converted into a SQL statement. Common causes include invalid JSON content or the JSON content missing a required field (if using an INSERT statement type).</td></tr><tr><td>original</td><td>When a FlowFile is converted to SQL, the original JSON FlowFile is route d 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 of FlowFile that is routed to 'sql' to 'text/plain'.</td></tr><tr><td>sql.table</td><td>Sets the sql.table attribute of FlowFile that is routed to 'sql' to the name of the table that is updated by the SQL statement.</td></tr><tr><td>sql.catalog</td><td>If the Catalog name is set for this database, specifies the name of the catalog that the SQL statement will update. If no catalog is used, this attribute will not be added.</td></tr><tr><td>fragment.identifier</td><td>All FlowFiles routed to the 'sql' relationship for the same incoming FlowFile (multiple will be output for the same incoming FlowFile if the incoming FlowFile is a JSON Array) will have the same value for the fragment.identifier attribute. This can then be used to correlate the results.</td></tr><tr><t d>fragment.count</td><td>The number of SQL FlowFiles that were produced for same incoming FlowFile. This can be used in conjunction with the fragment.identifier attribute in order to know how many FlowFiles belonged to the same incoming FlowFile.</td></tr><tr><td>fragment.index</td><td>The position of this FlowFile in the list of outgoing FlowFiles that were all derived from the same incoming FlowFile. This can be used in conjunction with the fragment.identifier and fragment.count attributes to know which FlowFiles originated from the same incoming FlowFile and in what order the SQL FlowFiles were produced</td></tr><tr><td>sql.args.N.type</td><td>The output SQL statements are parametrized in order to avoid SQL Injection Attacks. The types of the Parameters to use are stored in attributes named sql.args.1.type, sql.args.2.type, sql.args.3.type, and so on. The type is a number representing a JDBC Type constant. Generally, this is useful only for software to read and interpret but is a dded so that a processor such as PutSQL can understand how to interpret the values.</td></tr><tr><td>sql.args.N.value</td><td>The output SQL statements are parametrized in order to avoid SQL Injection Attacks. The values of the Parameters to use are stored in the attributes named sql.args.1.value, sql.args.2.value, sql.args.3.value, and so on. Each of these attributes has a corresponding sql.args.N.type attribute that indicates how the value should be interpreted when inserting it into the database.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutSQL/index.html">PutSQL</a></p></body></html> \ No newline at end of file
