# tFileInputXML properties for Apache Spark Batch

These properties are used to configure tFileInputXML running in the Spark Batch Job framework.

The Spark Batch tFileInputXML component belongs to the File family.

The component in this framework is available in all Talend products with Big Data and Talend Data Fabric.

## Basic settings

| Define a storage configuration<br>component | Select the configuration component to be used to provide the configuration<br>information for the connection to the target file system such as HDFS.<br><br>If you leave this check box clear, the target file system is the local<br>system.<br><br>The configuration component to be used must be present in the same Job.<br>For example, if you have dropped a tHDFSConfiguration component in the Job, you can select it to write<br>the result in a given HDFS system. |
| --- | --- |
| Property type | Either Built-In or Repository. |
|  | Built-In: No property data stored centrally. |
|  | Repository: Select the repository file where the<br>properties are stored.<br><br>The properties are stored centrally under the Hadoop<br>Cluster node of the Repository<br>tree.<br><br>The fields that come after are pre-filled in using the fetched<br>data.<br><br>For further information about the Hadoop<br>Cluster node, see the Getting Started Guide. |
| Schema and Edit<br>Schema | A schema is a row description. It defines the number of fields<br>(columns) to be processed and passed on to the next component. When you create a Spark<br>Job, avoid the reserved word line when naming the<br>fields.<br><br>Click Edit<br>schema to make changes to the schema. If the current schema is of the Repository type, three options are available:<br><br><ul> <li> <p> <span>View schema</span>: choose this                option to view the schema only.</p> </li> <li> <p> <span>Change to built-in property</span>:                choose this option to change the schema to <span>Built-in</span> for local changes.</p> </li> <li> <p> <span>Update repository connection</span>:                choose this option to change the schema stored in the repository and decide whether                to propagate the changes to all the Jobs upon completion. If you just want to                propagate the changes to the current Job, you can select <span>No</span> upon completion and choose this schema metadata                again in the <span>Repository Content</span>                window.</p> </li> </ul> |
|  | Built-In: You create and store the schema locally for this component<br>only. |
|  | Repository: You have already created the schema and stored it in the<br>Repository. You can reuse it in various projects and Job designs. |
| Folder/File | Browse to, or enter the path pointing to the data to be used in the file system.<br><br>If the path you set points to a folder, this component will<br>read all of the files stored in that folder, for example,<br>/user/talend/in; if sub-folders exist, the sub-folders are automatically<br>ignored unless you define the property<br>spark.hadoop.mapreduce.input.fileinputformat.input.dir.recursive to be<br>true in the Advanced properties table in the<br>Spark configuration tab.<br><br><ul> <li>Depending on the filesystem to be used, properly configure the corresponding          configuration component placed in your Job, for example, a            <span>tHDFSConfiguration</span> component for HDFS, a            <span>tS3Configuration</span> component for S3 and a            <span>tAzureFSConfiguration</span> for Azure Storage and Azure Data Lake          Storage.</li> </ul><br><br>If you want to specify more than one files or directories in this<br>field, separate each path using a comma (,).<br><br>If the file to be read is a compressed one, enter the file name<br>with its extension; then ttFileInputXML automatically decompresses it at<br>runtime. The supported compression formats and their corresponding<br>extensions are:<br><br><ul> <li> <p>DEFLATE: <em>*.deflate</em> </p> </li> <li> <p>gzip: <em>*.gz</em> </p> </li> <li> <p>bzip2: <em>*.bz2</em> </p> </li> <li> <p>LZO: <em>*.lzo</em> </p> </li> </ul><br><br>The button for browsing does not work with the Spark Local mode; if you are using the other Spark Yarn modes that the Studio supports with your distribution, ensure that<br>you have correctly configured the connection in a configuration component in the same<br>Job, such as tHDFSConfiguration. Use the<br>configuration component depending on the filesystem to be used. |
| Element to extract | Enter the element from which you need to read the contents and the<br>child elements of the input XML data.<br><br>The element defined in this field is used at the root node of any<br>XPath specified within this component. This element helps define the<br>atomic units of the XML data to be used so that however big the<br>original document is or wherever the input is split, the rows within<br>this element can be correctly distributed to the mapper<br>tasks.<br><br>Note that any content outside this element is ignored and the<br>child elements of this element cannot contain this element<br>itself. |
| Loop XPath query | Node of the tree, which the loop is based on.<br><br>Note its root is the element you have defined in the Element to extract field. |
| Mapping | Column: Columns to map. They<br>reflect the schema as defined in the Schema type field.<br><br><br>XPath Query: Enter the fields to<br>be extracted from the structured input.<br><br><br>Get nodes: Select this check box<br>to recuperate the XML content of all current nodes specified in the<br>Xpath query list, or select the<br>check box next to specific XML nodes to recuperate only the content<br>of the selected nodes. These nodes are important when the output<br>flow from this component needs to use the XML structure, for<br>example, the Document data<br>type.<br><br>For further information about the Document type, see<br>*Talend Studio User<br>Guide*. |
| Die on error | Select the check box to stop the execution of the Job when an error<br>occurs. |

