• 
• Updated On 4.1.8

Release Notes

This section contains release notes for CrafterCMS 4.1. For other release notes, please visit your release’s release notes page here: http://docs.craftercms.org or see below

Note

CrafterCMS 4.1.x requires Java 17

CrafterCMS 4.1.8

Released September 13, 2024

This release includes fixes for issues with the release version 4.1.7

Important

Please see Breaking changes for breaking changes and other things to consider before upgrading

For instructions on how to update your CrafterCMS install to 4.1.0 (applies to 4.1.8), please see Upgrading CrafterCMS

Bug Fixes

• Fixed issue with SAML integration not taking the user to the target page after authentication

For a complete list of community tickets, please visit: GitHub 4.1.8

For information on upgrading 3.1.x sites, see here

---

CrafterCMS 4.1.7

Released September 11, 2024

This release includes fixes for issues with the release version 4.1.6

Important

Please see Breaking changes for breaking changes and other things to consider before upgrading

For instructions on how to update your CrafterCMS install to 4.1.0 (applies to 4.1.7), please see Upgrading CrafterCMS

Bug Fixes

• Fixed race condition with multiple write operation API calls

• Fixed issue with author role failing to unlock an item when writing content

For a complete list of community tickets, please visit: GitHub 4.1.7

For information on upgrading 3.1.x sites, see here

---

CrafterCMS 4.1.6

Released August 19, 2024

This release includes fixes for issues with the release version 4.1.5

Important

Please see Breaking changes for breaking changes and other things to consider before upgrading

For instructions on how to update your CrafterCMS install to 4.1.0 (applies to 4.1.6), please see Upgrading CrafterCMS

Enhancements

• Improved startup message for "Error when creating PropertyDescriptor for public final void"

• Changed message in "FolderScanningSiteListResolver" to "Debug"

• Improved handling of content type read-only file-name with a default value

Studio UI

• getICEAttributes function (getICEAttributes from @craftercms/experience-builder or craftercms.xb.getICEAttributes) now accepts either the full model object (as it did) or two separate properties for modelId and path.

Bug Fixes

• Sort "Add" and "Browse Components" alphabetically

• Fixed issue with item selector maximum limit

• Fixed issue with checkbox-group while using the targeting user roles

• Fixed issue with custom "contentWrite" via content type controller not triggering reindex on Preview
  Added new interface for use in Studio, for writing content from an input stream and notifies subscribers. See Studio Content Write for more information.

• Fixed issue with empty/null Date/Time fields reporting it is valid

• Fixed issue with folders in path selection for search

• Fixed issue with new items in repeated groups requiring a refresh to show changes

• Fixed issue with PathNavigator ignoring the exclude list when searching

• Fixed issue with permission used in Dependency Service "getDependentItems"

• Fixed issue with item stuck in read only mode if the "lockedOwner" value is not null

• Fixed issue with Create Project failing due to missing index when multiple values for writeClusters are used

• Fixed issue with image cropper

Dependency Updates

• Noteworthy dependency updates:

  • OpenSearch to version 2.15

  • Apache CXF to version 3.5.8

  • GraphQL to version 20.9

  • Tomcat to version 9.0.93

  • Studio UI dependencies

    • yarn to version v1.22.22

    • node to version v21.7.3

For a complete list of community tickets, please visit: GitHub 4.1.6

For information on upgrading 3.1.x sites, see here

---

CrafterCMS 4.1.5

Released May 30, 2024

This release includes fixes for issues with the release version 4.1.4

Important

Please see Breaking changes for breaking changes and other things to consider before upgrading

For instructions on how to update your CrafterCMS install to 4.1.0 (applies to 4.1.5), please see Upgrading CrafterCMS

Enhancements

• Added support for indexing subtitle files and audio files

• Added support for variable types of _i and _f when using a dropdown control

• Added site unlock API
  The site unlock API allows an admin to unlock a site in LOCKED state.

• Added 'initialExpanded' prop to 'WidgetsAccordion' component

Bug Fixes

• Fixed issue with XB dropping request parameters on page view

• Fixed issue with Form freezing on save if user cancels a policy suggestion dialog

• Fixed issue with Image cropper increasing size of an image relative to the original

• Fixed issue with Studio not ingesting correctly a rename from lowercase to uppercase done directly in Git

