# tBoxv2List

Boxの指定フォルダーにあるファイルやフォルダーに関する情報をリスト表示します。

このコンポーネントは、Boxフォルダーにあるファイルやフォルダーのメタデータとコンテンツをリスト表示します。

## tBoxv2Listの標準プロパティ

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

標準のtBoxv2Listコンポーネントは、Cloudファミリーに属しています。

このフレームワーク内のコンポーネントは、すべてのサブスクリプションベースのTalend製品で利用できます。

情報メモ注: このコンポーネントは、Talendが提供する8.0.1-R2023-04以降のTalend Studioマンスリーアップデートをインストール済みである場合のみ利用できます。詳細は管理者にお問い合わせください。

## 基本設定

| プロパティ | 説明 |
| --- | --- |
| [Property type] (プロパティタイプ) | [Built-in] (組み込み)と[Repository] (リポジトリー)のいずれかです。<br><br><ul> <li> <span>[Built-In] (組み込み)</span>: 一元的に保存されるプロパティデータはありません。</li> <li> <span>[Repository] (リポジトリー)</span>: プロパティが保存されているリポジトリーファイルを選択します。次のフィールドは、取得したデータを使用して自動的に完了されます。</li> </ul><br><br>このドロップダウンリストは、[Use an existing connection] (既存の接続を使用)オプションが選択されている場合は利用できません。 |
| [Use an existing connection] (既存の接続を使用) | 定義済みの接続の詳細を再利用する場合は、このチェックボックスをオンにして、[Component List] (コンポーネントリスト)ドロップダウンリストから、目的の接続コンポーネントを選択します。 |
| [Authentication type] (認証タイプ) | 認証タイプとして、JWT (JSON Web Tokenの省略形)と開発者トークンのいずれかを選択します。<br><br>JWT認証タイプの該当するフィールドに、次のパラメーターを入力する必要があります。<br><br><ul> <li><span>[Client ID] (クライアントID)</span>と<span>[Client secret] (クライアントシークレット)</span>: Box APIへのアクセスで、Boxから求められるクライアンキーとクライアントシークレットを入力します。クライアントキーとクライアントシークレットを取得するためには、<a href="https://developers.box.com/" target="_blank">https://developers.box.com/</a>でアカウントを作成し、使用するBoxアカウントの下にBoxアプリを作成する必要があります。クライアントキーとクライアントシークレットは、アカウントアプリケーションの設定から取得できます。</li> <li><span>[Public key ID] (パブリックキーID)</span></li> <li><span>[Private key] (プライベートキー)</span></li> <li><span>[Private key passphrase] (プライベートキーのパスフレーズ)</span></li> <li><span>[Enterprise ID] (エンタープライズID)</span>または<span>[User ID] (ユーザーID)</span></li> </ul><br><br><br>JWT認証の詳細は、[JWT Auth](https://developer.box.com/guides/authentication/jwt/)をご覧ください。<br><br>情報メモ注: クライアントシークレット、プライベートキー、プライベートキーのパスフレーズを入力するためには、該当するフィールドの横にある[...]ボタンをクリックして[Enter a new password] (新しいパスワードを入力)ダイアログボックスを表示させ、テキストフィールドにプライベートキーを入力して[OK]をクリックします。このキーは、[pure password] (純粋なパスワード)モードではJSON文字列で、[Java mode] (Javaモード)ではJava式として入力できます。テキストフィールドの上部にある[switch to Java mode] (Javaモードに切り替え)または[switch to pure password mode] (純粋なパスワードに切り替え)をクリックすることで、2つのモードの間で切り替えられます。<br><br>ドロップダウンリストから、[Developer token] (開発者トークン)を選択した場合は、[Developer token] (開発者トークン)フィールドに開発者トークンを入力します。開発者トークンの詳細は、[Developer Tokens](https://developer.box.com/guides/authentication/tokens/developer-tokens/)をご覧ください。<br><br>[Authentication type] (認証タイプ)ドロップダウンリストは、[Use an existing connection] (既存の接続を使用)が選択されていない場合に利用できます。 |
| [Schema] (スキーマ)と[Edit schema] (スキーマを編集) | スキーマとは行の説明のことです。処理して次のコンポーネントに渡すフィールド(カラム)数を定義します。Sparkジョブを作成する場合、フィールドの命名時は予約語のlineを避けます。<br><br>[Built-in] (組み込み): そのコンポーネントに対してのみスキーマを作成し、ローカルに保管します。<br><br>[Repository] (リポジトリー): スキーマは作成済みで、リポジトリーに保管されています。さまざまなプロジェクトやジョブデザインで再利用できます。<br><br>スキーマを変更するには[Edit schema] (スキーマを編集)をクリックします。現在のスキーマがリポジトリータイプの場合は、3つのオプションを利用できます。<br><br><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> |
| [Guess Schema] (推測スキーマ) | このボタンをクリックすると、設定に応じたスキーマを取得できます。 |
| [Box remote path] (Boxリモートパス) | Boxパスを入力します。Boxのパス下にあるファイルやフォルダーの情報がリスト表示されます。<br><br>Boxパスは、このフィールドの横にある[...]ボタンをクリックし、そのフォルダーに移動して指定することもできます。<br><br>このオプションは、[Advanced settings] (詳細設定)ビューの[Get folder by ID] (IDでフォルダーを取得)オプションが選択されていない場合に利用できます。 |
| Box ID | リスト表示するファイル情報が含まれているフォルダーのBox IDを入力します。<br><br>Box IDは、このフィールドの横にある[...]ボタンをクリックし、そのフォルダーに移動して指定することもできます。<br><br>このオプションは、[Advanced settings] (詳細設定)ビューの[Get folder by ID] (IDでフォルダーを取得)オプションが選択されている場合に利用できます。 |
| [List type] (リストタイプ) | 情報をリスト表示するオブジェクトのタイプとして、[Files] (ファイル)、[Folders] (フォルダー)、[Both] (両方)のいずれかを選択します。 |
| [Include subfolders] (サブフォルダーを含める) | このオプションを選択すると、指定されたBoxフォルダーのサブフォルダーにあるオブジェクトの情報もリスト表示できます。 |

