顧客パイプライン

Current version: 10.1

CreateUser パイプライン

ECS およびソリューションとの実際の統合に応じて、ユーザーはデフォルトで無効にでき、ActivateUserAccount が呼び出されるとアクティブになります。

名前:

CreateUser

説明:

このパイプラインは、ユーザー アカウントを作成する役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - ユーザー エンティティとパスワードが含まれます。パイプラインを呼び出す前に設定されます。

応答 - ユーザー オブジェクトが含まれます。パイプラインが呼び出された後に読み取られます。

プロセッサー:

CreateUserInECS – オプション

外部コマース システムでユーザーを作成し、ユーザー エンティティの ExternalID フィールドを更新します。

注記

外部 ID が解析され、ユーザーがすでに存在する場合、何も起こりません。 

このプロセッサーはオプションですが、CommerceUsers が ECS でサポートされている場合は推奨されます。

CreateUserInCMS – (必須)

ユーザーを作成しますが、さらに重要なことに、メンバーシップ プロバイダーとプロファイル プロバイダーを使用して Sitecore に CommerceCustomer との関係を保存します。

ユーザーがすでに存在する場合は、ゴールのトリガーを回避するためにパイプラインを中止する必要があります。

注記

このプロセッサーは、CommerceUserCommerceCustomer. 間の 1 対多の関係を保存するために必須です。それが ECS で処理される場合、プロセッサーは必須ではありません。

TriggerDMSGoal –

[ユーザー アカウントが作成されました] ゴールは、User name と ShopName の値でトリガーされます。

UpdateUser パイプライン

名前:

UpdateUser

説明:

このパイプラインは、既存のユーザー アカウントを更新する役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - ユーザー エンティティが含まれます。パイプラインを呼び出す前に設定されます。

応答 - ユーザー エンティティが含まれます。パイプラインが呼び出された後に読み取られます。

プロセッサー:

UpdateUserInECS – オプション

外部コマース システムの既存のユーザー アカウントを更新します。

注記

このプロセッサーはオプションですが、CommerceUsers が ECS でサポートされている場合は推奨されます。

UpdateUserInCMS – 必須

Sitecore のユーザー アカウントを更新します。ユーザーは最初に外部で更新されるため、次にユーザー データを変更して最終バージョンを CMS に保存できます。

注記

このプロセッサーは、CommerceUserCommerceCustomer 間の 1 対多の関係を保存するために必須です。それが ECS で処理される場合、プロセッサーは必須ではありません。

TriggerDMSEvent – [ユーザー アカウントは更新されました] イベントのページが、User name と ShopName の値でトリガーされます。

DeleteUser パイプライン

名前:

DeleteUser

説明:

このパイプラインは、既存のユーザー アカウントを削除する役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - ユーザー エンティティが含まれます。パイプラインを呼び出す前に設定されます。

応答 -

プロセッサー:

DeleteUserInECS – オプション

外部コマース システムの既存のユーザーを削除します。

注記

ユーザー アカウントが存在しない場合は、返された外部システム メッセージのコレクションに記録されますが、パイプラインは続行する必要があります。 

このプロセッサーはオプションですが、CommerceUsers が ECS でサポートされている場合は推奨されます。

DeleteUserInCMS – 必須

Sitecore のユーザーを削除します。

注記

ユーザー アカウントが存在しない場合、パイプラインは中止されます。 

このプロセッサーは、CommerceUserCommerceCustomer 間の 1 対多の関係を保存するために必須です。それが ECS で処理される場合、プロセッサーは必須ではありません。

TriggerDMSEvent – [ユーザー アカウントは削除されました] ページ イベントが、User name と ShopName の値でトリガーされます。

DisableUser パイプライン

名前:

DisableUser

説明:

このパイプラインは、既存のユーザー アカウントを無効にする役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - ユーザー エンティティとコメントが含まれます。パイプラインを呼び出す前に設定されます。

応答 - パイプラインが呼び出された後に読み取られます。

プロセッサー:

DisableUserInECS – オプション

外部コマース システムの既存のユーザーを無効にします。

