コンテンツダウンロード処理

オペレーション名

コンテンツダウンロード

機能概要

入力データで指定したパスからコンテンツ(ファイルまたはフォルダ)をBoxからダウンロードします。

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

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

データモデル

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

プロパティ

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

基本設定

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

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	グローバルリソースを選択します。グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。 [追加]: 新規にグローバルリソースを追加します。 [一覧の編集]: 「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。

詳細設定

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

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

スキーマ

入力スキーマ

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

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>login</column>
    <column>from_box_content_path</column>
    <column>from_box_content_id</column>
    <column>from_box_content_type</column>
    <column>to_local_folder_path</column>
  </row>
  <row>
    :
  </row>
</table>

要素名	ラベル	説明	必須/省略可	備考
row	-	ダウンロードするコンテンツパスの件数分だけ繰り返します。
column	login	ユーザがログインに使用するメールアドレスを入力します。	必須
	from_box_content_path	ダウンロード元コンテンツのパスを入力します。	必須	[Boxコンテンツの指定方法]が[パス]の場合のみ出現します。フォルダのパスを指定した場合、フォルダ下のコンテンツを再帰的にダウンロードします。パスの形式については、「制限事項」を参照してください。「/」を指定することはできません。
	from_box_content_id	ダウンロード元コンテンツのIDを入力します。	必須	[Boxコンテンツの指定方法]が[ID]の場合のみ出現します。フォルダのIDを指定した場合、フォルダ下のコンテンツを再帰的にダウンロードします。「0」を指定することはできません。
	from_box_content_type	ダウンロード元コンテンツの種別(ファイルまたはフォルダ)を入力します。「file」:ファイル「folder」:フォルダ	必須	[Boxコンテンツの指定方法]が[ID]の場合のみ出現します。
	to_local_folder_path	ダウンロード先フォルダのパスを入力します。	必須	存在しないフォルダのパスを指定した場合、新規に作成します。ファイルのダウンロードにおいて同名のファイルがDataSpiderファイルシステム上に存在する場合、Boxの「変更日」(content_modified_at)とDataSpiderファイルシステムの更新日時とを比較し、前者の方が新しい場合のみダウンロードを実行します。パスはDataSpiderファイルシステムの絶対パスで指定してください。「/data」下のパスを指定することを推奨します。コンテンツ名に使用できない形式については、「制限事項」を参照してください。

出力スキーマ

[Boxコンテンツの指定方法]と[成功した処理も結果データに出力する]の設定により、カラム数および内容が異なります。

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>result</column>
    <column>login</column>
    <column>from_box_content_path</column>
    <column>from_box_content_id</column>
    <column>from_box_content_type</column>
    <column>to_local_folder_path</column>
    <column>downloaded_content_path</column>
    <column>downloaded_content_type</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を出力します。
	from_box_content_path	処理した入力のfrom_box_content_pathを出力します。	[Boxコンテンツの指定方法]が[パス]の場合のみ出現します。
	from_box_content_id	処理した入力のfrom_box_content_idを出力します。	[Boxコンテンツの指定方法]が[ID]の場合のみ出現します。
	from_box_content_type	処理した入力のfrom_box_content_typeを出力します。	[Boxコンテンツの指定方法]が[ID]の場合のみ出現します。
	to_local_folder_path	処理した入力のto_local_folder_pathを出力します。
	downloaded_content_path	ダウンロードしたコンテンツのパスを出力します。	[成功した処理も結果データに出力する]が[チェックあり]の場合のみ出現します。
	downloaded_content_type	ダウンロードしたコンテンツの種別を出力します。	[成功した処理も結果データに出力する]が[チェックあり]の場合のみ出現します。
	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のバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

入力データを1件ずつ処理を実行し確定します。そのため、処理中にエラーが発生した場合でも、それまでのデータは反映されます。

処理中にエラーが発生した場合、入力データの一部とエラーの詳細を結果データに出力し、処理を継続します。

主な例外

例外名	原因	対策
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[]	[接続先]が指定されていません。	[接続先]を指定してください。
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]	[接続先]で選択されたリソース定義が見つかりません。	[接続先]で指定したグローバルリソースを確認してください。