Azure Data Factory または Azure Synapse Analytics を使って Salesforce Service Cloud V2 との間でデータをコピーする

適用対象: Azure Data Factory Azure Synapse Analytics

この記事では、Azure Data Factory と Azure Synapse パイプラインのコピー アクティビティを使って、Salesforce Service Cloud 間でデータをコピーする方法について説明します。 この記事は、コピー アクティビティの概要を示しているコピー アクティビティの概要に関する記事に基づいています。

Supported capabilities

この Salesforce Service Cloud コネクタは、次の機能でサポートされます。

① Azure 統合ランタイム ② セルフホステッド統合ランタイム

ソースまたはシンクとしてサポートされているデータ ストアの一覧については、サポートされるデータ ストアに関する表を参照してください。

具体的には、この Salesforce Service Cloud コネクタは以下をサポートします。

• Salesforce Developer、Professional、Enterprise、または Unlimited エディション。
• カスタム ドメインとの間でデータのコピー (カスタム ドメインは運用環境とサンドボックス環境の両方で構成できます)。

リンク サービスで apiVersion プロパティ を使用して、データの読み取りまたは書き込みに使用する API バージョンを明示的に設定することができます。 データの Salesforce Service Cloud へのコピー時に、コネクタでは BULK API 2.0 が使われます。

Prerequisites

• Salesforce で API アクセス許可を有効にする必要があります。

• この公式ドキュメント を参照するか、この 記事の推奨事項のステップ バイ ステップ ガイドラインを参照して、Salesforce ポータルで接続アプリを構成する必要があります。

  Important

  • 実行ユーザーには "API のみ" のアクセス許可が必要です。
  • アクセス トークンの有効期限は、更新トークンではなくセッション ポリシーを使用して変更できます。

Salesforce Bulk API 2.0 の制限

Salesforce Bulk API 2.0 を使用して、データのクエリと取り込みを行います。 Bulk API 2.0 では、バッチが自動的に作成されます。 24 時間のロール期間あたり最大 15,000 件のバッチを送信できます。 バッチが上限を超えると、エラーが表示されます。

Bulk API 2.0 では、取り込みジョブのみがバッチを使用します。 クエリ ジョブは使用しません。 詳細については、「Bulk API 2.0 Developer Guide (Bulk API 2.0 開発者ガイド)」の「How Requests Are Processed」(要求の処理方法) を参照してください。

詳細については、Salesforce Developer の制限に関する資料の「General Limits」(一般的な制限) を参照してください。

概要

パイプラインでコピー アクティビティを実行するには、次のいずれかのツールまたは SDK を使用します。

• データ コピー ツール
• Azure ポータル
• .NET SDK
• Python SDK
• Azure PowerShell
• REST API
• Azure Resource Manager テンプレート

UI を使用して Salesforce Service Cloud のリンク サービスを作成する

次の手順を使用して、Azure portal UI で Salesforce Service Cloud のリンク サービスを作成します。

1. Azure Data Factory または Synapse ワークスペースの [管理] タブに移動し、[リンク サービス] を選択して、[新規] をクリックします。

   • Azureデータファクトリー
   • Azure Synapse

   

2. Salesforce を検索し、Salesforce Service Cloud コネクタを選択します。

   

3. サービスの詳細を構成し、接続をテストして、新しいリンク サービスを作成します。

   

コネクタの構成の詳細

次のセクションでは、Salesforce Service Cloud コネクタに固有のエンティティを定義するために使用されるプロパティについて詳しく説明します。

リンクされたサービスのプロパティ

Salesforce Service Cloud リンク サービスでは、次のプロパティがサポートされます。

例: 資格情報を格納する