• Fixed issue with Content Type Controller overwriting changes made to object in controller

• Fixed issue with Filename control rename dialog behaving differently than the initial create

• Fixed issue with double slash in path when using the Node selector datasource configuration

• Fixed the following roles and permissions defects in the UI:

  • Fixed issue where XB edit mode is blocked for pages that are readonly to the user, but contain items that the user does have write access to.

  • Fixed issue where the item selector items to which the user doesn’t have edit permissions, display the edit button. Clicking the edit button and trying to save an edit crashes the form leaving it in an unusable.

  • Fixed issue with adding a tree navigator with the path of the folder of a page shows an item which clicking it doesn’t take the user to preview as expected and clicking to open the item menu shows a skeletonised item menu that never resolves.

  • Fixed issue where the TreeNavigator UI doesn’t handle error in the service response and displays a spinner that doesn’t go away.

For a complete list of community tickets, please visit: GitHub 4.1.5

For information on upgrading 3.1.x sites, see here

---

CrafterCMS 4.1.4

Released May 1, 2024

This release includes fixes for issues with the release version 4.1.3

Important

Please see Breaking changes for breaking changes and other things to consider before upgrading

For instructions on how to update your CrafterCMS install to 4.1.0 (applies to 4.1.4), please see Upgrading CrafterCMS

Enhancements

• Updated Studio UI SDK writeContent API abstraction to use the supplied path without unexpected internal transformations.

• Extended valid email addresses accepted by Studio according to RFC 3696 section 2

• Added audio datasource support 'Audio Uploaded from Desktop' and 'Audio from Repository'

• Added support for changing the maximum configuration file size when using the write_configuration API
  See here for more information on setting the configuration content limit.

Bug Fixes

• Fixed issue with the Studio Configuration Editor saving an environment specific copy of the Project Policy Configuration file

• Fixed issue with docker compose deployments unable to duplicate projects

• Fixed issue with RTE Insert->Link using previewUrl instead of path

• Fixed issue with the transcoded-video control in XB returning XML instead of JSON

• Fixed issue with 'requireModule' and 'addJavascript' creating an incorrect url with 'buildFileUrl'.

• Fixed issues with XB when item selectors have flattening disabled for search

• Enforced Project Policy for all items in the Sidebar
  The new default project policy for filenames and automatic renaming rules is to lowercase everything except items under: /scripts, /templates, and /static-assets/app.
  See here for more information on the project policy configuration.

For a complete list of community tickets, please visit: GitHub 4.1.4

For information on upgrading 3.1.x sites, see here

---

CrafterCMS 4.1.3

Released March 11, 2024

This release includes fixes for issues with the release version 4.1.2

Important

Please see Breaking changes for breaking changes and other things to consider before upgrading

For instructions on how to update your CrafterCMS install to 4.1.0 (applies to 4.1.3), please see Upgrading CrafterCMS

Please see Upgrading 4.1.x -> 4.1.3 for important information on upgrading CrafterCMS version 4.1.x to 4.1.3

New Features

• New React JS empty blueprint added in the marketplace
  This blueprint is a great starting point for building your own React JS application.

• Studio header-based authentication now expects attribute secure_key in its own header
  See Configure Header-Based Authentication for more information on secure_key

Enhancements

• Git pull branch is now configurable

• Improved publish commit dialog confirmation

• Improved Crafter Studio startup times in orchestrated environments

• Improved XB communication status and error experience

• Improved “Publish by Commit ID” implementation

• Added ability to disable the Audit History job
  To learn more about disabling the audit history job, see the article Audit Log

• Added WebSocket support to Engine’s proxy
  See Proxy Configuration for examples on configuring proxies.

Bug Fixes

• Fixed issue with table buttons tool for in-context editing not working

• Fixed issue with inserting a link to RTE not working if the link starts with www when XB is enabled

• Fixed issue with node selector control

• Fixed issue with disableFlattening flag

• Fixed issue with Engine content store get item API empty value behavior
  Crafter Engine does not marshal single value fields with attributes as objects starting version 4.1.3 and later
  See Breaking changes for more information on the updates to Crafter Engine marshaling approach for fields with attributes.

• Fixed issue with children count and X more items button not working in the Sidebar Navigator tree

• Fixed issue with site screenshot request when proxy is enabled

