# Apache Spark Ba​​tchのtDataMaskingプロパティ

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

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

このフレームワークのコンポーネントは、すべてのビッグデータ対応の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><span>情報メモ</span><span>要確認:</span> <span>Dynamic</span>データ型を選択する時は次の点に注意してください: <ul> <li>データマスキングファンクションはダイナミックカラムの各データに適用されます。たとえばデータのカラムが<kbd>name</kbd>、<kbd>address</kbd>、<kbd>email</kbd>であれば、データマスキングファンクションは全体としてではなく各カラムのデータに個別に適用されます。</li> <li>ダイナミックカラムのデータ型が一部のデータマスキングファンクションと互換性がない場合、ジョブは失敗します。たとえば、<span>Email Masking</span>ファンクションは<kbd>Integer</kbd>データ型と互換性がありません。</li> <li>一部のデータマスキングファンクションは入力データを検証します。レコードの少なくとも1つのデータがマスキングできない場合、そのレコードは無効な出力フローに進みます。</li> </ul></div> <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>[Input Column] (入力カラム): マスクするデータを含む入力フローからカラムを選択します。<br><br>サポートされているデータ型は、Date、Double、Float、Integer、Long、Stringです。<br><br>これらの変更は、[Function] (ファンクション)カラムで選択するファンクションに基づいています。<br><br>[Category] (カテゴリー): マスキングファンクションのカテゴリーをリストから選択します。<br><br><ul> <li> <span>[Character Handling] (文字処理)</span> </li> <li> <span>[Data Handling] (データ処理)</span> </li> <li> <span>[Number Handling] (番号処理)</span> </li> <li> <span>[Bank Account Generation] (銀行口座の生成)</span> </li> <li> <span>[Data Generation] (データ生成)</span> </li> <li> <span>[Phone Number generation] (電話番号の生成)</span> </li> <li> <span>[SSN Generation] (SSNの生成)</span> </li> <li> <span>[Bank Account Masking] (銀行口座のマスキング)</span> </li> <li> <span>[Address Masking] (アドレスのマスキング)</span> </li> <li> <span>[Email Masking] (メールのマスキング)</span> </li> <li> <span>[Credit Card Masking] (クレジットカードのマスキング)</span> </li> <li> <span>[Phone Masking] (電話番号のマスキング)</span> </li> <li> <span>[SSN Masking] (SSNのマスキング)</span> </li> <li> <span>[Set to Null] (Nullに設定)</span> </li> </ul><br><br>[Function] (ファンクション): 元のデータを非表示にする、または代用のデータで難読化するファンクションを選択します。たとえば、数値や文字を任意の代用データに置換したり、インデックスファイル内のシノニムに置換したり、値をNullにしたりできます。<br><br>[Function] (ファンクション)リストから選択できるファンクションは、入力カラムのデータ型によって異なります。<br><br>たとえば、カラムタイプがLongの場合は、Numeric varianceファンクションが使えます。カラムタイプがStringの場合、Numeric varianceファンクションは使えません。また、[Date] (日付)カラムの[Function] (ファンクション)リストは日付に固有で、日付値に対して行う変更のタイプを決定できます。<br><br>[Method] (方式): [Basic] (基本)方式または1つのFF1アルゴリズム (フォーマット保持暗号化(FPE))を選択し、[FF1 with AES] (FF1およびAES)または[FF1 with SHA-2] (FF1およびSHA-2)を選択します。<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>情報メモ注: 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ビットキー)フィールドにパスワードを設定する必要があります。<br><br>[Alphabet] (アルファベット)リストは、フォーマット保持暗号化アルゴリズムを使うファンクションでのみ利用できます。<br><br>FPEメソッドと共に[Character handling] (文字処理)ファンクション(たとえば[Replace all] (すべて置換)、[Replace characters between two positions] (2つのポジション間の文字を置換)、[Replace all digits] (すべての桁を置換)など)を使う時は、アルファベットを選択する必要があります。<br><br>選択したアルファベットに属する文字は、選択したアルファベット内の同じ文字タイプの文字でマスクされます。<br><br>[Best guess] (最も妥当と思われるもの)アルファベットを選択している時は、マスク値には入力値に表示されるすべてのアルファベットからの文字が含まれます。[Best guess] (最も妥当と思われるもの)はデフォルトのアルファベットです。<br><br>認識されていない文字はそのまま出力にコピーされます。<br><br>[Extra Parameter] (追加パラメーター): このフィールドは一部のファンクションで使用されますが、使用されない場合は無効になります。必要に応じて、選択したファンクションの動作を決定するための数値または文字を入力します。<br><br>[Function] (ファンクション)を[Generate from file/list] (ファイル/リストから生成)に設定する場合は、[Extra Parameter] (追加パラメーター)でファイルパスを定義します。ファイルパスを次のように設定します。<br><br><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> </ul><br><br>[Keep format] (保存形式): このファンクションは文字列でのみ使用されます。このチェックボックスを選択すると、[Generate account number and keep original country] (口座番号を生成して元の国を保持)、[Generate credit card number and keep original bank] (クレジットカード番号を生成し、元の銀行を保持)、[Bank Account Masking] (銀行口座のマスキング)、[Credit Card Masking] (クレジットカードのマスキング)、[Phone Masking] (電話のマスキング)、[SSN Masking] (SSNのマスキング)ファンクションまたはカテゴリーによる入力形式が保持されます。つまり、入力にスペース、ドット('.')、ハイフン('-')、スラッシュ('/')のいずれかが含まれる場合、それらの文字は出力でも保持されます。このチェックボックスを選択すると、[Phone Masking] (電話のマスキング)ファンクションを使う時に、入力に含まれている数値以外の文字が出力にそのままコピーされます。 |

