Omnichannel Manager

Release Notes for the version 1.2.25

e-Spirit AG

2020-05-25
Table of Contents

Version 1.2.25

List of changes

IDCategoryDescription

OCM-403

Feature

When using a UUID without language postfix in any TPP_SNAP action, the current preview language will now be supposed.

OCM-414

Feature

Parameter forceUid was added to TPP_SNAP.createPage to enable forcing a page to be created with the exact uid that was specified.

Version 1.2.24

List of changes

IDCategoryDescription

OCM-382

Feature

Added API to show basic ContentCreator dialogs using TPP_SNAP (TPP_SNAP.showMessage and TPP_SNAP.showQuestion).

OCM-312

Feature

Added wrapper interface for MPP_API in TPP_SNAP; the corresponding methods are prefixed with "mpp".

Version 1.2.23

List of changes

IDCategoryDescription

OCM-421

Bug

Fixed a bug that caused a redirect loop when redirecting the preview frame.

Version 1.2.22

List of changes

IDCategoryDescription

OCM-357

Bug

Fixed the behaviour of the default crop button not using the data-tpp-context-image-resolution HTML attribute.

OCM-413

Bug

Fixed a bug that prevented the TPP_SNAP.moveSection function from being executed without specifying the options parameter.

OCM-332

Bug

Deleting a section now triggers a page revision to be created.

OCM-366

Feature

Show warnings in the browser console in case a PreviewID could not be resolved.

Version 1.2.21

List of changes

IDCategoryDescription

OCM-401

Feature

Improved compatibility with Angular and Vue, and minor enhancements for the new ContentCreator UI.

OCM-409

Feature

CaaS version 3: support for dataset preview ids in uuid format.

OCM-388

Feature

Added Deep-Link support in combination with the new Content Creator design and FirstSpirit server version 2020-03 or higher. The demo project now also supports this feature.

OCM-396

Bug

Fixed a bug where the page would not be reloaded when changes were made to existing datasets of a FS_INDEX.

Version 1.2.20

Compatibility

ProductVersion(s)Notice

FirstSpirit

2020-02

-

List of changes

IDCategoryDescription

OCM-394

Feature

New optional parameter refresh for TPP_SNAP.getElementStatus, set this to true to force an update of the status.

OCM-387

Feature

Added new icons and style sheets for TPP_SNAP when executed in a ContentCreator with the new design activated. The ThirdParty App can also customize its appereance by querying the new TPP_SNAP.isLegacyCC property to decide which design to use. The demo project can be viewed as an example, where the button bar’s old arrow icons get replaced with the new shipped with arrow icons when the app is opened in a Content Creator using the new design. The new arrow icons can be used - yet not in a legacy ContentCreator! - using the CSS classes tpp-icon-arrow-left, tpp-icon-arrow-up and so forth.

OCMS-405

Feature

In CaaS version 3 projects the callback functions (onNavigationChange, onContentChange, etc.) now use the new UUID-based previewId format.

Version 1.2.19

List of changes

IDCategoryDescription

OCM-402

Bug

Fixed java.lang.IllegalStateException: module not found preventing edit operations.

Version 1.2.18

This release supports CaaS version 2 and 3. CaaS v3 is currently in ramp-up.

The TPP_SNAP frontend library now additionally supports the format <uuid>.<locale> for the attribute data-fs-previewid. This format corresponds to the format of the _id attribute available in CaaS v3.

Compatibility

ProductVersion(s)Notice

FirstSpirit

2019-12

-

CaaS

2.x, 3.x

If in the linked FirstSpirit project the CaaS-3 project app has been installed, the function TPP_SNAP.renderElement delivers the CaaS-3 JSON format.

List of changes

IDCategoryDescription

OCM-381

Feature

Update of dependency com.google.code.gson to version 2.8.6.

OCM-386

Feature

Improved initialization sequence to be more robust against timing issues in case of slow load times.

OCM-376

Bug

Fixed an issue when creating new pages in the demo project.

OCM-321

Bug

Fixed an issue where creating a new page via TPP_SNAP would always set the master language as translated, not the preview language. This is now solved by adding all and only those languages as translated, where language-dependent fields are filled-in via the create page dialog. If no or only language-independent fields were used, no language will be marked as translated for this page.

Version 1.2.17

List of changes

IDCategoryDescription

OCM-378

Bug

Fixed an issue where changing the client language in FirstSpirit would not be reflected by the dialogs opened by the OCM (e.g. the deletion-confirmation dialog).

OCM-371

Bug

The ElementStatusProvider now properly displays the status for datasets with id 0.

Version 1.2.16

List of changes

IDCategoryDescription

OCM-370

Feature

Should errors occur when deleting an element, an error-specific and language-dependent error message will now be displayed.

OCM-368

Bug