• Fixed issue with lockOwner in workflow item_states

• Updated the S3 upload API to include the bucket name for the given profile

• Fixed issue with AWS File upload

• Fixed issue with video content item not disassociating from parent content item in React app

• Fixed issue with text area line breaks in XB

• Fixed issue with the Publish Commit Dialog incorrectly showing pending changes confirmation dialog

• Fixed issue with UI prepending a “/” to policy suggested file names

• Fixed issue with Publishing dialog failing when current date values are supplied in no-offset format

• Fixed issue with Audit logs

• Fixed issue with saving a profile without all attributes in Crafter Profile

• Fixed issue with the Form Engine calendar getting cut off when DateTime is the only control

• Fixed issue with Experience Builder not refreshing items on edit screen

• Fixed issue with Browse for Existingbutton not showing children pages of a page

• Improved get_configuration API performance

• Fixed issue with base repository path macros not working

• Fixed issue with single field form for an embedded component opening the full form

• Improved get_configuration API performance

• Fixed issue with Textarea input type ignoring rows and columns configuration

• Fixed issue with WebSocket proxy not working
  

• Fixed issue with Content-Type (text/html) incorrectly stated in response

• Fixed issue with unflattened content.
  

  Note

  The following is primarily an internal change. It would only affect those developing authoring applications using the functions described below either via @craftercms/studio-ui npm package or using the craftercms global on an authoring extension.

  New argument unflattenedPaths added to the bottom of the arguments list of the following functions:

  • utils/content/parseContentXML

  • utils/content/parseElementByContentType

  The argument should be an object that will be populated by the method with path: object pairs for the unflattened content items whose data is incomplete while processing. Note: This argument is likely to be required in the next versions of the package.

Dependency Updates

