Studio Server Release Notes

Compared to Studio Server 10.11, various changes have been made to the compatibility between Studio Server and other systems as shown in the following table.

The following DataSource Web service interface definitions have been marked as deprecated:

See also:

• The Web Services guide
• The Web Services index: Studio Server > Advanced > Web Services SDK

The following server plug-ins have been removed:

Support for adding Dossier templates to the Home page of Content Station 9 has been removed. Support for this feature was already deprecated but has now been fully removed from the software.

The following has been removed from the Brand Maintenance page:

• The Dossier templates section.

Note: When upgrading from a version of Enterprise Server in which records for this list existed, these records will be automatically removed during the upgrade.

The following PHP classes have been removed:

• BizAdmTemplateObject
• DBAdmTemplateObject
• TemplateObjectAccess
• AddTemplateObjectsRequest
• AddTemplateObjectsResponse
• AddTemplateObjectsService
• GetTemplateObjectsRequest
• GetTemplateObjectsResponse
• GetTemplateObjectsService
• RemoveTemplateObjectsRequest
• RemoveTemplateObjectsResponse
• RemoveTemplateObjectsService

The following Named Query has been removed:

• DOSSIER_TEMPLATES_IN_APPLICATIONS. This was implemented in the Server plug-in 'Studio List Dossiers' (also known as 'Content Station List Dossiers').

The following database table has been removed:

• smart_publobjects

The following elements and services under the Admin interface (StudioServer/server/interfaces/SmartConnectionAdmin.wsdl) have been removed:

• Elements:
• TemplateObjectAccess
• ArrayOfTemplateObjectAccess
• AddTemplateObjectsRequest
• AddTemplateObjectsResponse
• GetTemplateObjectsRequest
• GetTemplateObjectsResponse
• RemoveTemplateObjectsRequest
• RemoveTemplateObjectsResponse
• Services:
• AddTemplateObjects
• GetTemplateObjects
• RemoveTemplateObjects

Publishing Services were used in conjunction with Publish Forms in Content Station 9. Support for Publish Forms was already deprecated but its functionality (the Publishing Services) has now been fully removed.

Note that this means that these services cannot be called anymore, for example from custom integrations or plug-ins.

The following files have been removed:

• StudioServer/server/utils/PublishingProgressBar.class.php
• StudioServer/server/utils/PublishingFields.class.php
• StudioServer/server/utils/ParallelCallbackCache.class.php
• StudioServer/server/bizclasses/BizPublishing.class.php
• StudioServer/server/bizclasses/BizPubIssue.class.php
• StudioServer/server/interfaces/plugins/connectors/PubPublishing_EnterpriseConnector.class.php
• StudioServer/server/dbclasses/DBPubPublishedIssues.class.php
• StudioServer/server/dbclasses/DBPublishedObjectsHist.class.php
• StudioServer/server/dbclasses/DBPublishHistory.class.php

The following functions have been removed:

In StudioServer/server/bizclasses/facades/ServerPlugin.class.php:

• WW_BizClasses_Facades_ServerPlugin::runChannelConnector()

In StudioServer/server/bizclasses/BizServerPlugin.class.php:

• BizServerPlugin::getPluginFolderForChannelId()
• BizServerPlugin::runChannelConnector()
• BizServerPlugin::getChannelConnector()

In StudioServer/server/bizclasses/BizAdmPublication.class.php:

• BizAdmPublication::getDefaultPubChannel

The following Named Query has been removed:

• The build-in Named Query 'PublishManager'. This was used by Content Station 9 in the 'Publish Manager' tab to show an overview of the publish status of each Publish Form ('Ready To be Published', 'New', 'Updated', 'Published').

The following Studio business connector has been removed:

• PubPublishing_EnterpriseConnector

As a result, in the <pluginName>/PluginInfo.php file of a custom server plug-in, the following entry cannot be called anymore in the getConnectorInterfaces() function:

final public function getConnectorInterfaces() 
{ 
     return array( 'PubPublishing_EnterpriseConnector'  );
}

The following classes in StudioServer/server/smartevent.php have been removed:

• class smartevent_issuereorderpublished
• class smartevent_publishissue
• class smartevent_updateissue
• class smartevent_unpublishissue
• class smartevent_setpublishinfoforissue
• class smartevent_publishdossier
• class smartevent_updatedossier
• class smartevent_unpublishdossier
• class smartevent_setpublishinfofordossier
• class smartevent_issuereorder

