Upgrade Notes per Version

XperienCentral 10.17.0

• Apache Tomcat version 8.5.14 has been integrated. For Apache Tomcat the server.xml has changed:
  
  

  <Resource name="jdbc/WebManagerDb" auth="Container" type="javax.sql.DataSource" username="${webmanager.externaldb.dbuser}" password="${webmanager.externaldb.dbpassword}" driverClassName="${webmanager.externaldb.dbdriver}" url="${webmanager.externaldb.dburl}" maxTotal="100" maxIdle="10" maxWait="10000" testWhileIdle="true" timeBetweenEvictionRunsMillis="900000" removeAbandonedOnBorrow="false" removeAbandonedOnMaintenance="false"  removeAbandonedTimeout="30" logAbandoned="true" validationQuery="${webmanager.externaldb.validationquery}"/>
  <Resource name="jdbc/WebManagerDb" auth="Container" type="javax.sql.DataSource" username="${webmanager.externaldb.dbuser}" password="${webmanager.externaldb.dbpassword}" driverClassName="${webmanager.externaldb.dbdriver}" url="${webmanager.externaldb.dburl}" maxTotal="100" maxIdle="10" maxWait="10000" testWhileIdle="true" timeBetweenEvictionRunsMillis="900000" removeAbandonedOnBorrow="false" removeAbandonedOnMaintenance="false"  removeAbandonedTimeout="30" logAbandoned="true" validationQuery="${webmanager.externaldb.validationquery}"/>

  The way abandoned connection management should be handled by Tomcat has changed.
  
  

• For Apache Tomcat the context.xml has changed: CookieProcessor is set to org.apache.tomcat.util.http.LegacyCookieProcessor.
• Startup configuration for Apache Tomcat has changed: JVM configuration settings (described in settings.xml) formerly added to catalina.bat/catalina.sh are now located in setenv.bat/setenv.sh. The settings themselves are split into two categories (instead of one): catalinaopts and javaopts.
• The manner in which horizontal page text is aligned in the Inline Editor has changed. In XperienCentral versions older than 10.17.0, the align attribute was used inside <p> tags,<h1> through <h6>, and block-quote elements. Horizontal page text is now rendered using an aligncenter or alignright parameter in a CSS horizontal text-alignment class element. The CSS of the customer website must now include these class definitions. See stylesheet.css in the webmanager-cestyle-wcb for an example.
• The Image Element presentation imageElement.xml has three new properties: enableResize, resizeHeight and resizeWidth.

XperienCentral 10.16.1

Adjust presentations where the <img> tag width and height attributes are set in order to support SVG-images without explicit dimensions. See for example imageElement.jspf (line 36).

XperienCentral 10.16.0

• The way page labels and media terms are indexed has changed in order to improve the label facet in Advanced Search. Before these improvements fully take effect, all pages and media items need to be re-indexed. This only affects the backend search.
• Support for images has been added to the RSS feed presentation (rssFeedElement.jspf).

XperienCentral 10.15.1

The clientside SidebarContentItemWidget.contentItemChange event is now automatically triggered on content changes using contentManagement.updateContentItemVersion. Custom code using other triggers for updating the information being shown or throwing events to update other sidebar widgets should be adjusted or removed in order to avoid double updates.

XperienCentral 10.15.0

In order to make sure the wm-hostname tag works on WebSphere, a change in the default xslStyleSheet.jspf has been made. Also, a default hostname is included in the form.tag. If these files are overruled by a custom presentation, please update accordingly.

XperienCentral 10.14.0

• Please add the file xslStyleSheetForm.xml to the presentation of your project and include it by adding the following line to xslStyleSheet.jspf, according to the example presentation:
  
  <wm:render presentationName="xslStyleSheetForm" />


• In order to render Interactive Forms in a cross-domain manner, a number of files have been changed. If the default contentpartEmbedded.jspf, form.tag, formStep.jspf, or formvalidationbindings.js are overruled in a custom presentation, please synchronize these files. Also, a CORSFilter for Cross-Origin Resource Sharing has been added to the web.xml. If you are using a modified web.xml file, please update accordingly.

