FirstSpirit Connect for SAP Commerce Cloud

Release Notes for the version 20.11.0

e-Spirit AG

2020-11-25
Table of Contents

Version 20.11.0

Update Notice

The ContentConnect for SAP Commerce Cloud integration is a bundle of software components. The table below lists all components and their versions.

Components
This release contains the following components.
Versions marked with an arrow (⬆) changed since the last release.

ComponentsVersion

ContentConnect for SAP Commerce Cloud (fsm)

3.1.74 ⬆

fscontentconnect (SAP Commerce Cloud addon)

3.1.101

Reference project

3.1.71

General information
This release was tested with the following versions:

ProductVersion

FirstSpirit server

2020-11 (5.2.201107)

Java

8 and 11

Content as a Service (FSM)

2.13.15

Omnichannel Manager

1.2.27

Basic Workflows

1.3.3.871

Fixed issues

IDDescription

SAPCC-402

Fix a possible REST response processing error

Version 20.10.3

Highlights

SAPCC-385 - Renaming of the integration to FirstSpirit Connect for SAP Commerce Cloud

As part of the standardization of module names, the integration, previously published under the name ContentConnect for SAP Commerce Cloud, has been renamed to FirstSpirit Connect for SAP Commerce Cloud.

SAPCC-175 - Added plugin that allows to edit page settings in the ContentCreator

In the ContentCreator, editors now have the option of opening a dialog for editing the page settings through the element status and workflow section.

Update Notice

The FirstSpirit Connect for SAP Commerce Cloud integration is a bundle of software components. The table below lists all components and their versions.

Components
This release contains the following components.
Versions marked with an arrow (⬆) changed since the last release.

ComponentsVersion

ContentConnect for SAP Commerce Cloud (fsm)

3.1.73 ⬆

fscontentconnect (SAP Commerce Cloud addon)

3.1.101

Reference project

3.1.71

New features

IDDescription

SAPCC-385

Renaming of the integration to FirstSpirit Connect for SAP Commerce Cloud

SAPCC-175

Added plugin that allows to edit page settings in the ContentCreator

Version 20.10.2

Fixed issues

IDDescription

SAPCC-387

Removed automatic SAP Commmerce availability check

Version 20.10.1

New features

IDDescription

SAPCC-388

Minor documentation changes in chapter 1.3

Version 20.10.0

Highlights

SAPCC-300 - Introduction of a new version scheme
This release introduces a new version scheme for the complete integration package. The new version scheme consists of the two-digit year, the month number and the number of the release within a month.

Example for the second release in October 2020: 20.10.1
Example for the first release in April 2021: 21.4.0

The version scheme of the individual components of the complete package remains unchanged. This makes it easier to see whether a given version number is the version number of the complete package or of one of its components.

New features

IDDescription

SAPCC-380

Added note on installing global web applications to the documentation

SAPCC-373

Minor adaptions within the documentation

SAPCC-300

Introduction of a new version scheme

SAPCC-287

Addition of a chapter for the configuration of the external preview URL

Version 3.3.2

Fixed issues

IDDescription

SAPCC-368

The workflow status is now correctly updated after releasing a page

New features

IDDescription

SAPCC-364

Snippet content of the Product DAP is now configurable

Version 3.3.1

Fixed issues

IDDescription

SAPCC-358

Fixed broken links in the documentation

SAPCC-356

Error in the handling of products with special characters in a FS_INDEX fixed

Version 3.3.0

Highlights

SAPCC-354 - Introducing the NPM tags cloud-sap-acc and cloud-sap-acc-dev as version for fs-tpp-api
When a new version of the fs-tpp-api library was released, this version had to be manually adjusted each time in the fscontentconnect addon. By using the NPM tags cloud-sap-acc and cloud-sap-acc-dev the version of the fs-tpp-api library does not need to be adapted manually anymore. The cloud-sap-acc-dev tag is upgraded by e-Spirit to the latest compatible version of the fs-tpp-api library on every DEV/QA patchday. The cloud-sap-acc tag on every PROD patchday. To use the correct tag, a switch was built in, which uses one of the two tags depending on the configuration of the Hybris system.

