# Apache Spark BatchのtPatternMaskingプロパティ

これらのプロパティは、Spark Batchジョブのフレームワークで実行されているtPatternMaskingを設定するために使われます。

Spark BatchのtPatternMaskingコンポーネントは、データクオリティファミリーに属しています。

このフレームワークのコンポーネントは、すべてのビッグデータ対応のTalendプラットフォーム製品およびTalend Data Fabricで利用できます。

## 基本設定

| プロパティ | 説明 |
| --- | --- |
| [Schema] (スキーマ)と[Edit Schema] (スキーマを編集) | <ul> <li> <p>スキーマとは行の説明のことです。処理して次のコンポーネントに渡すフィールド(カラム)数を定義します。Sparkジョブを作成する場合、フィールドの命名時は予約語の<kbd>line</kbd>を避けます。</p> <p>ジョブで接続している先行コンポーネントからスキーマを取得するためには、<span>[Sync columns] (カラムを同期)</span>をクリックします。</p> <p>スキーマを変更するには<span>[Edit schema] (スキーマを編集)</span>をクリックします。現在のスキーマが<span>リポジトリー</span>タイプの場合は、3つのオプションを利用できます。</p> <ul> <li> <p> <span>[View schema] (スキーマを表示)</span>: スキーマのみを表示する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Change to built-in property] (組み込みのプロパティに変更)</span>: ローカルで変更を行うためにスキーマを<span>組み込み</span>に変更する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Update repository connection] (リポジトリー接続をアップデート)</span>: リポジトリーに保存されているスキーマに変更を加え、変更後にそのコンテンツをすべてのジョブにプロパゲートするかどうかを決める場合は、このオプションを選択します。</p> <p>変更を現在のジョブにのみ反映する場合は、変更後、<span>[No] (いいえ)</span>を選択し、<span>[Repository Content] (リポジトリーコンテンツ)</span>ウィンドウで再びこのスキーマのメタデータを選択します。</p> </li> </ul> <div>このコンポーネントの出力スキーマには、読み取り専用カラムが含まれています。 <ul> <li> <span>TWEAK</span>: <span>[Use tweaks with FF1 Encryption] (FF1暗号化で微調整を使用)</span>チェックボックスがオンになっている場合に生成されます。このカラムにはデータの解読に必要な微調整が含まれています。</li> <li> <span>ORIGINAL_MARK</span>: レコードが元のレコードであれば<span>true</span>で、代替レコードであれば<span>false</span>で識別します。</li> </ul> </div> </li> <li> <p> <span>[Built-in] (組み込み)</span>: そのコンポーネントに対してのみスキーマを作成し、ローカルに保管します。</p> </li> <li> <p> <span>[Repository] (リポジトリー)</span>: スキーマは作成済みで、リポジトリーに保管されています。さまざまなプロジェクトやジョブデザインで再利用できます。</p> </li> </ul> |
| [Modifications] (変更) | テーブルで変更するフィールドと変更方法を定義します:<br><br>[Column to mask] (マスクするカラム): 入力フローからカラムを選択し、値を変更して同種のデータを生成します。<br><br>異なる複数のカラムからのデータをマスクできますが、マスクするフィールドの順序に従う必要があります。<br><br>各カラムは順次処理されます。すなわち、最初のカラムからのデータに対してデータマスキングオペレーションが実行され、2番目以降のカラムも同様に実行されます。<br><br>カラム内では、最後のデータフィールドを除いて、各データフィールドが固定長フィールドになっています。<br><br>固定長フィールドの場合は、たとえば、"30001,30002,30003"または"FR,EN"のように、各値に含まれる文字数が同じである必要があります。<br><br>カラム内の最後の[Enumeration] (列挙)または[Enumeration from file] (ファイルからの列挙)データフィールドは、可変長フィールドです。<br><br>可変長フィールドの場合は、たとえば、"30001,300023,30003"または"FR,ENG"のように、各値に含まれる文字数は常に同じとは限りません。<br><br>[Field type] (フィールドタイプ): データが属しているフィールドタイプを選択します。<br><br><ul> <li> <p> <span>[Interval] (間隔)</span>: 選択時に次の構文を使用して、マスクに使用する数値の範囲を<span>[Range] (範囲)</span>フィールドで設定します: <kbd>"&lt;min&gt;,&lt;max&gt;"</kbd>。</p> <p>入力データからマスクされる文字の数は、最大値の文字数に対応します。</p> <p>たとえば、<kbd>"1,999"</kbd>は<kbd>"001,999"</kbd>として解釈されます。すなわち、入力データからの3文字が、定義済みの値の範囲からランダムに選択された値によってマスクされます。</p> </li> <li> <p> <span>[Enumeration] (列挙)</span>: 選択時に次の構文を使用して、<span>[Values] (値)</span>フィールド内のデータをマスクするために使用する値のコンマ区切りリストを入力します: <kbd>"value1,value2,value3"</kbd>。</p> <p>各値の文字数は同じである必要があります。たとえば、<kbd>"30001,30002,30003"</kbd>または<kbd>"FR,EN"</kbd>です。</p> </li> <li> <span>[Enumeration from file] (ファイルからの列挙)</span>: 選択時に、<span>[Path] (パス)</span>フィールド内のデータをマスクするために使用する値のリストを含むCSVファイルへのパスを設定するために使われます。ファイルには行ごとに1つの値が含まれていて、各値は一意で、値の文字数は同じである必要があります。<div>次の場所でファイルを選択できます。<ul> <li>ローカルシステム。</li> <li>Amazon S3 (ローカルSparkモード、または<span>tS3Configuration</span>を使ってEMRに接続)。S3NおよびS3Aファイルシステムがサポートされています。</li> <li>Azure Blob Storage (ローカルSparkモード、または<span>tAzureFSConfiguration</span>を使ってAzure HDInsightかDatabricksに接続)。 </li> <li>Azure Data Lake Storage (ローカルSparkモード、または<span>tAzureFSConfiguration</span>を使ってAzure HDInsightに接続)。</li> <li>Google Cloud Storage (ローカルSparkモード、または<span>tGSConfiguration</span>を使ってDataprocに接続)。</li> <li>HDFS (ローカルSparkモード、または<span>tHDFSConfiguration</span>を使ってAzure HDInsightに接続)。</li> </ul> </div> <div>ファイルパスを次のように設定します。<ul> <li>ローカルモードの場合:<ul> <li>Apache Spark 3.1以前のバージョンでは、<span>prefix://file path</span>または<span>file:///file path</span>となります。</li> <li>Apache Spark 3.2以降のバージョンでは、<span>file:///file path</span>となります。</li> </ul></li> <li>スタンドアロンおよびYarnモードの場合は、<span>prefix://file path</span>となります。</li> <li>ファイルがクラスターにある場合は、<span>hdfs://hdpnameservice1/file path</span>となります。</li> <li>ファイルがAzure Blob Storage上にあり、Azure HDInsightかDatabricksに接続している場合は、<span>wasbs://&lt;container_name&gt;@&lt;storage_account_name&gt;.blob.core.windows.net/&lt;folder&gt;/&lt;file_name&gt;</span>となります。</li> </ul> </div> <p>フォルダーへのパスはサポートされていません。</p> </li> <li> <p> <span>[Date pattern (YYYYMMDD)] (日付パターン(YYYYMMDD))</span>: 選択時に次の構文を使用して、<span>[Date Range] (日付範囲)</span>フィールドに年の範囲を設定するために使われます: <kbd>"&lt;min_year&gt;,&lt;max_year&gt;"</kbd>。</p> <p>年はたとえば<kbd>"1900,2100"</kbd>のように、必ず4桁にしてください。</p> <p>マスクする入力日付には、たとえば <kbd>20180101</kbd>のように、YYYYMMDDのパターンを使用してください。</p> <p>たとえば、入力日付が<kbd>20180101</kbd>で<span>[Date Range] (日付範囲)</span>内の値が<kbd>"1900,2100"</kbd>である場合、出力日付はたとえば<span>19221221</span>のようになります。</p> </li> </ul><br><br>[Values] (値)、[Path] (パス)、[Range] (範囲)および[Date Range] (日付範囲)に入力する値は、二重引用符で囲む必要があります。<br><br>入力データが無効な場合、すなわち、値がコンポーネントで定義したパターンにマッチしない場合、生成される値はnullとなります。 |