The following database tables have been removed:

• smart_pubpublishedissues
• smart_publishedobjectshist
• smart_publishhistory

When upgrading from a previous version of Studio Server or Enterprise Server, these tables will be removed ('dropped') during the database upgrade.

The following database fields have been removed:

• smart_states table: 'readyforpublishing'
• smart_targets table: 'publisheddate', 'publishedmajorversion', 'publishedminorversion', 'externalid'
• smart_channels table: 'publishsystem'

When upgrading from a previous version of Studio Server or Enterprise Server, these database fields will be removed ('dropped') during the database upgrade.

The following Web Service has been removed:

• Publishing interface (StudioServer/server/interfaces/EnterprisePublishing.wsdl). This interface was mainly called by Content Station 9.

No services related to the Publishing interface can be called anymore.

The following 'actions' in the Workflow interface (StudioServer/server/interfaces/SCEnterprise.wsdl) have been removed:

In the Workflow interface as part of simple type 'Action', the following entries have been removed:

<simpleType name="Action”>

<enumeration value="PublishDossier"/>  
<enumeration value="UpdateDossier"/>  
<enumeration value="UnPublishDossier"/> 
<enumeration value="SetPublishProperties"/> 

The following properties have been marked as discontinued:

Workflow interface (StudioServer/server/interfaces/SCEnterprise.wsdl)

• Under 'Target':
• 'PublishedDate' and 'PublishedVersion' properties (Discontinued)
• Under 'PubChannelType':
• 'sms' type (Discontinued)

Admin interface (StudioServer/server/interfaces/SmartConnectionAdmin.wsdl)

• Under 'Status':
• 'ReadyForPublishing' property (Discontinued)
• Under 'PubChannel':
• 'PublishSystem' property (Discontinued)
• Under 'PubChannelType':
• 'sms' type (Discontinued)

The Studio Server code base no longer handles these properties.

The WflGetPagesService is used for retrieving page renditions (thumbnails or previews) of layouts in applications such as Journal Designer. The following changes have been made to it:

• Improved performance. To speed up the retrieval process, the following has been changed:

• A new parameter named 'HaveVersions' has been added to the WflGetPagesRequest. By setting this parameter, only page rendition attachments are returned when, after an initial request, a newer version of the page is available. Previously all page renditions were copied to the Transfer Server folder (by the server) and downloaded by the client, even though no newer version was available.

• The following functions have been removed from the DBPage class; these should no longer be called by PHP customizations:
• DBPage::listPagesByLayoutPerIssue
• DBPage::listPagesByLayoutPerIds

• The following parameters have been deprecated since Enterprise Server 8.3.3 and have now been removed from the WflGetPagesRequest; these should no longer be used by web service integrations:
• PageOrders
• PageSequences
• RequestMetaData
• RequestFiles

For information about Web Services, see The Web Services SDK of Studio Server.

Compared to Studio Server 10.10, various changes have been made to the compatibility between Studio Server and other systems as shown in the following table.

Various changes have been made to Studio Server 10.11.0 which affects upgrading from previous versions. This includes:

• The upgrade path
• Features that are no longer supported
• Changes to Named Queries, PHP classes, PHP functions, database items, and more

For details, see Upgrading Enterprise Server to Studio Server 10.10 or higher.

To following changes have been made to the functionality of archiving files to Assets Server:

• The configuration of the 'Archive Zone' and 'Archive after (days)' options can now be set for each archive schema separately. In previous versions, when both 'Issue based' and 'Continuous' archive schemas were selected, the 'Archive Zone' and 'Archive after (days)' options applied to both these schemas. Now, the 'Archive Zone' and 'Archive after (days)' options can be defined separately for each schema.

• New and changed configuration options. In the config_elvis.php file, one configuration option has changed and three new options have been added to give more control over the default values of the two properties:

• New default values. The default value for the 'Archive after (days)' option has been changed from zero (0) to the following values:

• Continues archive schema: 30
• Issue Based schema: 7

• Health Check test. When running the 'WoodWing Assets Content Source' test on the Health Check page, any of the options mentioned above are automatically checked. When no values have been set for a Brand, they automatically get the default value assigned.