XperienCentral 10.13.0

• Interactive Forms now supports RBAC authorization for all handlers, routers, validators, form fragments and custom extension tabs. For product components, authorization for permission groups has been set. Please review any roles not based on permission groups in order to assign the correct permissions. Custom components will be accessible to all users if no authorization is assigned. RBAC authorization can be added to custom form components in the Activator.
• The HTML structure of lists has changed in order to comply with the HTML5 specification. Each sub-list is now nested in a list item tag <li> instead of being a direct child of a list tag <ul> or <ol>. Any CSS rules that rely on the latter structure will have to be updated in order to produce the same visual result.

XperienCentral 10.12.1

• Users can now be granted rights to access XperienCentral in specific ways. Whereas a user could always use password-based login and/or container-based (if enabled), each login method now has to be enabled for each user. By default, all users will be allowed all relevant access methods. We advise you to review the list of ways that each user may log in after the upgrade and adjust them accordingly.
• String interpolation in Interactive Forms has changed slightly. In previous versions of XperienCentral, a JavaScript syntax error would cause the original string value to be returned.  This error is now logged and other expressions (if any) will be evaluated. This may result in partially interpolated strings being returned instead of the input string.
• When upgrading to XperienCentral 10.12.1 or newer, the index directories contentindex and searchengine are removed automatically. However, in a clustered environment, this is only done on the master node. To upgrade successfully, the aforementioned index directories should be removed manually from all the slave nodes.
• JBoss/Wildfly application server users should deactivate the "as-default" profile and activate the Maven "as-jboss" profile by uncommenting the profiles in the profiles section in the settings.xml or by passing the profiles as Maven profile using the Maven command line -P <profiles> option.

XperienCentral 10.12.0

• SOLR has been upgraded to version 5.5.1, therefore it is necessary to fully rebuild the backend and frontend search indices. The former is built automatically after the upgrade. Please note that this may take some time to complete and could cause high server load. The frontend search index rebuild should be triggered manually via the Setup Tool.
• The files conf/core0/conf/schema.xml and conf/core0/conf/solrconfig.xml have been updated. If you have made custom changes to one or both of these files, it is necessary to merge the new files with the custom ones. If no custom changes have been made, the new versions of the files can simply be used instead of the old ones.
• The secure form signer used to protect forms against tampering has been changed. All dumped pages which contain interactive forms or advanced forms will need to be regenerated or flushed from the cache. Any old pre-upgrade forms submitted by browsers to the website after the upgrade will be rejected by the secure forms checking filter.
• Form sessions can now be completed if a different form version becomes active. If the default showFormElementSsi.jspf, formFragmentOverview.jspf and form.tag are overruled in a custom presentation, please synchronize these files.

XperienCentral 10.11.0

• An extra input field has been added to the IAF csfw fields. If a custom form.tag is used in the presentation, please add the following hidden input:
  
  <input type="hidden" name="csfw_requestedChannel" value="${wmfn:escapeToHtml(presentationcontext.channel)}"/>
  
  
• The E-Cards, Poll and Who-is-Who functionalities have been removed and all their persisted content will be automatically removed during the upgrade process.
• The system presentation JSP elementAnchor.jspf with scope ElementAnchor was changed and should be copied to/synchronized with the project specific presentation.
• In Interactive Forms, an error on the form scope previously did not stop execution of any components in a conditional block. If your project depends on this behavior, you will have to change the relevant conditions in Interactive Forms.
• One line of text used by the Search element is garbled when shown on a Dutch page. To correct this by hand, log into XperienCentral, navigate to the Configuration menu at the top of the page, select Language Labels and ensure that "Dutch" is selected, Open the "wm_language_search" part of the dialog and update the "all_pages" entry to "Alle categorieën".

