Salesforce

接続構成のサンプル

このセクションでは、接続を作成するときに構成するさまざまなフィールドのサンプル値を示します。

ユーザー名とパスワードの接続タイプ

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

• エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。

  ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。

• オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
  • リスト
  • 取得
  • 作成
  • 更新
  • 削除

  使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。

• アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

アクション

このコネクタを使用すると、Salesforce データに対して挿入、削除、更新、読み取りオペレーションを実行できます。カスタム SQL クエリを実行するため、コネクタは [カスタムクエリを実行する] アクションを備えています。

カスタムクエリを作成する手順は次のとおりです。

1. 詳細な手順に沿って、コネクタタスクを追加します。
2. コネクタタスクを構成するときに、実行するアクションの種類で [Actions] を選択します。
3. [Actions] リストで [Execute custom query] を選択し、[Done] をクリックします。

   

4. [Task input] セクションを開き、次の操作を行います。
   1. [タイムアウト後] フィールドに、クエリが実行されるまで待機する秒数を入力します。

      デフォルト値: 180 秒

   2. [最大行数]フィールドに、データベースから返される最大行数を入力します。

      デフォルト値: 25。

   3. カスタムクエリを更新するには、[Edit Custom Script] をクリックします。[Script editor] ダイアログが開きます。

      

   4. [Script editor] ダイアログで、SQL クエリを入力して [Save] をクリックします。

      SQL ステートメントで疑問符（?）を使用して、クエリ パラメータ リストで指定する必要がある 1 つのパラメータを表すことができます。たとえば、次の SQL クエリは、LastName 列に指定された値と一致する Employees テーブルからすべての行を選択します。

      SELECT * FROM Employees where LastName=?

   5. SQL クエリで疑問符を使用した場合は、各疑問符の [+ パラメータ名を追加] をクリックして、パラメータを追加する必要があります。統合の実行中に、これらのパラメータにより SQL クエリ内の疑問符（?）が順番に置き換わります。たとえば、3 つの疑問符（?）を追加した場合、3 つのパラメータを順番に追加する必要があります。

      

      クエリ パラメータを追加する手順は次のとおりです。

      1. [Type] リストから、パラメータのデータ型を選択します。
      2. [値] フィールドに、パラメータの値を入力します。
      3. 複数のパラメータを追加するには、[+ クエリ パラメータを追加] をクリックします。

Salesforce コネクタは、OFFSET 句のパラメータ化された値をサポートしていません。また、クエリ パラメータを使用して動的に置き換えることもできません。ただし、クエリ パラメータは WHERE 句でサポートされています。

このセクションには、Salesforce コネクタでサポートされているアクションが一覧表示されます。アクションの構成方法については、アクションの例をご覧ください。

CreateJobv2 アクション

このアクションを使用してジョブを作成します。

CreateJobV2 アクションの入力パラメータ

CreateJobV2 アクションの構成例については、例をご覧ください。

UploadJobDataV2 アクション

このアクションを使用すると、CSV 形式のジョブファイルを Salesforce にアップロードできます。

UploadJobDataV2 アクションの入力パラメータ

UploadJobDataV2 アクションの構成例については、例をご覧ください。

CreateBatch アクション

このアクションにより、Salesforce バッチが作成されます。

CreateBatch アクションの入力パラメータ

CreateBatch アクションの出力パラメータ

CreateBatch アクションの構成例については、例をご覧ください。

CreateJob アクション

このアクションは、Salesforce オブジェクトのエントリを追加します。

CreateJob アクションの入力パラメータ

CreateJob アクションの出力パラメータ

CreateJob アクションの構成例については、例をご覧ください。

GetBatch アクション

このアクションは、Salesforce バッチに関する情報を取得します。

GetBatch アクションの入力パラメータ

GetBatch アクションの出力パラメータ

GetBatch アクションの構成例については、例をご覧ください。

GetJob アクション

このアクションは、Salesforce ジョブに関する情報を取得します。

GetJob アクションの入力パラメータ

GetJob アクションの出力パラメータ

GetJob アクションの構成例については、例をご覧ください。

UploadAttachment アクション

このアクションは、アタッチメントをアップロードし、Salesforce 内のエンティティに関連付けます。

UploadAttachment アクションの入力パラメータ

UploadAttachment アクションの出力パラメータ

UploadAttachment アクションの構成例については、例をご覧ください。

GetBatchResults アクション

このアクションは、Salesforce バッチの結果を取得します。

GetBatchResults アクションの入力パラメータ

GetBatchResults アクションの出力パラメータ

GetBatchResults アクションの構成例については、例をご覧ください。

アクションの例

例 - CreateJobV2

この例では、ジョブを作成します。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [CreateJobV2] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Value フィールドに次のような値を入力する必要があります。

    {
     "ObjectName": "Contact",
     "Action": "insert"
    }

