| //// |
| 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. |
| //// |
| :documentationPath: /plugins/transforms/ |
| :language: en_US |
| :page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/transforms/propertyoutput/src/main/doc/propertyoutput.adoc |
| |
| = Write data to properties file |
| |
| == Description |
| |
| The Properties Output transform outputs a set of rows of data to a Java properties files. For more information on this file format, read this: http://en.wikipedia.org/wiki/.properties. |
| |
| The data needs to be structured in a key/value format to be usable for a properties file. |
| |
| == Options |
| |
| === General Tab |
| |
| [width="90%", options="header"] |
| |=== |
| |Option|Description |
| |Transform name|Name of the transform this name has to be unique in a single pipeline. |
| |Key field|The input field name that will contain the key part to be written to the properties file. |
| |Value field|The input field name that will contain the value part to be written to the properties file. |
| |Comment|Short comment that is going to be copied into the properties file (at the top).NOTE: Only the first line is commented out. The next ones need to be commented by the user. |
| |=== |
| |
| === Content |
| |
| [width="90%", options="header"] |
| |=== |
| |Option|Description |
| |Filename|The filename without the file extension. |
| |Append|Check this option to update an existing property file. Properties in the file that are not processed by the transform will remain unchanged. |
| |Create parent folder|Check this option if you want to automatically create the parent folder. |
| |Accept file name from field?|Check this option if the file name is specified in an input stream field. |
| |File name field|Specifies the field that contains the name of the file to write to. |
| |Extension|Specify the file extension. Usually this is "properties". |
| |Include transform number in filename|Includes the transform number (when running in multiple copies) in the output filename. |
| |Include date in filename|Includes the date in the output filename with format yyyyMMdd (20081231). |
| |Include time in filename|Includes the date in the output filename with format HHmmss (235959). |
| |Show filenames(s)...|Displays the path of the file to be written to. |
| |Result filename|Add files to result filename : Adds the generated filenames read to the result of this pipeline. A unique list is being kept in memory that can be used in the next workflow action in a workflow, for example in another pipeline. |
| |=== |