Fixed an issue with moving sections in Snap.

Version 1.2.15

List of changes

IDCategoryDescription

OCM-182

Feature

Similar to the Content Creator, all changes compared to the released revision can now be displayed.

OCM-360

Feature

Before an element is deleted, an optional confirmation dialog can now be displayed.

OCM-325

Feature

New API for requesting data from CaaS available. This version of caas.js supports paging aswell as and-concatenated equals filters. You can find the artifact in the demo application javascript assets folder.

OCM-273

Feature

Added optional parameter to skip input form dialog when creating a new page.

OCM-361

Feature

The snap css is no longer included as a blob, so that no Content Security Policy allowing blob: is required.

OCM-351

Bug

Fixed an issue showing multiple input components of the same type when opening 'edit input components' dialog.

OCM-324

Bug

Fixed deletion of page from within workflows.

Version 1.2.14

List of changes

IDCategoryDescription

OCM-331

Bug

Implemented errorless behavior in eventing for elements without DOM binding.

Version 1.2.13

List of changes

IDCategoryDescription

OCM-329

Bug

Corrected the duplicate display of translation actions.

Version 1.2.12

The list of supported browsers is maintained on the npm.com page: https://www.npmjs.com/package/fs-tpp-api#browser-support

Currently we support the following browsers:

  • Chrome >= 59
  • Firefox >= 61
  • Edge >= 15
  • Safari >= 10.1
  • IE 11

Sadly the support for the Internet Explorer 11 was broken. Starting with this release we provide a designated frontend script for IE-11: snap.ie11.js. Please import this version if you have to support editors using this browser.

List of changes

IDCategoryDescription

OCM-323

Bug

New version of the TPP-SNAP frontend library for Internet Explorer 11: snap.ie11.js.

CAAS-908

Demo-App

Demo contents are now written to and retrieved from CaaS in production and preview mode. Warning! The section labelled "FirstSpirit content" cannot be used with CaaS out of the box.

OCM-320

Bug

The fallback-language for creating pages was hardcoded with "EN", this is now changed to use always the project master language in cases where no other language informations are available.

Version 1.2.11

List of changes

IDCategoryDescription

CORE-10474

Bug

The callback provided to TPP_SNAP.onRequestPreviewElement was sometimes called with an empty string as previewId.

CORE-10473

Bug

In rare cases the status of the current FirstSpirit element did not show up correctly in the top left corner of the ContentCreator frame.

Version 1.2.10

List of changes

IDCategoryDescription

CORE-10393

Bug

After using the image cropping dialog, the preview frame could become inaccessible.

Version 1.2.8

List of changes

IDCategoryDescription

CORE-8784

API

Improved handling of optional index parameter for createSection and createSiblingSection.

CORE-9928

Logging

Error messages from the FirstSpirit server, e.g. when you’re calling TPP_SNAP.createSection() with an invalid PreviewID, are now displayed in the web browser’s Console.

CORE-10329

API

Now section D&D also triggers a content change event.

CORE-10183

API

The Content-Change-Event after workflow switching erroneously returned the content in the master language of the project. Now the content is delivered in the correct preview language.

Version 1.2.7

List of changes

IDCategoryDescription

CORE-9251

ElementStatus

The ElementStatus associated to a FirstSpirit Body object now inherits the permissions of the parent Page object, so that it’s possible to obtain user permissions for content creation based on the PreviewId of a Body.

CORE-9251

UI

The "add section" button now automatical appears on FirstSpirit Body-Objects as well.

CORE-10250

UI

Improved drag & drop support.

CORE-10194

API

The Promise "TPP-SNAP.isConnected" was never resolved, when TPP-SNAP was loaded in the top frame.

Version 1.2.6

Drag & Drop for Sections

This version contains initial support for moving sections. This allows the editor to move section inside the front end app by dragging and dropping, even between different content areas (if configured accordingly inside of FirstSpirit). Additionally it is now possible to drag sections from the report area (e.g. from the bookmark list) to a content area.

Since the drag & drop behaviour differs between browsers and operating systems unwanted display effects may occur.

Due to technical limitations this feature is only available in the SNAP_API for the time being.

The move-button appears automatically and context-sensitive. To disable this behavior use TPP_SNAP.overrideDefaultButton('move', { isVisible: () ⇒ false });.

List of changes

IDCategoryDescription

CORE-9464

API/UI

Use Operation.showMetaDataDialog to edit metadata in an appearing dialog. (To edit metadata the element type must be explicitly allowed).

CORE-9781

UI

The delete workflow is now shown on the workflow button if the workflow is associated to this non-page element (media or dataset).

CORE-9463

API/UI

New API to query project languages: TPP_SNAP.languages() respectively TPP_API.Operation.getLanguages().