## 詳細設定

| プロパティ | 説明 |
| --- | --- |
| [tStatCatcher Statistics] (tStatCatcher統計) | このチェックボックスをオンにすると、コンポーネントレベルでログデータを収集できます。 |
| [Fetch more information] (その他の情報をフェッチ) | このオプションを選択すると、指定されたフォルダーにあるオブジェクトに関するより詳細な情報を取得できます。これは、スキーマに余分なカラムを追加することで実行されます。<br><br>このオプションが選択されなかった場合、[Guess schema] (推測スキーマ)ボタンをクリックした後に生成されるスキーマにはID、NAME、RELATIVE\_PATH、TYPEという4つのカラムが含まれます 。このオプションが選択された場合、同じ操作で生成されるスキーマにはID、NAME、RELATIVE\_PATH、ABSOLUTE\_PATH、LAST\_MODIFIED、MODIFIED\_BY、SIZEというカラムが含まれます。 |
| [Get folder by ID] (IDでフォルダーを取得) | このオプションを選択すると、フォルダーをBox IDで指定できます。 |

## グローバル変数

| 変数 | 説明 |
| --- | --- |
| グローバル変数 | ERROR\_MESSAGE: エラーが発生した時にコンポーネントによって生成されるエラーメッセージ。これはAfter変数で、文字列を返します。この変数はコンポーネントにこのチェックボックスが存在し、[Die on error] (エラー発生時に強制終了)がオフになっている場合のみ機能します。<br><br>Flow変数はのコンポーネントの実行中に機能し、After変数はコンポーネントの実行後に機能します。<br><br>フィールドまたは式に変数を入力する場合は、Ctrl + スペースを押して変数リストにアクセスし、使用する変数を選択します。<br><br>変数の詳細は、[コンテキストと変数を使用](https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/contexts-and-variables)をご覧ください。 |

## 使用方法

| 使用方法のガイダンス | 説明 |
| --- | --- |
| **使用ルール** | このコンポーネントは、単独で、または[Iterate] (反復処理)リンクや、OnSubjobOKなどのトリガーリンクを介して、他のコンポーネントと共に使えます。 |