Sitecoreコンテンツのシリアル化

除外フィールドの構成

Version:

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

シリアル化から除外するフィールドを指定するには、sitecore.jsonファイルと *modules.jsonファイルで除外するフィールドを構成します。

メモ

除外フィールド機能は、CLI 4.0以降で使用できます。

除外フィールドの設定は、CLIコマンドpackage、watch、およびdiffでも可能です。

excludedFieldsプロパティには、除外されたフィールドの配列と、fieldIdとdescriptionの2つのプロパティが含まれています。

大事な

同期操作は常にignore excluded fields.Sitecoreでこれらのフィールドを変更しても、CLIは変更を検出しず、データをプッシュしても変更は上書きされません。YAMLファイル内のフィールドを除外した場合、含まれているフィールドが変更された後、またはその除外を手動で削除してpull操作を実行した場合にのみ、フィールドが削除されます。

すべてのフィールドを除外し、.ymlファイルにフィールドデータのない空のバージョンがある場合、それらのアイテムを .datパッケージに含めてインスタンスアイテムにアタッチすると、コンテンツエディターでバージョンが欠落します。

Revisionフィールドをシリアル化から除外すると、シリアル化コマンドで公開するときに問題が発生する可能性があります。

sitecore.jsonファイルで除外フィールドを設定する

sitecore.jsonファイルで、シリアル化から除外するフィールドを指定できます。

sitecore.jsonファイルで除外フィールドを設定するには:

sitecore.jsonファイルのserializationセクションを次のように変更します。

...
  "serialization": {
    "defaultMaxRelativeItemPathLength": 120,
    "defaultModuleRelativeSerializationPath": "serialization",
    "excludedFields": [
      {
        "fieldId": "badd9cf9-53e0-4d0c-bcc0-2d784c282f6a",
        "description": "__Updated by"
      },
      {
        "fieldId": "d9cf14b1-fa16-4ba6-9288-e8a174d4d522",
        "description": "__Updated"
      },
      {
        "fieldId": "5dd74568-4d4b-44c1-b513-0af5f4cda34f",
        "description": "__Created by"
      },
      {
        "fieldId": "25bed78c-4957-4165-998a-ca1b52f67497",
        "description": "__Created"
      },
      {
        "fieldId": "{52807595-0F8F-4B20-8D2A-CB71D28C6103}",
        "description": "__Owner"
      },
      {
        "fieldId": "{001DD393-96C5-490B-924A-B0F25CD9EFD8}",
        "description": "__Lock"
      }
    ]
  }

手記

ベースフィールド (同期しない標準テンプレートのフィールドなど) を指定します。これらは、特定のモジュール構成とは無関係にシリアル化中に考慮されます。

modules.jsonファイルで除外フィールドを設定する

modules.jsonファイルで、シリアル化から除外するフィールドを指定できます。

*modules.jsonファイルで除外フィールドを設定するには:

*module.jsonファイルのitemsセクションを次のように変更します。

...
items": {
        "includes": [
            {
                "name": "Apikey",
                "path": "/sitecore/system/Settings/Services/API Keys"
            },
            {
                "name": "Media",
                "path": "/sitecore/media library/my-first-jss-app"
            },
            {
                "name": "Templates",
                "path": "/sitecore/Templates/Project/my-first-jss-app"
            },
            {
                "name": "Content",
                "path": "/sitecore/content/my-first-jss-app"
            },
            {
                "name": "Layout",
                "path": "/sitecore/Layout/Layouts/Project/my-first-jss-app"
            },
            {
                "name": "Renderings",
                "path": "/sitecore/Layout/Renderings/Project/my-first-jss-app"
            },
            {
                "name": "Placeholders",
                "path": "/sitecore/Layout/Placeholder Settings/Project/my-first-jss-app"
            }
        ],
        "excludedFields":[
            {
				"fieldID": "{EB504D1B-B612-4FFF-B239-CA3BD7273D1B}",
				"description": "FieldsForExclude1"
			},
			{
				"fieldID": "{3C2C061E-F61F-4DF6-89EA-0B7A56348737}",
				"description": "FieldsForExclude2"
			},

			{
				"fieldID": "{4F7446A4-79C8-4853-A357-723665FE68DA}",
				"description": "ExcludeUnversionFIeld"
			}
        ]
    }

手記

この特定のモジュール設定ファイルのフィールドのみを指定します。

除外されたフィールドを確認する

前述のいずれかの方法を使用してフィールドをシリアル化から除外した後、serialization infoコマンドを使用して、除外したフィールドの概要または完全な詳細を表示できます。

設定された除外フィールドの概要を確認するには:

serialization infoコマンドを実行します。アウトプット：

Project
  Subtrees:
    Apikey: /sitecore/system/Settings/Services/API Keys
    Media: /sitecore/media library/my-first-jss-app
    Templates: /sitecore/Templates/Project/my-first-jss-app
    Content: /sitecore/content/my-first-jss-app
    Layout: /sitecore/Layout/Layouts/Project/my-first-jss-app
    Renderings: /sitecore/Layout/Renderings/Project/my-first-jss-app
    Placeholders: /sitecore/Layout/Placeholder Settings/Project/my-first-jss-app
      FieldsFilter Excludes: 3

Excluded Fields From Default Serialization Config:
      FieldsFilter Excludes: 7

設定された除外フィールドの詳細を確認するには:

serialization info -tコマンドを実行します。アウトプット：

Maximum subtree-relative item path allowed: 120

Project
  File: C:\Repos\Sitecore.DevEx\samples\Prototype\items/Project.module.json
  Subtrees:
...
      Excluded Fields:
        Field Id :{EB504D1B-B612-4FFF-B239-CA3BD7273D1B}: Description :FieldsForExclude1.
        Field Id :{3C2C061E-F61F-4DF6-89EA-0B7A56348737}: Description :FieldsForExclude2.
        Field Id :{4F7446A4-79C8-4853-A357-723665FE68DA}: Description :ExcludeUnversionFIeld.

Excluded Fields From Default Serialization Config:
      Excluded Fields:
        Field Id :8cdc337e-a112-42fb-bbb4-4143751e123f: Description :__Revision.
        Field Id :badd9cf9-53e0-4d0c-bcc0-2d784c282f6a: Description :__Updated by.
        Field Id :d9cf14b1-fa16-4ba6-9288-e8a174d4d522: Description :__Updated.
        Field Id :5dd74568-4d4b-44c1-b513-0af5f4cda34f: Description :__Created by.
        Field Id :25bed78c-4957-4165-998a-ca1b52f67497: Description :__Created.
        Field Id :{52807595-0F8F-4B20-8D2A-CB71D28C6103}: Description :__Owner.
        Field Id :{001DD393-96C5-490B-924A-B0F25CD9EFD8}: Description :__Lock.

この記事を改善するための提案がある場合は、お知らせください!