API to perform the translation dialog: TPP_SNAP.showTranslationDialog() respectively TPP_API.Operation.showTranslationDialog().

New Default Button on Pages / Sections to trigger the translation dialog.

TPP_SNAP: The button is visible by default and a drop-down provides options for each project language to open the translation dialog. This behavior can be disabled by TPP_SNAP.overrideDefaultButton('translate', { isVisible: () ⇒ false }).

TPP_API: The button is provided at TPP_API.Button.TRANSLATE with the same functionallity as described above.

CORE-9908

API/UI

Added drag & drop support to sections in view and from the report area (e.g. bookmarks). Also the API method TPP_SNAP.moveSection has been added to move sections within the front-end application.

CORE-10178

API

New method TPP_SNAP.previewUrl() / TPP_API.Operation.getPreviewUrl() delivers the "External Preview URL", as set in FirstSpirit. In SNAP this is used to redirect the preview to the Preview URL after the current preview page (set with TPP_SNAP.setPreviewElement) has been deleted, e.g. by a workflow. This behavior can be overridden by using TPP_SNAP.onContentChange. If you already have a TPP_SNAP.onContentChange defined, you can add the following: if (content === null && previewId === await TPP_SNAP.getPreviewElement()) { return location.href = await TPP_SNAP.previewUrl(); }.

Version 1.2.3

Front-End API TPP_SNAP

Starting with this version we are providing a new, simplified front-end API.

There is also new demo application showing how to use this api. You can find this application in the download folder next to the API and ContentCreator module, in the file tpp-snap-demo.zip. The demo requires no web framework, and it is also provided separately.

This demo instance has no CaaS connection, so you can use it with you local FirstSpirit to test editorial use cases. If you also want to test releases and deployment on a live site with the demo, you have to host the front-end app and a CaaS instance in your environment, and configure FirstSpirit accordingly.

Further information on the new API and on the demo is provided in the demo package’s readme.md.

List of changes

IDCategoryDescription

CORE-8832

API

New front-end API TPP_SNAP.

CORE-9011

API

Delete workflow events are now passed to the app code for registered listener (TPP_API.Common.addWorkflowProcessedHandler).

CORE-8325

API/UI

To crop images with multiple resolutions, the resolution parameter for Operation.cropImage can be an array. The DOM attribute data-tpp-context-image-resolutions="res1, res2" can also be used.

CORE-9786

API

Fixed a bug which caused an error message to be shown when fetching the element status of a deleted dataset.

CORE-9777

API/UI

New Datasets can now be created by Operation.createDataset.

Version 1.1.9

List of changes

IDCategoryDescription

CORE-9929

Install

Changes to module.xml, to avoid conflicts with other FirstSpirit modules that also provide a web.xml web-resource.

Version 1.1.8

List of changes

IDCategoryDescription

CORE-9736

API

We now provide source maps for the minified java script source. It’s recommended to integrate these in the build process of your frontend code, at least for QS and DEV environments. E.g. for webpack see https://github.com/webpack-contrib/source-map-loader

Version 1.1.7

List of changes

IDCategoryDescription

CORE-9653

Install

Reverted module and web app name changes from v1.1.6 which caused the fail of a module update without prior uninstall.

Version 1.1.6

List of changes

IDCategoryDescription

CORE-9377

API/UI

Bookmark feature (for Page, PageRef, Section, Dataset) via TPP_API.Operation.toggleBookmark and TPP_API.Button.TOGGLE_BOOKMARK.

Version 1.1.5

Conversion of the build process. Only technical release.

Version 1.1.4

List of changes

IDCategoryDescription

CORE-9225

API

The position of new sections created with template chooser has been corrected.

CORE-9360

UI

New Pages and sections could now be saved with empty and respectively with default values. Before the "Save" option wasn’t enabled without changes in the form.

Version 1.1.3

List of changes

IDCategoryDescription

CORE-8553

Logging

When using the Multi-Perspective-Preview error messages were appended to the browser console. This has been fixed (from FirstSpirit 2018-09 onwards).

CORE-8644

UI

The editorial language of ContentCreator dialogues now corresponds to the language of the element being displayed (“WE_API.Common.getPreviewElement().getLanguage()”, from FirstSpirit 2018-09 onwards).

CORE-8812

UI

When deleting a page via a delete workflow an error dialog was shown. This has been fixed.

Version 1.1.2

This version includes improvements for multi language projects.

ProduktVersion(en)Hinweise

FirstSpirit

2018-08 or newer

The format of the previewId() has been changed with FiristSpirit version 2018-08. The content in the preview-CaaS should be updated with this version.

List of changes

IDCategoryDescription

CORE-8409

API

The function TPP_API.Operation.renderStartNode has a new parameter lanuage to set the rendering language. Until now the rendering was always done with the project’s default language.