## Advanced settings

| Set minimum partitions | Select this check box to control the number of partitions to be created from the input<br>data over the default partitioning behavior of Spark.<br><br>In the displayed field, enter, without quotation marks, the minimum number of partitions<br>you want to obtain.<br><br>When you want to control the partition number, you can generally set at least as many partitions as<br>the number of executors for parallelism, while bearing in mind the available memory and the<br>data transfer pressure on your network. |
| --- | --- |
| Custom encoding | You may encounter encoding issues when you process the stored data. In that<br>situation, select this check box to display the Encoding list.<br><br>Select the encoding from the list or select Custom<br>and define it manually. This field is compulsory for database data handling. The<br>supported encodings depend on the JVM that you are using. For more information, see<br>[https://docs.oracle.com](https://docs.oracle.com/). |

## Usage

| **Usage rule** | This component is used as a start component and requires an<br>output link.<br><br>This component, along with the Spark Batch component Palette it belongs to,<br>appears only when you are creating a Spark Batch Job.<br><br>Note that in this documentation, unless otherwise explicitly stated, a<br>scenario presents only Standard Jobs, that is to<br>say traditional<br>Talend<br>data integration Jobs. |
| --- | --- |
| Spark Connection | In the Spark<br>Configuration tab in the Run<br>view, define the connection to a given Spark cluster for the whole Job. In<br>addition, since the Job expects its dependent jar files for execution, you must<br>specify the directory in the file system to which these jar files are<br>transferred so that Spark can access these files:<br><br><ul> <li> <div> <span>Yarn mode</span> (Yarn client or Yarn cluster):<ul> <li> <p>When using Google Dataproc, specify a bucket in the                                            <span>Google Storage staging bucket</span>                                        field in the <span>Spark configuration</span>                                        tab.</p> </li> <li> <p>When using HDInsight, specify the blob to be used for Job                                        deployment in the <span>Windows Azure Storage                                            configuration</span> area in the <span>Spark                                            configuration</span> tab.</p> </li> <li>When using Altus, specify the S3 bucket or the Azure                                    Data Lake Storage for Job deployment in the <span>Spark                                        configuration</span> tab.</li> <li>When using Qubole, add a                                        <span>tS3Configuration</span> to your Job to write                                    your actual business data in the S3 system with Qubole. Without                                        <span>tS3Configuration</span>, this business data is                                    written in the Qubole HDFS system and destroyed once you shut                                    down your cluster.</li> <li> <p>When using on-premises distributions, use the configuration component                                        corresponding to the file system your cluster is using.                                        Typically, this system is HDFS and so use <a href="https://help.qlik.com/talend/r/en-US/7.3/components/hdfs/thdfsconfiguration">tHDFSConfiguration</a>.</p> </li> </ul> </div> </li> <li> <p> <span>Standalone mode</span>: use the                            configuration component corresponding to the file system your cluster is                            using, such as <a href="https://help.qlik.com/talend/r/en-US/7.3/components/hdfs/thdfsconfiguration-properties-for-apache-spark-batch">tHDFSConfiguration Apache Spark Batch</a> or <a href="https://help.qlik.com/talend/r/en-US/7.3/components/amazon-s3/ts3configuration-properties-for-apache-spark-batch">tS3Configuration Apache Spark Batch</a>.</p> <p>If you are using Databricks without any configuration component present                            in your Job, your business data is written directly in DBFS (Databricks                            Filesystem).</p> </li> </ul><br><br>This connection is effective on a per-Job basis. |