SAPCC-350 - Support for special characters and uppercase letters in hybris pageids
With this release, content maintenance is supported on all pages, even if the page id contains special characters or capital letters. This applies to maintenance on catalog-driven pages (product and category pages) as well as on pure content pages.

SAPCC-324 - Support for content maintenance on non-standard content pages
With this release, SAP Integration also supports content maintenance on content pages whose URL differs from SAP standard formats.

To use this functionality it is necessary to define the mapping of the page URL to the corresponding FirstSpirit template in the "Contents" tab in the SAP module configuration in the project properties, as described in Section 3.3. of the documentation.

Update Notice

SAPCC-354 - Introducing the NPM tags cloud-sap-acc and cloud-sap-acc-dev as version for fs-tpp-api
In order to use the new NPM tags, the fscontentconnect add-on in the SAP Commerce Cloud must be updated. In particular, the following changes must be applied:

  • fscontentconnect/acceleratoraddon/web/src/com/espirit/moddev/contentconnect /sap/filters/FirstSpiritPreviewFilter.java

In this file, before calling filterChain.doFilter(request, response); the call session.setAttribute(FscontentconnectConstants.DEV_ENVIRONMENT, isDevEnvironment()); must be added.

In addition, the class has to be extended by this method:

private boolean isDevEnvironment() {
   final String property = Optional.ofNullable((String) configurationService.getConfiguration()
   .getProperty(FscontentconnectConstants.DEV_ENVIRONMENT)).orElse("");
   return StringUtils.isNotBlank(property) && Boolean.valueOf(property);
}
  • fscontentconnect/src/com/espirit/moddev/contentconnect/sap/constants /FscontentconnectConstants.java

In this class the new constant public static final string DEV_ENVIRONMENT = "fscontentconnect.dev"; is to be added.

  • fscontentconnect/acceleratoraddon/web/webroot/WEB-INF/tags/responsive /caas/includeOcmScripts.tag

The line

<script type="text/javascript" src='https://unpkg.com/fs-tpp-
api@1.2.23/snap${sessionScope["com.espirit.ecom.fscontentconnect.scripts.suffix"]}.js'></script>

should be replaced by the following lines:

<c:set var="com.espirit.ecom.fscontentconnect.scripts.tag" scope="session"
value='${pageContext.session.getAttribute("fscontentconnect.dev") ? "cloud-sap-acc-dev" : "cloud-sap-acc"}'
/>

<script type="text/javascript" src='https://unpkg.com/fs-tpp-
api@${sessionScope["com.espirit.ecom.fscontentconnect.scripts.tag"]}/snap${sessionScope["com.espirit.ecom.fscontentconnect.scripts.suffix"]}.js'></script>

Furthermore, as described in chapter 2.1.2 of the documentation, the configuration of the Hybris system must be extended by the property fscontentconnect.dev. If this property receives the value true, the switch uses the tag cloud-sap-acc-dev. If the property receives the value false or is not specified at all, the switch uses the tag cloud-sap-acc instead. This property should therefore be set to true on DEV and QA systems. On PROD systems it should not be used or set to false.

SAPCC-350 - Support for special characters and uppercase letters in hybris pageids
To enable support for special characters and capital letters in hybris pageids, an update of the addon is necessary. Both JavaScript files are affected:

  • fscontentconnect/acceleratoraddon/web/webroot/_ui/shared/js/fscontentconnect-tpp-impl.js
  • fscontentconnect/acceleratoraddon/web/webroot/_ui/shared/js/fscontentconnect-tpp-impl.ie11.js

These must be updated on the Hybris server.

In addition, all page templates of the project must be extended by the following hidden input component, in which the original hybris page id or the hybris product or category code is persisted when a new FirstSpirit page is created:

<CMS_INPUT_TEXT name="pt_cc_identifier" hFill="yes" hidden="yes" useLanguages="no">
   <LANGINFO>
      <LANGINFO lang="*" label="ContentConnect Identifier"/>
   </LANGINFOS>
</CMS_INPUT_TEXT>