XperienCentral 10.10.1

Links are now filtered by scheme. Schemes that are not allowed result in removal of the illegal link. Allowed link schemes can be configured using the Setup Tool, property valid_link_schemes in the website settings. The following schemes are accepted by default: http, https, mailto. In addition to these we accept relative URLs and anchors by default. We advise you to customize which schemes are accepted such that only the bare minimum is accepted.

XperienCentral 10.10.0

• Because of security reasons it is recommended to disable the following permissions for the Main Editor role when being used: "Maintain design templates", "Maintain application servers", "Maintain application proxy servers", "Maintain application proxy servers", "Maintain application replacements", "Maintain Layouts", "Maintain XSLT expressions", "Maintain language labels", "Maintain users", "Maintain roles" and "Import users".
• For security reasons, it is no longer permitted to use the Interactive Forms "Copy File Handler" to copy files to any arbitrary location. The only directories (and its subdirectories) to which the copy file handler is allowed to copy files are those specified in the configuration (the property "website_settings.file_upload_valid_directories" in the Setup Tool). By default, no directories are specified, which means that by default attempting to copy files will fail. When upgrading, please configure the allowed directories in the Setup Tool. It is recommended that you only use directories that are not part of GX Webmanager 10 XperienCentral itself. The new setting should also be used in custom code where files can be uploaded to a user-defined location.
• And also the following functionalities have been removed because of security considerations: Design Templates (panel), Design Template Folders (tab).  Similar functionality is provided by the System Utilities - File Browser which should be used instead.
• The configuration of Maintainable Folders has been moved to the Setup Tool.
• Error messages from Spring Framework Validators are now escaped. This means HTML markup can not be used in these error message any more. Typically you need to remove styling like <font color="red"> from your message files. CSS styling is possible using the "span.error" selector.
• Labels for the wmedit:radioButton, wmedit:select and wmedit:selectItem JSPtags will now be escaped to HTML by default. In case HTML is used in such labels, this needs to be replaced.
• More robust HTML escaping JSP functions are introduced as a replacement for fn:escapeXml. These are wmfn:escapeToHTML for generic use in HTML and wmfn:escapeToHTMLAttribute for escaping HTML attributes. Unlike fn:escapeXml, these functions do not escape L CODE tags that are used for links and personalization tags. It is recommended that you replace all instances of fn:escapeXml in frontend presentations with these functions. In specific cases this is required for L CODE tags and personalization to work correctly.

XperienCentral 10.9.0

• The GetText servlet has been deleted. If you are using a modified web.xml file then be sure to remove any references to the GetText servlet.
• From now on the 3.0 servlet API is supported only. To enable this the dependencies to the related artifacts need to be changed in custom poms that refer to these artifacts: javax.servlet:servlet-api and javax.servlet:jsp-api.

• The web.xml deployment descriptor header should be changed to the 3.0 format:
  
  

  <web-app xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"version="3.0">          
  </web-app>  