DisableUserInCMS – 必須

Sitecore でユーザーを無効にします。

注記

ユーザーは最初に外部で無効化を試みられるため、ビジネス ルールが原因でパイプラインが中止され、ユーザーが同期されたままになる可能性があります。 

このプロセッサーは、CommerceUserCommerceCustomer 間の 1 対多の関係を保存するために必須です。それが ECS で処理される場合、プロセッサーは必須ではありません。

TriggerDMSEvent – [ユーザー アカウントは無効化されました] ページ イベントが、User name、ShopName、提供されるコメントの値でトリガーされます。

EnableUser パイプライン

名前:

EnableUser

説明:

このパイプラインは、既存のユーザー アカウントを有効化する役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - ユーザー エンティティとコメントが含まれます。パイプラインを呼び出す前に設定されます。

応答 - パイプラインが呼び出された後に読み取られます。

プロセッサー:

EnableUserInECS – オプション

外部コマース システムの既存のユーザーを有効にします。

注記

このプロセッサーか次のプロセッサーのいずれかが、パイプラインに含まれている必要があります。通常、両方は含まれません。

EnableUserInCMS – 必須

Sitecore でユーザーを有効にします。

注記

ユーザーは最初に外部で有効化を試みられるため、ビジネス ルールが原因でパイプラインが中止され、ユーザーが同期されたままになる可能性があります。 

このプロセッサーは、CommerceUserCommerceCustomer 間の 1 対多の関係を保存するために必須です。それが ECS で処理される場合、プロセッサーは必須ではありません。

TriggerDMSEvent – [ユーザー アカウントは有効化されました] ゴールが、User name、ShopName、提供されるコメントの値でトリガーされます。

GetUser パイプライン

名前:

GetUser

説明:

単一のユーザー アカウントを返します。

使用方法:

訪問者に特定のユーザー アカウントが必要な場合に Sitecore から呼び出されます

引数:

リクエスト – ShopName と User ID が含まれています。パイプラインを呼び出す前に設定されます。

応答 – 単一のユーザー エンティティを返します。パイプラインが呼び出された後に読み取られます。

プロセッサー:

GetUserFromECS – オプション

指定されたユーザーを外部コマース システムから取得します。

注記

このプロセッサーか次のプロセッサーのいずれかが、パイプラインに含まれている必要があります。通常、両方は含まれません。 

このプロセッサーはオプションですが、CommerceUsers が ECS でサポートされている場合は推奨されます。

GetUserFromCMS – 必須

指定されたユーザーを CMS から取得します。

注記

このプロセッサーか前のプロセッサーのいずれかが、パイプラインに含まれている必要があります。通常、両方は含まれません。

GetUsers パイプライン

名前:

GetUsers

説明:

ユーザー アカウントを照会して返します。

さまざまな入力パラメーターが提供され、それらは論理積の andを使用して結合されます。

使用方法:

訪問者がアカウント登録しているときに Sitecore から呼び出されます。これはチェックアウト プロセス中またはプレーン サインアップを介して行われます。

引数:

要求 - 検索パラメーターが含まれます。パイプラインを呼び出す前に設定されます。

応答 – ユーザー エンティティのリストを返します。パイプラインが呼び出された後に読み取られます。

プロセッサー:

GetUsersFromECS – オプション

外部コマース システムのユーザーに対するクエリ。

注記

このプロセッサーか次のプロセッサーのいずれかが、パイプラインに含まれている必要があります。通常、両方は含まれません。 

このプロセッサーはオプションですが、CommerceUsers が ECS でサポートされている場合は推奨されます。

GetUsersFromCMS – 必須

CMS のユーザーに対するクエリ。

注記

このプロセッサーか前のプロセッサーのいずれかが、パイプラインに含まれている必要があります。通常、両方は含まれません。

CreateCustomer パイプライン

名前:

CreateCustomer

説明:

このパイプラインは、顧客アカウントを作成する役割を果たします。顧客はコマース システムによって管理されます。

使用方法:

Sitecore から呼び出されます

引数:

要求 - 顧客エンティティが含まれます。パイプラインを呼び出す前に設定されます。

