Configure the maximum relative item path length

Abstract

How to configure the maximum relative item path length of the Sitecore Content Serialization (SCS) system.

A correctly configured maximum relative item path length ensures that the Sitecore Content Serialization (SCS) system does not violate the maximum path and file name lengths of your file system. For Microsoft NTFS, the maximum length is 240.

To configure the maximum relative item path length:

  1. Go to your project folder.

  2. Open the sitecore.json file.

  3. Locate the defaultMaxRelativeItemPathLength property:

    "serialization": {
      "defaultMaxRelativeItemPathLength": 120,
      "defaultModuleRelativeSerializationPath": "serialization"
    }
  4. Change the value to the maximum relative item path length calculated with this formula: The maximum relative item path length = the file system maximum path and file name length - (the base path length + the serialization path length).

    Important

    You must include path separators such as / and \ when counting path lengths.

    A maximum relative item path length of 100-200 is a reasonable choice for maximum compatibility.