To ensure backwards compatibility, the integration continues to work as before without adding this input component, but then only supports page ids and product or category codes without special characters or capital letters.

Fixed issues

IDDescription

SAPCC-351

Improved API-call for requesting a single category

SAPCC-350

Support for special characters and uppercase letters in hybris pageids

New features

IDDescription

SAPCC-354

Introducing the NPM tags cloud-sap-acc and cloud-sap-acc-dev as version for fs-tpp-api

SAPCC-324

Support for content maintenance on non-standard content pages

Version 3.2.7

Highlights

SAPCC-207 - Improved handling of special characters in page, product and category IDs
If page, product or category IDs contain special characters, such as hyphens, the content stored in the CaaS could not be retrieved for these pages. Likewise communication with FirstSpirit did not run correctly in these cases, so that pages were created several times in FirstSpirit. This problem has been solved with this release.

Update Notice

SAPCC-342 - Fix an issue that causes an endless redirection loop in the ContentCreator
In order to apply this fix, the fscontentconnect addon needs to be updated in the SAP Commerce Cloud. Specifically, the following files need to be updated: * fscontentconnect/acceleratoraddon/web/webroot/WEB-INF/tags/responsive/caas/includeOcmScripts.tag * fscontentconnect/acceleratoraddon/web/webroot/_ui/shared/js/fscontentconnect-tpp-impl.js * fscontentconnect/acceleratoraddon/web/webroot/_ui/shared/js/fscontentconnect-tpp-impl.ie11.js

If you need to apply the changes in the includeOcmScripts.tag file manually, change the url of the fs-tpp-api library from https://unpkg.com/fs-tpp-api@1.2.17/ to https://unpkg.com/fs-tpp-api@1.2.23/.

SAPCC-207 - Improved handling of special characters in page, product and category IDs
To install this version, an update of the addon in the SAP Commerce Cloud is necessary.

The update adds a special character substitution to the file RequestTag.java:

RequestTag.java. 

if (caasService == null) {
    LOGGER.error("The CaaS Service has not been initialized.");
    return;
}

itemId = itemId.replaceAll("[^a-zA-Z0-9_.]", "_"); // special character substitution

if (session.getAttribute(FIRST_SPIRIT_PREVIEW_PARAM) != null && session.getAttribute(FIRST_SPIRIT_PREVIEW_PARAM) == Boolean.TRUE) {
    pageContext.setAttribute(var, caasService.getStagedCaaSData(collection, itemId));
} else  {
    pageContext.setAttribute(var, caasService.getOnlineCaaSData(collection, itemId));
}

Fixed issues

IDDescription

SAPCC-342

Fix an issue that causes an endless redirection loop in the ContentCreator

SAPCC-207

Improved handling of special characters in page, product and category IDs

Version 3.2.6

Highlights

SAPCC-149 - Improved error logging for API calls
Error messages caused by erroneous API calls now include the body of the API response for better and easier trouble-shooting. This applies to all calls regarding the cmswebservices, previewwebservices, and OAuth-API.

Furthermore API calls for creating or updating pages in SAP Commerce now will log the transmitted request body on a debug level.

New features

IDDescription

SAPCC-149

Improved error logging for API calls

Version 3.2.5

New features

IDDescription

SAPCC-289

Added support of multiple Commerce Cloud page templates per Commerce Cloud page type

Version 3.2.4

Fixed issues

IDDescription

SAPCC-286

Added PreviewTicket creation per project

Version 3.2.3

Fixed issues

IDDescription

SAPCC-285

Fix empty product report if a product has no thumbnail

Version 3.2.2

New features

IDDescription

SAPCC-60

Added thumbnails to product report, replaced report icons

Version 3.2.1

Fixed issues

IDDescription

SAPCC-272

Fixed error caused by missing language selector

SAPCC-269

Fixed page creation for newer Commerce Cloud versions

Version 3.2.0

New features

IDDescription

SAPCC-227

Added confirmation dialog when a section gets deleted

Version 3.1.56

Fixed issues

IDDescription

SAPCC-265

Improved handling of language dependent attributes

SAPCC-246

Fixed the display of the category teaser

SAPCC-242

