# tPatternUnmasking properties for Apache Spark Batch

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

The Spark Batch tPatternUnmasking component belongs to the Data Quality family.

## Basic settings

| Schema and<br>Edit 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 Sync<br>columns to retrieve the schema from the previous component connected in the<br>Job.<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><br><br>The output schema of this component<br>contains one read-only column, ORIGINAL\_MARK. This column identifies by<br>true or false if the record is an<br>masked or and original respectively. |
| --- | --- |
|  | 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. |
| Modifications | Define in the table what fields to unmask and how to<br>unmask them:<br><br>Use the same settings for the Field<br>type, Values,<br>Path, Range and<br>Date Range columns as the ones used for<br>masking the input data with the tPatternMasking<br>component.<br><br><br>Column to unmask:<br>Select the column from the input flow that contains the data to be<br>unmasked.<br><br>Each column is processed sequentially, meaning that data<br>unmasking operations will be performed on the data from the first<br>column, the second column, and so on.<br><br>In a colum, each data field is a fixed length field,<br>except the last data field.<br><br>For fixed length fields, each value must contain the<br>same number of characters, for example: "30001,30002,30003" or "FR,EN".<br><br>In a column, the last Enumeration or Enumeration<br>from file data field is a variable length field.<br><br>For variable length fields, each value might not always<br>contain the same number of characters, for example: "30001,300023,30003" or "FR,ENG".<br><br>Field type: Select<br>the field type the data belongs to.<br><br><ul> <li> <p> <span>Interval</span>: When selected, set a range of										numeric values used for masking purposes in the <span>Range</span> field, using the										following syntax: <kbd>"&lt;min&gt;,&lt;max&gt;"</kbd>.</p> <p>The number of unmasked characters from the										input data corresponds to the number of characters of the										maximum value.</p> <p>For example, <kbd>"1,999"</kbd> will be interpreted as <kbd>"001,999"</kbd>, which means that										three characters from the input data will be masked by a										value randomly selected from the defined range of										values.</p> </li> <li> <p> <span>Enumeration</span>: When selected, enter a										comma-separated list of values to be used for masking data										in the <span>Values</span> field,										using the following syntax: <kbd>"value1,value2,value3"</kbd>.</p> </li> <li> <span>Enumeration from file</span>: When									selected, set the path to the CSV file containing a list of									values used for masking data in the <span>Path</span> field. The file must contain one value per									row, each value must be unique and all values must have the same									number of characters.</li> <li> <p> <span>Date pattern											(YYYYMMDD)</span>: When selected, set a range of										years in the <span>Date											Range</span> field, using the following syntax:											<kbd>"&lt;min_year&gt;,&lt;max_year&gt;"</kbd>.</p> <p>Years can only have four digits, for example:											<kbd>"1900,2100"</kbd>.</p> <p>The input dates to be masked must follow the										YYYYMMDD pattern, for example: <kbd>20180101</kbd>.</p> <p>For example, if the input date is <kbd>20180101</kbd> and the value in										the <span>Date Range</span> is											<kbd>"1900,2100"</kbd>,											<span>19221221</span> could be the										output date.</p> </li> </ul><br><br>In the Values,<br>Path, Range and Date Range, values must be enclosed in double<br>quotes.<br><br>When the input data is invalid, meaning that a value is<br>not included in the defined range, date range or in the enumeration, the<br>generated value is null. |

## Advanced settings

| Method | From this list, select the Format-Preserving Encryption<br>(FPE) algorithm that was used to mask data, FF1 with AES or FF1 with<br>SHA-2:<br><br>The FF1 with AES<br>method is based on the Advanced Encryption Standard in CBC mode. The<br>FF1 with SHA-2 method depends<br>on the secure hash function HMAC-256.<br><br>Java 8u161 is the minimum required version to use the<br>FF1 with AES method. To be<br>able to use this FPE method with Java versions earlier than 8u161,<br>download the Java Cryptography Extension (JCE) unlimited strength<br>jurisdiction policy files from Oracle website. |
| --- | --- |
| Password for FF1<br>methods | To unmask data, the FF1 with AES<br>and FF1 with SHA-2 methods require the password<br>specified in the Password for FF1 methods field<br>when the data was masked with the tPatternMasking component. |
| Seed for random<br>generator | Set a random number if you want to generate the same sample of<br>substitute data in each execution of the Job. The seed is not set by default.<br><br>If you do not set the seed, the component creates a new random<br>seed for each Job execution. Repeating the execution with a different seed will result<br>in a different sample being generated. |
| Output the original<br>row? | Select this check box to output original data rows in addition<br>to the substitute data. Outputting both the original and substitute data can be useful<br>in debug or test processes. |
| Should Null input return<br>NULL? | This check box is selected by default. When selected, the<br>component outputs null when input values are null.<br>Otherwise, the component returns the default value when the input is<br>null, that is an empty string for string values, 0<br>for numeric values and the current date for date values.<br><br>If the input is null, the Generate Sequence function will not return<br>null, even if the check box is selected. |
| Should EMPTY input return<br>EMPTY? | When this check box is selected, empty values are left unchanged<br>in the output data. Otherwise, the selected functions are applied to the input data. |
| tStat Catcher<br>Statistics | Select this check box to gather the Job processing metadata at the Job level<br>as well as at each component level. |

## Usage

| **Usage rule** | This component is used as an intermediate step.<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<br>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-premise distributions, use the configuration component                                        corresponding to the file system your cluster is using.                                        Typically, this system is HDFS and so use <span></span>.</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 <span>tHDFSConfiguration</span> or <span>tS3Configuration</span>.</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. |