パッチ ファイルを使用してSitecore設定をカスタマイズする

パッチ ファイルは、Sitecoreインストールの /App_Config/Includeフォルダーに直接またはサブフォルダーに配置する必要があります。パッチ ファイルには、拡張子.configで終わる名前を付ける必要があります。

Sitecoreは、パッチ ファイルをアルファベット順にマージします。フォルダ内のファイルは、フォルダ内のサブフォルダ内のファイルよりも先にマージされます。たとえば、ファイル /App_Config/Include/mywebsite9.configは、ファイル /App_Config/Include/Myfolder/mywebsite1.configの前にマージされます。

Sitecoreが複数のパッチ ファイルで同じ設定を見つけた場合、マージされる最後のパッチ ファイルによって、設定の以前のバージョンが上書きされます。

たとえば、次のリストのすべてのファイルで同じ設定が定義されている場合、Sitecoreは最後にリストされたファイルの設定のみを使用します。

次のXML名前空間には、パッチ適用に関連するすべての属性と要素が含まれています。

名前空間をパッチ ファイルで使用する前に、名前空間を宣言する必要があります。通常は、ファイルの先頭で宣言します。

<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/" 
xmlns:set="http://www.sitecore.net/xmlconfig/set/">
. . . . . 
. . . . .
</configuration>

Sitecoreは、パッチ ファイルからの変更を適用するときに、パッチ ファイルの各要素を既存の設定の要素と一致させようとします。これは、要素名と要素のすべての属性の組み合わせを使用して要素を照合します。一致するものがある場合、Sitecoreは既存の要素を更新します。一致するものがない場合、Sitecoreは新しい要素を挿入します。

デフォルトでは、Sitecoreは、要素が属する設定セクションの最後に新しい要素を挿入します。要素内のpatch: 属性を使用して、既存の要素に対して相対的に配置される場所を指定したり、同じ名前の既存の要素を置き換え、更新、または削除するように指定したりできます。次の属性を使用できます。

たとえば、websiteという名前のサイトの前にサイトを追加するには、次の構文を使用します。

<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
  <sitecore>
    <sites>
      <site patch:before=”*[@name='website']” name=”mysite” ... />
    </sites>
  </sitecore>
</configuration>

パッチ ファイルの例を使用して、Sitecoreの設定を変更することができます。

パッチファイルの詳細については、インクルードファイルパッチ機能ガイドを参照してください。この説明は、主にSitecoreバージョン6に関連していることに注意してください。

実行時に使用される設定ファイルを表示するには、URL http://<hostName>/sitecore/admin/showconfig.aspxを読み込みます。

Sitecoreインスタンス マネージャーの設定ビルダーを使用して、マージ プロセスをシミュレートすることもできます。Config Builderは、すべてのパッチ ファイルをSitecore.configファイルにマージし、結果のファイルを任意の場所に保存できるようにします。その後、設定の変更が期待どおりにパッチが適用されたかどうかを確認できます。

Config Builderは、Sitecore Instance ManagerのHomeタブのBundled Toolsの下にあります。設定ビルダーを選択する前に、Sitecoreサイトを選択する必要があります。