Improved handling of invalid oauth tokens

New features

IDDescription

SAPCC-254

Added preview images to page and section templates

Version 3.1.54

Fixed issues

IDDescription

SAPCC-264

Fixed handling of page attributes

SAPCC-263

Base decision of used caas version on the used catalog version

SAPCC-256

Updated redirect script to detail pages

New features

IDDescription

SAPCC-253

Enabled image upload for every image input component

Version 3.1.51

Fixed issues

IDDescription

SAPCC-262

Fixed code issues

SAPCC-259

Fixed attribute mapping for non standard attributes

SAPCC-257

Reduced loading times of the product dap in FS_INDEX components

New features

IDDescription

SAPCC-258

Target catalog version for bulk update configurable at task level

Version 3.1.48

Fixed issues

IDDescription

SAPCC-260

Fixed problem where session attributes were lost

Version 3.1.45

Update Notice

If you use the FirstSpirit reference project of this version, you MUST also use the FirstSpirit module and SAP Commerce addon included in this version.

Fixed issues

IDDescription

SAPCC-243

By default the label of new content pages starts with a slash

SAPCC-232

Ensure new content pages can be opened in the FirstSpirit preview

New features

IDDescription

SAPCC-95

Rely on the Omnichannel manager to create a FirstSpirit pages for SAP Commerce pages

Version 3.1.43

Update Notice

This updated requires Omnichannel Manager 1.2.15 or higher.

Fixed issues

IDDescription

SAPCC-233

Fixed possible redirect issue in the CaaS communication

SAPCC-148

Removed workaround to trigger navigation to the homepage after page deletion

New features

IDDescription

SAPCC-230

Support Internet Explorer 11

Version 3.1.36

Fixed issues

IDDescription

SAPCC-224

Fixed preview session initialization in Firefox

Version 3.1.35

Fixed issues

IDDescription

SAPCC-217

Fixed possible race condition in JavaScript execution

SAPCC-205

Fixed problem handling special characters

New features

IDDescription

SAPCC-213

Initial translation of the documentation

Version 3.1.34

Fixed issues

IDDescription

SAPCC-40

Keep the preview session alive

Version 3.1.32

Highlights

This version comes with a new FirstSpirit reference project, that demonstrates the integration in conjunction with the B2B Accelerator. Included features are: Content management on existing content pages, utilization of dynamic product data, release and deployment processes, link and section templates, default users, groups and permissions, new ui.

Furthermore, this version includes a storefront, that includes all necessary adaptions.

Update Notice

This version requires some migration steps, that are explained in another document.

New features

IDDescription

SAPCC-187

Documentation Update

SAPCC-134

Reference Project

Version 3.1.30

Fixed issues

IDDescription

SAPCC-189

Removed dependency to internal CaaS API

Version 3.1.28

Fixed issues

IDDescription

SAPCC-196

Fixed bug that prevented language switching on the storefront

Version 3.1.26

Fixed issues

IDDescription

SAPCC-188

Fixed a bug that caused ContentCreator actions to be non-functional when viewing pages of page types that do not support content editing with FirstSpirit

New features

IDDescription

SAPCC-111

Updated documentation

Version 3.1.23

Fixed issues

IDDescription

SAPCC-181

Fixed a bug that caused the CaaS Availability Check to fail in some situations

Version 3.1.17

Fixed issues

IDDescription

SAPCC-129

Fixed a bug that caused an incorrect page context after navigating to a different FirstSpirit page

New features

IDDescription

SAPCC-142

TPP-JavaScript files now include a comment with a version number

Version 3.1.15

Update Notice

The update uses a dynamic resolution of the storefront context path which is needed within the TPP reference JavaScript. The reference implementation does now expect a storefrontContextRoot property which is provided by the PREVIEW_DATA object. For more information on how to define mentioned property in the PREVIEW_DATA object head to the chapter Storefront extensions → View of the documentation.

New features

IDDescription

SAPCC-112

Added support for dynamic content rendering and editing

SAPCC-107

Documentation of a release and deployment process

SAPCC-37

Removed static configuration of storefront context path from TPP reference JavaScript