When options have been repaired, an orange 'UPDATE' icon is shown together with a list of affected Brands. Each Brand can be clicked to navigate to its Brand Maintenance page for manual examination.

The following changes have been made:

• Logging is now off by default and can be enabled for debugging. In previous versions, logging by InDesign Server Jobs to various devices was enabled by default and could not be disabled. This could potentially negatively affect the performance of the production environment.

Now, logging is off by default and can be enabled for debugging purposes when needed. This is done through the following option in the configserver.php file:

INDESIGNSERV_LOGTODEVICES

For details, see Controlling InDesign Server Job logging in Studio Server.

• Scripts are no longer uploaded to InDesign Server during production. In previous versions, InDesign Server Jobs always uploaded their script to InDesign Server just before it was executed. This is now no longer done during production hours. Instead, scripts are uploaded during installation time and cached on the InDesign Server host machine.

Scripts are taken by the Health Check page from the StudioServer/server/utils/idsscripts folder and distributed to all InDesign Server machines (connected to Studio Server) in the following folder:

• MacOS: ~/Library/Preferences/Adobe InDesign Server/Version x.y/
  en_US/configuration_<port number>/Scripts/WwEnterpriseUtils
• Windows: %USERHOME%\AppData\Roaming\Adobe\InDesign Server\Version x.y\
  en_US\configuration_<port number>\Scripts\WwEnterpriseUtils

Where:

• Version x.y is the InDesign Server Version. For example: 'Version 15.0'.
• configuration_<port number> is the port on which InDesign Server is started. For example: 'configuration_18387'.

• No need anymore for a shared or mounted WebEdit folder with InDesign Server. In previous versions, the path to the WEBEDITDIR folder needed to be defined in the WEBEDITDIRIDSERV option. This option has now been dropped and a mount from either the Studio Server machines and/or from the InDesign Server machines is no longer needed.

Studio Server still needs access to the WebEdit folder that is shared between the application servers. However, Studio Server now creates a WebEdit folder for each InDesign Server machine automatically (without the need for configuration). This folder is shared between the InDesign Server instances running on that machine only. Files that needs to be shared will be transferred over HTTP automatically.

This folder is created in the following location:

• MacOS: ~/Library/Application Support/WwIdsWorkSpace
• Windows: %USERDATA%/WwIdsWorkSpace (by default, C:\Documents and Settings\username\Application Data\WwIdsWorkSpace)

• The generateOutputPages function can no longer be used. Integrations may have used this function provided by the BizWebEditWorkspace class. However, the parameters for this function have been heavily changed due to the changes mentioned above. More importantly, the function is no longer static or public and can therefore no longer be called.

Note: As this is a breaking change, integrators should look for an alternative solution for integrations using this function.

• Drop in preview performance. Due to the changes mentioned above, the performance of generating previews has dropped with an average of about 12%. (The actual figure depends on many factors, such as the size of the layout and article, and the number of images used.)

• Support for the use of certificate files via WWSettings.xml dropped. This SSL feature of Studio for InDesign Server can no longer be used for the preview feature of the InDesign Server integration. This is because the generated previews are now directly uploaded to Studio Server by the InDesign Server preview script.

Note: Specifying certificate files is still supported by Studio for InDesign Server. SSL connections for the preview feature can also still be set up. For the latter, the certificates registered at operating system level are used.

• Periodic clean-up of the WebEdit folders should be planned. When installing a new InDesign Server host (or upgrading an existing InDesign Server host) to connect to Studio Server, the WebEdit folders should be cleaned periodically.

These folders are created by the InDesign Server preview script (provided by Studio Server) for each preview session.

When an InDesign Server host is busy, the WebEdit folder is created by another InDesign Server host.

To make maximum use of the InDesign Server capacity (and to not have the process delayed because of auto-cleaning operations) it is the responsibility of the system operator to periodically remove the WebEdit folders.

The more users are served, the more often this should happen. However, doing this too often can lead to inefficiencies. A good starting point is to clean the folder every 15 minutes and to remove all WebEdit folders in the InDesign Server Workspace folder that are older than one hour.

For Windows Server, two example scripts are provided: a clean-up script that does the actual cleaning and an installation script that makes it periodically run with help of the Windows Task Scheduler. The scripts can be found in the StudioServer/sdk/ids folder.

