PlatioCanvasDelete - Platio Canvasからの削除

Platio Canvasプロダクトのテーブルからレコードを削除します。
順番にレコードを削除し、エラーが発生した場合は処理をスキップします。
Platio Canvasビルダーを使って、テーブル一覧や項目定義を取得します。詳細については下記トピック「Platio Canvasビルダーの使い方」を参照してください。

■ストリーム情報

入力フォーマットRecord
接続数1
説明 入力ストリームのフィールド定義を専用の設定画面で行います。 このフィールド定義は直前に連結したマッパーの出力ストリームのフィールド定義にコピーされ、そこに対して値のマッピングを行います。 そのため、このコンポーネントに連結できるコンポーネントはマッパーのみとなっています。
出力フォーマットRecord
説明 次のようなフィールド定義のレコードが出力されます。
フィールド名データ型説明
_RecordIdStringレコードのID
_StatusString削除結果
success - 削除に成功
failure - 削除に失敗
unprocessed - 未処理

■コンポーネントプロパティ

名前プロパティ型マッピング説明
コネクション名connection- Platio Canvasプロダクトへの接続用コネクションを指定します。
コネクションペインまたは管理コンソールにて作成したPlatio Canvas接続名を選択します。
各コネクションの詳細については、「はじめに」-「詳細なトピック」-「フローの構成要素」-「コネクションプロパティ」を参照してください。
テーブル名string- 削除するレコードのテーブル名を指定します。

■ループ処理

■トランザクション処理

コミット何もしません。
ロールバック何もしません。

■エラー処理

タイプパラメーターエラー処理フロー
へのストリーム		エラー
コード		説明
ApiException「ApiExceptionのパラメーター 」
を参照してください。 		コンポーネントの入力ストリーム1 Platio Canvas APIがエラーを返した場合
汎用 なし コンポーネントの入力ストリーム3Platio Canvasとの通信中にエラーが発生した場合
4コネクション名に指定したコネクションが見つからない場合
5テーブル名にテーブル名が指定されていない場合
6入力ストリームが空の場合

■「ApiException」のパラメーター

No.名前説明
1StatusCodePlatio Canvasから返されたステータスコードが返されます。
2StatusLinePlatio Canvasから返されたステータスラインが返されます。

■エラー処理フローへのストリーム

エラー発生時に、コンポーネントがエラー処理フローへ渡すストリームは、基本的にコンポーネントの入力ストリームを使用します。 ただし、レコードの作成・更新処理の途中でエラーが発生した場合は、 入力ストリームの各レコードに次のようなフィールドを追加してエラー処理フローへ渡します。
フィールド名データ型説明
_StatusString削除結果
success - 削除に成功
failure - 削除に失敗
unprocessed - 未処理

エラー処理フローへ渡されるストリームの例: 

<RecordSet xmlns="http://www.infoteria.com/asteria/flowlibrary/record">
  <Record>
    <Field name="_RecordId" type="String">f95ae96d0aeb</Field>
    <Field name="Name" type="String">AAA</Field>
    <Field name="_Status" type="String">success</Field>
  </Record>
  <Record>
    <Field name="_RecordId" type="String">96d0aeb7788a</Field>
    <Field name="Name" type="String">BBB</Field>
    <Field name="_Status" type="String">failure</Field>
  </Record>
  <Record>
    <Field name="_RecordId" type="String">d33e1fab1a17</Field>
    <Field name="Name" type="String">CCC</Field>
    <Field name="_Status" type="String">unprocessed</Field>
  </Record>
</RecordSet>

■制限事項

■APIリクエスト回数

API説明
レコードの削除 削除するレコード1件に対して1回実行されます。

例: 100レコード削除する場合はレコードの削除APIが100回実行されます。

■APIキーの取得方法

Platio Canvas APIを使用するためにはAPIキーを取得する必要があり、Platio Canvasコネクションに取得したAPIキーを指定する必要があります。
APIキーはPlatio Canvasで「プロダクト」ページ上部の「キャンバス」をクリックし、画面上部の「設定」ボタンから表示されるダイアログの「API」タブから作成し、取得することができます。

■Platio Canvasビルダーの使い方

Platio Canvasビルダーは、コネクション名 で接続できるPlatio Canvasプロダクトからテーブル一覧を取得し、そのテーブルの項目を出力ストリームのフィールドとして設定する専用ツールです。

●Platio Canvasビルダーを起動する

以下のいずれかの操作でPlatio Canvasビルダーを起動します。

●コネクションの選択

コネクション名 が設定されていない場合、Platio Canvasビルダー起動時にコネクションダイアログが表示されます。
新規にコネクションを作成する場合は「新規コネクション」を選択してください。
既存のコネクションを使用する場合は「名前」のプルダウンリストより使用するコネクション名を選択してください。選択したコネクションを使用してPlatio Canvasプロダクトへ接続します。

●新規コネクションの作成

「新規コネクション」を選択した場合「コネクションの作成」ダイアログが表示されますので、作成するコネクション名を入力し「OK」ボタンをクリックしてください。

コネクションのプロパティを入力するダイアログが表示されますので、コネクションの各プロパティを設定し「保存」ボタンをクリックしてください。

注意

この時点で新規コネクションが保存されます。

作成したコネクションでPlatio Canvasプロダクトへ接続します。

●テーブルの選択

Platio Canvasプロダクトへの接続が成功すると、Platio Canvasビルダーダイアログが表示されます。
テーブル一覧からテーブルを選択すると、選択したテーブルから取得できるフィールド一覧が表示されます。