How to Resolve ‘Error Reading Included File’ in NetSuite FreeMarker Templates

When encountering issues with the #include tag in FreeMarker email templates, particularly an "Error reading included file," the field type used for storing the file path can be a critical factor. NetSuite's FreeMarker engine appears to handle different field types with varying behaviors, especially concerning string escaping.Free-form text fields are subject to HTML escaping when rendered in FreeMarker templates, particularly when their content is used within quotation marks. This escaping can inadvertently alter file paths, leading to errors when the #include directive attempts to resolve the path.In contrast, switching the path's field type from free-form text to hyperlink can resolve this issue. While hyperlink fields are designed for URLs and often require less explicit escaping for direct URL insertion, it is important to note that robust rendering may still necessitate specific FreeMarker formatting (e.g., concatenation or the ?no_esc built-in) to ensure the URL is correctly processed without unwanted characters. The direct interaction of the #include tag with these field types for file paths may vary depending on field configuration and NetSuite version.Therefore, when a soft-coded string representing a file path is required within a FreeMarker email template, especially for use with the #include tag, it is recommended to use a hyperlink field type rather than a standard free-form text field to mitigate potential escaping issues.