アクションが成功すると、CREATEJOBV2 タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

 
  [{
  "ID": "750dM000005HjdnQAC",
  "State": "Open",
  "JobType": null,
  "ContentUrl": "services/data/v43.0/jobs/ingest/750dM000005HjdnQAC/batches",
  "ContentType": "CSV",
  "CreatedDate": "2024-08-07T09:16:16.000+0000",
  "CreatedById": "005dM0000061WSFQA2",
  "ConcurrencyMode": "Parallel",
  "SystemModStamp": "2024-08-07T09:16:16.000+0000"
  }] 

例 - UploadJobDataV2

この例では、Salesforce にジョブファイルをアップロードします。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [UploadJobDataV2] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

    {
     "Content":   "FirstName,LastName,Email,MobilePhone,External_Id__c\\nGinelle,Merioth,gmerioth0@example.com,851-555-8435,4d13cac0-2c11-48e9-891d-49ee9508a6c7\\nDalli,Tumilson,dtumilson1@example.com,881-555-6742,38bcb24b-247f-498b-9502-c98995a1e04b\\nRobbin,Purveys,rpurveys2@example.com,732-555-6909,35d96c7a-3856-4809-8c49-35ddb9fa7dd9\\nLothaire,Ivanchenkov,livanchenkov3@example.com,144-555-1959,75f63f26-6f4a-406f-a9f4-807f4a8a7b51",
     "ContentUrl": "services/data/v43.0/jobs/ingest/750dM000005HjdnQAC/batches"
    }

アクションが成功すると、UploadJobDataV2 タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

 
  [{
  "Uploaded": "true"
  }]

例 - CreateBatch

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [CreateBatch] アクションを選択してから、[完了] をクリックします。
3. [データ マッピング] セクションで Open Data Mapping Editor をクリックし、Input フィールドに次のような値を入力します。

   {
   "JobId": "750dL000007EipxQAC",
   "Aggregate": "\n    Walter\n    White\n  \n  \n    Rob\n    Brown\n  \n",
   "ContentType": "XML"
   }

アクションが成功すると、CreateBatch タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

 
[{
  "ID": "751dL000003ziC5QAI",
  "JobID": "750dL000007EipxQAC",
  "ApexProcessingTime": "0",
  "ApiActiveProcessingTime": "0",
  "CreatedDate": "2024-09-03T04:48:53.000Z",
  "NumberRecordsFailed": "0",
  "NumberRecordsProcessed": "0",
  "State": "Queued",
  "StateMessage": null,
  "SystemModstamp": "2024-09-03T04:48:53.000Z",
  "TotalProcessingTime": "0"
}]

例 - CreateJob

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [CreateJob] アクションを選択してから、[完了] をクリックします。
3. [データ マッピング] セクションで Open Data Mapping Editor をクリックし、Input フィールドに次のような値を入力します。

   {
     "ObjectName": "Campaign",
     "Action": "insert"
   }

アクションが成功すると、CreateJob タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

 
 [{
  "ID": "750dL000007GgD7QAK",
  "JobID": "750dL000007GgD7QAK",
  "ObjectName": "Campaign",
  "Operation": "insert",
  "ApiVersion": "56.0",
  "ApexProcessingTime": "0",
  "ApiActiveProcessingTime": "0",
  "AssignmentRuleId": null,
  "ConcurrencyMode": "Parallel",
  "ContentType": "XML",
  "CreatedById": "005dL000007CalFQAS",
  "CreatedDate": "2024-09-03T05:31:41.000Z",
  "ExternalIdFieldName": null,
  "NumberBatchesCompleted": "0",
  "NumberBatchesQueued": "0",
  "NumberBatchesFailed": "0",
  "NumberBatchesInProgress": "0",
  "NumberBatchesTotal": "0",
  "NumberRecordsFailed": "0",
  "NumberRecordsProcessed": "0",
  "NumberRetries": "0",
  "State": "Open",
  "SystemModStamp": "2024-09-03T05:31:41.000Z",
  "TotalProcessingTime": "0"
}]

例 - GetBatch

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [GetBatch] アクションを選択してから、[完了] をクリックします。
3. [データ マッピング] セクションで Open Data Mapping Editor をクリックし、Input フィールドに次のような値を入力します。

   {
     "BatchId": "751dL000003yKlJQAU",
     "JobId": "750dL000007EipxQAC"
   }

アクションが成功すると、GetBatch タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

 
[{
  "ID": "751dL000003yKlJQAU",
  "JobID": "750dL000007EipxQAC",
  "ApexProcessingTime": "0",
  "ApiActiveProcessingTime": "0",
  "CreatedDate": "2024-09-02T11:44:15.000Z",
  "NumberRecordsFailed": "0",
  "NumberRecordsProcessed": "0",
  "State": "Failed",
  "StateMessage": "InvalidBatch : Failed to parse XML. Unexpected XML element 'sObject' found at  START_TAG seen ... @1:9 it should be 'sObjects'",
  "SystemModstamp": "2024-09-02T11:44:15.000Z",
  "TotalProcessingTime": "0"
}]

