コンテンツ移動処理

オペレーション名

コンテンツ移動

機能概要

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

= 備考 =

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

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

データモデル

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

プロパティ

= 備考 =

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

基本設定

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

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	コネクションリソースを選択します。 [追加] 新規にコネクションリソースを追加します。 [一覧の編集] > HULFT INTEGRATE > コネクションで、コネクションリソースの設定を編集することができます。

項目名

必須/省略可

変数の使用

説明

備考

接続先

必須

使用不可

コネクションリソースを選択します。

[追加]: 新規にコネクションリソースを追加します。
[一覧の編集]: > HULFT INTEGRATE > コネクションで、コネクションリソースの設定を編集することができます。

詳細設定

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

項目名

必須/省略可

変数の使用

説明

備考

ユーザ情報の取得方法

必須

使用不可

入力スキーマ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>to_box_folder_path</column>
    <column>from_box_content_id</column>
    <column>from_box_content_type</column>
    <column>to_box_folder_id</column>
    <column>new_name</column>
  </row>
  <row>
    :
  </row>
</table>

要素名	ラベル	説明	必須/省略可	備考
row	-	移動するコンテンツの件数分だけ繰り返します。
column	login	ユーザがログインに使用するメールアドレスを入力します。	必須
	from_box_content_path	移動元のコンテンツのパスを入力します。	必須	注意 [Boxコンテンツの指定方法]が[パス]の場合に使用します。パスの形式については、「BOXカテゴリの制限事項」を参照してください。「/」を指定することはできません。フォルダのパスを指定した場合、フォルダ下のコンテンツを再帰的に移動します。
	to_box_folder_path	移動先のフォルダのパスを入力します。	必須	注意 [Boxコンテンツの指定方法]が[パス]の場合に使用します。パスの形式については、「BOXカテゴリの制限事項」を参照してください。存在しないフォルダのパスを指定した場合、新規に作成します。
	from_box_content_id	移動元のコンテンツのIDを入力します。	必須	注意 [Boxコンテンツの指定方法]が[ID]の場合に使用します。フォルダのIDを指定した場合、フォルダ下のコンテンツを再帰的に移動します。
	from_box_content_type	移動元のコンテンツの種別(ファイルまたはフォルダ)を入力します。 file ファイル folder フォルダ	必須	注意 [Boxコンテンツの指定方法]が[ID]の場合に使用します。
	to_box_folder_id	移動先のフォルダのIDを入力します。	必須	注意 [Boxコンテンツの指定方法]が[ID]の場合に使用します。
	new_name	移動先コンテンツの名前を入力します。	省略可	注意移動するコンテンツと同名のコンテンツが移動先に存在する場合、エラーが発生します。コンテンツ名に使用できない形式については、「BOXカテゴリの制限事項」を参照してください。省略した場合、移動元のコンテンツ名が設定されます。

出力スキーマ

注意

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

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>result</column>
    <column>login</column>
    <column>from_box_content_path</column>
    <column>to_box_folder_path</column>
    <column>from_box_content_id</column>
    <column>from_box_content_type</column>
    <column>to_box_folder_id</column>
    <column>new_name</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コンテンツの指定方法]が[パス]の場合に使用します。
	to_box_folder_path	処理した入力のto_box_folder_pathを出力します。	注意 [Boxコンテンツの指定方法]が[パス]の場合に使用します。
	from_box_content_id	処理した入力のfrom_box_content_idを出力します。	注意 [Boxコンテンツの指定方法]が[ID]の場合に使用します。
	from_box_content_type	処理した入力のfrom_box_content_typeを出力します。	注意 [Boxコンテンツの指定方法]が[ID]の場合に使用します。
	to_box_folder_id	処理した入力のto_box_folder_idを出力します。	注意 [Boxコンテンツの指定方法]が[ID]の場合に使用します。
	new_name	処理した入力のnew_nameを出力します。
	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」
error_message	エラー発生時、発生したエラーのメッセージが格納されます。	デフォルト値はnullです。
error_trace	エラー発生時、発生したエラーのトレース情報が格納されます。	デフォルト値はnullです。

メッセージコード、例外メッセージ、制限事項

コネクター	メッセージコード	例外メッセージ	制限事項
Box コネクターのメッセージおよび制限事項