• Maven 3.X does not support file URLs like "file:./maven-repository" in the settings.xml anymore, therefore the "localRepository" setting must be a real file path from now on and this should be updated in your custom Maven settings if needed. An absolute path is preferred for referring to the same repository (for example in subprojects) because the settings are relative to the current project directory (see https://maven.apache.org/plugin-developers/common-bugs.html#Resolving_Relative_Paths).

• Maven 3.X discourages using expressions for the groupId, artifactId and version settings in POMs and other descriptors. These have been replaced by constant values and, as a result, the webmanager.project.groupId, webmanager.project.artifactId and webmanager.project.version settings  from the settings.xml no longer serve a purpose and thus have been removed from the settings.xml. As a result of this it may be necessary to update the values of your project specific webmanager.staticbasedir, webmanager.backendbasedir and webmanager.cleansitelocation settings.

• Because the Maven plugin for OSGI bundles has been replaced in Maven 3.X, the following adjustments are needed in the pom.xml of custom plugins.
  
  PACKAGING:
    Maven 2:
      <project ...>
        <packaging>osgi-bundle</packaging>
        ...

    Replacement in Maven 3:
      <project ...>
        <packaging>bundle</packaging>
          ...
  
    MAVEN OSGI PLUGIN: Note especially that the <explicitImportPackage> tag is not needed any more.
    Previously this tag was used to make exported local packages available within the plugin code.
  
  Maven 2:
      <plugin>
        <groupId>org.apache.felix.plugins</groupId>
        <artifactId>maven-osgi-plugin</artifactId>
        <configuration>
          <osgiManifest>
            <bundleActivator>...</bundleActivator>
            <exportPackage>...</exportPackage>

            <explicitImportPackage>...</explicitImportPackage>
          </osgiManifest>
        <configuration>
        ...

    Replacement in Maven 3:
      <plugin>
        <groupId>org.apache.felix</groupId>
        <artifactId>maven-bundle-plugin</artifactId>
        <configuration>
          <instructions>
            <Bundle-Activator>...</Bundle-Activator>
            <Export-Package>...</Export-Package>

            <!-- REMOVED! explicitImportPackage -->
          </instructions>
        <configuration>
        ...  
  
  

• If a custom parent pom.xml is used in place of the one delivered in the XperienCentral SDK ZIP (nl.gx.webmanager.wcbs:webmanager-wcbs), then you need to make the following changes in the parent pom.xml. Some of these tags can also be used directly in the pom.xml of a plugin. In that case, the same "translation" should be used there.
  
    Maven 2:
    <plugin>
      <groupId>org.apache.felix.plugins</groupId>
      <artifactId>maven-osgi-plugin</artifactId>
      <version>...</version>
      <configuration>
        <manifestFile>...</manifestFile>
        <osgiManifest>
          <bundleVendor>...</bundleVendor>
          <bundleSymbolicName>...</bundleSymbolicName>
          <bundleName>...</bundleName>
          <bundleDescription>...</bundleDescription>
          <bundleSource>...</bundleSource>
          <bundleDate>...</bundleDate>

          <bundleManifestVersion>${webmanager.manifestversion}</bundleManifestVersion>
        </osgiManifest>
      <configuration>
      ...

  Replacement in Maven 3:
    <plugin>
      <groupId>org.apache.felix</groupId>
      <artifactId>maven-bundle-plugin</artifactId>
      <version>2.5.3</version>
      <configuration>
        <archive>
          <manifestFile>...</manifestFile>
        </archive>
        <instructions>
          <Embed-Dependency>*;scope=compile</Embed-Dependency>  <!-- NEW! -->
          <Embed-Transitive>true</Embed-Transitive>  <!-- NEW! -->
          <Export-Package/>  <!-- NEW! -->

          <Bundle-Vendor>...</Bundle-Vendor>
          <Bundle-SymbolicName>...</Bundle-SymbolicName>
          <Bundle-Name>...</Bundle-Name>
          <Bundle-Description>...</Bundle-Description>
          <Bundle-Source>...</Bundle-Source>
          <Bundle-Date>...</Bundle-Date>

          <!-- REMOVED: bundleManifestVersion -->
        </instructions>
      <configuration>
      ...
  
  

• The maven-bundle-plugin adds version information to the Manifest file for its dependencies. This information is checked at runtime in order to ensure that an accepted version of the referred plugin is installed on the system, otherwise the plugin will fail to start. The default runtime version requirements are sensible, but when dealing with 3rd party components you might need to overrule these default requirements. This can be done as follows to allow v1.x.x - v5.x.x:    <Import-Package>com.gxwebmanager.tests.testservice.*;version="[1,6)",*</Import-Package>.

XperienCentral 10.7.1

XperienCentral 10.7.1 provides an oEmbed service to embed XC content in external oEmbed consumers. The presentation of this content is provided by some XC presentation files. An example implementation can be found in the wmpcommunityeditionstyle WCB (provided in the edition-bundles directory of the release) that contains presentations with the following names:  "WM page embed", "WM page embed ssi", "WM contentpart embedded" that are used to render the oEmbed presentation. "WM content" and "WM databasepage" are invoked but not modified.

XperienCentral 10.7.0

• The manner in which the active version of a form or form section is determined has been changed. It no longer makes use of a predefined set of states, but uses the XperienCentral Workflow functionality instead. As a result of this the getActiveVersion and setActiveVersion methods on the Form and FormSection class have been deprecated. The getActiveVersion method now invokes the newly introduced getCurrent method to determine which version is returned as the  "active" version. The setActiveVersion no longer executes any logic at all.
• The behavior of the Session#getWrapper method has been altered when retrieving Content Items (instances of MediaItem). Previously this method would return an object even if none could be found for the requested identifier while now it will return null in this situation.
• 10.7.0 introduces support for Workflow in Interactive Forms. In order for this to work properly, WebManager sets up a new Workflow Repository Model called "Interactive Forms Workflow". You may want to review whether the permissions assigned to each activity suit your needs. You can find Workflow Repository Model configuration in the "Workflow" menu. The following permissions have been introduced in WebManager 10.7.0: Copy forms, create forms, create versions of forms, delete forms and edit forms.

XperienCentral 10.5.0

The model in order to store personalizations has been refactored. As a result, export files created using the content export functionality in the setup tool of older XperienCentral versions containing personalizations or references to personalizations cannot be imported on XperienCentral 10.5.0 and vice versa.

XperienCentral 10.4.1

• In 10.4.1 the logic which adds anchors and back to top links to elements has been moved from the content.jspf, which loops over and renders all elements, to two separate presentation JSPs, one with scope ElementAnchor, which prepends the anchors to an element if applicable and one with scope ElementBackToTop, which adds the back to top links to an element if applicable.
•  All element related logic should be removed from your project specific presentation JSPs which currently loop over and render the elements, like the content.jspf in the webmanager-cestyle-wcb and add two new presentation JSPs based on the elementAnchor.jspf and elementBackToTop.jspf in the webmanager-cestyle-wcb.

XperienCentral 10.4.0

• In 10.4.0 all default database connections are merged to one database connection named WebManagerDb which by default is accessed through JNDI lookups. Therefore it is necessary that before deploying  the application the WebManagerDb datasource is configured to be available on the application server. For Apache Tomcat edit the server.xml and add this resource to the context of the backend webapp:
  
  

  Resource name="jdbc/WebManagerDb" auth="Container" type="javax.sql.DataSource" username="${webmanager.externaldb.dbuser}" password="${webmanager.externaldb.dbpassword}"        driverClassName="${webmanager.externaldb.dbdriver}" url="${webmanager.externaldb.dburl}" maxActive="100" maxIdle="10" maxWait="10000" testWhileIdle="true"         timeBetweenEvictionRunsMillis="900000" removeAbandoned="true" removeAbandonedTimeout="30" logAbandoned="true" validationQuery="${webmanager.externaldb.validationquery}"/>>

  
  Note that you still have to fill in the correct values for the username, password, driverClassName, URL and validationQuery attributes. Examples of these can be found in the settings.xml.
  
  For Jboss edit the standalone.xml and add this datasource to datasources subsystem:
  
  
  

  <datasource jndi-name="java:jboss/jdbc/WebManagerDb" pool-name="WebManagerDb" enabled="true" use-java-context="true">
     <connection-url>${webmanager.externaldb.dburl}</connection-url>
        <driver>${driverName}</driver>
       <security>
           <user-name>${webmanager.externaldb.dbuser}</user-name>
           <password>${webmanager.externaldb.dbpassword}</password>
       </security>
  </datasource>

  
  Note that you still have to fill in the correct values for the connection-url, driver, user-name and password. Examples for the connection-url, driver and user-name can be found in the settings.xml. The driver value has to correspond with the name attribute of the driver you wish to use as defined in the drivers tag in the datasources subsystem. Furthermore, the driver for your database must be copied to the lib directory of your Tomcat or JBoss installation. Supported drivers can be found in the ext-directory in the root of the SDK distribution.
  
  It is advised to generate a new repository.xml using the maven configure-jcr-repository profile to make sure the jcr also accesses the database using JNDI and uses the WebManagerDb database connection. When you place this newly generated repository.xml you need to completely rebuild the JCR-index and thus stop the application server, remove the current repository directory and then start the application server again. If your installation contains custom database connections, you have to manually configure those to make use of JNDI, which includes adding the datasource to the application server configuration and updating the database connection set in the [Database configuration] tab of the setup tool.
  
  If you don't want to use JNDI, you have to fill in the old settings in the dbcbmanager sets in the dpcbmanager_defaults.xml which are generated in the WEB-INF folder of the webmanager-backend-webapp based on the settings.xml before executing the upgrade. You cannot generate non-JNDI dbcpmanager_defaults.xml using a maven command you always have to do this manually.
  
  

• The secure form signer used to protect forms against tampering has been changed. All dumped pages which contain interactive forms or advanced forms will need to be regenerated or flushed from the cache. Any old pre-upgrade forms submitted by browsers to the website after the upgrade will be rejected by the secure forms checking filter.

• PageVersionEvent.getTargetPageVersion() is deprecated; use .getPageVersion() instead. This change is relevant only for event handlers that use the deprecated method on a COPY event.

• PageVersionEvent.getEntity() no longer returns the original page version, it now returns the target page version. The same holds for .getPageVersion(). This change is relevant only for event handlers that use one of these methods on a COPY event.

• ElementEvent.getElement() now returns the target element, instead of the old element. This change is relevant only for event handlers that use this method on a COPY event.

• ElementEvent.getOriginalElement() now returns the original element. This change is relevant only for handlers that use this method on a COPY event.

• Subscription to interface scopes is possible; this might cause issues if a handler is subscribed to both Foo.class and FooParent.class.

• The PageManagementService no longer publishes UPDATE events, WCBs that rely on such an event being published after calling either .addLeadText(PageVersion), .addRedirect(PageVersion), or.reorderElements(PageVersion, Element[]) should now publish UPDATE events themselves.

• HistoryEvent.TOUCH is deprecated (and no longer published), please replace this with EntityEvent.UPDATE (both PRE and POST).

• Saving page metadata no longer publishes an MediaItemVersionEvent, but a PageVersionEvent instead.

• Apache Commons FileUpload has been updated to v1.3.1 (from 1.2.2), any implementation of FileItem now should implement both setHeaders(FileUploadHeaders) and getHeaders(). See http://commons.apache.org/proper/commons-fileupload/changes-report.html for other changes.

XperienCentral 10.2.x or older to 10.3.0

• In 10.2.1 or higher the XML parser factories of JBoss are boot delegated. Therefore, bundles that use XML parsing must import involved packages from javax.xml.* of the system bundle. Bundles cannot include a jar that provides javax.xml interfaces, or a ClassCastException occurs in combination with JBoss. This situation differs from 9.20.x as javax.xml.* packages were boot delegated. This breaks modularity of these packages leading to the problem the other way around: bundles cannot provide an implementation of a javax.xml.* package.
• In 10.3.0 or higher the hidden fields with name formid and clientsideRouting for Interactive Forms no longer have the id attributes with respective values formid and clientsiteRouting. Custom javascript code which depends on these iID attributes has to be updated.
• In 10.3.0 or higher, the divs with id attributes starting with "info_" and "errors_" have been extended with an identifier for the form to which they belong. Custom javascript code which depends on these id attributes has to be updated.
• In 10.3.0 or higher add the "Create versions of content items" permission explicitly to the "Create object" activity of all workflow repository models being used, in order to be able to create content versions of content repository related types.