## 詳細設定

| プロパティ | 説明 |
| --- | --- |
| Method | コンポーネントは、フォーマット保持暗号化(FPE)方式を使用して、マスクされた出力値を入力値と同じフォーマットで生成します。<br><br>FPE方式は微調整を使用する場合を除き、全単射方式です。<br><br>[Basic] (基本)方式がデフォルトのアルゴリズムです。<br><br>情報メモ注: マスキング方法は強力なので、[Basic] (基本)方式よりもFF1アルゴリズムを使うことをお勧めします。<br><br>[FF1 with AES] (FF1およびAES)方式は、CBCモードではAdvanced Encryption 標準をベースとしています。[FF1 with SHA-2] (FF1およびSHA-2)方式は、セキュアハッシュファンクションHMAC-256に依存します。<br><br>これらのメソッドは、コンポーネントが入力パターンから生成できる可能な値の数が1,000,000以上である場合に限り使用できます。<br><br>情報メモ注: Java 8u161は、[FF1 with AES] (FF1およびAES)方式を使用するために最低限必要なバージョンです。8u161よりも前のJavaバージョンを使ってこのFPE方式を使えるようにするには、Java Cryptography Extension (JCE)無制限強度管轄ポリシーファイルをOracle Webサイトからダウンロードします。<br><br>[FF1 with AES] (FF1およびAES)と[FF1 with SHA-2] (FF1およびSHA-2)の方式では、一意のマスク値を生成するために、[Advanced settings] (詳細設定)の[Password or 256-bit key for FF1 methods] (FF1方式のパスワードまたは256ビットキー)フィールドにパスワードを設定する必要があります。 |
| [FF1 settings] (FF1の設定) | [Password or 256-bit key for FF1 methods] (FF1メソッドのパスワードまたは256ビットキー): [FF1 with AES] (FF1およびAES)方式と[FF1 with SHA-2] (FF1およびSHA-2)方式で一意のマスク値を生成するために必要なパスワードかシークレットキーを設定するために使われます。パスワードを設定しないと、ジョブの実行時に毎回ランダムパスワードが作成されます。[FF1 with AES] (FF1およびAES)方式と[FF1 with SHA-2] (FF1およびSHA-2)方式、そしてパスワードを使っている時、[Seed for random generator] (ランダムジェネレーターをシード)フィールドからのシードは使われません。<br><br>256ビットキーは次のいずれかを使って取得できます。<br><br><ul> <li>オンラインツール</li> <li>OpenSSL: <span>openssl rand -base64 32</span> </li> </ul><br><br>[Use tweaks with FF1 Encryption] (FF1暗号化で微調整を使用): 微調整を使用する場合は、このチェックボックスを選択します。各レコードに対して一意の調整が生成され、レコードのすべてのデータに適用されます。 全単射マスキングが必要な場合は、このフィーチャーを使わないでください。微調整の詳細は、[データマスキングファンクション](https://help.qlik.com/talend/r/ja-JP/8.0/components/data-privacy/data-masking-functions-in-masking-components)をご覧ください。<br><br>[Use a column containing the tweaks] (微調整が含まれているカラムを使用): [Use tweaks with FF1 Encryption] (FF1暗号化で微調整を使用)チェックボックスがオンになっている場合に利用できます。このチェックボックスを選択すると、32桁の16進文字列でなければならない微調整の入カとして入力カラムを使用できます。<br><br>[Column containing the tweaks] (微調整が含まれているカラム): [Use a column containing the tweaks] (微調整が含まれているカラムを使用)チェックボックスがオンの場合に利用できます。微調整が含まれているカラムを選択します。<br><br>[Key derivation function] (キー導出関数): キー導出関数を選択します。反復回数が30万回のPBKDF2を使い、Talend Studio 8.0 R2022-04の実行で作成されたジョブです。<br><br>Talend Studio 8.0 R2022-04より前のジョブをインポートする場合は、30万回の反復回数でこのジョブを実行できます。反復回数が65,536回の場合とは異なる結果となります。 |
| [Seed for random generator] (ランダムジェネレーターをシード) | ジョブの実行ごとに同じサンプルの代替データを生成する場合は、乱数を設定します。シードはデフォルトでは設定されません。<br><br>シードを設定しないと、コンポーネントが各ジョブの実行に対して新しいランダムシードを作成します。シードを変更して実行を繰り返すと、異なるサンプルが生成されます。 |
| [Encoding] (エンコーディング) | リストからエンコーディングを選択するか、[CUSTOM] (カスタム)を選択して、手動で定義します。[Custom] (カスタム)を選択し、フィールドを空のままにすると、サポートされているエンコーディングは使用しているJVMに依存します。このフィールドはファイルエンコーディングには必須です。 |
| 元の行を出力 | このチェックボックスを選択すると、代替データに加えて元のデータ行が出力されます。元のデータと代替データの両方を出力すると、デバッグやテストのプロセスで役に立つ場合があります。 |
| Null入力はnullを返す | このチェックボックスはデフォルトで選択されています。選択すると、入力値がnullの場合、コンポーネントによりnullが出力されます。<br><br>クリアされると、入力データがnullの場合はその入力データが[Invalid] (無効)出力フローに送信されます。<br><br>Talend Studio R2024-08以降、[Null input returns null] (Null入力はnullを返す)が選択され、入力データがNullの場合、マスキングファンクションは適用されずにnullが返され、入力データはメインフローに送信されます。 |
| 空の入力は空の出力を返します | このチェックボックスを選択すると、出力データ内で空の値は変わらずそのままになります。それ以外の場合は、選択したファンクションが入力データに適用されます。 |
| [Send invalid data to "Invalid" output flow] (無効なデータを"無効な"出力フローに送信) | このチェックボックスはデフォルトで選択されています。<br><br><ul> <li>オン: マスク可能な場合は、メインフローに送信されます。それ以外の場合、データは「無効な」出力フローに送信されます。</li> <li>オフ: データはメインフローに送信されます。</li> </ul><br><br><br>無効なデータとは、パターンにマッチしない値のことです。 |

## 使用方法

| 使用方法のガイダンス | 説明 |
| --- | --- |
| **使用ルール** | このコンポーネントは中間ステップとして使用されます。<br><br>このコンポーネントは、所属するSpark Batchのコンポーネントのパレットと共に、Spark Batchジョブを作成している場合にだけ表示されます。 |
| [Spark Connection] (Spark接続) | [Run] (実行)ビューの[Spark configuration] (Spark設定)タブで、ジョブ全体でのSparkクラスターへの接続を定義します。また、ジョブでは、依存jarファイルを実行することを想定しているため、Sparkがこれらのjarファイルにアクセスできるように、これらのファイルの転送先にするファイルシステム内のディレクトリーを指定する必要があります。<br><br><ul> <li> <div> <span>Yarnモード</span>(YarnクライアントまたはYarnクラスター):<ul> <li> <p>Google Dataprocを使用している場合、<span>[Spark configuration] (Spark設定)</span>タブの<span>[Google Storage staging bucket] (Google Storageステージングバケット)</span>フィールドにバケットを指定します。</p> </li> <li> <p>HDInsightを使用している場合、<span>[Spark configuration] (Spark設定)</span>タブの<span>[Windows Azure Storage configuration] (Windows Azure Storage設定)</span>エリアでジョブのデプロイメントに使用するブロブを指定します。</p> </li> <li>Altusを使用する場合は、<span>[Spark configuration] (Spark設定)</span>タブでジョブのデプロイにS3バケットまたはAzure Data Lake Storageを指定します。</li> <li> <p>オンプレミスのディストリビューションを使用する場合は、クラスターで使われているファイルシステムに対応する設定コンポーネントを使用します。一般的に、このシステムはHDFSになるため、<a href="https://help.qlik.com/talend/r/ja-JP/8.0/components/hdfs/thdfsconfiguration">tHDFSConfiguration</a>を使用します。</p> </li> </ul> </div> </li> <li> <p> <span>[Standalone mode] (スタンドアロンモード)</span>: クラスターで使われているファイルシステム(<a href="https://help.qlik.com/talend/r/ja-JP/8.0/components/hdfs/thdfsconfiguration-properties-for-apache-spark-batch">tHDFSConfiguration Apache Spark Batch</a>や<a href="https://help.qlik.com/talend/r/ja-JP/8.0/components/amazon-s3/ts3configuration-properties-for-apache-spark-batch">tS3Configuration Apache Spark Batch</a>など)に対応する設定コンポーネントを使用します。</p> <p>ジョブ内に設定コンポーネントがない状態でDatabricksを使用している場合、ビジネスデータはDBFS (Databricks Filesystem)に直接書き込まれます。</p> </li> </ul><br><br>この接続は、ジョブごとに有効になります。 |