データ書き込み(UPSERT)処理

オペレーション名

機能概要

• 「Salesforce Developer Documentation」-(https://developer.salesforce.com/docs)
  • SOAP API Developer's Guide

データモデル

プロパティ

基本設定

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	グローバルリソースを選択します。 グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。 [追加]: 新規にグローバルリソースを追加します。 [一覧の編集]: 「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
テーブル名	必須	使用不可	Salesforceのテーブル名を選択します。
スキーマ定義	必須	-	Salesforceに対して書き込みを行う項目を設定します。	Salesforceに外部ID(またはID)が未設定の場合、または、外部ID(またはID)と異なる項目を外部キーと指定した場合、本オペレーション実行時にエラーが発生します。 Salesforceに対して書き込みが必要な項目に限定(不要な項目をスキーマ定義から除く)することにより、処理効率が向上します。
スキーマ定義/外部キー	必須	使用不可	[テーブル名]で指定したテーブルの該当の列が更新のキー項目かどうかを選択します。 [true]:更新のキー項目に指定します。 [false]:更新のキー項目に指定しません。	詳細については、「更新時のキー指定」を参照してください。
スキーマ定義/ラベル	必須	使用不可	[テーブル名]で指定したテーブルの列のラベル名を表示します。
スキーマ定義/API	必須	使用不可	[テーブル名]で指定したテーブルの列のAPI名を表示します。
スキーマ定義/型	必須	使用不可	[テーブル名]で指定したテーブルの列のデータ型を表示します。
リレーションシップ項目定義	省略可	-	スキーマ定義にリレーション項目が存在する場合、外部キーによる更新を行うための項目を設定します。 リレーション先オブジェクトの外部キー項目を選択することにより、リレーション関係を持たせたデータの受け渡しが可能となります。	API 14.0以降で使用可能です。API 7.0では使用不可です。 詳細については、「リレーションシップ項目定義」を参照してください。
リレーションシップ項目定義/元項目API名	必須	使用不可	[テーブル名]で指定したテーブルのリレーション項目の列のAPI名を表示します。
リレーションシップ項目定義/リレーションシップ名	必須	使用不可	[テーブル名]で指定したテーブルのリレーション項目の列のリレーションシップ名を表示します。
リレーションシップ項目定義/オブジェクトAPI名	省略可	使用不可	[テーブル名]で指定したテーブルのリレーション項目の列のリレーション先のオブジェクトのAPI名を選択します。
リレーションシップ項目定義/リレーション用カラムAPI名	省略可	使用不可	[テーブル名]で指定したテーブルのリレーション項目の列のリレーション先オブジェクトの外部キー項目を選択します。	省略した場合、リレーション先オブジェクトの該当レコードのIDを受け渡す仕様となります。

プロパティアクション

項目名	説明	備考
スキーマの作成	Salesforceに対して書き込みを行う項目の追加・削除を行うことができます。 設定方法については、「スキーマの作成」を参照してください。

オプション設定

プロパティアクション

項目名	説明	備考
テーブル情報の表示	操作を行っているオブジェクトのテーブル構造を確認できます。 テーブル構造の参照方法については、「テーブル情報の表示」を参照してください。	他のオブジェクトのテーブル構造を確認したい場合、[全テーブル情報の読み込み]をクリックしてください。
全テーブル情報の読み込み	取得可能なすべてのテーブル構造を取得します。 実行後に、[テーブル情報の表示]から取得した内容を確認することができます。
ファイルからスキーマ定義を読み取り	ファイルチューザでファイルを選択して、そのファイルの1行目にカンマ区切りで指定された項目(API)を読み取り、スキーマ定義として設定します。	選択するファイルのエンコードは「UTF-8」を指定してください。

データ処理方式

コメント

スキーマ

入力スキーマ

出力スキーマ

<?xml version="1.0" encoding="UTF-8" ?>
<table>
   <row>
    <column>[スキーマ定義]で設定されたラベル/API</column>
       :
     <column>更新結果_ID/upsert_result_id</column>
     <column>更新結果_成功フラグ/upsert_result_is_success</column>
     <column>更新結果_新規作成フラグ/upsert_result_is_created</column>
     <column>更新結果_エラーステータスコード/upsert_result_error_status_code</column>
     <column>更新結果_エラーメッセージ/upsert_result_error_message</column>
     <column>更新結果_行番号/upsert_result_row_number</column>
   </row>
   <row>
     :
   </row>
</table>

Mapperでのスキーマ読み込み

大容量データ処理

トランザクション

PSPでの使用について

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

更新時のキー指定

結果取得使用例

• 例:「取引先(Account)」へのデータ書き込み(UPSERT)の更新結果をCSVファイルに出力します。
  
  
  
  

  画像内の番号	名称	説明	備考
  (1)	入力データイメージ	取引先(Account)へ更新するための入力データイメージです。 ここでは、[外部キー]は「AccountCode__c」とします。
  (2)	取引先(Account)への更新の設定	ここでは、データ書き込み(UPSERT)のアイコンにて設定を行います。
  (3)	処理結果のデータ取得有無の設定	ここでは、[オプション設定]タブの[更新結果取得有無]にて「取得する」を選択します。
  (4)	スクリプトイメージ	本説明のスクリプト実装イメージです。
  (5)	結果データイメージ	取引先(Account)へ更新した際の結果データを取得してCSVファイル出力した結果データイメージです。

リレーションシップ項目定義

• 例: 取引先責任者(Contact)への更新(INSERT,UPDATE,UPSERT)
  
  
  • 例の詳細
    

    種類	説明	備考
    要件仕様	取引先責任者(Contact)の更新処理にて、取引先IDの項目(参照項目)に参照先のオブジェクトのIDを設定したい。 参照先となる取引先(Account)の関連は、入力データの取引先コードに対応するレコードと紐付けたい。
    設定方法	取引先責任者(Contact)への更新にて、取引先IDの項目(参照項目)へ参照先オブジェクトとなる取引先(Account)の 取引先コード(あらかじめ作成した外部キー項目:AccountCode__c)の値をMapperに受け渡す事により 更新時に対応する参照先オブジェクトのIDを自動で取得してリレーション関係を設定します。	本説明にて使用している項目や一部の設定は使用例となります。 使用しているSalesforce組織に必ず存在するものではありません。 各種設定を行った上で本機能を使用してください。

  
  
  • 連携イメージ
    
    
    

    画像内の番号	名称	説明	備考
    (1)	取引先(Account)のデータイメージ	取引先責任者(Contact)から参照されるオブジェクトのデータイメージです。
    (2)	取引先(Account)の外部キー項目	あらかじめ「取引先コード(AccountCode__c)」外部キーとして設定しておきます。
    (3)	入力データイメージ	取引先責任者(Contact)へ更新するための入力データイメージです。	「取引先コード」を保持したデータです。
    (4)	取引先責任者(Contact)への更新(INSERT,UPDATE,UPSERT)の設定	ここでは、「取引先ID」,「姓」,「名」,「電子メール」の4項目を更新対象とします。
    (5)	リレーションシップ項目定義の設定	「リレーション用カラムAPI名」にて参照先オブジェクトの外部キー項目を選択します。ここでは、リレーション関係を設定するためのキー項目として、参照先オブジェクトの外部キー「Account.AccountCode__c」を選択します。	選択値が無しの場合、参照先のオブジェクトの該当レコードのIDをMapperに受け渡す仕様となります。
    (6)	取引先責任者(Contact)の更新結果データイメージ	取引先責任者(Contact)の更新結果データイメージです。	「取引先コード」に対応したレコードとのリレーション関係が正しく設定されています。

スキーマの作成

テーブル情報の表示

仕様制限

• 本アダプタによるデータ読み取り・書き込みの操作を行うには、Salesforceの組織がAPIを公開している必要があります。


• 各テーブルに対するデータ読み取り・書き込みなどの操作権限、およびデータのアクセスコントロールは、すべてSalesforce側のプロファイル、共有ルールの設定、およびAPI仕様に依存します。


• API バージョンによって扱うことができるオブジェクトや項目は異なります。詳細はSalesforceのドキュメントをご確認ください。

主な例外

注意事項

• 本オペレーションでは、データベースアダプタなどとは異なり、エラー発生時にロールバックすることができません。そのため、正常データは更新し、エラーデータは更新せずその情報をWARNレベルのログとして出力します。
  よって、データ単位でのエラー(制約違反や設定値不正など)が存在する場合、スクリプト内で例外監視処理によるエラーの検出を行なうことはできません。
  データ単位でのエラー情報を処理の中でデータとして使用したい場合、[更新結果取得有無]に[取得する]を選択し、後続の処理で結果データをエラーの検出などのハンドリングに使用してください。


• リレーションシップ項目定義で指定したリレーション用カラムが数値型である場合、 java の double 型の精度を超える数値を受け渡すと、丸められた値で親レコードの索引が行われます。
  値を丸めずに索引を行う場合、テキスト型を指定してください。


• 外部キーに指定した項目が数値型である場合、 java の double 型の精度を超える数値を受け渡すと、丸められた値で扱われます。
  値を丸めずに外部キーとして扱う場合、テキスト型を指定してください。


• 次の API バージョンにおいて java の double 型の精度を超える数値を書き込んだ場合、値が丸められて登録されます。
  一例として、数値(16,2) の項目に「1,234,567,890,123,456.78」を書き込んだ場合、「1,234,567,890,123,456.80」として登録されます。
  
  • API 7.0
  • API 14.0
  • API 18.0
  • API 23.0
  
  値を丸めずに書き込む場合、上記より新しい API バージョンを使用してください。