応答 - パイプラインが呼び出された後の顧客エンティティを含みます。

プロセッサー:

CreateCustomerInECS – オプション

顧客が ECS でサポートされているかどうかによって異なります

外部コマース システムで顧客を作成します。

これは、次の手順で行います。

  • 外部システムで一意の顧客アカウントを作成します。

  • 顧客と特定のユーザー アカウント間のマッピングを作成します。

注記

外部 ID が解析され、顧客がすでに存在する場合、何も起こりません。

CreateCustomerInSitecore – (必須)

Sitecore で顧客を作成します。

注記

このプロセッサーは、CommerceUser と CommerceCustomers 間の 1 対多の関係を保存するために必須です。それが ECS で処理される場合、プロセッサーは必須ではありません。

TriggerDMSGoal – [顧客アカウントが作成されました] ゴールは、CustomerName と ShopName でトリガーされます。

UpdateCustomer パイプライン

名前:

UpdateCustomer

説明:

このパイプラインは、既存の顧客アカウントを更新する役割を果たします。顧客はコマース システムによって管理されます。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - 顧客エンティティが含まれます。パイプラインを呼び出す前に設定されます。

応答 - 顧客オブジェクトが含まれます。パイプラインが呼び出された後に読み取られます。

プロセッサー:

UpdateCustomerInECS – 必須

外部コマース システムで顧客を更新します。

SaveCustomertoEAState – 必須

前のプロセッサーから返された、更新された CommerceCustomer に基づいて、EA 状態に保存されている顧客を更新します。

TriggerDMSEvent – [顧客アカウントが更新されました] ゴールは、CustomerName と ShopName でトリガーされます。

DeleteCustomer パイプライン

名前:

DeleteCustomer

説明:

このパイプラインは、既存の顧客アカウントを削除する役割を果たします。顧客はコマース システムによって管理されます。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - 顧客エンティティが含まれます。パイプラインを呼び出す前に設定されます。

応答 -

プロセッサー:

DeleteCustomerInECS – 必須

外部システムで顧客を削除します。

注記

顧客アカウントが存在しない場合は、返された外部システム メッセージのコレクションに記録されますが、パイプラインは続行する必要があります。

RemoveCustomerFromEAState – 必須

EA 状態に保存されている顧客を削除します。

TriggerDMSEvent – [顧客アカウントは削除されました] ゴールは、CustomerName と ShopName でトリガーされます。

DisableCustomer パイプライン

名前:

DisableCustomer

説明:

このパイプラインは、既存の顧客アカウントを無効にする役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - 顧客エンティティとコメントが含まれます。パイプラインを呼び出す前に設定されます。

応答 – 無効化された顧客エンティティパイプラインが呼び出された後に読み取られます。

プロセッサー:

DisableCustomerInECS –

外部コマース システムの既存の顧客を無効にします。

SaveCustomertoEAState – 必須。

前のプロセッサーから返された、更新された CommerceCustomer に基づいて、EA 状態に保存されている顧客を更新します。

TriggerDMSEvent – [顧客アカウントが無効化されました] ページ イベントが、Name、ShopName、提供されるコメントの値でトリガーされます。

EnableCustomer パイプライン

名前:

EnableCustomer

説明:

このパイプラインは、既存の顧客アカウントを有効にする役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - 顧客エンティティとコメントが含まれます。パイプラインを呼び出す前に設定されます。

応答 – 有効化された顧客エンティティパイプラインが呼び出された後に読み取られます。

プロセッサー:

EnableCustomerInECS –

外部コマース システムの既存の顧客を有効にします。

SaveCustomertoEAState – 必須

前のプロセッサーから返された、更新された CommerceCustomer に基づいて、EA 状態に保存されている顧客を更新します。

TriggerDMSEvent –

[顧客アカウントは有効化されました] ページ イベントが、Name、ShopName、提供されるコメントの値でトリガーされます。

GetCustomer パイプライン

名前:

GetCustomer

説明:

指定された ID を持つ単一の顧客エンティティを返します。

