Skip to main content

Upgrading Finsemble to io.Connect Desktop

Overview​

Your existing Finsemble implementation is compatible with io.Connect Desktop (io.CD) version 10 but a few steps are required to upgrade. You can continue to use your existing Finsemble seed project.

Getting Access to io.Connect Desktop​

io.CD is available as either an installer or as a zip file. You should have already been provided with a link to download io.CD and your firm's license key. All developers will need to install or unzip io.CD and apply the license key.

Starting io.CD with your project​

You must update your package.json <entries?> and run npm install or yarn install. yarn start will then launch your installed copy of io.Connect, running against your seed project.

Customizations​

Most customizations that you may have made in Finsemble will be compatible with io.Connect. This section lists the exceptions.

WindowTitleBar customization​

Finsemble's WindowTitleBar component is no longer supported. To customize the window header you will need to use io.CD's "decorator window". The decorator window is responsible for rendering the titlebar, the frame surrounding windows, optional footers, and the grouping header that appears when multiple windows are snapped together to form a group.

The decorator window can be customized by running yarn template DecoratorWindow. This will add a "DecoratorWindow" src entry to your seed project with a template. Follow the instructions in the template, which will also refer you to io.CD's documentation.

Intercepting window close events​

Window closing events can be intercepted, allowing apps to clean up or interact with users before the window closes. This is supported either with the legacy FinsembleWindow closeRequested event, or with the new io.CD onClosing() event handler. If you're using the legacy closeRequested event then your code should continue to operate as expected. One caveat is that this is now only supported when an app registers for its own closeRequested event. Apps may no longer intercept closing behavior for other apps. If you need this behavior then you must switch to using the new onClosing() handler.

Generating installers​

TODO