## 詳細設定

| プロパティ | 説明 |
| --- | --- |
| [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>このフィールドはLongタイプです。値の範囲は [-2^63^、2^63^-1].<br><br>シードを設定しないと、コンポーネントが各ジョブの実行に対して新しいランダムシードを作成します。シードを変更して実行を繰り返すと、異なるサンプルが生成されます。 |
| [Encoding] (エンコーディング) | リストからエンコーディングを選択するか、[CUSTOM] (カスタム)を選択して、手動で定義します。[Custom] (カスタム)を選択し、フィールドを空のままにすると、サポートされているエンコーディングは使用しているJVMに依存します。このフィールドはファイルエンコーディングには必須です。 |
| 元の行を出力 | このチェックボックスを選択すると、代替データに加えて元のデータ行が出力されます。元のデータと代替データの両方を出力すると、デバッグやテストのプロセスで役に立つ場合があります。 |
| Null入力はnullを返す | このチェックボックスはデフォルトで選択されています。選択すると、入力値がnullの場合、コンポーネントによりnullが出力されます。<br><br>クリアされると、入力データがnullの場合にマスキングファンクションが適用されます:<br><br><ul> <li>入力データを検証しないファンクション(文字処理ファンクション、住所マスキングファンクション、数値分散ファンクション)は、データ型に応じてデフォルト値を返します:<ul> <li>文字列: 空の出力。</li> <li>数値入力: <samp>0</samp>。</li> </ul> <p>日付分散ファンクションの場合、出力される日付はジョブが実行された日付になります。</p> </li> <li>生成ファンクションによって新しい値が生成されます。データはメインフローに送信されます。</li> <li>検証ファンクション(メールマスキング、電話マスキング、クレジットカードマスキング、SSNマスキング、銀行口座マスキング)は、値を検証できません。データは「無効な」出力フローに送信されます。</li> </ul><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><ul> <li>使う<span>方法</span>に関係なく、SSN、電話番号、またはメールアドレスの形式が正しくありません。</li> <li>これらは、<a href="https://help.qlik.com/talend/r/ja-JP/8.0/components/data-privacy/data-masking-functions-in-masking-components"><span>[FF1 with AES] (FF1およびAES)</span>と<span>[FF1 with SHA-2] (FF1およびSHA-2)</span>メソッド</a>には準拠していません。</li> </ul> |

## 使用方法

| 使用方法のガイダンス | 説明 |
| --- | --- |
| **使用ルール** | このコンポーネントは中間ステップとして使用されます。<br><br>このコンポーネントは、所属するSpark Batchのコンポーネントのパレットと共に、Spark Batchジョブを作成している場合にだけ表示されます。<br><br>特に明記していない限り、このドキュメンテーションのシナリオでは、標準ジョブ、つまり従来の Talend Data Integrationジョブだけを扱います。 |
| [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>この接続は、ジョブごとに有効になります。 |