顧客が ECS か CMS のどちらから取得されるかは、ECS での顧客のサポートよって異なります。

使用方法:

Sitecore から呼び出されます。

引数:

リクエスト – ShopName と Customer ID が含まれています。パイプラインを呼び出す前に設定されます。

応答 - パイプラインが呼び出された後、単一の顧客エンティティを返します。

プロセッサー:

GetCustomerFromECS – オプション。

指定された顧客を外部コマース システムから取得します。

注記

このプロセッサーか次のプロセッサーのいずれかが、パイプラインに含まれている必要があります。通常、両方は含まれません。

GetCustomersFromCMS – 必須。

指定された顧客を CMS から取得します。

注記

このプロセッサーか前のプロセッサーのいずれかが、パイプラインに含まれている必要があります。通常、両方は含まれません。

GetCustomers パイプライン

名前:

GetCustomers

説明:

顧客アカウントを照会して返します。

さまざまな入力パラメーターが提供され、それらは論理積の andを使用して結合されます。

顧客が ECS か CMS のどちらから取得されるかは、ECS での顧客のサポートよって異なります。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - 検索パラメーターが含まれます。パイプラインを呼び出す前に設定されます。

応答 - パイプラインが呼び出された後、顧客エンティティのリストを返します。

プロセッサー:

GetCustomersFromECS – オプション。

外部コマース システムの顧客に対するクエリ。必要な検索機能が ECS でサポートされていない場合は、CMS で顧客を検索することにより処理できる可能性があります。

注意: このプロセッサーか次のプロセッサーのいずれかが、パイプラインに含まれている必要があります。通常、両方は含まれません。

GetCustomersFromCMS – オプション。

CMS の顧客に対するクエリ。必要な検索機能が CMS でサポートされていない場合は、ECS でユーザーを検索することにより処理できる可能性があります。

注意: このプロセッサーか前のプロセッサーのいずれかが、パイプラインに含まれている必要があります。通常、両方は含まれません。

AddCustomerParties パイプライン

名前:

AddCustomerParties

説明:

このパイプラインは、指定された顧客に顧客パーティーを追加する役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - 顧客と CustomerParty インスタンスのリストが含まれています。パイプラインを呼び出す前に設定されます。

応答 – 顧客の新規インスタンス。パイプラインが呼び出された後に読み取られます。

プロセッサー:

AddCustomerParties –

役割: 提供されたパーティーを顧客アカウントに追加し、それらを持続させます。

使用方法: 必須。

所有権: プロセッサーは Connect を使用して提供され、Sitecore メンバーシップ プロバイダーを使用して顧客アカウントを持つパーティーを保存します。

カスタマイズ: すぐにカスタマイズする必要はありません。

パーティーを ECS に保存するために個別のプロセッサーが必要です。プロセッサーは、このプロセッサーを置き換えるか、このプロセッサーに加えて追加する必要があります。

RemoveCustomerParties パイプライン

名前:

RemoveCustomerParties

説明:

このパイプラインは、指定された顧客から顧客パーティーを削除する役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - 顧客と CustomerParty インスタンスのリストが含まれています。パイプラインを呼び出す前に設定されます。

応答 – 顧客の新規インスタンス。パイプラインが呼び出された後に読み取られます。

プロセッサー:

RemoveCustomerParties –

役割: 提供されたパーティーを顧客アカウントから削除します。

使用方法: 必須。

所有権: プロセッサーは Connect を使用して提供され、Sitecore 内で持続されなくなったパーティーを削除します。

カスタマイズ: すぐにカスタマイズする必要はありません。

パーティーを ECS に保存するために個別のプロセッサーが必要です。プロセッサーは、このプロセッサーを置き換えるか、このプロセッサーに加えて追加する必要があります。

UpdateCustomerParties パイプライン

名前:

UpdateCustomerParties

説明:

このパイプラインは、指定された顧客について顧客パーティーを更新する役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - 顧客と CustomerParty インスタンスのリストが含まれています。パイプラインを呼び出す前に設定されます。

応答 – 顧客の新規インスタンス。パイプラインが呼び出された後に読み取られます。