Version 3.1.12

New features

IDDescription

SAPCC-36

Added button to test OAuth Settings in project app configuration

Version 3.1.11

Fixed issues

IDDescription

SAPCC-31

Updated TPP_SNAP version to 1.2.7 to resolve a possibly incorrect workflow status after releasing a page

Version 3.1.9

New features

IDDescription

SAPCC-106

Extended the module API by a catalog service which allows catalog synchronization

Version 3.1.8

Update Notice

The url pattern for content pages was hard coded before (within the reference implementation of the JavaScript which uses the TPP API). This module version introduces a ContentConnectSAPCommerceCloud_CMSPageUrlGenerator executable to generate page url paths. When using the new executable to generate url paths make sure to configure the new content page url pattern in the project app component to retain previous behaviour when it comes to navigating to content pages.

Fixed issues

IDDescription

SAPCC-103

Preventing deployment of non-released pages in full generation

SAPCC-100

Added support for navigation to CDP or PDP when clicking search results

Version 3.1.6

Fixed issues

IDDescription

SAPCC-102

Added chapter for FlexibleSearch restriction configuration regarding products to documentation

SAPCC-73

Added chapter about installation of web-component

SAPCC-43

Enhanced behaviour in case of network errors

SAPCC-33

Added language switching capability to TPP reference implementation

New features

IDDescription

SAPCC-65

New Category Data Access Plugin

Version 3.1.5-9

New features

IDDescription

SAPCC-58

API redesign

Version 3.1.5-8

Fixed issues

IDDescription

SAPCC-96

Fixed referencing of web.xml

Version 3.1.5-5

Fixed issues

IDDescription

SAPCC-77

Product report now supports cross origin navigation

Version 3.1.5-2

Fixed issues

IDDescription

SAPCC-57

Enhanced handling of access tokens

SAPCC-52

Fixed initial approval status of newly created CMSContentPages and added inheritance of CMSContentPage data when creating FS Contentpages based on existing CMSContentPages

New features

IDDescription

SAPCC-80

Adapted displayname of module

Version 3.1.5-13

Fixed issues

IDDescription

SAPCC-97

Fixed connection leak within CaaS request tag

SAPCC-94

Improved parameter validation and error handling of FSContentPageCreator executable

SAPCC-70

Fixed invalid configuration property within spring configuration of addon

SAPCC-64

Fixed deprecated reference within documentation

SAPCC-63

Fixed filename reference within documentation

New features

IDDescription

SAPCC-59

Improved usability of OAuth configuration within project component

Version 3.1.5

New features

IDDescription

SAPCC-53

Open product detail pages by clicking an item in the report

Version 3.1.4-1

New features

IDDescription

SAPCC-46

Added bulk update functionality

SAPCC-44

Added support for publishing the navigation structure into the CaaS

Version 3.1.3-4

Fixed issues

IDDescription

SAPCC-49

Fixed automatic refresh of the OAuth-Token

New features

IDDescription

SAPCC-27

Support for FirstSpirit Isolated Server and Java 11

Version 3.1.3-0

New features

IDDescription

SAPCC-35

Added search for content pages

SAPCC-11

Added support for creating new content pages

Version 3.1.2-2

New features

IDDescription

SAPCC-26

Added support for storefront protection via preview sessions

Version 3.1.2

New features

IDDescription

SAPCC-25

Implemented TPP JavaScript reference and added release mechanisms

SAPCC-24

Extended the functionality of our taglib to make custom calls possible

Version 3.1.1-1

Fixed issues

IDDescription

SAPCC-21

Updated fscontentconnect addon

New features

IDDescription

SAPCC-22

Addon clean up

SAPCC-20

Documentation improvements

SAPCC-19

Updated storefront manipulations chapter

Version 3.1.1

New features

IDDescription

SAPCC-18

Initial documentation

SAPCC-9

Project scoped module configuration and bug fixes in the cache mechanisms of the product report

Help

The Technical Support of the e-Spirit AG provides expert technical support to customers and partners covering any topic related to the FirstSpirit™ product. You can get and find more help concerning relevant topics in our community.