例 - GetJob

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [GetJob ] アクションを選択してから、[完了] をクリックします。
3. [データ マッピング] セクションで Open Data Mapping Editor をクリックし、Input フィールドに次のような値を入力します。

   {
     "JobId": "750dL000007EipxQAC"
   } 

アクションが成功すると、GetJob タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

 
[{
  "ID": "750dL000007EipxQAC",
  "JobID": "750dL000007EipxQAC",
  "ObjectName": "Campaign",
  "Operation": "insert",
  "ApiVersion": "56.0",
  "ApexProcessingTime": "0",
  "ApiActiveProcessingTime": "0",
  "AssignmentRuleId": null,
  "ConcurrencyMode": "Parallel",
  "ContentType": "XML",
  "CreatedById": "005dL000007CalFQAS",
  "CreatedDate": "2024-09-02T11:17:42.000Z",
  "ExternalIdFieldName": null,
  "NumberBatchesCompleted": "0",
  "NumberBatchesQueued": "0",
  "NumberBatchesFailed": "2",
  "NumberBatchesInProgress": "0",
  "NumberBatchesTotal": "2",
  "NumberRecordsFailed": "0",
  "NumberRecordsProcessed": "0",
  "NumberRetries": "0",
  "State": "Open",
  "SystemModStamp": "2024-09-02T11:17:42.000Z",
  "TotalProcessingTime": "0"
}]

例 - UploadAttachment

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [UploadAttachment] アクションを選択してから、[完了] をクリックします。
3. [データ マッピング] セクションで Open Data Mapping Editor をクリックし、Input フィールドに次のような値を入力します。

   {
     "ObjectId": "001dL00000SC6j7QAD",
     "FileName": "My files/salesforce/con.csv",
     "Base64Data": "Y29ubmVjdG9ycyBpcyBiYWNr"
   }

アクションが成功すると、UploadAttachment タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

 
[{
  "Id": "00PdL000000EJUDUA4"
}]

例 - GetBatchResults

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [GetBatchResults] アクションを選択してから、[完了] をクリックします。
3. [データ マッピング] セクションで Open Data Mapping Editor をクリックし、Input フィールドに次のような値を入力します。

   {
     "BatchId": "751dL000004D17FQAS",
     "JobId": "750dL000007XKUhQAO",
     "ContentType": "XML"
   }

アクションが成功すると、GetBatchResults タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

 
[{
  "ID": null,
  "Created": "false",
  "Success": "false",
  "Errors_Fields": "LastName",
  "Errors_Message": "Account: bad field names on insert/update call: FirstName, LastName",
  "Errors_StatusCode": "INVALID_FIELD_FOR_INSERT_UPDATE"
}, {
  "ID": null,
  "Created": "false",
  "Success": "false",
  "Errors_Fields": "LastName",
  "Errors_Message": "Account: bad field names on insert/update call: FirstName, LastName",
  "Errors_StatusCode": "INVALID_FIELD_FOR_INSERT_UPDATE"
}]

エンティティ オペレーションの例

このセクションでは、このコネクタでエンティティ オペレーションの一部を実行する方法について説明します。

例 - アタッチメントを作成する

エンティティ作成アタッチメントは、コンテンツ ファイルのないアタッチメントのみを作成します。ファイルを追加するには、入力でファイルのコンテキストを指定して、アタッチメントのアップロード アクションを実行する必要があります。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity リストから [アタッチメント] を選択します。
3. [Create] オペレーションを選択し、[完了] をクリックします。
4. [タスク] の [データ マッパー] セクションで、OpenDataMapping エディタをクリックし、field: に次のような値を入力します。

   {
     "Name": "New Attachment",
     "Description": "New created attachment",
     "ParentId": "001dL00000SC6j7QAD",
     "Body": "Body"
   }
   

5. この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

   {
     "Id": "00PdL000000EJKXUA4"
   }
   

例 - アタッチメントを更新する

エンティティの更新アタッチメントでは、アタッチメントの名前または説明のみが更新されます。ファイルを追加するには、入力でファイルのコンテキストを指定して、アタッチメントのアップロード アクションを実行する必要があります。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity リストから [アタッチメント] を選択します。
3. [Update] オペレーションを選択し、[完了] をクリックします。
4. アタッチメントを更新するようにエンティティ ID を設定します。エンティティ ID を設定するには、[タスク] の [データ マッパー] セクションで [EntityID] をクリックし、該当するフィールドに「00PdL000000EJKXUA4」と入力します。
5. [タスク] の [データ マッパー] セクションで、OpenDataMapping エディタをクリックし、field: に次のような値を入力します。

   {
     "Name": "New Attachment",
     "Description": "New updated attachment",
     "Body": "Body"
   }
   

[entityId] を指定する代わりに、[filterClause] を 00PdL000000EJKXUA4 に設定することもできます。

6. この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

   {
     "Id": "00PdL000000EJKXUA4"
   }