ファイルアップロード処理

オペレーション名

機能概要

• SOAP API
  • login()
  • retrieve()
• REST API
  • sObject Basic Information
  • sObject Rows
  • sObject Rows by External ID

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

データモデル

プロパティ

基本設定

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	グローバルリソースを選択します。 グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。 [追加]: 新規にグローバルリソースを追加します。 [一覧の編集]: 「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。	API 43.0以降のグローバルリソースが選択可能です。 本コンポーネントでは、影響を受けないグローバルリソースのプロパティがあります。詳細については、「影響を受けないグローバルリソースのプロパティ」を参照してください。
スキーマ定義	必須	-	コンテンツバージョン(ContentVersion)に対して書き込みを行う項目を設定します。	Salesforceに対して書き込みが必要な項目に限定(不要な項目をスキーマ定義から除く)することにより、処理効率が向上します。 [HTTPメソッド]で[PATCH]を選択した場合、[外部ID項目]で選択した項目を選択している必要があります。 設定例については、「ファイルアップロードの使用例」を参照してください。
スキーマ定義/ラベル	必須	使用不可	列のラベル名を表示します。
スキーマ定義/API	必須	使用不可	列のAPI名を表示します。
スキーマ定義/型	必須	使用不可	列のデータ型を表示します。
スキーマ定義/Null設定	省略可	使用不可	入力データがnullであった場合、nullで上書きするか、該当項目の更新をスキップするかを項目単位に選択します。 [チェックあり]: 入力データがnullの場合、この項目をnullで上書きします。 [チェックなし]: 入力データがnullの場合、この項目の更新をスキップし、更新前の状態を維持します。 入力データがnull以外の場合、この項目は入力データで上書きします。	[項目単位に設定する]で[チェックあり]にした場合、有効になります。
リレーションシップ項目定義	省略可	-	スキーマ定義にリレーション項目が存在する場合、外部キーによる更新を行うための項目を設定します。 リレーション先オブジェクトの外部キー項目を選択することにより、リレーション関係を持たせたデータの受け渡しが可能となります。	詳細については、「リレーションシップ項目定義」を参照してください。
リレーションシップ項目定義/元項目API名	必須	使用不可	リレーション項目の列のAPI名を表示します。
リレーションシップ項目定義/リレーションシップ名	必須	使用不可	リレーション項目の列のリレーションシップ名を表示します。
リレーションシップ項目定義/オブジェクトAPI名	省略可	使用不可	リレーション項目の列のリレーション先のオブジェクトのAPI名を選択します。
リレーションシップ項目定義/リレーション用カラムAPI名	省略可	使用不可	リレーション項目の列のリレーション先オブジェクトの外部キー項目を選択します。	省略した場合、リレーション先オブジェクトの該当レコードのIDを受け渡す仕様となります。

プロパティアクション

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

オプション設定

プロパティアクション

データ処理方式

コメント

スキーマ

入力スキーマ

出力スキーマ

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>[スキーマ定義]で設定されたAPI</column>
       :
    <column>result_id</column>
    <column>result_is_success</column>
    <column>result_is_created</column>
    <column>result_error_status_code</column>
    <column>result_error_message</column>
    <column>result_row_number</column>
    <column>result_content_document_id</column>
  </row>
  <row>
    :
  </row>
</table>

Mapperでのスキーマ読み込み

大容量データ処理

トランザクション

PSPでの使用について

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

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

• 例: コンテンツバージョン(ContentVersion)への更新(INSERT,UPDATE,UPSERT)
  
  
  • 例の詳細
    
    

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

    
    
    
  • 連携イメージ
    
    
    
    

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

スキーマの作成

ファイルアップロード使用例

