メタデータ読み取り処理

オペレーション名

メタデータ読み取り

機能概要

入力データで指定したBoxのコンテンツ(ファイルまたはフォルダ)のメタデータを読み取ります。

本コンポーネントが使用するAPI仕様については、以下のBox APIリファレンスを参照してください。

https://ja.developer.box.com/reference/get-files-id-metadata-id-id/
https://ja.developer.box.com/reference/get-folders-id-metadata-id-id/

データモデル

本コンポーネントのデータモデルはテーブルモデル型です。

プロパティ

変数の使用については、「変数」を参照してください。

基本設定

項目名	必須/省略可	変数の使用	説明	備考
名前	必須	使用不可	スクリプトキャンバス上での名前を入力します。
入力データ	必須	使用不可	スクリプトキャンバス上にあるコンポーネントを選択します。

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	グローバルリソースを選択します。グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。 [追加]: 新規にグローバルリソースを追加します。 [一覧の編集]: 「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
メタデータテンプレート名	必須	使用可	コンテンツに適用されたメタデータテンプレート名を選択または入力します。
メタデータフィールド一覧	必須	-	[メタデータテンプレート名]で指定したメタデータテンプレートのメタデータフィールドを表示します。	[メタデータフィールド一覧]で表示されたメタデータフィールドの中で、[読み取り対象]にチェックを入れたメタデータフィールドの[表示名]がMapperのスキーマに表示されます。
メタデータフィールド一覧/読み取り対象	省略可	使用不可	[メタデータテンプレート名]で指定したメタデータテンプレートの各メタデータフィールドを、読み取り対象フィールドに含めるかどうかを選択します。 [チェックあり]:(デフォルト) 読み取り対象に含めます。 [チェックなし]: 読み取り対象に含めません。	チェックを入れたメタデータフィールドの表示名がMapperのスキーマに表示されます。ヘッダに表示されたチェックボックスを押下することで、一括操作を行うことができます。 1つ以上のメタデータフィールドにチェックが入っている必要があります。
メタデータフィールド一覧/表示名	必須	使用不可	メタデータフィールドの表示名を表示します。
メタデータフィールド一覧/タイプ	必須	使用不可	メタデータフィールドのタイプを表示します。	「<タイプ> (<内部データ型>)」形式で表示されます。タイプ: Box APIで使用しているメタデータフィールドのタイプです。詳細については、「サポートするメタデータフィールドのタイプ」を参照してください。内部データ型: DataSpider内部で使用しているデータ型です。詳細については、「内部データ型」を参照してください。

プロパティアクション

項目名	説明	備考
メタデータテンプレート名一覧の更新	指定した接続先にあるメタデータテンプレートを取得して、[メタデータテンプレート名]に設定します。	[接続先]を変更した場合、本プロパティアクションを使用することでその変更を反映させることができます。 [接続先]が選択されている場合、有効になります。
メタデータフィールド一覧の更新	指定したメタデータテンプレートのメタデータフィールドを取得して、[メタデータフィールド一覧]に表示します。	[メタデータテンプレート名]を変更した場合、本プロパティアクションを使用することでその変更を反映させることができます。 [接続先]および[メタデータテンプレート名]が選択されている場合、有効になります。

詳細設定

項目名	必須/省略可	変数の使用	説明	備考
ユーザ情報の取得方法	必須	使用不可	入力スキーマloginで指定されたユーザの情報を取得する方法を指定します。 [一括]:(デフォルト) 処理開始時に、[接続先]で指定した接続先に存在するBoxユーザの情報を一括で取得します。 [ユーザごと]: Boxユーザの情報を入力データで指定したユーザごとに取得します。	Box上の管理対象ユーザが多い場合、[一括]を選択すると、ユーザ情報の取得に時間がかかり、処理時間が長くなります。その場合、入力データに指定するユーザ数が少なければ、[ユーザごと]を選択することで処理時間を短縮できます。
Boxコンテンツの指定方法	必須	使用不可	Boxコンテンツの指定方法を選択します。 [パス]:(デフォルト) Boxコンテンツをパスで指定します。 [ID]: BoxコンテンツをIDで指定します。

項目名	必須/省略可	変数の使用	説明	備考
コメント	省略可	使用不可	このアダプタの簡単な説明を記述することができます。説明を記述すると、仕様書に反映させることができます。

スキーマ

入力スキーマ

[Boxコンテンツの指定方法]の設定により、カラム数および内容が異なります。

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>login</column>
    <column>box_content_path</column>
    <column>box_content_id</column>
    <column>box_content_type</column>
  </row>
  <row>
    :
  </row>
</table>

