エンティティ削除処理

オペレーション名

エンティティ削除

機能概要

エンティティを削除します。

データモデル

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

プロパティ

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

基本設定

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

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	グローバルリソースを選択します。 [追加]: 新規にグローバルリソースを追加します。 [一覧の編集]: 「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。	グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。
認証	必須	使用不可	グローバルリソースを選択します。 [追加]: 新規にグローバルリソースを追加します。 [一覧の編集]: 「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。	各Dynamics 365 for Customer Engagementアダプタ固有のグローバルリソースの設定方法については、「Dynamics 365 for Customer Engagementアダプタの制限事項」を参照してください。
リソースパス	必須	使用可	リソースパスを選択または入力します。	各Dynamics 365 for Customer Engagementアダプタ固有のリソースパスの設定方法については、「Dynamics 365 for Customer Engagementアダプタの制限事項」を参照してください。
フィールド表示名を取得する	省略可	使用不可	[フィールド定義]を更新するときにフィールド表示名を取得するかどうかを選択します。 [チェックあり]: フィールド表示名を取得します。 [チェックなし]: (デフォルト) フィールド表示名を取得しません。	フィールド表示名を取得すると[フィールド定義を更新]に時間がかかる場合があります。
フィールド定義	必須	-	[リソースパス]で指定したエンティティのフィールド定義を表示します。
フィールド定義/キー	必須	使用不可	[フィールド名]がキーであるかを表示します。 [チェックあり]: キーとして利用します。 [チェックなし]: (デフォルト) キーとして利用しません。
フィールド定義/フィールド名	必須	使用不可	[リソースパス]で指定したエンティティのフィールド名を表示します。
フィールド定義/フィールド表示名	省略可	使用不可	[リソースパス]で指定したエンティティのフィールド表示名を表示します。
フィールド定義/型	必須	使用不可	[フィールド名]の型を表示します。

プロパティアクション

項目名	説明	備考
エンティティセット名一覧を更新	指定した[接続先]からエンティティセット名を取得して、[リソースパス]に設定します。	[接続先]および[認証]が選択されている場合、有効になります。
フィールド定義を更新	指定した[接続先]および[リソースパス]からフィールド定義を取得して、[フィールド定義]に設定します。	[接続先]および[認証]が選択されており、[リソースパス]を指定した場合、有効になります。

オプション設定

項目名	必須/省略可	変数の使用	説明	備考
処理に失敗したエンティティをスキップする	省略可	使用不可	処理に失敗したエンティティをスキップして処理を継続するかどうかを選択します。 [チェックあり]: 削除に失敗したアイテムをスキップして削除処理を継続します。 [チェックなし]: (デフォルト) 削除に失敗したアイテムが発生した場合、エラーとして削除処理を終わらせます。

データ処理方式

項目名	必須/省略可	変数の使用	説明	備考
データ処理方式	必須	使用不可	データ処理方式を選択します。 [スクリプトの設定を使用する]:(デフォルト) スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。 [大容量データ処理を行わない]: 大容量データ処理を行いません。 [大容量データ処理を行う]: 大容量データ処理を行います。

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

スキーマ

入力スキーマ

[フィールド定義]の設定により、カラム数が異なります。

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>キー</column>
      :
  </row>
  <row>
    :
  </row>
</table>

要素名	列名/ラベル	説明	備考
row	-	削除するエンティティの件数だけ繰り返します。
column	キー	削除するエンティティのキーを入力します。

スキーマ構造については、「テーブルモデル型のスキーマ」を参照してください。

出力スキーマ

[フィールド定義]の設定により、カラム数が異なります。

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>キー</column>
      :
    <column>status_code</column>
    <column>message</column>
    <column>error_type</column>
  </row>
  <row>
    :
  </row>
</table>

要素名	列名/ラベル	説明	備考
row	-	削除するエンティティの件数だけ繰り返します。
column	キー	エンティティのキーを出力します。
	status_code	エンティティ削除のHTTPステータスコードを出力します。
	message	エンティティ削除のメッセージを出力します。
	error_type	エラー発生時、発生したエラーの種類が格納されます。	デフォルト値はnullです。エラーの種類は、以下のような形式となります。例:「java.io.FileNotFoundException」

スキーマ構造については、「テーブルモデル型のスキーマ」を参照してください。

Mapperでのスキーマ読み込み

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

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

大容量データ処理

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

トランザクション

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

PSPでの使用について

PSPでは使用できません。

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

コンポーネント変数名	説明	備考
count	読み取ったデータの件数が格納されます。	デフォルト値はnullです。
delete_count	削除したデータの件数が格納されます。	デフォルト値はnullです。
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のバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

各Dynamics 365 for Customer Engagementアダプタ固有の仕様制限については、「Dynamics 365 for Customer Engagementアダプタの制限事項」を参照してください。

主な例外

例外名	原因	対策
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[]	[接続先]または[認証]が指定されていません。	[接続先]または[認証]を指定してください。
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]	[接続先]または[認証]で選択されたリソース定義が見つかりません。	[接続先]または[認証]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException <プロパティ名>が指定されていません。	[<プロパティ名>]が指定されていません。	[<プロパティ名>]を指定してください。
InvalidResourcePathException Invalid resource path: <リソースパス>	リソースパスの形式が不正です。	[リソースパス]を確認してください。
InvalidKeySegmentException The key must not be null or empty	キーが未指定です。	キーが含まれているかを確認してください。
IllegalArgumentException Invalid UUID string: <キー値>	型の変換に失敗しました。	検索型(GUID)のフィールドに検索型(GUID)に変換できる値が設定されているか確認してください。

各Dynamics 365 for Customer Engagementアダプタ固有の主な例外については、「Dynamics 365 for Customer Engagementアダプタの制限事項」を参照してください。

注意事項

各Dynamics 365 for Customer Engagementアダプタ固有の注意事項については、「Dynamics 365 for Customer Engagementアダプタの制限事項」を参照してください。