• 「Salesforce Developer Documentation」-(https://developer.salesforce.com/docs)
  • Object Reference for Salesforce and Lightning Platform

• 例1: 新規にファイルをアップロードする


1. [スキーマ定義]で以下の項目を設定します。

   ラベル	API	型	備考
   タイトル	Title	string	[スキーマ定義]で選択しない場合、または[スキーマ定義]で選択して入力データがnullであった場合、「PathOnClient」項目の入力データからファイルパスおよび拡張子を除外したファイル名が自動で保存されます。
   クライアントでのパス	PathOnClient	string	ファイルをSalesforceの [プレビュー] タブに表示するには、拡張子を含める必要があります。 例: /data/file.txt
   バージョンデータ	VersionData	base64	入力データにファイルパスを設定してください。 例: /data/file.txt ファイルパスはDataSpiderファイルシステムの絶対パスで指定してください。 パス区切り文字「/」以外のDataSpiderファイルシステムの使用禁止文字は使用できません。



2. [HTTPメソッド]で[POST]を選択します。



• 例2: ファイルの新しいバージョンを追加する


1. [スキーマ定義]で以下の項目を設定します。

   ラベル	API	型	備考
   タイトル	Title	string	[スキーマ定義]で選択しない場合、バージョンアップ前のタイトルが維持されます。 [スキーマ定義]で選択して入力データがnullであった場合、「PathOnClient」項目の入力データからファイルパスおよび拡張子を除外したファイル名が自動で保存されます。
   クライアントでのパス	PathOnClient	string	ファイルをSalesforceの [プレビュー] タブに表示するには、拡張子を含める必要があります。 例: /data/file.txt
   バージョンデータ	VersionData	base64	入力データにファイルパスを設定してください。 例: /data/file.txt ファイルパスはDataSpiderファイルシステムの絶対パスで指定してください。 パス区切り文字「/」以外のDataSpiderファイルシステムの使用禁止文字は使用できません。
   ContentDocument ID	ContentDocumentId	reference	入力データにバージョンアップしたいファイルのコンテンツドキュメント(ContentDocument)のIdを設定します。



2. [HTTPメソッド]で[POST]を選択します。



• 例3: ファイルのタイトルと説明を更新する


1. [スキーマ定義]で以下の項目を設定します。

   ラベル	API	型	備考
   ContentVersion ID	Id	id	入力データに更新したいファイルのコンテンツバージョン(ContentVersion)のIdを設定します。
   タイトル	Title	string
   説明	Description	textarea



2. [HTTPメソッド]で[PATCH]を選択します。


3. [外部ID項目]で[Id (ContentVersion ID)]を選択します。



• 例4: 外部ID(またはID)を使用してレコードを挿入/更新 (Upsert) する
• 外部ID(またはID)の値と一致する行が既にSalesforceに存在した場合は、その行を更新し、なければ追加するという処理を、Salesforceが判別して追加・更新(IDの場合は更新)を行います。
• [スキーマ定義]の選択項目によっては更新時にエラーが発生する場合があります（「PathOnClient」を更新しようとした場合など）。


1. [スキーマ定義]で以下の項目を設定します。

   ラベル	API	型	備考
   タイトル	Title	string	例1を参考に設定します。
   クライアントでのパス	PathOnClient	string
   バージョンデータ	VersionData	base64
   <外部ID項目のラベル>	<外部ID項目のAPI>	<外部ID項目の型>	スキーマ作成で「外部ID」がチェックありの項目を選択する必要があります。 ここで選択するためには、事前にSalesforceのカスタマイズ機能を使用して外部IDの項目を作成します。新規項目作成の詳細を入力する画面より、外部ID「外部システムの一意のレコード識別子として設定する」にチェックを入れます。



2. [HTTPメソッド]で[PATCH]を選択します。


3. [外部ID項目]で[<外部ID項目のAPI> (<外部ID項目のラベル>)]を選択します。

コンテンツドキュメントIDを取得する

• 例：アップロードしたファイルのコンテンツドキュメントIDを取得し、取引先責任者に紐付ける





画像内の番号	名称	説明	備考
(1)	入力データイメージ	コンテンツバージョン(ContentVersion)へ更新するための入力データイメージです。
(2)	コンテンツドキュメントIDの取得有無の設定	[オプション設定]タブの[コンテンツドキュメントIDを取得する]を[チェックあり]とします。
(3)	スクリプトイメージ	本説明のスクリプト実装イメージです。
(4)	ファイル紐付けイメージ	コンテンツバージョン(ContentVersion)へ更新したファイルを紐づけた取引先責任者のSalesforce詳細ページのイメージです。

影響を受けないグローバルリソースのプロパティ

オプション設定

SOAPヘッダー設定

仕様制限

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


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


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


• REST APIによるファイルアップロード時の最大サイズは 2GB (ヘッダーを含む)となります。詳細はSalesforceのドキュメントをご確認ください。

主な例外

注意事項

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


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


• オブジェクトの項目にはデータ型が定義されています。APIでは定義されたデータ型の形式ルールに従いデータを送受信しますが、本アダプタでは一部のデータ型においてルールを拡張しています。
  詳細については、「データ型の形式」を参照してください。