要素名	ラベル	説明	必須/省略可	備考
row	-	メタデータを読み取るコンテンツの件数分だけ繰り返します。
column	login	ユーザがログインに使用するメールアドレスを入力します。	必須
	box_content_path	メタデータを読み取るコンテンツのパスを入力します。	必須	[Boxコンテンツの指定方法]が[パス]の場合のみ出現します。パスの形式については、「制限事項」を参照してください。「/」を指定することはできません。
	box_content_id	メタデータを読み取るコンテンツのIDを入力します。	必須	[Boxコンテンツの指定方法]が[ID]の場合のみ出現します。「0」を指定することはできません。
	box_content_type	メタデータを読み取るコンテンツの種別(ファイルまたはフォルダ)を入力します。「file」:ファイル「folder」:フォルダ	必須	[Boxコンテンツの指定方法]が[ID]の場合のみ出現します。

出力スキーマ

[メタデータフィールド一覧]や[Boxコンテンツの指定方法]の設定により、カラム数および内容が異なります。

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>result</column>
    <column>login</column>
    <column>box_content_path</column>
    <column>box_content_id</column>
    <column>box_content_type</column>
    <column>メタデータフィールド</column>
      :
    <column>status_code</column>
    <column>error_code</column>
    <column>message</column>
    <column>request_id</column>
  </row>
  <row>
    :
  </row>
</table>

要素名	ラベル	説明	備考
row	-	処理した入力の件数分だけ繰り返します。
column	result	リクエスト実行結果が正常である場合は「succeeded」、入力が不正な場合は「skipped」、リクエスト実行結果がエラーである場合は「failed」を出力します。
	login	処理した入力のloginを出力します。
	box_content_path	処理した入力のbox_content_pathを出力します。	[Boxコンテンツの指定方法]が[パス]の場合のみ出現します。
	box_content_id	処理した入力のbox_content_idを出力します。	[Boxコンテンツの指定方法]が[ID]の場合のみ出現します。
	box_content_type	処理した入力のbox_content_typeを出力します。	[Boxコンテンツの指定方法]が[ID]の場合のみ出現します。
	メタデータフィールド	[読み取り対象]にチェックを入れたメタデータフィールドを出力します。	[読み取り対象]にチェックを入れたメタデータフィールドごとに出現します。 [タイプ]がmultiSelectのメタデータフィールドに複数の値が存在する場合、「,」(半角カンマ)で連結された値が格納されます。
	status_code	resultが「failed」の場合、BoxからのHTTPステータスコードを出力します。
	error_code	resultが「failed」の場合、エラー内容を特定するためのエラーコードを出力します。
	message	resultが「skipped」または「failed」の場合、エラーメッセージを出力します。
	request_id	resultが「failed」の場合、Boxに対するリクエストを一意に識別するIDを出力します。

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。

詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応していません。

トランザクション

トランザクションはサポートしていません。

PSPでの使用について

PSPでは使用できません。

使用できるコンポーネント変数

コンポーネント変数名	説明	備考
succeeded_count	処理に成功した入力の件数が格納されます。	デフォルト値は0です。
failed_count	処理に失敗した入力の件数が格納されます。	デフォルト値は0です。
skipped_count	処理をスキップした入力の件数が格納されます。	デフォルト値は0です。
message_category	エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。	デフォルト値はnullです。
message_code	エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。	デフォルト値はnullです。
message_level	エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。	デフォルト値はnullです。
error_type	エラー発生時、発生したエラーの種類が格納されます。	デフォルト値はnullです。エラーの種類は、以下のような形式となります。例:「java.io.FileNotFoundException」 DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_message	エラー発生時、発生したエラーのメッセージが格納されます。	デフォルト値はnullです。 DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_trace	エラー発生時、発生したエラーのトレース情報が格納されます。	デフォルト値はnullです。 DataSpider Servistaのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

同名メタデータテンプレートおよび同名メタデータフィールドは使用できません。

主な例外

例外名	原因	対策
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[]	[接続先]が指定されていません。	[接続先]を指定してください。
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]	[接続先]で選択されたリソース定義が見つかりません。	[接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException 必須項目 <プロパティ名> が入力されていません。	[<プロパティ名>]が入力されていません。	[<プロパティ名>]を入力してください。
InvalidPropertyConfigurationException 項目メタデータテンプレート名には有効なメタデータテンプレート名を入力してください。	[メタデータテンプレート名]が有効ではありません。	Boxに存在する[メタデータテンプレート名]を指定してください。
InvalidPropertyConfigurationException メタデータテンプレートに定義されていないメタデータフィールドが読み取り対象に指定されています。表示名:<表示名>	[読み取り対象]にチェックを入れたメタデータフィールドが[メタデータテンプレート名]で指定したメタデータテンプレートに定義されていません。	[メタデータフィールド一覧の更新]を実行し、再度[読み取り対象]にチェックを入れてください。
InvalidPropertyConfigurationException 読み取り対象フィールドが選択されていません。	[メタデータフィールド一覧]の[読み取り対象]が選択されていません。	[メタデータフィールド一覧]の[読み取り対象]を1つ以上選択してください。