ユーザ作成処理

オペレーション名

ユーザ作成

機能概要

入力データで指定されたユーザをBoxに作成します。

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

https://ja.developer.box.com/reference/post-users/

データモデル

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

プロパティ

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

基本設定

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

必須設定

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

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

スキーマ

入力スキーマ

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>login</column>
    <column>name</column>
    <column>role</column>
    <column>language</column>
    <column>is_sync_enabled</column>
    <column>job_title</column>
    <column>phone</column>
    <column>address</column>
    <column>space_amount</column>
    <column>can_see_managed_users</column>
    <column>timezone</column>
    <column>is_exempt_from_device_limits</column>
    <column>is_exempt_from_login_verification</column>
    <column>status</column>
  </row>
  <row>
    :
  </row>
</table>

要素名	ラベル	説明	必須/省略可	備考
row	-	作成するユーザの件数分だけ繰り返します。
column	login	ユーザがログインに使用するメールアドレスを入力します。	必須
	name	ユーザの名前を入力します。	必須
	role	ユーザのBoxにおける会社のロールを入力します。	省略可	「coadmin」または「user」のいずれかを入力してください。省略した場合、「user」を設定します。
	language	ユーザの言語を入力します。	省略可	「ja」または「en」のいずれかを入力してください。省略した場合、「ja」を設定します。
	is_sync_enabled	ユーザがBox Syncを使用できるかどうかを入力します。	省略可	省略した場合、「true」を設定します。
	job_title	ユーザの役職を入力します。	省略可
	phone	ユーザの電話番号を入力します。	省略可
	address	ユーザの住所を入力します。	省略可
	space_amount	ユーザが利用可能な容量の合計をギガバイト単位で入力します。	省略可	正の整数または「-1」(無制限)を入力してください。省略した場合、「-1」を設定します。
	can_see_managed_users	ユーザが自身の連絡先リストでBoxにおける会社の他のユーザを参照できるかどうかを入力します。	省略可	省略した場合、「true」を設定します。
	timezone	ユーザのタイムゾーンを入力します。	省略可	time zone identifier形式で入力します。例:「Asia/Tokyo」省略した場合、「Asia/Tokyo」を設定します。
	is_exempt_from_device_limits	Boxにおける会社のデバイス制限からユーザを除外するかどうかを入力します。	省略可	省略した場合、「false」を設定します。
	is_exempt_from_login_verification	ユーザが2要素認証を使用する必要があるかどうかを入力します。	省略可	省略した場合、「false」を設定します。
	status	ユーザのアカウントのステータスを入力します。	省略可	「active」「inactive」「cannot_delete_edit」「cannot_delete_edit_upload」のいずれかを入力してください。省略した場合、「active」を設定します。

出力スキーマ

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>result</column>
    <column>login</column>
    <column>status_code</column>
    <column>error_code</column>
    <column>message</column>
    <column>request_id</column>
  </row>
  <row>
    :
  </row>
</table>

要素名	ラベル	説明
row	-	処理に失敗した入力の件数分だけ繰り返します。
column	result	入力が不正な場合は「skipped」、リクエスト実行結果がエラーである場合は「failed」を出力します。
	login	処理に失敗した入力のloginを出力します。
	status_code	resultが「failed」の場合、BoxからのHTTPステータスコードを出力します。
	error_code	resultが「failed」の場合、エラー内容を特定するためのエラーコードを出力します。
	message	エラーメッセージを出力します。
	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 Cloudのバージョンにより、格納される内容が変わる可能性があります。
error_message	エラー発生時、発生したエラーのメッセージが格納されます。	デフォルト値はnullです。 DataSpider Cloudのバージョンにより、格納される内容が変わる可能性があります。
error_trace	エラー発生時、発生したエラーのトレース情報が格納されます。	デフォルト値はnullです。 DataSpider Cloudのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

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

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

主な例外

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