Release Notes FirstSpirit™ 2023.1

Release Notes

FirstSpirit™ 2023.1

1 Administration

1.1 Advanced URL Creator: Enhancement for the URL parameter useWelcomeFilenames

If a content projection page is set as the start page of a folder, it was not previously provided with a “welcome file name” (e.g. index.html) if the “Advanced URL Creator” was configured accordingly (parameter useWelcomeFilenames).

This behaviour has been changed if the defined number of entries per page is not equal to 1. In this case, the [first] page of the content projection is now provided with the “welcome file name”.

1.2 Announcement: Java 17

As of release 2022.3, Java 17 has been officially approved for use with FirstSpirit.

Beginning with the FirstSpirit release 2023.1, the recommended Java version for operating FirstSpirit will change to Java 17.

1.3 Derby layer can be deactivated

The creation of derby layers can now be hidden with

internalDB.hide=true 

in the fs-server.conf to prevent the creation of derby layers.

This hides the places in the GUI where a Derby DB can be configured. Accidental use of this database, which is not suitable for productive use, is thus prevented.

1.4 Import of projects via fs-cli (FSDevTool) as project administrator

With the current FirstSpirit release it is possible to import projects via fs-cli (FSDevTool) as a project administrator.

Previously, this was only possible for server administrators.

The parameter devProjectAdminPermissions=true in fs-server.conf can be used to configure that project administrators of any project on the server will be allowed to import other projects. This is possible via API or via fs-cli (commands project import or import with specification of a new project name). The corresponding user is automatically added to this project as project administrator.

Note: The parameter does not allow project administrators to create a new project via the FirstSpirit ServerManager.

2 Administration / Modules

Conflict detection for module resources with server scope

With the current FirstSpirit release, the detection of conflicts caused by module resources in the server scope has been improved.

Conflict detection takes place when modules are installed and results are logged and visualised accordingly.

ServerManager Module Overview

In the overview list of modules (“ServerManager / Server / Properties / Modules”) , problems with and between modules are now visualised.

ServerManager Module Overview
ServerManager Module Overview

UID=sm_info

INFO: Modules that put resources on the global classpath, or contain unknown resources.

Resource may influence other modules (INFO)
The module generally brings a global resource, but no other module brings it (yet).

Unnamed resource found (INFO)
The module brings a global resource that has no “name” attribute, and thus cannot be identified or compared.

UID=sm_rot

WARN: Problems are pointed out which can have an impact on the functionality of FirstSpirit or the corresponding modules. Either FirstSpirit jars have been integrated here or resources have been placed on the global classpath that are also brought along by other modules.

Resource may negatively impact other modules (WARN)
The module brings a global resource that is also brought by at least one module.

Module may be negatively impacted by global resources (WARN)
The module brings a private resource, which is additionally brought by another module as a global resource.

FirstSpirit artifact detected (WARN)
The module brings a FirstSpirit artefact.

UID=sm_gelb

A yellow exclamation mark is displayed when a module embeds resources in a way that will no longer be supported in the future (legacy resources).

Legacy resource found (WARN)
The module brings a legacy resource.

Note: Only the icon with the highest level of severity is displayed.

The button “Show Resource Issues” can be used to display corresponding conflicts.

3 External Synchronization / Content Transport

FSDevTools commands for ContentTransport

The command line tool FSDevTools simplifies export and import operations between a FirstSpirit project and the file system via predefined commands. From FSDevTools version 4.1.0 the “FirstSpirit ContentTransport” functionality is supported.

It is now possible via the command feature,

  • display the features of a project (list),
  • download features (download),
  • analyse features to see if they can be imported into a project (analyse),
  • import features into a project (import).

Additionally, as of FSDevTools version 4.3.0, it is possible to adjust the revision of a feature (revision) in order to enable the download of the data contained therein with any revision.

The documentation of the individual commands and their parameters can be found as usual in HTML format in the release under docs/index.html or can be called up via the command line (fs-cli help feature).

UID=fs_cli_feature

4 FirstSpirit Content Experience Tools (CXT)

Latest module versions

FirstSpirit 2023.1 supports the following module versions for “FirstSpirit Content Experience Tools”.

Module / file nameVersion number
FirstSpirit CXT Plattform
platform-[version].fsm
3.0.1
FirstSpirit CXT DAP Bridge
dataservice-[version].fsm
1.44.9
FirstSpirit CXT FragmentCreator
fragment-creator-[version].fsm
4.0.1
FirstSpirit Fragment DAP
fragmentdap-[version].fsm
1.40.14
FirstSpirit Media DAP
mediadap-[version].fsm
1.31.8*
FirstSpirit PageRef DAP
pagerefdap-[version].fsm
1.9.8
FirstSpirit Markdown Editor
markdown-editor-[version].fsm
1.29.7*
FirstSpirit Tagging Editor
tagging-editor-[version].fsm
1.29.7
FirstSpirit CXT FragmentCreator - CaaS Integration
caas-integration-[version].fsm
1.31.8

* These modules require FirstSpirit 2020-03 or higher from this version.

5 Module Development, Scripts, API

FirstSpirit Module Gradle Plugin public on GitHub