プロセッサー:

UpdateCustomerParties –

役割: 顧客アカウントの提供されたパーティーを更新し、それらを持続させます。

使用方法: 必須。

所有権: プロセッサーは Connect を使用して提供され、Sitecore メンバーシップ プロバイダーを使用して顧客アカウントを持つ更新されたパーティーを保存します。

カスタマイズ: すぐにカスタマイズする必要はありません。

パーティーを ECS に保存するために個別のプロセッサーが必要です。プロセッサーは、このプロセッサーを置き換えるか、このプロセッサーに加えて追加する必要があります。

AddParties パイプライン

名前:

AddParties

説明:

このパイプラインは、指定された顧客にパーティーを追加する役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - 顧客と CustomerParty インスタンスのリストが含まれています。パイプラインを呼び出す前に設定されます。

応答 – 顧客の新規インスタンス。パイプラインが呼び出された後に読み取られます。

プロセッサー:

AddParties –

役割: 提供されたパーティーを顧客アカウントに追加し、それらを持続させます。

使用方法: 必須。

所有権: プロセッサーは Connect を使用して提供され、Sitecore メンバーシップ プロバイダーを使用して顧客アカウントを持つパーティーを保存します。

カスタマイズ: すぐにカスタマイズする必要はありません。

パーティーを ECS に保存するために個別のプロセッサーが必要です。プロセッサーは、このプロセッサーを置き換えるか、このプロセッサーに加えて追加する必要があります。

RemoveParties パイプライン

名前:

RemoveParties

説明:

このパイプラインは、指定された顧客とともに保存されているパーティーを削除する役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - 顧客とパーティーのインスタンスのリストが含まれています。パイプラインを呼び出す前に設定されます。

応答 – 顧客の新規インスタンス。パイプラインが呼び出された後に読み取られます。

プロセッサー:

RemoveParties –

役割: 提供されたパーティーを顧客アカウントから削除します。

使用方法: 必須。

所有権: プロセッサーは Connect を使用して提供され、Sitecore 内で持続されなくなったパーティーを削除します。

カスタマイズ: すぐにカスタマイズする必要はありません。

パーティーを ECS に保存するために個別のプロセッサーが必要です。プロセッサーは、このプロセッサーを置き換えるか、このプロセッサーに加えて追加する必要があります。

UpdateParties パイプライン

名前:

UpdateParties

説明:

このパイプラインは、指定された顧客について顧客パーティーを更新する役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - 顧客と CustomerParty インスタンスのリストが含まれています。パイプラインを呼び出す前に設定されます。

応答 – 顧客の新規インスタンス。パイプラインが呼び出された後に読み取られます。

プロセッサー:

UpdateParties –

役割: 顧客アカウントについて提供されたパーティーを更新し、それらを持続させます。

使用方法: 必須。

所有権: プロセッサーは Connect を使用して提供され、Sitecore メンバーシップ プロバイダーを使用して顧客アカウントを持つ更新されたパーティーを保存します。

カスタマイズ: すぐにカスタマイズする必要はありません。

パーティーを ECS に保存するために個別のプロセッサーが必要です。プロセッサーは、このプロセッサーを置き換えるか、このプロセッサーに加えて追加する必要があります。

GetParties パイプライン

名前:

GetParties

説明:

このパイプラインは、パーティーを取得する役割を果たします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - 顧客が含まれます。パイプラインを呼び出す前に設定されます。

応答 – パーティーのリスト。パイプラインが呼び出された後に読み取られます。

プロセッサー:

GetParties –

役割: 顧客とともに保存されているパーティーの完全なリストを返します。

使用方法: 必須。

所有権: プロセッサーは Connect を使用して提供され、Sitecore メンバーシップ プロバイダーを使用して顧客アカウントを持つパーティーを保存します。

カスタマイズ: すぐにカスタマイズする必要はありません。

パーティーを ECS に保存するために個別のプロセッサーが必要です。プロセッサーは、このプロセッサーを置き換えるか、このプロセッサーに加えて追加する必要があります。

Do you have some feedback for us?

If you have suggestions for improving this article,