{
    "name": "SalesforceServiceCloudLinkedService",
    "properties": {
        "type": "SalesforceServiceCloudV2",
        "typeProperties": {
            "environmentUrl": "<environment URL>",
            "authenticationType": "OAuth2ClientCredentials",
            "clientId": "<client ID>",
            "clientSecret": {
                "type": "SecureString",
                "value": "<client secret>"
            },
            "apiVersion": "<API Version>"
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

例: キー コンテナーに資格情報を格納する

{
    "name": "SalesforceServiceCloudLinkedService",
    "properties": {
        "type": "SalesforceServiceCloudV2",
        "typeProperties": {
            "environmentUrl": "<environment URL>",
            "authenticationType": "OAuth2ClientCredentials",
            "clientId": "<client ID>",
            "clientSecret": {
                "type": "AzureKeyVaultSecret",
                "secretName": "<secret name of client secret in AKV>",
                "store":{
                    "referenceName": "<Azure Key Vault linked service>",
                    "type": "LinkedServiceReference"
                }
            },
            "apiVersion": "<API Version>"
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

Dataset properties

データセットを定義するために使用できるセクションとプロパティの完全な一覧については、データセットに関する記事をご覧ください。 このセクションでは、Salesforce Service Cloud データセットでサポートされるプロパティの一覧を示します。

Salesforce Service Cloud との間でデータをコピーするには、データセットの type プロパティを SalesforceServiceCloudV2Object に設定します。 次のプロパティがサポートされています。

Example:

{
    "name": "SalesforceServiceCloudDataset",
    "properties": {
        "type": "SalesforceServiceCloudV2Object",
        "typeProperties": {
            "objectApiName": "MyTable__c"
        },
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Salesforce Service Cloud linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

コピー アクティビティのプロパティ

アクティビティの定義に利用できるセクションとプロパティの完全な一覧については、パイプラインに関する記事を参照してください。 このセクションでは、Salesforce Service Cloud ソースとシンクでサポートされるプロパティの一覧を示します。

ソースの種類としての Salesforce Service Cloud

Salesforce Service Cloud からデータをコピーするには、コピー アクティビティのソースの種類を SalesforceServiceCloudV2Source に設定します。 コピー アクティビティの source セクションでは、次のプロパティがサポートされます。

Example:

"activities":[
    {
        "name": "CopyFromSalesforceServiceCloud",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Salesforce Service Cloud input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "SalesforceServiceCloudV2Source",
                "query": "SELECT Col_Currency__c, Col_Date__c, Col_Email__c FROM AllDataType__c",
                "includeDeletedObjects": false
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

シンクの種類としての Salesforce Service Cloud

Salesforce Service Cloud にデータをコピーするには、コピー アクティビティのシンクの種類を SalesforceServiceCloudV2Sink に設定します。 コピー アクティビティの sink セクションでは、次のプロパティがサポートされます。

例: コピー アクティビティの Salesforce Service Cloud シンク

"activities":[
    {
        "name": "CopyToSalesforceServiceCloud",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<Salesforce Service Cloud output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "<source type>"
            },
            "sink": {
                "type": "SalesforceServiceCloudV2Sink",
                "writeBehavior": "Upsert",
                "externalIdFieldName": "CustomerId__c",
                "writeBatchSize": 10000,
                "ignoreNullValues": true
            }
        }
    }
]

Salesforce Service Cloud のデータ型マッピング

Salesforce Service Cloud からデータをコピーする場合、Salesforce Service Cloud データ型からサービス内の中間データ型への次のマッピングが内部的に使われます。 コピー アクティビティでソースのスキーマとデータ型がシンクにマッピングされるしくみについては、スキーマとデータ型のマッピングに関する記事を参照してください。

Lookup アクティビティのプロパティ

プロパティの詳細については、Lookup アクティビティに関するページを参照してください。

Salesforce Service Cloud コネクタのライフサイクルとアップグレード

次の表は、Salesforce Service Cloud コネクタのさまざまなバージョンのリリース ステージと変更ログを示しています。

Salesforce Service Cloud コネクタをアップグレードする

Salesforce Service Cloud コネクタのアップグレードに役立つ手順を次に示します:

1. 「前提条件」を参照して、Salesforce ポータルで接続アプリを構成します。

2. 新しい Salesforce Service Cloud リンク サービスを作成し、「リンクされたサービスのプロパティ」を参照して構成します。

3. V1 リンク サービスを参照する Copy アクティビティのソースまたは検索アクティビティで SQL クエリを使用する場合は、それらを SOQL クエリに変換する必要があります。 SOQL クエリの詳細については、「ソースの種類としての Salesforce Service Cloud」と「Salesforce Object Query Language (SOQL)」を参照してください。

4. readBehavior は、コピー アクティビティのソースまたは参照アクティビティの includeDeletedObjects に置き換えられます。 詳細な構成については、「ソースの種類としての Salesforce Service Cloud」を参照してください。

Related content

コピー アクティビティによってソースおよびシンクとしてサポートされるデータ ストアの一覧については、サポートされるデータ ストアに関するセクションを参照してください。