Improving the process of checking in files in Studio

When a file is checked out for editing outside of Studio, the preferred way of checking in the edited file is by making use of Google Chrome and the Desktop application. During this process, the file is uploaded to Studio Server.

To do this, the Desktop application uses the HTTP/HTTPS libraries from Node.js.

However, when the upload is done over a secure (HTTPS) connection, the required certificate is checked differently by the HTTPS library than by the Chrome browser. It may happen therefore that a certificate is valid from a Chrome browser point of view, but not from the view of the HTTPS library. As result, the upload can fail.

To overcome this, the Desktop application can instead make use of the Electron.NET library. Using this library offers the following advantages:

• Custom SSL certificates can be used.
• The proxy settings of the operating system are respected.
• File uploads are faster and more reliable.

Requirements

The use of the Electron.NET library by the Desktop app requires a web server that supports chunk encoding. To check if your web server supports this, use the following curl command:

curl -L \
   -X POST \
   -H "Transfer-Encoding: chunked" \
   -d '{"id":"1","method":"QueryObjects","params":[{"Params":[]}] }' \
   <server_url>/index.php?protocol=JSON

The output of the command should be as follows:

{"id":"1","error":{"code":-32000,"message":"The system could not be accessed because the log-on ticket has become invalid or has expired. Please log in again. (S1043)","data":{"detail":"SCEntError_InvalidTicket"}},"jsonrpc":"2.0"}

Chunked encoding is not supported by the server when the command does not return any data at all or when the response contains the following:

{"id":null,"error":{"code":-32600,"message":"Invalid Request","data":null},"jsonrpc":"2.0"}

• Supported systems: Chunk encoding has been tested on Linux with the Apache 2.0 handler. To WoodWing's knowledge it is not supported on IIS or in combination with PHP-FPM. Other configurations are not supported, nor can WoodWing help with configuration issues.

Configuration

Info: Performing the described step requires direct server access. Depending upon how your system is hosted and the level of access you have to that system, coordination may be required with your Partner or WoodWing Support team. For a full overview of the steps that need to be done by WoodWing and how to request them, see WoodWing Cloud - Change management.

Enabling the use of the Electron.NET library by the Desktop app is done by setting the following option:

• File: The config_overrule.php file of the server on which Studio is installed.
• Name of option: STUDIO_DESKTOP_APP_ELECTRON_NET_ENABLED
• Value:
• true. The Desktop app uses the Electron.NET library to upload files.
• false. The Desktop app uses the default Node.js http/https libraries to upload files.
• Example:

define( 'STUDIO_DESKTOP_APP_ELECTRON_NET_ENABLED', true );