• Noteworthy dependency updates:

  • Spring Boot to version 2.7.18

  • Spring Framework to version 5.3.32

  • Spring Security to version 5.8.9

  • Tika to version 2.9.1

  • Tomcat to version 9.0.86

  • OpenSearch to version 2.9.0

  • Studio UI dependencies

    • yarn to version 4.0.2

    • @mui/* to version 5.15.7

    • jquery to version 3.7.1

    • moment to version 0.5.44

    • ace to version 1.32.5

    • bootstrap to version 5.3.2

  • JavaScript SDK dependencies

    • React to version 18.2.0

    • TypeScript to version 5.3.3

For a complete list of community tickets, please visit: GitHub 4.1.3

For information on upgrading 3.1.x sites, see here

---

CrafterCMS 4.1.2

Released October 29, 2023

This release includes fixes for issues with the release version 4.1.1

Important

Please see Breaking changes for breaking changes and other things to consider before upgrading

For instructions on how to update your CrafterCMS install to 4.1.0 (applies to 4.1.2), please see Upgrading CrafterCMS

New Features

• Added support for duplicating a project
  To learn more about duplicating a project, see the article Duplicating a Project

• Added "Search" option when inserting links in the RTE

• Added a user preference cache-clearing UI
  To learn more about clearing UI user preferences, see Account Management

Updates

• Engine now automatically reloads the context when it detects classes and config are changed

• Fixed issue with "getItem" call marshaled to JSON when content elements have either an attribute that is not required, a default text set, or an actual text value blank

• Added a SkipAll processor that allows skipping the item processing pipeline

• Fixed issue with targeting configuration of date-time control

• Fixed issue with dependency calculation when bulk publishing

• Fixed issue with the shared component path not updated when the parent is renamed

• Fixed issue when reverting a document with an internal name change

• Fixed issue with Deployer throwing NPE on startup

• Added support for configuring Preview edit mode defaults

  For more information on setting Preview edit mode defaults, see Preview Edit Mode Defaults

• Fixed issue with Studio search failing when searching with special characters

• Improved UI Experience
  

  • Updated Sidebar maximum width

  • Updated "Text Area" settings

  • Improved "Publishing by commit ID" dialog

  • Updated Node selector UI

  • Fixed issue with uploading files from RTE insert link option

  • Fixed issue with SVG images when using the "img-repository-upload" data source with the search option enabled

  • Fixed issue with XB printing error messages in the browser console when file-based items are not

  • Added a sort option to the sidebar path navigator component

  • The magnifying glass in a given nav tree is now always ‘active’

  • Fixed issue with the Datetime field’s timezone ({control-name}_dt_tz) field

  • Improved project listings screen and project creation experience

• Crafter Engine controllers now returns "HTTP 40x" on requests which cannot be resolved

• Fixed issue with content history when cutting and pasting content

• Fixed issue with GraphQL build failure when using a custom content type

• Improved API response in not found response use case, see Custom HTTP Responses

• Updated docker-entryproint.sh to start without root

• Added support for Authenticated as an authorizedRole value for Search

• Temporary files created for SQL by Studio are now cleaned up

• Improved Engine status API
  The Engine Status API returns the project health check. Projects can now be configured to use custom health check scripts that are run when the status API is called. To learn more on how to configure a custom health check script for your project, see Custom Health Check

• Added support for receiving authentication headers as JWT token
  For more information on receiving headers in JWT format, see Configure Header-Based Authentication

• Noteworthy dependency updates:

  • MariaDb4J to version 2.6.0.8 and MariaDB to 10.4.31.2

  • JGit to version 6.7.0.202309050840-r

For a complete list of community tickets, please visit: GitHub 4.1.2

For information on upgrading 3.1.x sites, see here

---

CrafterCMS 4.1.1

Released August 5, 2023

This release includes fixes for issues with the release version 4.1.0

Important

Please see Breaking changes for breaking changes and other things to consider before upgrading

For instructions on how to update your CrafterCMS install to 4.1.0 (applies to 4.1.1), please see Upgrading CrafterCMS

Updates

• Added a cache buster to Studio plugin browser resources
  See here for more information

• Git performance optimizations
  

• Added deployer cluster support
  See here for more information on how to configure the Deployer for Studio Clustering and here for more information on the new deployer processor property runInClusterMode

• Added support for receiving authentication headers as JWT token
  

• Noteworthy dependency updates:

  • MariaDb4J to version 2.6.0.1

  • Spring Boot to version 2.7.13

  • Spring Framework to version 5.3.28

• Fixed issue with permittedRoles for widgets in the user interface configuration
  See here for more information

Lot’s of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 4.1.1 Milestone

For information on upgrading 3.1.x sites, see here

---

CrafterCMS 4.1.0

Released June 17, 2023

Important

Please see Breaking changes for breaking changes and other things to consider before upgrading

For instructions on how to update your CrafterCMS install to 4.1.0, please see Upgrading CrafterCMS

New Features

• Studio UI New Features
  

  • New Dashboard

  • Improved Sidebar

Updates

• Upgraded Java to version 17 LTS
  

• Switched the search engine to OpenSearch version 2.8.0
  See here for more information on upgrading to OpenSearch

• Updated the minimum number of characters for usernames to 2 characters
  See here for more information

• Fixed the issue with ICE Pencil not propagating click events in compatibility-mode
  See here for more information

• Fixed the issue with global permission mappings
  See here for more information

• Fixed the issue for projects with multi-environment configuration setup
  See here for more information

• Fixed the issue with content after Save & Close and Save & Minimize action
  See here for more information

• Fixed the issue with Site Policy when uploading image from image upload control
  See here for more information

• Fixed the issue with pop-up buttons containing multiple options
  See here for more information

• Fixed the issue with binary content indexing for large files
  See here for more information

• Fixed the issue with required fields calculation for Page-URL fields
  See here for more information

• Fixed the issue with create project failures due to line breaks in queries
  

• Fixed the issue with SAML re-authentication via Open Login form after a session expires
  

• Added support for filtering requests
  See here for more information

• Updated default validation regex
  See here for more information on default validations regex values

• Added support for configuring limits to S3 object caching
  See here for more information

• SPA applications can now directly include CSS files from /static-assets/app by default
  

• Noteworthy dependency updates:

  • MongoDB to version 6.0.5 (optional)
    MongoDB in CrafterCMS Social and Profile has been updated. To upgrade MongoDB in your installation, see Upgrading MongoDB.

  • Box SDK to version 4.1.1 (optional)

Lot’s of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 4.1.0 Milestone

For information on upgrading 3.1.x sites, see here

---

For CrafterCMS version 4.0 release notes, see https://docs.craftercms.org/en/4.0/release-notes/index.html

---

For CrafterCMS version 3.1 release notes, see https://docs.craftercms.org/en/3.1/release-notes/index.html