The “FirstSpirit Module Gradle Plugin” is now publicly available on GitHub. In the repository (https://github.com/e-Spirit/firstspirit-module-gradle-plugin) you can find the complete source code as well as a detailed README describing the usage and various example projects.

Overview

ID Description Categories
CORE-14695

The behaviour when using “Advanced URL Creator” has been optimised.

Further information can be found in chapter “Administration: Advanced URL Creator: Enhancement for the URL parameter useWelcomeFilenames”.

Advanced URL, Generation
CORE-14735

Beginning with the FirstSpirit release 2023.1, the recommended Java version for operating FirstSpirit will change to Java 17.

Further information can be found in chapter “Administration: Announcement: Java 17”.

Java
CORE-14866

The getFiles() method from the RevisionMetaData interface (FirstSpirit Access API, package de.espirit.firstspirit.storage) was marked as “deprecated”. Furthermore, the interface SendMailException (package de.espirit.firstspirit.server.mailmanagement) was added to the FirstSpirit Access API.

FirstSpirit API
CORE-14903

The licence information on the FirstSpirit start page has been expanded and now includes the available version information for the integrated libraries and the version numbers of all installed modules.

FirstSpirit home page, License
CORE-14908

When using the “External Synchronisation” functionality, the data is now already cleaned of obsolete information (e.g. rights of deleted groups) during export.

External synchronization
CORE-14909

The import of projects via fs-cli (FSDevTool) is now also possible as a project administrator.

Further information can be found in chapter “Administration: Import of projects via fs-cli (FSDevTool) as project administrator”.

FSDevTools, FirstSpirit Administrator
CORE-14912

The creation of derby layers can now be prevented with the parameter internalDB.hide=true in fs-server.conf.

Further information can be found in chapter “Administration: Derby layer can be deactivated”.

Database, FirstSpirit Administrator
CORE-14928

With the current FirstSpirit release, the detection of conflicts caused by module resources in the server scope has been improved.

Further information can be found in chapter “Administration / Modules: Conflict detection for module resources with server scope”.

FirstSpirit Administrator, Modules
CORE-14964

If a schedule task is cancelled and an action in it does not finish within 5 minutes, a FATAL error message is generated. To facilitate the analysis of this problem, the stack trace of the order action is now also output.
In addition, the FirstSpirit server is now no longer considered degraded if the Jetty service cannot be started and at the same time the Jetty is hidden via the parameter webserver.jetty.hide=true in the fs-server.conf.

FirstSpirit Administrator, ServerMonitoring
CORE-14988

FirstSpirit Content Experience Tools: Latest module versions

Further information can be found in chapter “FirstSpirit Content Experience Tools (CXT): Latest module versions”.

FirstSpirit Content Experience Tools (CXT)
CORE-14992

Improved user list loading in FirstSpirit ServerManager (e.g. in the “Users/Edit” dialog or when adding users to a project). The initial waiting time has been significantly reduced.

FirstSpirit Administrator
DEVEX-563

As of FSDevTools release 4.1.0, the “FirstSpirit ContentTransport” functionality is supported.

Further information can be found in chapter “External Synchronization / Content Transport: FSDevTools commands for ContentTransport”.

FSDevTools
DEVEX-578

The “FirstSpirit Module Gradle Plugin” is now publicly available on GitHub.

Further information can be found in chapter “Module Development, Scripts, API: FirstSpirit Module Gradle Plugin public on GitHub”.

Developer
DEVEX-581

When updating or installing modules via “fs-cli” (FSDevTools 4.2.0), errors no longer abort the entire action immediately. Corresponding errors will be collected in the log.

FSDevTools

Deprecations

Functionality Deprecated as of Will be removed / Was removed as of
Input component CMS_INPUT_CONTENTAREALIST 5.2R3
Input component CMS_INPUT_CONTENTLIST 5.2R3
Input component CMS_INPUT_FILE 5.2R3
Input component CMS_INPUT_LINKLIST 5.2R3
Input component CMS_INPUT_OBJECTCHOOSER 5.2R3
Input component CMS_INPUT_PAGEREF 5.2R3
Input component CMS_INPUT_PICTURE 5.2R3
Input component CMS_INPUT_TABLIST 5.2R3
FirstSpirit Access API: de.espirit.firstspirit.agency.GroupsAgent 5.2R15
FirstSpirit Access API: delete (de.espirit.firstspirit.access.AccessUtil) 5.2R18
FirstSpirit Access API: release (de.espirit.firstspirit.access.AccessUtil) 2018-06
FirstSpirit Access API: getLastLoginAsDate (de.espirit.firstspirit.agency.UserStatisticsAgent) 2018-07
FirstSpirit Access API: remainingDurationOfCurrentStageInMillis (de.espirit.firstspirit.server.MaintenanceModeInfo) 2018-07 2025-13
FirstSpirit Access API: getStartingTimeOfStageAsDate (de.espirit.firstspirit.server.MaintenanceModeInfo) 2018-07 2025-13
FirstSpirit Access API: getSelectedWebserverConfiguration (de.espirit.firstspirit.access.serverConfiguration) 2018-10 2025-13
FirstSpirit Access API: setSelectedWebserverConfiguration (de.espirit.firstspirit.access.serverConfiguration) 2018-10 2025-13
FirstSpirit Access API: getSelectedWebServer (de.espirit.firstspirit.access.project.Project) 2018-10 2025-13
FirstSpirit Access API: setSelectedWebServer (de.espirit.firstspirit.access.project.Project) 2018-10 2025-13
FirstSpirit Access API: getLostAndFoundStoreNodes(); (de.espirit.firstspirit.feature.FeatureInstallResult) 2018-10
FirstSpirit Access API: getDeletedStoreNodes(); (de.espirit.firstspirit.feature.FeatureInstallResult) 2018-10
FirstSpirit Access API: de.espirit.firstspirit.access.store.Previewable 2019-01
WebSphere Application Server support for FirstSpirit 2019-05
Database layer for Oracle Database 11g/12c 2020-12 2025-05
FirstSpirit Access API: redirectTemplateLogToDefaultLog() (Interface RenderingAgent.Renderer) 2021-05
Support for Log4j 1 2022-05 2024-06