Sitecore XP Identity ServerのSitecore Experience Commerce 10 .0および10.1互換性アップデートについて


解説

Sitecore Experience Platform (XP) のアップデート リリース SXP 10.0 Update-3 および SXP 10.1 Update-2 では、.NET Core 3.1 をベースに用いた新しい Sitecore Identity Server バージョン 4.1.1が導入されました。これらのSitecore XPアップデート リリースにおきましては、新しいSitecore Identity Serverバージョンに接続するために、Sitecore Experience Commerce (XC)において、若干の設定変更が必要となります。

既存のデプロイメントを更新するには、Sitecore XC ファイルのSitecore.Commerce.IdentityServer.Host.xmlを置き換えるか、または手動で更新する必要があります。

この Sitecore XC 設定の変更以外に、Sitecore XP アップデート リリースとの互換性を保つためにSitecore XC 内でコードを変更する必要がないため、これに対応する新しいSitecore XC アップデート リリースはありません。

Experience CommerceのIdentity Server Hostファイル更新について

Sitecore.Commerce.IdentityServer.Host.xmlのアップデート用ファイルは、Sitecore.Identity.Config.Commerce.[release].scwdp.zipパッケージ内に格納されています。下記よりダウンロードしてください。

オンプレミス環境でのインストール手順:Hostファイルをそのまま使用する場合

Sitecore.Commerce.IdentityServer.Host.xmlファイルが、貴社デプロイメント内で変更されていない場合 (新しい Sitecore XC をデプロイした時など)、更新されたSitecore.Identity.Config.Commerce.[release].scwdp.zipパッケージを、release.zipのパッケージをホストしている場所にデプロイします。

オンプレミス環境でのインストール手順:Hostファイルを変更した場合

Sitecore.Commerce.IdentityServer.Host.xmlファイルが、貴社デプロイメント内で既に変更されている場合は、以下の指示に従って変更をカスタマイズ済のファイルに統合してください。この指示に従う場合は、Sitecore.Commerce.IdentityServer.Host.xmlのアップデート用ファイル(本ドキュメントの前半をご確認ください)は、参照用以外では使用しません。

  1. 元のIdentity ServerインストールのSitecore.Commerce.IdentityServer.Host.xmlの元ファイルを用意します。
  2. Sitecore.Commerce.IdentityServer.Host.xmlファイルを元のIdentity Serverからコピーし、\config\production下にインストールします。
  3. 下記のように、変更と追加を行います。
          <ApiScopes>
            <EngineApiScope>
              <Name>EngineAPI</Name>
              <DisplayName>Commerce Engine API</DisplayName>
            </EngineApiScope>
            <PostmanApiScope>
              <Name>postman_api</Name>
              <DisplayName>Postman API</DisplayName>
            </PostmanApiScope>
          </ApiScopes>
    既存の<ApiResources>下に、下記のように太字の<Scopes>を追加します。
          <ApiResources>
            <EngineApiResource>
              <Name>EngineAPI</Name>
              <DisplayName>Engine API</DisplayName>
              <ApiSecrets>
                <ApiSecret1>secret</ApiSecret1>
              </ApiSecrets>
              <UserClaims>
                <UserClaim1>name</UserClaim1>
                <UserClaim2>email</UserClaim2>
                <UserClaim3>role</UserClaim3>
              </UserClaims>
              <Scopes>
                <Scope1>EngineAPI</Scope1>
              </Scopes>
            </EngineApiResource>
            <PostmanApiResource>
              <Name>postman_api</Name>
              <DisplayName>Postman API</DisplayName>
              <ApiSecrets>
                <ApiSecret1>secret</ApiSecret1>
              </ApiSecrets>
              <UserClaims>
                <UserClaim1>name</UserClaim1>
                <UserClaim2>email</UserClaim2>
                <UserClaim3>role</UserClaim3>
              </UserClaims>
              <Scopes>
                <Scope1>postman_api</Scope1>
              </Scopes>
            </PostmanApiResource>
          </ApiResources>
  4. \config\production下の新しいIdentity Serverインストールから、Sitecore.Commerce.IdentityServer.Host.xmlファイルをコピーします。
  5. 新しいIdentity ServerのURLが変更されている場合は、以下の場所でURLを更新してSitecore XCの既存の参照を置き換える必要があります。
    • Commerce Engine: wwwroot\config.jsonの「SitecoreIdentityServerUrl」を変更します。
    • BizFX: assets\config.jsonの「IdentityServerUri」を変更します。
    • Postman: 既存の環境(例:Habitat環境)で「SitecoreIdServerHost」を変更します。

コンテナー デプロイメント向けのインストール手順

Sitecore XP 10.0 Update-3およびSitecore XP 10.1 Update-2のIdentity Serverイメージの名前が、「IS6」というサフィックス付きのものに変更されました。Sitecore Commerce Container SDKの最新版がリリースされたことにより、新しいSitecore XP Identity Serverの名前が参照されるようになりました。下記の手順で、Sitecore Commerceコンテナー イメージの再構築を行ってください。

  1. Sitecore Commerce Container SDKの該当する最新版をダウンロードします。

    SXC Sitecore Commerce Container SDK 10.0.1.60238.1126

    SXC Sitecore Commerce Container SDK 10.1.0.70162.20171

  2. 新しいSitecore.Identity.Config.Commerce.[release].scwdp.zipのパッケージをダウンロードします(本ドキュメントの前半をご確認ください)。
  3. カスタム Commerce コンテナー イメージを作成するためのワークフロー」のガイダンスに従って、イメージを再構築します。PrepContainerbuild.ps1(「コンテナー イメージのコンテンツの取得」セクション)を実行する前に、リリース パッケージ内の元のSitecore.Identity.Config.Commerce.x.x.scwdp.zipファイルを、前述の手順でダウンロード済みファイルに置き換えるようにしてください。
  4. カスタム コンテナーのデプロイとテストを実施してください。