Further instructions can be found in the headers of the scripts.

Note: The scripts provided are a guideline for setting up the automated cleaning. Usage of it is at your own risk; support for these scripts is not provided by WoodWing.

The Workspace folder can be found in the following locations:

• Windows: %USERDATA%\WwIdsWorkSpace
• MacOS: ~/Library/Application Support/WwIdsWorkSpace

• The behavior of a Publication Channel of type 'Web' is now the same as for type 'Print'. When a Dossier was created in previous versions, the Issue that was assigned to any objects within the Dossier depended on the Issue that the Dossier was assigned to: an Issue belonging to a Publication Channel of type 'Print' or of type 'Web'.

Example: When an article was created in a Dossier assigned to an Issue of a Publication Channel of type 'Print', the article was also assigned to the Print Issue. However, when an article was created in a Dossier assigned to an Issue of a Publication Channel of type 'Web', the article was not assigned to the Web Issue.

In Studio Server 10.11.0, an object that is created within a Dossier assigned to an Issue of a Publication Channel of type 'Web' is now also assigned to that Web Issue.

Note: When searching for files by filtering on a Web issue, all the child objects are now returned instead of only the Dossiers. (Applies to objects created in Studio Server 10.11.0 or higher only; objects created in previous versions will still not appear in the search results.

• The Zend Framework has been replaced by Laminas. The Zend Framework and all its sub-projects has been transitioned to an open source project hosted at the Linux Foundation. As a result, the following changes have been made:

• The Zend Framework in the StudioServer/server/vendor folder has been replaced by Laminas.
• Zend Framework usages by Studio Server have been replaced with Laminas.

As the footprint of Studio Server has been reduced, the web services show an improved performance.

This has been tested by running the ServerStudio/server/wwtest/speedtest.php module using its default options but with the 'Number of runs' option set to 5.

The test was run using the following configuration:

• Application Server running on Apache 2.4 + PHP 7.3 + ImageMagick + ExifTool + CentOS 7 instance in AWS (m5.large).
• Database running on MySQL 8.0 + CentOS 7 instance in AWS (m5.large).
• Server logging and profiling disabled.
• 3rd-party integrations disabled (InDesign Server, Elvis, RabbitMQ, Solr, and so on).
• Enterprise Server 10.8 and Studio Server 10.11 installed side-by-side (on the same instances).

• The database was set up with the standard WW News Brand configuration.

• One test run was made for SOAP and one for JSON-RPC.

Note: The InDesign/InCopy plug-ins for Studio are using SOAP and the Studio web application is using JSON-RPC.

The calculated Average outcomes are compared between Enterprise Server 10.8 and Studio Server 10.11 installations:

• SOAP performance improved by 16%.
• JSON-RPC performance improved by 29%.

Various improvements were made to the ServerStudio/server/wwtest/speedtest.php module:

• The Version option has been removed as it lists very old server versions that are no longer relevant.

• A new option named Protocols has been added. It makes it possible to run the tests over SOAP or JSON-RPC.

Note: The InDesign/InCopy plug-ins for Studio are using SOAP and the Studio web application is using JSON-RPC.

• The Average calculation has been improved. Outcomes of the lowest performance (the highest value) are now ignored and are shown in strikethrough text.

• A Best calculation is now also performed. It shows the fastest execution of the runs.

• The Summary report now shows totals calculated for each test run (shown when performing more than 1 test run).

• The 'InDesign Server / CS editor' test has been renamed to 'InDesign Server'. The 'CS editor' part was included because the test was originally used for the previews of the Content Station editor.

However, only the configured InDesign Server instances were tested. Because these are used for more purposes nowadays such as the InDesign Server Automation feature, naming the test 'InDesign Server' better reflects its purpose.

• The WSDL Cache is now automatically repaired. In previous versions, when the WSDL Cache was outdated, the WSDL Cache entry showed a WARNING icon and provided a link to clear the cache.

Now, an UPDATED icon is shown and the cache is automatically cleared when it is outdated. When the cache is cleared or up-to-date, an OK icon is shown.

The LOGFILE_FORMAT option in the configserver.php file now also allows to output in JSON format.

The output contains fields respecting the Elastic Common Schema, designed for centralized logging. It can be set up with the help of third-party tools such as Filebeat for reading logs and saving them in ElasticSearch.