TDS Serialization and Long Item / File Paths

Cover Image for TDS Serialization and Long Item / File Paths

In a recent project, I needed to serialize all of the items included in the Data Exchange Framework (DEF) and D365 connector modules.

The challenge is that the items have long names and deeply nested paths. Windows has a default 256 character file path limit.

I saw errors like this when getting the Sitecore items into the TDS project:


_1
An exception occured while updating the sitecore item xxxxxx


_13
Exception Could not find a part of the path 'C:\projects\ClientName\src\Foundation\DataExchange\serialization\ClientName.Foundation.DataExchange.TDS.Master\sitecore\templates\Data Exchange\Framework\Folders\Folders for Data Access\Base Mappings Applied Action Rules for Provider Root\__Standard Values.item'. (DirectoryNotFoundException):
_13
at System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)
_13
at System.IO.FileStream.Init(String path, FileMode mode, FileAccess access, Int32 rights, Boolean useRights, FileShare share, Int32 bufferSize, FileOptions options, SECURITY_ATTRIBUTES secAttrs, String msgPath, Boolean bFromProxy, Boolean useLongPath, Boolean checkHost)
_13
at System.IO.FileStream..ctor(String path, FileMode mode, FileAccess access, FileShare share, Int32 bufferSize, FileOptions options, String msgPath, Boolean bFromProxy, Boolean useLongPath, Boolean checkHost)
_13
at System.IO.File.InternalWriteAllBytes(String path, Byte[] bytes, Boolean checkHost)
_13
at System.IO.File.WriteAllBytes(String path, Byte[] bytes)
_13
at HedgehogDevelopment.SitecoreProject.VSIP.SitecoreItemNode.RefreshSitecoreInfo(String sitecoreItemPath)
_13
at HedgehogDevelopment.SitecoreProject.VSIP.SitecoreProjectNode.CreateSitecoreItemNode(String localItemPath, String sitecoreIcon, HierarchyNode parent)
_13
at HedgehogDevelopment.SitecoreProject.VSIP.Dialogs.GetItemStatus.<>c__DisplayClass19_2.<GetItem>b__3()
_13
at HedgehogDevelopment.SitecoreProject.VSIP.Utils.Support.<>c__DisplayClass62_0.<DispatchToUIThread>b__0()
_13
Exception Object reference not set to an instance of an object. (NullReferenceException):
_13
at HedgehogDevelopment.SitecoreProject.VSIP.Dialogs.GetItemStatus.GetItem(CheckedSitecoreItem item, Dictionary`2 createdNodes)
_13
at HedgehogDevelopment.SitecoreProject.VSIP.Dialogs.GetItemStatus.GetItemsWorker()

TDS has a great guide on how to overcome this issue, and I can confirm that it works well. Thanks to the Hedgehog team!

https://www.teamdevelopmentforsitecore.com/Blog/file-length-error-tds

Here's how I applied the aliases:


_10
Parent Item 1 ==> Alias of "1"
_10
- Child Item 1 ==> Alias of "1"
_10
- Child Item 2 ==> Alias of "2"
_10
- Child Item 3 ==> Alias of "3"
_10
- Child Item 4 ==> Alias of "4"
_10
Parent Item 2 ==> Alias of "2"
_10
- Child Item 1 ==> Alias of "1"
_10
- Child Item 2 ==> Alias of "2"
_10
- Child Item 3 ==> Alias of "3"
_10
- Child Item 4 ==> Alias of "4"

TDS File System Alias

Something to keep in mind is that just because the file system aliases work on your machine, that does not guarantee that it will work on other machines. Other developers and upstream environments may be pulling the files into different, more deeply nested areas of the file system. For this reason, err on the side of using file system aliases wherever paths start getting close to the path limit.

Works on my machine

Keep BUIDLing,

Marcel


More Stories

Cover Image for Troubleshooting 502 Responses in Azure App Services

Troubleshooting 502 Responses in Azure App Services

> App Services don't support all libraries

Cover Image for NextJS: Short URL for Viewing Layout Service Response

NextJS: Short URL for Viewing Layout Service Response

> Because the default URL is 2long4me

Cover Image for Tips for Forms Implementations

Tips for Forms Implementations

> And other pro tips

Cover Image for NextJS: Unable to Verify the First Certificate

NextJS: Unable to Verify the First Certificate

> UNABLE_TO_VERIFY_LEAF_SIGNATURE

Cover Image for SPE Script Performance & Troubleshooting

SPE Script Performance & Troubleshooting

> Script never ends or runs too slow? Get in here.

Cover Image for How to Run Old Versions of Solr in a Docker Container

How to Run Old Versions of Solr in a Docker Container

> Please don't make me install another version of Solr on my local...

Cover Image for Tips for New Sitecore Developers

Tips for New Sitecore Developers

> Because learning Sitecore can be hard

Cover Image for Content Editor Search Bar Not Working

Content Editor Search Bar Not Working

> Sometimes it works, sometimes not

Cover Image for NextJS/JSS Edit Frames Before JSS v21.1.0

NextJS/JSS Edit Frames Before JSS v21.1.0

> It is possible. We have the technology.

Cover Image for Azure PaaS Cache Optimization

Azure PaaS Cache Optimization

> App Services benefit greatly from proper configuration

Cover Image for Add TypeScript Type Checks to RouteData fields

Add TypeScript Type Checks to RouteData fields

> Inspired by error: Conversion of type may be a mistake because neither type sufficiently overlaps with the other.

Cover Image for Sitecore Symposium 2022

Sitecore Symposium 2022

> What I'm Watching 👀

Cover Image for Tips for Applying Cumulative Sitecore XM/XP Patches and Hotfixes

Tips for Applying Cumulative Sitecore XM/XP Patches and Hotfixes

> It's probably time to overhaul your processes

Cover Image for Symposium 2022 Reflections

Symposium 2022 Reflections

> Sitecore is making big changes

Cover Image for Super Fast Project Builds with Visual Studio Publish

Super Fast Project Builds with Visual Studio Publish

> For when solution builds take too long

Cover Image for On Sitecore Stack Exchange (SSE)

On Sitecore Stack Exchange (SSE)

> What I've learned, what I see, what I want to see

Cover Image for Don't Ignore the HttpRequestValidationException

Don't Ignore the HttpRequestValidationException

> Doing so could be... potentially dangerous

Cover Image for Ideas For Docker up.ps1 Scripts

Ideas For Docker up.ps1 Scripts

> Because Docker can be brittle

Cover Image for Hello World

Hello World

> Welcome to the show

Cover Image for Script: Boost SIF Certificate Expiry Days

Script: Boost SIF Certificate Expiry Days

> One simple script that definitely won't delete your system32 folder

Cover Image for Year in Review: 2022

Year in Review: 2022

> Full steam ahead

Cover Image for JSS + TypeScript Sitecore Project Tips

JSS + TypeScript Sitecore Project Tips

> New tech, new challenges

Cover Image for NextJS: Access has been blocked by CORS policy

NextJS: Access has been blocked by CORS policy

> CORS is almost as much of a nuisance as GDPR popups

Cover Image for Early Returns in React Components

Early Returns in React Components

> When and how should you return early in a React component?

Cover Image for JSS: Reducing Bloat in Multilist Field Serialization

JSS: Reducing Bloat in Multilist Field Serialization

> Because: performance, security, and error-avoidance

Cover Image for On Mentorship and Community Contributions

On Mentorship and Community Contributions

> Reflections and what I learned as an MVP mentor