CORE-8580

UI

Jumping from the search results to a dataset is now supported. The previeId should be constructed like this:

$CMS_VALUE(previewId(element:pageref, entity:entity))$

(The page ref should be identitcal to the preview page ref of the corresponding table template.)

CORE-8729

UI

The workflow flyout is now scrollable.

CORE-8744

API

The function TPP_API.Decorate.setDefaultButtons was added to configure the set of buttons that will be added to every decorated element. To be able to use this feature all buttons are are now available through TPP_API.Button.

CORE-8746

API

When creating a new section the input mask is now initially opened with the language of the parent element. Previously the project’s default language had been used.

CORE-8760

API

Fixed TypeError in autoReload feature.

Version 1.1.1

List of changes

IDCategoryDescription

CORE-8409

API

When starting workflows you can now provide the workflow UID. This now corresponds to the API-Doc description. Before this change you had to provide the node ID. For compatibility reasons the ID will be accepted, too. The parameter name has been changed from "workflowUid" to "workflow", the old parameter "workflowUid" is also supported.

The same was done when transitioning workflows for the parameter "transitionId", here the parameter name was shortened to "transition" and the UID or the ID will be accepted.

CORE-8415

Templating

Provide structure variables in the context. The content of the variable #global.node has been corrected from page store node to the site store page reference node.

CORE-8486

Workflow

Fixed cancelation of a workflow from the initial workflow dialog.

CORE-8495

API

Corrected return value of TPP_API.Operation.deleteSection(previewId) when deletion failed.

Version 1.1.0

This version brings two new features, allowing for a closer coupling of FirstSpirit editing features with front-end applications:

  1. Your app can now set the ContentCreator’s FirstSpirit context.
  2. An extended event mechanism.

Setting the FirstSpirit reference from the application allows for workflow control via the ContentCreator’s familiar menus. The extended event mechanism allows for fine-granular reactions to this by the application.

Thus workflows can be switched both via the ContentCreator’s menu and via the TPP internal buttons. In order to synchronize the TPP integration with the ContentCreator’s project-specific behavior, the TPP-API can operate workflows either on a page or on a page reference. The behavior can be configured upon API initialization.

Furthermore the extended event mechanism makes it possible to once again have editors create new pages via ContentCreator menus. The embedded application does not have to be modified for this. The respective events are transparently forwarded by the ContentCreator via the TPP-API. The same goes for the function "Edit navigation", for restructuring the navigation.

Further new features

Section selection by the editor

When creating new sections specifying the FirstSpirit template UID is now optional. When no UID is provided the editor is offered a selection of matching templates. If only one template matches, this step will be skipped.

Image cropping

For image cropping you no longer need an additional FirstSpirit script, from this version on. Decorating an HTML element with the previewID of an image from the FirstSpirit Media Store is sufficient.

Various

A list of all changes, including bugs fixed, is provided in tabular form further below in this document. For further details on the API extensions refer to the API documentation.

Outlook

The TPP-API currently to a large extend can be used via callbacks as well as via promises. We recommend the use of promises and are planning to drop callback support in a future version (2.0 or later).

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.2.20

-

Fixed issues

IDCategoryDescription

CORE-7357

API

Fixed a NoClassDefFoundError for org/apache/commons/lang/exception/ExceptionUtils in error handling code.

CORE-7554

API

When creating new sections the section type (uid of the template) is now optional. When not provided the user can choose the section type manually.

CORE-7645

API

TPP_API.Operation.cropImage and TPP_API.Button.CROP_IMAGE and corresponding Event TPP_API.Event.IMAGE_CHANGED introduced. Additional optional parameter 'context' in TPP_API.Decorate.element.

CORE-7420

UI

When creating a new section the dialog title now shows the display name of the template.

CORE-7398

API

TPP_Api.Common.addPreviewRequestHandler/.addNavigationChangeHandler and corresponding Events added.

CORE-7628

API

TPP_API.Common.setPreviewElement to set the FirstSpirit page in the ContentCreator frame added.

CORE-6581

API

Fixed problem with borders sometimes getting stuck.

CORE-7584

API/UI

Workflows can further be triggered by the operations TPP_API.operation.startWorkflow/processWorkflow and the corresponding buttons as usual. But also the ContentCreator menu can now be used. To control the projectspecific behaviout a new config parameter workflowMode is introduced. The event TPP_API.Event.WORKFLOW_STARTED wont be fired any more. Instead on every workflow step including the start TPP_API.Event.WORKFLOW_PROCESSED will be fired. This event now has an additional property workflowId. Besides the Events on the DOM-Elements it is possibly to register a callback with TPP_API.Common.addWorkflowProcessedHandler.

Version 1.0.0

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.2.16 and newer

-

Initial release for ramp up phase.

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.