Upgrading to Quark Publishing Platform
Migrating to the September 2016 Update involves planning around the following key areas:
- Upgrading the software binaries
- Upgrading the database
- Merging your existing configuration files into the latest set
- Testing your implementation before migrating to production
Summary of Platform Server Changes
- Updated third party software: Please review the updated third party software libraries. Custom components relying on one or more of these libraries may need to be recompiled in the September 2016 environment. For example, the Spring Framework version has been updated in this release. You can find the final list in the "Third Party Technologies" directory of the Quark Publishing Platform final software delivery, and the list is also included in the public pre-releases.
- Equation editing: A new web application named "pluginwiris_engine" is deployed with the September 2016 Update. The integration with WIRIS tools enables editing and publishing math equations using Quark Author and QuarkXPress Server, respectively. To enable the integration, the web app must be deployed in the same web container as that used for Quark Publishing Platform Server. To benefit from future software updates, Quark recommends avoiding changes to the WIRIS web app.
- Equation publishing: A new publishing activity called "com.quark.qpp.publishing.activity.ResolveMathEquationsis" appears in all smartdoc-related processes for resolving and publishing math equations.
- Dynamic configuration: A new platform service called "Configuration Service" provides dynamic updates to publishing process activities and channels. PluginsContext.xml now includes this new service entries.
- Multi-server optimization: Customers deploying multiple application server instances of Quark Publishing Platform must plan for configuration changes to leverage the scalability and enhancements related to our integration with Elasticsearch. Customers using multi-server nodes and Elasticsearch avoid duplicating indices used for full text search and this deployment model now requires Elasticsearch. PluginsContext.xml includes entries for Elasticsearch, in addition to the following files which support the new integration:
- My Assignments: The search query used to fetch the current assignment count is controlled using a new property included in Query.properties.
- New Office file formats for output: PowerPoint and Visio publishing configuration is managed by new process entries located inside ProcessConfig.xml. The following configuration files help manage PowerPoint and Visio file formats:
- New publishing channels: Apply new publishing configuration to manage HTML5, Visio, and PowerPoint formats in ChannelConfig.xml and ProcessConfig.xml; the updated files include new entries, new channels, and new parameters for those channels.
- Rendering parameters: To provide more options and broader coverage for rendering charts and data, we updated configuration for publishing activities. Specifically, the parameter "com.quark.qpp.publishing.activity.ResolveXADocReferences" now uses the more generic parameter "dataRenderingParametersMap." Deprecated parameters "excelDataRenderingParametersMap" and "chartRenderingParametersMap" both use the new "dataRenderingParametersMap" parameter.
- REST enhancements: We introduce several new REST APIs for generating text indices, and leveraging PowerPoint and Visio files as components. More information shall appear in our updated REST Interface guide.
- Platform Workspace REST changes: We changed the workspace URL used to create/edit a Smart Content document. Here's the new URL:
Please note that URL parameters corresponding to "draftVersion" or "fileClassID" are no longer required.
Code: Select all
Summary of Quark Author Changes
- Tabbed UI: Editor toolbar buttons and placement order was previously configured via the editor-config.js file. For tabbed grouping of toolbar buttons, configuration is now defined inside the xmleditor-config.xml file. Toolbar button configuration in editor-config.js will continue to work as before unless tabbed views are configured in xmleditor-config.xml. In other words, the new configuration file overrides any toolbar button configuration in editor-config.js. New buttons must be declared inside editor-config.js and included as items in the new tab and toolbar element structure contained inside xmleditor-config.xml.
- Smart Content CSS: The <div> element used to render HTML corresponding to Smart Content is no longer contained in an IFrame. Quark Author element styles appearing in the editing canvas for custom content types configured via editor-content.css may conflict with element styles of the host page. The Quark Author editor canvas is now hosted in a <div> element with a class attribute named ".quark-editor-content." We recommend using this new class to provide a more specific CSS selector for Smart Content elements.
- Offline mode: Custom plugins in Quark Author may need to handle connection events in order to gracefully disable these features in offline mode. If improperly handled, some events could prevent the Quark Author page from opening in offline mode. For details, please refer to the Quark Author XDK documentation and updated SDK samples.
- New configuration properties: To support new software features, we have added configuration properties to xmleditor-config.xml and workspace-config.xml. These may require merging your existing solution configuration to the new files. For details, please see the updated Quark Author System Administration guide.
- New metadata functions: Several new functions have been added to objects in the QXmlEditor.meta.Meta namespace. Please see the Quark Author XDK documentation for details, provided as part of the SDK delivery.